ADF7030-1 Device Drivers API Reference Manual
Alpha 0.0.1
Device Drivers for ADF7030-1 Transceiver
|
Data Structures | |
struct | BLOCK_XFER_DESCRIPTOR_Type |
struct | config_info_t |
struct | DATA_BLOCK_DESCRIPTOR_Type |
struct | MEM_CFG_DESCRIPTOR_Type |
struct | MEM_DESCRIPTOR_Type |
struct | RANDOM_XFER_DESCRIPTOR_Type |
Typedefs | |
typedef struct MEM_CFG_DESCRIPTOR_Type | MEM_CFG_DESCRIPTOR_Type |
typedef struct MEM_DESCRIPTOR_Type | MEM_DESCRIPTOR_Type |
Functions | |
uint32_t | adf7030_1__ReadConfig (ADI_SPI_HANDLE hSPIDevice, MEM_CFG_DESCRIPTOR_Type *pCONFIG) |
Function call to read Configuration from Radio PHY. More... | |
uint32_t | adf7030_1__SPI_GetBytes (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint32_t nbBytes) |
Read "nbBytes" memory location via the SPI. More... | |
uint32_t | adf7030_1__SPI_GetField (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint32_t Pos, uint32_t Size) |
Generic readback of a bitfield value from the Radio PHY via the SPI. More... | |
uint16_t | adf7030_1__SPI_GetMem16 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr) |
Read a 16bits memory location via the SPI. More... | |
uint32_t | adf7030_1__SPI_GetMem24 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr) |
Read a 24bits memory location via the SPI. More... | |
uint32_t | adf7030_1__SPI_GetMem32 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr) |
Read a single 32bits memory location via the SPI. More... | |
uint8_t | adf7030_1__SPI_GetMem8 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr) |
Read a 8bits memory location via the SPI. More... | |
void | adf7030_1__SPI_SetBytes (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint32_t Value, uint32_t nbBytes) |
Writes "nbBytes" memory location via the SPI. More... | |
void | adf7030_1__SPI_SetField (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint32_t Pos, uint32_t Size, uint32_t Val) |
Generic setting of a Radio PHY bitfield to a value via the SPI. More... | |
void | adf7030_1__SPI_SetMem16 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint16_t Value) |
Write a single 16bits memory location via the SPI. More... | |
void | adf7030_1__SPI_SetMem24 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint32_t Value) |
Write a single 24bits memory location via the SPI. More... | |
void | adf7030_1__SPI_SetMem32 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint32_t Value) |
Write a single 32bits memory location via the SPI. More... | |
void | adf7030_1__SPI_SetMem8 (ADI_SPI_HANDLE hSPIDevice, uint32_t Addr, uint8_t Value) |
Write a single 8bits memory location via the SPI. More... | |
uint32_t | adf7030_1__SPI_Xfer_Mem (ADI_SPI_HANDLE hSPIDevice, MEM_DESCRIPTOR_Type *pMEM, bool READ_nWRITE) |
Generic memory transfers function between Host shadow and the Radio PHY. More... | |
uint32_t | adf7030_1__VerifyConfig (ADI_SPI_HANDLE hSPIDevice, MEM_CFG_DESCRIPTOR_Type *pCONFIG) |
Function call to verify the integrity of the patch. More... | |
uint32_t | adf7030_1__WriteConfig (ADI_SPI_HANDLE hSPIDevice, MEM_CFG_DESCRIPTOR_Type *pCONFIG) |
Function call to write Configuration to Radio PHY. More... | |
uint32_t | adf7030_1__XferConfig (ADI_SPI_HANDLE hSPIDevice, MEM_CFG_DESCRIPTOR_Type *pCONFIG, bool READ_nWRITE, bool CHECK_ONLY) |
Generic Configuration transfers function between Host and the Radio PHY. More... | |
Variables | |
uint32_t | ADF7030_1_SPI_PNTR [8] |
#define adf7030_1__READ_FIELD | ( | fName | ) |
Definition at line 242 of file adf7030-1__mem.h.
#define adf7030_1__READ_FIELD2 | ( | fName | ) |
Definition at line 248 of file adf7030-1__mem.h.
#define adf7030_1__READ_REG | ( | rName | ) |
Definition at line 280 of file adf7030-1__mem.h.
#define adf7030_1__WRITE_FIELD | ( | fName, | |
fValue | |||
) |
Definition at line 206 of file adf7030-1__mem.h.
#define adf7030_1__WRITE_FIELD2 | ( | fName, | |
fValue | |||
) |
Definition at line 213 of file adf7030-1__mem.h.
#define adf7030_1__WRITE_REG | ( | rName, | |
rValue | |||
) |
Definition at line 274 of file adf7030-1__mem.h.
uint32_t adf7030_1__ReadConfig | ( | ADI_SPI_HANDLE | hSPIDevice, |
MEM_CFG_DESCRIPTOR_Type * | pCONFIG | ||
) |
Function call to read Configuration from Radio PHY.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | pCONFIG | Pointer to Host configuration structure. |
Definition at line 101 of file adf7030-1__mem.c.
uint32_t adf7030_1__SPI_GetBytes | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint32_t | nbBytes | ||
) |
Read "nbBytes" memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
[in] | nbBytes | Number of Bytes to read (1, 2, 3 or 4); |
Definition at line 740 of file adf7030-1__mem.c.
Referenced by adf7030_1__SPI_GetField(), adf7030_1__SPI_GetMem16(), adf7030_1__SPI_GetMem24(), adf7030_1__SPI_GetMem32(), adf7030_1__SPI_GetMem8(), and adf7030_1__SPI_SetField().
uint32_t adf7030_1__SPI_GetField | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint32_t | Pos, | ||
uint32_t | Size | ||
) |
Generic readback of a bitfield value from the Radio PHY via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | 32bit alligned PHY Address location of the bitfield. |
[in] | Pos | Starting bit position withing the 32bits word. |
[in] | Size | Bit lenght of the bitfield. |
Definition at line 858 of file adf7030-1__mem.c.
uint16_t adf7030_1__SPI_GetMem16 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr | ||
) |
Read a 16bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
Definition at line 605 of file adf7030-1__mem.c.
uint32_t adf7030_1__SPI_GetMem24 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr | ||
) |
Read a 24bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
Definition at line 556 of file adf7030-1__mem.c.
uint32_t adf7030_1__SPI_GetMem32 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr | ||
) |
Read a single 32bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
Definition at line 507 of file adf7030-1__mem.c.
uint8_t adf7030_1__SPI_GetMem8 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr | ||
) |
Read a 8bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
Definition at line 654 of file adf7030-1__mem.c.
void adf7030_1__SPI_SetBytes | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint32_t | Value, | ||
uint32_t | nbBytes | ||
) |
Writes "nbBytes" memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
[in] | Value | Value to write. |
[in] | nbBytes | Number of Bytes to writes (1, 2, 3 or 4); |
Definition at line 681 of file adf7030-1__mem.c.
Referenced by adf7030_1__SPI_SetField(), adf7030_1__SPI_SetMem16(), adf7030_1__SPI_SetMem24(), adf7030_1__SPI_SetMem32(), and adf7030_1__SPI_SetMem8().
void adf7030_1__SPI_SetField | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint32_t | Pos, | ||
uint32_t | Size, | ||
uint32_t | Val | ||
) |
Generic setting of a Radio PHY bitfield to a value via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | 32bit alligned PHY Address location of the bitfield. |
[in] | Pos | Starting bit position withing the 32bits word. |
[in] | Size | Bit lenght of the bitfield. |
[in] | Val | Bitfield value. |
Definition at line 804 of file adf7030-1__mem.c.
void adf7030_1__SPI_SetMem16 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint16_t | Value | ||
) |
Write a single 16bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
[in] | Value | 16bits Value to write. |
Definition at line 581 of file adf7030-1__mem.c.
void adf7030_1__SPI_SetMem24 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint32_t | Value | ||
) |
Write a single 24bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
[in] | Value | 24bits Value to write. |
Definition at line 532 of file adf7030-1__mem.c.
void adf7030_1__SPI_SetMem32 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint32_t | Value | ||
) |
Write a single 32bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
[in] | Value | 32bits Value to write. |
Definition at line 486 of file adf7030-1__mem.c.
void adf7030_1__SPI_SetMem8 | ( | ADI_SPI_HANDLE | hSPIDevice, |
uint32_t | Addr, | ||
uint8_t | Value | ||
) |
Write a single 8bits memory location via the SPI.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | Addr | PHY Address location at which the SPI will write. |
[in] | Value | 8bits Value to write. |
Definition at line 630 of file adf7030-1__mem.c.
uint32_t adf7030_1__SPI_Xfer_Mem | ( | ADI_SPI_HANDLE | hSPIDevice, |
MEM_DESCRIPTOR_Type * | pMEM, | ||
bool | READ_nWRITE | ||
) |
Generic memory transfers function between Host shadow and the Radio PHY.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | pMEM | Descriptor to the paired Host/PHY memory region. |
[in] | READ_nWRITE | Boolean -TRUE to write from Host shadow to the Radio PHY -FALSE to read from Radio PHY back to Host shadow |
Definition at line 329 of file adf7030-1__mem.c.
uint32_t adf7030_1__VerifyConfig | ( | ADI_SPI_HANDLE | hSPIDevice, |
MEM_CFG_DESCRIPTOR_Type * | pCONFIG | ||
) |
Function call to verify the integrity of the patch.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | pCONFIG | Pointer to Host configuration structure. |
Definition at line 127 of file adf7030-1__mem.c.
uint32_t adf7030_1__WriteConfig | ( | ADI_SPI_HANDLE | hSPIDevice, |
MEM_CFG_DESCRIPTOR_Type * | pCONFIG | ||
) |
Function call to write Configuration to Radio PHY.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | pCONFIG | Pointer to Host configuration structure. |
Definition at line 77 of file adf7030-1__mem.c.
uint32_t adf7030_1__XferConfig | ( | ADI_SPI_HANDLE | hSPIDevice, |
MEM_CFG_DESCRIPTOR_Type * | pCONFIG, | ||
bool | READ_nWRITE, | ||
bool | CHECK_ONLY | ||
) |
Generic Configuration transfers function between Host and the Radio PHY.
[in] | hSPIDevice | Handle to Glue SPI peripheral device used to communicate with the adf7030-1. |
[in] | pCONFIG | Pointer to Host configuration structure. |
[in] | READ_nWRITE | Boolean -TRUE to write Config from Host to the Radio PHY -FALSE to read Config from Radio PHY back to Host |
[in] | CHECK_ONLY | Boolean -TRUE to check PHY Config versus Host Reference -FALSE [D] to perform READ_nWRITE operation |
Definition at line 156 of file adf7030-1__mem.c.
Referenced by adf7030_1__ReadConfig(), adf7030_1__VerifyConfig(), and adf7030_1__WriteConfig().