Documentation/ABI/testing/sysfs-driver-qat

   1 What:           /sys/bus/pci/devices/<BDF>/qat/state
   2 Date:           June 2022
   3 KernelVersion:  6.0
   4 Contact:        qat-linux@intel.com
   5 Description:    (RW) Reports the current state of the QAT device. Write to
   6                 the file to start or stop the device.
   7
   8                 The values are:
   9
  10                 * up: the device is up and running
  11                 * down: the device is down
  12
  13
  14                 It is possible to transition the device from up to down only
  15                 if the device is up and vice versa.
  16
  17                 This attribute is only available for qat_4xxx devices.
  18
  19 What:           /sys/bus/pci/devices/<BDF>/qat/cfg_services
  20 Date:           June 2022
  21 KernelVersion:  6.0
  22 Contact:        qat-linux@intel.com
  23 Description:    (RW) Reports the current configuration of the QAT device.
  24                 Write to the file to change the configured services.
  25
  26                 The values are:
  27
  28                 * sym;asym: the device is configured for running crypto
  29                   services
  30                 * asym;sym: identical to sym;asym
  31                 * dc: the device is configured for running compression services
  32                 * dcc: identical to dc but enables the dc chaining feature,
  33                   hash then compression. If this is not required chose dc
  34                 * sym: the device is configured for running symmetric crypto
  35                   services
  36                 * asym: the device is configured for running asymmetric crypto
  37                   services
  38                 * asym;dc: the device is configured for running asymmetric
  39                   crypto services and compression services
  40                 * dc;asym: identical to asym;dc
  41                 * sym;dc: the device is configured for running symmetric crypto
  42                   services and compression services
  43                 * dc;sym: identical to sym;dc
  44
  45                 It is possible to set the configuration only if the device
  46                 is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
  47
  48                 The following example shows how to change the configuration of
  49                 a device configured for running crypto services in order to
  50                 run data compression::
  51
  52                         # cat /sys/bus/pci/devices/<BDF>/qat/state
  53                         up
  54                         # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
  55                         sym;asym
  56                         # echo down > /sys/bus/pci/devices/<BDF>/qat/state
  57                         # echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
  58                         # echo up > /sys/bus/pci/devices/<BDF>/qat/state
  59                         # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
  60                         dc
  61
  62                 This attribute is only available for qat_4xxx devices.
  63
  64 What:           /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
  65 Date:           June 2023
  66 KernelVersion:  6.5
  67 Contact:        qat-linux@intel.com
  68 Description:    (RW) This configuration option provides a way to force the device into remaining in
  69                 the MAX power state.
  70                 If idle support is enabled the device will transition to the `MIN` power state when
  71                 idle, otherwise will stay in the MAX power state.
  72                 Write to the file to enable or disable idle support.
  73
  74                 The values are:
  75
  76                 * 0: idle support is disabled
  77                 * 1: idle support is enabled
  78
  79                 Default value is 1.
  80
  81                 It is possible to set the pm_idle_enabled value only if the device
  82                 is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
  83
  84                 The following example shows how to change the pm_idle_enabled of
  85                 a device::
  86
  87                         # cat /sys/bus/pci/devices/<BDF>/qat/state
  88                         up
  89                         # cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
  90                         1
  91                         # echo down > /sys/bus/pci/devices/<BDF>/qat/state
  92                         # echo 0 > /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
  93                         # echo up > /sys/bus/pci/devices/<BDF>/qat/state
  94                         # cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
  95                         0
  96
  97                 This attribute is only available for qat_4xxx devices.
  98
  99 What:           /sys/bus/pci/devices/<BDF>/qat/rp2srv
 100 Date:           January 2024
 101 KernelVersion:  6.7
 102 Contact:        qat-linux@intel.com
 103 Description:
 104                 (RW) This attribute provides a way for a user to query a
 105                 specific ring pair for the type of service that it is currently
 106                 configured for.
 107
 108                 When written to, the value is cached and used to perform the
 109                 read operation. Allowed values are in the range 0 to N-1, where
 110                 N is the max number of ring pairs supported by a device. This
 111                 can be queried using the attribute qat/num_rps.
 112
 113                 A read returns the service associated to the ring pair queried.
 114
 115                 The values are:
 116
 117                 * dc: the ring pair is configured for running compression services
 118                 * sym: the ring pair is configured for running symmetric crypto
 119                   services
 120                 * asym: the ring pair is configured for running asymmetric crypto
 121                   services
 122
 123                 Example usage::
 124
 125                         # echo 1 > /sys/bus/pci/devices/<BDF>/qat/rp2srv
 126                         # cat /sys/bus/pci/devices/<BDF>/qat/rp2srv
 127                         sym
 128
 129                 This attribute is only available for qat_4xxx devices.
 130
 131 What:           /sys/bus/pci/devices/<BDF>/qat/num_rps
 132 Date:           January 2024
 133 KernelVersion:  6.7
 134 Contact:        qat-linux@intel.com
 135 Description:
 136                 (RO) Returns the number of ring pairs that a single device has.
 137
 138                 Example usage::
 139
 140                         # cat /sys/bus/pci/devices/<BDF>/qat/num_rps
 141                         64
 142
 143                 This attribute is only available for qat_4xxx devices.
 144
 145 What:           /sys/bus/pci/devices/<BDF>/qat/auto_reset
 146 Date:           May 2024
 147 KernelVersion:  6.9
 148 Contact:        qat-linux@intel.com
 149 Description:    (RW) Reports the current state of the autoreset feature
 150                 for a QAT device
 151
 152                 Write to the attribute to enable or disable device auto reset.
 153
 154                 Device auto reset is disabled by default.
 155
 156                 The values are:
 157
 158                 * 1/Yy/on: auto reset enabled. If the device encounters an
 159                   unrecoverable error, it will be reset automatically.
 160                 * 0/Nn/off: auto reset disabled. If the device encounters an
 161                   unrecoverable error, it will not be reset.
 162
 163                 This attribute is only available for qat_4xxx devices.