1 /*- 2 * Copyright (c) 2017 Broadcom. All rights reserved. 3 * The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation 13 * and/or other materials provided with the distribution. 14 * 15 * 3. Neither the name of the copyright holder nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 * 31 * $FreeBSD$ 32 */ 33 34 /** 35 * @file 36 * OCS bsd driver common include file 37 */ 38 39 40 #if !defined(__OCS_H__) 41 #define __OCS_H__ 42 43 #include "ocs_os.h" 44 #include "ocs_utils.h" 45 46 #include "ocs_hw.h" 47 #include "ocs_scsi.h" 48 #include "ocs_io.h" 49 50 #include "version.h" 51 52 #define DRV_NAME "ocs_fc" 53 #define DRV_VERSION \ 54 STR_BE_MAJOR "." STR_BE_MINOR "." STR_BE_BUILD "." STR_BE_BRANCH 55 56 /** 57 * @brief Interrupt context 58 */ 59 typedef struct ocs_intr_ctx_s { 60 uint32_t vec; /** Zero based interrupt vector */ 61 void *softc; /** software context for interrupt */ 62 char name[64]; /** label for this context */ 63 } ocs_intr_ctx_t; 64 65 typedef struct ocs_fc_rport_db_s { 66 uint32_t node_id; 67 uint32_t state; 68 uint8_t is_target; 69 uint8_t is_initiator; 70 71 uint32_t port_id; 72 uint64_t wwnn; 73 uint64_t wwpn; 74 uint32_t gone_timer; 75 76 } ocs_fc_target_t; 77 78 #define OCS_TGT_STATE_NONE 0 /* Empty DB slot */ 79 #define OCS_TGT_STATE_VALID 1 /* Valid*/ 80 #define OCS_TGT_STATE_LOST 2 /* LOST*/ 81 82 typedef struct ocs_fcport_s { 83 ocs_t *ocs; 84 struct cam_sim *sim; 85 struct cam_path *path; 86 uint32_t role; 87 88 ocs_fc_target_t tgt[OCS_MAX_TARGETS]; 89 int lost_device_time; 90 struct callout ldt; /* device lost timer */ 91 struct task ltask; 92 93 ocs_tgt_resource_t targ_rsrc_wildcard; 94 ocs_tgt_resource_t targ_rsrc[OCS_MAX_LUN]; 95 ocs_vport_spec_t *vport; 96 } ocs_fcport; 97 98 #define FCPORT(ocs, chan) (&((ocs_fcport *)(ocs)->fcports)[(chan)]) 99 100 /** 101 * @brief Driver's context 102 */ 103 104 struct ocs_softc { 105 106 device_t dev; 107 struct cdev *cdev; 108 109 ocs_pci_reg_t reg[PCI_MAX_BAR]; 110 111 uint32_t instance_index; 112 const char *desc; 113 114 uint32_t irqid; 115 struct resource *irq; 116 void *tag; 117 118 ocs_intr_ctx_t intr_ctx; 119 uint32_t n_vec; 120 121 bus_dma_tag_t dmat; /** Parent DMA tag */ 122 bus_dma_tag_t buf_dmat;/** IO buffer DMA tag */ 123 char display_name[OCS_DISPLAY_NAME_LENGTH]; 124 uint16_t pci_vendor; 125 uint16_t pci_device; 126 uint16_t pci_subsystem_vendor; 127 uint16_t pci_subsystem_device; 128 char businfo[16]; 129 const char *driver_version; 130 const char *fw_version; 131 const char *model; 132 133 ocs_hw_t hw; 134 135 ocs_rlock_t lock; /**< device wide lock */ 136 137 ocs_xport_e ocs_xport; 138 ocs_xport_t *xport; /**< pointer to transport object */ 139 ocs_domain_t *domain; 140 ocs_list_t domain_list; 141 uint32_t domain_instance_count; 142 void (*domain_list_empty_cb)(ocs_t *ocs, void *arg); 143 void *domain_list_empty_cb_arg; 144 145 uint8_t enable_ini; 146 uint8_t enable_tgt; 147 uint8_t fc_type; 148 int ctrlmask; 149 uint8_t explicit_buffer_list; 150 uint8_t external_loopback; 151 uint8_t skip_hw_teardown; 152 int speed; 153 int topology; 154 int ethernet_license; 155 int num_scsi_ios; 156 uint8_t enable_hlm; 157 uint32_t hlm_group_size; 158 uint32_t max_isr_time_msec; /*>> Maximum ISR time */ 159 uint32_t auto_xfer_rdy_size; /*>> Max sized write to use auto xfer rdy*/ 160 uint8_t esoc; 161 int logmask; 162 char *hw_war_version; 163 uint32_t num_vports; 164 uint32_t target_io_timer_sec; 165 uint32_t hw_bounce; 166 uint8_t rq_threads; 167 uint8_t rq_selection_policy; 168 uint8_t rr_quanta; 169 char *filter_def; 170 uint32_t max_remote_nodes; 171 172 /* 173 * tgt_rscn_delay - delay in kicking off RSCN processing 174 * (nameserver queries) after receiving an RSCN on the target. 175 * This prevents thrashing of nameserver requests due to a huge burst of 176 * RSCNs received in a short period of time. 177 * Note: this is only valid when target RSCN handling is enabled -- see 178 * ctrlmask. 179 */ 180 time_t tgt_rscn_delay_msec; /*>> minimum target RSCN delay */ 181 182 /* 183 * tgt_rscn_period - determines maximum frequency when processing 184 * back-to-back RSCNs; e.g. if this value is 30, there will never be 185 * any more than 1 RSCN handling per 30s window. This prevents 186 * initiators on a faulty link generating many RSCN from causing the 187 * target to continually query the nameserver. 188 * Note: This is only valid when target RSCN handling is enabled 189 */ 190 time_t tgt_rscn_period_msec; /*>> minimum target RSCN period */ 191 192 uint32_t enable_task_set_full; 193 uint32_t io_in_use; 194 uint32_t io_high_watermark; /**< used to send task set full */ 195 struct mtx sim_lock; 196 uint32_t config_tgt:1, /**< Configured to support target mode */ 197 config_ini:1; /**< Configured to support initiator mode */ 198 199 200 uint32_t nodedb_mask; /**< Node debugging mask */ 201 202 char modeldesc[64]; 203 char serialnum[64]; 204 char fwrev[64]; 205 char sli_intf[9]; 206 207 ocs_ramlog_t *ramlog; 208 ocs_textbuf_t ddump_saved; 209 210 ocs_mgmt_functions_t *mgmt_functions; 211 ocs_mgmt_functions_t *tgt_mgmt_functions; 212 ocs_mgmt_functions_t *ini_mgmt_functions; 213 214 ocs_err_injection_e err_injection; 215 uint32_t cmd_err_inject; 216 time_t delay_value_msec; 217 218 bool attached; 219 struct mtx dbg_lock; 220 221 struct cam_devq *devq; 222 ocs_fcport *fcports; 223 224 void* tgt_ocs; 225 }; 226 227 static inline void 228 ocs_device_lock_init(ocs_t *ocs) 229 { 230 ocs_rlock_init(ocs, &ocs->lock, "ocsdevicelock"); 231 } 232 233 static inline int32_t 234 ocs_device_lock_try(ocs_t *ocs) 235 { 236 return ocs_rlock_try(&ocs->lock); 237 } 238 239 static inline void 240 ocs_device_lock(ocs_t *ocs) 241 { 242 ocs_rlock_acquire(&ocs->lock); 243 } 244 245 static inline void 246 ocs_device_unlock(ocs_t *ocs) 247 { 248 ocs_rlock_release(&ocs->lock); 249 } 250 251 static inline void 252 ocs_device_lock_free(ocs_t *ocs) 253 { 254 ocs_rlock_free(&ocs->lock); 255 } 256 257 extern int32_t ocs_device_detach(ocs_t *ocs); 258 259 extern int32_t ocs_device_attach(ocs_t *ocs); 260 261 #define ocs_is_initiator_enabled() (ocs->enable_ini) 262 #define ocs_is_target_enabled() (ocs->enable_tgt) 263 264 #include "ocs_xport.h" 265 #include "ocs_domain.h" 266 #include "ocs_sport.h" 267 #include "ocs_node.h" 268 #include "ocs_unsol.h" 269 #include "ocs_scsi.h" 270 #include "ocs_ioctl.h" 271 272 static inline ocs_io_t * 273 ocs_io_alloc(ocs_t *ocs) 274 { 275 return ocs_io_pool_io_alloc(ocs->xport->io_pool); 276 } 277 278 static inline void 279 ocs_io_free(ocs_t *ocs, ocs_io_t *io) 280 { 281 ocs_io_pool_io_free(ocs->xport->io_pool, io); 282 } 283 284 #endif /* __OCS_H__ */ 285