学步园

/**********************************************************************<br /> Copyright(c) Analog Devices, Inc. All Rights Reserved.<br /> This software is proprietary and confidential. By using this software<br /> you agree to the terms of the associated Analog Devices License Agreement.<br /> $RCSfile: adi_dev.h,v $<br /> $Revision: 1.29 $<br /> $Date: 2007/08/01 20:38:12 $<br /> Description:<br /> This is the include file for the Device Manager.<br /> *********************************************************************/<br /> // This has been moved here from below as a temporary solution to TAR #32242<br /> #include <services/services.h><br /> #ifndef __ADI_DEV_H__<br /> #define __ADI_DEV_H__<br /> /*********************************************************************<br /> Insure the system services have been included<br /> *********************************************************************/<br /> // This has been moved above as a temporary solution to TAR #32242<br /> // #include <services/services.h><br /> /*********************************************************************<br /> Insure the device driver model supports the given processor family<br /> *********************************************************************/<br /> #if defined(__ADSP_EDINBURGH__) || defined(__ADSP_BRAEMAR__) || defined(__ADSP_TETON__) || defined(__ADSP_STIRLING__) || defined (__ADSP_MOAB__) || defined (__ADSP_KOOKABURRA__)<br /> #else<br /> #error "*** The Device Driver Model does not yet support this processor ***"<br /> #endif<br /> #if !defined(_LANGUAGE_ASM)</p> <p>/*********************************************************************<br /> Device Driver Enumeration Start Values<br /> Each device driver can extend the existing command IDs, event IDs and<br /> return codes. In order to avoid conflicts, these enumerations must be<br /> unique so that no two device drivers share the same enumeration values.<br /> The macros below define the enumeration start values for each device<br /> driver. Within each device driver's .h file, the enumeration values for<br /> new command IDs, event IDs and return codes should begin with the<br /> appropriate value from the list below. Each driver can add up to 65535<br /> new types before any conflicts occur. Also note that each driver should<br /> prefix all macros, functions, non-static and non-automatic variables with<br /> the prefixes shown below.<br /> (NOTE: all drivers should use the return code of ADI_DEV_RESULT_SUCCESS,<br /> which has the value 0, for all successful function calls.)<br /> For example, the PPI driver uses the prefix "ADI_PPI" and "adi_ppi" and<br /> begins it's enumeration values starting with ADI_PPI_ENUMERATION_START.<br /> When new drivers are added to the distribution, begin the enumeration<br /> for the new driver with the value indicated below, then replace that value<br /> on the line below with it's current value + 0x10000.<br /> Next driver enumeration starts at -> 0x40290000<br /> *********************************************************************/<br /> // adc<br /> #define ADI_AD1871_ENUMERATION_START (0x40010000) // AD1871 driver enumeration start<br /> #define ADI_AD7266_ENUMERATION_START (0x40020000) // AD7266 driver enumeration start<br /> #define ADI_AD7276_ENUMERATION_START (0x40028000) // AD7276 driver enumeration start<br /> #define ADI_AD7356_ENUMERATION_START (0x40260000) // AD7356 driver enumeration start<br /> #define ADI_AD7476A_ENUMERATION_START (0x40030000) // AD7476A driver enumeration start<br /> #define ADI_AD7477A_ENUMERATION_START (0x401a0000) // AD7477A driver enumeration start<br /> #define ADI_AD7478A_ENUMERATION_START (0x401b0000) // AD7478A driver enumeration start<br /> #define ADI_AD7476_ENUMERATION_START (0x401c0000) // AD7476 driver enumeration start<br /> #define ADI_AD7477_ENUMERATION_START (0x401d0000) // AD7477 driver enumeration start<br /> #define ADI_AD7478_ENUMERATION_START (0x401e0000) // AD7478 driver enumeration start<br /> #define ADI_AD7674_ENUMERATION_START (0x40040000) // AD7674 driver enumeration start<br /> // codec<br /> #define ADI_AD1836_ENUMERATION_START (0x40050000) // AD1836 driver enumeration start<br /> #define ADI_AD1938_ENUMERATION_START (0x40060000) // AD1938 driver enumeration start<br /> #define ADI_ADAV801_ENUMERATION_START (0x40070000) // ADAV801 driver enumeration start<br /> // dac<br /> #define ADI_AD1854_ENUMERATION_START (0x40080000) // AD1854 driver enumeration start<br /> #define ADI_AD5453_ENUMERATION_START (0x40270000) // AD5453 driver enumeration start<br /> // decoder<br /> #define ADI_ADV7183_ENUMERATION_START (0x40090000) // ADV7183 driver enumeration start<br /> // encoder<br /> #define ADI_ADV717x_ENUMERATION_START (0x400a0000) // ADV717x driver enumeration start<br /> // lcd<br /> #define ADI_NL6448BC3354_ENUMERATION_START (0x400b0000) // NEC NL6448BC3354 LCD driver enumeration start<br /> #define ADI_LQ10D368_ENUMERATION_START (0x40140000) // Sharp LQ10D368 LCD driver enumeration start<br /> #define ADI_TMS350MHQ03_ENUMERATION_START (0x401f0000) // TMS350MHQ03 LCD driver enumeration start (DMTC)<br /> #define ADI_LQ043T1DG01_ENUMERATION_START (0x40250000) // Sharp LQ043T1DG01 LCD driver enumeration start (BF548 Ez-Kit)<br /> // ppi<br /> #define ADI_PPI_ENUMERATION_START (0x400c0000) // PPI driver enumeration start<br /> // Pixel compositor<br /> #define ADI_PIXC_ENUMERATION_START (0x40160000) // Pixel compositor driver enumeration start<br /> // EPPI<br /> #define ADI_EPPI_ENUMERATION_START (0x40170000) // EPPI driver enumeration start<br /> // Keypad<br /> #define ADI_KEYPAD_ENUMERATION_START (0x40190000) // Keypad driver enumeration start<br /> // Touch screen<br /> #define ADI_AD7877_ENUMERATION_START (0x40180000) // AD7877 driver enumeration start<br /> // sensor<br /> #define ADI_MT9V022_ENUMERATION_START (0x400d0000) // Micron MT9V022 sensor driver enumeration start<br /> #define ADI_MT9V111_ENUMERATION_START (0x40150000) // Micron MT9V111 sensor driver enumeration start<br /> #define ADI_OV7x48_ENUMERATION_START (0x400e0000) // Omnivision OV7x48 sensor driver enumeration start<br /> // spi<br /> #define ADI_SPI_ENUMERATION_START (0x400f0000) // SPI driver enumeration start<br /> // sport<br /> #define ADI_SPORT_ENUMERATION_START (0x40100000) // SPORT driver enumeration start<br /> // twi<br /> #define ADI_TWI_ENUMERATION_START (0x40110000) // TWI driver enumeration start<br /> // uart<br /> #define ADI_UART_ENUMERATION_START (0x40120000) // UART driver enumeration start<br /> // rotary<br /> #define ADI_ROTARY_ENUMERATION_START (0x40200000) // Rotary driver enumeration start<br /> // USB<br /> #define ADI_USB_ENUMERATION_START (0x40210000) // common USB enumeration start<br /> #define ADI_USB_NET2272_ENUMERATION_START (0x40220000) // NET2272 USB controller driver enumeration start<br /> #define ADI_USB_BF54X_ENUMERATION_START (0x40230000) // BF54x USB controller driver enumeration start<br /> #define ADI_USB_BF52X_ENUMERATION_START (0x40240000) // BF52x USB controller driver enumeration start<br /> #define ADI_USB_MSD_ENUMERATION_START (0x40250000) // Mass Storage Device (peripheral mode) enumeration start<br /> #define ADI_USB_MSD_HOST_ENUMERATION_START (0x40260000) // Mass Storage Device (host mode) enumeration start</p> <p>/* These enumeration starts are no longer used going forward. They were used when all drivers<br /> shared the same enumeration starts. They are retained for compatibility with any drivers not<br /> using the new method. They should not be used in any new driver development. */<br /> #define ADI_DEV_CMD_PDD_START (0x40130000) /* old command ID enumerations */<br /> #define ADI_DEV_RESULT_PDD_START (0x40130000) /* old return code enumerations */<br /> #define ADI_DEV_EVENT_PDD_START (0x40130000) /* old event ID enumerations */</p> <p>/*********************************************************************<br /> Macros for the memory usage of the Device Manager<br /> *********************************************************************/<br /> #define ADI_DEV_BASE_MEMORY (12) /* base memory needed for the device manager (bytes) */<br /> #define ADI_DEV_DEVICE_MEMORY (104) /* additional memory needed for each device (bytes) */<br /> /*********************************************************************<br /> Macros for TWI/SPI Device Access Service for off chip devices<br /> *********************************************************************/<br /> #define ADI_DEV_REGEND 0xFFFF /* Device Access delimiter (indicates end of device register access) */<br /> /*********************************************************************<br /> Datatypes for handles into the device manager and device drivers<br /> *********************************************************************/<br /> typedef void *ADI_DEV_MANAGER_HANDLE; /* Handle to a device manager */<br /> typedef void *ADI_DEV_DEVICE_HANDLE; /* Handle to a device driver */<br /> typedef void *ADI_DEV_PDD_HANDLE; /* Handle to a physical device (used by device manager only)*/</p> <p>/*********************************************************************<br /> Dataflow enumerations<br /> *********************************************************************/<br /> typedef enum { /* Dataflow methods */<br /> ADI_DEV_MODE_UNDEFINED, /* undefined */<br /> ADI_DEV_MODE_CIRCULAR, /* circular buffer */<br /> ADI_DEV_MODE_CHAINED, /* chained */<br /> ADI_DEV_MODE_CHAINED_LOOPBACK, /* chained with loopback */<br /> ADI_DEV_MODE_SEQ_CHAINED, /* sequential chained */<br /> ADI_DEV_MODE_SEQ_CHAINED_LOOPBACK, /* sequential chained with loopback */<br /> } ADI_DEV_MODE;</p> <p>typedef enum { /* Data direction */<br /> ADI_DEV_DIRECTION_UNDEFINED, /* undefined */<br /> ADI_DEV_DIRECTION_INBOUND, /* inbound (read) */<br /> ADI_DEV_DIRECTION_OUTBOUND, /* outbound (write) */<br /> ADI_DEV_DIRECTION_BIDIRECTIONAL, /* both (read and write) */<br /> } ADI_DEV_DIRECTION;<br /> /*********************************************************************<br /> Enumerations for command IDs (extensible by physical drivers)<br /> *********************************************************************/</p> <p>enum { /* Command IDs */<br /> ADI_DEV_CMD_START=ADI_DEV_ENUMERATION_START,/* 0x40000000 - starting point */<br /> ADI_DEV_CMD_UNDEFINED, /* 0x0001 - undefined */</p> <p> ADI_DEV_CMD_END, /* 0x0002 - end of table (Value = NULL) */<br /> ADI_DEV_CMD_PAIR, /* 0x0003 - single command pair being passed (Value = ADI_DEV_CMD_VALUE_PAIR *) */<br /> ADI_DEV_CMD_TABLE, /* 0x0004 - table of command pairs being passed (Value = ADI_DEV_CMD_VALUE_PAIR *) */</p> <p> ADI_DEV_CMD_SET_DATAFLOW, /* 0x0005 - enable/disable dataflow (Value = TRUE/FALSE) */</p> <p> ADI_DEV_CMD_SET_DATAFLOW_METHOD, /* 0x0006 - set the dataflow method (Value = TRUE/FALSE) */<br /> ADI_DEV_CMD_NOT_USED_1, /* 0x0007 - no longer used (was GET_DATAFLOW_METHOD) */</p> <p> ADI_DEV_CMD_SET_SYNCHRONOUS, /* 0x0008 - set the device to synchronous I/O (Value = TRUE/FALSE) */<br /> ADI_DEV_CMD_NOT_USED_2, /* 0x0009 - no longer used (was GET_SYNCHRONOUS) */</p> <p> ADI_DEV_CMD_SET_STREAMING, /* 0x000a - sets streaming mode (Value = TRUE/FALSE) */</p> <p> ADI_DEV_CMD_GET_MAX_INBOUND_SIZE, /* 0x000b - get the size of the biggest inbound packet (Value = u32 *) */<br /> ADI_DEV_CMD_GET_MAX_OUTBOUND_SIZE, /* 0x000c - get the size of the biggest outbound packet (Value = u32 *) */</p> <p> ADI_DEV_CMD_GET_PERIPHERAL_DMA_SUPPORT, /* 0x000d - does the device support processor DMA (Value = u32 *) */<br /> ADI_DEV_CMD_GET_INBOUND_DMA_PMAP_ID, /* 0x000e - gets the peripheral's DMA PMAP value for inbound data (Value = ADI_DMA_PMAP *) */<br /> ADI_DEV_CMD_GET_OUTBOUND_DMA_PMAP_ID, /* 0x000f - gets the peripheral's DMA PMAP value for outbound data (Value = ADI_DMA_PMAP *) */<br /> ADI_DEV_CMD_SET_INBOUND_DMA_CHANNEL_ID, /* 0x0010 - sets the DMA channel ID for inbound DMA (Value = ADI_DMA_CHANNEL_ID) */<br /> ADI_DEV_CMD_GET_INBOUND_DMA_CHANNEL_ID, /* 0x0011 - gets the DMA channel ID for inbound DMA (Value = ADI_DMA_CHANNEL_ID *) */<br /> ADI_DEV_CMD_SET_OUTBOUND_DMA_CHANNEL_ID, /* 0x0012 - sets the DMA channel ID for outbound DMA (Value = ADI_DMA_CHANNEL_ID) */<br /> ADI_DEV_CMD_GET_OUTBOUND_DMA_CHANNEL_ID, /* 0x0013 - gets the DMA channel ID for outbound DMA (Value = ADI_DMA_CHANNEL_ID *) */<br /> ADI_DEV_CMD_GET_2D_SUPPORT, /* 0x0014 - queries whether the device supports 2D transfers (Value = u32 *) */</p> <p> ADI_DEV_CMD_SET_ERROR_REPORTING, /* 0x0015 - enables/disables error reporting (Value = TRUE/FALSE) */</p> <p> ADI_DEV_CMD_FREQUENCY_CHANGE_PROLOG, /* 0x0016 - notification of an impending core/system frequency change (Value = ADI_DEV_FREQUENCIES *CurrentFreqs) */<br /> ADI_DEV_CMD_FREQUENCY_CHANGE_EPILOG, /* 0x0017 - notification of new core/system frequency settings (Value = ADI_DEV_FREQUENCIES *NewFreqs) */</p> <p> /* TWI/SPI Device access service commands */<br /> ADI_DEV_CMD_REGISTER_READ, /* 0x0018 - reads a single device register (Value = ADI_DEV_ACCESS_REGISTER *) */<br /> ADI_DEV_CMD_REGISTER_FIELD_READ, /* 0x0019 - reads a specific device register field (Value = ADI_DEV_ACCESS_REGISTER_FIELD *) */<br /> ADI_DEV_CMD_REGISTER_TABLE_READ, /* 0x001a - reads a table of selective device registers (Value = ADI_DEV_ACCESS_REGISTER *) */<br /> ADI_DEV_CMD_REGISTER_FIELD_TABLE_READ, /* 0x001b - reads a table of selective device register(s) field(s) (Value = ADI_DEV_ACCESS_REGISTER_FIELD *) */<br /> ADI_DEV_CMD_REGISTER_BLOCK_READ, /* 0x001c - reads a block of consecutive device registers (Value = ADI_DEV_ACCESS_REGISTER_BLOCK *) */<br /> ADI_DEV_CMD_REGISTER_WRITE, /* 0x001d - writes to a single device register (Value = ADI_DEV_ACCESS_REGISTER *) */<br /> ADI_DEV_CMD_REGISTER_FIELD_WRITE, /* 0x001e - writes to a specific device register field (Value = ADI_DEV_ACCESS_REGISTER_FIELD *) */<br /> ADI_DEV_CMD_REGISTER_TABLE_WRITE, /* 0x001f - writes to a table of selective device registers (Value = ADI_DEV_ACCESS_REGISTER *) */<br /> ADI_DEV_CMD_REGISTER_FIELD_TABLE_WRITE, /* 0x0020 - writes to a table of selective device register(s) field(s) (Value = ADI_DEV_ACCESS_REGISTER_FIELD *) */<br /> ADI_DEV_CMD_REGISTER_BLOCK_WRITE, /* 0x0021 - writes to a block of consecutive device registers (Value = ADI_DEV_ACCESS_REGISTER_BLOCK *) */<br /> ADI_DEV_CMD_UPDATE_1D_DATA_POINTER, /* 0x0022 - updates the data pointer in a single 1D buffer (Value = ADI_DEV_1D_BUFFER *) */<br /> ADI_DEV_CMD_UPDATE_2D_DATA_POINTER, /* 0x0023 - updates the data pointer in a single 2D buffer (Value = ADI_DEV_2D_BUFFER *) */<br /> ADI_DEV_CMD_UPDATE_SEQ_1D_DATA_POINTER, /* 0x0024 - updates the data pointer in a single sequential 1D buffer (Value = ADI_DEV_SEQ_1D_BUFFER *) */</p> <p> ADI_DEV_CMD_GET_INBOUND_DMA_CURRENT_ADDRESS, /* 0x0025 - gets current address register value of Inbound DMA (Value = u32 *) */<br /> ADI_DEV_CMD_GET_OUTBOUND_DMA_CURRENT_ADDRESS, /* 0x0026 - gets current address register value of Outbound DMA (Value = u32 *) */</p> <p> ADI_DEV_CMD_GET_INBOUND_DMA_INFO, /* 0x0027 - gets channel information for Inbound DMAs (Value = ADI_DEV_DMA_INFO *) */<br /> ADI_DEV_CMD_GET_OUTBOUND_DMA_INFO, /* 0x0028 - gets channel information for Outbound DMAs (Value = ADI_DEV_DMA_INFO *) */<br /> ADI_DEV_CMD_OPEN_PERIPHERAL_DMA, /* 0x0029 - Peripheral requesting Device manager to open a DMA channel (Value = ADI_DEV_DMA_INFO *) */<br /> ADI_DEV_CMD_CLOSE_PERIPHERAL_DMA, /* 0x002a - Peripheral requesting Device manager to close a DMA channel (Value = ADI_DEV_DMA_INFO *) */</p> <p> ADI_DEV_CMD_SET_INBOUND_DMA_CHAIN_CHANNEL_ID, /* 0x002b - sets the DMA channel IDs for inbound DMA chain (Value = ADI_DEV_DMA_ACCESS *) */<br /> ADI_DEV_CMD_GET_INBOUND_DMA_CHAIN_CHANNEL_ID, /* 0x002c - gets the DMA channel IDs for inbound DMA chain (Value = ADI_DEV_DMA_ACCESS *) */<br /> ADI_DEV_CMD_SET_OUTBOUND_DMA_CHAIN_CHANNEL_ID, /* 0x002d - sets the DMA channel IDs for outbound DMA chain (Value = ADI_DEV_DMA_ACCESS *) */<br /> ADI_DEV_CMD_GET_OUTBOUND_DMA_CHAIN_CHANNEL_ID, /* 0x002e - gets the DMA channel IDs for outbound DMA chain (Value = ADI_DEV_DMA_ACCESS *) */</p> <p> ADI_DEV_CMD_GET_INBOUND_DMA_CHAIN_CURRENT_ADDRESS, /* 0x002f -gets current address register value of Inbound DMA chain (Value = ADI_DEV_DMA_ACCESS *) */<br /> ADI_DEV_CMD_GET_OUTBOUND_DMA_CHAIN_CURRENT_ADDRESS, /* 0x0030 -gets current address register value of Outbound DMA chain (Value = ADI_DEV_DMA_ACCESS *) */<br /> };</p> <p>typedef struct ADI_DEV_CMD_VALUE_PAIR { /* DEV command value pair */<br /> u32 CommandID; /* command ID */<br /> void *Value; /* parameter */<br /> } ADI_DEV_CMD_VALUE_PAIR;</p> <p>/*********************************************************************<br /> Enumerations for callback events (extensible by physical drivers)<br /> *********************************************************************/<br /> enum { /* Events */<br /> ADI_DEV_EVENT_START=ADI_DEV_ENUMERATION_START, /* 0x40000000 - starting point */</p> <p> ADI_DEV_EVENT_BUFFER_PROCESSED, /* 0x0001 - buffer completed processing */<br /> ADI_DEV_EVENT_SUB_BUFFER_PROCESSED, /* 0x0002 - a circular sub-buffer has been processed */<br /> ADI_DEV_EVENT_DMA_ERROR_INTERRUPT, /* 0x0003 - DMA controller generated an error interrupt */</p> <p>};<br /> /*********************************************************************<br /> Enumerations for return codes (extensible by physical drivers)<br /> *********************************************************************/<br /> enum { /* Return codes */<br /> ADI_DEV_RESULT_SUCCESS=0, /* generic success */<br /> ADI_DEV_RESULT_FAILED=1, /* generic failure */</p> <p> ADI_DEV_RESULT_START=ADI_DEV_ENUMERATION_START, /* 0x40000000 - starting point */</p> <p> ADI_DEV_RESULT_NOT_SUPPORTED, /* 0x0001 - not supported */<br /> ADI_DEV_RESULT_DEVICE_IN_USE, /* 0x0002 - device already in use */<br /> ADI_DEV_RESULT_NO_MEMORY, /* 0x0003 - insufficient memory for operation */<br /> ADI_DEV_RESULT_NOT_USED_1, /* 0x0004 - no longer used (was ADI_DEV_RESULT_TOO_MANY_DEVICES) */<br /> ADI_DEV_RESULT_BAD_DEVICE_NUMBER, /* 0x0005 - bad device number */<br /> ADI_DEV_RESULT_DIRECTION_NOT_SUPPORTED, /* 0x0006 - data direction not supported */<br /> ADI_DEV_RESULT_BAD_DEVICE_HANDLE, /* 0x0007 - bad device handle */<br /> ADI_DEV_RESULT_BAD_MANAGER_HANDLE, /* 0x0008 - bad device manager handle */<br /> ADI_DEV_RESULT_BAD_PDD_HANDLE, /* 0x0009 - bad physical driver handle */<br /> ADI_DEV_RESULT_INVALID_SEQUENCE, /* 0x000a - invalid sequence of commands */<br /> ADI_DEV_RESULT_ATTEMPTED_READ_ON_OUTBOUND_DEVICE, /* 0x000b - attempted read on outbound device */<br /> ADI_DEV_RESULT_ATTEMPTED_WRITE_ON_INBOUND_DEVICE, /* 0x000c - attempted write on inbound device */<br /> ADI_DEV_RESULT_DATAFLOW_UNDEFINED, /* 0x000d - dataflow method is undefined */<br /> ADI_DEV_RESULT_DATAFLOW_INCOMPATIBLE, /* 0x000e - operation is incompatible with the dataflow method */<br /> ADI_DEV_RESULT_BUFFER_TYPE_INCOMPATIBLE, /* 0x000f - device does not support the given buffer type */<br /> ADI_DEV_RESULT_NOT_USED_2, /* 0x0010 - no longer used (was ADI_DEV_RESULT_CALLBACK_ERROR) */<br /> ADI_DEV_RESULT_CANT_HOOK_INTERRUPT, /* 0x0011 - can't hook an interrupt */<br /> ADI_DEV_RESULT_CANT_UNHOOK_INTERRUPT, /* 0x0012 - can't unhood an interrupt */<br /> ADI_DEV_RESULT_NON_TERMINATED_LIST, /* 0x0013 - non-NULL terminated buffer list */<br /> ADI_DEV_RESULT_NO_CALLBACK_FUNCTION_SUPPLIED, /* 0x0014 - no callback function was provided to the open function */<br /> ADI_DEV_RESULT_REQUIRES_UNIDIRECTIONAL_DEVICE, /* 0x0015 - requires uni-directional device */<br /> ADI_DEV_RESULT_REQUIRES_BIDIRECTIONAL_DEVICE, /* 0x0016 - requires bidirectional device */</p> <p> /* Return codes for TWI/SPI Device access service */<br /> ADI_DEV_RESULT_TWI_LOCKED, /* 0x0017 - TWI locked in other operation */<br /> ADI_DEV_RESULT_REQUIRES_TWI_CONFIG_TABLE, /* 0x0018 - requires configuration table for the TWI driver */<br /> ADI_DEV_RESULT_CMD_NOT_SUPPORTED, /* 0x0019 - Command not supported */<br /> ADI_DEV_RESULT_INVALID_REG_ADDRESS, /* 0x001a - Accessing invalid Device Register address */<br /> ADI_DEV_RESULT_INVALID_REG_FIELD, /* 0x001b - Accessing invalid Device Register field location */<br /> ADI_DEV_RESULT_INVALID_REG_FIELD_DATA, /* 0x001c - Providing invalid Device Register field value */<br /> ADI_DEV_RESULT_ATTEMPT_TO_WRITE_READONLY_REG, /* 0x001d - Attempt to write a readonly register */<br /> ADI_DEV_RESULT_ATTEMPT_TO_ACCESS_RESERVE_AREA, /* 0x001e - Attempt to access a reserved location */<br /> ADI_DEV_RESULT_ACCESS_TYPE_NOT_SUPPORTED, /* 0x001f - Access type provided by the driver is not supported */<br /> ADI_DEV_RESULT_DATAFLOW_NOT_ENABLED, /* 0x0020 - In sync mode, buffers provided before dataflow enabled */<br /> ADI_DEV_RESULT_BAD_DIRECTION_FIELD, /* 0x0021 - In sequential I/O mode, buffers provided with an invalid direction value */<br /> ADI_DEV_RESULT_BAD_IVG, /* 0x0022 - Bad IVG number detected */</p> <p> ADI_DEV_RESULT_SWITCH_BUFFER_PAIR_INVALID, /* 0x0023 - Invalid buffer pair provided with Switch/Update switch buffer type */<br /> ADI_DEV_RESULT_DMA_CHANNEL_UNAVAILABLE, /* 0x0024 - No DMA channel is available to process the given command/buffer */<br /> ADI_DEV_RESULT_ATTEMPTED_BUFFER_TABLE_NESTING, /* 0x0025 - buffer table nesting is not allowed */<br /> };</p> <p>/*********************************************************************<br /> Enumerations for defining the details of the library being used.<br /> *********************************************************************/<br /> typedef enum ADI_DEV_LIBRARY_PROC { /* Processor */<br /> ADI_DEV_LIBRARY_PROC_UNKNOWN=0,<br /> ADI_DEV_LIBRARY_PROC_BF533,<br /> ADI_DEV_LIBRARY_PROC_BF537,<br /> ADI_DEV_LIBRARY_PROC_BF538,<br /> ADI_DEV_LIBRARY_PROC_BF548,<br /> ADI_DEV_LIBRARY_PROC_BF561<br /> } ADI_DEV_LIBRARY_PROC;<br /> typedef enum ADI_DEV_LIBRARY_CONFIG { /* Debug vs Release library */<br /> ADI_DEV_LIBRARY_CONFIG_UNKNOWN=0,<br /> ADI_DEV_LIBRARY_CONFIG_DEBUG,<br /> ADI_DEV_LIBRARY_CONFIG_RELEASE<br /> } ADI_DEV_LIBRARY_CONFIG;<br /> typedef enum ADI_DEV_LIBRARY_WRKRNDS { /* Chip workarounds for anomalies ("y" in the library name) */<br /> ADI_DEV_LIBRARY_WRKRNDS_UNKNOWN=0,<br /> ADI_DEV_LIBRARY_WRKRNDS_ENABLED,<br /> ADI_DEV_LIBRARY_WRKRNDS_DISABLED<br /> } ADI_DEV_LIBRARY_WRKRNDS;<br /> #define ADI_DEV_LIBRARY_CHIP_REV_NONE 0x7F /* This is for unknown chip revisions */<br /> #define ADI_DEV_LIBRARY_CHIP_REV_AUTO 0x7E /* This is for "auto" projects which automatically detect chip rev */</p> <p>typedef struct ADI_DEV_LIBRARY_DETAILS {<br /> enum ADI_DEV_LIBRARY_PROC Processor;<br /> enum ADI_DEV_LIBRARY_CONFIG Config;<br /> enum ADI_DEV_LIBRARY_WRKRNDS Workarounds;<br /> u8 ChipRev; /* This is a number representing the chip version of the processor */<br /> } ADI_DEV_LIBRARY_DETAILS;</p> <p>/*********************************************************************<br /> Callback options for devices opened using circular buffer mode<br /> *********************************************************************/<br /> typedef enum { /* Circular buffer callback type */<br /> ADI_DEV_CIRC_NO_CALLBACK, /* no callback */<br /> ADI_DEV_CIRC_SUB_BUFFER, /* callback on sub-buffer complete */<br /> ADI_DEV_CIRC_FULL_BUFFER, /* callback on full buffer complete */<br /> } ADI_DEV_CIRCULAR_CALLBACK;<br /> /*********************************************************************<br /> Enumerations and structures for buffers<br /> *********************************************************************/<br /> #define ADI_DEV_RESERVED_SIZE (sizeof(ADI_DMA_DESCRIPTOR_UNION)) /* size in bytes of reserved field in DEV_BUFFER */<br /> typedef enum { /* Buffer types */<br /> ADI_DEV_BUFFER_UNDEFINED, /* undefined */<br /> ADI_DEV_1D, /* 1 dimensional buffer */<br /> ADI_DEV_2D, /* 2 dimensional buffer */<br /> ADI_DEV_CIRC, /* circular buffer */<br /> ADI_DEV_SEQ_1D, /* sequential 1 dimensional buffer */<br /> ADI_DEV_SWITCH, /* Switch buffer */<br /> ADI_DEV_UPDATE_SWITCH, /* Buffer to chain with the existing Switch buffer */<br /> ADI_DEV_BUFFER_SKIP, /* skip this buffer & corresponding DMA channel (to support multi-DMA devices) */<br /> ADI_DEV_BUFFER_TABLE, /* Table of buffers */<br /> ADI_DEV_BUFFER_END, /* end of buffer array */<br /> } ADI_DEV_BUFFER_TYPE;<br /> typedef struct adi_dev_1d_buffer { /* 1D ("normal") buffer */<br /> char Reserved[ADI_DEV_RESERVED_SIZE]; /* reserved for physical device driver use */<br /> void *Data; /* pointer to data */<br /> u32 ElementCount; /* data element count */<br /> u32 ElementWidth; /* data element width (in bytes) */<br /> void *CallbackParameter; /* callback flag/pArg value */<br /> volatile u32 ProcessedFlag; /* processed flag */<br /> u32 ProcessedElementCount; /* # of bytes read in/out */<br /> struct adi_dev_1d_buffer *pNext; /* next buffer */<br /> void *pAdditionalInfo; /* device specific pointer to additional info */<br /> } ADI_DEV_1D_BUFFER;<br /> typedef struct adi_dev_2d_buffer { /* 2D buffer */<br /> char Reserved[ADI_DEV_RESERVED_SIZE]; /* reserved for physical device driver use */<br /> void *Data; /* pointer to data */<br /> u32 ElementWidth; /* data element width (in bytes) */<br /> u32 XCount; /* XCOUNT value for 2D */<br /> s32 XModify; /* XMODIFY value for 2D */<br /> u32 YCount; /* YCOUNT value for 2D */<br /> s32 YModify; /* YMODIFY value for 2D */<br /> void *CallbackParameter; /* callback flag/pArg value */<br /> volatile u32 ProcessedFlag; /* processed flag */<br /> u32 ProcessedElementCount; /* elements read in/out */<br /> struct adi_dev_2d_buffer *pNext; /* next buffer */<br /> void *pAdditionalInfo; /* device specific pointer to additional info */<br /> } ADI_DEV_2D_BUFFER;<br /> typedef struct adi_dev_circular_buffer { /* Circular buffer */<br /> char Reserved[ADI_DEV_RESERVED_SIZE]; /* reserved for physical driver use */<br /> void *Data; /* pointer to data */<br /> u32 SubBufferCount; /* number of subbuffers */<br /> u32 SubBufferElementCount; /* number of data elements in 1 subbuffer */<br /> u32 ElementWidth; /* data element width (in bytes) */<br /> ADI_DEV_CIRCULAR_CALLBACK CallbackType; /* circular buffer callback switch */<br /> void *pAdditionalInfo; /* device specific pointer to additional info */<br /> } ADI_DEV_CIRCULAR_BUFFER;<br /> typedef struct adi_dev_seq_1d_buffer { /* Sequential 1D buffer */<br /> ADI_DEV_1D_BUFFER Buffer; /* buffer */<br /> ADI_DEV_DIRECTION Direction; /* direction */<br /> } ADI_DEV_SEQ_1D_BUFFER;<br /> typedef struct ADI_DEV_BUFFER_PAIR { /* Buffer pair */<br /> ADI_DEV_BUFFER_TYPE BufferType; /* buffer type */<br /> union ADI_DEV_BUFFER *pBuffer; /* pointer to a buffer of above type */<br /> }ADI_DEV_BUFFER_PAIR;<br /> typedef union ADI_DEV_BUFFER { /* union of buffer types */<br /> ADI_DEV_1D_BUFFER OneD; /* 1D buffer */<br /> ADI_DEV_2D_BUFFER TwoD; /* 2D buffer */<br /> ADI_DEV_CIRCULAR_BUFFER Circular; /* circular buffer */<br /> ADI_DEV_SEQ_1D_BUFFER Seq1D; /* 1D sequential buffer */<br /> ADI_DEV_BUFFER_PAIR BufferPair; /* Buffer pair */<br /> } ADI_DEV_BUFFER;</p> <p>/*********************************************************************<br /> Data structure to hold peripheral DMA channel information<br /> *********************************************************************/<br /> typedef struct ADI_DEV_DMA_INFO { /* structure to hold peripheral DMA channel information */<br /> ADI_DMA_PMAP MappingID; /* DMA peripheral mapping ID */<br /> ADI_DMA_CHANNEL_HANDLE ChannelHandle; /* handle to this DMA channel */<br /> u8 SwitchModeFlag; /* Switch mode status flag (TRUE when in switch mode) */<br /> ADI_DMA_DESCRIPTOR_UNION *pSwitchHead; /* Head of Switch buffer chain */<br /> ADI_DMA_DESCRIPTOR_UNION *pSwitchTail; /* Tail of Switch buffer chain */<br /> struct ADI_DEV_DMA_INFO *pNext; /* pointer to structure holding next DMA channel info */<br /> } ADI_DEV_DMA_INFO;<br /> /*********************************************************************<br /> Data structure to access peripheral's Inbound/Outbound DMA chain data<br /> Values: DmaChannelCount - Holds number of Inbound/Outbound DMA channels<br /> to access in the selected peripheral's<br /> Inbound/Outbound DMA chain<br /> pData - Pointer to the first location in an array<br /> that holds (or) to hold DMA related data.<br /> The array data type should same as the<br /> DMA related data to be accessed.<br /> For example, to get channel id's of selected<br /> DMA channels in a peripheral, the array<br /> should be of type ADI_DMA_CHANNEL_ID, with<br /> address of the array passed as type void.</p> <p>*********************************************************************/<br /> typedef struct ADI_DEV_DMA_ACCESS<br /> {<br /> u8 DmaChannelCount; /* # DMA channels to access in the selected device */<br /> void *pData; /* start location of an array that holds/to hold DMA related data */<br /> }ADI_DEV_DMA_ACCESS;<br /> /*********************************************************************<br /> Data structures for frequency changes<br /> *********************************************************************/<br /> typedef struct ADI_DEV_FREQUENCIES { /* structure containing clock frequencies (in Hz) */<br /> u32 CoreClock; /* core clock (cclk) */<br /> u32 SystemClock; /* system clock (sclk) */<br /> u32 VCO; /* voltage controlled oscillator (vco) */<br /> } ADI_DEV_FREQUENCIES;<br /> /*********************************************************************<br /> Data structures for reads/writes of single, selective,<br /> blocks of offchip device registers and register field(s)<br /> *********************************************************************/<br /> /* Single and Selective Register Access */<br /> /* Data structure to access a single register */<br /> /* Array structure to access a table of selective device registers */<br /> typedef struct ADI_DEV_ACCESS_REGISTER<br /> {<br /> u16 Address; /* Device register address */<br /> u16 Data; /* Data read/written from/to the register */<br /> } ADI_DEV_ACCESS_REGISTER;<br /> /* Block Register Access */<br /> /* Data structure to access a block of consecutive registers */<br /> typedef struct ADI_DEV_ACCESS_REGISTER_BLOCK<br /> {<br /> u32 Count; /* number of registers to be accessed */<br /> u16 Address; /* starting address of register block */<br /> u16 *pData; /* pointer to a 'Count' sized array of register data read/written from/to the device */<br /> } ADI_DEV_ACCESS_REGISTER_BLOCK;<br /> /* Register Field Access */<br /> /* Basic element to access single register field */<br /> /*Array structure to access a table of selective device register(s) field(s)*/<br /> typedef struct ADI_DEV_ACCESS_REGISTER_FIELD<br /> {<br /> u16 Address; /* Register address to access */<br /> u16 Field; /* Register field in the above address to be accessed (list provided in corresponding offchip driver header file) */<br /> u16 Data; /* Register field data read/written from/to the device */<br /> } ADI_DEV_ACCESS_REGISTER_FIELD;<br /> /*********************************************************************<br /> Physical driver entry point<br /> *********************************************************************/<br /> typedef struct { /* Entry point to the physical driver */<br /> u32 (*adi_pdd_Open)( /* Open a device */<br /> ADI_DEV_MANAGER_HANDLE ManagerHandle, /* device manager handle */<br /> u32 DevNumber, /* device number */<br /> ADI_DEV_DEVICE_HANDLE DeviceHandle, /* DM handle */<br /> ADI_DEV_PDD_HANDLE *pPDDHandle, /* pointer to PDD handle location */<br /> ADI_DEV_DIRECTION Direction, /* data direction */<br /> void *pCriticalRegionArg,/* critical region parameter */<br /> ADI_DMA_MANAGER_HANDLE DMAHandle, /* handle to the DMA manager */<br /> ADI_DCB_HANDLE DCBHandle, /* callback handle */<br /> ADI_DCB_CALLBACK_FN DMCallback /* device manager callback function */<br /> );<br /> u32 (*adi_pdd_Close)( /* Closes a device */<br /> ADI_DEV_PDD_HANDLE PDDHandle /* PDD handle */<br /> );<br /> u32 (*adi_pdd_Read)( /* Reads data or queues an inbound buffer to a device */<br /> ADI_DEV_PDD_HANDLE PDDHandle, /* PDD handle */<br /> ADI_DEV_BUFFER_TYPE BufferType, /* buffer type */<br /> ADI_DEV_BUFFER *pBuffer /* pointer to buffer */<br /> );<br /> u32 (*adi_pdd_Write)( /* Writes data or queues an outbound buffer to a device */<br /> ADI_DEV_PDD_HANDLE PDDHandle, /* PDD handle */<br /> ADI_DEV_BUFFER_TYPE BufferType, /* buffer type */<br /> ADI_DEV_BUFFER *pBuffer /* pointer to buffer */<br /> );<br /> u32 (*adi_pdd_Control)( /* Sets or senses a device specific parameter */<br /> ADI_DEV_PDD_HANDLE PDDHandle, /* PDD handle */<br /> u32 CommandID, /* command ID */<br /> void *Value /* command specific value */<br /> );<br /> u32 (*adi_pdd_SequentialIO)( /* Sequentially reads/writes data to a device */<br /> ADI_DEV_PDD_HANDLE PDDHandle, /* PDD handle */<br /> ADI_DEV_BUFFER_TYPE BufferType, /* buffer type */<br /> ADI_DEV_BUFFER *pBuffer /* pointer to buffer */<br /> );<br /> } ADI_DEV_PDD_ENTRY_POINT;</p> <p>/*********************************************************************<br /> Device Manager API Function declarations<br /> *********************************************************************/</p> <p>#ifdef __cplusplus<br /> extern "C" {<br /> #endif<br /> u32 adi_dev_Init( /* Initializes the device Manager */<br /> void *pMemory, /* pointer to memory */<br /> const size_t MemorySize, /* size of memory (in bytes) */<br /> u32 *pMaxDevices, /* number of devices that can be supported */<br /> ADI_DEV_MANAGER_HANDLE *pManagerHandle, /*address where device manager will store the manager handle*/<br /> void *pEnterCriticalArg /* parameter for enter critical region */<br /> );</p> <p>u32 adi_dev_Terminate( /* Terminates the device Manager */<br /> ADI_DEV_MANAGER_HANDLE ManagerHandle /* device manager handle */<br /> );</p> <p>u32 adi_dev_Open( /* Open a device */<br /> ADI_DEV_MANAGER_HANDLE ManagerHandle, /* device manager handle */<br /> ADI_DEV_PDD_ENTRY_POINT *pEntryPoint, /* PDD entry point */<br /> u32 DevNumber, /* device number */<br /> void *ClientHandle, /* client handle */<br /> ADI_DEV_DEVICE_HANDLE *pDeviceHandle, /*pointer to location where the device handle will be stored*/<br /> ADI_DEV_DIRECTION Direction, /* data direction */<br /> ADI_DMA_MANAGER_HANDLE DMAHandle, /* handle to the DMA manager */<br /> ADI_DCB_HANDLE DCBHandle, /* handle to the callback manager */<br /> ADI_DCB_CALLBACK_FN ClientCallback /* client callback function */<br /> );</p> <p>u32 adi_dev_Close( /* Closes a device */<br /> ADI_DEV_DEVICE_HANDLE DeviceHandle /* Device handle */<br /> );</p> <p>u32 adi_dev_Read( /* Reads data or queues an inbound buffer to a device */<br /> ADI_DEV_DEVICE_HANDLE DeviceHandle, /* Device handle */<br /> ADI_DEV_BUFFER_TYPE BufferType, /* buffer type */<br /> ADI_DEV_BUFFER *pBuffer /* pointer to buffer */<br /> );</p> <p>u32 adi_dev_Write( /* Writes data or queues an outbound buffer to a device */<br /> ADI_DEV_DEVICE_HANDLE DeviceHandle, /* Device handle */<br /> ADI_DEV_BUFFER_TYPE BufferType, /* buffer type */<br /> ADI_DEV_BUFFER *pBuffer /* pointer to buffer */<br /> );</p> <p>u32 adi_dev_Control( /* Sets or senses a device specific parameter */<br /> ADI_DEV_DEVICE_HANDLE DeviceHandle, /* Device handle */<br /> u32 CommandID, /* command ID */<br /> void *Value /* command specific value */<br /> );</p> <p>u32 adi_dev_SequentialIO( /* Sequentially read/writes data to a device */<br /> ADI_DEV_DEVICE_HANDLE DeviceHandle, /* Device handle */<br /> ADI_DEV_BUFFER_TYPE BufferType, /* buffer type */<br /> ADI_DEV_BUFFER *pBuffer /* pointer to buffer */<br /> );</p> <p>u32 adi_dev_GetLibraryDetails( /* Get the processor, chip rev, debug/release, and other */<br /> ADI_DEV_LIBRARY_DETAILS *pLibraryDetails /* details for this particular library. */<br /> );<br /> #ifdef __cplusplus<br /> }<br /> #endif</p> <p>/********************************************************************************/<br /> #endif /* !defined(_LANGUAGE_ASM) */</p> <p>#endif /* __ADI_DEV_H__ */</p> <p>