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