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                     'dfl_fme_power'   - power hwmon device name
 118
 119 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input
 120 Date:           October 2019
 121 KernelVersion:  5.5
 122 Contact:        Wu Hao <hao.wu@intel.com>
 123 Description:    Read-Only. It returns FPGA device temperature in millidegrees
 124                 Celsius.
 125
 126 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max
 127 Date:           October 2019
 128 KernelVersion:  5.5
 129 Contact:        Wu Hao <hao.wu@intel.com>
 130 Description:    Read-Only. It returns hardware threshold1 temperature in
 131                 millidegrees Celsius. If temperature rises at or above this
 132                 threshold, hardware starts 50% or 90% throttling (see
 133                 'temp1_max_policy').
 134
 135 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_crit
 136 Date:           October 2019
 137 KernelVersion:  5.5
 138 Contact:        Wu Hao <hao.wu@intel.com>
 139 Description:    Read-Only. It returns hardware threshold2 temperature in
 140                 millidegrees Celsius. If temperature rises at or above this
 141                 threshold, hardware starts 100% throttling.
 142
 143 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_emergency
 144 Date:           October 2019
 145 KernelVersion:  5.5
 146 Contact:        Wu Hao <hao.wu@intel.com>
 147 Description:    Read-Only. It returns hardware trip threshold temperature in
 148                 millidegrees Celsius. If temperature rises at or above this
 149                 threshold, a fatal event will be triggered to board management
 150                 controller (BMC) to shutdown FPGA.
 151
 152 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max_alarm
 153 Date:           October 2019
 154 KernelVersion:  5.5
 155 Contact:        Wu Hao <hao.wu@intel.com>
 156 Description:    Read-only. It returns 1 if temperature is currently at or above
 157                 hardware threshold1 (see 'temp1_max'), otherwise 0.
 158
 159 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_crit_alarm
 160 Date:           October 2019
 161 KernelVersion:  5.5
 162 Contact:        Wu Hao <hao.wu@intel.com>
 163 Description:    Read-only. It returns 1 if temperature is currently at or above
 164                 hardware threshold2 (see 'temp1_crit'), otherwise 0.
 165
 166 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max_policy
 167 Date:           October 2019
 168 KernelVersion:  5.5
 169 Contact:        Wu Hao <hao.wu@intel.com>
 170 Description:    Read-Only. Read this file to get the policy of hardware threshold1
 171                 (see 'temp1_max'). It only supports two values (policies):
 172                     0 - AP2 state (90% throttling)
 173                     1 - AP1 state (50% throttling)
 174
 175 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_input
 176 Date:           October 2019
 177 KernelVersion:  5.5
 178 Contact:        Wu Hao <hao.wu@intel.com>
 179 Description:    Read-Only. It returns current FPGA power consumption in uW.
 180
 181 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_max
 182 Date:           October 2019
 183 KernelVersion:  5.5
 184 Contact:        Wu Hao <hao.wu@intel.com>
 185 Description:    Read-Write. Read this file to get current hardware power
 186                 threshold1 in uW. If power consumption rises at or above
 187                 this threshold, hardware starts 50% throttling.
 188                 Write this file to set current hardware power threshold1 in uW.
 189                 As hardware only accepts values in Watts, so input value will
 190                 be round down per Watts (< 1 watts part will be discarded) and
 191                 clamped within the range from 0 to 127 Watts. Write fails with
 192                 -EINVAL if input parsing fails.
 193
 194 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_crit
 195 Date:           October 2019
 196 KernelVersion:  5.5
 197 Contact:        Wu Hao <hao.wu@intel.com>
 198 Description:    Read-Write. Read this file to get current hardware power
 199                 threshold2 in uW. If power consumption rises at or above
 200                 this threshold, hardware starts 90% throttling.
 201                 Write this file to set current hardware power threshold2 in uW.
 202                 As hardware only accepts values in Watts, so input value will
 203                 be round down per Watts (< 1 watts part will be discarded) and
 204                 clamped within the range from 0 to 127 Watts. Write fails with
 205                 -EINVAL if input parsing fails.
 206
 207 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_max_alarm
 208 Date:           October 2019
 209 KernelVersion:  5.5
 210 Contact:        Wu Hao <hao.wu@intel.com>
 211 Description:    Read-only. It returns 1 if power consumption is currently at or
 212                 above hardware threshold1 (see 'power1_max'), otherwise 0.
 213
 214 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_crit_alarm
 215 Date:           October 2019
 216 KernelVersion:  5.5
 217 Contact:        Wu Hao <hao.wu@intel.com>
 218 Description:    Read-only. It returns 1 if power consumption is currently at or
 219                 above hardware threshold2 (see 'power1_crit'), otherwise 0.
 220
 221 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_xeon_limit
 222 Date:           October 2019
 223 KernelVersion:  5.5
 224 Contact:        Wu Hao <hao.wu@intel.com>
 225 Description:    Read-Only. It returns power limit for XEON in uW.
 226
 227 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_fpga_limit
 228 Date:           October 2019
 229 KernelVersion:  5.5
 230 Contact:        Wu Hao <hao.wu@intel.com>
 231 Description:    Read-Only. It returns power limit for FPGA in uW.
 232
 233 What:           /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_ltr
 234 Date:           October 2019
 235 KernelVersion:  5.5
 236 Contact:        Wu Hao <hao.wu@intel.com>
 237 Description:    Read-only. Read this file to get current Latency Tolerance
 238                 Reporting (ltr) value. It returns 1 if all Accelerated
 239                 Function Units (AFUs) can tolerate latency >= 40us for memory
 240                 access or 0 if any AFU is latency sensitive (< 40us).