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