2 * Common functions for SCSI Interface Modules (SIMs).
4 * Copyright (c) 1997 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: src/sys/cam/cam_sim.c,v 1.3 1999/08/28 00:40:42 peter Exp $
29 * $DragonFly: src/sys/bus/cam/cam_sim.c,v 1.13 2008/07/18 00:07:21 dillon Exp $
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/malloc.h>
35 #include <sys/kernel.h>
37 #include <sys/spinlock.h>
38 #include <sys/thread2.h>
39 #include <sys/spinlock2.h>
44 #include "cam_queue.h"
45 #include "cam_xpt_sim.h"
47 #define CAM_PATH_ANY (u_int32_t)-1
49 MALLOC_DEFINE(M_CAMSIM, "CAM SIM", "CAM SIM buffers");
51 /* Drivers will use sim_mplock if they need the BGL */
55 cam_sim_lock(sim_lock *lock)
57 if (lock == &sim_mplock)
60 lockmgr(lock, LK_EXCLUSIVE);
64 cam_sim_unlock(sim_lock *lock)
66 if (lock == &sim_mplock)
69 lockmgr(lock, LK_RELEASE);
73 cam_sim_cond_lock(sim_lock *lock)
75 if (lock == &sim_mplock) {
78 } else if (lockstatus(lock, curthread) != LK_EXCLUSIVE) {
79 lockmgr(lock, LK_EXCLUSIVE);
86 cam_sim_cond_unlock(sim_lock *lock, int doun)
89 if (lock == &sim_mplock)
92 lockmgr(lock, LK_RELEASE);
97 * lock can be NULL if sim was &dead_sim
100 sim_lock_assert_owned(sim_lock *lock)
103 if (lock == &sim_mplock)
104 ASSERT_MP_LOCK_HELD(curthread);
106 KKASSERT(lockstatus(lock, curthread) != 0);
111 sim_lock_assert_unowned(sim_lock *lock)
114 if (lock != &sim_mplock)
115 KKASSERT(lockstatus(lock, curthread) == 0);
120 sim_lock_sleep(void *ident, int flags, const char *wmesg, int timo,
125 if (lock != &sim_mplock) {
126 /* lock should be held already */
127 KKASSERT(lockstatus(lock, curthread) != 0);
128 tsleep_interlock(ident, flags);
129 lockmgr(lock, LK_RELEASE);
130 retval = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
132 retval = tsleep(ident, flags, wmesg, timo);
135 if (lock != &sim_mplock) {
136 lockmgr(lock, LK_EXCLUSIVE);
143 cam_simq_alloc(u_int32_t max_sim_transactions)
145 return (cam_devq_alloc(/*size*/0, max_sim_transactions));
149 cam_simq_release(struct cam_devq *devq)
151 cam_devq_release(devq);
155 * cam_sim_alloc() may potentially be called from an interrupt (?) but
156 * unexpected things happen to the system if malloc() returns NULL so we
157 * use M_INTWAIT anyway.
160 cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
161 const char *sim_name, void *softc, u_int32_t unit,
162 sim_lock *lock, int max_dev_transactions,
163 int max_tagged_dev_transactions, struct cam_devq *queue)
168 * XXX ahd was limited to 256 instead of 512 for unknown reasons,
169 * move that to a global limit here. We may be able to remove this
170 * code, needs testing.
172 if (max_dev_transactions > 256)
173 max_dev_transactions = 256;
174 if (max_tagged_dev_transactions > 256)
175 max_tagged_dev_transactions = 256;
178 * Allocate a simq or use the supplied (possibly shared) simq.
181 queue = cam_simq_alloc(max_tagged_dev_transactions);
183 cam_devq_reference(queue);
188 sim = kmalloc(sizeof(struct cam_sim), M_CAMSIM, M_INTWAIT | M_ZERO);
189 sim->sim_action = sim_action;
190 sim->sim_poll = sim_poll;
191 sim->sim_name = sim_name;
193 sim->path_id = CAM_PATH_ANY;
194 sim->unit_number = unit;
195 sim->bus_id = 0; /* set in xpt_bus_register */
196 sim->max_tagged_dev_openings = max_tagged_dev_transactions;
197 sim->max_dev_openings = max_dev_transactions;
202 if (lock == &sim_mplock) {
204 callout_init(&sim->callout);
206 sim->flags |= CAM_SIM_MPSAFE;
207 callout_init_mp(&sim->callout);
210 SLIST_INIT(&sim->ccb_freeq);
211 TAILQ_INIT(&sim->sim_doneq);
212 spin_init(&sim->sim_spin);
217 static void deadsim_poll(struct cam_sim *sim);
218 static void deadsim_action(struct cam_sim *sim, union ccb *ccb);
221 cam_sim_free(struct cam_sim *sim)
223 sim->sim_action = deadsim_action;
224 sim->sim_poll = deadsim_poll;
225 cam_sim_release(sim, CAM_SIM_SOFTC);
229 * Note: the devq is still used by individual peripherals even if the
230 * backend sim disappears, so do not destroy it until the sim itself
231 * is no longer needed.
234 cam_sim_release(struct cam_sim *sim, int flags)
236 if (flags & CAM_SIM_SOFTC)
238 if (sim->refcount == 1) {
240 cam_simq_release(sim->devq);
244 kfree(sim, M_CAMSIM);
251 cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
253 sim->path_id = path_id;
257 * Dead sim poll and action functions. The backend to the sim has gone
258 * away, aka usb, scsi device, etc... deal with it.
261 deadsim_poll(struct cam_sim *sim)
267 deadsim_action(struct cam_sim *sim, union ccb *ccb)
269 ccb->ccb_h.status = CAM_TID_INVALID;