uapi/misc/xilinx_sdfec.h

1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
3  * Xilinx SD-FEC
26 	(XSDFEC_LDPC_SC_TABLE_ADDR_HIGH - XSDFEC_LDPC_SC_TABLE_ADDR_BASE)
28 	(XSDFEC_LDPC_LA_TABLE_ADDR_HIGH - XSDFEC_LDPC_LA_TABLE_ADDR_BASE)
30 	(XSDFEC_LDPC_QC_TABLE_ADDR_HIGH - XSDFEC_LDPC_QC_TABLE_ADDR_BASE)
33  * enum xsdfec_code - Code Type.
47  * enum xsdfec_order - Order
49  * @XSDFEC_OUT_OF_ORDER: Out-of-order execution of blocks.
60  * enum xsdfec_turbo_alg - Turbo Algorithm Type.
61  * @XSDFEC_MAX_SCALE: Max Log-Map algorithm with extrinsic scaling. When
62  *		      scaling is set to this is equivalent to the Max Log-Map
64  * @XSDFEC_MAX_STAR: Log-Map algorithm.
76  * enum xsdfec_state - State.
94  * enum xsdfec_axis_width - AXIS_WIDTH.DIN Setting for 128-bit width.
95  * @XSDFEC_1x128b: DIN data input stream consists of a 128-bit lane
96  * @XSDFEC_2x128b: DIN data input stream consists of two 128-bit lanes
97  * @XSDFEC_4x128b: DIN data input stream consists of four 128-bit lanes
99  * This enum is used to indicate the AXIS_WIDTH.DIN setting for 128-bit width.
110  * enum xsdfec_axis_word_include - Words Configuration.
111  * @XSDFEC_FIXED_VALUE: Fixed, the DIN_WORDS AXI4-Stream interface is removed
115  *		     DIN_WORDS value per input code block. The DIN_WORDS
117  * @XSDFEC_PER_AXI_TRANSACTION: Per Transaction, configures the IP instance to
118  * expect one DIN_WORDS value per input transaction on the DIN interface. The
133  * struct xsdfec_turbo - User data for Turbo codes.
135  * @scale: Specifies the extrinsic scaling to apply when the Max Scale algorithm
146  * struct xsdfec_ldpc_params - User data for LDPC codes.
147  * @n: Number of code word bits
148  * @k: Number of information bits
149  * @psize: Size of sub-matrix
152  * @nmqc: Number of M-sized QC operations in parity check matrix
153  * @nm: Number of M-size vectors in N
156  * @special_qc: Sub-Matrix property for Circulant weight > 0
158  * @max_schedule: Experimental code word scheduling limit
193  * struct xsdfec_status - Status of SD-FEC core.
194  * @state: State of the SD-FEC core
195  * @activity: Describes if the SD-FEC instance is Active
203  * struct xsdfec_irq - Enabling or Disabling Interrupts.
213  * struct xsdfec_config - Configuration of SD-FEC core.
214  * @code: The codes being used by the SD-FEC instance
216  * @din_width: Width of the DIN AXI4-Stream
218  * @dout_width: Width of the DOUT AXI4-Stream
237  * struct xsdfec_stats - Stats retrived by ioctl XSDFEC_GET_STATS. Used
252  * struct xsdfec_ldpc_param_table_sizes - Used to store sizes of SD-FEC table
274  * ioctl to start SD-FEC core
284  * ioctl to stop the SD-FEC core
292  * ioctl that returns status of SD-FEC core
301  *	for the SD-FEC core
314  *	settings for the SD-FEC core
318  * ioctl that sets the SD-FEC Turbo parameter values
329  *	parameters to be added to the SD-FEC Block
332  * ioctl to add an LDPC code to the SD-FEC LDPC codes
336  * - Driver is in the XSDFEC_STOPPED state
338  * - SD-FEC core is configured as LPDC
340  * - SD-FEC Code Write Protection is disabled
350  *	configuration settings of the SD-FEC Block
354  * ioctl that returns SD-FEC core configuration
363  *	decode settings of the SD-FEC Block
367  * ioctl that returns SD-FEC turbo param values
391  *	normal operation and false results in the SD-FEC performing the
407  *	Pointer to bool that returns true if the SD-FEC is processing data
411  * ioctl that determines if SD-FEC is processing data
432  * ioctl that returns SD-FEC core stats
442  * ioctl that returns SD-FEC core to default config, use after a reset