1 /*- 2 * Copyright (c) 2003 Silicon Graphics International Corp. 3 * Copyright (c) 2014-2017 Alexander Motin <mav@FreeBSD.org> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions, and the following disclaimer, 11 * without modification. 12 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 13 * substantially similar to the "NO WARRANTY" disclaimer below 14 * ("Disclaimer") and any redistribution must be conditioned upon 15 * including a substantially similar Disclaimer requirement for further 16 * binary redistribution. 17 * 18 * NO WARRANTY 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 28 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGES. 30 * 31 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_frontend.h#2 $ 32 * $FreeBSD$ 33 */ 34 /* 35 * CAM Target Layer front end registration hooks 36 * 37 * Author: Ken Merry <ken@FreeBSD.org> 38 */ 39 40 #ifndef _CTL_FRONTEND_H_ 41 #define _CTL_FRONTEND_H_ 42 43 #include <cam/ctl/ctl_ioctl.h> 44 45 typedef enum { 46 CTL_PORT_STATUS_NONE = 0x00, 47 CTL_PORT_STATUS_ONLINE = 0x01, 48 CTL_PORT_STATUS_HA_SHARED = 0x02 49 } ctl_port_status; 50 51 typedef int (*fe_init_t)(void); 52 typedef int (*fe_shutdown_t)(void); 53 typedef void (*port_func_t)(void *onoff_arg); 54 typedef int (*port_info_func_t)(void *onoff_arg, struct sbuf *sb); 55 typedef int (*lun_func_t)(void *arg, int lun_id); 56 typedef int (*fe_ioctl_t)(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 57 struct thread *td); 58 59 #define CTL_FRONTEND_DECLARE(name, driver) \ 60 static int name ## _modevent(module_t mod, int type, void *data) \ 61 { \ 62 switch (type) { \ 63 case MOD_LOAD: \ 64 return (ctl_frontend_register( \ 65 (struct ctl_frontend *)data)); \ 66 break; \ 67 case MOD_UNLOAD: \ 68 return (ctl_frontend_deregister( \ 69 (struct ctl_frontend *)data)); \ 70 break; \ 71 default: \ 72 return EOPNOTSUPP; \ 73 } \ 74 return 0; \ 75 } \ 76 static moduledata_t name ## _mod = { \ 77 #name, \ 78 name ## _modevent, \ 79 (void *)&driver \ 80 }; \ 81 DECLARE_MODULE(name, name ## _mod, SI_SUB_CONFIGURE, SI_ORDER_FOURTH); \ 82 MODULE_DEPEND(name, ctl, 1, 1, 1); \ 83 MODULE_DEPEND(name, cam, 1, 1, 1) 84 85 struct ctl_wwpn_iid { 86 int in_use; 87 time_t last_use; 88 uint64_t wwpn; 89 char *name; 90 }; 91 92 /* 93 * The ctl_frontend structure is the registration mechanism between a FETD 94 * (Front End Target Driver) and the CTL layer. Here is a description of 95 * the fields: 96 * 97 * port_type: This field tells CTL what kind of front end it is 98 * dealing with. This field serves two purposes. 99 * The first is to let CTL know whether the frontend 100 * in question is inside the main CTL module (i.e. 101 * the ioctl front end), and therefore its module 102 * reference count shouldn't be incremented. The 103 * CTL ioctl front end should continue to use the 104 * CTL_PORT_IOCTL argument as long as it is part of 105 * the main CTL module. The second is to let CTL 106 * know what kind of front end it is dealing with, so 107 * it can return the proper inquiry data for that 108 * particular port. 109 * 110 * num_requested_ctl_io: This is the number of ctl_io structures that the 111 * front end needs for its pool. This should 112 * generally be the maximum number of outstanding 113 * transactions that the FETD can handle. The CTL 114 * layer will add a few to this to account for 115 * ctl_io buffers queued for pending sense data. 116 * (Pending sense only gets queued if the FETD 117 * doesn't support autosense. e.g. non-packetized 118 * parallel SCSI doesn't support autosense.) 119 * 120 * port_name: A string describing the FETD. e.g. "LSI 1030T U320" 121 * or whatever you want to use to describe the driver. 122 * 123 * physical_port: This is the physical port number of this 124 * particular port within the driver/hardware. This 125 * number is hardware/driver specific. 126 * virtual_port: This is the virtual port number of this 127 * particular port. This is for things like NP-IV. 128 * 129 * port_online(): This function is called, with onoff_arg as its 130 * argument, by the CTL layer when it wants the FETD 131 * to start responding to selections on the specified 132 * target ID. 133 * 134 * port_offline(): This function is called, with onoff_arg as its 135 * argument, by the CTL layer when it wants the FETD 136 * to stop responding to selection on the specified 137 * target ID. 138 * 139 * onoff_arg: This is supplied as an argument to port_online() 140 * and port_offline(). This is specified by the 141 * FETD. 142 * 143 * lun_enable(): This function is called, with targ_lun_arg, a target 144 * ID and a LUN ID as its arguments, by CTL when it 145 * wants the FETD to enable a particular LUN. If the 146 * FETD doesn't really know about LUNs, it should 147 * just ignore this call and return 0. If the FETD 148 * cannot enable the requested LUN for some reason, the 149 * FETD should return non-zero status. 150 * 151 * lun_disable(): This function is called, with targ_lun_arg, a target 152 * ID and LUN ID as its arguments, by CTL when it 153 * wants the FETD to disable a particular LUN. If the 154 * FETD doesn't really know about LUNs, it should just 155 * ignore this call and return 0. If the FETD cannot 156 * disable the requested LUN for some reason, the 157 * FETD should return non-zero status. 158 * 159 * targ_lun_arg: This is supplied as an argument to the targ/lun 160 * enable/disable() functions. This is specified by 161 * the FETD. 162 * 163 * fe_datamove(): This function is called one or more times per I/O 164 * by the CTL layer to tell the FETD to initiate a 165 * DMA to or from the data buffer(s) specified by 166 * the passed-in ctl_io structure. 167 * 168 * fe_done(): This function is called by the CTL layer when a 169 * particular SCSI I/O or task management command has 170 * completed. For SCSI I/O requests (CTL_IO_SCSI), 171 * sense data is always supplied if the status is 172 * CTL_SCSI_ERROR and the SCSI status byte is 173 * SCSI_STATUS_CHECK_COND. If the FETD doesn't 174 * support autosense, the sense should be queued 175 * back to the CTL layer via ctl_queue_sense(). 176 * 177 * fe_dump(): This function, if it exists, is called by CTL 178 * to request a dump of any debugging information or 179 * state to the console. 180 * 181 * targ_port: The CTL layer assigns a "port number" to every 182 * FETD. This port number should be passed back in 183 * in the header of every ctl_io that is queued to 184 * the CTL layer. This enables us to determine 185 * which bus the command came in on. 186 * 187 * ctl_pool_ref: Memory pool reference used by the FETD in calls to 188 * ctl_alloc_io(). 189 * 190 * max_initiators: Maximum number of initiators that the FETD is 191 * allowed to have. Initiators should be numbered 192 * from 0 to max_initiators - 1. This value will 193 * typically be 16, and thus not a problem for 194 * parallel SCSI. This may present issues for Fibre 195 * Channel. 196 * 197 * wwnn World Wide Node Name to be used by the FETD. 198 * Note that this is set *after* registration. It 199 * will be set prior to the online function getting 200 * called. 201 * 202 * wwpn World Wide Port Name to be used by the FETD. 203 * Note that this is set *after* registration. It 204 * will be set prior to the online function getting 205 * called. 206 * 207 * status: Used by CTL to keep track of per-FETD state. 208 * 209 * links: Linked list pointers, used by CTL. The FETD 210 * shouldn't touch this field. 211 */ 212 struct ctl_port { 213 struct ctl_softc *ctl_softc; 214 struct ctl_frontend *frontend; 215 ctl_port_type port_type; /* passed to CTL */ 216 int num_requested_ctl_io; /* passed to CTL */ 217 char *port_name; /* passed to CTL */ 218 int physical_port; /* passed to CTL */ 219 int virtual_port; /* passed to CTL */ 220 port_func_t port_online; /* passed to CTL */ 221 port_func_t port_offline; /* passed to CTL */ 222 port_info_func_t port_info; /* passed to CTL */ 223 void *onoff_arg; /* passed to CTL */ 224 lun_func_t lun_enable; /* passed to CTL */ 225 lun_func_t lun_disable; /* passed to CTL */ 226 int lun_map_size; /* passed to CTL */ 227 uint32_t *lun_map; /* passed to CTL */ 228 void *targ_lun_arg; /* passed to CTL */ 229 void (*fe_datamove)(union ctl_io *io); /* passed to CTL */ 230 void (*fe_done)(union ctl_io *io); /* passed to CTL */ 231 int32_t targ_port; /* passed back to FETD */ 232 void *ctl_pool_ref; /* passed back to FETD */ 233 uint32_t max_initiators; /* passed back to FETD */ 234 struct ctl_wwpn_iid *wwpn_iid; /* used by CTL */ 235 uint64_t wwnn; /* set by CTL before online */ 236 uint64_t wwpn; /* set by CTL before online */ 237 ctl_port_status status; /* used by CTL */ 238 ctl_options_t options; /* passed to CTL */ 239 struct ctl_devid *port_devid; /* passed to CTL */ 240 struct ctl_devid *target_devid; /* passed to CTL */ 241 struct ctl_devid *init_devid; /* passed to CTL */ 242 struct ctl_io_stats stats; /* used by CTL */ 243 struct mtx port_lock; /* used by CTL */ 244 STAILQ_ENTRY(ctl_port) fe_links; /* used by CTL */ 245 STAILQ_ENTRY(ctl_port) links; /* used by CTL */ 246 }; 247 248 struct ctl_frontend { 249 char name[CTL_DRIVER_NAME_LEN]; /* passed to CTL */ 250 fe_init_t init; /* passed to CTL */ 251 fe_ioctl_t ioctl; /* passed to CTL */ 252 void (*fe_dump)(void); /* passed to CTL */ 253 fe_shutdown_t shutdown; /* passed to CTL */ 254 STAILQ_HEAD(, ctl_port) port_list; /* used by CTL */ 255 STAILQ_ENTRY(ctl_frontend) links; /* used by CTL */ 256 }; 257 258 /* 259 * This may block until resources are allocated. Called at FETD module load 260 * time. Returns 0 for success, non-zero for failure. 261 */ 262 int ctl_frontend_register(struct ctl_frontend *fe); 263 264 /* 265 * Called at FETD module unload time. 266 * Returns 0 for success, non-zero for failure. 267 */ 268 int ctl_frontend_deregister(struct ctl_frontend *fe); 269 270 /* 271 * Find the frontend by its name. Returns NULL if not found. 272 */ 273 struct ctl_frontend * ctl_frontend_find(char *frontend_name); 274 275 /* 276 * This may block until resources are allocated. Called at FETD module load 277 * time. Returns 0 for success, non-zero for failure. 278 */ 279 int ctl_port_register(struct ctl_port *port); 280 281 /* 282 * Called at FETD module unload time. 283 * Returns 0 for success, non-zero for failure. 284 */ 285 int ctl_port_deregister(struct ctl_port *port); 286 287 /* 288 * Called to set the WWNN and WWPN for a particular frontend. 289 */ 290 void ctl_port_set_wwns(struct ctl_port *port, int wwnn_valid, 291 uint64_t wwnn, int wwpn_valid, uint64_t wwpn); 292 293 /* 294 * Called to bring a particular frontend online. 295 */ 296 void ctl_port_online(struct ctl_port *fe); 297 298 /* 299 * Called to take a particular frontend offline. 300 */ 301 void ctl_port_offline(struct ctl_port *fe); 302 303 /* 304 * This routine queues I/O and task management requests from the FETD to the 305 * CTL layer. Returns immediately. Returns 0 for success, non-zero for 306 * failure. 307 */ 308 int ctl_queue(union ctl_io *io); 309 310 /* 311 * This routine is used if the front end interface doesn't support 312 * autosense (e.g. non-packetized parallel SCSI). This will queue the 313 * scsiio structure back to a per-lun pending sense queue. This MUST be 314 * called BEFORE any request sense can get queued to the CTL layer -- I 315 * need it in the queue in order to service the request. The scsiio 316 * structure passed in here will be freed by the CTL layer when sense is 317 * retrieved by the initiator. Returns 0 for success, non-zero for failure. 318 */ 319 int ctl_queue_sense(union ctl_io *io); 320 321 /* 322 * This routine adds an initiator to CTL's port database. 323 * The iid field should be the same as the iid passed in the nexus of each 324 * ctl_io from this initiator. 325 * The WWPN should be the FC WWPN, if available. 326 */ 327 int ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name); 328 329 /* 330 * This routine will remove an initiator from CTL's port database. 331 * The iid field should be the same as the iid passed in the nexus of each 332 * ctl_io from this initiator. 333 */ 334 int ctl_remove_initiator(struct ctl_port *port, int iid); 335 336 #endif /* _CTL_FRONTEND_H_ */ 337