AM261x MCU+ SDK: fsi.h Source File

| AM261x MCU+ SDK 26.00.00 |

fsi/v0/fsi.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2021 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
49 #ifndef FSI_V0_H_
50 #define FSI_V0_H_
51
52 /* ========================================================================== */
53 /* Include Files */
54 /* ========================================================================== */
55
56 #include <drivers/hw_include/cslr.h>
57
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61
62 /* ========================================================================== */
63 /* Macros & Typedefs */
64 /* ========================================================================== */
65
66 /* Common defines for both FSI TX and RX */
67
71 #define FSI_MAX_LEN_NWORDS_DATA ((uint16_t)0xFU)
72
76 #define FSI_MAX_VALUE_USERDATA ((uint16_t)0xFFU)
77
81 #define FSI_MAX_VALUE_BUF_PTR_OFF ((uint16_t)0xFU)
82
86 #define FSI_CTRL_REG_KEY ((uint16_t)0xA5U)
87
88
97 typedef uint32_t FSI_DataWidth;
98 #define FSI_DATA_WIDTH_1_LANE ((uint32_t)0x0U)
99
100 #define FSI_DATA_WIDTH_2_LANE ((uint32_t)0x1U)
101
104 #define FSI_PINGTIMEOUT_ON_HWSWINIT_PING_FRAME ((uint32_t)0x1U)
105
117 typedef uint32_t FSI_ECCComputeWidth;
118
119 #define FSI_32BIT_ECC_COMPUTE ((uint32_t)0x0U)
120
121 #define FSI_16BIT_ECC_COMPUTE ((uint32_t)0x1U)
122
136 typedef uint32_t FSI_InterruptNum;
137
138 #define FSI_INT1 ((uint32_t)0x0U)
139
140 #define FSI_INT2 ((uint32_t)0x1U)
141
163 typedef uint32_t FSI_FrameType;
164
165 #define FSI_FRAME_TYPE_PING ((uint32_t)0x0U)
166
167 #define FSI_FRAME_TYPE_ERROR ((uint32_t)0xFU)
168
169 #define FSI_FRAME_TYPE_1WORD_DATA ((uint32_t)0x4U)
170
171 #define FSI_FRAME_TYPE_2WORD_DATA ((uint32_t)0x5U)
172
173 #define FSI_FRAME_TYPE_4WORD_DATA ((uint32_t)0x6U)
174
175 #define FSI_FRAME_TYPE_6WORD_DATA ((uint32_t)0x7U)
176
177 #define FSI_FRAME_TYPE_NWORD_DATA ((uint32_t)0x3U)
178
190 typedef uint32_t FSI_PingTimeoutMode;
191
196 #define FSI_PINGTIMEOUT_ON_HWINIT_PING_FRAME ((uint32_t)0x0U)
197
198 #ifdef __cplusplus
199 }
200 #endif
201
202 #endif /* #ifndef FSI_V0_H_ */
203
FSI_InterruptNum
uint32_t FSI_InterruptNum
Interrupt lines supported in FSI.
Definition: fsi/v0/fsi.h:136
FSI_PingTimeoutMode
uint32_t FSI_PingTimeoutMode
FSI ping timeout mode.
Definition: fsi/v0/fsi.h:190
FSI_FrameType
uint32_t FSI_FrameType
FSI frame type.
Definition: fsi/v0/fsi.h:163
FSI_ECCComputeWidth
uint32_t FSI_ECCComputeWidth
ECC Computation width - 16 bit or 32 bit.
Definition: fsi/v0/fsi.h:117
FSI_DataWidth
uint32_t FSI_DataWidth
Data lines used for transmit/receive operation.
Definition: fsi/v0/fsi.h:97