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$ 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 49 struct xpt_xport { 50 xpt_alloc_device_func alloc_device; 51 xpt_release_device_func reldev; 52 xpt_action_func action; 53 xpt_dev_async_func async; 54 xpt_announce_periph_func announce; 55 }; 56 57 /* 58 * Structure for queueing a device in a run queue. 59 * There is one run queue for allocating new ccbs, 60 * and another for sending ccbs to the controller. 61 */ 62 struct cam_ed_qinfo { 63 cam_pinfo pinfo; 64 struct cam_ed *device; 65 }; 66 67 /* 68 * The CAM EDT (Existing Device Table) contains the device information for 69 * all devices for all busses in the system. The table contains a 70 * cam_ed structure for each device on the bus. 71 */ 72 struct cam_ed { 73 TAILQ_ENTRY(cam_ed) links; 74 struct cam_ed_qinfo alloc_ccb_entry; 75 struct cam_ed_qinfo send_ccb_entry; 76 struct cam_et *target; 77 struct cam_sim *sim; 78 lun_id_t lun_id; 79 struct camq drvq; /* 80 * Queue of type drivers wanting to do 81 * work on this device. 82 */ 83 struct cam_ccbq ccbq; /* Queue of pending ccbs */ 84 struct async_list asyncs; /* Async callback info for this B/T/L */ 85 struct periph_list periphs; /* All attached devices */ 86 u_int generation; /* Generation number */ 87 struct cam_periph *owner; /* Peripheral driver's ownership tag */ 88 void *quirk; /* Oddities about this device */ 89 u_int maxtags; 90 u_int mintags; 91 cam_proto protocol; 92 u_int protocol_version; 93 cam_xport transport; 94 u_int transport_version; 95 struct scsi_inquiry_data inq_data; 96 uint8_t *supported_vpds; 97 uint8_t supported_vpds_len; 98 uint32_t device_id_len; 99 uint8_t *device_id; 100 struct ata_params ident_data; 101 u_int8_t inq_flags; /* 102 * Current settings for inquiry flags. 103 * This allows us to override settings 104 * like disconnection and tagged 105 * queuing for a device. 106 */ 107 u_int8_t queue_flags; /* Queue flags from the control page */ 108 u_int8_t serial_num_len; 109 u_int8_t *serial_num; 110 u_int32_t flags; 111 #define CAM_DEV_UNCONFIGURED 0x01 112 #define CAM_DEV_REL_TIMEOUT_PENDING 0x02 113 #define CAM_DEV_REL_ON_COMPLETE 0x04 114 #define CAM_DEV_REL_ON_QUEUE_EMPTY 0x08 115 #define CAM_DEV_RESIZE_QUEUE_NEEDED 0x10 116 #define CAM_DEV_TAG_AFTER_COUNT 0x20 117 #define CAM_DEV_INQUIRY_DATA_VALID 0x40 118 #define CAM_DEV_IN_DV 0x80 119 #define CAM_DEV_DV_HIT_BOTTOM 0x100 120 #define CAM_DEV_IDENTIFY_DATA_VALID 0x200 121 u_int32_t tag_delay_count; 122 #define CAM_TAG_DELAY_COUNT 5 123 u_int32_t tag_saved_openings; 124 u_int32_t refcount; 125 struct callout callout; 126 }; 127 128 /* 129 * Each target is represented by an ET (Existing Target). These 130 * entries are created when a target is successfully probed with an 131 * identify, and removed when a device fails to respond after a number 132 * of retries, or a bus rescan finds the device missing. 133 */ 134 struct cam_et { 135 TAILQ_HEAD(, cam_ed) ed_entries; 136 TAILQ_ENTRY(cam_et) links; 137 struct cam_eb *bus; 138 target_id_t target_id; 139 u_int32_t refcount; 140 u_int generation; 141 struct timeval last_reset; 142 u_int rpl_size; 143 struct scsi_report_luns_data *luns; 144 }; 145 146 /* 147 * Each bus is represented by an EB (Existing Bus). These entries 148 * are created by calls to xpt_bus_register and deleted by calls to 149 * xpt_bus_deregister. 150 */ 151 struct cam_eb { 152 TAILQ_HEAD(, cam_et) et_entries; 153 TAILQ_ENTRY(cam_eb) links; 154 path_id_t path_id; 155 struct cam_sim *sim; 156 struct timeval last_reset; 157 u_int32_t flags; 158 #define CAM_EB_RUNQ_SCHEDULED 0x01 159 u_int32_t refcount; 160 u_int generation; 161 device_t parent_dev; 162 struct xpt_xport *xport; 163 }; 164 165 struct cam_path { 166 struct cam_periph *periph; 167 struct cam_eb *bus; 168 struct cam_et *target; 169 struct cam_ed *device; 170 }; 171 172 struct xpt_xport * scsi_get_xport(void); 173 struct xpt_xport * ata_get_xport(void); 174 175 struct cam_ed * xpt_alloc_device(struct cam_eb *bus, 176 struct cam_et *target, 177 lun_id_t lun_id); 178 void xpt_acquire_device(struct cam_ed *device); 179 void xpt_release_device(struct cam_ed *device); 180 int xpt_schedule_dev(struct camq *queue, cam_pinfo *dev_pinfo, 181 u_int32_t new_priority); 182 u_int32_t xpt_dev_ccbq_resize(struct cam_path *path, int newopenings); 183 void xpt_start_tags(struct cam_path *path); 184 void xpt_stop_tags(struct cam_path *path); 185 186 MALLOC_DECLARE(M_CAMXPT); 187 188 #endif 189