Framework Components Application Programming Interface (API)
fc-v07
|
Macros | |
#define | IALG_DEFMEMRECS 4 |
#define | IALG_OBJMEMREC 0 |
#define | IALG_SYSCMD 256 |
#define | IALG_EOK 0 |
#define | IALG_EFAIL (-1) |
#define | IALG_CUSTOMFAILBASE (-2048) |
#define | IALG_CUSTOMFAILEND (-256) |
#define | IALG_MPROG 0x0008 |
#define | IALG_MXTRN 0x0010 |
#define | IALG_isProg(s) |
#define | IALG_isOffChip(s) |
Data Structures | |
struct | IALG_MemRec |
Memory records. More... | |
struct | IALG_Obj |
Algorithm instance object definition. More... | |
struct | IALG_Params |
Algorithm instance creation parameters. More... | |
struct | IALG_Status |
Pointer to algorithm specific status structure. More... | |
struct | IALG_Fxns |
Defines the fields and methods that must be supplied by all XDAIS algorithms. More... | |
Typedefs | |
typedef enum IALG_MemAttrs | IALG_MemAttrs |
Memory attributes. More... | |
typedef enum IALG_MemSpace | IALG_MemSpace |
Defined memory spaces. More... | |
typedef struct IALG_MemRec | IALG_MemRec |
Memory records. More... | |
typedef struct IALG_Obj | IALG_Obj |
Algorithm instance object definition. More... | |
typedef struct IALG_Obj * | IALG_Handle |
Handle to an algorithm instance object. More... | |
typedef struct IALG_Params | IALG_Params |
Algorithm instance creation parameters. More... | |
typedef struct IALG_Status | IALG_Status |
Pointer to algorithm specific status structure. More... | |
typedef unsigned int | IALG_Cmd |
Algorithm specific command. More... | |
typedef struct IALG_Fxns | IALG_Fxns |
Defines the fields and methods that must be supplied by all XDAIS algorithms. More... | |
Enumerations | |
enum | IALG_MemAttrs { IALG_SCRATCH, IALG_PERSIST, IALG_WRITEONCE } |
Memory attributes. More... | |
enum | IALG_MemSpace { IALG_EPROG, IALG_IPROG, IALG_ESDATA, IALG_EXTERNAL, IALG_DARAM0 = 0, IALG_DARAM1 = 1, IALG_SARAM = 2, IALG_SARAM0 = 2, IALG_SARAM1 = 3, IALG_DARAM2 = 4, IALG_SARAM2 = 5 } |
Defined memory spaces. More... | |
This is the XDAIS IALG interface.
#define IALG_DEFMEMRECS 4 |
Default number of memory records.
#define IALG_OBJMEMREC 0 |
Memory record index of instance object.
#define IALG_SYSCMD 256 |
Minimum "system" IALG_Cmd value.
#define IALG_EOK 0 |
Successful return status code.
#define IALG_EFAIL (-1) |
Unspecified error return status code.
#define IALG_CUSTOMFAILBASE (-2048) |
Algorithm-specific failure code end.
@remarks This is 0xfffff800.
#define IALG_CUSTOMFAILEND (-256) |
Algorithm-specific failure code base.
@remarks This is 0xffffff00.
#define IALG_MPROG 0x0008 |
Program memory space bit.
#define IALG_MXTRN 0x0010 |
External memory space bit.
#define IALG_isProg | ( | s | ) |
#define IALG_isOffChip | ( | s | ) |
typedef enum IALG_MemAttrs IALG_MemAttrs |
Memory attributes.
typedef enum IALG_MemSpace IALG_MemSpace |
Defined memory spaces.
typedef struct IALG_MemRec IALG_MemRec |
Memory records.
Algorithm instance object definition.
typedef struct IALG_Obj* IALG_Handle |
Handle to an algorithm instance object.
typedef struct IALG_Params IALG_Params |
Algorithm instance creation parameters.
typedef struct IALG_Status IALG_Status |
Pointer to algorithm specific status structure.
typedef unsigned int IALG_Cmd |
Algorithm specific command.
Defines the fields and methods that must be supplied by all XDAIS algorithms.
enum IALG_MemAttrs |
enum IALG_MemSpace |
Defined memory spaces.