Documentation/ABI/testing/sysfs-bus-cdx

   1 What:           /sys/bus/cdx/rescan
   2 Date:           March 2023
   3 Contact:        nipun.gupta@amd.com
   4 Description:
   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
  14 What:           /sys/bus/cdx/devices/.../vendor
  15 Date:           March 2023
  16 Contact:        nipun.gupta@amd.com
  17 Description:
  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
  22 What:           /sys/bus/cdx/devices/.../device
  23 Date:           March 2023
  24 Contact:        nipun.gupta@amd.com
  25 Description:
  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
  31 What:           /sys/bus/cdx/devices/.../subsystem_vendor
  32 Date:           July 2023
  33 Contact:        puneet.gupta@amd.com
  34 Description:
  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
  39 What:           /sys/bus/cdx/devices/.../subsystem_device
  40 Date:           July 2023
  41 Contact:        puneet.gupta@amd.com
  42 Description:
  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
  47 What:           /sys/bus/cdx/devices/.../class
  48 Date:           July 2023
  49 Contact:        puneet.gupta@amd.com
  50 Description:
  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
  54 What:           /sys/bus/cdx/devices/.../revision
  55 Date:           July 2023
  56 Contact:        puneet.gupta@amd.com
  57 Description:
  58                 This file contains the revision field of the CDX device, in hexadecimal.
  59                 Revision is 8 bit revision identifier of the device.
  60
  61 What:           /sys/bus/cdx/devices/.../enable
  62 Date:           October 2023
  63 Contact:        abhijit.gangurde@amd.com
  64 Description:
  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
  74 What:           /sys/bus/cdx/devices/.../reset
  75 Date:           March 2023
  76 Contact:        nipun.gupta@amd.com
  77 Description:
  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
  87 What:           /sys/bus/cdx/devices/.../remove
  88 Date:           March 2023
  89 Contact:        tarak.reddy@amd.com
  90 Description:
  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
 101 What:           /sys/bus/cdx/devices/.../resource<N>
 102 Date:           July 2023
 103 Contact:        puneet.gupta@amd.com
 104 Description:
 105                 The resource binary file contains the content of the memory
 106                 regions. These files can be m'maped from userspace.
 107
 108 What:           /sys/bus/cdx/devices/.../modalias
 109 Date:           July 2023
 110 Contact:        nipun.gupta@amd.com
 111 Description:
 112                 This attribute indicates the CDX ID of the device.
 113                 That is in the format:
 114                 cdx:vXXXXdXXXXsvXXXXsdXXXXcXXXXXX,
 115                 where:
 116
 117                     - vXXXX contains the vendor ID;
 118                     - dXXXX contains the device ID;
 119                     - svXXXX contains the subsystem vendor ID;
 120                     - sdXXXX contains the subsystem device ID;
 121                     - cXXXXXX contains the device class.