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_HA_SHARED = 0x02 46 } ctl_port_status; 47 48 typedef int (*fe_init_t)(void); 49 typedef void (*fe_shutdown_t)(void); 50 typedef void (*port_func_t)(void *onoff_arg); 51 typedef int (*port_info_func_t)(void *onoff_arg, struct sbuf *sb); 52 typedef int (*lun_func_t)(void *arg, int lun_id); 53 typedef int (*fe_ioctl_t)(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 54 struct thread *td); 55 56 #define CTL_FRONTEND_DECLARE(name, driver) \ 57 static int name ## _modevent(module_t mod, int type, void *data) \ 58 { \ 59 switch (type) { \ 60 case MOD_LOAD: \ 61 ctl_frontend_register( \ 62 (struct ctl_frontend *)data); \ 63 break; \ 64 case MOD_UNLOAD: \ 65 printf(#name " module unload - not possible for this module type\n"); \ 66 return EINVAL; \ 67 default: \ 68 return EOPNOTSUPP; \ 69 } \ 70 return 0; \ 71 } \ 72 static moduledata_t name ## _mod = { \ 73 #name, \ 74 name ## _modevent, \ 75 (void *)&driver \ 76 }; \ 77 DECLARE_MODULE(name, name ## _mod, SI_SUB_CONFIGURE, SI_ORDER_FOURTH); \ 78 MODULE_DEPEND(name, ctl, 1, 1, 1); \ 79 MODULE_DEPEND(name, cam, 1, 1, 1) 80 81 struct ctl_wwpn_iid { 82 int in_use; 83 time_t last_use; 84 uint64_t wwpn; 85 char *name; 86 }; 87 88 /* 89 * The ctl_frontend structure is the registration mechanism between a FETD 90 * (Front End Target Driver) and the CTL layer. Here is a description of 91 * the fields: 92 * 93 * port_type: This field tells CTL what kind of front end it is 94 * dealing with. This field serves two purposes. 95 * The first is to let CTL know whether the frontend 96 * in question is inside the main CTL module (i.e. 97 * the ioctl front end), and therefore its module 98 * reference count shouldn't be incremented. The 99 * CTL ioctl front end should continue to use the 100 * CTL_PORT_IOCTL argument as long as it is part of 101 * the main CTL module. The second is to let CTL 102 * know what kind of front end it is dealing with, so 103 * it can return the proper inquiry data for that 104 * particular port. 105 * 106 * num_requested_ctl_io: This is the number of ctl_io structures that the 107 * front end needs for its pool. This should 108 * generally be the maximum number of outstanding 109 * transactions that the FETD can handle. The CTL 110 * layer will add a few to this to account for 111 * ctl_io buffers queued for pending sense data. 112 * (Pending sense only gets queued if the FETD 113 * doesn't support autosense. e.g. non-packetized 114 * parallel SCSI doesn't support autosense.) 115 * 116 * port_name: A string describing the FETD. e.g. "LSI 1030T U320" 117 * or whatever you want to use to describe the driver. 118 * 119 * 120 * physical_port: This is the physical port number of this 121 * particular port within the driver/hardware. This 122 * number is hardware/driver specific. 123 * virtual_port: This is the virtual port number of this 124 * particular port. This is for things like NP-IV. 125 * 126 * port_online(): This function is called, with onoff_arg as its 127 * argument, by the CTL layer when it wants the FETD 128 * to start responding to selections on the specified 129 * target ID. 130 * 131 * port_offline(): This function is called, with onoff_arg as its 132 * argument, by the CTL layer when it wants the FETD 133 * to stop responding to selection on the specified 134 * target ID. 135 * 136 * onoff_arg: This is supplied as an argument to port_online() 137 * and port_offline(). This is specified by the 138 * FETD. 139 * 140 * lun_enable(): This function is called, with targ_lun_arg, a target 141 * ID and a LUN ID as its arguments, by CTL when it 142 * wants the FETD to enable a particular LUN. If the 143 * FETD doesn't really know about LUNs, it should 144 * just ignore this call and return 0. If the FETD 145 * cannot enable the requested LUN for some reason, the 146 * FETD should return non-zero status. 147 * 148 * lun_disable(): This function is called, with targ_lun_arg, a target 149 * ID and LUN ID as its arguments, by CTL when it 150 * wants the FETD to disable a particular LUN. If the 151 * FETD doesn't really know about LUNs, it should just 152 * ignore this call and return 0. If the FETD cannot 153 * disable the requested LUN for some reason, the 154 * FETD should return non-zero status. 155 * 156 * targ_lun_arg: This is supplied as an argument to the targ/lun 157 * enable/disable() functions. This is specified by 158 * the FETD. 159 * 160 * fe_datamove(): This function is called one or more times per I/O 161 * by the CTL layer to tell the FETD to initiate a 162 * DMA to or from the data buffer(s) specified by 163 * the passed-in ctl_io structure. 164 * 165 * fe_done(): This function is called by the CTL layer when a 166 * particular SCSI I/O or task management command has 167 * completed. For SCSI I/O requests (CTL_IO_SCSI), 168 * sense data is always supplied if the status is 169 * CTL_SCSI_ERROR and the SCSI status byte is 170 * SCSI_STATUS_CHECK_COND. If the FETD doesn't 171 * support autosense, the sense should be queued 172 * back to the CTL layer via ctl_queue_sense(). 173 * 174 * fe_dump(): This function, if it exists, is called by CTL 175 * to request a dump of any debugging information or 176 * state to the console. 177 * 178 * max_targets: The maximum number of targets that we can create 179 * per-port. 180 * 181 * max_target_id: The highest target ID that we can use. 182 * 183 * targ_port: The CTL layer assigns a "port number" to every 184 * FETD. This port number should be passed back in 185 * in the header of every ctl_io that is queued to 186 * the CTL layer. This enables us to determine 187 * which bus the command came in on. 188 * 189 * ctl_pool_ref: Memory pool reference used by the FETD in calls to 190 * ctl_alloc_io(). 191 * 192 * max_initiators: Maximum number of initiators that the FETD is 193 * allowed to have. Initiators should be numbered 194 * from 0 to max_initiators - 1. This value will 195 * typically be 16, and thus not a problem for 196 * parallel SCSI. This may present issues for Fibre 197 * Channel. 198 * 199 * wwnn World Wide Node Name to be used by the FETD. 200 * Note that this is set *after* registration. It 201 * will be set prior to the online function getting 202 * called. 203 * 204 * wwpn World Wide Port Name to be used by the FETD. 205 * Note that this is set *after* registration. It 206 * will be set prior to the online function getting 207 * called. 208 * 209 * status: Used by CTL to keep track of per-FETD state. 210 * 211 * links: Linked list pointers, used by CTL. The FETD 212 * shouldn't touch this field. 213 */ 214 struct ctl_port { 215 struct ctl_softc *ctl_softc; 216 struct ctl_frontend *frontend; 217 ctl_port_type port_type; /* passed to CTL */ 218 int num_requested_ctl_io; /* passed to CTL */ 219 char *port_name; /* passed to CTL */ 220 int physical_port; /* passed to CTL */ 221 int virtual_port; /* passed to CTL */ 222 port_func_t port_online; /* passed to CTL */ 223 port_func_t port_offline; /* passed to CTL */ 224 port_info_func_t port_info; /* passed to CTL */ 225 void *onoff_arg; /* passed to CTL */ 226 lun_func_t lun_enable; /* passed to CTL */ 227 lun_func_t lun_disable; /* passed to CTL */ 228 uint32_t *lun_map; /* passed to CTL */ 229 void *targ_lun_arg; /* passed to CTL */ 230 void (*fe_datamove)(union ctl_io *io); /* passed to CTL */ 231 void (*fe_done)(union ctl_io *io); /* passed to CTL */ 232 int max_targets; /* passed to CTL */ 233 int max_target_id; /* passed to CTL */ 234 int32_t targ_port; /* passed back to FETD */ 235 void *ctl_pool_ref; /* passed back to FETD */ 236 uint32_t max_initiators; /* passed back to FETD */ 237 struct ctl_wwpn_iid *wwpn_iid; /* used by CTL */ 238 uint64_t wwnn; /* set by CTL before online */ 239 uint64_t wwpn; /* set by CTL before online */ 240 ctl_port_status status; /* used by CTL */ 241 ctl_options_t options; /* passed to CTL */ 242 struct ctl_devid *port_devid; /* passed to CTL */ 243 struct ctl_devid *target_devid; /* passed to CTL */ 244 struct ctl_devid *init_devid; /* passed to CTL */ 245 STAILQ_ENTRY(ctl_port) fe_links; /* used by CTL */ 246 STAILQ_ENTRY(ctl_port) links; /* used by CTL */ 247 }; 248 249 struct ctl_frontend { 250 char name[CTL_DRIVER_NAME_LEN]; /* passed to CTL */ 251 fe_init_t init; /* passed to CTL */ 252 fe_ioctl_t ioctl; /* passed to CTL */ 253 void (*fe_dump)(void); /* passed to CTL */ 254 fe_shutdown_t shutdown; /* passed to CTL */ 255 STAILQ_HEAD(, ctl_port) port_list; /* used by CTL */ 256 STAILQ_ENTRY(ctl_frontend) links; /* used by CTL */ 257 }; 258 259 /* 260 * This may block until resources are allocated. Called at FETD module load 261 * time. Returns 0 for success, non-zero for failure. 262 */ 263 int ctl_frontend_register(struct ctl_frontend *fe); 264 265 /* 266 * Called at FETD module unload time. 267 * Returns 0 for success, non-zero for failure. 268 */ 269 int ctl_frontend_deregister(struct ctl_frontend *fe); 270 271 /* 272 * Find the frontend by its name. Returns NULL if not found. 273 */ 274 struct ctl_frontend * ctl_frontend_find(char *frontend_name); 275 276 /* 277 * This may block until resources are allocated. Called at FETD module load 278 * time. Returns 0 for success, non-zero for failure. 279 */ 280 int ctl_port_register(struct ctl_port *port); 281 282 /* 283 * Called at FETD module unload time. 284 * Returns 0 for success, non-zero for failure. 285 */ 286 int ctl_port_deregister(struct ctl_port *port); 287 288 /* 289 * Called to set the WWNN and WWPN for a particular frontend. 290 */ 291 void ctl_port_set_wwns(struct ctl_port *port, int wwnn_valid, 292 uint64_t wwnn, int wwpn_valid, uint64_t wwpn); 293 294 /* 295 * Called to bring a particular frontend online. 296 */ 297 void ctl_port_online(struct ctl_port *fe); 298 299 /* 300 * Called to take a particular frontend offline. 301 */ 302 void ctl_port_offline(struct ctl_port *fe); 303 304 /* 305 * This routine queues I/O and task management requests from the FETD to the 306 * CTL layer. Returns immediately. Returns 0 for success, non-zero for 307 * failure. 308 */ 309 int ctl_queue(union ctl_io *io); 310 311 /* 312 * This routine is used if the front end interface doesn't support 313 * autosense (e.g. non-packetized parallel SCSI). This will queue the 314 * scsiio structure back to a per-lun pending sense queue. This MUST be 315 * called BEFORE any request sense can get queued to the CTL layer -- I 316 * need it in the queue in order to service the request. The scsiio 317 * structure passed in here will be freed by the CTL layer when sense is 318 * retrieved by the initiator. Returns 0 for success, non-zero for failure. 319 */ 320 int ctl_queue_sense(union ctl_io *io); 321 322 /* 323 * This routine adds an initiator to CTL's port database. 324 * The iid field should be the same as the iid passed in the nexus of each 325 * ctl_io from this initiator. 326 * The WWPN should be the FC WWPN, if available. 327 */ 328 int ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name); 329 330 /* 331 * This routine will remove an initiator from CTL's port database. 332 * The iid field should be the same as the iid passed in the nexus of each 333 * ctl_io from this initiator. 334 */ 335 int ctl_remove_initiator(struct ctl_port *port, int iid); 336 337 #endif /* _CTL_FRONTEND_H_ */ 338