2 * Common functions for SCSI Interface Modules (SIMs).
4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
6 * Copyright (c) 1997 Justin T. Gibbs.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification, immediately at the beginning of the file.
15 * 2. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22 * ANY DIRECT, INDIRECT, INCIDENTAL, 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, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
36 #include <sys/kernel.h>
38 #include <sys/malloc.h>
39 #include <sys/mutex.h>
42 #include <cam/cam_ccb.h>
43 #include <cam/cam_queue.h>
44 #include <cam/cam_sim.h>
45 #include <cam/cam_xpt.h>
47 #define CAM_PATH_ANY (u_int32_t)-1
49 static MALLOC_DEFINE(M_CAMSIM, "CAM SIM", "CAM SIM buffers");
51 static struct mtx cam_sim_free_mtx;
52 MTX_SYSINIT(cam_sim_free_init, &cam_sim_free_mtx, "CAM SIM free lock", MTX_DEF);
55 cam_simq_alloc(u_int32_t max_sim_transactions)
57 return (cam_devq_alloc(/*size*/0, max_sim_transactions));
61 cam_simq_free(struct cam_devq *devq)
69 * @brief allocate a new sim and fill in the details
71 * A Storage Interface Module (SIM) is the interface between CAM and
72 * hardware. SIM receives CCBs from CAM via @p sim_action callback and
73 * translates them into DMA or other hardware transactions. During system
74 * dumps, it can be polled with the @p sim_poll callback. CCB processing is
75 * terminated by calling @c xpt_done().
77 * The @p mtx acts as a perimeter lock for the SIM. All calls into the SIM's
78 * @p sim_action are made with this lock held. It is also used to hold/release
79 * a SIM, managing its reference count. When the lock is NULL, the SIM is 100%
80 * responsible for locking (and the reference counting is done with a shared
83 * The cam_devq passed in (@c queue) is used to arbitrate the number of
84 * outstanding transactions to the SIM. For HBAs that have global limits shared
85 * between the different buses, the same devq should be specified for each bus
86 * attached to the SIM.
88 * @param sim_action Function to call to process CCBs
89 * @param sim_poll Function to poll the hardware for completions
90 * @param sim_name Name of SIM class
91 * @param softc Software context associated with the SIM
92 * @param unit Unit number of SIM
93 * @param mtx Mutex to lock while interacting with the SIM, or NULL
94 * for a SIM that handle its own locking to enable multi
96 * @param max_dev_transactions Maximum number of concurrent untagged
97 * transactions possible
98 * @param max_tagged_dev_transactions Maximum number of concurrent tagged
99 * transactions possible.
100 * @param queue The cam_devq to use for this SIM.
103 cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
104 const char *sim_name, void *softc, u_int32_t unit,
105 struct mtx *mtx, int max_dev_transactions,
106 int max_tagged_dev_transactions, struct cam_devq *queue)
110 sim = malloc(sizeof(struct cam_sim), M_CAMSIM, M_ZERO | M_NOWAIT);
114 sim->sim_action = sim_action;
115 sim->sim_poll = sim_poll;
116 sim->sim_name = sim_name;
118 sim->path_id = CAM_PATH_ANY;
119 sim->unit_number = unit;
120 sim->bus_id = 0; /* set in xpt_bus_register */
121 sim->max_tagged_dev_openings = max_tagged_dev_transactions;
122 sim->max_dev_openings = max_dev_transactions;
131 * @brief frees up the sim
133 * Frees up the CAM @c sim and optionally the devq. If a mutex is associated
134 * with the sim, it must be locked on entry. It will remain locked on
137 * This function will wait for all outstanding reference to the sim to clear
140 * @param sim The sim to free
141 * @param free_devq Free the devq associated with the sim at creation.
144 cam_sim_free(struct cam_sim *sim, int free_devq)
147 int error __diagused;
149 if (sim->mtx == NULL) {
150 mtx = &cam_sim_free_mtx;
154 mtx_assert(mtx, MA_OWNED);
156 KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
158 if (sim->refcount > 0) {
159 error = msleep(sim, mtx, PRIBIO, "simfree", 0);
160 KASSERT(error == 0, ("invalid error value for msleep(9)"));
162 KASSERT(sim->refcount == 0, ("sim->refcount == 0"));
163 if (mtx == &cam_sim_free_mtx) /* sim->mtx == NULL */
167 cam_simq_free(sim->devq);
172 cam_sim_release(struct cam_sim *sim)
176 if (sim->mtx == NULL)
177 mtx = &cam_sim_free_mtx;
178 else if (!mtx_owned(sim->mtx))
181 mtx = NULL; /* We hold the lock. */
184 KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
186 if (sim->refcount == 0)
193 cam_sim_hold(struct cam_sim *sim)
197 if (sim->mtx == NULL)
198 mtx = &cam_sim_free_mtx;
199 else if (!mtx_owned(sim->mtx))
202 mtx = NULL; /* We hold the lock. */
205 KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
212 cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
214 sim->path_id = path_id;