ADF7030-1 Device Drivers API Reference Manual  Alpha 0.0.1
Device Drivers for ADF7030-1 Transceiver
PHY Patch Interface
Collaboration diagram for PHY Patch Interface:

Data Structures

struct  PATCH_DESCRIPTOR_Type
 
struct  version_info_t
 

Typedefs

typedef struct PATCH_DESCRIPTOR_Type PATCH_DESCRIPTOR_Type
 

Functions

uint32_t adf7030_1__EjectPatch (ADI_SPI_HANDLE hSPIDevice, PATCH_DESCRIPTOR_Type *pPATCH)
 Function call to disnable the patch if needed. More...
 
uint32_t adf7030_1__InjectPatch (ADI_SPI_HANDLE hSPIDevice, PATCH_DESCRIPTOR_Type *pPATCH)
 Function call to re-enable the patch if needed. More...
 
uint32_t adf7030_1__ReadPatch (ADI_SPI_HANDLE hSPIDevice, PATCH_DESCRIPTOR_Type *pPATCH)
 Function call to readback the patch from Radio PHY. More...
 
uint32_t adf7030_1__VerifyPatch (ADI_SPI_HANDLE hSPIDevice, PATCH_DESCRIPTOR_Type *pPATCH)
 Function call to verify the integrity of the patch. More...
 
uint32_t adf7030_1__WritePatch (ADI_SPI_HANDLE hSPIDevice, PATCH_DESCRIPTOR_Type *pPATCH)
 Function call to write patch to Radio PHY. More...
 
uint32_t adf7030_1__XferPatch (ADI_SPI_HANDLE hSPIDevice, PATCH_DESCRIPTOR_Type *pPATCH, bool READ_nWRITE, bool CHECK_ONLY)
 Generic Patch transfers function between Host and the Radio PHY. More...
 
uint32_t adf7030_1_ReadPatchInfo (ADI_SPI_HANDLE hSPIDevice, version_info_t *pPathInfo, uint32_t PhyAddr)
 Function to read Patch Information from the PHY Radio. More...
 
uint32_t adf7030_1_WritePatchInfo (ADI_SPI_HANDLE hSPIDevice, version_info_t *pPathInfo, uint32_t PhyAddr)
 Function to write Patch Information to the PHY Radio. More...
 

Variables

uint32_t ADF7030_1_SPI_PNTR [8]
 

Detailed Description

Function Documentation

uint32_t adf7030_1__EjectPatch ( ADI_SPI_HANDLE  hSPIDevice,
PATCH_DESCRIPTOR_Type pPATCH 
)

Function call to disnable the patch if needed.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPatchDescriptor to the Host patch memory region.
Note
This function only disable the patch, it can be re-enable at a later stage by calling the adf7030_1__InjectPatch() function.
Returns
Status
  • #SUCCESS If the Eject sequence was succesfull.
  • #FAILURE [D] If the Eject failed.

Definition at line 183 of file adf7030-1__patch.c.

Here is the call graph for this function:

uint32_t adf7030_1__InjectPatch ( ADI_SPI_HANDLE  hSPIDevice,
PATCH_DESCRIPTOR_Type pPATCH 
)

Function call to re-enable the patch if needed.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPatchDescriptor to the Host patch memory region.
Note
This function assume the following the patch has already been transfered and that its integrity is valid. User can check the Ram for the patch presence by calling the function adf7030_1__VerifyPatch().
Returns
Status
  • #SUCCESS If the Inject sequence was succesfull.
  • #FAILURE [D] If the Inject failed.

Definition at line 150 of file adf7030-1__patch.c.

Here is the call graph for this function:

uint32_t adf7030_1__ReadPatch ( ADI_SPI_HANDLE  hSPIDevice,
PATCH_DESCRIPTOR_Type pPATCH 
)

Function call to readback the patch from Radio PHY.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPatchDescriptor to the Host patch memory region.
Note
This function only readback patch data from the PHY. ADF7030_1_SPI_PNTR[PNTR_CUSTOM0_ADDR] could be modified.
Returns
Status
  • #SUCCESS If the patch was readback successfully in the Host.
  • #FAILURE [D] If the patch transfert failed.

Definition at line 106 of file adf7030-1__patch.c.

Here is the call graph for this function:

uint32_t adf7030_1__VerifyPatch ( ADI_SPI_HANDLE  hSPIDevice,
PATCH_DESCRIPTOR_Type pPATCH 
)

Function call to verify the integrity of the patch.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPatchDescriptor to the Host patch memory region.
Note
This function only disable the patch, it can be re-enable at a later stage by calling the adf7030_1__InjectPatch() function. This function modifies ADF7030_1_SPI_PNTR[PNTR_CUSTOM0_ADDR].
Returns
Status
  • #SUCCESS If the patch in the PHY matches the reference in the Host.
  • #FAILURE [D] If the patch is different.

Definition at line 217 of file adf7030-1__patch.c.

Here is the call graph for this function:

uint32_t adf7030_1__WritePatch ( ADI_SPI_HANDLE  hSPIDevice,
PATCH_DESCRIPTOR_Type pPATCH 
)

Function call to write patch to Radio PHY.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPatchDescriptor to the Host patch memory region.
Note
This function only transfert patch data to the PHY. User must enable at a later stage by calling the adf7030_1__InjectPatch() function. This function modifies ADF7030_1_SPI_PNTR[PNTR_CUSTOM0_ADDR].
Returns
Status
  • #SUCCESS If the patch was written successfully in the Host.
  • #FAILURE [D] If the patch transfert failed.

Definition at line 81 of file adf7030-1__patch.c.

Here is the call graph for this function:

uint32_t adf7030_1__XferPatch ( ADI_SPI_HANDLE  hSPIDevice,
PATCH_DESCRIPTOR_Type pPATCH,
bool  READ_nWRITE,
bool  CHECK_ONLY 
)

Generic Patch transfers function between Host and the Radio PHY.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPatchDescriptor to the Host patch memory region.
[in]READ_nWRITEBoolean -TRUE to write Patch from Host to the Radio PHY -FALSE to read Patch from Radio PHY back to Host
[in]CHECK_ONLYBoolean -TRUE to check PHY patch versus Host Reference -FALSE [D] to perform READ_nWRITE operation
Note
This function can modify ADF7030_1_SPI_PNTR[PNTR_CUSTOM0_ADDR].
Returns
Status
  • #SUCCESS If the transfert was succesfull to the adf7030-1.
  • #FAILURE [D] If the transfert failed.

Definition at line 364 of file adf7030-1__patch.c.

Referenced by adf7030_1__ReadPatch(), adf7030_1__VerifyPatch(), and adf7030_1__WritePatch().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t adf7030_1_ReadPatchInfo ( ADI_SPI_HANDLE  hSPIDevice,
version_info_t pPathInfo,
uint32_t  PhyAddr 
)

Function to read Patch Information from the PHY Radio.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in|out]pPathInfo Pointer to Host patch descriptor memory region.
[in]PhyAddrAddress location of patch descriptor in the PHY Radio memory space.
Note
This function modifies ADF7030_1_SPI_PNTR[PNTR_CUSTOM0_ADDR].
Returns
Status
  • #SUCCESS If the Patch Information has been read back into pPathInfo.
  • #FAILURE [D] If the Patch Information could not be read.

Definition at line 303 of file adf7030-1__patch.c.

Here is the call graph for this function:

uint32_t adf7030_1_WritePatchInfo ( ADI_SPI_HANDLE  hSPIDevice,
version_info_t pPathInfo,
uint32_t  PhyAddr 
)

Function to write Patch Information to the PHY Radio.

Parameters
[in]hSPIDeviceHandle to Glue SPI peripheral device used to communicate with the adf7030-1.
[in]pPathInfoPointer to Host patch descriptor memory region.
[in]PhyAddrAddress location of patch descriptor in the PHY Radio memory space.
Note
This function modifies ADF7030_1_SPI_PNTR[PNTR_CUSTOM0_ADDR].
Returns
Status
  • #SUCCESS If the Patch Information has been read back into pPathInfo.
  • #FAILURE [D] If the Patch Information could not be read.

Definition at line 244 of file adf7030-1__patch.c.

Here is the call graph for this function: