1 /* 2 * Copyright 2008 Cisco Systems, Inc. All rights reserved. 3 * Copyright 2007 Nuova Systems, Inc. All rights reserved. 4 * 5 * This program is free software; you may redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; version 2 of the License. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 10 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 11 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 12 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 13 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 14 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 15 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 16 * SOFTWARE. 17 */ 18 #ifndef _FNIC_H_ 19 #define _FNIC_H_ 20 21 #include <linux/interrupt.h> 22 #include <linux/netdevice.h> 23 #include <linux/workqueue.h> 24 #include <linux/bitops.h> 25 #include <scsi/libfc.h> 26 #include <scsi/libfcoe.h> 27 #include "fnic_io.h" 28 #include "fnic_res.h" 29 #include "fnic_trace.h" 30 #include "vnic_dev.h" 31 #include "vnic_wq.h" 32 #include "vnic_rq.h" 33 #include "vnic_cq.h" 34 #include "vnic_wq_copy.h" 35 #include "vnic_intr.h" 36 #include "vnic_stats.h" 37 #include "vnic_scsi.h" 38 39 #define DRV_NAME "fnic" 40 #define DRV_DESCRIPTION "Cisco FCoE HBA Driver" 41 #define DRV_VERSION "1.5.0.23" 42 #define PFX DRV_NAME ": " 43 #define DFX DRV_NAME "%d: " 44 45 #define DESC_CLEAN_LOW_WATERMARK 8 46 #define FNIC_UCSM_DFLT_THROTTLE_CNT_BLD 16 /* UCSM default throttle count */ 47 #define FNIC_MIN_IO_REQ 256 /* Min IO throttle count */ 48 #define FNIC_MAX_IO_REQ 2048 /* scsi_cmnd tag map entries */ 49 #define FNIC_IO_LOCKS 64 /* IO locks: power of 2 */ 50 #define FNIC_DFLT_QUEUE_DEPTH 32 51 #define FNIC_STATS_RATE_LIMIT 4 /* limit rate at which stats are pulled up */ 52 53 /* 54 * Tag bits used for special requests. 55 */ 56 #define FNIC_TAG_ABORT BIT(30) /* tag bit indicating abort */ 57 #define FNIC_TAG_DEV_RST BIT(29) /* indicates device reset */ 58 #define FNIC_TAG_MASK (BIT(24) - 1) /* mask for lookup */ 59 #define FNIC_NO_TAG -1 60 61 /* 62 * Command flags to identify the type of command and for other future 63 * use. 64 */ 65 #define FNIC_NO_FLAGS 0 66 #define FNIC_IO_INITIALIZED BIT(0) 67 #define FNIC_IO_ISSUED BIT(1) 68 #define FNIC_IO_DONE BIT(2) 69 #define FNIC_IO_REQ_NULL BIT(3) 70 #define FNIC_IO_ABTS_PENDING BIT(4) 71 #define FNIC_IO_ABORTED BIT(5) 72 #define FNIC_IO_ABTS_ISSUED BIT(6) 73 #define FNIC_IO_TERM_ISSUED BIT(7) 74 #define FNIC_IO_INTERNAL_TERM_ISSUED BIT(8) 75 #define FNIC_IO_ABT_TERM_DONE BIT(9) 76 #define FNIC_IO_ABT_TERM_REQ_NULL BIT(10) 77 #define FNIC_IO_ABT_TERM_TIMED_OUT BIT(11) 78 #define FNIC_DEVICE_RESET BIT(12) /* Device reset request */ 79 #define FNIC_DEV_RST_ISSUED BIT(13) 80 #define FNIC_DEV_RST_TIMED_OUT BIT(14) 81 #define FNIC_DEV_RST_ABTS_ISSUED BIT(15) 82 #define FNIC_DEV_RST_TERM_ISSUED BIT(16) 83 #define FNIC_DEV_RST_DONE BIT(17) 84 #define FNIC_DEV_RST_REQ_NULL BIT(18) 85 #define FNIC_DEV_RST_ABTS_DONE BIT(19) 86 #define FNIC_DEV_RST_TERM_DONE BIT(20) 87 #define FNIC_DEV_RST_ABTS_PENDING BIT(21) 88 89 /* 90 * Usage of the scsi_cmnd scratchpad. 91 * These fields are locked by the hashed io_req_lock. 92 */ 93 #define CMD_SP(Cmnd) ((Cmnd)->SCp.ptr) 94 #define CMD_STATE(Cmnd) ((Cmnd)->SCp.phase) 95 #define CMD_ABTS_STATUS(Cmnd) ((Cmnd)->SCp.Message) 96 #define CMD_LR_STATUS(Cmnd) ((Cmnd)->SCp.have_data_in) 97 #define CMD_TAG(Cmnd) ((Cmnd)->SCp.sent_command) 98 #define CMD_FLAGS(Cmnd) ((Cmnd)->SCp.Status) 99 100 #define FCPIO_INVALID_CODE 0x100 /* hdr_status value unused by firmware */ 101 102 #define FNIC_LUN_RESET_TIMEOUT 10000 /* mSec */ 103 #define FNIC_HOST_RESET_TIMEOUT 10000 /* mSec */ 104 #define FNIC_RMDEVICE_TIMEOUT 1000 /* mSec */ 105 #define FNIC_HOST_RESET_SETTLE_TIME 30 /* Sec */ 106 #define FNIC_ABT_TERM_DELAY_TIMEOUT 500 /* mSec */ 107 108 #define FNIC_MAX_FCP_TARGET 256 109 110 /** 111 * state_flags to identify host state along along with fnic's state 112 **/ 113 #define __FNIC_FLAGS_FWRESET BIT(0) /* fwreset in progress */ 114 #define __FNIC_FLAGS_BLOCK_IO BIT(1) /* IOs are blocked */ 115 116 #define FNIC_FLAGS_NONE (0) 117 #define FNIC_FLAGS_FWRESET (__FNIC_FLAGS_FWRESET | \ 118 __FNIC_FLAGS_BLOCK_IO) 119 120 #define FNIC_FLAGS_IO_BLOCKED (__FNIC_FLAGS_BLOCK_IO) 121 122 #define fnic_set_state_flags(fnicp, st_flags) \ 123 __fnic_set_state_flags(fnicp, st_flags, 0) 124 125 #define fnic_clear_state_flags(fnicp, st_flags) \ 126 __fnic_set_state_flags(fnicp, st_flags, 1) 127 128 extern unsigned int fnic_log_level; 129 130 #define FNIC_MAIN_LOGGING 0x01 131 #define FNIC_FCS_LOGGING 0x02 132 #define FNIC_SCSI_LOGGING 0x04 133 #define FNIC_ISR_LOGGING 0x08 134 135 #define FNIC_CHECK_LOGGING(LEVEL, CMD) \ 136 do { \ 137 if (unlikely(fnic_log_level & LEVEL)) \ 138 do { \ 139 CMD; \ 140 } while (0); \ 141 } while (0) 142 143 #define FNIC_MAIN_DBG(kern_level, host, fmt, args...) \ 144 FNIC_CHECK_LOGGING(FNIC_MAIN_LOGGING, \ 145 shost_printk(kern_level, host, fmt, ##args);) 146 147 #define FNIC_FCS_DBG(kern_level, host, fmt, args...) \ 148 FNIC_CHECK_LOGGING(FNIC_FCS_LOGGING, \ 149 shost_printk(kern_level, host, fmt, ##args);) 150 151 #define FNIC_SCSI_DBG(kern_level, host, fmt, args...) \ 152 FNIC_CHECK_LOGGING(FNIC_SCSI_LOGGING, \ 153 shost_printk(kern_level, host, fmt, ##args);) 154 155 #define FNIC_ISR_DBG(kern_level, host, fmt, args...) \ 156 FNIC_CHECK_LOGGING(FNIC_ISR_LOGGING, \ 157 shost_printk(kern_level, host, fmt, ##args);) 158 159 #define FNIC_MAIN_NOTE(kern_level, host, fmt, args...) \ 160 shost_printk(kern_level, host, fmt, ##args) 161 162 extern const char *fnic_state_str[]; 163 164 enum fnic_intx_intr_index { 165 FNIC_INTX_WQ_RQ_COPYWQ, 166 FNIC_INTX_ERR, 167 FNIC_INTX_NOTIFY, 168 FNIC_INTX_INTR_MAX, 169 }; 170 171 enum fnic_msix_intr_index { 172 FNIC_MSIX_RQ, 173 FNIC_MSIX_WQ, 174 FNIC_MSIX_WQ_COPY, 175 FNIC_MSIX_ERR_NOTIFY, 176 FNIC_MSIX_INTR_MAX, 177 }; 178 179 struct fnic_msix_entry { 180 int requested; 181 char devname[IFNAMSIZ]; 182 irqreturn_t (*isr)(int, void *); 183 void *devid; 184 }; 185 186 enum fnic_state { 187 FNIC_IN_FC_MODE = 0, 188 FNIC_IN_FC_TRANS_ETH_MODE, 189 FNIC_IN_ETH_MODE, 190 FNIC_IN_ETH_TRANS_FC_MODE, 191 }; 192 193 #define FNIC_WQ_COPY_MAX 1 194 #define FNIC_WQ_MAX 1 195 #define FNIC_RQ_MAX 1 196 #define FNIC_CQ_MAX (FNIC_WQ_COPY_MAX + FNIC_WQ_MAX + FNIC_RQ_MAX) 197 198 struct mempool; 199 200 enum fnic_evt { 201 FNIC_EVT_START_VLAN_DISC = 1, 202 FNIC_EVT_START_FCF_DISC = 2, 203 FNIC_EVT_MAX, 204 }; 205 206 struct fnic_event { 207 struct list_head list; 208 struct fnic *fnic; 209 enum fnic_evt event; 210 }; 211 212 /* Per-instance private data structure */ 213 struct fnic { 214 struct fc_lport *lport; 215 struct fcoe_ctlr ctlr; /* FIP FCoE controller structure */ 216 struct vnic_dev_bar bar0; 217 218 struct msix_entry msix_entry[FNIC_MSIX_INTR_MAX]; 219 struct fnic_msix_entry msix[FNIC_MSIX_INTR_MAX]; 220 221 struct vnic_stats *stats; 222 unsigned long stats_time; /* time of stats update */ 223 unsigned long stats_reset_time; /* time of stats reset */ 224 struct vnic_nic_cfg *nic_cfg; 225 char name[IFNAMSIZ]; 226 struct timer_list notify_timer; /* used for MSI interrupts */ 227 228 unsigned int fnic_max_tag_id; 229 unsigned int err_intr_offset; 230 unsigned int link_intr_offset; 231 232 unsigned int wq_count; 233 unsigned int cq_count; 234 235 u32 vlan_hw_insert:1; /* let hw insert the tag */ 236 u32 in_remove:1; /* fnic device in removal */ 237 u32 stop_rx_link_events:1; /* stop proc. rx frames, link events */ 238 239 struct completion *remove_wait; /* device remove thread blocks */ 240 241 atomic_t in_flight; /* io counter */ 242 u32 _reserved; /* fill hole */ 243 unsigned long state_flags; /* protected by host lock */ 244 enum fnic_state state; 245 spinlock_t fnic_lock; 246 247 u16 vlan_id; /* VLAN tag including priority */ 248 u8 data_src_addr[ETH_ALEN]; 249 u64 fcp_input_bytes; /* internal statistic */ 250 u64 fcp_output_bytes; /* internal statistic */ 251 u32 link_down_cnt; 252 int link_status; 253 254 struct list_head list; 255 struct pci_dev *pdev; 256 struct vnic_fc_config config; 257 struct vnic_dev *vdev; 258 unsigned int raw_wq_count; 259 unsigned int wq_copy_count; 260 unsigned int rq_count; 261 int fw_ack_index[FNIC_WQ_COPY_MAX]; 262 unsigned short fw_ack_recd[FNIC_WQ_COPY_MAX]; 263 unsigned short wq_copy_desc_low[FNIC_WQ_COPY_MAX]; 264 unsigned int intr_count; 265 u32 __iomem *legacy_pba; 266 struct fnic_host_tag *tags; 267 mempool_t *io_req_pool; 268 mempool_t *io_sgl_pool[FNIC_SGL_NUM_CACHES]; 269 spinlock_t io_req_lock[FNIC_IO_LOCKS]; /* locks for scsi cmnds */ 270 271 struct work_struct link_work; 272 struct work_struct frame_work; 273 struct sk_buff_head frame_queue; 274 struct sk_buff_head tx_queue; 275 276 /*** FIP related data members -- start ***/ 277 void (*set_vlan)(struct fnic *, u16 vlan); 278 struct work_struct fip_frame_work; 279 struct sk_buff_head fip_frame_queue; 280 struct timer_list fip_timer; 281 struct list_head vlans; 282 spinlock_t vlans_lock; 283 284 struct work_struct event_work; 285 struct list_head evlist; 286 /*** FIP related data members -- end ***/ 287 288 /* copy work queue cache line section */ 289 ____cacheline_aligned struct vnic_wq_copy wq_copy[FNIC_WQ_COPY_MAX]; 290 /* completion queue cache line section */ 291 ____cacheline_aligned struct vnic_cq cq[FNIC_CQ_MAX]; 292 293 spinlock_t wq_copy_lock[FNIC_WQ_COPY_MAX]; 294 295 /* work queue cache line section */ 296 ____cacheline_aligned struct vnic_wq wq[FNIC_WQ_MAX]; 297 spinlock_t wq_lock[FNIC_WQ_MAX]; 298 299 /* receive queue cache line section */ 300 ____cacheline_aligned struct vnic_rq rq[FNIC_RQ_MAX]; 301 302 /* interrupt resource cache line section */ 303 ____cacheline_aligned struct vnic_intr intr[FNIC_MSIX_INTR_MAX]; 304 }; 305 306 static inline struct fnic *fnic_from_ctlr(struct fcoe_ctlr *fip) 307 { 308 return container_of(fip, struct fnic, ctlr); 309 } 310 311 extern struct workqueue_struct *fnic_event_queue; 312 extern struct workqueue_struct *fnic_fip_queue; 313 extern struct device_attribute *fnic_attrs[]; 314 315 void fnic_clear_intr_mode(struct fnic *fnic); 316 int fnic_set_intr_mode(struct fnic *fnic); 317 void fnic_free_intr(struct fnic *fnic); 318 int fnic_request_intr(struct fnic *fnic); 319 320 int fnic_send(struct fc_lport *, struct fc_frame *); 321 void fnic_free_wq_buf(struct vnic_wq *wq, struct vnic_wq_buf *buf); 322 void fnic_handle_frame(struct work_struct *work); 323 void fnic_handle_link(struct work_struct *work); 324 void fnic_handle_event(struct work_struct *work); 325 int fnic_rq_cmpl_handler(struct fnic *fnic, int); 326 int fnic_alloc_rq_frame(struct vnic_rq *rq); 327 void fnic_free_rq_buf(struct vnic_rq *rq, struct vnic_rq_buf *buf); 328 void fnic_flush_tx(struct fnic *); 329 void fnic_eth_send(struct fcoe_ctlr *, struct sk_buff *skb); 330 void fnic_set_port_id(struct fc_lport *, u32, struct fc_frame *); 331 void fnic_update_mac(struct fc_lport *, u8 *new); 332 void fnic_update_mac_locked(struct fnic *, u8 *new); 333 334 int fnic_queuecommand(struct Scsi_Host *, struct scsi_cmnd *); 335 int fnic_abort_cmd(struct scsi_cmnd *); 336 int fnic_device_reset(struct scsi_cmnd *); 337 int fnic_host_reset(struct scsi_cmnd *); 338 int fnic_reset(struct Scsi_Host *); 339 void fnic_scsi_cleanup(struct fc_lport *); 340 void fnic_scsi_abort_io(struct fc_lport *); 341 void fnic_empty_scsi_cleanup(struct fc_lport *); 342 void fnic_exch_mgr_reset(struct fc_lport *, u32, u32); 343 int fnic_wq_copy_cmpl_handler(struct fnic *fnic, int); 344 int fnic_wq_cmpl_handler(struct fnic *fnic, int); 345 int fnic_flogi_reg_handler(struct fnic *fnic, u32); 346 void fnic_wq_copy_cleanup_handler(struct vnic_wq_copy *wq, 347 struct fcpio_host_req *desc); 348 int fnic_fw_reset_handler(struct fnic *fnic); 349 void fnic_terminate_rport_io(struct fc_rport *); 350 const char *fnic_state_to_str(unsigned int state); 351 352 void fnic_log_q_error(struct fnic *fnic); 353 void fnic_handle_link_event(struct fnic *fnic); 354 355 int fnic_is_abts_pending(struct fnic *, struct scsi_cmnd *); 356 357 void fnic_handle_fip_frame(struct work_struct *work); 358 void fnic_handle_fip_event(struct fnic *fnic); 359 void fnic_fcoe_reset_vlans(struct fnic *fnic); 360 void fnic_fcoe_evlist_free(struct fnic *fnic); 361 extern void fnic_handle_fip_timer(struct fnic *fnic); 362 363 static inline int 364 fnic_chk_state_flags_locked(struct fnic *fnic, unsigned long st_flags) 365 { 366 return ((fnic->state_flags & st_flags) == st_flags); 367 } 368 void __fnic_set_state_flags(struct fnic *, unsigned long, unsigned long); 369 void fnic_dump_fchost_stats(struct Scsi_Host *, struct fc_host_statistics *); 370 #endif /* _FNIC_H_ */ 371