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-2007 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/sched.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_netlink.h>
33
34 struct scsi_transport_template;
35
36 /*
37 * FC Port definitions - Following FC HBAAPI guidelines
38 *
39 * Note: Not all binary values for the different fields match HBAAPI.
40 * Instead, we use densely packed ordinal values or enums.
41 * We get away with this as we never present the actual binary values
42 * externally. For sysfs, we always present the string that describes
43 * the value. Thus, an admin doesn't need a magic HBAAPI decoder ring
44 * to understand the values. The HBAAPI user-space library is free to
45 * convert the strings into the HBAAPI-specified binary values.
46 *
47 * Note: Not all HBAAPI-defined values are contained in the definitions
48 * below. Those not appropriate to an fc_host (e.g. FCP initiator) have
49 * been removed.
50 */
51
52 /*
53 * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c
54 * (for the ascii descriptions).
55 */
56 enum fc_port_type {
57 FC_PORTTYPE_UNKNOWN,
58 FC_PORTTYPE_OTHER,
59 FC_PORTTYPE_NOTPRESENT,
60 FC_PORTTYPE_NPORT, /* Attached to FPort */
61 FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */
62 FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */
63 FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */
64 FC_PORTTYPE_NPIV, /* VPORT based on NPIV */
65 };
66
67
68 /*
69 * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c
70 * (for the ascii descriptions).
71 */
72 enum fc_port_state {
73 FC_PORTSTATE_UNKNOWN,
74 FC_PORTSTATE_NOTPRESENT,
75 FC_PORTSTATE_ONLINE,
76 FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */
77 FC_PORTSTATE_BLOCKED,
78 FC_PORTSTATE_BYPASSED,
79 FC_PORTSTATE_DIAGNOSTICS,
80 FC_PORTSTATE_LINKDOWN,
81 FC_PORTSTATE_ERROR,
82 FC_PORTSTATE_LOOPBACK,
83 FC_PORTSTATE_DELETED,
84 };
85
86
87 /*
88 * fc_vport_state: If you alter this, you also need to alter
89 * scsi_transport_fc.c (for the ascii descriptions).
90 */
91 enum fc_vport_state {
92 FC_VPORT_UNKNOWN,
93 FC_VPORT_ACTIVE,
94 FC_VPORT_DISABLED,
95 FC_VPORT_LINKDOWN,
96 FC_VPORT_INITIALIZING,
97 FC_VPORT_NO_FABRIC_SUPP,
98 FC_VPORT_NO_FABRIC_RSCS,
99 FC_VPORT_FABRIC_LOGOUT,
100 FC_VPORT_FABRIC_REJ_WWN,
101 FC_VPORT_FAILED,
102 };
103
104
105
106 /*
107 * FC Classes of Service
108 * Note: values are not enumerated, as they can be "or'd" together
109 * for reporting (e.g. report supported_classes). If you alter this list,
110 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
111 */
112 #define FC_COS_UNSPECIFIED 0
113 #define FC_COS_CLASS1 2
114 #define FC_COS_CLASS2 4
115 #define FC_COS_CLASS3 8
116 #define FC_COS_CLASS4 0x10
117 #define FC_COS_CLASS6 0x40
118
119 /*
120 * FC Port Speeds
121 * Note: values are not enumerated, as they can be "or'd" together
122 * for reporting (e.g. report supported_speeds). If you alter this list,
123 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
124 */
125 #define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver
126 incapable of reporting */
127 #define FC_PORTSPEED_1GBIT 1
128 #define FC_PORTSPEED_2GBIT 2
129 #define FC_PORTSPEED_10GBIT 4
130 #define FC_PORTSPEED_4GBIT 8
131 #define FC_PORTSPEED_8GBIT 0x10
132 #define FC_PORTSPEED_16GBIT 0x20
133 #define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */
134
135 /*
136 * fc_tgtid_binding_type: If you alter this, you also need to alter
137 * scsi_transport_fc.c (for the ascii descriptions).
138 */
139 enum fc_tgtid_binding_type {
140 FC_TGTID_BIND_NONE,
141 FC_TGTID_BIND_BY_WWPN,
142 FC_TGTID_BIND_BY_WWNN,
143 FC_TGTID_BIND_BY_ID,
144 };
145
146 /*
147 * FC Port Roles
148 * Note: values are not enumerated, as they can be "or'd" together
149 * for reporting (e.g. report roles). If you alter this list,
150 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
151 */
152 #define FC_PORT_ROLE_UNKNOWN 0x00
153 #define FC_PORT_ROLE_FCP_TARGET 0x01
154 #define FC_PORT_ROLE_FCP_INITIATOR 0x02
155 #define FC_PORT_ROLE_IP_PORT 0x04
156
157 /* The following are for compatibility */
158 #define FC_RPORT_ROLE_UNKNOWN FC_PORT_ROLE_UNKNOWN
159 #define FC_RPORT_ROLE_FCP_TARGET FC_PORT_ROLE_FCP_TARGET
160 #define FC_RPORT_ROLE_FCP_INITIATOR FC_PORT_ROLE_FCP_INITIATOR
161 #define FC_RPORT_ROLE_IP_PORT FC_PORT_ROLE_IP_PORT
162
163
164 /* Macro for use in defining Virtual Port attributes */
165 #define FC_VPORT_ATTR(_name,_mode,_show,_store) \
166 struct device_attribute dev_attr_vport_##_name = \
167 __ATTR(_name,_mode,_show,_store)
168
169 /*
170 * fc_vport_identifiers: This set of data contains all elements
171 * to uniquely identify and instantiate a FC virtual port.
172 *
173 * Notes:
174 * symbolic_name: The driver is to append the symbolic_name string data
175 * to the symbolic_node_name data that it generates by default.
176 * the resulting combination should then be registered with the switch.
177 * It is expected that things like Xen may stuff a VM title into
178 * this field.
179 */
180 #define FC_VPORT_SYMBOLIC_NAMELEN 64
181 struct fc_vport_identifiers {
182 u64 node_name;
183 u64 port_name;
184 u32 roles;
185 bool disable;
186 enum fc_port_type vport_type; /* only FC_PORTTYPE_NPIV allowed */
187 char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN];
188 };
189
190 /*
191 * FC Virtual Port Attributes
192 *
193 * This structure exists for each FC port is a virtual FC port. Virtual
194 * ports share the physical link with the Physical port. Each virtual
195 * ports has a unique presence on the SAN, and may be instantiated via
196 * NPIV, Virtual Fabrics, or via additional ALPAs. As the vport is a
197 * unique presence, each vport has it's own view of the fabric,
198 * authentication privilege, and priorities.
199 *
200 * A virtual port may support 1 or more FC4 roles. Typically it is a
201 * FCP Initiator. It could be a FCP Target, or exist sole for an IP over FC
202 * roles. FC port attributes for the vport will be reported on any
203 * fc_host class object allocated for an FCP Initiator.
204 *
205 * --
206 *
207 * Fixed attributes are not expected to change. The driver is
208 * expected to set these values after receiving the fc_vport structure
209 * via the vport_create() call from the transport.
210 * The transport fully manages all get functions w/o driver interaction.
211 *
212 * Dynamic attributes are expected to change. The driver participates
213 * in all get/set operations via functions provided by the driver.
214 *
215 * Private attributes are transport-managed values. They are fully
216 * managed by the transport w/o driver interaction.
217 */
218
219 struct fc_vport {
220 /* Fixed Attributes */
221
222 /* Dynamic Attributes */
223
224 /* Private (Transport-managed) Attributes */
225 enum fc_vport_state vport_state;
226 enum fc_vport_state vport_last_state;
227 u64 node_name;
228 u64 port_name;
229 u32 roles;
230 u32 vport_id; /* Admin Identifier for the vport */
231 enum fc_port_type vport_type;
232 char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN];
233
234 /* exported data */
235 void *dd_data; /* Used for driver-specific storage */
236
237 /* internal data */
238 struct Scsi_Host *shost; /* Physical Port Parent */
239 unsigned int channel;
240 u32 number;
241 u8 flags;
242 struct list_head peers;
243 struct device dev;
244 struct work_struct vport_delete_work;
245 } __attribute__((aligned(sizeof(unsigned long))));
246
247 /* bit field values for struct fc_vport "flags" field: */
248 #define FC_VPORT_CREATING 0x01
249 #define FC_VPORT_DELETING 0x02
250 #define FC_VPORT_DELETED 0x04
251 #define FC_VPORT_DEL 0x06 /* Any DELETE state */
252
253 #define dev_to_vport(d) \
254 container_of(d, struct fc_vport, dev)
255 #define transport_class_to_vport(dev) \
256 dev_to_vport(dev->parent)
257 #define vport_to_shost(v) \
258 (v->shost)
259 #define vport_to_shost_channel(v) \
260 (v->channel)
261 #define vport_to_parent(v) \
262 (v->dev.parent)
263
264
265 /* Error return codes for vport_create() callback */
266 #define VPCERR_UNSUPPORTED -ENOSYS /* no driver/adapter
267 support */
268 #define VPCERR_BAD_WWN -ENOTUNIQ /* driver validation
269 of WWNs failed */
270 #define VPCERR_NO_FABRIC_SUPP -EOPNOTSUPP /* Fabric connection
271 is loop or the
272 Fabric Port does
273 not support NPIV */
274
275 /*
276 * fc_rport_identifiers: This set of data contains all elements
277 * to uniquely identify a remote FC port. The driver uses this data
278 * to report the existence of a remote FC port in the topology. Internally,
279 * the transport uses this data for attributes and to manage consistent
280 * target id bindings.
281 */
282 struct fc_rport_identifiers {
283 u64 node_name;
284 u64 port_name;
285 u32 port_id;
286 u32 roles;
287 };
288
289
290 /* Macro for use in defining Remote Port attributes */
291 #define FC_RPORT_ATTR(_name,_mode,_show,_store) \
292 struct device_attribute dev_attr_rport_##_name = \
293 __ATTR(_name,_mode,_show,_store)
294
295
296 /*
297 * FC Remote Port Attributes
298 *
299 * This structure exists for each remote FC port that a LLDD notifies
300 * the subsystem of. A remote FC port may or may not be a SCSI Target,
301 * also be a SCSI initiator, IP endpoint, etc. As such, the remote
302 * port is considered a separate entity, independent of "role" (such
303 * as scsi target).
304 *
305 * --
306 *
307 * Attributes are based on HBAAPI V2.0 definitions. Only those
308 * attributes that are determinable by the local port (aka Host)
309 * are contained.
310 *
311 * Fixed attributes are not expected to change. The driver is
312 * expected to set these values after successfully calling
313 * fc_remote_port_add(). The transport fully manages all get functions
314 * w/o driver interaction.
315 *
316 * Dynamic attributes are expected to change. The driver participates
317 * in all get/set operations via functions provided by the driver.
318 *
319 * Private attributes are transport-managed values. They are fully
320 * managed by the transport w/o driver interaction.
321 */
322
323 struct fc_rport { /* aka fc_starget_attrs */
324 /* Fixed Attributes */
325 u32 maxframe_size;
326 u32 supported_classes;
327
328 /* Dynamic Attributes */
329 u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */
330
331 /* Private (Transport-managed) Attributes */
332 u64 node_name;
333 u64 port_name;
334 u32 port_id;
335 u32 roles;
336 enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */
337 u32 scsi_target_id;
338 u32 fast_io_fail_tmo;
339
340 /* exported data */
341 void *dd_data; /* Used for driver-specific storage */
342
343 /* internal data */
344 unsigned int channel;
345 u32 number;
346 u8 flags;
347 struct list_head peers;
348 struct device dev;
349 struct delayed_work dev_loss_work;
350 struct work_struct scan_work;
351 struct delayed_work fail_io_work;
352 struct work_struct stgt_delete_work;
353 struct work_struct rport_delete_work;
354 struct request_queue *rqst_q; /* bsg support */
355 } __attribute__((aligned(sizeof(unsigned long))));
356
357 /* bit field values for struct fc_rport "flags" field: */
358 #define FC_RPORT_DEVLOSS_PENDING 0x01
359 #define FC_RPORT_SCAN_PENDING 0x02
360 #define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04
361 #define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08
362
363 #define dev_to_rport(d) \
364 container_of(d, struct fc_rport, dev)
365 #define transport_class_to_rport(dev) \
366 dev_to_rport(dev->parent)
367 #define rport_to_shost(r) \
368 dev_to_shost(r->dev.parent)
369
370 /*
371 * FC SCSI Target Attributes
372 *
373 * The SCSI Target is considered an extension of a remote port (as
374 * a remote port can be more than a SCSI Target). Within the scsi
375 * subsystem, we leave the Target as a separate entity. Doing so
376 * provides backward compatibility with prior FC transport api's,
377 * and lets remote ports be handled entirely within the FC transport
378 * and independently from the scsi subsystem. The drawback is that
379 * some data will be duplicated.
380 */
381
382 struct fc_starget_attrs { /* aka fc_target_attrs */
383 /* Dynamic Attributes */
384 u64 node_name;
385 u64 port_name;
386 u32 port_id;
387 };
388
389 #define fc_starget_node_name(x) \
390 (((struct fc_starget_attrs *)&(x)->starget_data)->node_name)
391 #define fc_starget_port_name(x) \
392 (((struct fc_starget_attrs *)&(x)->starget_data)->port_name)
393 #define fc_starget_port_id(x) \
394 (((struct fc_starget_attrs *)&(x)->starget_data)->port_id)
395
396 #define starget_to_rport(s) \
397 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL
398
399
400 /*
401 * FC Local Port (Host) Statistics
402 */
403
404 /* FC Statistics - Following FC HBAAPI v2.0 guidelines */
405 struct fc_host_statistics {
406 /* port statistics */
407 u64 seconds_since_last_reset;
408 u64 tx_frames;
409 u64 tx_words;
410 u64 rx_frames;
411 u64 rx_words;
412 u64 lip_count;
413 u64 nos_count;
414 u64 error_frames;
415 u64 dumped_frames;
416 u64 link_failure_count;
417 u64 loss_of_sync_count;
418 u64 loss_of_signal_count;
419 u64 prim_seq_protocol_err_count;
420 u64 invalid_tx_word_count;
421 u64 invalid_crc_count;
422
423 /* fc4 statistics (only FCP supported currently) */
424 u64 fcp_input_requests;
425 u64 fcp_output_requests;
426 u64 fcp_control_requests;
427 u64 fcp_input_megabytes;
428 u64 fcp_output_megabytes;
429 };
430
431
432 /*
433 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
434 */
435
436 /*
437 * fc_host_event_code: If you alter this, you also need to alter
438 * scsi_transport_fc.c (for the ascii descriptions).
439 */
440 enum fc_host_event_code {
441 FCH_EVT_LIP = 0x1,
442 FCH_EVT_LINKUP = 0x2,
443 FCH_EVT_LINKDOWN = 0x3,
444 FCH_EVT_LIPRESET = 0x4,
445 FCH_EVT_RSCN = 0x5,
446 FCH_EVT_ADAPTER_CHANGE = 0x103,
447 FCH_EVT_PORT_UNKNOWN = 0x200,
448 FCH_EVT_PORT_OFFLINE = 0x201,
449 FCH_EVT_PORT_ONLINE = 0x202,
450 FCH_EVT_PORT_FABRIC = 0x204,
451 FCH_EVT_LINK_UNKNOWN = 0x500,
452 FCH_EVT_VENDOR_UNIQUE = 0xffff,
453 };
454
455
456 /*
457 * FC Local Port (Host) Attributes
458 *
459 * Attributes are based on HBAAPI V2.0 definitions.
460 * Note: OSDeviceName is determined by user-space library
461 *
462 * Fixed attributes are not expected to change. The driver is
463 * expected to set these values after successfully calling scsi_add_host().
464 * The transport fully manages all get functions w/o driver interaction.
465 *
466 * Dynamic attributes are expected to change. The driver participates
467 * in all get/set operations via functions provided by the driver.
468 *
469 * Private attributes are transport-managed values. They are fully
470 * managed by the transport w/o driver interaction.
471 */
472
473 #define FC_FC4_LIST_SIZE 32
474 #define FC_SYMBOLIC_NAME_SIZE 256
475 #define FC_VERSION_STRING_SIZE 64
476 #define FC_SERIAL_NUMBER_SIZE 80
477
478 struct fc_host_attrs {
479 /* Fixed Attributes */
480 u64 node_name;
481 u64 port_name;
482 u64 permanent_port_name;
483 u32 supported_classes;
484 u8 supported_fc4s[FC_FC4_LIST_SIZE];
485 u32 supported_speeds;
486 u32 maxframe_size;
487 u16 max_npiv_vports;
488 char serial_number[FC_SERIAL_NUMBER_SIZE];
489 char manufacturer[FC_SERIAL_NUMBER_SIZE];
490 char model[FC_SYMBOLIC_NAME_SIZE];
491 char model_description[FC_SYMBOLIC_NAME_SIZE];
492 char hardware_version[FC_VERSION_STRING_SIZE];
493 char driver_version[FC_VERSION_STRING_SIZE];
494 char firmware_version[FC_VERSION_STRING_SIZE];
495 char optionrom_version[FC_VERSION_STRING_SIZE];
496
497 /* Dynamic Attributes */
498 u32 port_id;
499 enum fc_port_type port_type;
500 enum fc_port_state port_state;
501 u8 active_fc4s[FC_FC4_LIST_SIZE];
502 u32 speed;
503 u64 fabric_name;
504 char symbolic_name[FC_SYMBOLIC_NAME_SIZE];
505 char system_hostname[FC_SYMBOLIC_NAME_SIZE];
506 u32 dev_loss_tmo;
507
508 /* Private (Transport-managed) Attributes */
509 enum fc_tgtid_binding_type tgtid_bind_type;
510
511 /* internal data */
512 struct list_head rports;
513 struct list_head rport_bindings;
514 struct list_head vports;
515 u32 next_rport_number;
516 u32 next_target_id;
517 u32 next_vport_number;
518 u16 npiv_vports_inuse;
519
520 /* work queues for rport state manipulation */
521 char work_q_name[20];
522 struct workqueue_struct *work_q;
523 char devloss_work_q_name[20];
524 struct workqueue_struct *devloss_work_q;
525
526 /* bsg support */
527 struct request_queue *rqst_q;
528 };
529
530 #define shost_to_fc_host(x) \
531 ((struct fc_host_attrs *)(x)->shost_data)
532
533 #define fc_host_node_name(x) \
534 (((struct fc_host_attrs *)(x)->shost_data)->node_name)
535 #define fc_host_port_name(x) \
536 (((struct fc_host_attrs *)(x)->shost_data)->port_name)
537 #define fc_host_permanent_port_name(x) \
538 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
539 #define fc_host_supported_classes(x) \
540 (((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
541 #define fc_host_supported_fc4s(x) \
542 (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
543 #define fc_host_supported_speeds(x) \
544 (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
545 #define fc_host_maxframe_size(x) \
546 (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
547 #define fc_host_max_npiv_vports(x) \
548 (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports)
549 #define fc_host_serial_number(x) \
550 (((struct fc_host_attrs *)(x)->shost_data)->serial_number)
551 #define fc_host_manufacturer(x) \
552 (((struct fc_host_attrs *)(x)->shost_data)->manufacturer)
553 #define fc_host_model(x) \
554 (((struct fc_host_attrs *)(x)->shost_data)->model)
555 #define fc_host_model_description(x) \
556 (((struct fc_host_attrs *)(x)->shost_data)->model_description)
557 #define fc_host_hardware_version(x) \
558 (((struct fc_host_attrs *)(x)->shost_data)->hardware_version)
559 #define fc_host_driver_version(x) \
560 (((struct fc_host_attrs *)(x)->shost_data)->driver_version)
561 #define fc_host_firmware_version(x) \
562 (((struct fc_host_attrs *)(x)->shost_data)->firmware_version)
563 #define fc_host_optionrom_version(x) \
564 (((struct fc_host_attrs *)(x)->shost_data)->optionrom_version)
565 #define fc_host_port_id(x) \
566 (((struct fc_host_attrs *)(x)->shost_data)->port_id)
567 #define fc_host_port_type(x) \
568 (((struct fc_host_attrs *)(x)->shost_data)->port_type)
569 #define fc_host_port_state(x) \
570 (((struct fc_host_attrs *)(x)->shost_data)->port_state)
571 #define fc_host_active_fc4s(x) \
572 (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
573 #define fc_host_speed(x) \
574 (((struct fc_host_attrs *)(x)->shost_data)->speed)
575 #define fc_host_fabric_name(x) \
576 (((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
577 #define fc_host_symbolic_name(x) \
578 (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
579 #define fc_host_system_hostname(x) \
580 (((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
581 #define fc_host_tgtid_bind_type(x) \
582 (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
583 #define fc_host_rports(x) \
584 (((struct fc_host_attrs *)(x)->shost_data)->rports)
585 #define fc_host_rport_bindings(x) \
586 (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
587 #define fc_host_vports(x) \
588 (((struct fc_host_attrs *)(x)->shost_data)->vports)
589 #define fc_host_next_rport_number(x) \
590 (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
591 #define fc_host_next_target_id(x) \
592 (((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
593 #define fc_host_next_vport_number(x) \
594 (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number)
595 #define fc_host_npiv_vports_inuse(x) \
596 (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse)
597 #define fc_host_work_q_name(x) \
598 (((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
599 #define fc_host_work_q(x) \
600 (((struct fc_host_attrs *)(x)->shost_data)->work_q)
601 #define fc_host_devloss_work_q_name(x) \
602 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
603 #define fc_host_devloss_work_q(x) \
604 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)
605 #define fc_host_dev_loss_tmo(x) \
606 (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo)
607
608
609 struct fc_bsg_buffer {
610 unsigned int payload_len;
611 int sg_cnt;
612 struct scatterlist *sg_list;
613 };
614
615 /* Values for fc_bsg_job->state_flags (bitflags) */
616 #define FC_RQST_STATE_INPROGRESS 0
617 #define FC_RQST_STATE_DONE 1
618
619 struct fc_bsg_job {
620 struct Scsi_Host *shost;
621 struct fc_rport *rport;
622 struct device *dev;
623 struct request *req;
624 spinlock_t job_lock;
625 unsigned int state_flags;
626 unsigned int ref_cnt;
627 void (*job_done)(struct fc_bsg_job *);
628
629 struct fc_bsg_request *request;
630 struct fc_bsg_reply *reply;
631 unsigned int request_len;
632 unsigned int reply_len;
633 /*
634 * On entry : reply_len indicates the buffer size allocated for
635 * the reply.
636 *
637 * Upon completion : the message handler must set reply_len
638 * to indicates the size of the reply to be returned to the
639 * caller.
640 */
641
642 /* DMA payloads for the request/response */
643 struct fc_bsg_buffer request_payload;
644 struct fc_bsg_buffer reply_payload;
645
646 void *dd_data; /* Used for driver-specific storage */
647 };
648
649
650 /* The functions by which the transport class and the driver communicate */
651 struct fc_function_template {
652 void (*get_rport_dev_loss_tmo)(struct fc_rport *);
653 void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32);
654
655 void (*get_starget_node_name)(struct scsi_target *);
656 void (*get_starget_port_name)(struct scsi_target *);
657 void (*get_starget_port_id)(struct scsi_target *);
658
659 void (*get_host_port_id)(struct Scsi_Host *);
660 void (*get_host_port_type)(struct Scsi_Host *);
661 void (*get_host_port_state)(struct Scsi_Host *);
662 void (*get_host_active_fc4s)(struct Scsi_Host *);
663 void (*get_host_speed)(struct Scsi_Host *);
664 void (*get_host_fabric_name)(struct Scsi_Host *);
665 void (*get_host_symbolic_name)(struct Scsi_Host *);
666 void (*set_host_system_hostname)(struct Scsi_Host *);
667
668 struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *);
669 void (*reset_fc_host_stats)(struct Scsi_Host *);
670
671 int (*issue_fc_host_lip)(struct Scsi_Host *);
672
673 void (*dev_loss_tmo_callbk)(struct fc_rport *);
674 void (*terminate_rport_io)(struct fc_rport *);
675
676 void (*set_vport_symbolic_name)(struct fc_vport *);
677 int (*vport_create)(struct fc_vport *, bool);
678 int (*vport_disable)(struct fc_vport *, bool);
679 int (*vport_delete)(struct fc_vport *);
680
681 /* target-mode drivers' functions */
682 int (* tsk_mgmt_response)(struct Scsi_Host *, u64, u64, int);
683 int (* it_nexus_response)(struct Scsi_Host *, u64, int);
684
685 /* bsg support */
686 int (*bsg_request)(struct fc_bsg_job *);
687 int (*bsg_timeout)(struct fc_bsg_job *);
688
689 /* allocation lengths for host-specific data */
690 u32 dd_fcrport_size;
691 u32 dd_fcvport_size;
692 u32 dd_bsg_size;
693
694 /*
695 * The driver sets these to tell the transport class it
696 * wants the attributes displayed in sysfs. If the show_ flag
697 * is not set, the attribute will be private to the transport
698 * class
699 */
700
701 /* remote port fixed attributes */
702 unsigned long show_rport_maxframe_size:1;
703 unsigned long show_rport_supported_classes:1;
704 unsigned long show_rport_dev_loss_tmo:1;
705
706 /*
707 * target dynamic attributes
708 * These should all be "1" if the driver uses the remote port
709 * add/delete functions (so attributes reflect rport values).
710 */
711 unsigned long show_starget_node_name:1;
712 unsigned long show_starget_port_name:1;
713 unsigned long show_starget_port_id:1;
714
715 /* host fixed attributes */
716 unsigned long show_host_node_name:1;
717 unsigned long show_host_port_name:1;
718 unsigned long show_host_permanent_port_name:1;
719 unsigned long show_host_supported_classes:1;
720 unsigned long show_host_supported_fc4s:1;
721 unsigned long show_host_supported_speeds:1;
722 unsigned long show_host_maxframe_size:1;
723 unsigned long show_host_serial_number:1;
724 unsigned long show_host_manufacturer:1;
725 unsigned long show_host_model:1;
726 unsigned long show_host_model_description:1;
727 unsigned long show_host_hardware_version:1;
728 unsigned long show_host_driver_version:1;
729 unsigned long show_host_firmware_version:1;
730 unsigned long show_host_optionrom_version:1;
731 /* host dynamic attributes */
732 unsigned long show_host_port_id:1;
733 unsigned long show_host_port_type:1;
734 unsigned long show_host_port_state:1;
735 unsigned long show_host_active_fc4s:1;
736 unsigned long show_host_speed:1;
737 unsigned long show_host_fabric_name:1;
738 unsigned long show_host_symbolic_name:1;
739 unsigned long show_host_system_hostname:1;
740
741 unsigned long disable_target_scan:1;
742 };
743
744
745 /**
746 * fc_remote_port_chkready - called to validate the remote port state
747 * prior to initiating io to the port.
748 *
749 * Returns a scsi result code that can be returned by the LLDD.
750 *
751 * @rport: remote port to be checked
752 **/
753 static inline int
fc_remote_port_chkready(struct fc_rport * rport)754 fc_remote_port_chkready(struct fc_rport *rport)
755 {
756 int result;
757
758 switch (rport->port_state) {
759 case FC_PORTSTATE_ONLINE:
760 if (rport->roles & FC_PORT_ROLE_FCP_TARGET)
761 result = 0;
762 else if (rport->flags & FC_RPORT_DEVLOSS_PENDING)
763 result = DID_IMM_RETRY << 16;
764 else
765 result = DID_NO_CONNECT << 16;
766 break;
767 case FC_PORTSTATE_BLOCKED:
768 if (rport->flags & FC_RPORT_FAST_FAIL_TIMEDOUT)
769 result = DID_TRANSPORT_FAILFAST << 16;
770 else
771 result = DID_IMM_RETRY << 16;
772 break;
773 default:
774 result = DID_NO_CONNECT << 16;
775 break;
776 }
777 return result;
778 }
779
wwn_to_u64(u8 * wwn)780 static inline u64 wwn_to_u64(u8 *wwn)
781 {
782 return (u64)wwn[0] << 56 | (u64)wwn[1] << 48 |
783 (u64)wwn[2] << 40 | (u64)wwn[3] << 32 |
784 (u64)wwn[4] << 24 | (u64)wwn[5] << 16 |
785 (u64)wwn[6] << 8 | (u64)wwn[7];
786 }
787
u64_to_wwn(u64 inm,u8 * wwn)788 static inline void u64_to_wwn(u64 inm, u8 *wwn)
789 {
790 wwn[0] = (inm >> 56) & 0xff;
791 wwn[1] = (inm >> 48) & 0xff;
792 wwn[2] = (inm >> 40) & 0xff;
793 wwn[3] = (inm >> 32) & 0xff;
794 wwn[4] = (inm >> 24) & 0xff;
795 wwn[5] = (inm >> 16) & 0xff;
796 wwn[6] = (inm >> 8) & 0xff;
797 wwn[7] = inm & 0xff;
798 }
799
800 /**
801 * fc_vport_set_state() - called to set a vport's state. Saves the old state,
802 * excepting the transitory states of initializing and sending the ELS
803 * traffic to instantiate the vport on the link.
804 *
805 * Assumes the driver has surrounded this with the proper locking to ensure
806 * a coherent state change.
807 *
808 * @vport: virtual port whose state is changing
809 * @new_state: new state
810 **/
811 static inline void
fc_vport_set_state(struct fc_vport * vport,enum fc_vport_state new_state)812 fc_vport_set_state(struct fc_vport *vport, enum fc_vport_state new_state)
813 {
814 if ((new_state != FC_VPORT_UNKNOWN) &&
815 (new_state != FC_VPORT_INITIALIZING))
816 vport->vport_last_state = vport->vport_state;
817 vport->vport_state = new_state;
818 }
819
820 struct scsi_transport_template *fc_attach_transport(
821 struct fc_function_template *);
822 void fc_release_transport(struct scsi_transport_template *);
823 void fc_remove_host(struct Scsi_Host *);
824 struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost,
825 int channel, struct fc_rport_identifiers *ids);
826 void fc_remote_port_delete(struct fc_rport *rport);
827 void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles);
828 int scsi_is_fc_rport(const struct device *);
829 u32 fc_get_event_number(void);
830 void fc_host_post_event(struct Scsi_Host *shost, u32 event_number,
831 enum fc_host_event_code event_code, u32 event_data);
832 void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number,
833 u32 data_len, char * data_buf, u64 vendor_id);
834 /* Note: when specifying vendor_id to fc_host_post_vendor_event()
835 * be sure to read the Vendor Type and ID formatting requirements
836 * specified in scsi_netlink.h
837 */
838 struct fc_vport *fc_vport_create(struct Scsi_Host *shost, int channel,
839 struct fc_vport_identifiers *);
840 int fc_vport_terminate(struct fc_vport *vport);
841 int fc_block_scsi_eh(struct scsi_cmnd *cmnd);
842
843 #endif /* SCSI_TRANSPORT_FC_H */
844