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