Data Structures
Collaboration diagram for Data Structures:
|
Data Structures | |
| struct | IfxPsi5_Psi5 |
| PSI5 handle data structure. More... | |
| struct | IfxPsi5_Psi5_ChannelTrigger |
| channel trigger configuration structure More... | |
| struct | IfxPsi5_Psi5_Clock |
| Clock configuration data structure. More... | |
| struct | IfxPsi5_Psi5_FrameData |
| Psi5 frame data structure with individual members. More... | |
| struct | IfxPsi5_Psi5_InputOutputControl |
| Input output configuration structure. More... | |
| struct | IfxPsi5_Psi5_PulseGeneration |
| Sync pulse generation configuration structure. More... | |
| struct | IfxPsi5_Psi5_Rdm |
| Psi5 frame in double word format. More... | |
| struct | IfxPsi5_Psi5_Rds |
| Psi5 serial message as unsigned 32 bit value. More... | |
| struct | IfxPsi5_Psi5_ReceiveControl |
| Receive control configuration structure. More... | |
| struct | IfxPsi5_Psi5_TimeStampConfig |
| Timestamp configuration data structure. More... | |
| struct | IfxPsi5_Psi5_TransmitControl |
| Transmit control configuration structure. More... | |
| struct | IfxPsi5_Psi5_Channel |
| Channel handle data structure. More... | |
| struct | IfxPsi5_Psi5_ChannelConfig |
| Channel configuration structure. More... | |
| struct | IfxPsi5_Psi5_Config |
| PSI5 module configuration structure. More... | |
| union | IfxPsi5_Psi5_Frame |
| Psi5 frame data union. More... | |
| struct | IfxPsi5_Psi5_StartupOptions |
| startup related options TBD More... | |
Detailed Description
Data Structure Documentation
| struct IfxPsi5_Psi5 |
PSI5 handle data structure.
Definition at line 144 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| Ifx_PSI5 * | psi5 | Specifies the pointer to the PSI5 module registers. |
| struct IfxPsi5_Psi5_ChannelTrigger |
channel trigger configuration structure
Definition at line 151 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint32 | channelTriggerCounter | Specifies the channel trigger counter. |
| uint32 | channelTriggerValue | Specifies the channel trigger value CTV. |
| struct IfxPsi5_Psi5_Clock |
Clock configuration data structure.
Definition at line 159 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint32 | frequency | Specifies the frequency for the clock. |
| IfxPsi5_DividerMode | mode | Specifies the mode of division for the clock. |
| IfxPsi5_ClockType | type | Specifies the type of clock (fracDiv / slow 125kHz / fast 189 kHz / timestamp) |
| struct IfxPsi5_Psi5_FrameData |
Psi5 frame data structure with individual members.
Definition at line 168 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint8 | crc: 3 | Received crc. |
| uint8 | crcError: 1 | Crc error flag. |
| uint8 | messagingBitsError: 1 | Messaging bits error flag. |
| uint8 | noFrameReceivedError: 1 | No frame received flag. |
| uint8 | numberOfBitsError: 1 | Number of bits error flag. |
| uint32 | readData: 28 | Received data. |
| uint8 | receiveMemoryOverflowError: 1 | Receive buffer overflow error flag. |
| uint8 | slotCounter: 3 | Slot counter. |
| uint8 | timeslotError: 1 | Time slot error flag. |
| uint32 | timestamp: 24 | Timestamp. |
| struct IfxPsi5_Psi5_InputOutputControl |
Input output configuration structure.
Definition at line 184 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| IfxPsi5_DigitalInputFilterDepth | digitalInputFilterDepth | Specifies the the number of port input samples considered for floating average. |
| boolean | inputInverterEnabled | Specifies the pulse polarity of the input. |
| boolean | outputInverterEnabled | Specifies the pulse polarity of the output. |
| struct IfxPsi5_Psi5_Message |
Psi5 serial message with individual members.
Definition at line 193 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint8 | configuration: 1 | Serial message configuration. |
| uint8 | crc: 6 | Serial message crc. |
| uint8 | messageId: 8 | Serial message Id. |
| uint16 | serialData: 16 | Serial message data. |
| uint8 | serialMessageCRCFailedError: 1 | Serial message crc error flag. |
| struct IfxPsi5_Psi5_PulseGeneration |
Sync pulse generation configuration structure.
Definition at line 204 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint32 | blankoutTime | Specifies the duration of blank out period. |
| uint32 | delayLength | Specifies the additional length of the pulse width for coding a '1'. |
| IfxPsi5_Trigger | externalTimeBaseSelect | Specifies the clock source for CTV in the case of external. |
| IfxPsi5_Trigger | externalTriggerSelect | Specifies the trigger source in case of external triggerring. |
| IfxPsi5_TriggerType | periodicOrExternalOrBypass | Specifies whether periodic trigger or external trigger or bypass is selected. |
| uint32 | pulseLength | Specifies the standard pulse width without data coding for standard pulse width or for coding a '0'. |
| IfxPsi5_TimeBase | timeBaseSelect | Specifies the clock source for CTV as internal or external. |
| struct IfxPsi5_Psi5_Rdm |
Psi5 frame in double word format.
Definition at line 217 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint32 | highWord | Upper 32 bits of the Psi5 frame. |
| uint32 | lowWord | Lower 32 bits of the Psi5 frame. |
| struct IfxPsi5_Psi5_Rds |
Psi5 serial message as unsigned 32 bit value.
Definition at line 225 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint32 | value | 32 bit value of the Psi5 serial message |
| struct IfxPsi5_Psi5_ReceiveControl |
Receive control configuration structure.
Definition at line 232 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| boolean | asynchronousModeSelected | Specifies the asynchronous mode of operation. |
| IfxPsi5_BaudRate | baudrateSelect | Specifies the baudrate selection. |
| IfxPsi5_CRCorParity | crcOrParity[IFXPSI5_NUM_SLOTS] | Specifies the crc or parity selection for the slots 0 to 5. |
| uint32 | fifoWarningLevel | Specifies the fifo warning level. |
| IfxPsi5_FrameExpectation | frameExpectation[IFXPSI5_NUM_SLOTS] | Specifies whether the frame is expected or not in the slots 0 to 5. |
| IfxPsi5_TimestampRegister | frameTimestampSelect | Specifies the timestamp register selection for start of frames. |
| IfxPsi5_MessagingBits | messagingBitsPresence[IFXPSI5_NUM_SLOTS] | Specifies the presence or absence of messaging bits in the slots 0 to 5. |
| uint32 | payloadLength[IFXPSI5_NUM_SLOTS] | Specifies the payload length for the slots 0 to 5. |
| IfxPsi5_TimestampRegister | pulseTimestampSelect | Specifies the timestamp register selection for pulses. |
| IfxPsi5_ReceiveDataRegisterTimestamp | receiveDataRegisterTimestamp | Specifies the pulse or start of frame based timestamp to be stored in receive data register RDRH. |
| IfxPsi5_Verbose | verbose[IFXPSI5_NUM_SLOTS] | Specifies the verbose is enabled or disabled for the slots 0 to 5. |
| IfxPsi5_Verbose | verboseForAsynchronousMode | Specifies the verbose mode selection in asynchronous mode of operation. |
| struct IfxPsi5_Psi5_TimeStampConfig |
Timestamp configuration data structure.
Definition at line 250 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| IfxPsi5_Trigger | externalTimeBaseSelect | Specifies the clock base for counter CTS in the case of external. |
| IfxPsi5_TimeBase | timeBaseSelect | Specifies the clock source for CTS as internal or external. |
| struct IfxPsi5_Psi5_TransmitControl |
Transmit control configuration structure.
Definition at line 258 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| boolean | bitStuffingEnabled | Specifies whether the bit stuffing is turned on or not. |
| boolean | crcGenerationEnabled | Specifies whether the crc generation is turned on or not. |
| boolean | enhancedProtocolSelected | Specifies whether the enhanced protocol is selected or not. |
| boolean | inhibitingAutomaticTransferEnabled | Specifies whether automatic transfer from the shift registers SSRL/H to SORL/H is inhibited or not. |
| uint32 | payloadLength | Specifies the payload length to be sent. |
| uint32 | sorPayloadLength | Specifies the payload length of SOR. |
| uint32 | ssrPayloadLength | Specifies the payload length of SSR. |
| boolean | startSequenceGenerationEnabled | Specifies whether the start sequence generation is turned on or not. |
| struct IfxPsi5_Psi5_Channel |
Channel handle data structure.
Definition at line 287 of file IfxPsi5_Psi5.h.
Collaboration diagram for IfxPsi5_Psi5_Channel:
| Data Fields | ||
|---|---|---|
| Ifx_PSI5_CH * | channel | Pointer to the channel registers. |
| IfxPsi5_ChannelId | channelId | Specifies the channel index. |
| IfxPsi5_Psi5 * | module | The PSI5 handle structure. |
| struct IfxPsi5_Psi5_ChannelConfig |
Channel configuration structure.
Definition at line 296 of file IfxPsi5_Psi5.h.
Collaboration diagram for IfxPsi5_Psi5_ChannelConfig:
| Data Fields | ||
|---|---|---|
| IfxPsi5_ChannelId | channelId | Specifies the channel index. |
| IfxPsi5_Psi5_ChannelTrigger | channelTrigger | Specifies the configuration for channel trigger. |
| IfxPsi5_Psi5_InputOutputControl | inputOutputControl | Specifies the configuration for input output control. |
| const IfxPsi5_Psi5 * | module | Specifies pointer to the IfxPsi5_Psi5 module handle. |
| const IfxPsi5_Psi5_PinsConfig * | pinsConfig | Pin Configuration structure. |
| IfxPsi5_Psi5_PulseGeneration | pulseGeneration | Specifies the configuration for sync pulse generation. |
| IfxPsi5_Psi5_ReceiveControl | receiveControl | Specifies the configuration for reception. |
| IfxPsi5_Psi5_TransmitControl | sendControl | Specifies the configuration for transmission. |
| uint32 | watchdogTimerLimit[IFXPSI5_NUM_WDTS] | Specifies the watchdog timer limit for each of the slots 0 to 6. |
| struct IfxPsi5_Psi5_Config |
PSI5 module configuration structure.
Definition at line 311 of file IfxPsi5_Psi5.h.
Collaboration diagram for IfxPsi5_Psi5_Config:
| Data Fields | ||
|---|---|---|
| IfxPsi5_Psi5_Clock | fastClock | Specifies the faster f189 clock properties. |
| IfxPsi5_Psi5_Clock | fracDiv | Specifies fractionally divided clock properties. |
| Ifx_PSI5 * | psi5 | Specifies the pointer to the PSI5 module registers. |
| IfxPsi5_Psi5_Clock | slowClock | Specifies the slower f125 clock properties. |
| IfxPsi5_Psi5_Clock | timestampClock | Specifies the time stamp clock properties. |
| IfxPsi5_Psi5_TimeStampConfig | timestampCounterA | Specifies the time stamp counter A properties. |
| IfxPsi5_Psi5_TimeStampConfig | timestampCounterB | Specifies the time stamp counter B properties. |
| IfxPsi5_Psi5_TimeStampConfig | timestampCounterC | Specifies the time stamp counter C properties. |
| union IfxPsi5_Psi5_Frame |
Psi5 frame data union.
Definition at line 325 of file IfxPsi5_Psi5.h.
Collaboration diagram for IfxPsi5_Psi5_Frame:
| Data Fields | ||
|---|---|---|
| IfxPsi5_Psi5_FrameData | frame | Psi5 frame data structure with individual members. |
| IfxPsi5_Psi5_Rdm | rdm | Psi5 frame in double word format. |
| union IfxPsi5_Psi5_SerialMessage |
Psi5 serial message data structure.
Definition at line 333 of file IfxPsi5_Psi5.h.
Collaboration diagram for IfxPsi5_Psi5_SerialMessage:
| Data Fields | ||
|---|---|---|
| IfxPsi5_Psi5_Message | message | Psi5 serial message with individual members. |
| IfxPsi5_Psi5_Rds | rds | Psi5 serial message as unsigned 32 bit value. |
| struct IfxPsi5_Psi5_StartupOptions |
startup related options TBD
Definition at line 341 of file IfxPsi5_Psi5.h.
| Data Fields | ||
|---|---|---|
| uint8 | a: 1 | TBD. |
| uint32 | b: 31 | TBD. |
