xref: /linux/Documentation/ABI/testing/sysfs-bus-cdx (revision 0174f5810401ae6390bfe15354346b5ea660d40c)
12959ab24SNipun GuptaWhat:		/sys/bus/cdx/rescan
22959ab24SNipun GuptaDate:		March 2023
32959ab24SNipun GuptaContact:	nipun.gupta@amd.com
42959ab24SNipun GuptaDescription:
52959ab24SNipun Gupta		Writing y/1/on to this file will cause rescan of the bus
62959ab24SNipun Gupta		and devices on the CDX bus. Any new devices are scanned and
72959ab24SNipun Gupta		added to the list of Linux devices and any devices removed are
82959ab24SNipun Gupta		also deleted from Linux.
92959ab24SNipun Gupta
102959ab24SNipun Gupta		For example::
112959ab24SNipun Gupta
122959ab24SNipun Gupta		  # echo 1 > /sys/bus/cdx/rescan
1348a6c7bcSNipun Gupta
1448a6c7bcSNipun GuptaWhat:		/sys/bus/cdx/devices/.../vendor
1548a6c7bcSNipun GuptaDate:		March 2023
1648a6c7bcSNipun GuptaContact:	nipun.gupta@amd.com
1748a6c7bcSNipun GuptaDescription:
1848a6c7bcSNipun Gupta		Vendor ID for this CDX device, in hexadecimal. Vendor ID is
1948a6c7bcSNipun Gupta		16 bit identifier which is specific to the device manufacturer.
2048a6c7bcSNipun Gupta		Combination of Vendor ID and Device ID identifies a device.
2148a6c7bcSNipun Gupta
2248a6c7bcSNipun GuptaWhat:		/sys/bus/cdx/devices/.../device
2348a6c7bcSNipun GuptaDate:		March 2023
2448a6c7bcSNipun GuptaContact:	nipun.gupta@amd.com
2548a6c7bcSNipun GuptaDescription:
2648a6c7bcSNipun Gupta		Device ID for this CDX device, in hexadecimal. Device ID is
2748a6c7bcSNipun Gupta		16 bit identifier to identify a device type within the range
2848a6c7bcSNipun Gupta		of a device manufacturer.
2948a6c7bcSNipun Gupta		Combination of Vendor ID and Device ID identifies a device.
3048a6c7bcSNipun Gupta
31e3cfd49cSAbhijit GangurdeWhat:		/sys/bus/cdx/devices/.../enable
32e3cfd49cSAbhijit GangurdeDate:		October 2023
33e3cfd49cSAbhijit GangurdeContact:	abhijit.gangurde@amd.com
34e3cfd49cSAbhijit GangurdeDescription:
35e3cfd49cSAbhijit Gangurde		CDX bus should be disabled before updating the devices in FPGA.
36e3cfd49cSAbhijit Gangurde		Writing n/0/off will attempt to disable the CDX bus and.
37e3cfd49cSAbhijit Gangurde		writing y/1/on will attempt to enable the CDX bus. Reading this file
38e3cfd49cSAbhijit Gangurde		gives the current state of the bus, 1 for enabled and 0 for disabled.
39e3cfd49cSAbhijit Gangurde
40e3cfd49cSAbhijit Gangurde		For example::
41e3cfd49cSAbhijit Gangurde
42e3cfd49cSAbhijit Gangurde		  # echo 1 > /sys/bus/cdx/.../enable
43e3cfd49cSAbhijit Gangurde
4448a6c7bcSNipun GuptaWhat:		/sys/bus/cdx/devices/.../reset
4548a6c7bcSNipun GuptaDate:		March 2023
4648a6c7bcSNipun GuptaContact:	nipun.gupta@amd.com
4748a6c7bcSNipun GuptaDescription:
48*0174f581SAbhijit Gangurde		Writing y/1/on to this file resets the CDX device or all devices
49*0174f581SAbhijit Gangurde		on the bus. On resetting the device, the corresponding driver is
50*0174f581SAbhijit Gangurde		notified twice, once before the device is being reset, and again
51*0174f581SAbhijit Gangurde		after the reset has been complete.
5248a6c7bcSNipun Gupta
5348a6c7bcSNipun Gupta		For example::
5448a6c7bcSNipun Gupta
5548a6c7bcSNipun Gupta		  # echo 1 > /sys/bus/cdx/.../reset
5648a6c7bcSNipun Gupta
5748a6c7bcSNipun GuptaWhat:		/sys/bus/cdx/devices/.../remove
5848a6c7bcSNipun GuptaDate:		March 2023
5948a6c7bcSNipun GuptaContact:	tarak.reddy@amd.com
6048a6c7bcSNipun GuptaDescription:
6148a6c7bcSNipun Gupta		Writing y/1/on to this file removes the corresponding
6248a6c7bcSNipun Gupta		device from the CDX bus. If the device is to be reconfigured
6348a6c7bcSNipun Gupta		reconfigured in the Hardware, the device can be removed, so
6448a6c7bcSNipun Gupta		that the device driver does not access the device while it is
6548a6c7bcSNipun Gupta		being reconfigured.
6648a6c7bcSNipun Gupta
6748a6c7bcSNipun Gupta		For example::
6848a6c7bcSNipun Gupta
6948a6c7bcSNipun Gupta		  # echo 1 > /sys/bus/cdx/devices/.../remove
70