2 * Copyright (c) 2003 Silicon Graphics International Corp.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
30 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_frontend.h#2 $
34 * CAM Target Layer front end registration hooks
36 * Author: Ken Merry <ken@FreeBSD.org>
39 #ifndef _CTL_FRONTEND_H_
40 #define _CTL_FRONTEND_H_
43 CTL_PORT_STATUS_NONE = 0x00,
44 CTL_PORT_STATUS_ONLINE = 0x01,
45 CTL_PORT_STATUS_TARG_ONLINE = 0x02,
46 CTL_PORT_STATUS_LUN_ONLINE = 0x04
49 typedef int (*fe_init_t)(void);
50 typedef void (*fe_shutdown_t)(void);
51 typedef void (*port_func_t)(void *onoff_arg);
52 typedef int (*targ_func_t)(void *arg, struct ctl_id targ_id);
53 typedef int (*lun_func_t)(void *arg, struct ctl_id targ_id, int lun_id);
54 typedef int (*fe_ioctl_t)(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
57 #define CTL_FRONTEND_DECLARE(name, driver) \
58 static int name ## _modevent(module_t mod, int type, void *data) \
62 ctl_frontend_register( \
63 (struct ctl_frontend *)data); \
66 printf(#name " module unload - not possible for this module type\n"); \
73 static moduledata_t name ## _mod = { \
78 DECLARE_MODULE(name, name ## _mod, SI_SUB_CONFIGURE, SI_ORDER_FOURTH); \
79 MODULE_DEPEND(name, ctl, 1, 1, 1); \
80 MODULE_DEPEND(name, cam, 1, 1, 1)
83 * The ctl_frontend structure is the registration mechanism between a FETD
84 * (Front End Target Driver) and the CTL layer. Here is a description of
87 * port_type: This field tells CTL what kind of front end it is
88 * dealing with. This field serves two purposes.
89 * The first is to let CTL know whether the frontend
90 * in question is inside the main CTL module (i.e.
91 * the ioctl front end), and therefore its module
92 * reference count shouldn't be incremented. The
93 * CTL ioctl front end should continue to use the
94 * CTL_PORT_IOCTL argument as long as it is part of
95 * the main CTL module. The second is to let CTL
96 * know what kind of front end it is dealing with, so
97 * it can return the proper inquiry data for that
100 * num_requested_ctl_io: This is the number of ctl_io structures that the
101 * front end needs for its pool. This should
102 * generally be the maximum number of outstanding
103 * transactions that the FETD can handle. The CTL
104 * layer will add a few to this to account for
105 * ctl_io buffers queued for pending sense data.
106 * (Pending sense only gets queued if the FETD
107 * doesn't support autosense. e.g. non-packetized
108 * parallel SCSI doesn't support autosense.)
110 * port_name: A string describing the FETD. e.g. "LSI 1030T U320"
111 * or whatever you want to use to describe the driver.
114 * physical_port: This is the physical port number of this
115 * particular port within the driver/hardware. This
116 * number is hardware/driver specific.
117 * virtual_port: This is the virtual port number of this
118 * particular port. This is for things like NP-IV.
120 * port_online(): This function is called, with onoff_arg as its
121 * argument, by the CTL layer when it wants the FETD
122 * to start responding to selections on the specified
123 * target ID. (targ_target)
125 * port_offline(): This function is called, with onoff_arg as its
126 * argument, by the CTL layer when it wants the FETD
127 * to stop responding to selection on the specified
128 * target ID. (targ_target)
130 * onoff_arg: This is supplied as an argument to port_online()
131 * and port_offline(). This is specified by the
134 * lun_enable(): This function is called, with targ_lun_arg, a target
135 * ID and a LUN ID as its arguments, by CTL when it
136 * wants the FETD to enable a particular LUN. If the
137 * FETD doesn't really know about LUNs, it should
138 * just ignore this call and return 0. If the FETD
139 * cannot enable the requested LUN for some reason, the
140 * FETD should return non-zero status.
142 * lun_disable(): This function is called, with targ_lun_arg, a target
143 * ID and LUN ID as its arguments, by CTL when it
144 * wants the FETD to disable a particular LUN. If the
145 * FETD doesn't really know about LUNs, it should just
146 * ignore this call and return 0. If the FETD cannot
147 * disable the requested LUN for some reason, the
148 * FETD should return non-zero status.
150 * targ_lun_arg: This is supplied as an argument to the targ/lun
151 * enable/disable() functions. This is specified by
154 * fe_datamove(): This function is called one or more times per I/O
155 * by the CTL layer to tell the FETD to initiate a
156 * DMA to or from the data buffer(s) specified by
157 * the passed-in ctl_io structure.
159 * fe_done(): This function is called by the CTL layer when a
160 * particular SCSI I/O or task management command has
161 * completed. For SCSI I/O requests (CTL_IO_SCSI),
162 * sense data is always supplied if the status is
163 * CTL_SCSI_ERROR and the SCSI status byte is
164 * SCSI_STATUS_CHECK_COND. If the FETD doesn't
165 * support autosense, the sense should be queued
166 * back to the CTL layer via ctl_queue_sense().
168 * fe_dump(): This function, if it exists, is called by CTL
169 * to request a dump of any debugging information or
170 * state to the console.
172 * max_targets: The maximum number of targets that we can create
175 * max_target_id: The highest target ID that we can use.
177 * targ_port: The CTL layer assigns a "port number" to every
178 * FETD. This port number should be passed back in
179 * in the header of every ctl_io that is queued to
180 * the CTL layer. This enables us to determine
181 * which bus the command came in on.
183 * ctl_pool_ref: Memory pool reference used by the FETD in calls to
186 * max_initiators: Maximum number of initiators that the FETD is
187 * allowed to have. Initiators should be numbered
188 * from 0 to max_initiators - 1. This value will
189 * typically be 16, and thus not a problem for
190 * parallel SCSI. This may present issues for Fibre
193 * wwnn World Wide Node Name to be used by the FETD.
194 * Note that this is set *after* registration. It
195 * will be set prior to the online function getting
198 * wwpn World Wide Port 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
203 * status: Used by CTL to keep track of per-FETD state.
205 * links: Linked list pointers, used by CTL. The FETD
206 * shouldn't touch this field.
209 struct ctl_frontend *frontend;
210 ctl_port_type port_type; /* passed to CTL */
211 int num_requested_ctl_io; /* passed to CTL */
212 char *port_name; /* passed to CTL */
213 int physical_port; /* passed to CTL */
214 int virtual_port; /* passed to CTL */
215 port_func_t port_online; /* passed to CTL */
216 port_func_t port_offline; /* passed to CTL */
217 void *onoff_arg; /* passed to CTL */
218 lun_func_t lun_enable; /* passed to CTL */
219 lun_func_t lun_disable; /* passed to CTL */
220 void *targ_lun_arg; /* passed to CTL */
221 void (*fe_datamove)(union ctl_io *io); /* passed to CTL */
222 void (*fe_done)(union ctl_io *io); /* passed to CTL */
223 int max_targets; /* passed to CTL */
224 int max_target_id; /* passed to CTL */
225 int32_t targ_port; /* passed back to FETD */
226 void *ctl_pool_ref; /* passed back to FETD */
227 uint32_t max_initiators; /* passed back to FETD */
228 uint64_t wwnn; /* set by CTL before online */
229 uint64_t wwpn; /* set by CTL before online */
230 ctl_port_status status; /* used by CTL */
231 ctl_options_t options; /* passed to CTL */
232 struct ctl_devid *port_devid; /* passed to CTL */
233 struct ctl_devid *target_devid; /* passed to CTL */
234 STAILQ_ENTRY(ctl_port) fe_links; /* used by CTL */
235 STAILQ_ENTRY(ctl_port) links; /* used by CTL */
238 struct ctl_frontend {
239 char name[CTL_DRIVER_NAME_LEN]; /* passed to CTL */
240 fe_init_t init; /* passed to CTL */
241 fe_ioctl_t ioctl; /* passed to CTL */
242 void (*fe_dump)(void); /* passed to CTL */
243 fe_shutdown_t shutdown; /* passed to CTL */
244 STAILQ_HEAD(, ctl_port) port_list; /* used by CTL */
245 STAILQ_ENTRY(ctl_frontend) links; /* used by CTL */
249 * This may block until resources are allocated. Called at FETD module load
250 * time. Returns 0 for success, non-zero for failure.
252 int ctl_frontend_register(struct ctl_frontend *fe);
255 * Called at FETD module unload time.
256 * Returns 0 for success, non-zero for failure.
258 int ctl_frontend_deregister(struct ctl_frontend *fe);
261 * Find the frontend by its name. Returns NULL if not found.
263 struct ctl_frontend * ctl_frontend_find(char *frontend_name);
266 * This may block until resources are allocated. Called at FETD module load
267 * time. Returns 0 for success, non-zero for failure.
269 int ctl_port_register(struct ctl_port *fe, int master_SC);
272 * Called at FETD module unload time.
273 * Returns 0 for success, non-zero for failure.
275 int ctl_port_deregister(struct ctl_port *fe);
278 * Called to set the WWNN and WWPN for a particular frontend.
280 void ctl_port_set_wwns(struct ctl_port *port, int wwnn_valid,
281 uint64_t wwnn, int wwpn_valid, uint64_t wwpn);
284 * Called to bring a particular frontend online.
286 void ctl_port_online(struct ctl_port *fe);
289 * Called to take a particular frontend offline.
291 void ctl_port_offline(struct ctl_port *fe);
294 * This routine queues I/O and task management requests from the FETD to the
295 * CTL layer. Returns immediately. Returns 0 for success, non-zero for
298 int ctl_queue(union ctl_io *io);
301 * This routine is used if the front end interface doesn't support
302 * autosense (e.g. non-packetized parallel SCSI). This will queue the
303 * scsiio structure back to a per-lun pending sense queue. This MUST be
304 * called BEFORE any request sense can get queued to the CTL layer -- I
305 * need it in the queue in order to service the request. The scsiio
306 * structure passed in here will be freed by the CTL layer when sense is
307 * retrieved by the initiator. Returns 0 for success, non-zero for failure.
309 int ctl_queue_sense(union ctl_io *io);
312 * This routine adds an initiator to CTL's port database. The WWPN should
313 * be the FC WWPN, if available. The targ_port field should be the same as
314 * the targ_port passed back from CTL in the ctl_frontend structure above.
315 * The iid field should be the same as the iid passed in the nexus of each
316 * ctl_io from this initiator.
318 int ctl_add_initiator(uint64_t wwpn, int32_t targ_port, uint32_t iid);
321 * This routine will remove an initiator from CTL's port database. The
322 * targ_port field should be the same as the targ_port passed back in the
323 * ctl_frontend structure above. The iid field should be the same as the
324 * iid passed in the nexus of each ctl_io from this initiator.
327 ctl_remove_initiator(int32_t targ_port, uint32_t iid);
329 #endif /* _CTL_FRONTEND_H_ */