drivers/scsi/bfa/bfa_fcpim.h

   1 /*
   2  * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
   3  * All rights reserved
   4  * www.brocade.com
   5  *
   6  * Linux driver for Brocade Fibre Channel Host Bus Adapter.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License (GPL) Version 2 as
  10  * published by the Free Software Foundation
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  */
  17
  18 #ifndef __BFA_FCPIM_H__
  19 #define __BFA_FCPIM_H__
  20
  21 #include "bfa.h"
  22 #include "bfa_svc.h"
  23 #include "bfi_ms.h"
  24 #include "bfa_defs_svc.h"
  25 #include "bfa_cs.h"
  26
  27 /* FCP module related definitions */
  28 #define BFA_IO_MAX      BFI_IO_MAX
  29 #define BFA_FWTIO_MAX   2000
  30
  31 struct bfa_fcp_mod_s;
  32 struct bfa_iotag_s {
  33         struct list_head        qe;     /* queue element        */
  34         u16     tag;                    /* FW IO tag            */
  35 };
  36
  37 struct bfa_itn_s {
  38         bfa_isr_func_t isr;
  39 };
  40
  41 void bfa_itn_create(struct bfa_s *bfa, struct bfa_rport_s *rport,
  42                 void (*isr)(struct bfa_s *bfa, struct bfi_msg_s *m));
  43 void bfa_itn_isr(struct bfa_s *bfa, struct bfi_msg_s *m);
  44 void bfa_iotag_attach(struct bfa_fcp_mod_s *fcp);
  45 void bfa_fcp_res_recfg(struct bfa_s *bfa, u16 num_ioim_fw);
  46
  47 #define BFA_FCP_MOD(_hal)       (&(_hal)->modules.fcp_mod)
  48 #define BFA_MEM_FCP_KVA(__bfa)  (&(BFA_FCP_MOD(__bfa)->kva_seg))
  49 #define BFA_IOTAG_FROM_TAG(_fcp, _tag)  \
  50         (&(_fcp)->iotag_arr[(_tag & BFA_IOIM_IOTAG_MASK)])
  51 #define BFA_ITN_FROM_TAG(_fcp, _tag)    \
  52         ((_fcp)->itn_arr + ((_tag) & ((_fcp)->num_itns - 1)))
  53 #define BFA_SNSINFO_FROM_TAG(_fcp, _tag) \
  54         bfa_mem_get_dmabuf_kva(_fcp, _tag, BFI_IOIM_SNSLEN)
  55
  56 #define BFA_ITNIM_MIN   32
  57 #define BFA_ITNIM_MAX   1024
  58
  59 #define BFA_IOIM_MIN    8
  60 #define BFA_IOIM_MAX    2000
  61
  62 #define BFA_TSKIM_MIN   4
  63 #define BFA_TSKIM_MAX   512
  64 #define BFA_FCPIM_PATHTOV_DEF   (30 * 1000)     /* in millisecs */
  65 #define BFA_FCPIM_PATHTOV_MAX   (90 * 1000)     /* in millisecs */
  66
  67
  68 #define bfa_itnim_ioprofile_update(__itnim, __index)                    \
  69         (__itnim->ioprofile.iocomps[__index]++)
  70
  71 #define BFA_IOIM_RETRY_TAG_OFFSET 11
  72 #define BFA_IOIM_IOTAG_MASK 0x07ff /* 2K IOs */
  73 #define BFA_IOIM_RETRY_MAX 7
  74
  75 /* Buckets are are 512 bytes to 2MB */
  76 static inline u32
  77 bfa_ioim_get_index(u32 n) {
  78         int pos = 0;
  79         if (n >= (1UL)<<22)
  80                 return BFA_IOBUCKET_MAX - 1;
  81         n >>= 8;
  82         if (n >= (1UL)<<16) {
  83                 n >>= 16;
  84                 pos += 16;
  85         }
  86         if (n >= 1 << 8) {
  87                 n >>= 8;
  88                 pos += 8;
  89         }
  90         if (n >= 1 << 4) {
  91                 n >>= 4;
  92                 pos += 4;
  93         }
  94         if (n >= 1 << 2) {
  95                 n >>= 2;
  96                 pos += 2;
  97         }
  98         if (n >= 1 << 1)
  99                 pos += 1;
 100
 101         return (n == 0) ? (0) : pos;
 102 }
 103
 104 /*
 105  * forward declarations
 106  */
 107 struct bfa_ioim_s;
 108 struct bfa_tskim_s;
 109 struct bfad_ioim_s;
 110 struct bfad_tskim_s;
 111
 112 typedef void    (*bfa_fcpim_profile_t) (struct bfa_ioim_s *ioim);
 113
 114 struct bfa_fcpim_s {
 115         struct bfa_s            *bfa;
 116         struct bfa_fcp_mod_s    *fcp;
 117         struct bfa_itnim_s      *itnim_arr;
 118         struct bfa_ioim_s       *ioim_arr;
 119         struct bfa_ioim_sp_s    *ioim_sp_arr;
 120         struct bfa_tskim_s      *tskim_arr;
 121         int                     num_itnims;
 122         int                     num_tskim_reqs;
 123         u32                     path_tov;
 124         u16                     q_depth;
 125         u8                      reqq;           /*  Request queue to be used */
 126         struct list_head        itnim_q;        /*  queue of active itnim */
 127         struct list_head        ioim_resfree_q; /*  IOs waiting for f/w */
 128         struct list_head        ioim_comp_q;    /*  IO global comp Q    */
 129         struct list_head        tskim_free_q;
 130         struct list_head        tskim_unused_q; /* Unused tskim Q */
 131         u32                     ios_active;     /*  current active IOs  */
 132         u32                     delay_comp;
 133         struct bfa_fcpim_del_itn_stats_s del_itn_stats;
 134         bfa_boolean_t           ioredirect;
 135         bfa_boolean_t           io_profile;
 136         u32                     io_profile_start_time;
 137         bfa_fcpim_profile_t     profile_comp;
 138         bfa_fcpim_profile_t     profile_start;
 139 };
 140
 141 /* Max FCP dma segs required */
 142 #define BFA_FCP_DMA_SEGS        BFI_IOIM_SNSBUF_SEGS
 143
 144 struct bfa_fcp_mod_s {
 145         struct bfa_s            *bfa;
 146         struct list_head        iotag_ioim_free_q;      /* free IO resources */
 147         struct list_head        iotag_tio_free_q;       /* free IO resources */
 148         struct list_head        iotag_unused_q; /* unused IO resources*/
 149         struct bfa_iotag_s      *iotag_arr;
 150         struct bfa_itn_s        *itn_arr;
 151         int                     num_ioim_reqs;
 152         int                     num_fwtio_reqs;
 153         int                     num_itns;
 154         struct bfa_dma_s        snsbase[BFA_FCP_DMA_SEGS];
 155         struct bfa_fcpim_s      fcpim;
 156         struct bfa_mem_dma_s    dma_seg[BFA_FCP_DMA_SEGS];
 157         struct bfa_mem_kva_s    kva_seg;
 158 };
 159
 160 /*
 161  * BFA IO (initiator mode)
 162  */
 163 struct bfa_ioim_s {
 164         struct list_head        qe;             /*  queue elememt       */
 165         bfa_sm_t                sm;             /*  BFA ioim state machine */
 166         struct bfa_s            *bfa;           /*  BFA module  */
 167         struct bfa_fcpim_s      *fcpim;         /*  parent fcpim module */
 168         struct bfa_itnim_s      *itnim;         /*  i-t-n nexus for this IO  */
 169         struct bfad_ioim_s      *dio;           /*  driver IO handle    */
 170         u16                     iotag;          /*  FWI IO tag  */
 171         u16                     abort_tag;      /*  unqiue abort request tag */
 172         u16                     nsges;          /*  number of SG elements */
 173         u16                     nsgpgs;         /*  number of SG pages  */
 174         struct bfa_sgpg_s       *sgpg;          /*  first SG page       */
 175         struct list_head        sgpg_q;         /*  allocated SG pages  */
 176         struct bfa_cb_qe_s      hcb_qe;         /*  bfa callback qelem  */
 177         bfa_cb_cbfn_t           io_cbfn;        /*  IO completion handler */
 178         struct bfa_ioim_sp_s    *iosp;          /*  slow-path IO handling */
 179         u8                      reqq;           /*  Request queue for I/O */
 180         u8                      mode;           /*  IO is passthrough or not */
 181         u64                     start_time;     /*  IO's Profile start val */
 182 };
 183
 184 struct bfa_ioim_sp_s {
 185         struct bfi_msg_s        comp_rspmsg;    /*  IO comp f/w response */
 186         struct bfa_sgpg_wqe_s   sgpg_wqe;       /*  waitq elem for sgpg */
 187         struct bfa_reqq_wait_s  reqq_wait;      /*  to wait for room in reqq */
 188         bfa_boolean_t           abort_explicit; /*  aborted by OS       */
 189         struct bfa_tskim_s      *tskim;         /*  Relevant TM cmd     */
 190 };
 191
 192 /*
 193  * BFA Task management command (initiator mode)
 194  */
 195 struct bfa_tskim_s {
 196         struct list_head        qe;
 197         bfa_sm_t                sm;
 198         struct bfa_s            *bfa;   /*  BFA module  */
 199         struct bfa_fcpim_s      *fcpim; /*  parent fcpim module */
 200         struct bfa_itnim_s      *itnim; /*  i-t-n nexus for this IO  */
 201         struct bfad_tskim_s     *dtsk;  /*  driver task mgmt cmnd       */
 202         bfa_boolean_t           notify; /*  notify itnim on TM comp  */
 203         struct scsi_lun         lun;    /*  lun if applicable   */
 204         enum fcp_tm_cmnd        tm_cmnd; /*  task management command  */
 205         u16                     tsk_tag; /*  FWI IO tag */
 206         u8                      tsecs;  /*  timeout in seconds  */
 207         struct bfa_reqq_wait_s  reqq_wait;   /*  to wait for room in reqq */
 208         struct list_head        io_q;   /*  queue of affected IOs       */
 209         struct bfa_wc_s         wc;     /*  waiting counter     */
 210         struct bfa_cb_qe_s      hcb_qe; /*  bfa callback qelem  */
 211         enum bfi_tskim_status   tsk_status;  /*  TM status      */
 212 };
 213
 214 /*
 215  * BFA i-t-n (initiator mode)
 216  */
 217 struct bfa_itnim_s {
 218         struct list_head        qe;     /*  queue element       */
 219         bfa_sm_t                sm;     /*  i-t-n im BFA state machine  */
 220         struct bfa_s            *bfa;   /*  bfa instance        */
 221         struct bfa_rport_s      *rport; /*  bfa rport   */
 222         void                    *ditn;  /*  driver i-t-n structure      */
 223         struct bfi_mhdr_s       mhdr;   /*  pre-built mhdr      */
 224         u8                      msg_no; /*  itnim/rport firmware handle */
 225         u8                      reqq;   /*  CQ for requests     */
 226         struct bfa_cb_qe_s      hcb_qe; /*  bfa callback qelem  */
 227         struct list_head pending_q;     /*  queue of pending IO requests */
 228         struct list_head io_q;          /*  queue of active IO requests */
 229         struct list_head io_cleanup_q;  /*  IO being cleaned up */
 230         struct list_head tsk_q;         /*  queue of active TM commands */
 231         struct list_head  delay_comp_q; /*  queue of failed inflight cmds */
 232         bfa_boolean_t   seq_rec;        /*  SQER supported      */
 233         bfa_boolean_t   is_online;      /*  itnim is ONLINE for IO      */
 234         bfa_boolean_t   iotov_active;   /*  IO TOV timer is active       */
 235         struct bfa_wc_s wc;             /*  waiting counter     */
 236         struct bfa_timer_s timer;       /*  pending IO TOV       */
 237         struct bfa_reqq_wait_s reqq_wait; /*  to wait for room in reqq */
 238         struct bfa_fcpim_s *fcpim;      /*  fcpim module        */
 239         struct bfa_itnim_iostats_s      stats;
 240         struct bfa_itnim_ioprofile_s  ioprofile;
 241 };
 242
 243 #define bfa_itnim_is_online(_itnim) ((_itnim)->is_online)
 244 #define BFA_FCPIM(_hal) (&(_hal)->modules.fcp_mod.fcpim)
 245 #define BFA_IOIM_TAG_2_ID(_iotag)       ((_iotag) & BFA_IOIM_IOTAG_MASK)
 246 #define BFA_IOIM_FROM_TAG(_fcpim, _iotag)       \
 247         (&fcpim->ioim_arr[(_iotag & BFA_IOIM_IOTAG_MASK)])
 248 #define BFA_TSKIM_FROM_TAG(_fcpim, _tmtag)      \
 249         (&fcpim->tskim_arr[_tmtag & (fcpim->num_tskim_reqs - 1)])
 250
 251 #define bfa_io_profile_start_time(_bfa) \
 252         ((_bfa)->modules.fcp_mod.fcpim.io_profile_start_time)
 253 #define bfa_fcpim_get_io_profile(_bfa)  \
 254         ((_bfa)->modules.fcp_mod.fcpim.io_profile)
 255 #define bfa_ioim_update_iotag(__ioim) do {                              \
 256         uint16_t k = (__ioim)->iotag >> BFA_IOIM_RETRY_TAG_OFFSET;      \
 257         k++; (__ioim)->iotag &= BFA_IOIM_IOTAG_MASK;                    \
 258         (__ioim)->iotag |= k << BFA_IOIM_RETRY_TAG_OFFSET;              \
 259 } while (0)
 260
 261 static inline bfa_boolean_t
 262 bfa_ioim_maxretry_reached(struct bfa_ioim_s *ioim)
 263 {
 264         uint16_t k = ioim->iotag >> BFA_IOIM_RETRY_TAG_OFFSET;
 265         if (k < BFA_IOIM_RETRY_MAX)
 266                 return BFA_FALSE;
 267         return BFA_TRUE;
 268 }
 269
 270 /*
 271  * function prototypes
 272  */
 273 void    bfa_ioim_attach(struct bfa_fcpim_s *fcpim);
 274 void    bfa_ioim_isr(struct bfa_s *bfa, struct bfi_msg_s *msg);
 275 void    bfa_ioim_good_comp_isr(struct bfa_s *bfa,
 276                                         struct bfi_msg_s *msg);
 277 void    bfa_ioim_cleanup(struct bfa_ioim_s *ioim);
 278 void    bfa_ioim_cleanup_tm(struct bfa_ioim_s *ioim,
 279                                         struct bfa_tskim_s *tskim);
 280 void    bfa_ioim_iocdisable(struct bfa_ioim_s *ioim);
 281 void    bfa_ioim_tov(struct bfa_ioim_s *ioim);
 282
 283 void    bfa_tskim_attach(struct bfa_fcpim_s *fcpim);
 284 void    bfa_tskim_isr(struct bfa_s *bfa, struct bfi_msg_s *msg);
 285 void    bfa_tskim_iodone(struct bfa_tskim_s *tskim);
 286 void    bfa_tskim_iocdisable(struct bfa_tskim_s *tskim);
 287 void    bfa_tskim_cleanup(struct bfa_tskim_s *tskim);
 288 void    bfa_tskim_res_recfg(struct bfa_s *bfa, u16 num_tskim_fw);
 289
 290 void    bfa_itnim_meminfo(struct bfa_iocfc_cfg_s *cfg, u32 *km_len);
 291 void    bfa_itnim_attach(struct bfa_fcpim_s *fcpim);
 292 void    bfa_itnim_iocdisable(struct bfa_itnim_s *itnim);
 293 void    bfa_itnim_isr(struct bfa_s *bfa, struct bfi_msg_s *msg);
 294 void    bfa_itnim_iodone(struct bfa_itnim_s *itnim);
 295 void    bfa_itnim_tskdone(struct bfa_itnim_s *itnim);
 296 bfa_boolean_t   bfa_itnim_hold_io(struct bfa_itnim_s *itnim);
 297
 298 /*
 299  * bfa fcpim module API functions
 300  */
 301 void    bfa_fcpim_path_tov_set(struct bfa_s *bfa, u16 path_tov);
 302 u16     bfa_fcpim_path_tov_get(struct bfa_s *bfa);
 303 u16     bfa_fcpim_qdepth_get(struct bfa_s *bfa);
 304 bfa_status_t bfa_fcpim_port_iostats(struct bfa_s *bfa,
 305                         struct bfa_itnim_iostats_s *stats, u8 lp_tag);
 306 void bfa_fcpim_add_stats(struct bfa_itnim_iostats_s *fcpim_stats,
 307                         struct bfa_itnim_iostats_s *itnim_stats);
 308 bfa_status_t bfa_fcpim_profile_on(struct bfa_s *bfa, u32 time);
 309 bfa_status_t bfa_fcpim_profile_off(struct bfa_s *bfa);
 310
 311 #define bfa_fcpim_ioredirect_enabled(__bfa)                             \
 312         (((struct bfa_fcpim_s *)(BFA_FCPIM(__bfa)))->ioredirect)
 313
 314 #define bfa_fcpim_get_next_reqq(__bfa, __qid)                           \
 315 {                                                                       \
 316         struct bfa_fcpim_s *__fcpim = BFA_FCPIM(__bfa);      \
 317         __fcpim->reqq++;                                                \
 318         __fcpim->reqq &= (BFI_IOC_MAX_CQS - 1);      \
 319         *(__qid) = __fcpim->reqq;                                       \
 320 }
 321
 322 #define bfa_iocfc_map_msg_to_qid(__msg, __qid)                          \
 323         *(__qid) = (u8)((__msg) & (BFI_IOC_MAX_CQS - 1));
 324 /*
 325  * bfa itnim API functions
 326  */
 327 struct bfa_itnim_s *bfa_itnim_create(struct bfa_s *bfa,
 328                 struct bfa_rport_s *rport, void *itnim);
 329 void bfa_itnim_delete(struct bfa_itnim_s *itnim);
 330 void bfa_itnim_online(struct bfa_itnim_s *itnim, bfa_boolean_t seq_rec);
 331 void bfa_itnim_offline(struct bfa_itnim_s *itnim);
 332 void bfa_itnim_clear_stats(struct bfa_itnim_s *itnim);
 333 bfa_status_t bfa_itnim_get_ioprofile(struct bfa_itnim_s *itnim,
 334                         struct bfa_itnim_ioprofile_s *ioprofile);
 335
 336 #define bfa_itnim_get_reqq(__ioim) (((struct bfa_ioim_s *)__ioim)->itnim->reqq)
 337
 338 /*
 339  * BFA completion callback for bfa_itnim_online().
 340  */
 341 void    bfa_cb_itnim_online(void *itnim);
 342
 343 /*
 344  * BFA completion callback for bfa_itnim_offline().
 345  */
 346 void    bfa_cb_itnim_offline(void *itnim);
 347 void    bfa_cb_itnim_tov_begin(void *itnim);
 348 void    bfa_cb_itnim_tov(void *itnim);
 349
 350 /*
 351  * BFA notification to FCS/driver for second level error recovery.
 352  * Atleast one I/O request has timedout and target is unresponsive to
 353  * repeated abort requests. Second level error recovery should be initiated
 354  * by starting implicit logout and recovery procedures.
 355  */
 356 void    bfa_cb_itnim_sler(void *itnim);
 357
 358 /*
 359  * bfa ioim API functions
 360  */
 361 struct bfa_ioim_s       *bfa_ioim_alloc(struct bfa_s *bfa,
 362                                         struct bfad_ioim_s *dio,
 363                                         struct bfa_itnim_s *itnim,
 364                                         u16 nsgles);
 365
 366 void            bfa_ioim_free(struct bfa_ioim_s *ioim);
 367 void            bfa_ioim_start(struct bfa_ioim_s *ioim);
 368 bfa_status_t    bfa_ioim_abort(struct bfa_ioim_s *ioim);
 369 void            bfa_ioim_delayed_comp(struct bfa_ioim_s *ioim,
 370                                       bfa_boolean_t iotov);
 371 /*
 372  * I/O completion notification.
 373  *
 374  * @param[in]           dio                     driver IO structure
 375  * @param[in]           io_status               IO completion status
 376  * @param[in]           scsi_status             SCSI status returned by target
 377  * @param[in]           sns_len                 SCSI sense length, 0 if none
 378  * @param[in]           sns_info                SCSI sense data, if any
 379  * @param[in]           residue                 Residual length
 380  *
 381  * @return None
 382  */
 383 void bfa_cb_ioim_done(void *bfad, struct bfad_ioim_s *dio,
 384                         enum bfi_ioim_status io_status,
 385                         u8 scsi_status, int sns_len,
 386                         u8 *sns_info, s32 residue);
 387
 388 /*
 389  * I/O good completion notification.
 390  */
 391 void bfa_cb_ioim_good_comp(void *bfad, struct bfad_ioim_s *dio);
 392
 393 /*
 394  * I/O abort completion notification
 395  */
 396 void bfa_cb_ioim_abort(void *bfad, struct bfad_ioim_s *dio);
 397
 398 /*
 399  * bfa tskim API functions
 400  */
 401 struct bfa_tskim_s *bfa_tskim_alloc(struct bfa_s *bfa,
 402                         struct bfad_tskim_s *dtsk);
 403 void bfa_tskim_free(struct bfa_tskim_s *tskim);
 404 void bfa_tskim_start(struct bfa_tskim_s *tskim,
 405                         struct bfa_itnim_s *itnim, struct scsi_lun lun,
 406                         enum fcp_tm_cmnd tm, u8 t_secs);
 407 void bfa_cb_tskim_done(void *bfad, struct bfad_tskim_s *dtsk,
 408                         enum bfi_tskim_status tsk_status);
 409
 410 void    bfa_fcpim_lunmask_rp_update(struct bfa_s *bfa, wwn_t lp_wwn,
 411                         wwn_t rp_wwn, u16 rp_tag, u8 lp_tag);
 412 bfa_status_t    bfa_fcpim_lunmask_update(struct bfa_s *bfa, u32 on_off);
 413 bfa_status_t    bfa_fcpim_lunmask_query(struct bfa_s *bfa, void *buf);
 414 bfa_status_t    bfa_fcpim_lunmask_delete(struct bfa_s *bfa, u16 vf_id,
 415                                 wwn_t *pwwn, wwn_t rpwwn, struct scsi_lun lun);
 416 bfa_status_t    bfa_fcpim_lunmask_add(struct bfa_s *bfa, u16 vf_id,
 417                                 wwn_t *pwwn, wwn_t rpwwn, struct scsi_lun lun);
 418 bfa_status_t    bfa_fcpim_lunmask_clear(struct bfa_s *bfa);
 419
 420 #endif /* __BFA_FCPIM_H__ */