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, 2008
   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/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>
  33 #include <asm/qdio.h>
  34 #include <asm/debug.h>
  35 #include <asm/ebcdic.h>
  36 #include "zfcp_dbf.h"
  37 #include "zfcp_fsf.h"
  38
  39
  40 /********************* GENERAL DEFINES *********************************/
  41
  42 #define REQUEST_LIST_SIZE 128
  43
  44 /********************* SCSI SPECIFIC DEFINES *********************************/
  45 #define ZFCP_SCSI_ER_TIMEOUT                    (10*HZ)
  46
  47 /********************* CIO/QDIO SPECIFIC DEFINES *****************************/
  48
  49 /* Adapter Identification Parameters */
  50 #define ZFCP_CONTROL_UNIT_TYPE  0x1731
  51 #define ZFCP_CONTROL_UNIT_MODEL 0x03
  52 #define ZFCP_DEVICE_TYPE        0x1732
  53 #define ZFCP_DEVICE_MODEL       0x03
  54 #define ZFCP_DEVICE_MODEL_PRIV  0x04
  55
  56 /* DMQ bug workaround: don't use last SBALE */
  57 #define ZFCP_MAX_SBALES_PER_SBAL        (QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
  58
  59 /* index of last SBALE (with respect to DMQ bug workaround) */
  60 #define ZFCP_LAST_SBALE_PER_SBAL        (ZFCP_MAX_SBALES_PER_SBAL - 1)
  61
  62 /* max. number of (data buffer) SBALEs in largest SBAL chain */
  63 #define ZFCP_MAX_SBALES_PER_REQ         \
  64         (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
  65         /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
  66
  67 #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
  68         /* max. number of (data buffer) SBALEs in largest SBAL chain
  69            multiplied with number of sectors per 4k block */
  70
  71 /********************* FSF SPECIFIC DEFINES *********************************/
  72
  73 /* ATTENTION: value must not be used by hardware */
  74 #define FSF_QTCB_UNSOLICITED_STATUS             0x6305
  75
  76 /* timeout value for "default timer" for fsf requests */
  77 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
  78
  79 /*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
  80
  81 typedef unsigned long long wwn_t;
  82 typedef unsigned long long fcp_lun_t;
  83 /* data length field may be at variable position in FCP-2 FCP_CMND IU */
  84 typedef unsigned int       fcp_dl_t;
  85
  86 /* timeout for name-server lookup (in seconds) */
  87 #define ZFCP_NS_GID_PN_TIMEOUT          10
  88
  89 /* task attribute values in FCP-2 FCP_CMND IU */
  90 #define SIMPLE_Q        0
  91 #define HEAD_OF_Q       1
  92 #define ORDERED_Q       2
  93 #define ACA_Q           4
  94 #define UNTAGGED        5
  95
  96 /* task management flags in FCP-2 FCP_CMND IU */
  97 #define FCP_CLEAR_ACA           0x40
  98 #define FCP_TARGET_RESET        0x20
  99 #define FCP_LOGICAL_UNIT_RESET  0x10
 100 #define FCP_CLEAR_TASK_SET      0x04
 101 #define FCP_ABORT_TASK_SET      0x02
 102
 103 #define FCP_CDB_LENGTH          16
 104
 105 #define ZFCP_DID_MASK           0x00FFFFFF
 106
 107 /* FCP(-2) FCP_CMND IU */
 108 struct fcp_cmnd_iu {
 109         fcp_lun_t fcp_lun;         /* FCP logical unit number */
 110         u8  crn;                   /* command reference number */
 111         u8  reserved0:5;           /* reserved */
 112         u8  task_attribute:3;      /* task attribute */
 113         u8  task_management_flags; /* task management flags */
 114         u8  add_fcp_cdb_length:6;  /* additional FCP_CDB length */
 115         u8  rddata:1;              /* read data */
 116         u8  wddata:1;              /* write data */
 117         u8  fcp_cdb[FCP_CDB_LENGTH];
 118 } __attribute__((packed));
 119
 120 /* FCP(-2) FCP_RSP IU */
 121 struct fcp_rsp_iu {
 122         u8  reserved0[10];
 123         union {
 124                 struct {
 125                         u8 reserved1:3;
 126                         u8 fcp_conf_req:1;
 127                         u8 fcp_resid_under:1;
 128                         u8 fcp_resid_over:1;
 129                         u8 fcp_sns_len_valid:1;
 130                         u8 fcp_rsp_len_valid:1;
 131                 } bits;
 132                 u8 value;
 133         } validity;
 134         u8  scsi_status;
 135         u32 fcp_resid;
 136         u32 fcp_sns_len;
 137         u32 fcp_rsp_len;
 138 } __attribute__((packed));
 139
 140
 141 #define RSP_CODE_GOOD            0
 142 #define RSP_CODE_LENGTH_MISMATCH 1
 143 #define RSP_CODE_FIELD_INVALID   2
 144 #define RSP_CODE_RO_MISMATCH     3
 145 #define RSP_CODE_TASKMAN_UNSUPP  4
 146 #define RSP_CODE_TASKMAN_FAILED  5
 147
 148 /* see fc-fs */
 149 #define LS_RSCN  0x61
 150 #define LS_LOGO  0x05
 151 #define LS_PLOGI 0x03
 152
 153 struct fcp_rscn_head {
 154         u8  command;
 155         u8  page_length; /* always 0x04 */
 156         u16 payload_len;
 157 } __attribute__((packed));
 158
 159 struct fcp_rscn_element {
 160         u8  reserved:2;
 161         u8  event_qual:4;
 162         u8  addr_format:2;
 163         u32 nport_did:24;
 164 } __attribute__((packed));
 165
 166 #define ZFCP_PORT_ADDRESS   0x0
 167 #define ZFCP_AREA_ADDRESS   0x1
 168 #define ZFCP_DOMAIN_ADDRESS 0x2
 169 #define ZFCP_FABRIC_ADDRESS 0x3
 170
 171 #define ZFCP_PORTS_RANGE_PORT   0xFFFFFF
 172 #define ZFCP_PORTS_RANGE_AREA   0xFFFF00
 173 #define ZFCP_PORTS_RANGE_DOMAIN 0xFF0000
 174 #define ZFCP_PORTS_RANGE_FABRIC 0x000000
 175
 176 #define ZFCP_NO_PORTS_PER_AREA    0x100
 177 #define ZFCP_NO_PORTS_PER_DOMAIN  0x10000
 178 #define ZFCP_NO_PORTS_PER_FABRIC  0x1000000
 179
 180 /* see fc-ph */
 181 struct fcp_logo {
 182         u32 command;
 183         u32 nport_did;
 184         wwn_t nport_wwpn;
 185 } __attribute__((packed));
 186
 187 /*
 188  * FC-FS stuff
 189  */
 190 #define R_A_TOV                         10 /* seconds */
 191
 192 #define ZFCP_LS_RLS                     0x0f
 193 #define ZFCP_LS_ADISC                   0x52
 194 #define ZFCP_LS_RPS                     0x56
 195 #define ZFCP_LS_RSCN                    0x61
 196 #define ZFCP_LS_RNID                    0x78
 197
 198 struct zfcp_ls_adisc {
 199         u8              code;
 200         u8              field[3];
 201         u32             hard_nport_id;
 202         u64             wwpn;
 203         u64             wwnn;
 204         u32             nport_id;
 205 } __attribute__ ((packed));
 206
 207 /*
 208  * FC-GS-2 stuff
 209  */
 210 #define ZFCP_CT_REVISION                0x01
 211 #define ZFCP_CT_DIRECTORY_SERVICE       0xFC
 212 #define ZFCP_CT_NAME_SERVER             0x02
 213 #define ZFCP_CT_SYNCHRONOUS             0x00
 214 #define ZFCP_CT_SCSI_FCP                0x08
 215 #define ZFCP_CT_UNABLE_TO_PERFORM_CMD   0x09
 216 #define ZFCP_CT_GID_PN                  0x0121
 217 #define ZFCP_CT_GPN_FT                  0x0172
 218 #define ZFCP_CT_MAX_SIZE                0x1020
 219 #define ZFCP_CT_ACCEPT                  0x8002
 220 #define ZFCP_CT_REJECT                  0x8001
 221
 222 /*
 223  * FC-GS-4 stuff
 224  */
 225 #define ZFCP_CT_TIMEOUT                 (3 * R_A_TOV)
 226
 227 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
 228
 229 /*
 230  * Note, the leftmost status byte is common among adapter, port
 231  * and unit
 232  */
 233 #define ZFCP_COMMON_FLAGS                       0xfff00000
 234
 235 /* common status bits */
 236 #define ZFCP_STATUS_COMMON_REMOVE               0x80000000
 237 #define ZFCP_STATUS_COMMON_RUNNING              0x40000000
 238 #define ZFCP_STATUS_COMMON_ERP_FAILED           0x20000000
 239 #define ZFCP_STATUS_COMMON_UNBLOCKED            0x10000000
 240 #define ZFCP_STATUS_COMMON_OPEN                 0x04000000
 241 #define ZFCP_STATUS_COMMON_ERP_INUSE            0x01000000
 242 #define ZFCP_STATUS_COMMON_ACCESS_DENIED        0x00800000
 243 #define ZFCP_STATUS_COMMON_ACCESS_BOXED         0x00400000
 244 #define ZFCP_STATUS_COMMON_NOESC                0x00200000
 245
 246 /* adapter status */
 247 #define ZFCP_STATUS_ADAPTER_QDIOUP              0x00000002
 248 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK          0x00000008
 249 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT       0x00000010
 250 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_UP       0x00000020
 251 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_KILL     0x00000080
 252 #define ZFCP_STATUS_ADAPTER_ERP_PENDING         0x00000100
 253 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED      0x00000200
 254
 255 /* FC-PH/FC-GS well-known address identifiers for generic services */
 256 #define ZFCP_DID_MANAGEMENT_SERVICE             0xFFFFFA
 257 #define ZFCP_DID_TIME_SERVICE                   0xFFFFFB
 258 #define ZFCP_DID_DIRECTORY_SERVICE              0xFFFFFC
 259 #define ZFCP_DID_ALIAS_SERVICE                  0xFFFFF8
 260 #define ZFCP_DID_KEY_DISTRIBUTION_SERVICE       0xFFFFF7
 261
 262 /* remote port status */
 263 #define ZFCP_STATUS_PORT_PHYS_OPEN              0x00000001
 264 #define ZFCP_STATUS_PORT_DID_DID                0x00000002
 265 #define ZFCP_STATUS_PORT_PHYS_CLOSING           0x00000004
 266 #define ZFCP_STATUS_PORT_NO_WWPN                0x00000008
 267 #define ZFCP_STATUS_PORT_NO_SCSI_ID             0x00000010
 268 #define ZFCP_STATUS_PORT_INVALID_WWPN           0x00000020
 269
 270 /* for ports with well known addresses */
 271 #define ZFCP_STATUS_PORT_WKA \
 272                 (ZFCP_STATUS_PORT_NO_WWPN | \
 273                  ZFCP_STATUS_PORT_NO_SCSI_ID)
 274
 275 /* logical unit status */
 276 #define ZFCP_STATUS_UNIT_SHARED                 0x00000004
 277 #define ZFCP_STATUS_UNIT_READONLY               0x00000008
 278 #define ZFCP_STATUS_UNIT_REGISTERED             0x00000010
 279 #define ZFCP_STATUS_UNIT_SCSI_WORK_PENDING      0x00000020
 280
 281 /* FSF request status (this does not have a common part) */
 282 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT      0x00000002
 283 #define ZFCP_STATUS_FSFREQ_COMPLETED            0x00000004
 284 #define ZFCP_STATUS_FSFREQ_ERROR                0x00000008
 285 #define ZFCP_STATUS_FSFREQ_CLEANUP              0x00000010
 286 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED       0x00000040
 287 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED       0x00000080
 288 #define ZFCP_STATUS_FSFREQ_ABORTED              0x00000100
 289 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED         0x00000200
 290 #define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP        0x00000400
 291 #define ZFCP_STATUS_FSFREQ_RETRY                0x00000800
 292 #define ZFCP_STATUS_FSFREQ_DISMISSED            0x00001000
 293
 294 /************************* STRUCTURE DEFINITIONS *****************************/
 295
 296 struct zfcp_fsf_req;
 297
 298 /* holds various memory pools of an adapter */
 299 struct zfcp_adapter_mempool {
 300         mempool_t *fsf_req_erp;
 301         mempool_t *fsf_req_scsi;
 302         mempool_t *fsf_req_abort;
 303         mempool_t *fsf_req_status_read;
 304         mempool_t *data_status_read;
 305         mempool_t *data_gid_pn;
 306 };
 307
 308 /*
 309  * header for CT_IU
 310  */
 311 struct ct_hdr {
 312         u8 revision;            // 0x01
 313         u8 in_id[3];            // 0x00
 314         u8 gs_type;             // 0xFC Directory Service
 315         u8 gs_subtype;          // 0x02 Name Server
 316         u8 options;             // 0x00 single bidirectional exchange
 317         u8 reserved0;
 318         u16 cmd_rsp_code;       // 0x0121 GID_PN, or 0x0100 GA_NXT
 319         u16 max_res_size;       // <= (4096 - 16) / 4
 320         u8 reserved1;
 321         u8 reason_code;
 322         u8 reason_code_expl;
 323         u8 vendor_unique;
 324 } __attribute__ ((packed));
 325
 326 /* nameserver request CT_IU -- for requests where
 327  * a port name is required */
 328 struct ct_iu_gid_pn_req {
 329         struct ct_hdr header;
 330         wwn_t wwpn;
 331 } __attribute__ ((packed));
 332
 333 /* FS_ACC IU and data unit for GID_PN nameserver request */
 334 struct ct_iu_gid_pn_resp {
 335         struct ct_hdr header;
 336         u32 d_id;
 337 } __attribute__ ((packed));
 338
 339 typedef void (*zfcp_send_ct_handler_t)(unsigned long);
 340
 341 /**
 342  * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
 343  * @port: port where the request is sent to
 344  * @req: scatter-gather list for request
 345  * @resp: scatter-gather list for response
 346  * @req_count: number of elements in request scatter-gather list
 347  * @resp_count: number of elements in response scatter-gather list
 348  * @handler: handler function (called for response to the request)
 349  * @handler_data: data passed to handler function
 350  * @timeout: FSF timeout for this request
 351  * @completion: completion for synchronization purposes
 352  * @status: used to pass error status to calling function
 353  */
 354 struct zfcp_send_ct {
 355         struct zfcp_port *port;
 356         struct scatterlist *req;
 357         struct scatterlist *resp;
 358         unsigned int req_count;
 359         unsigned int resp_count;
 360         zfcp_send_ct_handler_t handler;
 361         unsigned long handler_data;
 362         int timeout;
 363         struct completion *completion;
 364         int status;
 365 };
 366
 367 /* used for name server requests in error recovery */
 368 struct zfcp_gid_pn_data {
 369         struct zfcp_send_ct ct;
 370         struct scatterlist req;
 371         struct scatterlist resp;
 372         struct ct_iu_gid_pn_req ct_iu_req;
 373         struct ct_iu_gid_pn_resp ct_iu_resp;
 374         struct zfcp_port *port;
 375 };
 376
 377 typedef void (*zfcp_send_els_handler_t)(unsigned long);
 378
 379 /**
 380  * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
 381  * @adapter: adapter where request is sent from
 382  * @port: port where ELS is destinated (port reference count has to be increased)
 383  * @d_id: destiniation id of port where request is sent to
 384  * @req: scatter-gather list for request
 385  * @resp: scatter-gather list for response
 386  * @req_count: number of elements in request scatter-gather list
 387  * @resp_count: number of elements in response scatter-gather list
 388  * @handler: handler function (called for response to the request)
 389  * @handler_data: data passed to handler function
 390  * @completion: completion for synchronization purposes
 391  * @ls_code: hex code of ELS command
 392  * @status: used to pass error status to calling function
 393  */
 394 struct zfcp_send_els {
 395         struct zfcp_adapter *adapter;
 396         struct zfcp_port *port;
 397         u32 d_id;
 398         struct scatterlist *req;
 399         struct scatterlist *resp;
 400         unsigned int req_count;
 401         unsigned int resp_count;
 402         zfcp_send_els_handler_t handler;
 403         unsigned long handler_data;
 404         struct completion *completion;
 405         int ls_code;
 406         int status;
 407 };
 408
 409 struct zfcp_qdio_queue {
 410         struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q]; /* SBALs */
 411         u8                 first;             /* index of next free bfr
 412                                                  in queue (free_count>0) */
 413         atomic_t           count;             /* number of free buffers
 414                                                  in queue */
 415         spinlock_t         lock;              /* lock for operations on queue */
 416         int                pci_batch;         /* SBALs since PCI indication
 417                                                  was last set */
 418 };
 419
 420 struct zfcp_erp_action {
 421         struct list_head list;
 422         int action;                   /* requested action code */
 423         struct zfcp_adapter *adapter; /* device which should be recovered */
 424         struct zfcp_port *port;
 425         struct zfcp_unit *unit;
 426         u32             status;       /* recovery status */
 427         u32 step;                     /* active step of this erp action */
 428         struct zfcp_fsf_req *fsf_req; /* fsf request currently pending
 429                                          for this action */
 430         struct timer_list timer;
 431 };
 432
 433 struct fsf_latency_record {
 434         u32 min;
 435         u32 max;
 436         u64 sum;
 437 };
 438
 439 struct latency_cont {
 440         struct fsf_latency_record channel;
 441         struct fsf_latency_record fabric;
 442         u64 counter;
 443 };
 444
 445 struct zfcp_latencies {
 446         struct latency_cont read;
 447         struct latency_cont write;
 448         struct latency_cont cmd;
 449         spinlock_t lock;
 450 };
 451
 452 struct zfcp_adapter {
 453         struct list_head        list;              /* list of adapters */
 454         atomic_t                refcount;          /* reference count */
 455         wait_queue_head_t       remove_wq;         /* can be used to wait for
 456                                                       refcount drop to zero */
 457         wwn_t                   peer_wwnn;         /* P2P peer WWNN */
 458         wwn_t                   peer_wwpn;         /* P2P peer WWPN */
 459         u32                     peer_d_id;         /* P2P peer D_ID */
 460         struct ccw_device       *ccw_device;       /* S/390 ccw device */
 461         u32                     hydra_version;     /* Hydra version */
 462         u32                     fsf_lic_version;
 463         u32                     adapter_features;  /* FCP channel features */
 464         u32                     connection_features; /* host connection features */
 465         u32                     hardware_version;  /* of FCP channel */
 466         u16                     timer_ticks;       /* time int for a tick */
 467         struct Scsi_Host        *scsi_host;        /* Pointer to mid-layer */
 468         struct list_head        port_list_head;    /* remote port list */
 469         struct list_head        port_remove_lh;    /* head of ports to be
 470                                                       removed */
 471         u32                     ports;             /* number of remote ports */
 472         unsigned long           req_no;            /* unique FSF req number */
 473         struct list_head        *req_list;         /* list of pending reqs */
 474         spinlock_t              req_list_lock;     /* request list lock */
 475         struct zfcp_qdio_queue  req_q;             /* request queue */
 476         u32                     fsf_req_seq_no;    /* FSF cmnd seq number */
 477         wait_queue_head_t       request_wq;        /* can be used to wait for
 478                                                       more avaliable SBALs */
 479         struct zfcp_qdio_queue  resp_q;    /* response queue */
 480         rwlock_t                abort_lock;        /* Protects against SCSI
 481                                                       stack abort/command
 482                                                       completion races */
 483         atomic_t                stat_miss;         /* # missing status reads*/
 484         struct work_struct      stat_work;
 485         atomic_t                status;            /* status of this adapter */
 486         struct list_head        erp_ready_head;    /* error recovery for this
 487                                                       adapter/devices */
 488         struct list_head        erp_running_head;
 489         rwlock_t                erp_lock;
 490         struct semaphore        erp_ready_sem;
 491         wait_queue_head_t       erp_thread_wqh;
 492         wait_queue_head_t       erp_done_wqh;
 493         struct zfcp_erp_action  erp_action;        /* pending error recovery */
 494         atomic_t                erp_counter;
 495         u32                     erp_total_count;   /* total nr of enqueued erp
 496                                                       actions */
 497         u32                     erp_low_mem_count; /* nr of erp actions waiting
 498                                                       for memory */
 499         struct zfcp_port        *nameserver_port;  /* adapter's nameserver */
 500         debug_info_t            *rec_dbf;
 501         debug_info_t            *hba_dbf;
 502         debug_info_t            *san_dbf;          /* debug feature areas */
 503         debug_info_t            *scsi_dbf;
 504         spinlock_t              rec_dbf_lock;
 505         spinlock_t              hba_dbf_lock;
 506         spinlock_t              san_dbf_lock;
 507         spinlock_t              scsi_dbf_lock;
 508         struct zfcp_rec_dbf_record      rec_dbf_buf;
 509         struct zfcp_hba_dbf_record      hba_dbf_buf;
 510         struct zfcp_san_dbf_record      san_dbf_buf;
 511         struct zfcp_scsi_dbf_record     scsi_dbf_buf;
 512         struct zfcp_adapter_mempool     pool;      /* Adapter memory pools */
 513         struct qdio_initialize  qdio_init_data;    /* for qdio_establish */
 514         struct device           generic_services;  /* directory for WKA ports */
 515         struct fc_host_statistics *fc_stats;
 516         struct fsf_qtcb_bottom_port *stats_reset_data;
 517         unsigned long           stats_reset;
 518         struct work_struct      scan_work;
 519         atomic_t                qdio_outb_full;    /* queue full incidents */
 520 };
 521
 522 struct zfcp_port {
 523         struct device          sysfs_device;   /* sysfs device */
 524         struct fc_rport        *rport;         /* rport of fc transport class */
 525         struct list_head       list;           /* list of remote ports */
 526         atomic_t               refcount;       /* reference count */
 527         wait_queue_head_t      remove_wq;      /* can be used to wait for
 528                                                   refcount drop to zero */
 529         struct zfcp_adapter    *adapter;       /* adapter used to access port */
 530         struct list_head       unit_list_head; /* head of logical unit list */
 531         struct list_head       unit_remove_lh; /* head of luns to be removed
 532                                                   list */
 533         u32                    units;          /* # of logical units in list */
 534         atomic_t               status;         /* status of this remote port */
 535         wwn_t                  wwnn;           /* WWNN if known */
 536         wwn_t                  wwpn;           /* WWPN */
 537         u32                    d_id;           /* D_ID */
 538         u32                    handle;         /* handle assigned by FSF */
 539         struct zfcp_erp_action erp_action;     /* pending error recovery */
 540         atomic_t               erp_counter;
 541         u32                    maxframe_size;
 542         u32                    supported_classes;
 543 };
 544
 545 struct zfcp_unit {
 546         struct device          sysfs_device;   /* sysfs device */
 547         struct list_head       list;           /* list of logical units */
 548         atomic_t               refcount;       /* reference count */
 549         wait_queue_head_t      remove_wq;      /* can be used to wait for
 550                                                   refcount drop to zero */
 551         struct zfcp_port       *port;          /* remote port of unit */
 552         atomic_t               status;         /* status of this logical unit */
 553         unsigned int           scsi_lun;       /* own SCSI LUN */
 554         fcp_lun_t              fcp_lun;        /* own FCP_LUN */
 555         u32                    handle;         /* handle assigned by FSF */
 556         struct scsi_device     *device;        /* scsi device struct pointer */
 557         struct zfcp_erp_action erp_action;     /* pending error recovery */
 558         atomic_t               erp_counter;
 559         struct zfcp_latencies   latencies;
 560 };
 561
 562 /* FSF request */
 563 struct zfcp_fsf_req {
 564         struct list_head       list;           /* list of FSF requests */
 565         unsigned long          req_id;         /* unique request ID */
 566         struct zfcp_adapter    *adapter;       /* adapter request belongs to */
 567         u8                     sbal_number;    /* nr of SBALs free for use */
 568         u8                     sbal_first;     /* first SBAL for this request */
 569         u8                     sbal_last;      /* last SBAL for this request */
 570         u8                     sbal_limit;      /* last possible SBAL for
 571                                                   this reuest */
 572         u8                     sbale_curr;     /* current SBALE during creation
 573                                                   of request */
 574         u8                      sbal_response;  /* SBAL used in interrupt */
 575         wait_queue_head_t      completion_wq;  /* can be used by a routine
 576                                                   to wait for completion */
 577         u32                     status;        /* status of this request */
 578         u32                    fsf_command;    /* FSF Command copy */
 579         struct fsf_qtcb        *qtcb;          /* address of associated QTCB */
 580         u32                    seq_no;         /* Sequence number of request */
 581         void                    *data;           /* private data of request */
 582         struct timer_list     timer;           /* used for erp or scsi er */
 583         struct zfcp_erp_action *erp_action;    /* used if this request is
 584                                                   issued on behalf of erp */
 585         mempool_t              *pool;          /* used if request was alloacted
 586                                                   from emergency pool */
 587         unsigned long long     issued;         /* request sent time (STCK) */
 588         struct zfcp_unit       *unit;
 589         void                    (*handler)(struct zfcp_fsf_req *);
 590 };
 591
 592 /* driver data */
 593 struct zfcp_data {
 594         struct scsi_host_template scsi_host_template;
 595         struct scsi_transport_template *scsi_transport_template;
 596         atomic_t                status;             /* Module status flags */
 597         struct list_head        adapter_list_head;  /* head of adapter list */
 598         struct list_head        adapter_remove_lh;  /* head of adapters to be
 599                                                        removed */
 600         u32                     adapters;           /* # of adapters in list */
 601         rwlock_t                config_lock;        /* serialises changes
 602                                                        to adapter/port/unit
 603                                                        lists */
 604         struct semaphore        config_sema;        /* serialises configuration
 605                                                        changes */
 606         atomic_t                loglevel;            /* current loglevel */
 607         char                    init_busid[BUS_ID_SIZE];
 608         wwn_t                   init_wwpn;
 609         fcp_lun_t               init_fcp_lun;
 610         struct kmem_cache               *fsf_req_qtcb_cache;
 611         struct kmem_cache               *sr_buffer_cache;
 612         struct kmem_cache               *gid_pn_cache;
 613 };
 614
 615 /* struct used by memory pools for fsf_requests */
 616 struct zfcp_fsf_req_qtcb {
 617         struct zfcp_fsf_req fsf_req;
 618         struct fsf_qtcb qtcb;
 619 };
 620
 621 /********************** ZFCP SPECIFIC DEFINES ********************************/
 622
 623 #define ZFCP_REQ_AUTO_CLEANUP   0x00000002
 624 #define ZFCP_REQ_NO_QTCB        0x00000008
 625
 626 #define ZFCP_SET                0x00000100
 627 #define ZFCP_CLEAR              0x00000200
 628
 629 #define zfcp_get_busid_by_adapter(adapter) (adapter->ccw_device->dev.bus_id)
 630
 631 /*
 632  * Helper functions for request ID management.
 633  */
 634 static inline int zfcp_reqlist_hash(unsigned long req_id)
 635 {
 636         return req_id % REQUEST_LIST_SIZE;
 637 }
 638
 639 static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter,
 640                                        struct zfcp_fsf_req *fsf_req)
 641 {
 642         list_del(&fsf_req->list);
 643 }
 644
 645 static inline struct zfcp_fsf_req *
 646 zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id)
 647 {
 648         struct zfcp_fsf_req *request;
 649         unsigned int idx;
 650
 651         idx = zfcp_reqlist_hash(req_id);
 652         list_for_each_entry(request, &adapter->req_list[idx], list)
 653                 if (request->req_id == req_id)
 654                         return request;
 655         return NULL;
 656 }
 657
 658 static inline struct zfcp_fsf_req *
 659 zfcp_reqlist_find_safe(struct zfcp_adapter *adapter, struct zfcp_fsf_req *req)
 660 {
 661         struct zfcp_fsf_req *request;
 662         unsigned int idx;
 663
 664         for (idx = 0; idx < REQUEST_LIST_SIZE; idx++) {
 665                 list_for_each_entry(request, &adapter->req_list[idx], list)
 666                         if (request == req)
 667                                 return request;
 668         }
 669         return NULL;
 670 }
 671
 672 /*
 673  *  functions needed for reference/usage counting
 674  */
 675
 676 static inline void
 677 zfcp_unit_get(struct zfcp_unit *unit)
 678 {
 679         atomic_inc(&unit->refcount);
 680 }
 681
 682 static inline void
 683 zfcp_unit_put(struct zfcp_unit *unit)
 684 {
 685         if (atomic_dec_return(&unit->refcount) == 0)
 686                 wake_up(&unit->remove_wq);
 687 }
 688
 689 static inline void
 690 zfcp_port_get(struct zfcp_port *port)
 691 {
 692         atomic_inc(&port->refcount);
 693 }
 694
 695 static inline void
 696 zfcp_port_put(struct zfcp_port *port)
 697 {
 698         if (atomic_dec_return(&port->refcount) == 0)
 699                 wake_up(&port->remove_wq);
 700 }
 701
 702 static inline void
 703 zfcp_adapter_get(struct zfcp_adapter *adapter)
 704 {
 705         atomic_inc(&adapter->refcount);
 706 }
 707
 708 static inline void
 709 zfcp_adapter_put(struct zfcp_adapter *adapter)
 710 {
 711         if (atomic_dec_return(&adapter->refcount) == 0)
 712                 wake_up(&adapter->remove_wq);
 713 }
 714
 715 #endif /* ZFCP_DEF_H */