1 /*-
2 * Copyright 2009 Scott Long
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. The name of the author may not be used to endorse or promote products
12 * derived from this software without specific prior written permission.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/cam/cam_xpt_internal.h 199178 2009-11-11 11:10:36Z mav $
27 */
28
29 #ifndef _CAM_CAM_XPT_INTERNAL_H
30 #define _CAM_CAM_XPT_INTERNAL_H 1
31
32 /* Forward Declarations */
33 struct cam_eb;
34 struct cam_et;
35 struct cam_ed;
36
37 typedef struct cam_ed * (*xpt_alloc_device_func)(struct cam_eb *bus,
38 struct cam_et *target,
39 lun_id_t lun_id);
40 typedef void (*xpt_release_device_func)(struct cam_ed *device);
41 typedef void (*xpt_action_func)(union ccb *start_ccb);
42 typedef void (*xpt_dev_async_func)(u_int32_t async_code,
43 struct cam_eb *bus,
44 struct cam_et *target,
45 struct cam_ed *device,
46 void *async_arg);
47 typedef void (*xpt_announce_periph_func)(struct cam_periph *periph,
48 char *announce_string);
49
50 struct xpt_xport {
51 xpt_alloc_device_func alloc_device;
52 xpt_release_device_func reldev;
53 xpt_action_func action;
54 xpt_dev_async_func async;
55 xpt_announce_periph_func announce;
56 };
57
58 /*
59 * Structure for queueing a device in a run queue.
60 * There is one run queue for allocating new ccbs,
61 * and another for sending ccbs to the controller.
62 */
63 struct cam_ed_qinfo {
64 cam_pinfo pinfo;
65 struct cam_ed *device;
66 };
67
68 /*
69 * The CAM EDT (Existing Device Table) contains the device information for
70 * all devices for all busses in the system. The table contains a
71 * cam_ed structure for each device on the bus.
72 */
73 struct cam_ed {
74 TAILQ_ENTRY(cam_ed) links;
75 struct cam_ed_qinfo alloc_ccb_entry;
76 struct cam_ed_qinfo send_ccb_entry;
77 struct cam_et *target;
78 struct cam_sim *sim;
79 lun_id_t lun_id;
80 struct camq drvq; /*
81 * Queue of type drivers wanting to do
82 * work on this device.
83 */
84 struct cam_ccbq ccbq; /* Queue of pending ccbs */
85 struct async_list asyncs; /* Async callback info for this B/T/L */
86 struct periph_list periphs; /* All attached devices */
87 u_int generation; /* Generation number */
88 struct cam_periph *owner; /* Peripheral driver's ownership tag */
89 void *quirk; /* Oddities about this device */
90 u_int maxtags;
91 u_int mintags;
92 cam_proto protocol;
93 u_int protocol_version;
94 cam_xport transport;
95 u_int transport_version;
96 struct scsi_inquiry_data inq_data;
97 struct ata_params ident_data;
98 u_int8_t inq_flags; /*
99 * Current settings for inquiry flags.
100 * This allows us to override settings
101 * like disconnection and tagged
102 * queuing for a device.
103 */
104 u_int8_t queue_flags; /* Queue flags from the control page */
105 u_int8_t serial_num_len;
106 u_int8_t *serial_num;
107 u_int32_t flags;
108 #define CAM_DEV_UNCONFIGURED 0x01
109 #define CAM_DEV_REL_TIMEOUT_PENDING 0x02
110 #define CAM_DEV_REL_ON_COMPLETE 0x04
111 #define CAM_DEV_REL_ON_QUEUE_EMPTY 0x08
112 #define CAM_DEV_RESIZE_QUEUE_NEEDED 0x10
113 #define CAM_DEV_TAG_AFTER_COUNT 0x20
114 #define CAM_DEV_INQUIRY_DATA_VALID 0x40
115 #define CAM_DEV_IN_DV 0x80
116 #define CAM_DEV_DV_HIT_BOTTOM 0x100
117 #define CAM_DEV_IDENTIFY_DATA_VALID 0x200
118 u_int32_t tag_delay_count;
119 #define CAM_TAG_DELAY_COUNT 5
120 u_int32_t tag_saved_openings;
121 u_int32_t refcount;
122 struct callout callout;
123 };
124
125 /*
126 * Each target is represented by an ET (Existing Target). These
127 * entries are created when a target is successfully probed with an
128 * identify, and removed when a device fails to respond after a number
129 * of retries, or a bus rescan finds the device missing.
130 */
131 struct cam_et {
132 TAILQ_HEAD(, cam_ed) ed_entries;
133 TAILQ_ENTRY(cam_et) links;
134 struct cam_eb *bus;
135 target_id_t target_id;
136 u_int32_t refcount;
137 u_int generation;
138 struct timeval last_reset;
139 };
140
141 /*
142 * Each bus is represented by an EB (Existing Bus). These entries
143 * are created by calls to xpt_bus_register and deleted by calls to
144 * xpt_bus_deregister.
145 */
146 struct cam_eb {
147 TAILQ_HEAD(, cam_et) et_entries;
148 TAILQ_ENTRY(cam_eb) links;
149 path_id_t path_id;
150 struct cam_sim *sim;
151 struct timeval last_reset;
152 u_int32_t flags;
153 #define CAM_EB_RUNQ_SCHEDULED 0x01
154 u_int32_t refcount;
155 u_int generation;
156 device_t parent_dev;
157 struct xpt_xport *xport;
158 };
159
160 struct cam_path {
161 struct cam_periph *periph;
162 struct cam_eb *bus;
163 struct cam_et *target;
164 struct cam_ed *device;
165 };
166
167 struct xpt_xport * scsi_get_xport(void);
168 struct xpt_xport * ata_get_xport(void);
169
170 struct cam_ed * xpt_alloc_device(struct cam_eb *bus,
171 struct cam_et *target,
172 lun_id_t lun_id);
173 void xpt_acquire_device(struct cam_ed *device);
174 void xpt_release_device(struct cam_ed *device);
175 void xpt_run_dev_sendq(struct cam_eb *bus);
176 int xpt_schedule_dev(struct camq *queue, cam_pinfo *dev_pinfo,
177 u_int32_t new_priority);
178 u_int32_t xpt_dev_ccbq_resize(struct cam_path *path, int newopenings);
179 void xpt_start_tags(struct cam_path *path);
180 void xpt_stop_tags(struct cam_path *path);
181
182 MALLOC_DECLARE(M_CAMXPT);
183
184 #endif
Cache object: 04b3735283f2ec5f2a926b720076ae67
|