2 * Copyright 2009 Scott Long
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 #ifndef _CAM_CAM_XPT_INTERNAL_H
30 #define _CAM_CAM_XPT_INTERNAL_H 1
32 #include <sys/taskqueue.h>
34 /* Forward Declarations */
39 typedef struct cam_ed * (*xpt_alloc_device_func)(struct cam_eb *bus,
40 struct cam_et *target,
42 typedef void (*xpt_release_device_func)(struct cam_ed *device);
43 typedef void (*xpt_action_func)(union ccb *start_ccb);
44 typedef void (*xpt_dev_async_func)(u_int32_t async_code,
46 struct cam_et *target,
47 struct cam_ed *device,
49 typedef void (*xpt_announce_periph_func)(struct cam_periph *periph);
50 typedef void (*xpt_announce_periph_sbuf_func)(struct cam_periph *periph, struct sbuf *sbuf);
52 struct xpt_xport_ops {
53 xpt_alloc_device_func alloc_device;
54 xpt_release_device_func reldev;
55 xpt_action_func action;
56 xpt_dev_async_func async;
57 xpt_announce_periph_func announce;
58 xpt_announce_periph_sbuf_func announce_sbuf;
64 struct xpt_xport_ops *ops;
67 SET_DECLARE(cam_xpt_xport_set, struct xpt_xport);
68 #define CAM_XPT_XPORT(data) \
69 DATA_SET(cam_xpt_xport_set, data)
71 typedef void (*xpt_proto_announce_func)(struct cam_ed *);
72 typedef void (*xpt_proto_announce_sbuf_func)(struct cam_ed *, struct sbuf *);
73 typedef void (*xpt_proto_debug_out_func)(union ccb *);
75 struct xpt_proto_ops {
76 xpt_proto_announce_func announce;
77 xpt_proto_announce_sbuf_func announce_sbuf;
78 xpt_proto_announce_func denounce;
79 xpt_proto_announce_sbuf_func denounce_sbuf;
80 xpt_proto_debug_out_func debug_out;
86 struct xpt_proto_ops *ops;
89 SET_DECLARE(cam_xpt_proto_set, struct xpt_proto);
90 #define CAM_XPT_PROTO(data) \
91 DATA_SET(cam_xpt_proto_set, data)
95 * The CAM EDT (Existing Device Table) contains the device information for
96 * all devices for all buses in the system. The table contains a
97 * cam_ed structure for each device on the bus.
100 cam_pinfo devq_entry;
101 TAILQ_ENTRY(cam_ed) links;
102 struct cam_et *target;
105 struct cam_ccbq ccbq; /* Queue of pending ccbs */
106 struct async_list asyncs; /* Async callback info for this B/T/L */
107 struct periph_list periphs; /* All attached devices */
108 u_int generation; /* Generation number */
109 void *quirk; /* Oddities about this device */
113 u_int protocol_version;
115 u_int transport_version;
116 struct scsi_inquiry_data inq_data;
117 uint8_t *supported_vpds;
118 uint8_t supported_vpds_len;
119 uint32_t device_id_len;
121 uint32_t ext_inq_len;
123 uint8_t physpath_len;
124 uint8_t *physpath; /* physical path string form */
127 struct ata_params ident_data;
128 struct mmc_params mmc_ident_data;
129 u_int8_t inq_flags; /*
130 * Current settings for inquiry flags.
131 * This allows us to override settings
132 * like disconnection and tagged
133 * queuing for a device.
135 u_int8_t queue_flags; /* Queue flags from the control page */
136 u_int8_t serial_num_len;
137 u_int8_t *serial_num;
139 #define CAM_DEV_UNCONFIGURED 0x01
140 #define CAM_DEV_REL_TIMEOUT_PENDING 0x02
141 #define CAM_DEV_REL_ON_COMPLETE 0x04
142 #define CAM_DEV_REL_ON_QUEUE_EMPTY 0x08
143 #define CAM_DEV_TAG_AFTER_COUNT 0x20
144 #define CAM_DEV_INQUIRY_DATA_VALID 0x40
145 #define CAM_DEV_IN_DV 0x80
146 #define CAM_DEV_DV_HIT_BOTTOM 0x100
147 #define CAM_DEV_IDENTIFY_DATA_VALID 0x200
148 u_int32_t tag_delay_count;
149 #define CAM_TAG_DELAY_COUNT 5
150 u_int32_t tag_saved_openings;
152 struct callout callout;
153 STAILQ_ENTRY(cam_ed) highpowerq_entry;
154 struct mtx device_mtx;
155 struct task device_destroy_task;
156 const struct nvme_controller_data *nvme_cdata;
157 const struct nvme_namespace_data *nvme_data;
161 * Each target is represented by an ET (Existing Target). These
162 * entries are created when a target is successfully probed with an
163 * identify, and removed when a device fails to respond after a number
164 * of retries, or a bus rescan finds the device missing.
167 TAILQ_HEAD(, cam_ed) ed_entries;
168 TAILQ_ENTRY(cam_et) links;
170 target_id_t target_id;
173 struct timeval last_reset;
175 struct scsi_report_luns_data *luns;
176 struct mtx luns_mtx; /* Protection for luns field. */
180 * Each bus is represented by an EB (Existing Bus). These entries
181 * are created by calls to xpt_bus_register and deleted by calls to
182 * xpt_bus_deregister.
185 TAILQ_HEAD(, cam_et) et_entries;
186 TAILQ_ENTRY(cam_eb) links;
189 struct timeval last_reset;
191 #define CAM_EB_RUNQ_SCHEDULED 0x01
195 struct xpt_xport *xport;
196 struct mtx eb_mtx; /* Bus topology mutex. */
200 struct cam_periph *periph;
202 struct cam_et *target;
203 struct cam_ed *device;
206 struct cam_ed * xpt_alloc_device(struct cam_eb *bus,
207 struct cam_et *target,
209 void xpt_acquire_device(struct cam_ed *device);
210 void xpt_release_device(struct cam_ed *device);
211 u_int32_t xpt_dev_ccbq_resize(struct cam_path *path, int newopenings);
212 void xpt_start_tags(struct cam_path *path);
213 void xpt_stop_tags(struct cam_path *path);
215 MALLOC_DECLARE(M_CAMXPT);