AM263Px MCU+ SDK: fsi.h File Reference

| AM263Px MCU+ SDK 26.00.00 |

Macros
fsi/v0/fsi.h File Reference
APIs for SOC Specific Device Drivers » APIs for FSI

## Introduction

Header file containing various enumerations, structure definitions and function declarations common for both the FSI TX and FSI RX IP.

Go to the source code of this file.

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

## ECC Computation width
#define | FSI_32BIT_ECC_COMPUTE ((uint32_t)0x0U)
#define | FSI_16BIT_ECC_COMPUTE ((uint32_t)0x1U)
typedef uint32_t | FSI_ECCComputeWidth
| ECC Computation width - 16 bit or 32 bit. More...

## FSI interrupt line number
#define | FSI_INT1 ((uint32_t)0x0U)
#define | FSI_INT2 ((uint32_t)0x1U)
typedef uint32_t | FSI_InterruptNum
| Interrupt lines supported in FSI. More...

## FSI frame type
#define | FSI_FRAME_TYPE_PING ((uint32_t)0x0U)
#define | FSI_FRAME_TYPE_ERROR ((uint32_t)0xFU)
#define | FSI_FRAME_TYPE_1WORD_DATA ((uint32_t)0x4U)
#define | FSI_FRAME_TYPE_2WORD_DATA ((uint32_t)0x5U)
#define | FSI_FRAME_TYPE_4WORD_DATA ((uint32_t)0x6U)
#define | FSI_FRAME_TYPE_6WORD_DATA ((uint32_t)0x7U)
#define | FSI_FRAME_TYPE_NWORD_DATA ((uint32_t)0x3U)
typedef uint32_t | FSI_FrameType
| FSI frame type. More...

## Ping timeout mode
#define | FSI_PINGTIMEOUT_ON_HWINIT_PING_FRAME ((uint32_t)0x0U)
| Ping timeout can reset and restart only on hardware initiated PING frames (PING Watchdog timeout) More...
typedef uint32_t | FSI_PingTimeoutMode
| FSI ping timeout mode. More...

## 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)

## Macro Definition Documentation

## ◆ FSI_32BIT_ECC_COMPUTE

#define FSI_32BIT_ECC_COMPUTE ((uint32_t)0x0U)

ECC Computation width of 32 bit

## ◆ FSI_16BIT_ECC_COMPUTE

#define FSI_16BIT_ECC_COMPUTE ((uint32_t)0x1U)

ECC Computation width of 16 bit

## ◆ FSI_INT1

#define FSI_INT1 ((uint32_t)0x0U)

Interrupt line 0

## ◆ FSI_INT2

#define FSI_INT2 ((uint32_t)0x1U)

Interrupt line 1

## ◆ FSI_FRAME_TYPE_PING

#define FSI_FRAME_TYPE_PING ((uint32_t)0x0U)

Ping frame type

## ◆ FSI_FRAME_TYPE_ERROR

#define FSI_FRAME_TYPE_ERROR ((uint32_t)0xFU)

Error frame type

## ◆ FSI_FRAME_TYPE_1WORD_DATA

#define FSI_FRAME_TYPE_1WORD_DATA ((uint32_t)0x4U)

1 word data frame type

## ◆ FSI_FRAME_TYPE_2WORD_DATA

#define FSI_FRAME_TYPE_2WORD_DATA ((uint32_t)0x5U)

2 word data frame type

## ◆ FSI_FRAME_TYPE_4WORD_DATA

#define FSI_FRAME_TYPE_4WORD_DATA ((uint32_t)0x6U)

4 word data frame type

## ◆ FSI_FRAME_TYPE_6WORD_DATA

#define FSI_FRAME_TYPE_6WORD_DATA ((uint32_t)0x7U)

6 word data frame type

## ◆ FSI_FRAME_TYPE_NWORD_DATA

#define FSI_FRAME_TYPE_NWORD_DATA ((uint32_t)0x3U)

N word data frame type

## ◆ FSI_PINGTIMEOUT_ON_HWINIT_PING_FRAME

#define FSI_PINGTIMEOUT_ON_HWINIT_PING_FRAME ((uint32_t)0x0U)

Ping timeout can reset and restart only on hardware initiated PING frames (PING Watchdog timeout)

## Typedef Documentation

## ◆ FSI_ECCComputeWidth

typedef uint32_t FSI_ECCComputeWidth

ECC Computation width - 16 bit or 32 bit.

## ◆ FSI_InterruptNum

typedef uint32_t FSI_InterruptNum

Interrupt lines supported in FSI.

Any event on FSI TX or RX can be enabled to trigger interrupt on 2 interrupt lines to CPU/CLA - INT1 and INT2

## ◆ FSI_FrameType

typedef uint32_t FSI_FrameType

FSI frame type.

Three frame types exist- Ping: Used for checking line integrity, can be sent by software or automatically by hardware. Error: Used typically during error conditions or when one side wants to signal the other side for attention. Data: Two subtypes exist based on data-length- a) Fixed (1/2/4/6 words) b) Nwords Software programs number of data words

4 bit code for frame types - 0x1, 0x2 and 0x8 to 0xE are reserved

## ◆ FSI_PingTimeoutMode

typedef uint32_t FSI_PingTimeoutMode

FSI ping timeout mode.