Documentation/misc-devices/xilinx_sdfec.rst

4 Xilinx SD-FEC Driver
10 This driver supports SD-FEC Integrated Block for Zynq |Ultrascale+ (TM)| RFSoCs.
15 For a full description of SD-FEC core features, see the `SD-FEC Product Guide (PG256) <https://www.…
24 Missing features, known issues, and limitations of the SD-FEC driver are as
28   - Reset of the SD-FEC Integrated Block is not controlled by this driver
32 …indings/misc/xlnx,sd-fec.yaml <https://github.com/Xilinx/linux-xlnx/blob/master/Documentation/devi…
38 The driver works with the SD-FEC core in two modes of operation:
50 	- Activate the SD-FEC core
51 	- Monitor the SD-FEC core for errors
52 	- Retrieve the status and configuration of the SD-FEC core
61 	- Activate the SD-FEC core
62 	- Monitor the SD-FEC core for errors
63 	- Retrieve the status and configuration of the SD-FEC core
78 …- open: Implements restriction that only a single file descriptor can be open per SD-FEC instance …
80   - poll: Provides a method to monitor for SD-FEC Error events
81 …ioctl: Provides the following ioctl commands that allows the application configure the SD-FEC core:
105 performed to configure and activate the SD-FEC core and determine the
112     SD-FEC core is configured plus if the SD-FEC has not been configured for PL
115   - Bypass the SD-FEC core, if required
116   - Start the SD-FEC core if not already started
117   - Get the SD-FEC core status
119   - Stop the SD-FEC core
128 Determine the configuration of the SD-FEC core by using the ioctl
140 …status>` filled by the ioctl :c:macro:`XSDFEC_GET_STATUS` indicates the SD-FEC core has not STARTED
146 The following steps indicate how to add LDPC codes to the SD-FEC core:
157 …config>` filled by the ioctl :c:macro:`XSDFEC_GET_CONFIG` indicates the SD-FEC core is configured …
159 …status>` filled by the ioctl :c:macro:`XSDFEC_GET_STATUS` indicates the SD-FEC core has not started
168 …config>` filled by the ioctl :c:macro:`XSDFEC_GET_CONFIG` indicates the SD-FEC core is configured …
169 …status>` filled by the ioctl :c:macro:`XSDFEC_GET_STATUS` indicates the SD-FEC core has not STARTED
179 …config>` filled by the ioctl :c:macro:`XSDFEC_GET_CONFIG` indicates the SD-FEC core is configured …
181 Bypass the SD-FEC
184 Bypassing the SD-FEC is done by using the ioctl :c:macro:`XSDFEC_SET_BYPASS`
186 Bypassing the SD-FEC can only be done if the following restrictions are met:
188 …status>` filled by the ioctl :c:macro:`XSDFEC_GET_STATUS` indicates the SD-FEC core has not STARTED
190 Start the SD-FEC core
193 Start the SD-FEC core by using the ioctl :c:macro:`XSDFEC_START_DEV`
195 Get SD-FEC Status
198 Get the SD-FEC status of the device by using the ioctl :c:macro:`XSDFEC_GET_STATUS`, which will fil…
218 Stop the SD-FEC Core
231 Users should not duplicate SD-FEC device file handlers, for example fork() or dup() a process that …