drivers/scsi/bfa/bfad_im.h

   1 /*
   2  * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
   3  * Copyright (c) 2014- QLogic Corporation.
   4  * All rights reserved
   5  * www.qlogic.com
   6  *
   7  * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License (GPL) Version 2 as
  11  * published by the Free Software Foundation
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  */
  18
  19 #ifndef __BFAD_IM_H__
  20 #define __BFAD_IM_H__
  21
  22 #include "bfa_fcs.h"
  23
  24 #define FCPI_NAME " fcpim"
  25
  26 #ifndef KOBJ_NAME_LEN
  27 #define KOBJ_NAME_LEN           20
  28 #endif
  29
  30 bfa_status_t bfad_im_module_init(void);
  31 void bfad_im_module_exit(void);
  32 bfa_status_t bfad_im_probe(struct bfad_s *bfad);
  33 void bfad_im_probe_undo(struct bfad_s *bfad);
  34 bfa_status_t bfad_im_port_new(struct bfad_s *bfad, struct bfad_port_s *port);
  35 void bfad_im_port_delete(struct bfad_s *bfad, struct bfad_port_s *port);
  36 void bfad_im_port_clean(struct bfad_im_port_s *im_port);
  37 int  bfad_im_scsi_host_alloc(struct bfad_s *bfad,
  38                 struct bfad_im_port_s *im_port, struct device *dev);
  39 void bfad_im_scsi_host_free(struct bfad_s *bfad,
  40                                 struct bfad_im_port_s *im_port);
  41 u32 bfad_im_supported_speeds(struct bfa_s *bfa);
  42
  43 #define MAX_FCP_TARGET 1024
  44 #define MAX_FCP_LUN 16384
  45 #define BFAD_TARGET_RESET_TMO 60
  46 #define BFAD_LUN_RESET_TMO 60
  47 #define ScsiResult(host_code, scsi_code) (((host_code) << 16) | scsi_code)
  48 #define BFA_QUEUE_FULL_RAMP_UP_TIME 120
  49
  50 /*
  51  * itnim flags
  52  */
  53 #define IO_DONE_BIT                     0
  54
  55 struct bfad_itnim_data_s {
  56         struct bfad_itnim_s *itnim;
  57 };
  58
  59 struct bfad_im_port_s {
  60         struct bfad_s         *bfad;
  61         struct bfad_port_s    *port;
  62         struct work_struct port_delete_work;
  63         int             idr_id;
  64         u16        cur_scsi_id;
  65         u16     flags;
  66         struct list_head binding_list;
  67         struct Scsi_Host *shost;
  68         struct list_head itnim_mapped_list;
  69         struct fc_vport *fc_vport;
  70 };
  71
  72 struct bfad_im_port_pointer {
  73         struct bfad_im_port_s *p;
  74 };
  75
  76 static inline struct bfad_im_port_s *bfad_get_im_port(struct Scsi_Host *host)
  77 {
  78         struct bfad_im_port_pointer *im_portp = shost_priv(host);
  79         return im_portp->p;
  80 }
  81
  82 enum bfad_itnim_state {
  83         ITNIM_STATE_NONE,
  84         ITNIM_STATE_ONLINE,
  85         ITNIM_STATE_OFFLINE_PENDING,
  86         ITNIM_STATE_OFFLINE,
  87         ITNIM_STATE_TIMEOUT,
  88         ITNIM_STATE_FREE,
  89 };
  90
  91 /*
  92  * Per itnim data structure
  93  */
  94 struct bfad_itnim_s {
  95         struct list_head list_entry;
  96         struct bfa_fcs_itnim_s fcs_itnim;
  97         struct work_struct itnim_work;
  98         u32        flags;
  99         enum bfad_itnim_state state;
 100         struct bfad_im_s *im;
 101         struct bfad_im_port_s *im_port;
 102         struct bfad_rport_s *drv_rport;
 103         struct fc_rport *fc_rport;
 104         struct bfa_itnim_s *bfa_itnim;
 105         u16        scsi_tgt_id;
 106         u16        channel;
 107         u16        queue_work;
 108         unsigned long   last_ramp_up_time;
 109         unsigned long   last_queue_full_time;
 110 };
 111
 112 enum bfad_binding_type {
 113         FCP_PWWN_BINDING = 0x1,
 114         FCP_NWWN_BINDING = 0x2,
 115         FCP_FCID_BINDING = 0x3,
 116 };
 117
 118 struct bfad_fcp_binding {
 119         struct list_head list_entry;
 120         enum bfad_binding_type binding_type;
 121         u16        scsi_target_id;
 122         u32        fc_id;
 123         wwn_t           nwwn;
 124         wwn_t           pwwn;
 125 };
 126
 127 struct bfad_im_s {
 128         struct bfad_s         *bfad;
 129         struct workqueue_struct *drv_workq;
 130         char            drv_workq_name[KOBJ_NAME_LEN];
 131         struct work_struct      aen_im_notify_work;
 132 };
 133
 134 #define bfad_get_aen_entry(_drv, _entry) do {                           \
 135         unsigned long   _flags;                                         \
 136         spin_lock_irqsave(&(_drv)->bfad_aen_spinlock, _flags);          \
 137         bfa_q_deq(&(_drv)->free_aen_q, &(_entry));                      \
 138         if (_entry)                                                     \
 139                 list_add_tail(&(_entry)->qe, &(_drv)->active_aen_q);    \
 140         spin_unlock_irqrestore(&(_drv)->bfad_aen_spinlock, _flags);     \
 141 } while (0)
 142
 143 /* post fc_host vendor event */
 144 static inline void bfad_im_post_vendor_event(struct bfa_aen_entry_s *entry,
 145                                              struct bfad_s *drv, int cnt,
 146                                              enum bfa_aen_category cat,
 147                                              enum bfa_ioc_aen_event evt)
 148 {
 149         struct timespec64 ts;
 150
 151         ktime_get_real_ts64(&ts);
 152         /*
 153          * 'unsigned long aen_tv_sec' overflows in y2106 on 32-bit
 154          * architectures, or in 2038 if user space interprets it
 155          * as 'signed'.
 156          */
 157         entry->aen_tv_sec = ts.tv_sec;
 158         entry->aen_tv_usec = ts.tv_nsec / NSEC_PER_USEC;
 159         entry->bfad_num = drv->inst_no;
 160         entry->seq_num = cnt;
 161         entry->aen_category = cat;
 162         entry->aen_type = evt;
 163         if (drv->bfad_flags & BFAD_FC4_PROBE_DONE)
 164                 queue_work(drv->im->drv_workq, &drv->im->aen_im_notify_work);
 165 }
 166
 167 struct Scsi_Host *bfad_scsi_host_alloc(struct bfad_im_port_s *im_port,
 168                                 struct bfad_s *);
 169 bfa_status_t bfad_thread_workq(struct bfad_s *bfad);
 170 void bfad_destroy_workq(struct bfad_im_s *im);
 171 void bfad_fc_host_init(struct bfad_im_port_s *im_port);
 172 void bfad_scsi_host_free(struct bfad_s *bfad,
 173                                  struct bfad_im_port_s *im_port);
 174 void bfad_ramp_up_qdepth(struct bfad_itnim_s *itnim,
 175                                  struct scsi_device *sdev);
 176 void bfad_handle_qfull(struct bfad_itnim_s *itnim, struct scsi_device *sdev);
 177 struct bfad_itnim_s *bfad_get_itnim(struct bfad_im_port_s *im_port, int id);
 178
 179 extern struct scsi_host_template bfad_im_scsi_host_template;
 180 extern struct scsi_host_template bfad_im_vport_template;
 181 extern struct fc_function_template bfad_im_fc_function_template;
 182 extern struct fc_function_template bfad_im_vport_fc_function_template;
 183 extern struct scsi_transport_template *bfad_im_scsi_transport_template;
 184 extern struct scsi_transport_template *bfad_im_scsi_vport_transport_template;
 185
 186 extern struct device_attribute *bfad_im_host_attrs[];
 187 extern struct device_attribute *bfad_im_vport_attrs[];
 188
 189 irqreturn_t bfad_intx(int irq, void *dev_id);
 190
 191 int bfad_im_bsg_request(struct bsg_job *job);
 192 int bfad_im_bsg_timeout(struct bsg_job *job);
 193
 194 /*
 195  * Macro to set the SCSI device sdev_bflags - sdev_bflags are used by the
 196  * SCSI mid-layer to choose LUN Scanning mode REPORT_LUNS vs. Sequential Scan
 197  *
 198  * Internally iterate's over all the ITNIM's part of the im_port & set's the
 199  * sdev_bflags for the scsi_device associated with LUN #0.
 200  */
 201 #define bfad_reset_sdev_bflags(__im_port, __lunmask_cfg) do {           \
 202         struct scsi_device *__sdev = NULL;                              \
 203         struct bfad_itnim_s *__itnim = NULL;                            \
 204         u32 scan_flags = BLIST_NOREPORTLUN | BLIST_SPARSELUN;           \
 205         list_for_each_entry(__itnim, &((__im_port)->itnim_mapped_list), \
 206                             list_entry) {                               \
 207                 __sdev = scsi_device_lookup((__im_port)->shost,         \
 208                                             __itnim->channel,           \
 209                                             __itnim->scsi_tgt_id, 0);   \
 210                 if (__sdev) {                                           \
 211                         if ((__lunmask_cfg) == BFA_TRUE)                \
 212                                 __sdev->sdev_bflags |= scan_flags;      \
 213                         else                                            \
 214                                 __sdev->sdev_bflags &= ~scan_flags;     \
 215                         scsi_device_put(__sdev);                        \
 216                 }                                                       \
 217         }                                                               \
 218 } while (0)
 219
 220 #endif