cam_sim.c revision 116161 
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: head/sys/cam/cam_sim.c 116161 2003-06-10 17:50:20Z obrien $");
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/malloc.h>
35
36#include <cam/cam.h>
37#include <cam/cam_ccb.h>
38#include <cam/cam_sim.h>
39#include <cam/cam_queue.h>
40
41#define CAM_PATH_ANY (u_int32_t)-1
42
43struct cam_devq *
44cam_simq_alloc(u_int32_t max_sim_transactions)
45{
46	return (cam_devq_alloc(/*size*/0, max_sim_transactions));
47}
48
49void
50cam_simq_free(struct cam_devq *devq)
51{
52	cam_devq_free(devq);
53}
54
55struct cam_sim *
56cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
57	      const char *sim_name, void *softc, u_int32_t unit,
58	      int max_dev_transactions,
59	      int max_tagged_dev_transactions, struct cam_devq *queue)
60{
61	struct cam_sim *sim;
62
63	/*
64	 * If this is the xpt layer creating a sim, then it's OK
65	 * to wait for an allocation.
66	 *
67	 * XXX Should we pass in a flag to indicate that wait is OK?
68	 */
69	if (strcmp(sim_name, "xpt") == 0)
70		sim = (struct cam_sim *)malloc(sizeof(struct cam_sim),
71					       M_DEVBUF, M_WAITOK);
72	else
73		sim = (struct cam_sim *)malloc(sizeof(struct cam_sim),
74					       M_DEVBUF, M_NOWAIT);
75
76	if (sim != NULL) {
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		callout_handle_init(&sim->c_handle);
88		sim->devq = queue;
89	}
90
91	return (sim);
92}
93
94void
95cam_sim_free(struct cam_sim *sim, int free_devq)
96{
97	if (free_devq)
98		cam_simq_free(sim->devq);
99	free(sim, M_DEVBUF);
100}
101
102void
103cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
104{
105	sim->path_id = path_id;
106}
107