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