Data Structures
Collaboration diagram for Data Structures:
|
Data Structures | |
| struct | IfxPsi5s_Psi5s_Clock |
| Clock configuration data structure. More... | |
| struct | IfxPsi5s_Psi5s_ReceivedBits |
| Received individual bits. More... | |
| struct | IfxPsi5s_Psi5s_ReceivedData |
| Receive data structure with different segments of data. More... | |
| struct | IfxPsi5s_Psi5s_Timestamp |
| Received timestamp contents structure. More... | |
| struct | IfxPsi5s_Psi5s |
| PSI5S handle data structure. More... | |
| struct | IfxPsi5s_Psi5s_AscConfig |
| PSI5S module configuration structure. More... | |
| struct | IfxPsi5s_Psi5s_ChannelTrigger |
| channel trigger configuration structure More... | |
| struct | IfxPsi5s_Psi5s_GlobalControlConfig |
| PSI5S global control configuration structure. More... | |
| struct | IfxPsi5s_Psi5s_Pins |
| Structure for PSI5S pin configuration. More... | |
| struct | IfxPsi5s_Psi5s_PulseGeneration |
| Sync pulse generation configuration structure. More... | |
| struct | IfxPsi5s_Psi5s_ReceiveControl |
| Receive control configuration structure - covers control fields from RCRA, RCRB and NFC registers. More... | |
| union | IfxPsi5s_Psi5s_ReceiveData |
| "Received data" data structure More... | |
| union | IfxPsi5s_Psi5s_ReceiveStatus |
| Receiver status data structure. More... | |
| union | IfxPsi5s_Psi5s_ReceiveTimestamp |
| Receiver timestamp data structure. More... | |
| struct | IfxPsi5s_Psi5s_TimeStampConfig |
| Timestamp configuration data structure. More... | |
| struct | IfxPsi5s_Psi5s_TransmitControl |
| Transmit control configuration structure. More... | |
| struct | IfxPsi5s_Psi5s_Channel |
| Channel handle data structure. More... | |
| struct | IfxPsi5s_Psi5s_ChannelConfig |
| Channel configuration structure. More... | |
| struct | IfxPsi5s_Psi5s_Config |
| PSI5S module configuration structure. More... | |
| struct | IfxPsi5s_Psi5s_Frame |
| Psi5s frame data structure. More... | |
Detailed Description
Data Structure Documentation
| struct IfxPsi5s_Psi5s_Clock |
Clock configuration data structure.
Definition at line 160 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| uint32 | frequency | Specifies the frequency for the clock. |
| IfxPsi5s_DividerMode | mode | Specifies the mode of division for the clock. |
| IfxPsi5s_ClockType | type | Specifies the type of clock (fracDiv / timestamp) |
| struct IfxPsi5s_Psi5s_ReceivedBits |
Received individual bits.
Definition at line 169 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| uint8 | actualUartFrameCount: 3 | UART frames actually received. |
| uint8 | ascFramingErrorFlag: 1 | ASC framing error flag. |
| uint8 | ascOverrunErrorFlag: 1 | ASC overrun error flag. |
| uint8 | ascParityErrorFlag: 1 | ASC parity error flag. |
| uint8 | channelId: 3 | Channel ID. |
| uint8 | crc: 3 | Received CRC. |
| uint8 | crcError: 1 | CRC error flag. |
| uint8 | errorFlag0: 1 | Error signalling flag 0. |
| uint8 | errorFlag1: 1 | Error signalling flag 1. |
| uint8 | frameId: 3 | Frame ID. |
| uint8 | headerErrorFlag: 1 | Header error signalling flag. |
| uint8 | packetFrameCount: 4 | Packet frame count. |
| uint8 | receiveBufferOverflowFlag: 1 | Receive buffer overflow flag. |
| uint8 | watchdogTimeoutErrorFlag: 1 | Watchdog timeout error flag. |
| uint8 | xcrc: 6 | Received XCRC. |
| uint8 | xcrcError: 1 | XCRC error flag. |
| struct IfxPsi5s_Psi5s_ReceivedData |
Receive data structure with different segments of data.
Definition at line 191 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| uint8 | packetFrameCount | Packet frame count. |
| uint32 | readData: 28 | Received data. |
| struct IfxPsi5s_Psi5s_Timestamp |
Received timestamp contents structure.
Definition at line 199 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| uint8 | packetFrameCount: 4 | Packet frame count. |
| uint32 | timestamp: 24 | Received data. |
| struct IfxPsi5s_Psi5s |
PSI5S handle data structure.
Definition at line 211 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| Ifx_PSI5S * | psi5s | Specifies the pointer to the PSI5S module registers. |
| struct IfxPsi5s_Psi5s_AscConfig |
PSI5S module configuration structure.
Definition at line 218 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_AscConfig:
| Data Fields | ||
|---|---|---|
| uint32 | baudrateFrequency | Specifies the baudrate frequency. |
| IfxPsi5s_AscBaudratePrescalar | baudrateSelection | Specifies whether divide-by-2 or divide-by-3 is selected for baudrate prescalar. |
| IfxPsi5s_Psi5s_Clock | clockOutput | Specifies the output clock properties. |
| boolean | fractionalDividerEnabled | Specifies whether fractional divider is enabled or not. |
| boolean | framingCheckEnabled | Specifies whether framing check is enabled or not. |
| boolean | loopbackEnabled | Specifies whether loopback is enabled or not. |
| boolean | overrunCheckEnabled | Specifies whether overrun check is enabled or not. |
| boolean | parityCheckEnabled | Specifies whether parity check is enabled or not. |
| IfxPsi5s_AscMode | receiveMode | Specifies the mode of operation for ASC receiver. |
| boolean | receiverOddParityEnabled | Specifies whether receiver parity check should be for even or odd. |
| IfxPsi5s_AscStopBits | stopBits | Specifies the number of stop bits. |
| IfxPsi5s_AscMode | transmitMode | Specifies the mode of operation for ASC transmitter. |
| boolean | transmitterOddParityEnabled | Specifies whether transmit parity generation should be even or odd. |
| struct IfxPsi5s_Psi5s_ChannelTrigger |
channel trigger configuration structure
Definition at line 237 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| uint32 | channelTriggerCounter | Specifies the channel trigger counter. |
| uint32 | channelTriggerValue | Specifies the channel trigger value CTV. |
| struct IfxPsi5s_Psi5s_GlobalControlConfig |
PSI5S global control configuration structure.
Definition at line 245 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| boolean | ascOnlyMode | Specifies if the module is in ASC only mode. |
| boolean | crcErrorConsideredForRSI | Specifies whether CRCI is considered for RSI assertion. |
| boolean | framingErrorConsideredForRSI | Specifies whether FE is considered for RSI assertion. |
| boolean | headerErrorConsideredForRSI | Specifies whether HDI is considered for RSI assertion. |
| uint32 | idleTime | Specifies the number of stop bits in addition to last UART frame that is required for start of frame detection. |
| boolean | overrunErrorConsideredForRSI | Specifies whether OE is considered for RSI assertion. |
| boolean | parityErrorConsideredForRSI | Specifies whether PE is considered for RSI assertion. |
| boolean | receiveBufferErrorConsideredForRSI | Specifies whether RBI is considered for RSI assertion. |
| boolean | transmitErrorConsideredForRSI | Specifies whether TEI is considered for RSI assertion. |
| boolean | xcrcErrorConsideredForRSI | Specifies whether XCRCI is considered for RSI assertion. |
| struct IfxPsi5s_Psi5s_Pins |
Structure for PSI5S pin configuration.
Definition at line 261 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_Pins:
| Data Fields | ||
|---|---|---|
| const IfxPsi5s_Clk_Out * | clk | PSI5S Clk Pin. |
| IfxPort_OutputMode | clkMode | Clk as output. |
| IfxPort_PadDriver | pinDriver | pad driver |
| const IfxPsi5s_Rx_In * | rx | PSI5S Rx pin. |
| IfxPort_InputMode | rxMode | Rx pin as input. |
| const IfxPsi5s_Tx_Out * | tx | PSI5S Tx pin. |
| IfxPort_OutputMode | txMode | Tx as output. |
| struct IfxPsi5s_Psi5s_PulseGeneration |
Sync pulse generation configuration structure.
Definition at line 274 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| uint32 | codeforOne | Specifies the code used to represent '1' - referred as ATXCMD. |
| uint32 | codeforZero | Specifies the code used to represent '0' - referred as TXCMD. |
| IfxPsi5s_Trigger | externalTimeBaseSelect | Specifies the clock source for CTV in the case of external. |
| IfxPsi5s_Trigger | externalTriggerSelect | Specifies the trigger source in case of external triggerring. |
| IfxPsi5s_TriggerType | periodicOrExternal | Specifies whether periodic trigger or external trigger or bypass is selected. |
| IfxPsi5s_TimeBase | timeBaseSelect | Specifies the clock source for CTV as internal or external. |
| struct IfxPsi5s_Psi5s_ReceiveControl |
Receive control configuration structure - covers control fields from RCRA, RCRB and NFC registers.
Definition at line 286 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| IfxPsi5s_CrcOrParity | crcOrParity[IFXPSI5S_NUM_SLOTS] | Specifies the crc or parity selection for the slots 0 to 5. |
| IfxPsi5s_FrameId | frameIdSelect | Specifies if frame ID is updated from frame header or is a rolling number 0..5 copied from FCNT. |
| IfxPsi5s_NumberExpectedFrames | numberOfFramesExpected | Specifies the number of psi5s frames expected. |
| uint32 | payloadLength[IFXPSI5S_NUM_SLOTS] | Specifies the payload length to be received for each slot. |
| boolean | timestampEnabled | Specifies whether the timestamp is enabled or not. |
| IfxPsi5s_TimestampRegister | timestampSelect | Specifies the timestamp register selection for pulses. |
| IfxPsi5s_TimestampTrigger | timestampTriggerSelect | Specifies the timestamp register selection for pulses. |
| IfxPsi5s_UartFrameCount | uartFrameCount[IFXPSI5S_NUM_SLOTS] | Specifies the expected number of UART frames per packet frame for each slot. |
| IfxPsi5s_WatchdogTimerMode | watchdogTimerModeSelect | Specifies the watchdog timer restart is wrt frame or sync pulse reception. |
| union IfxPsi5s_Psi5s_ReceiveData |
"Received data" data structure
Definition at line 301 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_ReceiveData:
| Data Fields | ||
|---|---|---|
| uint32 | rdr | received data with frame count |
| IfxPsi5s_Psi5s_ReceivedData | receivedData | Receive data structure with different segments of data. |
| union IfxPsi5s_Psi5s_ReceiveStatus |
Receiver status data structure.
Definition at line 309 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_ReceiveStatus:
| Data Fields | ||
|---|---|---|
| uint32 | rds | received status data. |
| IfxPsi5s_Psi5s_ReceivedBits | receivedBits | Received individual bits. |
| union IfxPsi5s_Psi5s_ReceiveTimestamp |
Receiver timestamp data structure.
Definition at line 317 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_ReceiveTimestamp:
| Data Fields | ||
|---|---|---|
| IfxPsi5s_Psi5s_Timestamp | timeStamp | Received timestamp contents structure. |
| uint32 | tsm | received timestamp along with frame count |
| struct IfxPsi5s_Psi5s_TimeStampConfig |
Timestamp configuration data structure.
Definition at line 325 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| IfxPsi5s_Trigger | externalTimeBaseSelect | Specifies the clock base for counter CTS in the case of external. |
| IfxPsi5s_TimeBase | timeBaseSelect | Specifies the clock source for CTS as internal or external. |
| struct IfxPsi5s_Psi5s_TransmitControl |
Transmit control configuration structure.
Definition at line 333 of file IfxPsi5s_Psi5s.h.
| Data Fields | ||
|---|---|---|
| boolean | bitStuffControl | Specifies whether the bit stuffing is turned on or not. |
| boolean | crcGenerationControl | Specifies whether the crc generation is turned on or not. |
| IfxPsi5s_EnhancedProtocol | enhancedProtocolSelection | Specifies whether the enhanced protocol is selected or not. |
| uint32 | payloadLength | Specifies the payload length to be sent. |
| boolean | startSequenceGenerationControl | Specifies whether the start sequence generation is turned on or not. |
| struct IfxPsi5s_Psi5s_Channel |
Channel handle data structure.
Definition at line 348 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_Channel:
| Data Fields | ||
|---|---|---|
| IfxPsi5s_ChannelId | channelId | Specifies the channel index. |
| IfxPsi5s_Psi5s * | module | The PSI5S handle structure. |
| struct IfxPsi5s_Psi5s_ChannelConfig |
Channel configuration structure.
Definition at line 356 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_ChannelConfig:
| Data Fields | ||
|---|---|---|
| IfxPsi5s_ChannelId | channelId | Specifies the channel index. |
| IfxPsi5s_Psi5s_ChannelTrigger | channelTrigger | Specifies the configuration for channel trigger. |
| const IfxPsi5s_Psi5s * | module | Specifies pointer to the IfxPsi5s_Psi5s module handle. |
| IfxPsi5s_Psi5s_PulseGeneration | pulseGeneration | Specifies the configuration for sync pulse generation. |
| IfxPsi5s_Psi5s_ReceiveControl | receiveControl | Specifies the configuration for reception. |
| IfxPsi5s_Psi5s_TransmitControl | sendControl | Specifies the configuration for transmission. |
| uint32 | watchdogTimerLimit | Specifies the watchdog timer limit for each of the slots 0 to 6. |
| struct IfxPsi5s_Psi5s_Config |
PSI5S module configuration structure.
Definition at line 369 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_Config:
| Data Fields | ||
|---|---|---|
| IfxPsi5s_Psi5s_AscConfig | ascConfig | Specifies the configuration for ASC. |
| IfxPsi5s_Psi5s_Clock | fracDiv | Specifies fractionally divided clock properties. |
| IfxPsi5s_Psi5s_GlobalControlConfig | globalControlConfig | Specifies the global control configuration. |
| Ifx_PSI5S * | module | Specifies the pointer to the PSI5S module registers. |
| const IfxPsi5s_Psi5s_Pins * | pins | structure for PSI5S pin configuration |
| IfxPsi5s_Psi5s_Clock | timestampClock | Specifies the time stamp clock properties. |
| IfxPsi5s_Psi5s_TimeStampConfig | timestampCounterA | Specifies the time stamp counter A properties. |
| IfxPsi5s_Psi5s_TimeStampConfig | timestampCounterB | Specifies the time stamp counter B properties. |
| struct IfxPsi5s_Psi5s_Frame |
Psi5s frame data structure.
Definition at line 383 of file IfxPsi5s_Psi5s.h.
Collaboration diagram for IfxPsi5s_Psi5s_Frame:
| Data Fields | ||
|---|---|---|
| IfxPsi5s_Psi5s_ReceiveData | data | Received data. |
| IfxPsi5s_Psi5s_ReceiveStatus | status | Receiver status. |
| IfxPsi5s_Psi5s_ReceiveTimestamp | timestamp | Receiver timestamp. |
