FSI外设

1.FSI_resetRxModule(uint32_t base, FSI_RxSubmoduleInReset submodule)

• function description: Briefly resets the frame monitor, ping monitor, or the entire RX module
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Rx module
    • submodule: The name of the module that should be reset
  • return parameter:/

2.FSI_clearRxModuleReset(uint32_t base, FSI_RxSubmoduleInReset submodule)

• function description: Briefly clears the frame monitor, ping monitor, or reset on the entire RX module
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Rx module
    • submodule: the module to be removed from the reset
  • return parameter:/

3.FSI_readRxBuffer(uint32_t base, uint16_t array[], uint16_t length, uint16_t bufOffset)

• function description: Read data from FSI Rx buffer
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Rx module
    • array: The address of the word array that receives the data
    • length: is the number of words to receive in the array
    • bufOffset: is the offset of the read data in the Rx buffer
  • return parameter:/

4.FSI_configRxDelayLine(uint32_t base, FSI_RxDelayTapType delayTapType, uint16_t tapValue)

• function description: Adds a delay to the selected tap line
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Rx module
    • delayTapType: The line to which the delay needs to be added. It can be RXCLK, RXD0, or RXD1
    • tapValue: 5-bit value of the amount of delay to be added
  • return parameter:/

5.FSI_performTxInitialization(uint32_t base, uint16_t prescalar)

• function description: Brief initialization of the FSI Tx module, software-based initialization of the FSI transmitter IP. This is usually required only once during initialization, or if the module needs to be reset due to an underload condition that occurs during operation
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Tx module
    • prescalar: User-configurable PLL input clock divider
  • return parameter:/

6.FSI_performRxInitialization(uint32_t base)

• function description: Brief initialization of the FSI Rx module, software-based initialization of the FSI receiver module. This is usually needed only once during initialization. However, if there is a frame error in the received frame, the receive module needs to be reset so that subsequent frames/packets can be reprocessed.
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Tx module
  • return parameter:/

7.FSI_executeTxFlushSequence(uint32_t base, uint16_t prescalar)

• function description: Send a refresh mode sequence. The refresh mode sequence sent by the FSI transmit module will take the FSI receive module out of reset and prepare it to receive subsequent frames.
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Tx module
    • prescalar: User-configurable PLL input clock divider
  • return parameter:/

8.delay_us(unsigned int t)

• function description: Generates a microsecond delay
• parameter description:
  • input parameters:
    • t: Specifies the number of microseconds for the delay time
  • return parameters:

9.bool FSI_isTxBaseValid(uint32_t base)

• function description: Verify whether the FSI Tx base address is correct
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Tx module
  • return parameters:

10.FSI_sendTxFlush(uint32_t base)

• function description: Send FLUSH mode
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Tx module
  • return parameters:

11.FSI_stopTxFlush(uint32_t base)

• function description: Stop FLUSH mode transmission
• parameter description:
  • input parameters:
    • base: is the base address of the FSI Tx module
  • return parameters:

12.FSI_selectTxPLLClock(uint32_t base)

• function description: Selects the PLL clock as the source for the clock divider
• parameter description:
  • input parameters: base: is the base address of the FSI Tx module
  • return parameters:

13.FSI_enableTxClock(uint32_t base)

• function description: Sets the clock divider prescaler and enables the transmission clock
• parameter description:
  • input parameters: base: is the base address of the FSI Tx module
  • return parameters:

14.FSI_disableTxClock(uint32_t base)

• function description: Disables the transmission clock
• parameter description:
  • input parameters: base: is the base address of the FSI Tx module
  • return parameters:

15.FSI_configPrescalar(uint32_t base, uint16_t preScaleValue)

• function description: Sets the prescaler clock while keeping the transmit clock in reset
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • preScaleValue: preScaleValue
• return parameters:

16.FSI_setTxDataWidth(uint32_t base, FSI_DataWidth dataWidth)

• function description: Set the transmission data width
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • dataWidth: data width
• return parameters:

18.FSI_enableTxSPIMode(uint32_t base)

• function description: Enable SPI compatibility mode
• parameter description:
  • input parameters: -base: is the base address of the FSI Tx module
  • return parameters:

19.FSI_disableTxSPIMode(uint32_t base)

• function description: Disable SPI compatibility mode
• parameter description:
• input parameters: base: is the base address of the FSI Tx module
• return parameters:

20.FSI_setTxStartMode(uint32_t base, FSI_TxStartMode txStartMode)

• function description: Sets the start mode of any frame transmission.
• parameter description:
  • input parameters: -base: is the base address of the FSI Tx module -txStartMode: transfer start mode
  • return parameters:

21.FSI_setTxPingTimeoutMode(uint32_t base, FSI_PingTimeoutMode pingTimeoutMode)

• function description: Setting Ping timeout can reset and restart the settings.
• parameter description:
  • input parameters: -base: is the base address of the FSI Tx module -pingTimeout Mode: Ping Timeout Mode
  • return parameters:

22.FSI_setTxExtFrameTrigger(uint32_t base, uint16_t extInputNum)

• function description: Sets a specific external input to trigger the transfer.
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • extInputNum: external input number
• return parameters:

23.FSI_enableTxCRCForceError(uint32_t base)

• function description: Force the data frame of CRC value to zero
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

24.FSI_disableTxCRCForceError(uint32_t base)

• function description: Disable forcing the CRC value of the data frame to be zero
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

25.FSI_setTxECCComputeWidth(uint32_t base, FSI_ECCComputeWidth eccComputeWidth)

• function description: Select 16-bit or 32-bit ECC calculation
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • eccComputeWidth: ECC Compute Width
• return parameters:

26.FSI_setTxFrameType(uint32_t base, FSI_FrameType frameType)

• function description: Set the transmission frame type
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • frameType: frame type
• return parameters:

27.FSI_setTxSoftwareFrameSize(uint32_t base, uint16_t nWords)

• function description: Sets the frame size if the frame type is user/software defined frame
• parameter description:
  • input parameters: -base: is the base address of the FSI Tx module -nWords: Number of data words
• return parameters:

28.FSI_startTxTransmit(uint32_t base)

• function description: Start transmitting frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

29.FSI_setTxFrameTag(uint32_t base, FSI_FrameTag frameTag)

• function description: Set the transmission frame label
• parameter description:
  • input parameters: -base: is the base address of the FSI Tx module -frameTag: frame tag
  • return parameters:

30.FSI_setTxUserDefinedData(uint32_t base, uint16_t userDefData)

• function description: Set the user-defined data (8 bits) for transmission, except for the regular data field
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • user DefData: User-defined data value
• return parameters:

31.FSI_setTxBufferPtr(uint32_t base, uint16_t bufPtrOff)

• function description: Sets the value of the transmit buffer pointer at the desired location
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • bufPtrOff: buffer pointer offset
• return parameters:

32.FSI_getTxBufferPtr(uint32_t base)

• function description: Returns the current buffer pointer position
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameter: current buffer pointer position

33.FSI_getTxWordCount(uint32_t base)

• function description: Returns the valid number of data words in the buffer that have not been transferred
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameter: number of data words not transferred

34.FSI_enableTxPingTimer(uint32_t base, uint32_t refValue, FSI_FrameTag pingFrameTag)

• function description: Enables the ping timer logic, which signals the sender to send a ping frame once the set time has elapsed
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • refValue: Reference value of the ping timeout counter
  • ping FrameTag: The tag value of the ping timeout counter
• return parameters:

35.FSI_setTxPingTag(uint32_t base, FSI_FrameTag frameTag)

• function description: Set the ping tag value for ping frame transmission or external ping trigger input initiated by the timeout counter
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • frameTag: frame tag
• return parameters:

36.FSI_enableTxExtPingTrigger(uint32_t base, uint16_t extTrigSel)

• function description: Enables externally triggered transmission of ping frames
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • extTrigSel: can be one of the external inputs from 0 to 31
• return parameters:

37.FSI_disableTxExtPingTrigger()

• function description: Disables the external trigger logic
• parameter description:
• input parameter: none
• return parameters:

38.FSI_getTxCurrentPingTimeoutCounter(uint32_t base)

• function description: Obtain the current Ping timeout logic counter value
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

39.FSI_enableTxDMAEvent(uint32_t base)

• function description: Enables DMA event generation after a frame transfer is completed
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

40.FSI_disableTxDMAEvent(uint32_t base)

• function description: Disables the generation of a DMA event after the frame transfer is completed
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

41.FSI_lockTxCtrl(uint32_t base)

• function description: Locks the control of all transfer control registers. Once locked, further write operations will not take effect until a system reset occurs
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

42.FSI_getTxEventStatus(uint32_t base)

• function description: Returns the current status of all error flags
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

43.FSI_forceTxEvents(uint32_t base, uint16_t evtFlags)

• function description: Allows the user to set the TX error flag
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • evtFlags: Contains a list of event and error flags to set.
• return parameters:

44.FSI_clearTxEvents(uint32_t base, uint16_t evtFlags)

• function description: Allows the user to clear the TX error flag
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • evtFlags: Contains a list of events and error flags to clear.
• return parameters:

45.FSI_enableTxUserCRC(uint32_t base, uint16_t userCRCValue)

• function description: Sets the CRC value to be selected if the transport is configured to use a user-defined SW CRC
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • user CRCValue: user-defined CRC value
• return parameters:

46.FSI_disableTxUserCRC(uint32_t base)

• function description: Disables the CRC value to be selected if the transport is configured to use a user-defined SW CRC
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameters:

47.FSI_setTxECCdata(uint32_t base, uint32_t data)

• function description: Sets the data used for ECC logic calculation
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • data: The data value for which the ECC needs to be calculated
• return parameters:

48.FSI_getTxECCValue(uint32_t base)

• function description: Returns the ECC value of 16/32-bit data
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameter: ECC value

49.FSI_enableTxInterrupt(uint32_t base, FSI_InterruptNum intNum, uint16_t intFlags)

• function description: Allows the user to generate an interrupt when a FSI _ TxEventList event occurs.
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • intNum: Interrupt type to generate, Interrupt 1 or Interrupt 2
  • intFlags: Contains a list of events on which an interrupt should be generated.
• return parameters:

50.FSI_disableTxInterrupt(uint32_t base, FSI_InterruptNum intNum, uint16_t intFlags)

• function description: Allows the user to disable interrupt generation when a FSI _ TxEventList event occurs.
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • intNum: Interrupt type to generate, Interrupt 1 or Interrupt 2
  • intFlags: Contains a list of events for which interrupt generation should be disabled.
• return parameters:

51.FSI_getTxBufferAddress(uint32_t base)

• function description: Returns the address of Tx data buffer
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
• return parameter: Tx data buffer address

52.FSI_resetTxModule(uint32_t base, FSI_TxSubmoduleInReset submodule)

• function description: Reset the clock or Ping timeout counter or the entire TX module
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • submodule: The name of the submodule to reset
• return parameters:

53.FSI_clearTxModuleReset(uint32_t base, FSI_TxSubmoduleInReset submodule)

• function description: Clear the reset of the clock or Ping timeout counter or the entire TX module
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • submodule: name of the submodule to be brought out of the reset state
• return parameters:

54.FSI_writeTxBuffer(uint32_t base, const uint16_t array[], uint16_t length, uint16_t bufOffset)

• function description: Writes data to the FSI Tx buffer
• parameter description:
• input parameters:
  • base: is the base address of the FSI Tx module
  • array: The address of the data array to be transferred
  • length: The number of words in the array to be transferred
  • bufOffset: Offset to write data in Tx buffer
• return parameters:

55.FSI_isRxBaseValid(uint32_t base)

• function description: Checks the FSI-Rx base address
• parameter description:
• input parameters:
  • base: is the base address of the FSI-Rx module
• return parameter: return true if the base address is valid; otherwise return false

56.FSI_enableRxInternalLoopback(uint32_t base)

• function description: Enables internal loopback, which causes Mux to select the internal pin
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

57.FSI_disableRxInternalLoopback(uint32_t base)

• function description: Disables internal loopback so that Mux does not use internal pins from the Tx module
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

58.FSI_enableRxSPIPairing(uint32_t base)

• function description: The receive clock is selected from the internal port of the Tx module
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

59.FSI_disableRxSPIPairing(uint32_t base)

• function description: Selects the regular receive clock from the pin
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

60.FSI_setRxDataWidth(uint32_t base, FSI_DataWidth dataWidth)

• function description: Select the number of data rows to receive
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • dataWidth: data width
• return parameters:

61.FSI_enableRxSPIMode(uint32_t base)

• function description: Enables SPI-compatible mode in FSI Rx
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

62.FSI_disableRxSPIMode(uint32_t base)

• function description: Disable SPI compatibility mode in FSI Rx
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

63.FSI_setRxSoftwareFrameSize(uint32_t base, uint16_t nWords)

• function description: Sets the frame size if the frame type is user/software defined frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • nWords: The number of words of data in the software-defined frame
• return parameters:

64.FSI_setRxECCComputeWidth(uint32_t base, FSI_ECCComputeWidth eccComputeWidth)

• function description: Selects between 16-bit and 32-bit ECC calculation
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • eccComputeWidth: ECC Compute Width
• return parameters:

65.FSI_setRxPingTimeoutMode(uint32_t base, FSI_PingTimeoutMode pingTimeoutMode)

• function description: Set the reset and restart mode of Ping timeout.
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • ping Timeout Mode: Ping Timeout Mode
• return parameters:

66.FSI_getRxFrameType(uint32_t base)

• function description: Obtain the frame type of the last successful frame reception
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • return parameter: frame type of the FSI _ FrameType enumeration type

67.FSI_enableRxDMAEvent(uint32_t base)

• function description: Enables the generation of a DMA event after a frame is successfully received
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

68.FSI_disableRxDMAEvent(uint32_t base)

• function description: Disables the generation of a DMA event after a frame is successfully received
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

69.FSI_getRxFrameTag(uint32_t base)

• function description: Returns the frame label of the last successfully received frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: frame label

70.FSI_getRxUserDefinedData(uint32_t base)

• function description: Returns the user-defined data (8 bits) field of the received data frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: user-defined data

71.FSI_getRxEventStatus(uint32_t base)

• function description: Returns the current status of all event/error flags
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return Parameter: Event/Error Flag Status

72.FSI_forceRxEvents(uint32_t base, uint16_t evtFlags)

• function description: Allows the user to set the RX event/error flags
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • evtFlags: Contains a list of error flags to set
• return parameters:

73.FSI_clearRxEvents(uint32_t base, uint16_t evtFlags)

• function description: Allows the user to clear the RX event/error flags
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • evtFlags: Contains a list of error flags to clear
• return parameters:

74.FSI_getRxReceivedCRC(uint32_t base)

• function description: Return the CRC value of the received data frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: received CRC value

75.FSI_getRxComputedCRC(uint32_t base)

• function description: Calculate and return the CRC value of the received data
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return Parameter: Calculated CRC Value

76.FSI_setRxBufferPtr(uint32_t base, uint16_t bufPtrOff)

• function description: Sets the value of the receive buffer pointer at the desired location
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • bufPtrOff: buffer pointer offset
• return parameters:

77.FSI_getRxBufferPtr(uint32_t base)

• function description: Returns the current buffer pointer position
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: current buffer pointer position

78.FSI_getRxWordCount(uint32_t base)

• function description: Returns the valid number of data words in the buffer that have not been read
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: number of data words not read

79.FSI_enableRxFrameWatchdog(uint32_t base, uint32_t wdRef)

• function description: Enables the frame watchdog counter logic to count when it starts receiving a frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • wdRef: Watchdog reference value
• return parameters:

80.FSI_disableRxFrameWatchdog(uint32_t base)

• function description: Disable the frame watchdog counter logic
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

81.FSI_getRxFrameWatchdogCounter(uint32_t base)

• function description: Returns the value of the watchdog counter of the current frame
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: value of frame watchdog counter

82.FSI_enableRxPingWatchdog(uint32_t base, uint32_t wdRef)

• function description: Enables the ping watchdog counter logic, which will indicate that a ping watchdog timeout occurs once the set time has elapsed
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • wdRef: the reference value of the ping watchdog timeout counter
• return parameters:

83.FSI_disableRxPingWatchdog(uint32_t base)

• function description: Disable the ping watchdog counter logic
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

84.FSI_getRxPingWatchdogCounter(uint32_t base)

• function description: Returns the value of the current ping watchdog counter
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: ping watchdog counter value

85.FSI_getRxPingTag(uint32_t base)

• function description: Returns the label value of the last ping frame received
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: the label value of ping frame

86.FSI_lockRxCtrl(uint32_t base)

• function description: Locks the control of all receive control registers. Once locked, further write operations will not take effect until a system reset occurs
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameters:

87.FSI_setRxECCData(uint32_t base, uint32_t rxECCdata)

• function description: Sets the Rx ECC data used to run the ECC (SEC-DED) calculation logic
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • rxECCdata: ECC data to be set
• return parameters:

88.FSI_setRxReceivedECCValue(uint32_t base, uint16_t rxECCvalue)

• function description: Sets the received ECC value used to run the ECC (SEC-DED) calculation logic
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • rxECCvalue: Received ECC value
• return parameters:

89.FSI_getRxECCCorrectedData(uint32_t base)

• function description: Return the data after ECC correction
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • return parameter: data after ECC correction

90.FSI_getRxECCLog(uint32_t base)

• function description: Return the ECC log detail
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: ECC log details, including single-bit error (SBE) and multi-bit error (MBE)

91.FSI_enableRxInterrupt(uint32_t base, FSI_InterruptNum intNum, uint16_t intFlags)

• function description: Allows the user to generate an interrupt when an Rx event occurs
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • intNum: Interrupt type to activate, Interrupt 1 or Interrupt 2
  • intFlags: a list of events to indicate which events should generate an interrupt
• return parameters:

92.FSI_disableRxInterrupt(uint32_t base, FSI_InterruptNum intNum, uint16_t intFlags)

• function description: Allows the user to disable interrupt generation when an Rx event occurs
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
  • intNum: Interrupt type to disable, Interrupt 1 or Interrupt 2
  • intFlags: a list of events to indicate which events should disable interrupts
• return parameters:

93.FSI_getRxBufferAddress(uint32_t base)

• function description: Returns the address of Rx data buffer
• parameter description:
• input parameters:
  • base: is the base address of the FSI Rx module
• return parameter: Rx data buffer address