Documentation/ABI/stable/sysfs-driver-ib_srp

   1 What:           /sys/class/infiniband_srp/srp-<hca>-<port_number>/add_target
   2 Date:           January 2, 2006
   3 KernelVersion:  2.6.15
   4 Contact:        linux-rdma@vger.kernel.org
   5 Description:    Interface for making ib_srp connect to a new target.
   6                 One can request ib_srp to connect to a new target by writing
   7                 a comma-separated list of login parameters to this sysfs
   8                 attribute. The supported parameters are:
   9
  10                 * id_ext, a 16-digit hexadecimal number specifying the eight
  11                   byte identifier extension in the 16-byte SRP target port
  12                   identifier. The target port identifier is sent by ib_srp
  13                   to the target in the SRP_LOGIN_REQ request.
  14                 * ioc_guid, a 16-digit hexadecimal number specifying the eight
  15                   byte I/O controller GUID portion of the 16-byte target port
  16                   identifier.
  17                 * dgid, a 32-digit hexadecimal number specifying the
  18                   destination GID.
  19                 * pkey, a four-digit hexadecimal number specifying the
  20                   InfiniBand partition key.
  21                 * service_id, a 16-digit hexadecimal number specifying the
  22                   InfiniBand service ID used to establish communication with
  23                   the SRP target. How to find out the value of the service ID
  24                   is specified in the documentation of the SRP target.
  25                 * max_sect, a decimal number specifying the maximum number of
  26                   512-byte sectors to be transferred via a single SCSI command.
  27                 * max_cmd_per_lun, a decimal number specifying the maximum
  28                   number of outstanding commands for a single LUN.
  29                 * io_class, a hexadecimal number specifying the SRP I/O class.
  30                   Must be either 0xff00 (rev 10) or 0x0100 (rev 16a). The I/O
  31                   class defines the format of the SRP initiator and target
  32                   port identifiers.
  33                 * initiator_ext, a 16-digit hexadecimal number specifying the
  34                   identifier extension portion of the SRP initiator port
  35                   identifier. This data is sent by the initiator to the target
  36                   in the SRP_LOGIN_REQ request.
  37                 * cmd_sg_entries, a number in the range 1..255 that specifies
  38                   the maximum number of data buffer descriptors stored in the
  39                   SRP_CMD information unit itself. With allow_ext_sg=0 the
  40                   parameter cmd_sg_entries defines the maximum S/G list length
  41                   for a single SRP_CMD, and commands whose S/G list length
  42                   exceeds this limit after S/G list collapsing will fail.
  43                 * allow_ext_sg, whether ib_srp is allowed to include a partial
  44                   memory descriptor list in an SRP_CMD instead of the entire
  45                   list. If a partial memory descriptor list has been included
  46                   in an SRP_CMD the remaining memory descriptors are
  47                   communicated from initiator to target via an additional RDMA
  48                   transfer. Setting allow_ext_sg to 1 increases the maximum
  49                   amount of data that can be transferred between initiator and
  50                   target via a single SCSI command. Since not all SRP target
  51                   implementations support partial memory descriptor lists the
  52                   default value for this option is 0.
  53                 * sg_tablesize, a number in the range 1..2048 specifying the
  54                   maximum S/G list length the SCSI layer is allowed to pass to
  55                   ib_srp. Specifying a value that exceeds cmd_sg_entries is
  56                   only safe with partial memory descriptor list support enabled
  57                   (allow_ext_sg=1).
  58                 * comp_vector, a number in the range 0..n-1 specifying the
  59                   MSI-X completion vector of the first RDMA channel. Some
  60                   HCA's allocate multiple (n) MSI-X vectors per HCA port. If
  61                   the IRQ affinity masks of these interrupts have been
  62                   configured such that each MSI-X interrupt is handled by a
  63                   different CPU then the comp_vector parameter can be used to
  64                   spread the SRP completion workload over multiple CPU's.
  65                 * tl_retry_count, a number in the range 2..7 specifying the
  66                   IB RC retry count.
  67                 * queue_size, the maximum number of commands that the
  68                   initiator is allowed to queue per SCSI host. The default
  69                   value for this parameter is 62. The lowest supported value
  70                   is 2.
  71                 * max_it_iu_size, a decimal number specifying the maximum
  72                   initiator to target information unit length.
  73
  74 What:           /sys/class/infiniband_srp/srp-<hca>-<port_number>/ibdev
  75 Date:           January 2, 2006
  76 KernelVersion:  2.6.15
  77 Contact:        linux-rdma@vger.kernel.org
  78 Description:    HCA name (<hca>).
  79
  80 What:           /sys/class/infiniband_srp/srp-<hca>-<port_number>/port
  81 Date:           January 2, 2006
  82 KernelVersion:  2.6.15
  83 Contact:        linux-rdma@vger.kernel.org
  84 Description:    HCA port number (<port_number>).
  85
  86 What:           /sys/class/scsi_host/host<n>/allow_ext_sg
  87 Date:           May 19, 2011
  88 KernelVersion:  2.6.39
  89 Contact:        linux-rdma@vger.kernel.org
  90 Description:    Whether ib_srp is allowed to include a partial memory
  91                 descriptor list in an SRP_CMD when communicating with an SRP
  92                 target.
  93
  94 What:           /sys/class/scsi_host/host<n>/ch_count
  95 Date:           April 1, 2015
  96 KernelVersion:  3.19
  97 Contact:        linux-rdma@vger.kernel.org
  98 Description:    Number of RDMA channels used for communication with the SRP
  99                 target.
 100
 101 What:           /sys/class/scsi_host/host<n>/cmd_sg_entries
 102 Date:           May 19, 2011
 103 KernelVersion:  2.6.39
 104 Contact:        linux-rdma@vger.kernel.org
 105 Description:    Maximum number of data buffer descriptors that may be sent to
 106                 the target in a single SRP_CMD request.
 107
 108 What:           /sys/class/scsi_host/host<n>/comp_vector
 109 Date:           September 2, 2013
 110 KernelVersion:  3.11
 111 Contact:        linux-rdma@vger.kernel.org
 112 Description:    Completion vector used for the first RDMA channel.
 113
 114 What:           /sys/class/scsi_host/host<n>/dgid
 115 Date:           June 17, 2006
 116 KernelVersion:  2.6.17
 117 Contact:        linux-rdma@vger.kernel.org
 118 Description:    InfiniBand destination GID used for communication with the SRP
 119                 target. Differs from orig_dgid if port redirection has happened.
 120
 121 What:           /sys/class/scsi_host/host<n>/id_ext
 122 Date:           June 17, 2006
 123 KernelVersion:  2.6.17
 124 Contact:        linux-rdma@vger.kernel.org
 125 Description:    Eight-byte identifier extension portion of the 16-byte target
 126                 port identifier.
 127
 128 What:           /sys/class/scsi_host/host<n>/ioc_guid
 129 Date:           June 17, 2006
 130 KernelVersion:  2.6.17
 131 Contact:        linux-rdma@vger.kernel.org
 132 Description:    Eight-byte I/O controller GUID portion of the 16-byte target
 133                 port identifier.
 134
 135 What:           /sys/class/scsi_host/host<n>/local_ib_device
 136 Date:           November 29, 2006
 137 KernelVersion:  2.6.19
 138 Contact:        linux-rdma@vger.kernel.org
 139 Description:    Name of the InfiniBand HCA used for communicating with the
 140                 SRP target.
 141
 142 What:           /sys/class/scsi_host/host<n>/local_ib_port
 143 Date:           November 29, 2006
 144 KernelVersion:  2.6.19
 145 Contact:        linux-rdma@vger.kernel.org
 146 Description:    Number of the HCA port used for communicating with the
 147                 SRP target.
 148
 149 What:           /sys/class/scsi_host/host<n>/orig_dgid
 150 Date:           June 17, 2006
 151 KernelVersion:  2.6.17
 152 Contact:        linux-rdma@vger.kernel.org
 153 Description:    InfiniBand destination GID specified in the parameters
 154                 written to the add_target sysfs attribute.
 155
 156 What:           /sys/class/scsi_host/host<n>/pkey
 157 Date:           June 17, 2006
 158 KernelVersion:  2.6.17
 159 Contact:        linux-rdma@vger.kernel.org
 160 Description:    A 16-bit number representing the InfiniBand partition key used
 161                 for communication with the SRP target.
 162
 163 What:           /sys/class/scsi_host/host<n>/req_lim
 164 Date:           October 20, 2010
 165 KernelVersion:  2.6.36
 166 Contact:        linux-rdma@vger.kernel.org
 167 Description:    Number of requests ib_srp can send to the target before it has
 168                 to wait for more credits. For more information see also the
 169                 SRP credit algorithm in the SRP specification.
 170
 171 What:           /sys/class/scsi_host/host<n>/service_id
 172 Date:           June 17, 2006
 173 KernelVersion:  2.6.17
 174 Contact:        linux-rdma@vger.kernel.org
 175 Description:    InfiniBand service ID used for establishing communication with
 176                 the SRP target.
 177
 178 What:           /sys/class/scsi_host/host<n>/sgid
 179 Date:           February 1, 2014
 180 KernelVersion:  3.13
 181 Contact:        linux-rdma@vger.kernel.org
 182 Description:    InfiniBand GID of the source port used for communication with
 183                 the SRP target.
 184
 185 What:           /sys/class/scsi_host/host<n>/zero_req_lim
 186 Date:           September 20, 2006
 187 KernelVersion:  2.6.18
 188 Contact:        linux-rdma@vger.kernel.org
 189 Description:    Number of times the initiator had to wait before sending a
 190                 request to the target because it ran out of credits. For more
 191                 information see also the SRP credit algorithm in the SRP
 192                 specification.