2 * ibmvfc.h -- driver for IBM Power Virtual Fibre Channel Adapter
4 * Written By: Brian King <brking@linux.vnet.ibm.com>, IBM Corporation
6 * Copyright (C) IBM Corporation, 2008
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/list.h>
28 #include <linux/types.h>
31 #define IBMVFC_NAME "ibmvfc"
32 #define IBMVFC_DRIVER_VERSION "1.0.0"
33 #define IBMVFC_DRIVER_DATE "(July 1, 2008)"
35 #define IBMVFC_DEFAULT_TIMEOUT 15
36 #define IBMVFC_INIT_TIMEOUT 30
37 #define IBMVFC_MAX_REQUESTS_DEFAULT 100
39 #define IBMVFC_DEBUG 0
40 #define IBMVFC_MAX_TARGETS 1024
41 #define IBMVFC_MAX_LUN 0xffffffff
42 #define IBMVFC_MAX_SECTORS 0xffffu
43 #define IBMVFC_MAX_DISC_THREADS 4
44 #define IBMVFC_TGT_MEMPOOL_SZ 64
45 #define IBMVFC_MAX_CMDS_PER_LUN 64
46 #define IBMVFC_MAX_INIT_RETRIES 3
47 #define IBMVFC_DEV_LOSS_TMO (5 * 60)
48 #define IBMVFC_DEFAULT_LOG_LEVEL 2
49 #define IBMVFC_MAX_CDB_LEN 16
52 * Ensure we have resources for ERP and initialization:
54 * 1 for initialization
55 * 1 for each discovery thread
57 #define IBMVFC_NUM_INTERNAL_REQ (1 + 1 + disc_threads)
59 #define IBMVFC_MAD_SUCCESS 0x00
60 #define IBMVFC_MAD_NOT_SUPPORTED 0xF1
61 #define IBMVFC_MAD_FAILED 0xF7
62 #define IBMVFC_MAD_DRIVER_FAILED 0xEE
63 #define IBMVFC_MAD_CRQ_ERROR 0xEF
65 enum ibmvfc_crq_valid {
66 IBMVFC_CRQ_CMD_RSP = 0x80,
67 IBMVFC_CRQ_INIT_RSP = 0xC0,
68 IBMVFC_CRQ_XPORT_EVENT = 0xFF,
71 enum ibmvfc_crq_format {
72 IBMVFC_CRQ_INIT = 0x01,
73 IBMVFC_CRQ_INIT_COMPLETE = 0x02,
74 IBMVFC_PARTITION_MIGRATED = 0x06,
77 enum ibmvfc_cmd_status_flags {
78 IBMVFC_FABRIC_MAPPED = 0x0001,
79 IBMVFC_VIOS_FAILURE = 0x0002,
80 IBMVFC_FC_FAILURE = 0x0004,
81 IBMVFC_FC_SCSI_ERROR = 0x0008,
82 IBMVFC_HW_EVENT_LOGGED = 0x0010,
83 IBMVFC_VIOS_LOGGED = 0x0020,
86 enum ibmvfc_fabric_mapped_errors {
87 IBMVFC_UNABLE_TO_ESTABLISH = 0x0001,
88 IBMVFC_XPORT_FAULT = 0x0002,
89 IBMVFC_CMD_TIMEOUT = 0x0003,
90 IBMVFC_ENETDOWN = 0x0004,
91 IBMVFC_HW_FAILURE = 0x0005,
92 IBMVFC_LINK_DOWN_ERR = 0x0006,
93 IBMVFC_LINK_DEAD_ERR = 0x0007,
94 IBMVFC_UNABLE_TO_REGISTER = 0x0008,
95 IBMVFC_XPORT_BUSY = 0x000A,
96 IBMVFC_XPORT_DEAD = 0x000B,
97 IBMVFC_CONFIG_ERROR = 0x000C,
98 IBMVFC_NAME_SERVER_FAIL = 0x000D,
99 IBMVFC_LINK_HALTED = 0x000E,
100 IBMVFC_XPORT_GENERAL = 0x8000,
103 enum ibmvfc_vios_errors {
104 IBMVFC_CRQ_FAILURE = 0x0001,
105 IBMVFC_SW_FAILURE = 0x0002,
106 IBMVFC_INVALID_PARAMETER = 0x0003,
107 IBMVFC_MISSING_PARAMETER = 0x0004,
108 IBMVFC_HOST_IO_BUS = 0x0005,
109 IBMVFC_TRANS_CANCELLED = 0x0006,
110 IBMVFC_TRANS_CANCELLED_IMPLICIT = 0x0007,
111 IBMVFC_INSUFFICIENT_RESOURCE = 0x0008,
112 IBMVFC_COMMAND_FAILED = 0x8000,
115 enum ibmvfc_mad_types {
116 IBMVFC_NPIV_LOGIN = 0x0001,
117 IBMVFC_DISC_TARGETS = 0x0002,
118 IBMVFC_PORT_LOGIN = 0x0004,
119 IBMVFC_PROCESS_LOGIN = 0x0008,
120 IBMVFC_QUERY_TARGET = 0x0010,
121 IBMVFC_IMPLICIT_LOGOUT = 0x0040,
122 IBMVFC_TMF_MAD = 0x0100,
125 struct ibmvfc_mad_common {
132 }__attribute__((packed, aligned (8)));
134 struct ibmvfc_npiv_login_mad {
135 struct ibmvfc_mad_common common;
136 struct srp_direct_buf buffer;
137 }__attribute__((packed, aligned (8)));
139 #define IBMVFC_MAX_NAME 256
141 struct ibmvfc_npiv_login {
143 #define IBMVFC_OS_LINUX 0x02
149 u32 vfc_frame_version;
152 #define IBMVFC_CLIENT_MIGRATED 0x01
153 #define IBMVFC_FLUSH_ON_HALT 0x02
156 #define IBMVFC_CAN_MIGRATE 0x01
158 struct srp_direct_buf async;
159 u8 partition_name[IBMVFC_MAX_NAME];
160 u8 device_name[IBMVFC_MAX_NAME];
161 u8 drc_name[IBMVFC_MAX_NAME];
163 }__attribute__((packed, aligned (8)));
165 struct ibmvfc_common_svc_parms {
169 u16 bb_rcv_sz; /* upper nibble is BB_SC_N */
172 }__attribute__((packed, aligned (4)));
174 struct ibmvfc_service_parms {
175 struct ibmvfc_common_svc_parms common;
182 u32 vendor_version[4];
183 u32 services_avail[2];
187 }__attribute__((packed, aligned (4)));
189 struct ibmvfc_npiv_login_resp {
194 #define IBMVFC_NATIVE_FC 0x01
195 #define IBMVFC_CAN_FLUSH_ON_HALT 0x08
205 u8 partition_name[IBMVFC_MAX_NAME];
206 u8 device_name[IBMVFC_MAX_NAME];
207 u8 port_loc_code[IBMVFC_MAX_NAME];
208 u8 drc_name[IBMVFC_MAX_NAME];
209 struct ibmvfc_service_parms service_parms;
211 }__attribute__((packed, aligned (8)));
213 union ibmvfc_npiv_login_data {
214 struct ibmvfc_npiv_login login;
215 struct ibmvfc_npiv_login_resp resp;
216 }__attribute__((packed, aligned (8)));
218 struct ibmvfc_discover_targets_buf {
220 #define IBMVFC_DISC_TGT_SCSI_ID_MASK 0x00ffffff
223 struct ibmvfc_discover_targets {
224 struct ibmvfc_mad_common common;
225 struct srp_direct_buf buffer;
233 }__attribute__((packed, aligned (8)));
235 enum ibmvfc_fc_reason {
236 IBMVFC_INVALID_ELS_CMD_CODE = 0x01,
237 IBMVFC_INVALID_VERSION = 0x02,
238 IBMVFC_LOGICAL_ERROR = 0x03,
239 IBMVFC_INVALID_CT_IU_SIZE = 0x04,
240 IBMVFC_LOGICAL_BUSY = 0x05,
241 IBMVFC_PROTOCOL_ERROR = 0x07,
242 IBMVFC_UNABLE_TO_PERFORM_REQ = 0x09,
243 IBMVFC_CMD_NOT_SUPPORTED = 0x0B,
244 IBMVFC_SERVER_NOT_AVAIL = 0x0D,
245 IBMVFC_CMD_IN_PROGRESS = 0x0E,
246 IBMVFC_VENDOR_SPECIFIC = 0xFF,
249 enum ibmvfc_fc_type {
250 IBMVFC_FABRIC_REJECT = 0x01,
251 IBMVFC_PORT_REJECT = 0x02,
252 IBMVFC_LS_REJECT = 0x03,
253 IBMVFC_FABRIC_BUSY = 0x04,
254 IBMVFC_PORT_BUSY = 0x05,
255 IBMVFC_BASIC_REJECT = 0x06,
258 enum ibmvfc_gs_explain {
259 IBMVFC_PORT_NAME_NOT_REG = 0x02,
262 struct ibmvfc_port_login {
263 struct ibmvfc_mad_common common;
266 u16 fc_service_class;
270 u16 error; /* also fc_reason */
274 struct ibmvfc_service_parms service_parms;
275 struct ibmvfc_service_parms service_parms_change;
277 }__attribute__((packed, aligned (8)));
279 struct ibmvfc_prli_svc_parms {
281 #define IBMVFC_SCSI_FCP_TYPE 0x08
284 #define IBMVFC_PRLI_ORIG_PA_VALID 0x8000
285 #define IBMVFC_PRLI_RESP_PA_VALID 0x4000
286 #define IBMVFC_PRLI_EST_IMG_PAIR 0x2000
290 #define IBMVFC_PRLI_TASK_RETRY 0x00000200
291 #define IBMVFC_PRLI_RETRY 0x00000100
292 #define IBMVFC_PRLI_DATA_OVERLAY 0x00000040
293 #define IBMVFC_PRLI_INITIATOR_FUNC 0x00000020
294 #define IBMVFC_PRLI_TARGET_FUNC 0x00000010
295 #define IBMVFC_PRLI_READ_FCP_XFER_RDY_DISABLED 0x00000002
296 #define IBMVFC_PRLI_WR_FCP_XFER_RDY_DISABLED 0x00000001
297 }__attribute__((packed, aligned (4)));
299 struct ibmvfc_process_login {
300 struct ibmvfc_mad_common common;
302 struct ibmvfc_prli_svc_parms parms;
305 u16 error; /* also fc_reason */
308 }__attribute__((packed, aligned (8)));
310 struct ibmvfc_query_tgt {
311 struct ibmvfc_mad_common common;
319 }__attribute__((packed, aligned (8)));
321 struct ibmvfc_implicit_logout {
322 struct ibmvfc_mad_common common;
325 }__attribute__((packed, aligned (8)));
328 struct ibmvfc_mad_common common;
332 #define IBMVFC_TMF_ABORT_TASK 0x02
333 #define IBMVFC_TMF_ABORT_TASK_SET 0x04
334 #define IBMVFC_TMF_LUN_RESET 0x10
335 #define IBMVFC_TMF_TGT_RESET 0x20
336 #define IBMVFC_TMF_LUA_VALID 0x40
339 #define IBMVFC_TMF_CANCEL_KEY 0x80000000
342 }__attribute__((packed, aligned (8)));
344 enum ibmvfc_fcp_rsp_info_codes {
345 RSP_NO_FAILURE = 0x00,
346 RSP_TMF_REJECTED = 0x04,
347 RSP_TMF_FAILED = 0x05,
348 RSP_TMF_INVALID_LUN = 0x09,
351 struct ibmvfc_fcp_rsp_info {
355 }__attribute__((packed, aligned (2)));
357 enum ibmvfc_fcp_rsp_flags {
359 FCP_BIDI_READ_RESID_UNDER = 0x40,
360 FCP_BIDI_READ_RESID_OVER = 0x20,
362 FCP_RESID_UNDER = 0x08,
363 FCP_RESID_OVER = 0x04,
364 FCP_SNS_LEN_VALID = 0x02,
365 FCP_RSP_LEN_VALID = 0x01,
368 union ibmvfc_fcp_rsp_data {
369 struct ibmvfc_fcp_rsp_info info;
370 u8 sense[SCSI_SENSE_BUFFERSIZE + sizeof(struct ibmvfc_fcp_rsp_info)];
371 }__attribute__((packed, aligned (8)));
373 struct ibmvfc_fcp_rsp {
375 u16 retry_delay_timer;
381 union ibmvfc_fcp_rsp_data data;
382 }__attribute__((packed, aligned (8)));
384 enum ibmvfc_cmd_flags {
385 IBMVFC_SCATTERLIST = 0x0001,
386 IBMVFC_NO_MEM_DESC = 0x0002,
387 IBMVFC_READ = 0x0004,
388 IBMVFC_WRITE = 0x0008,
390 IBMVFC_CLASS_3_ERR = 0x0100,
393 enum ibmvfc_fc_task_attr {
394 IBMVFC_SIMPLE_TASK = 0x00,
395 IBMVFC_HEAD_OF_QUEUE = 0x01,
396 IBMVFC_ORDERED_TASK = 0x02,
397 IBMVFC_ACA_TASK = 0x04,
400 enum ibmvfc_fc_tmf_flags {
401 IBMVFC_ABORT_TASK_SET = 0x02,
402 IBMVFC_LUN_RESET = 0x10,
403 IBMVFC_TARGET_RESET = 0x20,
406 struct ibmvfc_fcp_cmd_iu {
412 #define IBMVFC_RDDATA 0x02
413 #define IBMVFC_WRDATA 0x01
414 u8 cdb[IBMVFC_MAX_CDB_LEN];
416 }__attribute__((packed, aligned (4)));
428 #define IBMVFC_ADAPTER_RESID_VALID 0x01
431 struct srp_direct_buf ext_func;
432 struct srp_direct_buf ioba;
433 struct srp_direct_buf resp;
438 struct ibmvfc_fcp_cmd_iu iu;
439 struct ibmvfc_fcp_rsp rsp;
440 }__attribute__((packed, aligned (8)));
442 struct ibmvfc_trace_start_entry {
444 }__attribute__((packed));
446 struct ibmvfc_trace_end_entry {
453 }__attribute__((packed));
455 struct ibmvfc_trace_entry {
456 struct ibmvfc_event *evt;
464 #define IBMVFC_TRC_START 0x00
465 #define IBMVFC_TRC_END 0xff
467 struct ibmvfc_trace_start_entry start;
468 struct ibmvfc_trace_end_entry end;
470 }__attribute__((packed, aligned (8)));
472 enum ibmvfc_crq_formats {
473 IBMVFC_CMD_FORMAT = 0x01,
474 IBMVFC_ASYNC_EVENT = 0x02,
475 IBMVFC_MAD_FORMAT = 0x04,
478 enum ibmvfc_async_event {
479 IBMVFC_AE_ELS_PLOGI = 0x0001,
480 IBMVFC_AE_ELS_LOGO = 0x0002,
481 IBMVFC_AE_ELS_PRLO = 0x0004,
482 IBMVFC_AE_SCN_NPORT = 0x0008,
483 IBMVFC_AE_SCN_GROUP = 0x0010,
484 IBMVFC_AE_SCN_DOMAIN = 0x0020,
485 IBMVFC_AE_SCN_FABRIC = 0x0040,
486 IBMVFC_AE_LINK_UP = 0x0080,
487 IBMVFC_AE_LINK_DOWN = 0x0100,
488 IBMVFC_AE_LINK_DEAD = 0x0200,
489 IBMVFC_AE_HALT = 0x0400,
490 IBMVFC_AE_RESUME = 0x0800,
491 IBMVFC_AE_ADAPTER_FAILED = 0x1000,
499 }__attribute__((packed, aligned (8)));
501 struct ibmvfc_crq_queue {
502 struct ibmvfc_crq *msgs;
504 dma_addr_t msg_token;
507 struct ibmvfc_async_crq {
516 }__attribute__((packed, aligned (8)));
518 struct ibmvfc_async_crq_queue {
519 struct ibmvfc_async_crq *msgs;
521 dma_addr_t msg_token;
525 struct ibmvfc_mad_common mad_common;
526 struct ibmvfc_npiv_login_mad npiv_login;
527 struct ibmvfc_discover_targets discover_targets;
528 struct ibmvfc_port_login plogi;
529 struct ibmvfc_process_login prli;
530 struct ibmvfc_query_tgt query_tgt;
531 struct ibmvfc_implicit_logout implicit_logout;
532 struct ibmvfc_tmf tmf;
533 struct ibmvfc_cmd cmd;
534 }__attribute__((packed, aligned (8)));
536 enum ibmvfc_target_action {
537 IBMVFC_TGT_ACTION_NONE = 0,
538 IBMVFC_TGT_ACTION_INIT,
539 IBMVFC_TGT_ACTION_INIT_WAIT,
540 IBMVFC_TGT_ACTION_ADD_RPORT,
541 IBMVFC_TGT_ACTION_DEL_RPORT,
544 struct ibmvfc_target {
545 struct list_head queue;
546 struct ibmvfc_host *vhost;
549 struct fc_rport *rport;
551 enum ibmvfc_target_action action;
554 struct ibmvfc_service_parms service_parms;
555 struct ibmvfc_service_parms service_parms_change;
556 struct fc_rport_identifiers ids;
557 void (*job_step) (struct ibmvfc_target *);
561 /* a unit of work for the hosting partition */
562 struct ibmvfc_event {
563 struct list_head queue;
564 struct ibmvfc_host *vhost;
565 struct ibmvfc_target *tgt;
566 struct scsi_cmnd *cmnd;
568 union ibmvfc_iu *xfer_iu;
569 void (*done) (struct ibmvfc_event *);
570 struct ibmvfc_crq crq;
572 union ibmvfc_iu *sync_iu;
573 struct srp_direct_buf *ext_list;
574 dma_addr_t ext_list_token;
575 struct completion comp;
576 struct timer_list timer;
579 /* a pool of event structs for use */
580 struct ibmvfc_event_pool {
581 struct ibmvfc_event *events;
583 union ibmvfc_iu *iu_storage;
587 enum ibmvfc_host_action {
588 IBMVFC_HOST_ACTION_NONE = 0,
589 IBMVFC_HOST_ACTION_INIT,
590 IBMVFC_HOST_ACTION_INIT_WAIT,
591 IBMVFC_HOST_ACTION_QUERY,
592 IBMVFC_HOST_ACTION_QUERY_TGTS,
593 IBMVFC_HOST_ACTION_TGT_DEL,
594 IBMVFC_HOST_ACTION_ALLOC_TGTS,
595 IBMVFC_HOST_ACTION_TGT_INIT,
596 IBMVFC_HOST_ACTION_TGT_ADD,
599 enum ibmvfc_host_state {
611 struct list_head queue;
612 struct Scsi_Host *host;
613 enum ibmvfc_host_state state;
614 enum ibmvfc_host_action action;
615 #define IBMVFC_NUM_TRACE_INDEX_BITS 8
616 #define IBMVFC_NUM_TRACE_ENTRIES (1 << IBMVFC_NUM_TRACE_INDEX_BITS)
617 #define IBMVFC_TRACE_SIZE (sizeof(struct ibmvfc_trace_entry) * IBMVFC_NUM_TRACE_ENTRIES)
618 struct ibmvfc_trace_entry *trace;
619 u32 trace_index:IBMVFC_NUM_TRACE_INDEX_BITS;
621 struct list_head targets;
622 struct list_head sent;
623 struct list_head free;
625 struct ibmvfc_event_pool pool;
626 struct dma_pool *sg_pool;
628 struct ibmvfc_crq_queue crq;
629 struct ibmvfc_async_crq_queue async_crq;
630 struct ibmvfc_npiv_login login_info;
631 union ibmvfc_npiv_login_data *login_buf;
632 dma_addr_t login_buf_dma;
635 struct ibmvfc_discover_targets_buf *disc_buf;
638 int discovery_threads;
642 #define IBMVFC_AE_LINKUP 0x0001
643 #define IBMVFC_AE_LINKDOWN 0x0002
644 #define IBMVFC_AE_RSCN 0x0004
645 dma_addr_t disc_buf_dma;
646 unsigned int partition_number;
647 char partition_name[97];
648 void (*job_step) (struct ibmvfc_host *);
649 struct task_struct *work_thread;
650 wait_queue_head_t init_wait_q;
651 wait_queue_head_t work_wait_q;
654 #define DBG_CMD(CMD) do { if (ibmvfc_debug) CMD; } while (0)
656 #define tgt_dbg(t, fmt, ...) \
657 DBG_CMD(dev_info((t)->vhost->dev, "%lX: " fmt, (t)->scsi_id, ##__VA_ARGS__))
659 #define tgt_err(t, fmt, ...) \
660 dev_err((t)->vhost->dev, "%lX: " fmt, (t)->scsi_id, ##__VA_ARGS__)
662 #define ibmvfc_dbg(vhost, ...) \
663 DBG_CMD(dev_info((vhost)->dev, ##__VA_ARGS__))
665 #define ibmvfc_log(vhost, level, ...) \
667 if (level >= (vhost)->log_level) \
668 dev_err((vhost)->dev, ##__VA_ARGS__); \
671 #define ENTER DBG_CMD(printk(KERN_INFO IBMVFC_NAME": Entering %s\n", __FUNCTION__))
672 #define LEAVE DBG_CMD(printk(KERN_INFO IBMVFC_NAME": Leaving %s\n", __FUNCTION__))
674 #ifdef CONFIG_SCSI_IBMVFC_TRACE
675 #define ibmvfc_create_trace_file(kobj, attr) sysfs_create_bin_file(kobj, attr)
676 #define ibmvfc_remove_trace_file(kobj, attr) sysfs_remove_bin_file(kobj, attr)
678 #define ibmvfc_create_trace_file(kobj, attr) 0
679 #define ibmvfc_remove_trace_file(kobj, attr) do { } while (0)