initial commit
[freebsd-arm:freebsd-arm.git] / cam / cam_sim.c
1 /*-
2  * Common functions for SCSI Interface Modules (SIMs).
3  *
4  * Copyright (c) 1997 Justin T. Gibbs.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
15  *
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
26  * SUCH DAMAGE.
27  */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/malloc.h>
35 #include <sys/kernel.h>
36 #include <sys/lock.h>
37 #include <sys/mutex.h>
38
39 #include <cam/cam.h>
40 #include <cam/cam_ccb.h>
41 #include <cam/cam_sim.h>
42 #include <cam/cam_queue.h>
43
44 #define CAM_PATH_ANY (u_int32_t)-1
45
46 MALLOC_DEFINE(M_CAMSIM, "CAM SIM", "CAM SIM buffers");
47
48 struct cam_devq *
49 cam_simq_alloc(u_int32_t max_sim_transactions)
50 {
51         return (cam_devq_alloc(/*size*/0, max_sim_transactions));
52 }
53
54 void
55 cam_simq_free(struct cam_devq *devq)
56 {
57         cam_devq_free(devq);
58 }
59
60 struct cam_sim *
61 cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
62               const char *sim_name, void *softc, u_int32_t unit,
63               struct mtx *mtx, int max_dev_transactions,
64               int max_tagged_dev_transactions, struct cam_devq *queue)
65 {
66         struct cam_sim *sim;
67
68         if (mtx == NULL)
69                 return (NULL);
70
71         sim = (struct cam_sim *)malloc(sizeof(struct cam_sim),
72             M_CAMSIM, M_ZERO | M_NOWAIT);
73
74         if (sim == NULL)
75                 return (NULL);
76
77         sim->sim_action = sim_action;
78         sim->sim_poll = sim_poll;
79         sim->sim_name = sim_name;
80         sim->softc = softc;
81         sim->path_id = CAM_PATH_ANY;
82         sim->unit_number = unit;
83         sim->bus_id = 0;        /* set in xpt_bus_register */
84         sim->max_tagged_dev_openings = max_tagged_dev_transactions;
85         sim->max_dev_openings = max_dev_transactions;
86         sim->flags = 0;
87         sim->refcount = 1;
88         sim->devq = queue;
89         sim->max_ccbs = 8;      /* Reserve for management purposes. */
90         sim->mtx = mtx;
91         if (mtx == &Giant) {
92                 sim->flags |= 0;
93                 callout_init(&sim->callout, 0);
94         } else {
95                 sim->flags |= CAM_SIM_MPSAFE;
96                 callout_init(&sim->callout, 1);
97         }
98
99         SLIST_INIT(&sim->ccb_freeq);
100         TAILQ_INIT(&sim->sim_doneq);
101
102         return (sim);
103 }
104
105 void
106 cam_sim_free(struct cam_sim *sim, int free_devq)
107 {
108         int error;
109
110         sim->refcount--;
111         if (sim->refcount > 0) {
112                 error = msleep(sim, sim->mtx, PRIBIO, "simfree", 0);
113                 KASSERT(error == 0, ("invalid error value for msleep(9)"));
114         }
115
116         KASSERT(sim->refcount == 0, ("sim->refcount == 0"));
117
118         if (free_devq)
119                 cam_simq_free(sim->devq);
120         free(sim, M_CAMSIM);
121 }
122
123 void
124 cam_sim_release(struct cam_sim *sim)
125 {
126         KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
127         mtx_assert(sim->mtx, MA_OWNED);
128
129         sim->refcount--;
130         if (sim->refcount == 0)
131                 wakeup(sim);
132 }
133
134 void
135 cam_sim_hold(struct cam_sim *sim)
136 {
137         KASSERT(sim->refcount >= 1, ("sim->refcount >= 1"));
138         mtx_assert(sim->mtx, MA_OWNED);
139
140         sim->refcount++;
141 }
142
143 void
144 cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
145 {
146         sim->path_id = path_id;
147 }