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>
39 #include <sys/thread2.h>
40 #include <sys/spinlock2.h>
41 #include <sys/mplock2.h>
46 #include "cam_queue.h"
47 #include "cam_xpt_sim.h"
49 #define CAM_PATH_ANY (u_int32_t)-1
51 MALLOC_DEFINE(M_CAMSIM
, "CAM SIM", "CAM SIM buffers");
53 /* Drivers will use sim_mplock if they need the BGL */
57 cam_sim_lock(sim_lock
*lock
)
59 if (lock
== &sim_mplock
)
62 lockmgr(lock
, LK_EXCLUSIVE
);
66 cam_sim_unlock(sim_lock
*lock
)
68 if (lock
== &sim_mplock
)
71 lockmgr(lock
, LK_RELEASE
);
75 cam_sim_cond_lock(sim_lock
*lock
)
77 if (lock
== &sim_mplock
) {
80 } else if (lockstatus(lock
, curthread
) != LK_EXCLUSIVE
) {
81 lockmgr(lock
, LK_EXCLUSIVE
);
88 cam_sim_cond_unlock(sim_lock
*lock
, int doun
)
91 if (lock
== &sim_mplock
)
94 lockmgr(lock
, LK_RELEASE
);
99 * lock can be NULL if sim was &dead_sim
102 sim_lock_assert_owned(sim_lock
*lock
)
105 if (lock
== &sim_mplock
)
106 ASSERT_MP_LOCK_HELD(curthread
);
108 KKASSERT(lockstatus(lock
, curthread
) != 0);
113 sim_lock_assert_unowned(sim_lock
*lock
)
116 if (lock
!= &sim_mplock
)
117 KKASSERT(lockstatus(lock
, curthread
) == 0);
122 sim_lock_sleep(void *ident
, int flags
, const char *wmesg
, int timo
,
127 if (lock
!= &sim_mplock
) {
128 /* lock should be held already */
129 KKASSERT(lockstatus(lock
, curthread
) != 0);
130 tsleep_interlock(ident
, flags
);
131 lockmgr(lock
, LK_RELEASE
);
132 retval
= tsleep(ident
, flags
| PINTERLOCKED
, wmesg
, timo
);
134 retval
= tsleep(ident
, flags
, wmesg
, timo
);
137 if (lock
!= &sim_mplock
) {
138 lockmgr(lock
, LK_EXCLUSIVE
);
145 cam_simq_alloc(u_int32_t max_sim_transactions
)
147 return (cam_devq_alloc(/*size*/0, max_sim_transactions
));
151 cam_simq_release(struct cam_devq
*devq
)
153 cam_devq_release(devq
);
157 * cam_sim_alloc() may potentially be called from an interrupt (?) but
158 * unexpected things happen to the system if malloc() returns NULL so we
159 * use M_INTWAIT anyway.
162 cam_sim_alloc(sim_action_func sim_action
, sim_poll_func sim_poll
,
163 const char *sim_name
, void *softc
, u_int32_t unit
,
164 sim_lock
*lock
, int max_dev_transactions
,
165 int max_tagged_dev_transactions
, struct cam_devq
*queue
)
170 * XXX ahd was limited to 256 instead of 512 for unknown reasons,
171 * move that to a global limit here. We may be able to remove this
172 * code, needs testing.
174 if (max_dev_transactions
> 256)
175 max_dev_transactions
= 256;
176 if (max_tagged_dev_transactions
> 256)
177 max_tagged_dev_transactions
= 256;
180 * Allocate a simq or use the supplied (possibly shared) simq.
183 queue
= cam_simq_alloc(max_tagged_dev_transactions
);
185 cam_devq_reference(queue
);
190 sim
= kmalloc(sizeof(struct cam_sim
), M_CAMSIM
, M_INTWAIT
| M_ZERO
);
191 sim
->sim_action
= sim_action
;
192 sim
->sim_poll
= sim_poll
;
193 sim
->sim_name
= sim_name
;
195 sim
->path_id
= CAM_PATH_ANY
;
196 sim
->unit_number
= unit
;
197 sim
->bus_id
= 0; /* set in xpt_bus_register */
198 sim
->max_tagged_dev_openings
= max_tagged_dev_transactions
;
199 sim
->max_dev_openings
= max_dev_transactions
;
204 if (lock
== &sim_mplock
) {
206 callout_init(&sim
->callout
);
208 sim
->flags
|= CAM_SIM_MPSAFE
;
209 callout_init_mp(&sim
->callout
);
212 SLIST_INIT(&sim
->ccb_freeq
);
213 TAILQ_INIT(&sim
->sim_doneq
);
214 spin_init(&sim
->sim_spin
);
219 static void deadsim_poll(struct cam_sim
*sim
);
220 static void deadsim_action(struct cam_sim
*sim
, union ccb
*ccb
);
223 cam_sim_free(struct cam_sim
*sim
)
225 sim
->sim_action
= deadsim_action
;
226 sim
->sim_poll
= deadsim_poll
;
227 cam_sim_release(sim
, CAM_SIM_SOFTC
);
231 * Note: the devq is still used by individual peripherals even if the
232 * backend sim disappears, so do not destroy it until the sim itself
233 * is no longer needed.
236 cam_sim_release(struct cam_sim
*sim
, int flags
)
238 if (flags
& CAM_SIM_SOFTC
)
240 if (sim
->refcount
== 1) {
242 cam_simq_release(sim
->devq
);
246 kfree(sim
, M_CAMSIM
);
253 cam_sim_set_path(struct cam_sim
*sim
, u_int32_t path_id
)
255 sim
->path_id
= path_id
;
259 * Dead sim poll and action functions. The backend to the sim has gone
260 * away, aka usb, scsi device, etc... deal with it.
263 deadsim_poll(struct cam_sim
*sim
)
269 deadsim_action(struct cam_sim
*sim
, union ccb
*ccb
)
271 ccb
->ccb_h
.status
= CAM_TID_INVALID
;