xref: /linux/Documentation/ABI/testing/sysfs-bus-cdx (revision c48a7c44a1d02516309015b6134c9bb982e17008)
1What:		/sys/bus/cdx/rescan
2Date:		March 2023
3Contact:	nipun.gupta@amd.com
4Description:
5		Writing y/1/on to this file will cause rescan of the bus
6		and devices on the CDX bus. Any new devices are scanned and
7		added to the list of Linux devices and any devices removed are
8		also deleted from Linux.
9
10		For example::
11
12		  # echo 1 > /sys/bus/cdx/rescan
13
14What:		/sys/bus/cdx/devices/.../vendor
15Date:		March 2023
16Contact:	nipun.gupta@amd.com
17Description:
18		Vendor ID for this CDX device, in hexadecimal. Vendor ID is
19		16 bit identifier which is specific to the device manufacturer.
20		Combination of Vendor ID and Device ID identifies a device.
21
22What:		/sys/bus/cdx/devices/.../device
23Date:		March 2023
24Contact:	nipun.gupta@amd.com
25Description:
26		Device ID for this CDX device, in hexadecimal. Device ID is
27		16 bit identifier to identify a device type within the range
28		of a device manufacturer.
29		Combination of Vendor ID and Device ID identifies a device.
30
31What:		/sys/bus/cdx/devices/.../subsystem_vendor
32Date:		July 2023
33Contact:	puneet.gupta@amd.com
34Description:
35		Subsystem Vendor ID for this CDX device, in hexadecimal.
36		Subsystem Vendor ID is 16 bit identifier specific to the
37		card manufacturer.
38
39What:		/sys/bus/cdx/devices/.../subsystem_device
40Date:		July 2023
41Contact:	puneet.gupta@amd.com
42Description:
43		Subsystem Device ID for this CDX device, in hexadecimal
44		Subsystem Device ID is 16 bit identifier specific to the
45		card manufacturer.
46
47What:		/sys/bus/cdx/devices/.../class
48Date:		July 2023
49Contact:	puneet.gupta@amd.com
50Description:
51		This file contains the class of the CDX device, in hexadecimal.
52		Class is 24 bit identifier specifies the functionality of the device.
53
54What:		/sys/bus/cdx/devices/.../revision
55Date:		July 2023
56Contact:	puneet.gupta@amd.com
57Description:
58		This file contains the revision field of the CDX device, in hexadecimal.
59		Revision is 8 bit revision identifier of the device.
60
61What:		/sys/bus/cdx/devices/.../enable
62Date:		October 2023
63Contact:	abhijit.gangurde@amd.com
64Description:
65		CDX bus should be disabled before updating the devices in FPGA.
66		Writing n/0/off will attempt to disable the CDX bus and.
67		writing y/1/on will attempt to enable the CDX bus. Reading this file
68		gives the current state of the bus, 1 for enabled and 0 for disabled.
69
70		For example::
71
72		  # echo 1 > /sys/bus/cdx/.../enable
73
74What:		/sys/bus/cdx/devices/.../reset
75Date:		March 2023
76Contact:	nipun.gupta@amd.com
77Description:
78		Writing y/1/on to this file resets the CDX device or all devices
79		on the bus. On resetting the device, the corresponding driver is
80		notified twice, once before the device is being reset, and again
81		after the reset has been complete.
82
83		For example::
84
85		  # echo 1 > /sys/bus/cdx/.../reset
86
87What:		/sys/bus/cdx/devices/.../remove
88Date:		March 2023
89Contact:	tarak.reddy@amd.com
90Description:
91		Writing y/1/on to this file removes the corresponding
92		device from the CDX bus. If the device is to be reconfigured
93		reconfigured in the Hardware, the device can be removed, so
94		that the device driver does not access the device while it is
95		being reconfigured.
96
97		For example::
98
99		  # echo 1 > /sys/bus/cdx/devices/.../remove
100
101What:		/sys/bus/cdx/devices/.../modalias
102Date:		July 2023
103Contact:	nipun.gupta@amd.com
104Description:
105		This attribute indicates the CDX ID of the device.
106		That is in the format:
107		cdx:vXXXXdXXXXsvXXXXsdXXXXcXXXXXX,
108		where:
109
110		    - vXXXX contains the vendor ID;
111		    - dXXXX contains the device ID;
112		    - svXXXX contains the subsystem vendor ID;
113		    - sdXXXX contains the subsystem device ID;
114		    - cXXXXXX contains the device class.
115