2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright 2009 Scott Long
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 #ifndef _CAM_CAM_XPT_INTERNAL_H
32 #define _CAM_CAM_XPT_INTERNAL_H 1
34 #include <sys/taskqueue.h>
36 /* Forward Declarations */
41 typedef struct cam_ed * (*xpt_alloc_device_func)(struct cam_eb *bus,
42 struct cam_et *target,
44 typedef void (*xpt_release_device_func)(struct cam_ed *device);
45 typedef void (*xpt_action_func)(union ccb *start_ccb);
46 typedef void (*xpt_dev_async_func)(u_int32_t async_code,
48 struct cam_et *target,
49 struct cam_ed *device,
51 typedef void (*xpt_announce_periph_func)(struct cam_periph *periph);
52 typedef void (*xpt_announce_periph_sbuf_func)(struct cam_periph *periph, struct sbuf *sbuf);
54 struct xpt_xport_ops {
55 xpt_alloc_device_func alloc_device;
56 xpt_release_device_func reldev;
57 xpt_action_func action;
58 xpt_dev_async_func async;
59 xpt_announce_periph_func announce;
60 xpt_announce_periph_sbuf_func announce_sbuf;
66 struct xpt_xport_ops *ops;
69 SET_DECLARE(cam_xpt_xport_set, struct xpt_xport);
70 #define CAM_XPT_XPORT(data) \
71 DATA_SET(cam_xpt_xport_set, data)
73 typedef void (*xpt_proto_announce_func)(struct cam_ed *);
74 typedef void (*xpt_proto_announce_sbuf_func)(struct cam_ed *, struct sbuf *);
75 typedef void (*xpt_proto_debug_out_func)(union ccb *);
77 struct xpt_proto_ops {
78 xpt_proto_announce_func announce;
79 xpt_proto_announce_sbuf_func announce_sbuf;
80 xpt_proto_announce_func denounce;
81 xpt_proto_announce_sbuf_func denounce_sbuf;
82 xpt_proto_debug_out_func debug_out;
88 struct xpt_proto_ops *ops;
91 SET_DECLARE(cam_xpt_proto_set, struct xpt_proto);
92 #define CAM_XPT_PROTO(data) \
93 DATA_SET(cam_xpt_proto_set, data)
96 * The CAM EDT (Existing Device Table) contains the device information for
97 * all devices for all buses in the system. The table contains a
98 * cam_ed structure for each device on the bus.
101 cam_pinfo devq_entry;
102 TAILQ_ENTRY(cam_ed) links;
103 struct cam_et *target;
106 struct cam_ccbq ccbq; /* Queue of pending ccbs */
107 struct async_list asyncs; /* Async callback info for this B/T/L */
108 struct periph_list periphs; /* All attached devices */
109 u_int generation; /* Generation number */
110 void *quirk; /* Oddities about this device */
114 u_int protocol_version;
116 u_int transport_version;
117 struct scsi_inquiry_data inq_data;
118 uint8_t *supported_vpds;
119 uint8_t supported_vpds_len;
120 uint32_t device_id_len;
122 uint32_t ext_inq_len;
124 uint8_t physpath_len;
125 uint8_t *physpath; /* physical path string form */
128 struct ata_params ident_data;
129 struct mmc_params mmc_ident_data;
130 u_int8_t inq_flags; /*
131 * Current settings for inquiry flags.
132 * This allows us to override settings
133 * like disconnection and tagged
134 * queuing for a device.
136 u_int8_t queue_flags; /* Queue flags from the control page */
137 u_int8_t serial_num_len;
138 u_int8_t *serial_num;
140 #define CAM_DEV_UNCONFIGURED 0x01
141 #define CAM_DEV_REL_TIMEOUT_PENDING 0x02
142 #define CAM_DEV_REL_ON_COMPLETE 0x04
143 #define CAM_DEV_REL_ON_QUEUE_EMPTY 0x08
144 #define CAM_DEV_TAG_AFTER_COUNT 0x20
145 #define CAM_DEV_INQUIRY_DATA_VALID 0x40
146 #define CAM_DEV_IN_DV 0x80
147 #define CAM_DEV_DV_HIT_BOTTOM 0x100
148 #define CAM_DEV_IDENTIFY_DATA_VALID 0x200
149 u_int32_t tag_delay_count;
150 #define CAM_TAG_DELAY_COUNT 5
151 u_int32_t tag_saved_openings;
153 struct callout callout;
154 STAILQ_ENTRY(cam_ed) highpowerq_entry;
155 struct mtx device_mtx;
156 struct task device_destroy_task;
157 struct nvme_controller_data *nvme_cdata;
158 struct nvme_namespace_data *nvme_data;
162 * Each target is represented by an ET (Existing Target). These
163 * entries are created when a target is successfully probed with an
164 * identify, and removed when a device fails to respond after a number
165 * of retries, or a bus rescan finds the device missing.
168 TAILQ_HEAD(, cam_ed) ed_entries;
169 TAILQ_ENTRY(cam_et) links;
171 target_id_t target_id;
174 struct timeval last_reset;
176 struct scsi_report_luns_data *luns;
177 struct mtx luns_mtx; /* Protection for luns field. */
181 * Each bus is represented by an EB (Existing Bus). These entries
182 * are created by calls to xpt_bus_register and deleted by calls to
183 * xpt_bus_deregister.
186 TAILQ_HEAD(, cam_et) et_entries;
187 TAILQ_ENTRY(cam_eb) links;
190 struct timeval last_reset;
192 #define CAM_EB_RUNQ_SCHEDULED 0x01
196 struct xpt_xport *xport;
197 struct mtx eb_mtx; /* Bus topology mutex. */
201 struct cam_periph *periph;
203 struct cam_et *target;
204 struct cam_ed *device;
207 struct cam_ed * xpt_alloc_device(struct cam_eb *bus,
208 struct cam_et *target,
210 void xpt_acquire_device(struct cam_ed *device);
211 void xpt_release_device(struct cam_ed *device);
212 u_int32_t xpt_dev_ccbq_resize(struct cam_path *path, int newopenings);
213 void xpt_start_tags(struct cam_path *path);
214 void xpt_stop_tags(struct cam_path *path);
216 MALLOC_DECLARE(M_CAMXPT);