xref: /freebsd/sys/cam/cam_sim.c (revision f0a75d274af375d15b97b830966b99a02b7db911)
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 
37 #include <cam/cam.h>
38 #include <cam/cam_ccb.h>
39 #include <cam/cam_sim.h>
40 #include <cam/cam_queue.h>
41 
42 #define CAM_PATH_ANY (u_int32_t)-1
43 
44 MALLOC_DEFINE(M_CAMSIM, "CAM SIM", "CAM SIM buffers");
45 
46 struct cam_devq *
47 cam_simq_alloc(u_int32_t max_sim_transactions)
48 {
49 	return (cam_devq_alloc(/*size*/0, max_sim_transactions));
50 }
51 
52 void
53 cam_simq_free(struct cam_devq *devq)
54 {
55 	cam_devq_free(devq);
56 }
57 
58 struct cam_sim *
59 cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
60 	      const char *sim_name, void *softc, u_int32_t unit,
61 	      int max_dev_transactions,
62 	      int max_tagged_dev_transactions, struct cam_devq *queue)
63 {
64 	struct cam_sim *sim;
65 
66 	/*
67 	 * If this is the xpt layer creating a sim, then it's OK
68 	 * to wait for an allocation.
69 	 *
70 	 * XXX Should we pass in a flag to indicate that wait is OK?
71 	 */
72 	if (strcmp(sim_name, "xpt") == 0)
73 		sim = (struct cam_sim *)malloc(sizeof(struct cam_sim),
74 					       M_CAMSIM, M_WAITOK);
75 	else
76 		sim = (struct cam_sim *)malloc(sizeof(struct cam_sim),
77 					       M_CAMSIM, M_NOWAIT);
78 
79 	if (sim != NULL) {
80 		sim->sim_action = sim_action;
81 		sim->sim_poll = sim_poll;
82 		sim->sim_name = sim_name;
83 		sim->softc = softc;
84 		sim->path_id = CAM_PATH_ANY;
85 		sim->unit_number = unit;
86 		sim->bus_id = 0;	/* set in xpt_bus_register */
87 		sim->max_tagged_dev_openings = max_tagged_dev_transactions;
88 		sim->max_dev_openings = max_dev_transactions;
89 		sim->flags = 0;
90 		callout_handle_init(&sim->c_handle);
91 		sim->devq = queue;
92 	}
93 
94 	return (sim);
95 }
96 
97 void
98 cam_sim_free(struct cam_sim *sim, int free_devq)
99 {
100 	if (free_devq)
101 		cam_simq_free(sim->devq);
102 	free(sim, M_CAMSIM);
103 }
104 
105 void
106 cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
107 {
108 	sim->path_id = path_id;
109 }
110