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.c#4 $
33 * CAM Target Layer front end interface code
35 * Author: Ken Merry <ken@FreeBSD.org>
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/types.h>
45 #include <sys/malloc.h>
47 #include <sys/mutex.h>
48 #include <sys/condvar.h>
49 #include <sys/endian.h>
50 #include <sys/queue.h>
51 #include <sys/sysctl.h>
53 #include <cam/scsi/scsi_all.h>
54 #include <cam/scsi/scsi_da.h>
55 #include <cam/ctl/ctl_io.h>
56 #include <cam/ctl/ctl.h>
57 #include <cam/ctl/ctl_frontend.h>
58 #include <cam/ctl/ctl_frontend_internal.h>
59 #include <cam/ctl/ctl_backend.h>
60 /* XXX KDM move defines from ctl_ioctl.h to somewhere else */
61 #include <cam/ctl/ctl_ioctl.h>
62 #include <cam/ctl/ctl_ha.h>
63 #include <cam/ctl/ctl_private.h>
64 #include <cam/ctl/ctl_debug.h>
66 extern struct ctl_softc *control_softc;
69 ctl_frontend_register(struct ctl_frontend *fe)
71 struct ctl_softc *softc = control_softc;
72 struct ctl_frontend *fe_tmp;
74 KASSERT(softc != NULL, ("CTL is not initialized"));
77 * Sanity check, make sure this isn't a duplicate registration.
79 mtx_lock(&softc->ctl_lock);
80 STAILQ_FOREACH(fe_tmp, &softc->fe_list, links) {
81 if (strcmp(fe_tmp->name, fe->name) == 0) {
82 mtx_unlock(&softc->ctl_lock);
86 mtx_unlock(&softc->ctl_lock);
87 STAILQ_INIT(&fe->port_list);
90 * Call the frontend's initialization routine.
95 mtx_lock(&softc->ctl_lock);
96 softc->num_frontends++;
97 STAILQ_INSERT_TAIL(&softc->fe_list, fe, links);
98 mtx_unlock(&softc->ctl_lock);
103 ctl_frontend_deregister(struct ctl_frontend *fe)
105 struct ctl_softc *softc = control_softc;
107 if (!STAILQ_EMPTY(&fe->port_list))
110 mtx_lock(&softc->ctl_lock);
111 STAILQ_REMOVE(&softc->fe_list, fe, ctl_frontend, links);
112 softc->num_frontends--;
113 mtx_unlock(&softc->ctl_lock);
116 * Call the frontend's shutdown routine.
118 if (fe->shutdown != NULL)
123 struct ctl_frontend *
124 ctl_frontend_find(char *frontend_name)
126 struct ctl_softc *softc = control_softc;
127 struct ctl_frontend *fe;
129 mtx_lock(&softc->ctl_lock);
130 STAILQ_FOREACH(fe, &softc->fe_list, links) {
131 if (strcmp(fe->name, frontend_name) == 0) {
132 mtx_unlock(&softc->ctl_lock);
136 mtx_unlock(&softc->ctl_lock);
141 ctl_port_register(struct ctl_port *port)
143 struct ctl_softc *softc = control_softc;
150 KASSERT(softc != NULL, ("CTL is not initialized"));
152 mtx_lock(&softc->ctl_lock);
153 port_num = ctl_ffz(softc->ctl_port_mask, CTL_MAX_PORTS);
155 || (ctl_set_mask(softc->ctl_port_mask, port_num) == -1)) {
156 port->targ_port = -1;
157 mtx_unlock(&softc->ctl_lock);
161 mtx_unlock(&softc->ctl_lock);
164 * Initialize the initiator and portname mappings
166 port->max_initiators = CTL_MAX_INIT_PER_PORT;
167 port->wwpn_iid = malloc(sizeof(*port->wwpn_iid) * port->max_initiators,
168 M_CTL, M_NOWAIT | M_ZERO);
169 if (port->wwpn_iid == NULL) {
175 * We add 20 to whatever the caller requests, so he doesn't get
176 * burned by queueing things back to the pending sense queue. In
177 * theory, there should probably only be one outstanding item, at
178 * most, on the pending sense queue for a LUN. We'll clear the
179 * pending sense queue on the next command, whether or not it is
182 retval = ctl_pool_create(softc, port->port_name,
183 port->num_requested_ctl_io + 20, &pool);
185 free(port->wwpn_iid, M_CTL);
187 port->targ_port = -1;
188 mtx_lock(&softc->ctl_lock);
189 ctl_clear_mask(softc->ctl_port_mask, port_num);
190 mtx_unlock(&softc->ctl_lock);
193 port->ctl_pool_ref = pool;
195 if (port->options.stqh_first == NULL)
196 STAILQ_INIT(&port->options);
198 mtx_lock(&softc->ctl_lock);
199 port->targ_port = port_num + softc->port_offset;
200 STAILQ_INSERT_TAIL(&port->frontend->port_list, port, fe_links);
201 STAILQ_INSERT_TAIL(&softc->port_list, port, links);
202 softc->ctl_ports[port_num] = port;
203 mtx_unlock(&softc->ctl_lock);
209 ctl_port_deregister(struct ctl_port *port)
211 struct ctl_softc *softc = control_softc;
212 struct ctl_io_pool *pool;
213 int port_num, retval, i;
217 pool = (struct ctl_io_pool *)port->ctl_pool_ref;
219 if (port->targ_port == -1) {
224 mtx_lock(&softc->ctl_lock);
225 STAILQ_REMOVE(&softc->port_list, port, ctl_port, links);
226 STAILQ_REMOVE(&port->frontend->port_list, port, ctl_port, fe_links);
228 port_num = (port->targ_port < CTL_MAX_PORTS) ? port->targ_port :
229 port->targ_port - CTL_MAX_PORTS;
230 ctl_clear_mask(softc->ctl_port_mask, port_num);
231 softc->ctl_ports[port_num] = NULL;
232 mtx_unlock(&softc->ctl_lock);
235 ctl_free_opts(&port->options);
237 free(port->port_devid, M_CTL);
238 port->port_devid = NULL;
239 free(port->target_devid, M_CTL);
240 port->target_devid = NULL;
241 free(port->init_devid, M_CTL);
242 port->init_devid = NULL;
243 for (i = 0; i < port->max_initiators; i++)
244 free(port->wwpn_iid[i].name, M_CTL);
245 free(port->wwpn_iid, M_CTL);
252 ctl_port_set_wwns(struct ctl_port *port, int wwnn_valid, uint64_t wwnn,
253 int wwpn_valid, uint64_t wwpn)
255 struct scsi_vpd_id_descriptor *desc;
258 if (port->port_type == CTL_PORT_FC)
259 proto = SCSI_PROTO_FC << 4;
260 else if (port->port_type == CTL_PORT_ISCSI)
261 proto = SCSI_PROTO_ISCSI << 4;
263 proto = SCSI_PROTO_SPI << 4;
268 free(port->target_devid, M_CTL);
270 len = sizeof(struct scsi_vpd_device_id) + CTL_WWPN_LEN;
271 port->target_devid = malloc(sizeof(struct ctl_devid) + len,
272 M_CTL, M_WAITOK | M_ZERO);
273 port->target_devid->len = len;
274 desc = (struct scsi_vpd_id_descriptor *)port->target_devid->data;
275 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
276 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_TARGET |
278 desc->length = CTL_WWPN_LEN;
279 scsi_u64to8b(port->wwnn, desc->identifier);
285 free(port->port_devid, M_CTL);
287 len = sizeof(struct scsi_vpd_device_id) + CTL_WWPN_LEN;
288 port->port_devid = malloc(sizeof(struct ctl_devid) + len,
289 M_CTL, M_WAITOK | M_ZERO);
290 port->port_devid->len = len;
291 desc = (struct scsi_vpd_id_descriptor *)port->port_devid->data;
292 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
293 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
295 desc->length = CTL_WWPN_LEN;
296 scsi_u64to8b(port->wwpn, desc->identifier);
301 ctl_port_online(struct ctl_port *port)
303 port->port_online(port->onoff_arg);
304 /* XXX KDM need a lock here? */
305 port->status |= CTL_PORT_STATUS_ONLINE;
309 ctl_port_offline(struct ctl_port *port)
311 port->port_offline(port->onoff_arg);
312 /* XXX KDM need a lock here? */
313 port->status &= ~CTL_PORT_STATUS_ONLINE;