 |
dfeofdm
Vitis Drivers API Documentation
|
|
dfeofdm
Vitis Drivers API Documentation
|
Data Structures | |
| struct | XDfeOfdm_Version |
| LogiCORE version. More... | |
| struct | XDfeOfdm_Trigger |
| Trigger configuration. More... | |
| struct | XDfeOfdm_TriggerCfg |
| All IP triggers. More... | |
| struct | XDfeOfdm_CCSequence |
| Defines a CCID sequence. More... | |
| struct | XDfeOfdm_FTSequence |
| Defines an FT sequence. More... | |
| struct | XDfeOfdm_ModelParameters |
| OFDM model parameters structure. More... | |
| struct | XDfeOfdm_Cfg |
| Configuration. More... | |
| struct | XDfeOfdm_Init |
| Initialization, "one-time" configuration parameters. More... | |
| struct | XDfeOfdm_CarrierCfg |
| Configuration for a single CC. More... | |
| struct | XDfeOfdm_InternalCarrierCfg |
| Internal configuration for a single CC. More... | |
| struct | XDfeOfdm_CCCfg |
| Full CC configuration. More... | |
| struct | XDfeOfdm_Status |
| OFDM Status. More... | |
| struct | XDfeOfdm_InterruptMask |
| Interrupt mask. More... | |
| struct | XDfeOfdm_Config |
| OFDM Configuration structure. More... | |
| struct | XDfeOfdm |
| OFDM Structure. More... | |
Macros | |
| #define | XDFEOFDM_MAX_NUM_INSTANCES (10U) |
| Maximum number of driver instances running at the same time. More... | |
| #define | XDFEOFDM_INSTANCE_EXISTS(X) (X < XDFEOFDM_MAX_NUM_INSTANCES) |
| Number of instances that exist at any given time. More... | |
| #define | XST_SUCCESS (0U) |
| Success flag. More... | |
| #define | XST_FAILURE (1U) |
| Failure flag. More... | |
| #define | XDFEOFDM_NODE_NAME_MAX_LENGTH (50U) |
| Node name maximum length. More... | |
| #define | XDFEOFDM_CC_NUM (16) |
| Maximum CC sequence number. More... | |
| #define | XDFEOFDM_FT_NUM (16) |
| Maximum FT sequence number. More... | |
| #define | XDFEOFDM_CC_SEQ_LENGTH_MAX (16U) |
| Maximum sequence length. More... | |
| #define | XDFEOFDM_FT_SEQ_LENGTH_MAX (16U) |
| Maximum Fourier transform sequence length. More... | |
| #define | XDFEOFDM_PHASE_COMPENSATION_MAX (112U) |
| Maximum phase compensation weight. More... | |
Enumerations | |
| enum | XDfeOfdm_StateId { XDFEOFDM_STATE_NOT_READY = 0, XDFEOFDM_STATE_READY, XDFEOFDM_STATE_RESET, XDFEOFDM_STATE_CONFIGURED, XDFEOFDM_STATE_INITIALISED, XDFEOFDM_STATE_OPERATIONAL } |
Functions | |
| XDfeOfdm * | XDfeOfdm_InstanceInit (const char *DeviceNodeName) |
| Initializes one instance of the OFDM driver and traverses the "/sys/bus/platform/device" directory (in Linux) to find the registered OFDM device with the name DeviceNodeName. More... | |
| void | XDfeOfdm_InstanceClose (XDfeOfdm *InstancePtr) |
| Closes the instances of the OFDM driver and moves the state machine to a Not Ready state. More... | |
| void | XDfeOfdm_Reset (XDfeOfdm *InstancePtr) |
| Resets the OFDM instance and puts block into a reset state. More... | |
| void | XDfeOfdm_Configure (XDfeOfdm *InstancePtr, XDfeOfdm_Cfg *Cfg) |
| Reads configuration from device tree/xparameters.h and IP registers. More... | |
| void | XDfeOfdm_Initialize (XDfeOfdm *InstancePtr, XDfeOfdm_Init *Init) |
| Initializes the OFDM driver and moves the state machine to an initialized state. More... | |
| void | XDfeOfdm_Activate (XDfeOfdm *InstancePtr, bool EnableLowPower) |
| Activates OFDM and moves the state machine to an activated state. More... | |
| void | XDfeOfdm_Deactivate (XDfeOfdm *InstancePtr) |
| Deactivates OFDM and moves the state machine to an initialised state. More... | |
| XDfeOfdm_StateId | XDfeOfdm_GetStateID (XDfeOfdm *InstancePtr) |
| Gets a state machine state ID. More... | |
| void | XDfeOfdm_GetCurrentCCCfg (const XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CurrCCCfg) |
| Returns the current CC configuration. More... | |
| void | XDfeOfdm_GetEmptyCCCfg (const XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CCCfg) |
| Returns configuration structure CCCfg with CCCfg->CCSequence.Length value set in XDfeOfdm_Configure(), array CCCfg->CCSequence.CCID[] members are set to not used value (-1) and the other CCCfg members are set to 0. More... | |
| void | XDfeOfdm_GetCarrierCfg (const XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CCCfg, s32 CCID, u32 *CCSeqBitmap, XDfeOfdm_CarrierCfg *CarrierCfg) |
| Returns the current CCID carrier configuration. More... | |
| u32 | XDfeOfdm_AddCCtoCCCfg (XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CCCfg, s32 CCID, u32 CCSeqBitmap, const XDfeOfdm_CarrierCfg *CarrierCfg, XDfeOfdm_FTSequence *FTSeq) |
| Adds specified CCID, with specified configuration, to a local CC configuration structure. More... | |
| u32 | XDfeOfdm_RemoveCCfromCCCfg (XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CCCfg, s32 CCID, XDfeOfdm_FTSequence *FTSeq) |
| Removes specified CCID from a local CC configuration structure. More... | |
| u32 | XDfeOfdm_UpdateCCinCCCfg (XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CCCfg, s32 CCID, const XDfeOfdm_CarrierCfg *CarrierCfg, XDfeOfdm_FTSequence *FTSeq) |
| Updates a specified CCID with the specified configuration to a local CC configuration structure. More... | |
| void | XDfeOfdm_SetNextCCCfg (const XDfeOfdm *InstancePtr, const XDfeOfdm_CCCfg *NextCCCfg) |
| Sets the next CC configuration. More... | |
| u32 | XDfeOfdm_EnableCCUpdateTrigger (const XDfeOfdm *InstancePtr) |
| Reads the triggers and sets the enable bit of Update trigger. More... | |
| u32 | XDfeOfdm_SetNextCCCfgAndTrigger (const XDfeOfdm *InstancePtr, XDfeOfdm_CCCfg *CCCfg) |
| Writes local CC configuration to the shadow (NEXT) registers and triggers copying from shadow to operational registers. More... | |
| void | XDfeOfdm_GetTriggersCfg (const XDfeOfdm *InstancePtr, XDfeOfdm_TriggerCfg *TriggerCfg) |
| Returns the current trigger configuration. More... | |
| void | XDfeOfdm_SetTriggersCfg (const XDfeOfdm *InstancePtr, XDfeOfdm_TriggerCfg *TriggerCfg) |
| Sets the trigger configuration. More... | |
| void | XDfeOfdm_SetTuserOutFrameLocation (const XDfeOfdm *InstancePtr, u32 TuserOutFrameLocation) |
| Sets the TUSER Framing bit location register where bit location indicates which bit to be used for sending the framing information on DL_DOUT IF and M_AXIS_TBASE IF. More... | |
| u32 | XDfeOfdm_GetTuserOutFrameLocation (const XDfeOfdm *InstancePtr) |
| Gets the TUSER Framing bit location register where bit location indicates which bit to be used for sending framing information on DL_DOUT IF and M_AXIS_TBASE IF. More... | |
| void | XDfeOfdm_SetTuserCCUpdateTrigger (const XDfeOfdm *InstancePtr, u32 TuserCCUpdateTrigger) |
| Sets the TUSER CC Update trigger where bit location would indicate which bit to be used for sending cc update triggering on TUSER (DL_DOUT IF and M_AXIS_TBASE IF). More... | |
| u32 | XDfeOfdm_GetTuserCCUpdateTrigger (const XDfeOfdm *InstancePtr) |
| Gets the TUSER CC Update trigger. More... | |
| void | XDfeOfdm_GetEventStatus (const XDfeOfdm *InstancePtr, XDfeOfdm_Status *Status) |
| Gets event status. More... | |
| void | XDfeOfdm_ClearEventStatus (const XDfeOfdm *InstancePtr, const XDfeOfdm_Status *Status) |
| Clears the event status. More... | |
| void | XDfeOfdm_SetInterruptMask (const XDfeOfdm *InstancePtr, const XDfeOfdm_InterruptMask *Mask) |
| Sets interrupt masks. More... | |
| void | XDfeOfdm_GetInterruptMask (const XDfeOfdm *InstancePtr, XDfeOfdm_InterruptMask *Mask) |
| Gets interrupt masks. More... | |
| void | XDfeOfdm_SetTUserDelay (const XDfeOfdm *InstancePtr, u32 Delay) |
| Sets the delay to be added to TUSER and TLAST (delay matched through the IP). More... | |
| u32 | XDfeOfdm_GetTUserDelay (const XDfeOfdm *InstancePtr) |
| Reads the delay, which will be added to TUSER and TLAST (delay matched through the IP). More... | |
| u32 | XDfeOfdm_GetDataLatency (const XDfeOfdm *InstancePtr) |
| Returns data latency. More... | |
| void | XDfeOfdm_GetVersions (const XDfeOfdm *InstancePtr, XDfeOfdm_Version *SwVersion, XDfeOfdm_Version *HwVersion) |
| Gets the driver version. More... | |