Documentation/ABI/testing/sysfs-platform-dfl-fme

   1 What:           /sys/bus/platform/devices/dfl-fme.0/ports_num
   2 Date:           June 2018
   3 KernelVersion:  4.19
   4 Contact:        Wu Hao <hao.wu@intel.com>
   5 Description:    Read-only. One DFL FPGA device may have more than 1
   6                 port/Accelerator Function Unit (AFU). It returns the
   7                 number of ports on the FPGA device when read it.
   8
   9 What:           /sys/bus/platform/devices/dfl-fme.0/bitstream_id
  10 Date:           June 2018
  11 KernelVersion:  4.19
  12 Contact:        Wu Hao <hao.wu@intel.com>
  13 Description:    Read-only. It returns Bitstream (static FPGA region)
  14                 identifier number, which includes the detailed version
  15                 and other information of this static FPGA region.
  16
  17 What:           /sys/bus/platform/devices/dfl-fme.0/bitstream_metadata
  18 Date:           June 2018
  19 KernelVersion:  4.19
  20 Contact:        Wu Hao <hao.wu@intel.com>
  21 Description:    Read-only. It returns Bitstream (static FPGA region) meta
  22                 data, which includes the synthesis date, seed and other
  23                 information of this static FPGA region.
  24
  25 What:           /sys/bus/platform/devices/dfl-fme.0/cache_size
  26 Date:           August 2019
  27 KernelVersion:  5.4
  28 Contact:        Wu Hao <hao.wu@intel.com>
  29 Description:    Read-only. It returns cache size of this FPGA device.
  30
  31 What:           /sys/bus/platform/devices/dfl-fme.0/fabric_version
  32 Date:           August 2019
  33 KernelVersion:  5.4
  34 Contact:        Wu Hao <hao.wu@intel.com>
  35 Description:    Read-only. It returns fabric version of this FPGA device.
  36                 Userspace applications need this information to select
  37                 best data channels per different fabric design.
  38
  39 What:           /sys/bus/platform/devices/dfl-fme.0/socket_id
  40 Date:           August 2019
  41 KernelVersion:  5.4
  42 Contact:        Wu Hao <hao.wu@intel.com>
  43 Description:    Read-only. It returns socket_id to indicate which socket
  44                 this FPGA belongs to, only valid for integrated solution.
  45                 User only needs this information, in case standard numa node
  46                 can't provide correct information.
  47
  48 What:           /sys/bus/platform/devices/dfl-fme.0/errors/pcie0_errors
  49 Date:           August 2019
  50 KernelVersion:  5.4
  51 Contact:        Wu Hao <hao.wu@intel.com>
  52 Description:    Read-Write. Read this file for errors detected on pcie0 link.
  53                 Write this file to clear errors logged in pcie0_errors. Write
  54                 fails with -EINVAL if input parsing fails or input error code
  55                 doesn't match.
  56
  57 What:           /sys/bus/platform/devices/dfl-fme.0/errors/pcie1_errors
  58 Date:           August 2019
  59 KernelVersion:  5.4
  60 Contact:        Wu Hao <hao.wu@intel.com>
  61 Description:    Read-Write. Read this file for errors detected on pcie1 link.
  62                 Write this file to clear errors logged in pcie1_errors. Write
  63                 fails with -EINVAL if input parsing fails or input error code
  64                 doesn't match.
  65
  66 What:           /sys/bus/platform/devices/dfl-fme.0/errors/nonfatal_errors
  67 Date:           August 2019
  68 KernelVersion:  5.4
  69 Contact:        Wu Hao <hao.wu@intel.com>
  70 Description:    Read-only. It returns non-fatal errors detected.
  71
  72 What:           /sys/bus/platform/devices/dfl-fme.0/errors/catfatal_errors
  73 Date:           August 2019
  74 KernelVersion:  5.4
  75 Contact:        Wu Hao <hao.wu@intel.com>
  76 Description:    Read-only. It returns catastrophic and fatal errors detected.
  77
  78 What:           /sys/bus/platform/devices/dfl-fme.0/errors/inject_errors
  79 Date:           August 2019
  80 KernelVersion:  5.4
  81 Contact:        Wu Hao <hao.wu@intel.com>
  82 Description:    Read-Write. Read this file to check errors injected. Write this
  83                 file to inject errors for testing purpose. Write fails with
  84                 -EINVAL if input parsing fails or input inject error code isn't
  85                 supported.
  86
  87 What:           /sys/bus/platform/devices/dfl-fme.0/errors/fme_errors
  88 Date:           August 2019
  89 KernelVersion:  5.4
  90 Contact:        Wu Hao <hao.wu@intel.com>
  91 Description:    Read-Write. Read this file to get errors detected on FME.
  92                 Write this file to clear errors logged in fme_errors. Write
  93                 fials with -EINVAL if input parsing fails or input error code
  94                 doesn't match.
  95
  96 What:           /sys/bus/platform/devices/dfl-fme.0/errors/first_error
  97 Date:           August 2019
  98 KernelVersion:  5.4
  99 Contact:        Wu Hao <hao.wu@intel.com>
 100 Description:    Read-only. Read this file to get the first error detected by
 101                 hardware.
 102
 103 What:           /sys/bus/platform/devices/dfl-fme.0/errors/next_error
 104 Date:           August 2019
 105 KernelVersion:  5.4
 106 Contact:        Wu Hao <hao.wu@intel.com>
 107 Description:    Read-only. Read this file to get the second error detected by
 108                 hardware.
 109
 110 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/name
 111 Date:           October 2019
 112 KernelVersion:  5.5
 113 Contact:        Wu Hao <hao.wu@intel.com>
 114 Description:    Read-Only. Read this file to get the name of hwmon device, it
 115                 supports values:
 116                     'dfl_fme_thermal' - thermal hwmon device name
 117
 118 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input
 119 Date:           October 2019
 120 KernelVersion:  5.5
 121 Contact:        Wu Hao <hao.wu@intel.com>
 122 Description:    Read-Only. It returns FPGA device temperature in millidegrees
 123                 Celsius.
 124
 125 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max
 126 Date:           October 2019
 127 KernelVersion:  5.5
 128 Contact:        Wu Hao <hao.wu@intel.com>
 129 Description:    Read-Only. It returns hardware threshold1 temperature in
 130                 millidegrees Celsius. If temperature rises at or above this
 131                 threshold, hardware starts 50% or 90% throttling (see
 132                 'temp1_max_policy').
 133
 134 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_crit
 135 Date:           October 2019
 136 KernelVersion:  5.5
 137 Contact:        Wu Hao <hao.wu@intel.com>
 138 Description:    Read-Only. It returns hardware threshold2 temperature in
 139                 millidegrees Celsius. If temperature rises at or above this
 140                 threshold, hardware starts 100% throttling.
 141
 142 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_emergency
 143 Date:           October 2019
 144 KernelVersion:  5.5
 145 Contact:        Wu Hao <hao.wu@intel.com>
 146 Description:    Read-Only. It returns hardware trip threshold temperature in
 147                 millidegrees Celsius. If temperature rises at or above this
 148                 threshold, a fatal event will be triggered to board management
 149                 controller (BMC) to shutdown FPGA.
 150
 151 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max_alarm
 152 Date:           October 2019
 153 KernelVersion:  5.5
 154 Contact:        Wu Hao <hao.wu@intel.com>
 155 Description:    Read-only. It returns 1 if temperature is currently at or above
 156                 hardware threshold1 (see 'temp1_max'), otherwise 0.
 157
 158 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_crit_alarm
 159 Date:           October 2019
 160 KernelVersion:  5.5
 161 Contact:        Wu Hao <hao.wu@intel.com>
 162 Description:    Read-only. It returns 1 if temperature is currently at or above
 163                 hardware threshold2 (see 'temp1_crit'), otherwise 0.
 164
 165 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max_policy
 166 Date:           October 2019
 167 KernelVersion:  5.5
 168 Contact:        Wu Hao <hao.wu@intel.com>
 169 Description:    Read-Only. Read this file to get the policy of hardware threshold1
 170                 (see 'temp1_max'). It only supports two values (policies):
 171                     0 - AP2 state (90% throttling)
 172                     1 - AP1 state (50% throttling)