xref: /linux/Documentation/ABI/stable/sysfs-driver-ib_srp (revision a4605a93696ee0768e55e4bce1ff7f0ee39bcf79)
1*a4605a93SBart Van AsscheWhat:		/sys/class/infiniband_srp/srp-<hca>-<port_number>/add_target
2*a4605a93SBart Van AsscheDate:		January 2, 2006
3*a4605a93SBart Van AsscheKernelVersion:	2.6.15
4*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
5*a4605a93SBart Van AsscheDescription:	Interface for making ib_srp connect to a new target.
6*a4605a93SBart Van Assche		One can request ib_srp to connect to a new target by writing
7*a4605a93SBart Van Assche		a comma-separated list of login parameters to this sysfs
8*a4605a93SBart Van Assche		attribute. The supported parameters are:
9*a4605a93SBart Van Assche		* id_ext, a 16-digit hexadecimal number specifying the eight
10*a4605a93SBart Van Assche		  byte identifier extension in the 16-byte SRP target port
11*a4605a93SBart Van Assche		  identifier. The target port identifier is sent by ib_srp
12*a4605a93SBart Van Assche		  to the target in the SRP_LOGIN_REQ request.
13*a4605a93SBart Van Assche		* ioc_guid, a 16-digit hexadecimal number specifying the eight
14*a4605a93SBart Van Assche		  byte I/O controller GUID portion of the 16-byte target port
15*a4605a93SBart Van Assche		  identifier.
16*a4605a93SBart Van Assche		* dgid, a 32-digit hexadecimal number specifying the
17*a4605a93SBart Van Assche		  destination GID.
18*a4605a93SBart Van Assche		* pkey, a four-digit hexadecimal number specifying the
19*a4605a93SBart Van Assche		  InfiniBand partition key.
20*a4605a93SBart Van Assche		* service_id, a 16-digit hexadecimal number specifying the
21*a4605a93SBart Van Assche		  InfiniBand service ID used to establish communication with
22*a4605a93SBart Van Assche		  the SRP target. How to find out the value of the service ID
23*a4605a93SBart Van Assche		  is specified in the documentation of the SRP target.
24*a4605a93SBart Van Assche		* max_sect, a decimal number specifying the maximum number of
25*a4605a93SBart Van Assche		  512-byte sectors to be transferred via a single SCSI command.
26*a4605a93SBart Van Assche		* max_cmd_per_lun, a decimal number specifying the maximum
27*a4605a93SBart Van Assche		  number of outstanding commands for a single LUN.
28*a4605a93SBart Van Assche		* io_class, a hexadecimal number specifying the SRP I/O class.
29*a4605a93SBart Van Assche		  Must be either 0xff00 (rev 10) or 0x0100 (rev 16a). The I/O
30*a4605a93SBart Van Assche		  class defines the format of the SRP initiator and target
31*a4605a93SBart Van Assche		  port identifiers.
32*a4605a93SBart Van Assche		* initiator_ext, a 16-digit hexadecimal number specifying the
33*a4605a93SBart Van Assche		  identifier extension portion of the SRP initiator port
34*a4605a93SBart Van Assche		  identifier. This data is sent by the initiator to the target
35*a4605a93SBart Van Assche		  in the SRP_LOGIN_REQ request.
36*a4605a93SBart Van Assche		* cmd_sg_entries, a number in the range 1..255 that specifies
37*a4605a93SBart Van Assche		  the maximum number of data buffer descriptors stored in the
38*a4605a93SBart Van Assche		  SRP_CMD information unit itself. With allow_ext_sg=0 the
39*a4605a93SBart Van Assche		  parameter cmd_sg_entries defines the maximum S/G list length
40*a4605a93SBart Van Assche		  for a single SRP_CMD, and commands whose S/G list length
41*a4605a93SBart Van Assche		  exceeds this limit after S/G list collapsing will fail.
42*a4605a93SBart Van Assche		* allow_ext_sg, whether ib_srp is allowed to include a partial
43*a4605a93SBart Van Assche		  memory descriptor list in an SRP_CMD instead of the entire
44*a4605a93SBart Van Assche		  list. If a partial memory descriptor list has been included
45*a4605a93SBart Van Assche		  in an SRP_CMD the remaining memory descriptors are
46*a4605a93SBart Van Assche		  communicated from initiator to target via an additional RDMA
47*a4605a93SBart Van Assche		  transfer. Setting allow_ext_sg to 1 increases the maximum
48*a4605a93SBart Van Assche		  amount of data that can be transferred between initiator and
49*a4605a93SBart Van Assche		  target via a single SCSI command. Since not all SRP target
50*a4605a93SBart Van Assche		  implementations support partial memory descriptor lists the
51*a4605a93SBart Van Assche		  default value for this option is 0.
52*a4605a93SBart Van Assche		* sg_tablesize, a number in the range 1..2048 specifying the
53*a4605a93SBart Van Assche		  maximum S/G list length the SCSI layer is allowed to pass to
54*a4605a93SBart Van Assche		  ib_srp. Specifying a value that exceeds cmd_sg_entries is
55*a4605a93SBart Van Assche		  only safe with partial memory descriptor list support enabled
56*a4605a93SBart Van Assche		  (allow_ext_sg=1).
57*a4605a93SBart Van Assche
58*a4605a93SBart Van AsscheWhat:		/sys/class/infiniband_srp/srp-<hca>-<port_number>/ibdev
59*a4605a93SBart Van AsscheDate:		January 2, 2006
60*a4605a93SBart Van AsscheKernelVersion:	2.6.15
61*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
62*a4605a93SBart Van AsscheDescription:	HCA name (<hca>).
63*a4605a93SBart Van Assche
64*a4605a93SBart Van AsscheWhat:		/sys/class/infiniband_srp/srp-<hca>-<port_number>/port
65*a4605a93SBart Van AsscheDate:		January 2, 2006
66*a4605a93SBart Van AsscheKernelVersion:	2.6.15
67*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
68*a4605a93SBart Van AsscheDescription:	HCA port number (<port_number>).
69*a4605a93SBart Van Assche
70*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/allow_ext_sg
71*a4605a93SBart Van AsscheDate:		May 19, 2011
72*a4605a93SBart Van AsscheKernelVersion:	2.6.39
73*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
74*a4605a93SBart Van AsscheDescription:	Whether ib_srp is allowed to include a partial memory
75*a4605a93SBart Van Assche		descriptor list in an SRP_CMD when communicating with an SRP
76*a4605a93SBart Van Assche		target.
77*a4605a93SBart Van Assche
78*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/cmd_sg_entries
79*a4605a93SBart Van AsscheDate:		May 19, 2011
80*a4605a93SBart Van AsscheKernelVersion:	2.6.39
81*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
82*a4605a93SBart Van AsscheDescription:	Maximum number of data buffer descriptors that may be sent to
83*a4605a93SBart Van Assche		the target in a single SRP_CMD request.
84*a4605a93SBart Van Assche
85*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/dgid
86*a4605a93SBart Van AsscheDate:		June 17, 2006
87*a4605a93SBart Van AsscheKernelVersion:	2.6.17
88*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
89*a4605a93SBart Van AsscheDescription:	InfiniBand destination GID used for communication with the SRP
90*a4605a93SBart Van Assche		target. Differs from orig_dgid if port redirection has happened.
91*a4605a93SBart Van Assche
92*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/id_ext
93*a4605a93SBart Van AsscheDate:		June 17, 2006
94*a4605a93SBart Van AsscheKernelVersion:	2.6.17
95*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
96*a4605a93SBart Van AsscheDescription:	Eight-byte identifier extension portion of the 16-byte target
97*a4605a93SBart Van Assche		port identifier.
98*a4605a93SBart Van Assche
99*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/ioc_guid
100*a4605a93SBart Van AsscheDate:		June 17, 2006
101*a4605a93SBart Van AsscheKernelVersion:	2.6.17
102*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
103*a4605a93SBart Van AsscheDescription:	Eight-byte I/O controller GUID portion of the 16-byte target
104*a4605a93SBart Van Assche		port identifier.
105*a4605a93SBart Van Assche
106*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/local_ib_device
107*a4605a93SBart Van AsscheDate:		November 29, 2006
108*a4605a93SBart Van AsscheKernelVersion:	2.6.19
109*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
110*a4605a93SBart Van AsscheDescription:	Name of the InfiniBand HCA used for communicating with the
111*a4605a93SBart Van Assche		SRP target.
112*a4605a93SBart Van Assche
113*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/local_ib_port
114*a4605a93SBart Van AsscheDate:		November 29, 2006
115*a4605a93SBart Van AsscheKernelVersion:	2.6.19
116*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
117*a4605a93SBart Van AsscheDescription:	Number of the HCA port used for communicating with the
118*a4605a93SBart Van Assche		SRP target.
119*a4605a93SBart Van Assche
120*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/orig_dgid
121*a4605a93SBart Van AsscheDate:		June 17, 2006
122*a4605a93SBart Van AsscheKernelVersion:	2.6.17
123*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
124*a4605a93SBart Van AsscheDescription:	InfiniBand destination GID specified in the parameters
125*a4605a93SBart Van Assche		written to the add_target sysfs attribute.
126*a4605a93SBart Van Assche
127*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/pkey
128*a4605a93SBart Van AsscheDate:		June 17, 2006
129*a4605a93SBart Van AsscheKernelVersion:	2.6.17
130*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
131*a4605a93SBart Van AsscheDescription:	A 16-bit number representing the InfiniBand partition key used
132*a4605a93SBart Van Assche		for communication with the SRP target.
133*a4605a93SBart Van Assche
134*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/req_lim
135*a4605a93SBart Van AsscheDate:		October 20, 2010
136*a4605a93SBart Van AsscheKernelVersion:	2.6.36
137*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
138*a4605a93SBart Van AsscheDescription:	Number of requests ib_srp can send to the target before it has
139*a4605a93SBart Van Assche		to wait for more credits. For more information see also the
140*a4605a93SBart Van Assche		SRP credit algorithm in the SRP specification.
141*a4605a93SBart Van Assche
142*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/service_id
143*a4605a93SBart Van AsscheDate:		June 17, 2006
144*a4605a93SBart Van AsscheKernelVersion:	2.6.17
145*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
146*a4605a93SBart Van AsscheDescription:	InfiniBand service ID used for establishing communication with
147*a4605a93SBart Van Assche		the SRP	target.
148*a4605a93SBart Van Assche
149*a4605a93SBart Van AsscheWhat:		/sys/class/scsi_host/host<n>/zero_req_lim
150*a4605a93SBart Van AsscheDate:		September 20, 2006
151*a4605a93SBart Van AsscheKernelVersion:	2.6.18
152*a4605a93SBart Van AsscheContact:	linux-rdma@vger.kernel.org
153*a4605a93SBart Van AsscheDescription:	Number of times the initiator had to wait before sending a
154*a4605a93SBart Van Assche		request to the target because it ran out of credits. For more
155*a4605a93SBart Van Assche		information see also the SRP credit algorithm in the SRP
156*a4605a93SBart Van Assche		specification.
157