ADM-XRC SDK 2.8.1 User Guide (Linux)
© Copyright 2001-2009 Alpha Data
Prototype
ADMXRC2_STATUS ADMXRC2_SetSpaceConfig( ADMXRC2_HANDLE Card, unsigned int SpaceIndex, uint32_t Flags);
Arguments
Argument | Type | Purpose |
Card | In | Handle of card |
SpaceIndex | In | The index of the space to be configured |
Flags | In | Flags specifying configuration |
Return value
Value | Meaning |
ADMXRC2_SUCCESS | The space was successfully configured. |
ADMXRC2_INVALID_HANDLE | The Card handle was not valid |
ADMXRC2_INVALID_PARAMETER | Flags did not consist entirely of valid flags |
ADMXRC2_NOT_SUPPORTED | An invalid space was specified via SpaceIndex or the requested configuration, specified via Flags, is not supported on the card |
Description
This function configures a local bus space.
The SpaceIndex parameter is a zero-based index that specifies the local bus space to configure.
The Flags parameter specifies the desired configuration for the local bus space, and should be constructed by bitwise ORing together flags from the following table:
Flag | Meaning |
ADMXRC2_SPACE_SET_WIDTH | The bus width for the local bus space is specified; must be accompanied by one of the ADMXRC2_SPACE_WIDTH_XXX flags |
ADMXRC2_SPACE_WIDTH_DEFAULT | The model-specific default bus width is requested; equates to one of the other ADMXRC2_SPACE_WIDTH_XXX flags, depending on the model |
ADMXRC2_SPACE_WIDTH_8 | 8 bit local bus width is requested |
ADMXRC2_SPACE_WIDTH_16 | 16 bit local bus width is requested |
ADMXRC2_SPACE_WIDTH_32 | 32 bit local bus width is requested |
ADMXRC2_SPACE_WIDTH_64 | 64 bit local bus width is requested |
ADMXRC2_SPACE_SET_PREFETCH | The prefetch behaviour for the local bus space is specified; must be accompanied by one of the ADMXRC2_SPACE_PREFETCH_XXX flags |
ADMXRC2_SPACE_PREFETCH_DEFAULT | The model-specific default prefetch behaviour is requested; corresponds to one of the other ADMXRC2_SPACE_PREFETCH_XXX flags, depending on the model |
ADMXRC2_SPACE_PREFETCH_MINIMUM | The minimum amount of prefetching is requested; on some models, this equates to no prefetching |
ADMXRC2_SPACE_PREFETCH_NORMAL | A nominal amount of prefetching is requested |
ADMXRC2_SPACE_PREFETCH_MAXIMUM | The maximum amount of prefetching is requested; on some models, this may equate to unlimited prefetching |
ADMXRC2_SPACE_SET_BURST | The bursting behaviour for the local bus space is specified; must be accompanied by one of the ADMXRC2_SPACE_BURST_XXX flags |
ADMXRC2_SPACE_BURST_DEFAULT | The model-specific default burst behaviour is requested; corresponds to one of the other ADMXRC2_SPACE_BURST_XXX flags, depending on the model |
ADMXRC2_SPACE_BURST_DISABLED | Non-bursting (single word transfer) behaviour is requested |
ADMXRC2_SPACE_BURST_ENABLED | Bursting (multiword transfer) behaviour is requested |