1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*-
* Common functions for SCSI Interface Modules (SIMs).
*
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 1997 Justin T. Gibbs.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification, immediately at the beginning of the file.
* 2. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/malloc.h>
#include <sys/kernel.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/bus.h>
#include <cam/cam.h>
#include <cam/cam_ccb.h>
#include <cam/cam_sim.h>
#include <cam/cam_queue.h>
#include <cam/cam_xpt.h>
#define CAM_PATH_ANY (u_int32_t)-1
static MALLOC_DEFINE(M_CAMSIM, "CAM SIM", "CAM SIM buffers");
static struct mtx cam_sim_free_mtx;
MTX_SYSINIT(cam_sim_free_init, &cam_sim_free_mtx, "CAM SIM free lock", MTX_DEF);
struct cam_devq *
cam_simq_alloc(u_int32_t max_sim_transactions)
{
return (cam_devq_alloc(/*size*/0, max_sim_transactions));
}
void
cam_simq_free(struct cam_devq *devq)
{
cam_devq_free(devq);
}
/**
* @brief allocate a new sim and fill in the details
*
* A Storage Interface Module (SIM) is the interface between CAM and
* hardware. SIM receives CCBs from CAM via @p sim_action callback and
* translates them into DMA or other hardware transactions. During system
* dumps, it can be polled with the @p sim_poll callback. CCB processing is
* terminated by calling @c xpt_done().
*
* The @p mtx acts as a perimeter lock for the SIM. All calls into the SIM's
* @p sim_action are made with this lock held. It is also used to hold/release
* a SIM, managing its reference count. When the lock is NULL, the SIM is 100%
* responsible for locking (and the reference counting is done with a shared
* lock.
*
* The cam_devq passed in (@c queue) is used to arbitrate the number of
* outstanding transactions to the SIM. For HBAs that have global limits shared
* between the different buses, the same devq should be specified for each bus
* attached to the SIM.
*
* @param sim_action Function to call to process CCBs
* @param sim_poll Function to poll the hardware for completions
* @param sim_name Name of SIM class
* @param softc Software context associated with the SIM
* @param unit Unit number of SIM
* @param mtx Mutex to lock while interacting with the SIM, or NULL
* for a SIM that handle its own locking to enable multi
* queue support.
* @param max_dev_transactions Maximum number of concurrent untagged
* transactions possible
* @param max_tagged_dev_transactions Maximum number of concurrent tagged
* transactions possible.
* @param queue The cam_devq to use for this SIM.
*/
struct cam_sim *
cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
const char *sim_name, void *softc, u_int32_t unit,
struct mtx *mtx, int max_dev_transactions,
int max_tagged_dev_transactions, struct cam_devq *queue)
{
struct cam_sim *sim;
sim = malloc(sizeof(struct cam_sim), M_CAMSIM, M_ZERO | M_NOWAIT);
if (sim == NULL)
return (NULL);
sim->sim_action = sim_action;
sim->sim_poll = sim_poll;
sim->sim_name = sim_name;
sim->softc = softc;
sim->path_id = CAM_PATH_ANY;
sim->sim_dev = NULL; /* set only by cam_sim_alloc_dev */
sim->unit_number = unit;
sim->bus_id = 0; /* set in xpt_bus_register */
sim->max_tagged_dev_openings = max_tagged_dev_transactions;
sim->max_dev_openings = max_dev_transactions;
sim->flags = 0;
sim->refcount = 1;
sim->devq = queue;
sim->mtx = mtx;
callout_init(&sim->callout, 1);
return (sim);
}
struct cam_sim *
cam_sim_alloc_dev(sim_action_func sim_action, sim_poll_func sim_poll,
const char *sim_name, void *softc, device_t dev,
struct mtx *mtx, int max_dev_transactions,
int max_tagged_dev_transactions, struct cam_devq *queue)
{
struct cam_sim *sim;
KASSERT(dev != NULL, ("%s: dev is null for sim_name %s softc %p\n",
__func__, sim_name, softc));
sim = cam_sim_alloc(sim_action, sim_poll, sim_name, softc,
device_get_unit(dev), mtx, max_dev_transactions,
max_tagged_dev_transactions, queue);
if (sim != NULL)
sim->sim_dev = dev;
return (sim);
}
void
cam_sim_free(struct cam_sim *sim, int free_devq)
{
struct mtx *mtx;
int error;
if (sim->mtx == NULL) {
mtx = &cam_sim_free_mtx;
mtx_lock(mtx);
} else {
mtx = sim->mtx;
mtx_assert(mtx, MA_OWNED);
}
KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
sim->refcount--;
if (sim->refcount > 0) {
error = msleep(sim, mtx, PRIBIO, "simfree", 0);
KASSERT(error == 0, ("invalid error value for msleep(9)"));
}
KASSERT(sim->refcount == 0, ("sim->refcount == 0"));
if (mtx == &cam_sim_free_mtx) /* sim->mtx == NULL */
mtx_unlock(mtx);
if (free_devq)
cam_simq_free(sim->devq);
free(sim, M_CAMSIM);
}
void
cam_sim_release(struct cam_sim *sim)
{
struct mtx *mtx;
if (sim->mtx == NULL)
mtx = &cam_sim_free_mtx;
else if (!mtx_owned(sim->mtx))
mtx = sim->mtx;
else
mtx = NULL; /* We hold the lock. */
if (mtx)
mtx_lock(mtx);
KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
sim->refcount--;
if (sim->refcount == 0)
wakeup(sim);
if (mtx)
mtx_unlock(mtx);
}
void
cam_sim_hold(struct cam_sim *sim)
{
struct mtx *mtx;
if (sim->mtx == NULL)
mtx = &cam_sim_free_mtx;
else if (!mtx_owned(sim->mtx))
mtx = sim->mtx;
else
mtx = NULL; /* We hold the lock. */
if (mtx)
mtx_lock(mtx);
KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
sim->refcount++;
if (mtx)
mtx_unlock(mtx);
}
void
cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
{
sim->path_id = path_id;
}
|
