1.1.3.4 Library Interface
RF215 driver library provides the following interfaces:
Functions
| Name | Description |
|---|---|
| DRV_RF215_Initialize | Initializes the RF215 driver |
| DRV_RF215_Status | Gets the current status of the RF215 driver module |
| DRV_RF215_Tasks | Maintains the RF215 driver's state machine |
| DRV_RF215_ReadyStatusCallbackRegister | Allows a client to set an event handling function for the driver to call back when it is ready to be opened |
| DRV_RF215_Open | Opens the specified RF215 driver instance and returns a handle to it |
| DRV_RF215_Close | Closes an opened-instance of the RF215 driver |
| DRV_RF215_RxIndCallbackRegister | Allows a client to set an event handling function for the driver to call back when a new PPDU is received |
| DRV_RF215_TxCfmCallbackRegister | Allows a client to set an event handling function for the driver to call back when a transmission request has finished |
| DRV_RF215_SetChannelCallbackRegister | Allows a client to set an event handling function for the driver to call back when frequency channel is updated (Only available if Frequency Hopping is enabled) |
| DRV_RF215_TxRequest | Allows a client to request data transmission through RF |
| DRV_RF215_TxCancel | Allows a client to cancel a previously requested transmission |
| DRV_RF215_SetChannelRequest | Allows a client to request RX frequency channel switch at specified time (Only available if Frequency Hopping is enabled) |
| DRV_RF215_GetPibSize | Gets size of PIB attribute |
| DRV_RF215_GetPib | Gets value of PIB attribute |
| DRV_RF215_SetPib | Sets value of PIB attribute |
Data types and constants
| Name | Type | Description |
|---|---|---|
| DRV_RF215_TX_HANDLE | Typedef | Handle identifying the transmission request queued |
| DRV_RF215_TX_HANDLE_INVALID | Macro | Definition of an invalid transmission handle |
| DRV_RF215_TRX_ID | Enum | Defines the available RF215 transceivers |
| DRV_RF215_READY_STATUS_CALLBACK | Typedef | Pointer to a RF215 driver ready status callback function |
| DRV_RF215_RX_IND_CALLBACK | Typedef | Pointer to a RF215 driver receive indication callback function |
| DRV_RF215_TX_CFM_CALLBACK | Typedef | Pointer to a RF215 driver transmit confirm callback function |
| DRV_RF215_SET_CHANNEL_CALLBACK | Typedef | Pointer to a RF215 set channel notification callback function |
| DRV_RF215_PHY_BAND_OPM | Enum | Defines the available PHY bands and Operating modes |
| DRV_RF215_FSK_SYM_RATE | Enum | Defines the available FSK symbol rates |
| DRV_RF215_FSK_MOD_IDX | Enum | Defines the available FSK modulation indexes |
| DRV_RF215_FSK_MOD_ORD | Enum | Defines the available FSK modulation orders |
| DRV_RF215_OFDM_BW_OPT | Enum | Defines the available OFDM bandwidth options |
| DRV_RF215_OFDM_ITLV_MODE | Enum | Defines the available OFDM Interleaving modes |
| DRV_RF215_PHY_TYPE | Enum | Defines the available PHY types |
| DRV_RF215_PHY_MOD_SCHEME | Enum | Defines the available PHY modulation schemes |
| DRV_RF215_PHY_CCA_MODE | Enum | Defines the available PHY CCA (Clear Channel Assessment) modes |
| DRV_RF215_TX_TIME_MODE | Enum | Defines the available TX time modes |
| DRV_RF215_TX_RESULT | Enum | Defines the possible PHY transmission results |
| DRV_RF215_PIB_ATTRIBUTE | Enum | Defines the list of PIB attributes |
| DRV_RF215_PIB_RESULT | Enum | Defines the list of PIB results |
| DRV_RF215_FSK_CFG_OBJ | Struct | Defines the data required to configure the RF215 FSK PHY |
| DRV_RF215_OFDM_CFG_OBJ | Struct | Defines the data required to configure the RF215 OFDM PHY |
| DRV_RF215_PHY_TYPE_CFG_OBJ | Union | Defines the data required to configure the RF215 FSK/OFDM PHY |
| DRV_RF215_PHY_CFG_OBJ | Struct | Defines the data required to configure the RF215 PHY |
| DRV_RF215_RX_INDICATION_OBJ | Struct | Defines the data reported in RF215 RX indication |
| DRV_RF215_TX_REQUEST_OBJ | Struct | Defines the parameters for TX request |
| DRV_RF215_TX_CONFIRM_OBJ | Struct | Defines the data reported in RF215 TX confirm |
| DRV_RF215_FW_VERSION | Struct | Defines the RF215 Driver firmware version data |
| DRV_RF215_PLIB_SPI_IS_BUSY | Typedef | Pointer to a PLIB function to check if SPI transmitter is busy |
| DRV_RF215_PLIB_SPI_SET_CS | Typedef | Pointer to a PLIB function to set the SPI chip select line |
| DRV_RF215_PLIB_SPI_WRITE_READ | Typedef | Pointer to a PLIB function to write and read through SPI |
| DRV_RF215_PLIB_SPI_SET_CALLBACK | Typedef | Pointer to a PLIB function to set SPI callback |
| DRV_RF215_INIT | Struct | Defines the data required to initialize the RF215 driver |