AM261x MCU+ SDK: APIs for FSI

| AM261x MCU+ SDK 26.00.00 |

Files | Macros
APIs for FSI
APIs for SOC Specific Device Drivers

## Introduction

This module contains APIs to program and use the FSI module.

## Files
file | fsi/v0/fsi.h
| Header file containing various enumerations, structure definitions and function declarations common for both the FSI TX and FSI RX IP.

## Macros
#define | FSI_MAX_LEN_NWORDS_DATA ((uint16_t)0xFU)
| Maximum data length(16 words) for user/software defined data frame. More...
#define | FSI_MAX_VALUE_USERDATA ((uint16_t)0xFFU)
| Maximum value for user data field (8 bits) More...
#define | FSI_MAX_VALUE_BUF_PTR_OFF ((uint16_t)0xFU)
| Maximum value of Buffer pointer offset (4 bits) More...
#define | FSI_CTRL_REG_KEY ((uint16_t)0xA5U)
| Key value for writing some FSI TX/RX registers. More...
#define | FSI_PINGTIMEOUT_ON_HWSWINIT_PING_FRAME ((uint32_t)0x1U)

## FSI data width
typedef uint32_t | FSI_DataWidth
| Data lines used for transmit/receive operation. More...
#define | FSI_DATA_WIDTH_1_LANE ((uint32_t)0x0U)
#define | FSI_DATA_WIDTH_2_LANE ((uint32_t)0x1U)

## Macro Definition Documentation

## ◆ FSI_MAX_LEN_NWORDS_DATA

#define FSI_MAX_LEN_NWORDS_DATA ((uint16_t)0xFU)

Maximum data length(16 words) for user/software defined data frame.

## ◆ FSI_MAX_VALUE_USERDATA

#define FSI_MAX_VALUE_USERDATA ((uint16_t)0xFFU)

Maximum value for user data field (8 bits)

## ◆ FSI_MAX_VALUE_BUF_PTR_OFF

#define FSI_MAX_VALUE_BUF_PTR_OFF ((uint16_t)0xFU)

Maximum value of Buffer pointer offset (4 bits)

## ◆ FSI_CTRL_REG_KEY

#define FSI_CTRL_REG_KEY ((uint16_t)0xA5U)

Key value for writing some FSI TX/RX registers.

## ◆ FSI_DATA_WIDTH_1_LANE

#define FSI_DATA_WIDTH_1_LANE ((uint32_t)0x0U)

1 lane data width

## ◆ FSI_DATA_WIDTH_2_LANE

#define FSI_DATA_WIDTH_2_LANE ((uint32_t)0x1U)

2 lane data width

## ◆ FSI_PINGTIMEOUT_ON_HWSWINIT_PING_FRAME

#define FSI_PINGTIMEOUT_ON_HWSWINIT_PING_FRAME ((uint32_t)0x1U)

Ping timeout can reset and restart both on hardware or software initiated frame being sent out also based on which mode is selected

## Typedef Documentation

## ◆ FSI_DataWidth

typedef uint32_t FSI_DataWidth

Data lines used for transmit/receive operation.