1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright 2009 Scott Long 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 * $FreeBSD$ 29 */ 30 31 #ifndef _CAM_CAM_XPT_INTERNAL_H 32 #define _CAM_CAM_XPT_INTERNAL_H 1 33 34 #include <sys/taskqueue.h> 35 36 /* Forward Declarations */ 37 struct cam_eb; 38 struct cam_et; 39 struct cam_ed; 40 41 typedef struct cam_ed * (*xpt_alloc_device_func)(struct cam_eb *bus, 42 struct cam_et *target, 43 lun_id_t lun_id); 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)(uint32_t async_code, 47 struct cam_eb *bus, 48 struct cam_et *target, 49 struct cam_ed *device, 50 void *async_arg); 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); 53 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_sbuf_func announce_sbuf; 60 }; 61 62 struct xpt_xport { 63 cam_xport xport; 64 const char *name; 65 struct xpt_xport_ops *ops; 66 }; 67 68 SET_DECLARE(cam_xpt_xport_set, struct xpt_xport); 69 #define CAM_XPT_XPORT(data) \ 70 DATA_SET(cam_xpt_xport_set, data) 71 72 typedef void (*xpt_proto_announce_func)(struct cam_ed *); 73 typedef void (*xpt_proto_announce_sbuf_func)(struct cam_ed *, struct sbuf *); 74 typedef void (*xpt_proto_debug_out_func)(union ccb *); 75 76 struct xpt_proto_ops { 77 xpt_proto_announce_sbuf_func announce_sbuf; 78 xpt_proto_announce_sbuf_func denounce_sbuf; 79 xpt_proto_debug_out_func debug_out; 80 }; 81 82 struct xpt_proto { 83 cam_proto proto; 84 const char *name; 85 struct xpt_proto_ops *ops; 86 }; 87 88 SET_DECLARE(cam_xpt_proto_set, struct xpt_proto); 89 #define CAM_XPT_PROTO(data) \ 90 DATA_SET(cam_xpt_proto_set, data) 91 92 /* 93 * The CAM EDT (Existing Device Table) contains the device information for 94 * all devices for all buses in the system. The table contains a 95 * cam_ed structure for each device on the bus. 96 */ 97 struct cam_ed { 98 cam_pinfo devq_entry; 99 TAILQ_ENTRY(cam_ed) links; 100 struct cam_et *target; 101 struct cam_sim *sim; 102 lun_id_t lun_id; 103 struct cam_ccbq ccbq; /* Queue of pending ccbs */ 104 struct async_list asyncs; /* Async callback info for this B/T/L */ 105 struct periph_list periphs; /* All attached devices */ 106 u_int generation; /* Generation number */ 107 void *quirk; /* Oddities about this device */ 108 u_int maxtags; 109 u_int mintags; 110 cam_proto protocol; 111 u_int protocol_version; 112 cam_xport transport; 113 u_int transport_version; 114 struct scsi_inquiry_data inq_data; 115 uint8_t *supported_vpds; 116 uint8_t supported_vpds_len; 117 uint32_t device_id_len; 118 uint8_t *device_id; 119 uint32_t ext_inq_len; 120 uint8_t *ext_inq; 121 uint8_t physpath_len; 122 uint8_t *physpath; /* physical path string form */ 123 uint32_t rcap_len; 124 uint8_t *rcap_buf; 125 struct ata_params ident_data; 126 struct mmc_params mmc_ident_data; 127 uint8_t inq_flags; /* 128 * Current settings for inquiry flags. 129 * This allows us to override settings 130 * like disconnection and tagged 131 * queuing for a device. 132 */ 133 uint8_t queue_flags; /* Queue flags from the control page */ 134 uint8_t serial_num_len; 135 uint8_t *serial_num; 136 uint32_t flags; 137 #define CAM_DEV_UNCONFIGURED 0x01 138 #define CAM_DEV_REL_TIMEOUT_PENDING 0x02 139 #define CAM_DEV_REL_ON_COMPLETE 0x04 140 #define CAM_DEV_REL_ON_QUEUE_EMPTY 0x08 141 #define CAM_DEV_TAG_AFTER_COUNT 0x20 142 #define CAM_DEV_INQUIRY_DATA_VALID 0x40 143 #define CAM_DEV_IN_DV 0x80 144 #define CAM_DEV_DV_HIT_BOTTOM 0x100 145 #define CAM_DEV_IDENTIFY_DATA_VALID 0x200 146 uint32_t tag_delay_count; 147 #define CAM_TAG_DELAY_COUNT 5 148 uint32_t tag_saved_openings; 149 uint32_t refcount; 150 struct callout callout; 151 STAILQ_ENTRY(cam_ed) highpowerq_entry; 152 struct mtx device_mtx; 153 struct task device_destroy_task; 154 struct nvme_controller_data *nvme_cdata; 155 struct nvme_namespace_data *nvme_data; 156 }; 157 158 /* 159 * Each target is represented by an ET (Existing Target). These 160 * entries are created when a target is successfully probed with an 161 * identify, and removed when a device fails to respond after a number 162 * of retries, or a bus rescan finds the device missing. 163 */ 164 struct cam_et { 165 TAILQ_HEAD(, cam_ed) ed_entries; 166 TAILQ_ENTRY(cam_et) links; 167 struct cam_eb *bus; 168 target_id_t target_id; 169 uint32_t refcount; 170 u_int generation; 171 struct timeval last_reset; 172 u_int rpl_size; 173 struct scsi_report_luns_data *luns; 174 struct mtx luns_mtx; /* Protection for luns field. */ 175 }; 176 177 /* 178 * Each bus is represented by an EB (Existing Bus). These entries 179 * are created by calls to xpt_bus_register and deleted by calls to 180 * xpt_bus_deregister. 181 */ 182 struct cam_eb { 183 TAILQ_HEAD(, cam_et) et_entries; 184 TAILQ_ENTRY(cam_eb) links; 185 path_id_t path_id; 186 struct cam_sim *sim; 187 struct timeval last_reset; 188 uint32_t flags; 189 #define CAM_EB_RUNQ_SCHEDULED 0x01 190 uint32_t refcount; 191 u_int generation; 192 device_t parent_dev; 193 struct xpt_xport *xport; 194 struct mtx eb_mtx; /* Bus topology mutex. */ 195 }; 196 197 struct cam_path { 198 struct cam_periph *periph; 199 struct cam_eb *bus; 200 struct cam_et *target; 201 struct cam_ed *device; 202 }; 203 204 struct cam_ed * xpt_alloc_device(struct cam_eb *bus, 205 struct cam_et *target, 206 lun_id_t lun_id); 207 void xpt_acquire_device(struct cam_ed *device); 208 void xpt_release_device(struct cam_ed *device); 209 uint32_t xpt_dev_ccbq_resize(struct cam_path *path, int newopenings); 210 void xpt_start_tags(struct cam_path *path); 211 void xpt_stop_tags(struct cam_path *path); 212 213 MALLOC_DECLARE(M_CAMXPT); 214 215 #endif 216