Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * FiberChannel transport specific attributes exported to sysfs. | |
3 | * | |
4 | * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved. | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 2 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software | |
18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
19 | * | |
20 | * ======== | |
21 | * | |
22 | * Copyright (C) 2004-2005 James Smart, Emulex Corporation | |
23 | * Rewrite for host, target, device, and remote port attributes, | |
24 | * statistics, and service functions... | |
25 | * | |
26 | */ | |
27 | #ifndef SCSI_TRANSPORT_FC_H | |
28 | #define SCSI_TRANSPORT_FC_H | |
29 | ||
30 | #include <linux/config.h> | |
4e57b681 | 31 | #include <linux/sched.h> |
19a7b4ae | 32 | #include <scsi/scsi.h> |
1da177e4 LT |
33 | |
34 | struct scsi_transport_template; | |
35 | ||
36 | ||
37 | /* | |
38 | * FC Port definitions - Following FC HBAAPI guidelines | |
39 | * | |
40 | * Note: Not all binary values for the different fields match HBAAPI. | |
41 | * Instead, we use densely packed ordinal values or enums. | |
42 | * We get away with this as we never present the actual binary values | |
43 | * externally. For sysfs, we always present the string that describes | |
44 | * the value. Thus, an admin doesn't need a magic HBAAPI decoder ring | |
45 | * to understand the values. The HBAAPI user-space library is free to | |
46 | * convert the strings into the HBAAPI-specified binary values. | |
47 | * | |
48 | * Note: Not all HBAAPI-defined values are contained in the definitions | |
49 | * below. Those not appropriate to an fc_host (e.g. FCP initiator) have | |
50 | * been removed. | |
51 | */ | |
52 | ||
53 | /* | |
54 | * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c | |
55 | * (for the ascii descriptions). | |
56 | */ | |
57 | enum fc_port_type { | |
58 | FC_PORTTYPE_UNKNOWN, | |
59 | FC_PORTTYPE_OTHER, | |
60 | FC_PORTTYPE_NOTPRESENT, | |
61 | FC_PORTTYPE_NPORT, /* Attached to FPort */ | |
62 | FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */ | |
63 | FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */ | |
64 | FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */ | |
65 | }; | |
66 | ||
67 | /* | |
68 | * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c | |
69 | * (for the ascii descriptions). | |
70 | */ | |
71 | enum fc_port_state { | |
72 | FC_PORTSTATE_UNKNOWN, | |
73 | FC_PORTSTATE_NOTPRESENT, | |
74 | FC_PORTSTATE_ONLINE, | |
75 | FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */ | |
76 | FC_PORTSTATE_BLOCKED, | |
77 | FC_PORTSTATE_BYPASSED, | |
78 | FC_PORTSTATE_DIAGNOSTICS, | |
79 | FC_PORTSTATE_LINKDOWN, | |
80 | FC_PORTSTATE_ERROR, | |
81 | FC_PORTSTATE_LOOPBACK, | |
42e33148 | 82 | FC_PORTSTATE_DELETED, |
1da177e4 LT |
83 | }; |
84 | ||
85 | ||
86 | /* | |
87 | * FC Classes of Service | |
88 | * Note: values are not enumerated, as they can be "or'd" together | |
89 | * for reporting (e.g. report supported_classes). If you alter this list, | |
90 | * you also need to alter scsi_transport_fc.c (for the ascii descriptions). | |
91 | */ | |
92 | #define FC_COS_UNSPECIFIED 0 | |
93 | #define FC_COS_CLASS1 2 | |
94 | #define FC_COS_CLASS2 4 | |
95 | #define FC_COS_CLASS3 8 | |
96 | #define FC_COS_CLASS4 0x10 | |
97 | #define FC_COS_CLASS6 0x40 | |
98 | ||
99 | /* | |
100 | * FC Port Speeds | |
101 | * Note: values are not enumerated, as they can be "or'd" together | |
102 | * for reporting (e.g. report supported_speeds). If you alter this list, | |
103 | * you also need to alter scsi_transport_fc.c (for the ascii descriptions). | |
104 | */ | |
105 | #define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver | |
106 | incapable of reporting */ | |
107 | #define FC_PORTSPEED_1GBIT 1 | |
108 | #define FC_PORTSPEED_2GBIT 2 | |
1832a586 AH |
109 | #define FC_PORTSPEED_4GBIT 4 |
110 | #define FC_PORTSPEED_10GBIT 8 | |
1da177e4 LT |
111 | #define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */ |
112 | ||
113 | /* | |
114 | * fc_tgtid_binding_type: If you alter this, you also need to alter | |
115 | * scsi_transport_fc.c (for the ascii descriptions). | |
116 | */ | |
117 | enum fc_tgtid_binding_type { | |
118 | FC_TGTID_BIND_NONE, | |
119 | FC_TGTID_BIND_BY_WWPN, | |
120 | FC_TGTID_BIND_BY_WWNN, | |
121 | FC_TGTID_BIND_BY_ID, | |
122 | }; | |
123 | ||
124 | /* | |
125 | * FC Remote Port Roles | |
126 | * Note: values are not enumerated, as they can be "or'd" together | |
127 | * for reporting (e.g. report roles). If you alter this list, | |
128 | * you also need to alter scsi_transport_fc.c (for the ascii descriptions). | |
129 | */ | |
130 | #define FC_RPORT_ROLE_UNKNOWN 0x00 | |
131 | #define FC_RPORT_ROLE_FCP_TARGET 0x01 | |
132 | #define FC_RPORT_ROLE_FCP_INITIATOR 0x02 | |
133 | #define FC_RPORT_ROLE_IP_PORT 0x04 | |
134 | ||
135 | ||
136 | /* | |
137 | * fc_rport_identifiers: This set of data contains all elements | |
138 | * to uniquely identify a remote FC port. The driver uses this data | |
139 | * to report the existence of a remote FC port in the topology. Internally, | |
140 | * the transport uses this data for attributes and to manage consistent | |
141 | * target id bindings. | |
142 | */ | |
143 | struct fc_rport_identifiers { | |
144 | u64 node_name; | |
145 | u64 port_name; | |
146 | u32 port_id; | |
147 | u32 roles; | |
148 | }; | |
149 | ||
150 | /* Macro for use in defining Remote Port attributes */ | |
151 | #define FC_RPORT_ATTR(_name,_mode,_show,_store) \ | |
152 | struct class_device_attribute class_device_attr_rport_##_name = \ | |
153 | __ATTR(_name,_mode,_show,_store) | |
154 | ||
155 | ||
156 | /* | |
157 | * FC Remote Port Attributes | |
158 | * | |
159 | * This structure exists for each remote FC port that a LLDD notifies | |
160 | * the subsystem of. A remote FC port may or may not be a SCSI Target, | |
161 | * also be a SCSI initiator, IP endpoint, etc. As such, the remote | |
162 | * port is considered a separate entity, independent of "role" (such | |
163 | * as scsi target). | |
164 | * | |
165 | * -- | |
166 | * | |
167 | * Attributes are based on HBAAPI V2.0 definitions. Only those | |
168 | * attributes that are determinable by the local port (aka Host) | |
169 | * are contained. | |
170 | * | |
171 | * Fixed attributes are not expected to change. The driver is | |
172 | * expected to set these values after successfully calling | |
173 | * fc_remote_port_add(). The transport fully manages all get functions | |
174 | * w/o driver interaction. | |
175 | * | |
176 | * Dynamic attributes are expected to change. The driver participates | |
177 | * in all get/set operations via functions provided by the driver. | |
178 | * | |
179 | * Private attributes are transport-managed values. They are fully | |
180 | * managed by the transport w/o driver interaction. | |
181 | */ | |
182 | ||
183 | struct fc_rport { /* aka fc_starget_attrs */ | |
184 | /* Fixed Attributes */ | |
185 | u32 maxframe_size; | |
186 | u32 supported_classes; | |
187 | ||
188 | /* Dynamic Attributes */ | |
189 | u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */ | |
190 | ||
191 | /* Private (Transport-managed) Attributes */ | |
192 | u64 node_name; | |
193 | u64 port_name; | |
194 | u32 port_id; | |
195 | u32 roles; | |
196 | enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */ | |
197 | u32 scsi_target_id; | |
198 | ||
199 | /* exported data */ | |
200 | void *dd_data; /* Used for driver-specific storage */ | |
201 | ||
202 | /* internal data */ | |
203 | unsigned int channel; | |
204 | u32 number; | |
205 | struct list_head peers; | |
206 | struct device dev; | |
207 | struct work_struct dev_loss_work; | |
208 | struct work_struct scan_work; | |
209 | } __attribute__((aligned(sizeof(unsigned long)))); | |
210 | ||
211 | #define dev_to_rport(d) \ | |
212 | container_of(d, struct fc_rport, dev) | |
213 | #define transport_class_to_rport(classdev) \ | |
214 | dev_to_rport(classdev->dev) | |
215 | #define rport_to_shost(r) \ | |
216 | dev_to_shost(r->dev.parent) | |
217 | ||
218 | /* | |
219 | * FC SCSI Target Attributes | |
220 | * | |
221 | * The SCSI Target is considered an extention of a remote port (as | |
222 | * a remote port can be more than a SCSI Target). Within the scsi | |
223 | * subsystem, we leave the Target as a separate entity. Doing so | |
224 | * provides backward compatibility with prior FC transport api's, | |
225 | * and lets remote ports be handled entirely within the FC transport | |
226 | * and independently from the scsi subsystem. The drawback is that | |
227 | * some data will be duplicated. | |
228 | */ | |
229 | ||
230 | struct fc_starget_attrs { /* aka fc_target_attrs */ | |
231 | /* Dynamic Attributes */ | |
232 | u64 node_name; | |
233 | u64 port_name; | |
234 | u32 port_id; | |
235 | }; | |
236 | ||
237 | #define fc_starget_node_name(x) \ | |
238 | (((struct fc_starget_attrs *)&(x)->starget_data)->node_name) | |
239 | #define fc_starget_port_name(x) \ | |
240 | (((struct fc_starget_attrs *)&(x)->starget_data)->port_name) | |
241 | #define fc_starget_port_id(x) \ | |
242 | (((struct fc_starget_attrs *)&(x)->starget_data)->port_id) | |
243 | ||
244 | #define starget_to_rport(s) \ | |
245 | scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL | |
246 | ||
247 | ||
248 | /* | |
249 | * FC Local Port (Host) Statistics | |
250 | */ | |
251 | ||
252 | /* FC Statistics - Following FC HBAAPI v2.0 guidelines */ | |
253 | struct fc_host_statistics { | |
254 | /* port statistics */ | |
255 | u64 seconds_since_last_reset; | |
256 | u64 tx_frames; | |
257 | u64 tx_words; | |
258 | u64 rx_frames; | |
259 | u64 rx_words; | |
260 | u64 lip_count; | |
261 | u64 nos_count; | |
262 | u64 error_frames; | |
263 | u64 dumped_frames; | |
264 | u64 link_failure_count; | |
265 | u64 loss_of_sync_count; | |
266 | u64 loss_of_signal_count; | |
267 | u64 prim_seq_protocol_err_count; | |
268 | u64 invalid_tx_word_count; | |
269 | u64 invalid_crc_count; | |
270 | ||
271 | /* fc4 statistics (only FCP supported currently) */ | |
272 | u64 fcp_input_requests; | |
273 | u64 fcp_output_requests; | |
274 | u64 fcp_control_requests; | |
275 | u64 fcp_input_megabytes; | |
276 | u64 fcp_output_megabytes; | |
277 | }; | |
278 | ||
279 | ||
280 | /* | |
281 | * FC Local Port (Host) Attributes | |
282 | * | |
283 | * Attributes are based on HBAAPI V2.0 definitions. | |
284 | * Note: OSDeviceName is determined by user-space library | |
285 | * | |
286 | * Fixed attributes are not expected to change. The driver is | |
287 | * expected to set these values after successfully calling scsi_add_host(). | |
288 | * The transport fully manages all get functions w/o driver interaction. | |
289 | * | |
290 | * Dynamic attributes are expected to change. The driver participates | |
291 | * in all get/set operations via functions provided by the driver. | |
292 | * | |
293 | * Private attributes are transport-managed values. They are fully | |
294 | * managed by the transport w/o driver interaction. | |
295 | */ | |
296 | ||
297 | #define FC_FC4_LIST_SIZE 32 | |
298 | #define FC_SYMBOLIC_NAME_SIZE 256 | |
299 | #define FC_VERSION_STRING_SIZE 64 | |
300 | #define FC_SERIAL_NUMBER_SIZE 80 | |
301 | ||
302 | struct fc_host_attrs { | |
303 | /* Fixed Attributes */ | |
304 | u64 node_name; | |
305 | u64 port_name; | |
306 | u32 supported_classes; | |
307 | u8 supported_fc4s[FC_FC4_LIST_SIZE]; | |
308 | char symbolic_name[FC_SYMBOLIC_NAME_SIZE]; | |
309 | u32 supported_speeds; | |
310 | u32 maxframe_size; | |
311 | char serial_number[FC_SERIAL_NUMBER_SIZE]; | |
312 | ||
313 | /* Dynamic Attributes */ | |
314 | u32 port_id; | |
315 | enum fc_port_type port_type; | |
316 | enum fc_port_state port_state; | |
317 | u8 active_fc4s[FC_FC4_LIST_SIZE]; | |
318 | u32 speed; | |
319 | u64 fabric_name; | |
320 | ||
321 | /* Private (Transport-managed) Attributes */ | |
322 | enum fc_tgtid_binding_type tgtid_bind_type; | |
323 | ||
324 | /* internal data */ | |
325 | struct list_head rports; | |
326 | struct list_head rport_bindings; | |
327 | u32 next_rport_number; | |
328 | u32 next_target_id; | |
42e33148 JSEC |
329 | u8 flags; |
330 | struct work_struct rport_del_work; | |
1da177e4 LT |
331 | }; |
332 | ||
42e33148 JSEC |
333 | /* values for struct fc_host_attrs "flags" field: */ |
334 | #define FC_SHOST_RPORT_DEL_SCHEDULED 0x01 | |
335 | ||
336 | ||
1da177e4 LT |
337 | #define fc_host_node_name(x) \ |
338 | (((struct fc_host_attrs *)(x)->shost_data)->node_name) | |
339 | #define fc_host_port_name(x) \ | |
340 | (((struct fc_host_attrs *)(x)->shost_data)->port_name) | |
341 | #define fc_host_supported_classes(x) \ | |
342 | (((struct fc_host_attrs *)(x)->shost_data)->supported_classes) | |
343 | #define fc_host_supported_fc4s(x) \ | |
344 | (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s) | |
345 | #define fc_host_symbolic_name(x) \ | |
346 | (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name) | |
347 | #define fc_host_supported_speeds(x) \ | |
348 | (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds) | |
349 | #define fc_host_maxframe_size(x) \ | |
350 | (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size) | |
351 | #define fc_host_serial_number(x) \ | |
352 | (((struct fc_host_attrs *)(x)->shost_data)->serial_number) | |
353 | #define fc_host_port_id(x) \ | |
354 | (((struct fc_host_attrs *)(x)->shost_data)->port_id) | |
355 | #define fc_host_port_type(x) \ | |
356 | (((struct fc_host_attrs *)(x)->shost_data)->port_type) | |
357 | #define fc_host_port_state(x) \ | |
358 | (((struct fc_host_attrs *)(x)->shost_data)->port_state) | |
359 | #define fc_host_active_fc4s(x) \ | |
360 | (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s) | |
361 | #define fc_host_speed(x) \ | |
362 | (((struct fc_host_attrs *)(x)->shost_data)->speed) | |
363 | #define fc_host_fabric_name(x) \ | |
364 | (((struct fc_host_attrs *)(x)->shost_data)->fabric_name) | |
365 | #define fc_host_tgtid_bind_type(x) \ | |
366 | (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type) | |
367 | #define fc_host_rports(x) \ | |
368 | (((struct fc_host_attrs *)(x)->shost_data)->rports) | |
369 | #define fc_host_rport_bindings(x) \ | |
370 | (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings) | |
371 | #define fc_host_next_rport_number(x) \ | |
372 | (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number) | |
373 | #define fc_host_next_target_id(x) \ | |
374 | (((struct fc_host_attrs *)(x)->shost_data)->next_target_id) | |
42e33148 JSEC |
375 | #define fc_host_flags(x) \ |
376 | (((struct fc_host_attrs *)(x)->shost_data)->flags) | |
377 | #define fc_host_rport_del_work(x) \ | |
378 | (((struct fc_host_attrs *)(x)->shost_data)->rport_del_work) | |
1da177e4 LT |
379 | |
380 | ||
381 | /* The functions by which the transport class and the driver communicate */ | |
382 | struct fc_function_template { | |
383 | void (*get_rport_dev_loss_tmo)(struct fc_rport *); | |
384 | void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32); | |
385 | ||
386 | void (*get_starget_node_name)(struct scsi_target *); | |
387 | void (*get_starget_port_name)(struct scsi_target *); | |
388 | void (*get_starget_port_id)(struct scsi_target *); | |
389 | ||
390 | void (*get_host_port_id)(struct Scsi_Host *); | |
391 | void (*get_host_port_type)(struct Scsi_Host *); | |
392 | void (*get_host_port_state)(struct Scsi_Host *); | |
393 | void (*get_host_active_fc4s)(struct Scsi_Host *); | |
394 | void (*get_host_speed)(struct Scsi_Host *); | |
395 | void (*get_host_fabric_name)(struct Scsi_Host *); | |
396 | ||
397 | struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *); | |
398 | void (*reset_fc_host_stats)(struct Scsi_Host *); | |
399 | ||
91ca7b01 AV |
400 | int (*issue_fc_host_lip)(struct Scsi_Host *); |
401 | ||
1da177e4 LT |
402 | /* allocation lengths for host-specific data */ |
403 | u32 dd_fcrport_size; | |
404 | ||
405 | /* | |
406 | * The driver sets these to tell the transport class it | |
407 | * wants the attributes displayed in sysfs. If the show_ flag | |
408 | * is not set, the attribute will be private to the transport | |
409 | * class | |
410 | */ | |
411 | ||
412 | /* remote port fixed attributes */ | |
413 | unsigned long show_rport_maxframe_size:1; | |
414 | unsigned long show_rport_supported_classes:1; | |
415 | unsigned long show_rport_dev_loss_tmo:1; | |
416 | ||
417 | /* | |
418 | * target dynamic attributes | |
419 | * These should all be "1" if the driver uses the remote port | |
420 | * add/delete functions (so attributes reflect rport values). | |
421 | */ | |
422 | unsigned long show_starget_node_name:1; | |
423 | unsigned long show_starget_port_name:1; | |
424 | unsigned long show_starget_port_id:1; | |
425 | ||
426 | /* host fixed attributes */ | |
427 | unsigned long show_host_node_name:1; | |
428 | unsigned long show_host_port_name:1; | |
429 | unsigned long show_host_supported_classes:1; | |
430 | unsigned long show_host_supported_fc4s:1; | |
431 | unsigned long show_host_symbolic_name:1; | |
432 | unsigned long show_host_supported_speeds:1; | |
433 | unsigned long show_host_maxframe_size:1; | |
434 | unsigned long show_host_serial_number:1; | |
435 | /* host dynamic attributes */ | |
436 | unsigned long show_host_port_id:1; | |
437 | unsigned long show_host_port_type:1; | |
438 | unsigned long show_host_port_state:1; | |
439 | unsigned long show_host_active_fc4s:1; | |
440 | unsigned long show_host_speed:1; | |
441 | unsigned long show_host_fabric_name:1; | |
442 | }; | |
443 | ||
444 | ||
19a7b4ae JSEC |
445 | /** |
446 | * fc_remote_port_chkready - called to validate the remote port state | |
447 | * prior to initiating io to the port. | |
448 | * | |
449 | * Returns a scsi result code that can be returned by the LLDD. | |
450 | * | |
451 | * @rport: remote port to be checked | |
452 | **/ | |
453 | static inline int | |
454 | fc_remote_port_chkready(struct fc_rport *rport) | |
455 | { | |
456 | int result; | |
457 | ||
458 | switch (rport->port_state) { | |
459 | case FC_PORTSTATE_ONLINE: | |
460 | result = 0; | |
461 | break; | |
462 | case FC_PORTSTATE_BLOCKED: | |
463 | result = DID_BUS_BUSY << 16; | |
464 | break; | |
465 | default: | |
466 | result = DID_NO_CONNECT << 16; | |
467 | break; | |
468 | } | |
469 | return result; | |
470 | } | |
471 | ||
472 | ||
1da177e4 LT |
473 | struct scsi_transport_template *fc_attach_transport( |
474 | struct fc_function_template *); | |
475 | void fc_release_transport(struct scsi_transport_template *); | |
476 | void fc_remove_host(struct Scsi_Host *); | |
477 | struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost, | |
478 | int channel, struct fc_rport_identifiers *ids); | |
479 | void fc_remote_port_delete(struct fc_rport *rport); | |
480 | void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles); | |
1da177e4 LT |
481 | int scsi_is_fc_rport(const struct device *); |
482 | ||
218fba00 AV |
483 | static inline u64 wwn_to_u64(u8 *wwn) |
484 | { | |
485 | return (u64)wwn[0] << 56 | (u64)wwn[1] << 48 | | |
486 | (u64)wwn[2] << 40 | (u64)wwn[3] << 32 | | |
487 | (u64)wwn[4] << 24 | (u64)wwn[5] << 16 | | |
488 | (u64)wwn[6] << 8 | (u64)wwn[7]; | |
489 | } | |
490 | ||
1da177e4 | 491 | #endif /* SCSI_TRANSPORT_FC_H */ |