Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

procdefs.h File Reference

Defines data types and structures used by PROC component. More...

#include <gpptypes.h>
#include <linkcfgdefs.h>

Include dependency graph for procdefs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PROC_Attrs_tag
struct  ProcMemMapInfo_tag

PROC_Attrs

A placeholder for processor information.

============================================================================

Parameters:
timeout Time out associated with a DSP.
dspCfgPtr Pointer to DSP side Configuration. ============================================================================


#define PROC_CTRL_CMD_GEN_BASE   0x00000100u
#define PROC_CTRL_CMD_GEN_LAST   0x00000200u
#define PROC_CTRL_CMD_MAP_DSPMEM   (PROC_CTRL_CMD_GEN_BASE + 0x00000001u)
#define PROC_CTRL_CMD_UNMAP_DSPMEM   (PROC_CTRL_CMD_GEN_BASE + 0x00000002u)
#define PROC_CTRL_CMD_MMU_ADD_ENTRY   (PROC_CTRL_CMD_GEN_BASE + 0x00000003u)
#define PROC_CTRL_CMD_MMU_DEL_ENTRY   (PROC_CTRL_CMD_GEN_BASE + 0x00000004u)
typedef PROC_Attrs_tag PROC_Attrs

ProcMemMapInfo

Control information for mapping DSP memory region in GPP's address space.

============================================================================

Parameters:
dspAddr Address in the DSP memory space to be mapped
size Size of memory to be mapped
mappedAddr Mapped address in the user memory space
mappedSize Size of memory actually mapped ============================================================================


#define ProcState   PROC_State
#define ProcAttr   PROC_Attrs
typedef ProcMemMapInfo_tag ProcMemMapInfo

PROC_State

Enumerations to indicate processor states.

============================================================================

Parameters:
ProcState_Unknown Unknown (possibly error) processor state.
ProcState_Setup Indicates that the PROC component has been setup.
ProcState_Loaded Indicates the DSP is loaded.
ProcState_Started Indicates the DSP is started.
ProcState_Stopped Indicates the DSP is stopped.
ProcState_Idle Indicates the DSP is idle.
ProcState_Reset Indicates the DSP is reset.
ProcState_Unavailable Indicates the DSP is unavailable to the physical transport. ============================================================================


enum  PROC_State {
  ProcState_Unknown = 0u, ProcState_Setup = 1u, ProcState_Loaded = 2u, ProcState_Started = 3u,
  ProcState_Stopped = 4u, ProcState_Idle = 5u, ProcState_Reset = 6u, ProcState_Unavailable = 7u
}

Defines

#define PROCDEFS_H
#define IS_VALID_PROCID(id)   (id < MAX_DSPS)
 Is the proc ID valid. ============================================================================.


Detailed Description

Defines data types and structures used by PROC component.

============================================================================

Path:
/db/swcoe_asp/DSPLINK_Build/dsplink_linux_1_65_00_03/dsplink/gpp/inc/usr/
Version:
1.65.00.03 ============================================================================
Copyright:
Copyright (C) 2002-2009, Texas Instruments Incorporated - http://www.ti.com/
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ============================================================================

Definition in file procdefs.h.


Define Documentation

#define IS_VALID_PROCID id   )     (id < MAX_DSPS)
 

Is the proc ID valid. ============================================================================.

============================================================================

Macro:
IS_VALID_PROCID

Definition at line 63 of file procdefs.h.

#define PROC_CTRL_CMD_GEN_BASE   0x00000100u
 

Definition at line 125 of file procdefs.h.

#define PROC_CTRL_CMD_GEN_LAST   0x00000200u
 

Definition at line 126 of file procdefs.h.

#define PROC_CTRL_CMD_MAP_DSPMEM   (PROC_CTRL_CMD_GEN_BASE + 0x00000001u)
 

Definition at line 136 of file procdefs.h.

#define PROC_CTRL_CMD_MMU_ADD_ENTRY   (PROC_CTRL_CMD_GEN_BASE + 0x00000003u)
 

Definition at line 138 of file procdefs.h.

#define PROC_CTRL_CMD_MMU_DEL_ENTRY   (PROC_CTRL_CMD_GEN_BASE + 0x00000004u)
 

Definition at line 139 of file procdefs.h.

#define PROC_CTRL_CMD_UNMAP_DSPMEM   (PROC_CTRL_CMD_GEN_BASE + 0x00000002u)
 

Definition at line 137 of file procdefs.h.

#define ProcAttr   PROC_Attrs
 

============================================================================

Deprecated:
The deprecated data structures ProcAttr has been replaced with PROC_Attrs. This has been done to follow DSP/BIOS codinf guidelines and have a uniform naming convention for the API's on both GPP as well as DSP.
============================================================================

Definition at line 185 of file procdefs.h.

#define PROCDEFS_H
 

Definition at line 44 of file procdefs.h.

#define ProcState   PROC_State
 

============================================================================

Deprecated:
The deprecated data structure ProcState has been replaced with PROC_State. This has been done to follow DSP/BIOS codinf guidelines and have a uniform naming convention for the API's on both GPP as well as DSP.
============================================================================

Definition at line 174 of file procdefs.h.


Typedef Documentation

typedef struct PROC_Attrs_tag PROC_Attrs
 

typedef struct ProcMemMapInfo_tag ProcMemMapInfo
 

============================================================================

Deprecated:
The deprecated data structure ProcState has been replaced with PROC_State. This has been done to follow DSP/BIOS codinf guidelines and have a uniform naming convention for the API's on both GPP as well as DSP.
============================================================================


Enumeration Type Documentation

enum PROC_State
 

Enumerator:
ProcState_Unknown 
ProcState_Setup 
ProcState_Loaded 
ProcState_Started 
ProcState_Stopped 
ProcState_Idle 
ProcState_Reset 
ProcState_Unavailable 

Definition at line 89 of file procdefs.h.

00089              {
00090     ProcState_Unknown     = 0u,
00091     ProcState_Setup       = 1u,
00092     ProcState_Loaded      = 2u,
00093     ProcState_Started     = 3u,
00094     ProcState_Stopped     = 4u,
00095     ProcState_Idle        = 5u,
00096     ProcState_Reset       = 6u,
00097     ProcState_Unavailable = 7u
00098 } PROC_State ;


Generated on Fri Jul 16 14:34:09 2010 for DSP/BIOSLink by  doxygen 1.4.4