drivers/s390/scsi/zfcp_def.h

   1 /*
   2  * zfcp device driver
   3  *
   4  * Global definitions for the zfcp device driver.
   5  *
   6  * Copyright IBM Corporation 2002, 2009
   7  */
   8
   9 #ifndef ZFCP_DEF_H
  10 #define ZFCP_DEF_H
  11
  12 /*************************** INCLUDES *****************************************/
  13
  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/fc/fc_fs.h>
  26 #include <scsi/fc/fc_gs.h>
  27 #include <scsi/scsi.h>
  28 #include <scsi/scsi_tcq.h>
  29 #include <scsi/scsi_cmnd.h>
  30 #include <scsi/scsi_device.h>
  31 #include <scsi/scsi_host.h>
  32 #include <scsi/scsi_transport.h>
  33 #include <scsi/scsi_transport_fc.h>
  34 #include <scsi/scsi_bsg_fc.h>
  35 #include <asm/ccwdev.h>
  36 #include <asm/qdio.h>
  37 #include <asm/debug.h>
  38 #include <asm/ebcdic.h>
  39 #include <asm/sysinfo.h>
  40 #include "zfcp_fsf.h"
  41
  42 /********************* GENERAL DEFINES *********************************/
  43
  44 #define REQUEST_LIST_SIZE 128
  45
  46 /********************* SCSI SPECIFIC DEFINES *********************************/
  47 #define ZFCP_SCSI_ER_TIMEOUT                    (10*HZ)
  48
  49 /********************* CIO/QDIO SPECIFIC DEFINES *****************************/
  50
  51 /* DMQ bug workaround: don't use last SBALE */
  52 #define ZFCP_MAX_SBALES_PER_SBAL        (QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
  53
  54 /* index of last SBALE (with respect to DMQ bug workaround) */
  55 #define ZFCP_LAST_SBALE_PER_SBAL        (ZFCP_MAX_SBALES_PER_SBAL - 1)
  56
  57 /* max. number of (data buffer) SBALEs in largest SBAL chain */
  58 #define ZFCP_MAX_SBALES_PER_REQ         \
  59         (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
  60         /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
  61
  62 #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
  63         /* max. number of (data buffer) SBALEs in largest SBAL chain
  64            multiplied with number of sectors per 4k block */
  65
  66 /********************* FSF SPECIFIC DEFINES *********************************/
  67
  68 /* ATTENTION: value must not be used by hardware */
  69 #define FSF_QTCB_UNSOLICITED_STATUS             0x6305
  70
  71 /* timeout value for "default timer" for fsf requests */
  72 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
  73
  74 /*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
  75
  76 #define ZFCP_DID_MASK           0x00FFFFFF
  77
  78 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
  79
  80 /*
  81  * Note, the leftmost status byte is common among adapter, port
  82  * and unit
  83  */
  84 #define ZFCP_COMMON_FLAGS                       0xfff00000
  85
  86 /* common status bits */
  87 #define ZFCP_STATUS_COMMON_RUNNING              0x40000000
  88 #define ZFCP_STATUS_COMMON_ERP_FAILED           0x20000000
  89 #define ZFCP_STATUS_COMMON_UNBLOCKED            0x10000000
  90 #define ZFCP_STATUS_COMMON_OPEN                 0x04000000
  91 #define ZFCP_STATUS_COMMON_ERP_INUSE            0x01000000
  92 #define ZFCP_STATUS_COMMON_ACCESS_DENIED        0x00800000
  93 #define ZFCP_STATUS_COMMON_ACCESS_BOXED         0x00400000
  94 #define ZFCP_STATUS_COMMON_NOESC                0x00200000
  95
  96 /* adapter status */
  97 #define ZFCP_STATUS_ADAPTER_QDIOUP              0x00000002
  98 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK          0x00000008
  99 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT       0x00000010
 100 #define ZFCP_STATUS_ADAPTER_ERP_PENDING         0x00000100
 101 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED      0x00000200
 102
 103 /* remote port status */
 104 #define ZFCP_STATUS_PORT_PHYS_OPEN              0x00000001
 105 #define ZFCP_STATUS_PORT_LINK_TEST              0x00000002
 106
 107 /* logical unit status */
 108 #define ZFCP_STATUS_UNIT_SHARED                 0x00000004
 109 #define ZFCP_STATUS_UNIT_READONLY               0x00000008
 110
 111 /* FSF request status (this does not have a common part) */
 112 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT      0x00000002
 113 #define ZFCP_STATUS_FSFREQ_ERROR                0x00000008
 114 #define ZFCP_STATUS_FSFREQ_CLEANUP              0x00000010
 115 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED       0x00000040
 116 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED       0x00000080
 117 #define ZFCP_STATUS_FSFREQ_ABORTED              0x00000100
 118 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED         0x00000200
 119 #define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP        0x00000400
 120 #define ZFCP_STATUS_FSFREQ_RETRY                0x00000800
 121 #define ZFCP_STATUS_FSFREQ_DISMISSED            0x00001000
 122
 123 /************************* STRUCTURE DEFINITIONS *****************************/
 124
 125 struct zfcp_fsf_req;
 126
 127 /* holds various memory pools of an adapter */
 128 struct zfcp_adapter_mempool {
 129         mempool_t *erp_req;
 130         mempool_t *gid_pn_req;
 131         mempool_t *scsi_req;
 132         mempool_t *scsi_abort;
 133         mempool_t *status_read_req;
 134         mempool_t *status_read_data;
 135         mempool_t *gid_pn;
 136         mempool_t *qtcb_pool;
 137 };
 138
 139 /**
 140  * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
 141  * @wka_port: port where the request is sent to
 142  * @req: scatter-gather list for request
 143  * @resp: scatter-gather list for response
 144  * @handler: handler function (called for response to the request)
 145  * @handler_data: data passed to handler function
 146  * @completion: completion for synchronization purposes
 147  * @status: used to pass error status to calling function
 148  */
 149 struct zfcp_send_ct {
 150         struct zfcp_fc_wka_port *wka_port;
 151         struct scatterlist *req;
 152         struct scatterlist *resp;
 153         void (*handler)(unsigned long);
 154         unsigned long handler_data;
 155         struct completion *completion;
 156         int status;
 157 };
 158
 159 /**
 160  * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
 161  * @adapter: adapter where request is sent from
 162  * @port: port where ELS is destinated (port reference count has to be increased)
 163  * @d_id: destiniation id of port where request is sent to
 164  * @req: scatter-gather list for request
 165  * @resp: scatter-gather list for response
 166  * @handler: handler function (called for response to the request)
 167  * @handler_data: data passed to handler function
 168  * @completion: completion for synchronization purposes
 169  * @ls_code: hex code of ELS command
 170  * @status: used to pass error status to calling function
 171  */
 172 struct zfcp_send_els {
 173         struct zfcp_adapter *adapter;
 174         struct zfcp_port *port;
 175         u32 d_id;
 176         struct scatterlist *req;
 177         struct scatterlist *resp;
 178         void (*handler)(unsigned long);
 179         unsigned long handler_data;
 180         struct completion *completion;
 181         int ls_code;
 182         int status;
 183 };
 184
 185 struct zfcp_qdio_queue {
 186         struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
 187         u8                 first;       /* index of next free bfr in queue */
 188         atomic_t           count;       /* number of free buffers in queue */
 189 };
 190
 191 struct zfcp_erp_action {
 192         struct list_head list;
 193         int action;                   /* requested action code */
 194         struct zfcp_adapter *adapter; /* device which should be recovered */
 195         struct zfcp_port *port;
 196         struct zfcp_unit *unit;
 197         u32             status;       /* recovery status */
 198         u32 step;                     /* active step of this erp action */
 199         struct zfcp_fsf_req *fsf_req; /* fsf request currently pending
 200                                          for this action */
 201         struct timer_list timer;
 202 };
 203
 204 struct fsf_latency_record {
 205         u32 min;
 206         u32 max;
 207         u64 sum;
 208 };
 209
 210 struct latency_cont {
 211         struct fsf_latency_record channel;
 212         struct fsf_latency_record fabric;
 213         u64 counter;
 214 };
 215
 216 struct zfcp_latencies {
 217         struct latency_cont read;
 218         struct latency_cont write;
 219         struct latency_cont cmd;
 220         spinlock_t lock;
 221 };
 222
 223 /** struct zfcp_qdio - basic QDIO data structure
 224  * @resp_q: response queue
 225  * @req_q: request queue
 226  * @stat_lock: lock to protect req_q_util and req_q_time
 227  * @req_q_lock; lock to serialize access to request queue
 228  * @req_q_time: time of last fill level change
 229  * @req_q_util: used for accounting
 230  * @req_q_full: queue full incidents
 231  * @req_q_wq: used to wait for SBAL availability
 232  * @adapter: adapter used in conjunction with this QDIO structure
 233  */
 234 struct zfcp_qdio {
 235         struct zfcp_qdio_queue  resp_q;
 236         struct zfcp_qdio_queue  req_q;
 237         spinlock_t              stat_lock;
 238         spinlock_t              req_q_lock;
 239         unsigned long long      req_q_time;
 240         u64                     req_q_util;
 241         atomic_t                req_q_full;
 242         wait_queue_head_t       req_q_wq;
 243         struct zfcp_adapter     *adapter;
 244 };
 245
 246 struct zfcp_adapter {
 247         struct kref             ref;
 248         u64                     peer_wwnn;         /* P2P peer WWNN */
 249         u64                     peer_wwpn;         /* P2P peer WWPN */
 250         u32                     peer_d_id;         /* P2P peer D_ID */
 251         struct ccw_device       *ccw_device;       /* S/390 ccw device */
 252         struct zfcp_qdio        *qdio;
 253         u32                     hydra_version;     /* Hydra version */
 254         u32                     fsf_lic_version;
 255         u32                     adapter_features;  /* FCP channel features */
 256         u32                     connection_features; /* host connection features */
 257         u32                     hardware_version;  /* of FCP channel */
 258         u16                     timer_ticks;       /* time int for a tick */
 259         struct Scsi_Host        *scsi_host;        /* Pointer to mid-layer */
 260         struct list_head        port_list;         /* remote port list */
 261         rwlock_t                port_list_lock;    /* port list lock */
 262         unsigned long           req_no;            /* unique FSF req number */
 263         struct list_head        *req_list;         /* list of pending reqs */
 264         spinlock_t              req_list_lock;     /* request list lock */
 265         u32                     fsf_req_seq_no;    /* FSF cmnd seq number */
 266         rwlock_t                abort_lock;        /* Protects against SCSI
 267                                                       stack abort/command
 268                                                       completion races */
 269         atomic_t                stat_miss;         /* # missing status reads*/
 270         struct work_struct      stat_work;
 271         atomic_t                status;            /* status of this adapter */
 272         struct list_head        erp_ready_head;    /* error recovery for this
 273                                                       adapter/devices */
 274         wait_queue_head_t       erp_ready_wq;
 275         struct list_head        erp_running_head;
 276         rwlock_t                erp_lock;
 277         wait_queue_head_t       erp_done_wqh;
 278         struct zfcp_erp_action  erp_action;        /* pending error recovery */
 279         atomic_t                erp_counter;
 280         u32                     erp_total_count;   /* total nr of enqueued erp
 281                                                       actions */
 282         u32                     erp_low_mem_count; /* nr of erp actions waiting
 283                                                       for memory */
 284         struct task_struct      *erp_thread;
 285         struct zfcp_fc_wka_ports *gs;              /* generic services */
 286         struct zfcp_dbf         *dbf;              /* debug traces */
 287         struct zfcp_adapter_mempool     pool;      /* Adapter memory pools */
 288         struct fc_host_statistics *fc_stats;
 289         struct fsf_qtcb_bottom_port *stats_reset_data;
 290         unsigned long           stats_reset;
 291         struct work_struct      scan_work;
 292         struct service_level    service_level;
 293         struct workqueue_struct *work_queue;
 294 };
 295
 296 struct zfcp_port {
 297         struct device          sysfs_device;   /* sysfs device */
 298         struct fc_rport        *rport;         /* rport of fc transport class */
 299         struct list_head       list;           /* list of remote ports */
 300         struct zfcp_adapter    *adapter;       /* adapter used to access port */
 301         struct list_head        unit_list;      /* head of logical unit list */
 302         rwlock_t                unit_list_lock; /* unit list lock */
 303         atomic_t               status;         /* status of this remote port */
 304         u64                    wwnn;           /* WWNN if known */
 305         u64                    wwpn;           /* WWPN */
 306         u32                    d_id;           /* D_ID */
 307         u32                    handle;         /* handle assigned by FSF */
 308         struct zfcp_erp_action erp_action;     /* pending error recovery */
 309         atomic_t               erp_counter;
 310         u32                    maxframe_size;
 311         u32                    supported_classes;
 312         struct work_struct     gid_pn_work;
 313         struct work_struct     test_link_work;
 314         struct work_struct     rport_work;
 315         enum { RPORT_NONE, RPORT_ADD, RPORT_DEL }  rport_task;
 316 };
 317
 318 struct zfcp_unit {
 319         struct device          sysfs_device;   /* sysfs device */
 320         struct list_head       list;           /* list of logical units */
 321         struct zfcp_port       *port;          /* remote port of unit */
 322         atomic_t               status;         /* status of this logical unit */
 323         u64                    fcp_lun;        /* own FCP_LUN */
 324         u32                    handle;         /* handle assigned by FSF */
 325         struct scsi_device     *device;        /* scsi device struct pointer */
 326         struct zfcp_erp_action erp_action;     /* pending error recovery */
 327         atomic_t               erp_counter;
 328         struct zfcp_latencies   latencies;
 329         struct work_struct      scsi_work;
 330 };
 331
 332 /**
 333  * struct zfcp_queue_req - queue related values for a request
 334  * @sbal_number: number of free SBALs
 335  * @sbal_first: first SBAL for this request
 336  * @sbal_last: last SBAL for this request
 337  * @sbal_limit: last possible SBAL for this request
 338  * @sbale_curr: current SBALE at creation of this request
 339  * @sbal_response: SBAL used in interrupt
 340  * @qdio_outb_usage: usage of outbound queue
 341  * @qdio_inb_usage: usage of inbound queue
 342  */
 343 struct zfcp_queue_req {
 344         u8                     sbal_number;
 345         u8                     sbal_first;
 346         u8                     sbal_last;
 347         u8                     sbal_limit;
 348         u8                     sbale_curr;
 349         u8                     sbal_response;
 350         u16                    qdio_outb_usage;
 351         u16                    qdio_inb_usage;
 352 };
 353
 354 /**
 355  * struct zfcp_fsf_req - basic FSF request structure
 356  * @list: list of FSF requests
 357  * @req_id: unique request ID
 358  * @adapter: adapter this request belongs to
 359  * @queue_req: queue related values
 360  * @completion: used to signal the completion of the request
 361  * @status: status of the request
 362  * @fsf_command: FSF command issued
 363  * @qtcb: associated QTCB
 364  * @seq_no: sequence number of this request
 365  * @data: private data
 366  * @timer: timer data of this request
 367  * @erp_action: reference to erp action if request issued on behalf of ERP
 368  * @pool: reference to memory pool if used for this request
 369  * @issued: time when request was send (STCK)
 370  * @unit: reference to unit if this request is a SCSI request
 371  * @handler: handler which should be called to process response
 372  */
 373 struct zfcp_fsf_req {
 374         struct list_head        list;
 375         unsigned long           req_id;
 376         struct zfcp_adapter     *adapter;
 377         struct zfcp_queue_req   queue_req;
 378         struct completion       completion;
 379         u32                     status;
 380         u32                     fsf_command;
 381         struct fsf_qtcb         *qtcb;
 382         u32                     seq_no;
 383         void                    *data;
 384         struct timer_list       timer;
 385         struct zfcp_erp_action  *erp_action;
 386         mempool_t               *pool;
 387         unsigned long long      issued;
 388         struct zfcp_unit        *unit;
 389         void                    (*handler)(struct zfcp_fsf_req *);
 390 };
 391
 392 /* driver data */
 393 struct zfcp_data {
 394         struct scsi_host_template scsi_host_template;
 395         struct scsi_transport_template *scsi_transport_template;
 396         struct kmem_cache       *gpn_ft_cache;
 397         struct kmem_cache       *qtcb_cache;
 398         struct kmem_cache       *sr_buffer_cache;
 399         struct kmem_cache       *gid_pn_cache;
 400 };
 401
 402 /********************** ZFCP SPECIFIC DEFINES ********************************/
 403
 404 #define ZFCP_SET                0x00000100
 405 #define ZFCP_CLEAR              0x00000200
 406
 407 /*
 408  * Helper functions for request ID management.
 409  */
 410 static inline int zfcp_reqlist_hash(unsigned long req_id)
 411 {
 412         return req_id % REQUEST_LIST_SIZE;
 413 }
 414
 415 static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter,
 416                                        struct zfcp_fsf_req *fsf_req)
 417 {
 418         list_del(&fsf_req->list);
 419 }
 420
 421 static inline struct zfcp_fsf_req *
 422 zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id)
 423 {
 424         struct zfcp_fsf_req *request;
 425         unsigned int idx;
 426
 427         idx = zfcp_reqlist_hash(req_id);
 428         list_for_each_entry(request, &adapter->req_list[idx], list)
 429                 if (request->req_id == req_id)
 430                         return request;
 431         return NULL;
 432 }
 433
 434 static inline struct zfcp_fsf_req *
 435 zfcp_reqlist_find_safe(struct zfcp_adapter *adapter, struct zfcp_fsf_req *req)
 436 {
 437         struct zfcp_fsf_req *request;
 438         unsigned int idx;
 439
 440         for (idx = 0; idx < REQUEST_LIST_SIZE; idx++) {
 441                 list_for_each_entry(request, &adapter->req_list[idx], list)
 442                         if (request == req)
 443                                 return request;
 444         }
 445         return NULL;
 446 }
 447
 448 #endif /* ZFCP_DEF_H */