1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * zfcp device driver 4 * 5 * Global definitions for the zfcp device driver. 6 * 7 * Copyright IBM Corp. 2002, 2020 8 */ 9 10 #ifndef ZFCP_DEF_H 11 #define ZFCP_DEF_H 12 13 /*************************** INCLUDES *****************************************/ 14 15 #include <linux/init.h> 16 #include <linux/moduleparam.h> 17 #include <linux/major.h> 18 #include <linux/blkdev.h> 19 #include <linux/delay.h> 20 #include <linux/timer.h> 21 #include <linux/slab.h> 22 #include <linux/mempool.h> 23 #include <linux/syscalls.h> 24 #include <linux/scatterlist.h> 25 #include <linux/ioctl.h> 26 #include <scsi/fc/fc_fs.h> 27 #include <scsi/fc/fc_gs.h> 28 #include <scsi/scsi.h> 29 #include <scsi/scsi_tcq.h> 30 #include <scsi/scsi_cmnd.h> 31 #include <scsi/scsi_device.h> 32 #include <scsi/scsi_host.h> 33 #include <scsi/scsi_transport.h> 34 #include <scsi/scsi_transport_fc.h> 35 #include <scsi/scsi_bsg_fc.h> 36 #include <asm/ccwdev.h> 37 #include <asm/debug.h> 38 #include <asm/ebcdic.h> 39 #include <asm/sysinfo.h> 40 #include "zfcp_fsf.h" 41 #include "zfcp_fc.h" 42 #include "zfcp_qdio.h" 43 44 /********************* FSF SPECIFIC DEFINES *********************************/ 45 46 /* ATTENTION: value must not be used by hardware */ 47 #define FSF_QTCB_UNSOLICITED_STATUS 0x6305 48 49 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/ 50 51 /* 52 * Note, the leftmost 12 status bits (3 nibbles) are common among adapter, port 53 * and unit. This is a mask for bitwise 'and' with status values. 54 */ 55 #define ZFCP_COMMON_FLAGS 0xfff00000 56 57 /* common status bits */ 58 #define ZFCP_STATUS_COMMON_RUNNING 0x40000000 59 #define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000 60 #define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000 61 #define ZFCP_STATUS_COMMON_OPEN 0x04000000 62 #define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000 63 #define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000 64 #define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000 65 #define ZFCP_STATUS_COMMON_NOESC 0x00200000 66 67 /* adapter status */ 68 #define ZFCP_STATUS_ADAPTER_MB_ACT 0x00000001 69 #define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002 70 #define ZFCP_STATUS_ADAPTER_SIOSL_ISSUED 0x00000004 71 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008 72 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010 73 #define ZFCP_STATUS_ADAPTER_SUSPENDED 0x00000040 74 #define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100 75 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200 76 #define ZFCP_STATUS_ADAPTER_DATA_DIV_ENABLED 0x00000400 77 78 /* remote port status */ 79 #define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001 80 #define ZFCP_STATUS_PORT_LINK_TEST 0x00000002 81 82 /* FSF request status (this does not have a common part) */ 83 #define ZFCP_STATUS_FSFREQ_ERROR 0x00000008 84 #define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010 85 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040 86 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080 87 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200 88 #define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000 89 #define ZFCP_STATUS_FSFREQ_XDATAINCOMPLETE 0x00020000 90 91 /************************* STRUCTURE DEFINITIONS *****************************/ 92 93 /** 94 * enum zfcp_erp_act_type - Type of ERP action object. 95 * @ZFCP_ERP_ACTION_REOPEN_LUN: LUN recovery. 96 * @ZFCP_ERP_ACTION_REOPEN_PORT: Port recovery. 97 * @ZFCP_ERP_ACTION_REOPEN_PORT_FORCED: Forced port recovery. 98 * @ZFCP_ERP_ACTION_REOPEN_ADAPTER: Adapter recovery. 99 * 100 * Values must fit into u8 because of code dependencies: 101 * zfcp_dbf_rec_trig(), &zfcp_dbf_rec_trigger.want, &zfcp_dbf_rec_trigger.need; 102 * zfcp_dbf_rec_run_lvl(), zfcp_dbf_rec_run(), &zfcp_dbf_rec_running.rec_action. 103 */ 104 enum zfcp_erp_act_type { 105 ZFCP_ERP_ACTION_REOPEN_LUN = 1, 106 ZFCP_ERP_ACTION_REOPEN_PORT = 2, 107 ZFCP_ERP_ACTION_REOPEN_PORT_FORCED = 3, 108 ZFCP_ERP_ACTION_REOPEN_ADAPTER = 4, 109 }; 110 111 /* 112 * Values must fit into u16 because of code dependencies: 113 * zfcp_dbf_rec_run_lvl(), zfcp_dbf_rec_run(), zfcp_dbf_rec_run_wka(), 114 * &zfcp_dbf_rec_running.rec_step. 115 */ 116 enum zfcp_erp_steps { 117 ZFCP_ERP_STEP_UNINITIALIZED = 0x0000, 118 ZFCP_ERP_STEP_PHYS_PORT_CLOSING = 0x0010, 119 ZFCP_ERP_STEP_PORT_CLOSING = 0x0100, 120 ZFCP_ERP_STEP_PORT_OPENING = 0x0800, 121 ZFCP_ERP_STEP_LUN_CLOSING = 0x1000, 122 ZFCP_ERP_STEP_LUN_OPENING = 0x2000, 123 }; 124 125 struct zfcp_erp_action { 126 struct list_head list; 127 enum zfcp_erp_act_type type; /* requested action code */ 128 struct zfcp_adapter *adapter; /* device which should be recovered */ 129 struct zfcp_port *port; 130 struct scsi_device *sdev; 131 u32 status; /* recovery status */ 132 enum zfcp_erp_steps step; /* active step of this erp action */ 133 unsigned long fsf_req_id; 134 struct timer_list timer; 135 }; 136 137 /* holds various memory pools of an adapter */ 138 struct zfcp_adapter_mempool { 139 mempool_t *erp_req; 140 mempool_t *gid_pn_req; 141 mempool_t *scsi_req; 142 mempool_t *scsi_abort; 143 mempool_t *status_read_req; 144 mempool_t *sr_data; 145 mempool_t *gid_pn; 146 mempool_t *qtcb_pool; 147 }; 148 149 struct zfcp_adapter { 150 struct kref ref; 151 u64 peer_wwnn; /* P2P peer WWNN */ 152 u64 peer_wwpn; /* P2P peer WWPN */ 153 u32 peer_d_id; /* P2P peer D_ID */ 154 struct ccw_device *ccw_device; /* S/390 ccw device */ 155 struct zfcp_qdio *qdio; 156 u32 hydra_version; /* Hydra version */ 157 u32 fsf_lic_version; 158 u32 adapter_features; /* FCP channel features */ 159 u32 connection_features; /* host connection features */ 160 u32 hardware_version; /* of FCP channel */ 161 u32 fc_security_algorithms; /* of FCP channel */ 162 u32 fc_security_algorithms_old; /* of FCP channel */ 163 u16 timer_ticks; /* time int for a tick */ 164 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */ 165 struct list_head port_list; /* remote port list */ 166 rwlock_t port_list_lock; /* port list lock */ 167 unsigned long req_no; /* unique FSF req number */ 168 struct zfcp_reqlist *req_list; 169 u32 fsf_req_seq_no; /* FSF cmnd seq number */ 170 rwlock_t abort_lock; /* Protects against SCSI 171 stack abort/command 172 completion races */ 173 atomic_t stat_miss; /* # missing status reads*/ 174 unsigned int stat_read_buf_num; 175 struct work_struct stat_work; 176 atomic_t status; /* status of this adapter */ 177 struct list_head erp_ready_head; /* error recovery for this 178 adapter/devices */ 179 wait_queue_head_t erp_ready_wq; 180 struct list_head erp_running_head; 181 rwlock_t erp_lock; 182 wait_queue_head_t erp_done_wqh; 183 struct zfcp_erp_action erp_action; /* pending error recovery */ 184 atomic_t erp_counter; 185 u32 erp_total_count; /* total nr of enqueued erp 186 actions */ 187 u32 erp_low_mem_count; /* nr of erp actions waiting 188 for memory */ 189 struct task_struct *erp_thread; 190 struct zfcp_fc_wka_ports *gs; /* generic services */ 191 struct zfcp_dbf *dbf; /* debug traces */ 192 struct zfcp_adapter_mempool pool; /* Adapter memory pools */ 193 struct fc_host_statistics *fc_stats; 194 struct fsf_qtcb_bottom_port *stats_reset_data; 195 unsigned long stats_reset; 196 struct delayed_work scan_work; 197 struct work_struct ns_up_work; 198 struct service_level service_level; 199 struct workqueue_struct *work_queue; 200 struct device_dma_parameters dma_parms; 201 struct zfcp_fc_events events; 202 unsigned long next_port_scan; 203 struct zfcp_diag_adapter *diagnostics; 204 struct work_struct version_change_lost_work; 205 }; 206 207 struct zfcp_port { 208 struct device dev; 209 struct fc_rport *rport; /* rport of fc transport class */ 210 struct list_head list; /* list of remote ports */ 211 struct zfcp_adapter *adapter; /* adapter used to access port */ 212 struct list_head unit_list; /* head of logical unit list */ 213 rwlock_t unit_list_lock; /* unit list lock */ 214 atomic_t units; /* zfcp_unit count */ 215 atomic_t status; /* status of this remote port */ 216 u64 wwnn; /* WWNN if known */ 217 u64 wwpn; /* WWPN */ 218 u32 d_id; /* D_ID */ 219 u32 handle; /* handle assigned by FSF */ 220 struct zfcp_erp_action erp_action; /* pending error recovery */ 221 atomic_t erp_counter; 222 u32 maxframe_size; 223 u32 supported_classes; 224 u32 connection_info; 225 u32 connection_info_old; 226 struct work_struct gid_pn_work; 227 struct work_struct test_link_work; 228 struct work_struct rport_work; 229 enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task; 230 unsigned int starget_id; 231 }; 232 233 struct zfcp_latency_record { 234 u32 min; 235 u32 max; 236 u64 sum; 237 }; 238 239 struct zfcp_latency_cont { 240 struct zfcp_latency_record channel; 241 struct zfcp_latency_record fabric; 242 u64 counter; 243 }; 244 245 struct zfcp_latencies { 246 struct zfcp_latency_cont read; 247 struct zfcp_latency_cont write; 248 struct zfcp_latency_cont cmd; 249 spinlock_t lock; 250 }; 251 252 /** 253 * struct zfcp_unit - LUN configured via zfcp sysfs 254 * @dev: struct device for sysfs representation and reference counting 255 * @list: entry in LUN/unit list per zfcp_port 256 * @port: reference to zfcp_port where this LUN is configured 257 * @fcp_lun: 64 bit LUN value 258 * @scsi_work: for running scsi_scan_target 259 * 260 * This is the representation of a LUN that has been configured for 261 * usage. The main data here is the 64 bit LUN value, data for 262 * running I/O and recovery is in struct zfcp_scsi_dev. 263 */ 264 struct zfcp_unit { 265 struct device dev; 266 struct list_head list; 267 struct zfcp_port *port; 268 u64 fcp_lun; 269 struct work_struct scsi_work; 270 }; 271 272 /** 273 * struct zfcp_scsi_dev - zfcp data per SCSI device 274 * @status: zfcp internal status flags 275 * @lun_handle: handle from "open lun" for issuing FSF requests 276 * @erp_action: zfcp erp data for opening and recovering this LUN 277 * @erp_counter: zfcp erp counter for this LUN 278 * @latencies: FSF channel and fabric latencies 279 * @port: zfcp_port where this LUN belongs to 280 */ 281 struct zfcp_scsi_dev { 282 atomic_t status; 283 u32 lun_handle; 284 struct zfcp_erp_action erp_action; 285 atomic_t erp_counter; 286 struct zfcp_latencies latencies; 287 struct zfcp_port *port; 288 }; 289 290 /** 291 * sdev_to_zfcp - Access zfcp LUN data for SCSI device 292 * @sdev: scsi_device where to get the zfcp_scsi_dev pointer 293 */ 294 static inline struct zfcp_scsi_dev *sdev_to_zfcp(struct scsi_device *sdev) 295 { 296 return scsi_transport_device_data(sdev); 297 } 298 299 /** 300 * zfcp_scsi_dev_lun - Return SCSI device LUN as 64 bit FCP LUN 301 * @sdev: SCSI device where to get the LUN from 302 */ 303 static inline u64 zfcp_scsi_dev_lun(struct scsi_device *sdev) 304 { 305 u64 fcp_lun; 306 307 int_to_scsilun(sdev->lun, (struct scsi_lun *)&fcp_lun); 308 return fcp_lun; 309 } 310 311 /** 312 * struct zfcp_fsf_req - basic FSF request structure 313 * @list: list of FSF requests 314 * @req_id: unique request ID 315 * @adapter: adapter this request belongs to 316 * @qdio_req: qdio queue related values 317 * @completion: used to signal the completion of the request 318 * @status: status of the request 319 * @qtcb: associated QTCB 320 * @data: private data 321 * @timer: timer data of this request 322 * @erp_action: reference to erp action if request issued on behalf of ERP 323 * @pool: reference to memory pool if used for this request 324 * @issued: time when request was send (STCK) 325 * @handler: handler which should be called to process response 326 */ 327 struct zfcp_fsf_req { 328 struct list_head list; 329 unsigned long req_id; 330 struct zfcp_adapter *adapter; 331 struct zfcp_qdio_req qdio_req; 332 struct completion completion; 333 u32 status; 334 struct fsf_qtcb *qtcb; 335 void *data; 336 struct timer_list timer; 337 struct zfcp_erp_action *erp_action; 338 mempool_t *pool; 339 unsigned long long issued; 340 void (*handler)(struct zfcp_fsf_req *); 341 }; 342 343 static inline 344 int zfcp_adapter_multi_buffer_active(struct zfcp_adapter *adapter) 345 { 346 return atomic_read(&adapter->status) & ZFCP_STATUS_ADAPTER_MB_ACT; 347 } 348 349 static inline bool zfcp_fsf_req_is_status_read_buffer(struct zfcp_fsf_req *req) 350 { 351 return req->qtcb == NULL; 352 } 353 354 #endif /* ZFCP_DEF_H */ 355