1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
/*
* Xilinx SD-FEC
*
* Copyright (C) 2019 Xilinx, Inc.
*
* Description:
* This driver is developed for SDFEC16 IP. It provides a char device
* in sysfs and supports file operations like open(), close() and ioctl().
*/
#ifndef __XILINX_SDFEC_H__
#define __XILINX_SDFEC_H__
#include <linux/types.h>
/**
* enum xsdfec_code - Code Type.
* @XSDFEC_TURBO_CODE: Driver is configured for Turbo mode.
* @XSDFEC_LDPC_CODE: Driver is configured for LDPC mode.
*
* This enum is used to indicate the mode of the driver. The mode is determined
* by checking which codes are set in the driver. Note that the mode cannot be
* changed by the driver.
*/
enum xsdfec_code {
XSDFEC_TURBO_CODE = 0,
XSDFEC_LDPC_CODE,
};
/**
* enum xsdfec_order - Order
* @XSDFEC_MAINTAIN_ORDER: Maintain order execution of blocks.
* @XSDFEC_OUT_OF_ORDER: Out-of-order execution of blocks.
*
* This enum is used to indicate whether the order of blocks can change from
* input to output.
*/
enum xsdfec_order {
XSDFEC_MAINTAIN_ORDER = 0,
XSDFEC_OUT_OF_ORDER,
};
/**
* enum xsdfec_turbo_alg - Turbo Algorithm Type.
* @XSDFEC_MAX_SCALE: Max Log-Map algorithm with extrinsic scaling. When
* scaling is set to this is equivalent to the Max Log-Map
* algorithm.
* @XSDFEC_MAX_STAR: Log-Map algorithm.
* @XSDFEC_TURBO_ALG_MAX: Used to indicate out of bound Turbo algorithms.
*
* This enum specifies which Turbo Decode algorithm is in use.
*/
enum xsdfec_turbo_alg {
XSDFEC_MAX_SCALE = 0,
XSDFEC_MAX_STAR,
XSDFEC_TURBO_ALG_MAX,
};
/**
* enum xsdfec_state - State.
* @XSDFEC_INIT: Driver is initialized.
* @XSDFEC_STARTED: Driver is started.
* @XSDFEC_STOPPED: Driver is stopped.
* @XSDFEC_NEEDS_RESET: Driver needs to be reset.
* @XSDFEC_PL_RECONFIGURE: Programmable Logic needs to be recofigured.
*
* This enum is used to indicate the state of the driver.
*/
enum xsdfec_state {
XSDFEC_INIT = 0,
XSDFEC_STARTED,
XSDFEC_STOPPED,
XSDFEC_NEEDS_RESET,
XSDFEC_PL_RECONFIGURE,
};
/**
* enum xsdfec_axis_width - AXIS_WIDTH.DIN Setting for 128-bit width.
* @XSDFEC_1x128b: DIN data input stream consists of a 128-bit lane
* @XSDFEC_2x128b: DIN data input stream consists of two 128-bit lanes
* @XSDFEC_4x128b: DIN data input stream consists of four 128-bit lanes
*
* This enum is used to indicate the AXIS_WIDTH.DIN setting for 128-bit width.
* The number of lanes of the DIN data input stream depends upon the
* AXIS_WIDTH.DIN parameter.
*/
enum xsdfec_axis_width {
XSDFEC_1x128b = 1,
XSDFEC_2x128b = 2,
XSDFEC_4x128b = 4,
};
/**
* enum xsdfec_axis_word_include - Words Configuration.
* @XSDFEC_FIXED_VALUE: Fixed, the DIN_WORDS AXI4-Stream interface is removed
* from the IP instance and is driven with the specified
* number of words.
* @XSDFEC_IN_BLOCK: In Block, configures the IP instance to expect a single
* DIN_WORDS value per input code block. The DIN_WORDS
* interface is present.
* @XSDFEC_PER_AXI_TRANSACTION: Per Transaction, configures the IP instance to
* expect one DIN_WORDS value per input transaction on the DIN interface. The
* DIN_WORDS interface is present.
* @XSDFEC_AXIS_WORDS_INCLUDE_MAX: Used to indicate out of bound Words
* Configurations.
*
* This enum is used to specify the DIN_WORDS configuration.
*/
enum xsdfec_axis_word_include {
XSDFEC_FIXED_VALUE = 0,
XSDFEC_IN_BLOCK,
XSDFEC_PER_AXI_TRANSACTION,
XSDFEC_AXIS_WORDS_INCLUDE_MAX,
};
/**
* struct xsdfec_turbo - User data for Turbo codes.
* @alg: Specifies which Turbo decode algorithm to use
* @scale: Specifies the extrinsic scaling to apply when the Max Scale algorithm
* has been selected
*
* Turbo code structure to communicate parameters to XSDFEC driver.
*/
struct xsdfec_turbo {
__u32 alg;
__u8 scale;
};
/**
* struct xsdfec_status - Status of SD-FEC core.
* @state: State of the SD-FEC core
* @activity: Describes if the SD-FEC instance is Active
*/
struct xsdfec_status {
__u32 state;
__s8 activity;
};
/**
* struct xsdfec_irq - Enabling or Disabling Interrupts.
* @enable_isr: If true enables the ISR
* @enable_ecc_isr: If true enables the ECC ISR
*/
struct xsdfec_irq {
__s8 enable_isr;
__s8 enable_ecc_isr;
};
/**
* struct xsdfec_config - Configuration of SD-FEC core.
* @code: The codes being used by the SD-FEC instance
* @order: Order of Operation
* @din_width: Width of the DIN AXI4-Stream
* @din_word_include: How DIN_WORDS are inputted
* @dout_width: Width of the DOUT AXI4-Stream
* @dout_word_include: HOW DOUT_WORDS are outputted
* @irq: Enabling or disabling interrupts
* @bypass: Is the core being bypassed
* @code_wr_protect: Is write protection of LDPC codes enabled
*/
struct xsdfec_config {
__u32 code;
__u32 order;
__u32 din_width;
__u32 din_word_include;
__u32 dout_width;
__u32 dout_word_include;
struct xsdfec_irq irq;
__s8 bypass;
__s8 code_wr_protect;
};
/*
* XSDFEC IOCTL List
*/
#define XSDFEC_MAGIC 'f'
/**
* DOC: XSDFEC_SET_TURBO
* @Parameters
*
* @struct xsdfec_turbo *
* Pointer to the &struct xsdfec_turbo that contains the Turbo decode
* settings for the SD-FEC core
*
* @Description
*
* ioctl that sets the SD-FEC Turbo parameter values
*
* This can only be used when the driver is in the XSDFEC_STOPPED state
*/
#define XSDFEC_SET_TURBO _IOW(XSDFEC_MAGIC, 4, struct xsdfec_turbo)
/**
* DOC: XSDFEC_GET_TURBO
* @Parameters
*
* @struct xsdfec_turbo *
* Pointer to the &struct xsdfec_turbo that contains the current Turbo
* decode settings of the SD-FEC Block
*
* @Description
*
* ioctl that returns SD-FEC turbo param values
*/
#define XSDFEC_GET_TURBO _IOR(XSDFEC_MAGIC, 7, struct xsdfec_turbo)
#endif /* __XILINX_SDFEC_H__ */
|
