2a65167a8f10e80ded5aa5532e8fbdb04cf3e7dc
[linux-2.6.git] / include / scsi / scsi_transport_fc.h
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_4GBIT              4
130 #define FC_PORTSPEED_10GBIT             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
490         /* Dynamic Attributes */
491         u32 port_id;
492         enum fc_port_type port_type;
493         enum fc_port_state port_state;
494         u8  active_fc4s[FC_FC4_LIST_SIZE];
495         u32 speed;
496         u64 fabric_name;
497         char symbolic_name[FC_SYMBOLIC_NAME_SIZE];
498         char system_hostname[FC_SYMBOLIC_NAME_SIZE];
499         u32 dev_loss_tmo;
500
501         /* Private (Transport-managed) Attributes */
502         enum fc_tgtid_binding_type  tgtid_bind_type;
503
504         /* internal data */
505         struct list_head rports;
506         struct list_head rport_bindings;
507         struct list_head vports;
508         u32 next_rport_number;
509         u32 next_target_id;
510         u32 next_vport_number;
511         u16 npiv_vports_inuse;
512
513         /* work queues for rport state manipulation */
514         char work_q_name[20];
515         struct workqueue_struct *work_q;
516         char devloss_work_q_name[20];
517         struct workqueue_struct *devloss_work_q;
518
519         /* bsg support */
520         struct request_queue *rqst_q;
521 };
522
523 #define shost_to_fc_host(x) \
524         ((struct fc_host_attrs *)(x)->shost_data)
525
526 #define fc_host_node_name(x) \
527         (((struct fc_host_attrs *)(x)->shost_data)->node_name)
528 #define fc_host_port_name(x)    \
529         (((struct fc_host_attrs *)(x)->shost_data)->port_name)
530 #define fc_host_permanent_port_name(x)  \
531         (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
532 #define fc_host_supported_classes(x)    \
533         (((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
534 #define fc_host_supported_fc4s(x)       \
535         (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
536 #define fc_host_supported_speeds(x)     \
537         (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
538 #define fc_host_maxframe_size(x)        \
539         (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
540 #define fc_host_max_npiv_vports(x)      \
541         (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports)
542 #define fc_host_serial_number(x)        \
543         (((struct fc_host_attrs *)(x)->shost_data)->serial_number)
544 #define fc_host_port_id(x)      \
545         (((struct fc_host_attrs *)(x)->shost_data)->port_id)
546 #define fc_host_port_type(x)    \
547         (((struct fc_host_attrs *)(x)->shost_data)->port_type)
548 #define fc_host_port_state(x)   \
549         (((struct fc_host_attrs *)(x)->shost_data)->port_state)
550 #define fc_host_active_fc4s(x)  \
551         (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
552 #define fc_host_speed(x)        \
553         (((struct fc_host_attrs *)(x)->shost_data)->speed)
554 #define fc_host_fabric_name(x)  \
555         (((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
556 #define fc_host_symbolic_name(x)        \
557         (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
558 #define fc_host_system_hostname(x)      \
559         (((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
560 #define fc_host_tgtid_bind_type(x) \
561         (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
562 #define fc_host_rports(x) \
563         (((struct fc_host_attrs *)(x)->shost_data)->rports)
564 #define fc_host_rport_bindings(x) \
565         (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
566 #define fc_host_vports(x) \
567         (((struct fc_host_attrs *)(x)->shost_data)->vports)
568 #define fc_host_next_rport_number(x) \
569         (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
570 #define fc_host_next_target_id(x) \
571         (((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
572 #define fc_host_next_vport_number(x) \
573         (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number)
574 #define fc_host_npiv_vports_inuse(x)    \
575         (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse)
576 #define fc_host_work_q_name(x) \
577         (((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
578 #define fc_host_work_q(x) \
579         (((struct fc_host_attrs *)(x)->shost_data)->work_q)
580 #define fc_host_devloss_work_q_name(x) \
581         (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
582 #define fc_host_devloss_work_q(x) \
583         (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)
584 #define fc_host_dev_loss_tmo(x) \
585         (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo)
586
587
588 struct fc_bsg_buffer {
589         unsigned int payload_len;
590         int sg_cnt;
591         struct scatterlist *sg_list;
592 };
593
594 /* Values for fc_bsg_job->state_flags (bitflags) */
595 #define FC_RQST_STATE_INPROGRESS        0
596 #define FC_RQST_STATE_DONE              1
597
598 struct fc_bsg_job {
599         struct Scsi_Host *shost;
600         struct fc_rport *rport;
601         struct device *dev;
602         struct request *req;
603         spinlock_t job_lock;
604         unsigned int state_flags;
605         unsigned int ref_cnt;
606         void (*job_done)(struct fc_bsg_job *);
607
608         struct fc_bsg_request *request;
609         struct fc_bsg_reply *reply;
610         unsigned int request_len;
611         unsigned int reply_len;
612         /*
613          * On entry : reply_len indicates the buffer size allocated for
614          * the reply.
615          *
616          * Upon completion : the message handler must set reply_len
617          *  to indicates the size of the reply to be returned to the
618          *  caller.
619          */
620
621         /* DMA payloads for the request/response */
622         struct fc_bsg_buffer request_payload;
623         struct fc_bsg_buffer reply_payload;
624
625         void *dd_data;                  /* Used for driver-specific storage */
626 };
627
628
629 /* The functions by which the transport class and the driver communicate */
630 struct fc_function_template {
631         void    (*get_rport_dev_loss_tmo)(struct fc_rport *);
632         void    (*set_rport_dev_loss_tmo)(struct fc_rport *, u32);
633
634         void    (*get_starget_node_name)(struct scsi_target *);
635         void    (*get_starget_port_name)(struct scsi_target *);
636         void    (*get_starget_port_id)(struct scsi_target *);
637
638         void    (*get_host_port_id)(struct Scsi_Host *);
639         void    (*get_host_port_type)(struct Scsi_Host *);
640         void    (*get_host_port_state)(struct Scsi_Host *);
641         void    (*get_host_active_fc4s)(struct Scsi_Host *);
642         void    (*get_host_speed)(struct Scsi_Host *);
643         void    (*get_host_fabric_name)(struct Scsi_Host *);
644         void    (*get_host_symbolic_name)(struct Scsi_Host *);
645         void    (*set_host_system_hostname)(struct Scsi_Host *);
646
647         struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *);
648         void    (*reset_fc_host_stats)(struct Scsi_Host *);
649
650         int     (*issue_fc_host_lip)(struct Scsi_Host *);
651
652         void    (*dev_loss_tmo_callbk)(struct fc_rport *);
653         void    (*terminate_rport_io)(struct fc_rport *);
654
655         void    (*set_vport_symbolic_name)(struct fc_vport *);
656         int     (*vport_create)(struct fc_vport *, bool);
657         int     (*vport_disable)(struct fc_vport *, bool);
658         int     (*vport_delete)(struct fc_vport *);
659
660         /* target-mode drivers' functions */
661         int     (* tsk_mgmt_response)(struct Scsi_Host *, u64, u64, int);
662         int     (* it_nexus_response)(struct Scsi_Host *, u64, int);
663
664         /* bsg support */
665         int     (*bsg_request)(struct fc_bsg_job *);
666         int     (*bsg_timeout)(struct fc_bsg_job *);
667
668         /* allocation lengths for host-specific data */
669         u32                             dd_fcrport_size;
670         u32                             dd_fcvport_size;
671         u32                             dd_bsg_size;
672
673         /*
674          * The driver sets these to tell the transport class it
675          * wants the attributes displayed in sysfs.  If the show_ flag
676          * is not set, the attribute will be private to the transport
677          * class
678          */
679
680         /* remote port fixed attributes */
681         unsigned long   show_rport_maxframe_size:1;
682         unsigned long   show_rport_supported_classes:1;
683         unsigned long   show_rport_dev_loss_tmo:1;
684
685         /*
686          * target dynamic attributes
687          * These should all be "1" if the driver uses the remote port
688          * add/delete functions (so attributes reflect rport values).
689          */
690         unsigned long   show_starget_node_name:1;
691         unsigned long   show_starget_port_name:1;
692         unsigned long   show_starget_port_id:1;
693
694         /* host fixed attributes */
695         unsigned long   show_host_node_name:1;
696         unsigned long   show_host_port_name:1;
697         unsigned long   show_host_permanent_port_name:1;
698         unsigned long   show_host_supported_classes:1;
699         unsigned long   show_host_supported_fc4s:1;
700         unsigned long   show_host_supported_speeds:1;
701         unsigned long   show_host_maxframe_size:1;
702         unsigned long   show_host_serial_number:1;
703         /* host dynamic attributes */
704         unsigned long   show_host_port_id:1;
705         unsigned long   show_host_port_type:1;
706         unsigned long   show_host_port_state:1;
707         unsigned long   show_host_active_fc4s:1;
708         unsigned long   show_host_speed:1;
709         unsigned long   show_host_fabric_name:1;
710         unsigned long   show_host_symbolic_name:1;
711         unsigned long   show_host_system_hostname:1;
712
713         unsigned long   disable_target_scan:1;
714 };
715
716
717 /**
718  * fc_remote_port_chkready - called to validate the remote port state
719  *   prior to initiating io to the port.
720  *
721  * Returns a scsi result code that can be returned by the LLDD.
722  *
723  * @rport:      remote port to be checked
724  **/
725 static inline int
726 fc_remote_port_chkready(struct fc_rport *rport)
727 {
728         int result;
729
730         switch (rport->port_state) {
731         case FC_PORTSTATE_ONLINE:
732                 if (rport->roles & FC_PORT_ROLE_FCP_TARGET)
733                         result = 0;
734                 else if (rport->flags & FC_RPORT_DEVLOSS_PENDING)
735                         result = DID_IMM_RETRY << 16;
736                 else
737                         result = DID_NO_CONNECT << 16;
738                 break;
739         case FC_PORTSTATE_BLOCKED:
740                 if (rport->flags & FC_RPORT_FAST_FAIL_TIMEDOUT)
741                         result = DID_TRANSPORT_FAILFAST << 16;
742                 else
743                         result = DID_IMM_RETRY << 16;
744                 break;
745         default:
746                 result = DID_NO_CONNECT << 16;
747                 break;
748         }
749         return result;
750 }
751
752 static inline u64 wwn_to_u64(u8 *wwn)
753 {
754         return (u64)wwn[0] << 56 | (u64)wwn[1] << 48 |
755             (u64)wwn[2] << 40 | (u64)wwn[3] << 32 |
756             (u64)wwn[4] << 24 | (u64)wwn[5] << 16 |
757             (u64)wwn[6] <<  8 | (u64)wwn[7];
758 }
759
760 static inline void u64_to_wwn(u64 inm, u8 *wwn)
761 {
762         wwn[0] = (inm >> 56) & 0xff;
763         wwn[1] = (inm >> 48) & 0xff;
764         wwn[2] = (inm >> 40) & 0xff;
765         wwn[3] = (inm >> 32) & 0xff;
766         wwn[4] = (inm >> 24) & 0xff;
767         wwn[5] = (inm >> 16) & 0xff;
768         wwn[6] = (inm >> 8) & 0xff;
769         wwn[7] = inm & 0xff;
770 }
771
772 /**
773  * fc_vport_set_state() - called to set a vport's state. Saves the old state,
774  *   excepting the transitory states of initializing and sending the ELS
775  *   traffic to instantiate the vport on the link.
776  *
777  * Assumes the driver has surrounded this with the proper locking to ensure
778  * a coherent state change.
779  *
780  * @vport:      virtual port whose state is changing
781  * @new_state:  new state
782  **/
783 static inline void
784 fc_vport_set_state(struct fc_vport *vport, enum fc_vport_state new_state)
785 {
786         if ((new_state != FC_VPORT_UNKNOWN) &&
787             (new_state != FC_VPORT_INITIALIZING))
788                 vport->vport_last_state = vport->vport_state;
789         vport->vport_state = new_state;
790 }
791
792 struct scsi_transport_template *fc_attach_transport(
793                         struct fc_function_template *);
794 void fc_release_transport(struct scsi_transport_template *);
795 void fc_remove_host(struct Scsi_Host *);
796 struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost,
797                         int channel, struct fc_rport_identifiers  *ids);
798 void fc_remote_port_delete(struct fc_rport  *rport);
799 void fc_remote_port_rolechg(struct fc_rport  *rport, u32 roles);
800 int scsi_is_fc_rport(const struct device *);
801 u32 fc_get_event_number(void);
802 void fc_host_post_event(struct Scsi_Host *shost, u32 event_number,
803                 enum fc_host_event_code event_code, u32 event_data);
804 void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number,
805                 u32 data_len, char * data_buf, u64 vendor_id);
806         /* Note: when specifying vendor_id to fc_host_post_vendor_event()
807          *   be sure to read the Vendor Type and ID formatting requirements
808          *   specified in scsi_netlink.h
809          */
810 struct fc_vport *fc_vport_create(struct Scsi_Host *shost, int channel,
811                 struct fc_vport_identifiers *);
812 int fc_vport_terminate(struct fc_vport *vport);
813 int fc_block_scsi_eh(struct scsi_cmnd *cmnd);
814
815 #endif /* SCSI_TRANSPORT_FC_H */