4 * Global definitions for the zfcp device driver.
6 * Copyright IBM Corporation 2002, 2009
12 /*************************** INCLUDES *****************************************/
14 #include <linux/init.h>
15 #include <linux/moduleparam.h>
16 #include <linux/major.h>
17 #include <linux/blkdev.h>
18 #include <linux/delay.h>
19 #include <linux/timer.h>
20 #include <linux/slab.h>
21 #include <linux/mempool.h>
22 #include <linux/syscalls.h>
23 #include <linux/scatterlist.h>
24 #include <linux/ioctl.h>
25 #include <scsi/scsi.h>
26 #include <scsi/scsi_tcq.h>
27 #include <scsi/scsi_cmnd.h>
28 #include <scsi/scsi_device.h>
29 #include <scsi/scsi_host.h>
30 #include <scsi/scsi_transport.h>
31 #include <scsi/scsi_transport_fc.h>
32 #include <asm/ccwdev.h>
34 #include <asm/debug.h>
35 #include <asm/ebcdic.h>
36 #include <asm/sysinfo.h>
41 /********************* GENERAL DEFINES *********************************/
43 #define REQUEST_LIST_SIZE 128
45 /********************* SCSI SPECIFIC DEFINES *********************************/
46 #define ZFCP_SCSI_ER_TIMEOUT (10*HZ)
48 /********************* CIO/QDIO SPECIFIC DEFINES *****************************/
50 /* DMQ bug workaround: don't use last SBALE */
51 #define ZFCP_MAX_SBALES_PER_SBAL (QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
53 /* index of last SBALE (with respect to DMQ bug workaround) */
54 #define ZFCP_LAST_SBALE_PER_SBAL (ZFCP_MAX_SBALES_PER_SBAL - 1)
56 /* max. number of (data buffer) SBALEs in largest SBAL chain */
57 #define ZFCP_MAX_SBALES_PER_REQ \
58 (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
59 /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
61 #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
62 /* max. number of (data buffer) SBALEs in largest SBAL chain
63 multiplied with number of sectors per 4k block */
65 /********************* FSF SPECIFIC DEFINES *********************************/
67 /* ATTENTION: value must not be used by hardware */
68 #define FSF_QTCB_UNSOLICITED_STATUS 0x6305
70 /* timeout value for "default timer" for fsf requests */
71 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
73 /*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
75 /* timeout for name-server lookup (in seconds) */
76 #define ZFCP_NS_GID_PN_TIMEOUT 10
78 /* task attribute values in FCP-2 FCP_CMND IU */
85 /* task management flags in FCP-2 FCP_CMND IU */
86 #define FCP_CLEAR_ACA 0x40
87 #define FCP_TARGET_RESET 0x20
88 #define FCP_LOGICAL_UNIT_RESET 0x10
89 #define FCP_CLEAR_TASK_SET 0x04
90 #define FCP_ABORT_TASK_SET 0x02
92 #define FCP_CDB_LENGTH 16
94 #define ZFCP_DID_MASK 0x00FFFFFF
96 /* FCP(-2) FCP_CMND IU */
98 u64 fcp_lun
; /* FCP logical unit number */
99 u8 crn
; /* command reference number */
100 u8 reserved0
:5; /* reserved */
101 u8 task_attribute
:3; /* task attribute */
102 u8 task_management_flags
; /* task management flags */
103 u8 add_fcp_cdb_length
:6; /* additional FCP_CDB length */
104 u8 rddata
:1; /* read data */
105 u8 wddata
:1; /* write data */
106 u8 fcp_cdb
[FCP_CDB_LENGTH
];
107 } __attribute__((packed
));
109 /* FCP(-2) FCP_RSP IU */
116 u8 fcp_resid_under
:1;
118 u8 fcp_sns_len_valid
:1;
119 u8 fcp_rsp_len_valid
:1;
127 } __attribute__((packed
));
130 #define RSP_CODE_GOOD 0
131 #define RSP_CODE_LENGTH_MISMATCH 1
132 #define RSP_CODE_FIELD_INVALID 2
133 #define RSP_CODE_RO_MISMATCH 3
134 #define RSP_CODE_TASKMAN_UNSUPP 4
135 #define RSP_CODE_TASKMAN_FAILED 5
140 #define LS_PLOGI 0x03
142 struct fcp_rscn_head
{
144 u8 page_length
; /* always 0x04 */
146 } __attribute__((packed
));
148 struct fcp_rscn_element
{
153 } __attribute__((packed
));
160 } __attribute__((packed
));
165 #define R_A_TOV 10 /* seconds */
167 #define ZFCP_LS_RLS 0x0f
168 #define ZFCP_LS_ADISC 0x52
169 #define ZFCP_LS_RPS 0x56
170 #define ZFCP_LS_RSCN 0x61
171 #define ZFCP_LS_RNID 0x78
173 struct zfcp_ls_adisc
{
180 } __attribute__ ((packed
));
185 #define ZFCP_CT_REVISION 0x01
186 #define ZFCP_CT_DIRECTORY_SERVICE 0xFC
187 #define ZFCP_CT_NAME_SERVER 0x02
188 #define ZFCP_CT_SYNCHRONOUS 0x00
189 #define ZFCP_CT_SCSI_FCP 0x08
190 #define ZFCP_CT_UNABLE_TO_PERFORM_CMD 0x09
191 #define ZFCP_CT_GID_PN 0x0121
192 #define ZFCP_CT_GPN_FT 0x0172
193 #define ZFCP_CT_ACCEPT 0x8002
194 #define ZFCP_CT_REJECT 0x8001
199 #define ZFCP_CT_TIMEOUT (3 * R_A_TOV)
201 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
204 * Note, the leftmost status byte is common among adapter, port
207 #define ZFCP_COMMON_FLAGS 0xfff00000
209 /* common status bits */
210 #define ZFCP_STATUS_COMMON_REMOVE 0x80000000
211 #define ZFCP_STATUS_COMMON_RUNNING 0x40000000
212 #define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000
213 #define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000
214 #define ZFCP_STATUS_COMMON_OPEN 0x04000000
215 #define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000
216 #define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000
217 #define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000
218 #define ZFCP_STATUS_COMMON_NOESC 0x00200000
221 #define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
222 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
223 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
224 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_UP 0x00000020
225 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_KILL 0x00000080
226 #define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
227 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
229 /* FC-PH/FC-GS well-known address identifiers for generic services */
230 #define ZFCP_DID_WKA 0xFFFFF0
231 #define ZFCP_DID_MANAGEMENT_SERVICE 0xFFFFFA
232 #define ZFCP_DID_TIME_SERVICE 0xFFFFFB
233 #define ZFCP_DID_DIRECTORY_SERVICE 0xFFFFFC
234 #define ZFCP_DID_ALIAS_SERVICE 0xFFFFF8
235 #define ZFCP_DID_KEY_DISTRIBUTION_SERVICE 0xFFFFF7
237 /* remote port status */
238 #define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
240 /* well known address (WKA) port status*/
241 enum zfcp_wka_status
{
242 ZFCP_WKA_PORT_OFFLINE
,
243 ZFCP_WKA_PORT_CLOSING
,
244 ZFCP_WKA_PORT_OPENING
,
245 ZFCP_WKA_PORT_ONLINE
,
248 /* logical unit status */
249 #define ZFCP_STATUS_UNIT_SHARED 0x00000004
250 #define ZFCP_STATUS_UNIT_READONLY 0x00000008
252 /* FSF request status (this does not have a common part) */
253 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002
254 #define ZFCP_STATUS_FSFREQ_COMPLETED 0x00000004
255 #define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
256 #define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
257 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
258 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
259 #define ZFCP_STATUS_FSFREQ_ABORTED 0x00000100
260 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
261 #define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP 0x00000400
262 #define ZFCP_STATUS_FSFREQ_RETRY 0x00000800
263 #define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
265 /************************* STRUCTURE DEFINITIONS *****************************/
269 /* holds various memory pools of an adapter */
270 struct zfcp_adapter_mempool
{
271 mempool_t
*fsf_req_erp
;
272 mempool_t
*fsf_req_scsi
;
273 mempool_t
*fsf_req_abort
;
274 mempool_t
*fsf_req_status_read
;
275 mempool_t
*data_status_read
;
276 mempool_t
*data_gid_pn
;
285 u8 gs_type
; // 0xFC Directory Service
286 u8 gs_subtype
; // 0x02 Name Server
287 u8 options
; // 0x00 single bidirectional exchange
289 u16 cmd_rsp_code
; // 0x0121 GID_PN, or 0x0100 GA_NXT
290 u16 max_res_size
; // <= (4096 - 16) / 4
295 } __attribute__ ((packed
));
297 /* nameserver request CT_IU -- for requests where
298 * a port name is required */
299 struct ct_iu_gid_pn_req
{
300 struct ct_hdr header
;
302 } __attribute__ ((packed
));
304 /* FS_ACC IU and data unit for GID_PN nameserver request */
305 struct ct_iu_gid_pn_resp
{
306 struct ct_hdr header
;
308 } __attribute__ ((packed
));
311 * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
312 * @wka_port: port where the request is sent to
313 * @req: scatter-gather list for request
314 * @resp: scatter-gather list for response
315 * @handler: handler function (called for response to the request)
316 * @handler_data: data passed to handler function
317 * @timeout: FSF timeout for this request
318 * @completion: completion for synchronization purposes
319 * @status: used to pass error status to calling function
321 struct zfcp_send_ct
{
322 struct zfcp_wka_port
*wka_port
;
323 struct scatterlist
*req
;
324 struct scatterlist
*resp
;
325 void (*handler
)(unsigned long);
326 unsigned long handler_data
;
328 struct completion
*completion
;
332 /* used for name server requests in error recovery */
333 struct zfcp_gid_pn_data
{
334 struct zfcp_send_ct ct
;
335 struct scatterlist req
;
336 struct scatterlist resp
;
337 struct ct_iu_gid_pn_req ct_iu_req
;
338 struct ct_iu_gid_pn_resp ct_iu_resp
;
339 struct zfcp_port
*port
;
343 * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
344 * @adapter: adapter where request is sent from
345 * @port: port where ELS is destinated (port reference count has to be increased)
346 * @d_id: destiniation id of port where request is sent to
347 * @req: scatter-gather list for request
348 * @resp: scatter-gather list for response
349 * @handler: handler function (called for response to the request)
350 * @handler_data: data passed to handler function
351 * @completion: completion for synchronization purposes
352 * @ls_code: hex code of ELS command
353 * @status: used to pass error status to calling function
355 struct zfcp_send_els
{
356 struct zfcp_adapter
*adapter
;
357 struct zfcp_port
*port
;
359 struct scatterlist
*req
;
360 struct scatterlist
*resp
;
361 void (*handler
)(unsigned long);
362 unsigned long handler_data
;
363 struct completion
*completion
;
368 struct zfcp_wka_port
{
369 struct zfcp_adapter
*adapter
;
370 wait_queue_head_t completion_wq
;
371 enum zfcp_wka_status status
;
376 struct delayed_work work
;
379 struct zfcp_qdio_queue
{
380 struct qdio_buffer
*sbal
[QDIO_MAX_BUFFERS_PER_Q
];
381 u8 first
; /* index of next free bfr in queue */
382 atomic_t count
; /* number of free buffers in queue */
385 struct zfcp_erp_action
{
386 struct list_head list
;
387 int action
; /* requested action code */
388 struct zfcp_adapter
*adapter
; /* device which should be recovered */
389 struct zfcp_port
*port
;
390 struct zfcp_unit
*unit
;
391 u32 status
; /* recovery status */
392 u32 step
; /* active step of this erp action */
393 struct zfcp_fsf_req
*fsf_req
; /* fsf request currently pending
395 struct timer_list timer
;
398 struct fsf_latency_record
{
404 struct latency_cont
{
405 struct fsf_latency_record channel
;
406 struct fsf_latency_record fabric
;
410 struct zfcp_latencies
{
411 struct latency_cont read
;
412 struct latency_cont write
;
413 struct latency_cont cmd
;
417 struct zfcp_adapter
{
418 atomic_t refcount
; /* reference count */
419 wait_queue_head_t remove_wq
; /* can be used to wait for
420 refcount drop to zero */
421 u64 peer_wwnn
; /* P2P peer WWNN */
422 u64 peer_wwpn
; /* P2P peer WWPN */
423 u32 peer_d_id
; /* P2P peer D_ID */
424 struct ccw_device
*ccw_device
; /* S/390 ccw device */
425 u32 hydra_version
; /* Hydra version */
427 u32 adapter_features
; /* FCP channel features */
428 u32 connection_features
; /* host connection features */
429 u32 hardware_version
; /* of FCP channel */
430 u16 timer_ticks
; /* time int for a tick */
431 struct Scsi_Host
*scsi_host
; /* Pointer to mid-layer */
432 struct list_head port_list_head
; /* remote port list */
433 unsigned long req_no
; /* unique FSF req number */
434 struct list_head
*req_list
; /* list of pending reqs */
435 spinlock_t req_list_lock
; /* request list lock */
436 struct zfcp_qdio_queue req_q
; /* request queue */
437 spinlock_t req_q_lock
; /* for operations on queue */
438 ktime_t req_q_time
; /* time of last fill level change */
439 u64 req_q_util
; /* for accounting */
440 spinlock_t qdio_stat_lock
;
441 u32 fsf_req_seq_no
; /* FSF cmnd seq number */
442 wait_queue_head_t request_wq
; /* can be used to wait for
443 more avaliable SBALs */
444 struct zfcp_qdio_queue resp_q
; /* response queue */
445 rwlock_t abort_lock
; /* Protects against SCSI
448 atomic_t stat_miss
; /* # missing status reads*/
449 struct work_struct stat_work
;
450 atomic_t status
; /* status of this adapter */
451 struct list_head erp_ready_head
; /* error recovery for this
453 struct list_head erp_running_head
;
455 struct semaphore erp_ready_sem
;
456 wait_queue_head_t erp_thread_wqh
;
457 wait_queue_head_t erp_done_wqh
;
458 struct zfcp_erp_action erp_action
; /* pending error recovery */
459 atomic_t erp_counter
;
460 u32 erp_total_count
; /* total nr of enqueued erp
462 u32 erp_low_mem_count
; /* nr of erp actions waiting
464 struct zfcp_wka_port nsp
; /* adapter's nameserver */
465 debug_info_t
*rec_dbf
;
466 debug_info_t
*hba_dbf
;
467 debug_info_t
*san_dbf
; /* debug feature areas */
468 debug_info_t
*scsi_dbf
;
469 spinlock_t rec_dbf_lock
;
470 spinlock_t hba_dbf_lock
;
471 spinlock_t san_dbf_lock
;
472 spinlock_t scsi_dbf_lock
;
473 struct zfcp_rec_dbf_record rec_dbf_buf
;
474 struct zfcp_hba_dbf_record hba_dbf_buf
;
475 struct zfcp_san_dbf_record san_dbf_buf
;
476 struct zfcp_scsi_dbf_record scsi_dbf_buf
;
477 struct zfcp_adapter_mempool pool
; /* Adapter memory pools */
478 struct qdio_initialize qdio_init_data
; /* for qdio_establish */
479 struct fc_host_statistics
*fc_stats
;
480 struct fsf_qtcb_bottom_port
*stats_reset_data
;
481 unsigned long stats_reset
;
482 struct work_struct scan_work
;
483 struct service_level service_level
;
484 atomic_t qdio_outb_full
; /* queue full incidents */
488 struct device sysfs_device
; /* sysfs device */
489 struct fc_rport
*rport
; /* rport of fc transport class */
490 struct list_head list
; /* list of remote ports */
491 atomic_t refcount
; /* reference count */
492 wait_queue_head_t remove_wq
; /* can be used to wait for
493 refcount drop to zero */
494 struct zfcp_adapter
*adapter
; /* adapter used to access port */
495 struct list_head unit_list_head
; /* head of logical unit list */
496 atomic_t status
; /* status of this remote port */
497 u64 wwnn
; /* WWNN if known */
500 u32 handle
; /* handle assigned by FSF */
501 struct zfcp_erp_action erp_action
; /* pending error recovery */
502 atomic_t erp_counter
;
504 u32 supported_classes
;
505 struct work_struct gid_pn_work
;
506 struct work_struct test_link_work
;
507 struct work_struct rport_work
;
508 enum { RPORT_NONE
, RPORT_ADD
, RPORT_DEL
} rport_task
;
512 struct device sysfs_device
; /* sysfs device */
513 struct list_head list
; /* list of logical units */
514 atomic_t refcount
; /* reference count */
515 wait_queue_head_t remove_wq
; /* can be used to wait for
516 refcount drop to zero */
517 struct zfcp_port
*port
; /* remote port of unit */
518 atomic_t status
; /* status of this logical unit */
519 u64 fcp_lun
; /* own FCP_LUN */
520 u32 handle
; /* handle assigned by FSF */
521 struct scsi_device
*device
; /* scsi device struct pointer */
522 struct zfcp_erp_action erp_action
; /* pending error recovery */
523 atomic_t erp_counter
;
524 struct zfcp_latencies latencies
;
525 struct work_struct scsi_work
;
529 struct zfcp_fsf_req
{
530 struct list_head list
; /* list of FSF requests */
531 unsigned long req_id
; /* unique request ID */
532 struct zfcp_adapter
*adapter
; /* adapter request belongs to */
533 u8 sbal_number
; /* nr of SBALs free for use */
534 u8 sbal_first
; /* first SBAL for this request */
535 u8 sbal_last
; /* last SBAL for this request */
536 u8 sbal_limit
; /* last possible SBAL for
538 u8 sbale_curr
; /* current SBALE during creation
540 u8 sbal_response
; /* SBAL used in interrupt */
541 wait_queue_head_t completion_wq
; /* can be used by a routine
542 to wait for completion */
543 u32 status
; /* status of this request */
544 u32 fsf_command
; /* FSF Command copy */
545 struct fsf_qtcb
*qtcb
; /* address of associated QTCB */
546 u32 seq_no
; /* Sequence number of request */
547 void *data
; /* private data of request */
548 struct timer_list timer
; /* used for erp or scsi er */
549 struct zfcp_erp_action
*erp_action
; /* used if this request is
550 issued on behalf of erp */
551 mempool_t
*pool
; /* used if request was alloacted
552 from emergency pool */
553 unsigned long long issued
; /* request sent time (STCK) */
554 struct zfcp_unit
*unit
;
555 void (*handler
)(struct zfcp_fsf_req
*);
556 u16 qdio_outb_usage
;/* usage of outbound queue */
557 u16 qdio_inb_usage
; /* usage of inbound queue */
562 struct scsi_host_template scsi_host_template
;
563 struct scsi_transport_template
*scsi_transport_template
;
564 rwlock_t config_lock
; /* serialises changes
567 struct semaphore config_sema
; /* serialises configuration
569 struct kmem_cache
*fsf_req_qtcb_cache
;
570 struct kmem_cache
*sr_buffer_cache
;
571 struct kmem_cache
*gid_pn_cache
;
572 struct workqueue_struct
*work_queue
;
575 /* struct used by memory pools for fsf_requests */
576 struct zfcp_fsf_req_qtcb
{
577 struct zfcp_fsf_req fsf_req
;
578 struct fsf_qtcb qtcb
;
581 /********************** ZFCP SPECIFIC DEFINES ********************************/
583 #define ZFCP_SET 0x00000100
584 #define ZFCP_CLEAR 0x00000200
587 * Helper functions for request ID management.
589 static inline int zfcp_reqlist_hash(unsigned long req_id
)
591 return req_id
% REQUEST_LIST_SIZE
;
594 static inline void zfcp_reqlist_remove(struct zfcp_adapter
*adapter
,
595 struct zfcp_fsf_req
*fsf_req
)
597 list_del(&fsf_req
->list
);
600 static inline struct zfcp_fsf_req
*
601 zfcp_reqlist_find(struct zfcp_adapter
*adapter
, unsigned long req_id
)
603 struct zfcp_fsf_req
*request
;
606 idx
= zfcp_reqlist_hash(req_id
);
607 list_for_each_entry(request
, &adapter
->req_list
[idx
], list
)
608 if (request
->req_id
== req_id
)
613 static inline struct zfcp_fsf_req
*
614 zfcp_reqlist_find_safe(struct zfcp_adapter
*adapter
, struct zfcp_fsf_req
*req
)
616 struct zfcp_fsf_req
*request
;
619 for (idx
= 0; idx
< REQUEST_LIST_SIZE
; idx
++) {
620 list_for_each_entry(request
, &adapter
->req_list
[idx
], list
)
628 * functions needed for reference/usage counting
632 zfcp_unit_get(struct zfcp_unit
*unit
)
634 atomic_inc(&unit
->refcount
);
638 zfcp_unit_put(struct zfcp_unit
*unit
)
640 if (atomic_dec_return(&unit
->refcount
) == 0)
641 wake_up(&unit
->remove_wq
);
645 zfcp_port_get(struct zfcp_port
*port
)
647 atomic_inc(&port
->refcount
);
651 zfcp_port_put(struct zfcp_port
*port
)
653 if (atomic_dec_return(&port
->refcount
) == 0)
654 wake_up(&port
->remove_wq
);
658 zfcp_adapter_get(struct zfcp_adapter
*adapter
)
660 atomic_inc(&adapter
->refcount
);
664 zfcp_adapter_put(struct zfcp_adapter
*adapter
)
666 if (atomic_dec_return(&adapter
->refcount
) == 0)
667 wake_up(&adapter
->remove_wq
);
670 #endif /* ZFCP_DEF_H */