1 /*- 2 * BSD LICENSE 3 * 4 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 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 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _ISCI_H 34 #define _ISCI_H 35 36 #include <sys/param.h> 37 #include <sys/systm.h> 38 #include <sys/kernel.h> 39 #include <sys/bus.h> 40 #include <sys/lock.h> 41 #include <sys/mutex.h> 42 #include <sys/types.h> 43 #include <sys/malloc.h> 44 #include <sys/rman.h> 45 46 #include <machine/bus.h> 47 #include <machine/resource.h> 48 49 #include <cam/cam.h> 50 #include <cam/cam_ccb.h> 51 #include <cam/cam_sim.h> 52 #include <cam/cam_xpt_sim.h> 53 54 #include <dev/isci/environment.h> 55 #include <dev/isci/scil/intel_pci.h> 56 57 #include <dev/isci/scil/sci_types.h> 58 #include <dev/isci/scil/sci_object.h> 59 #include <dev/isci/scil/sci_status.h> 60 #include <dev/isci/scil/sci_pool.h> 61 #include <dev/isci/scil/sci_fast_list.h> 62 63 #include <dev/isci/scil/sci_controller_constants.h> 64 65 #include <dev/isci/scil/scic_controller.h> 66 #include <dev/isci/scil/scic_config_parameters.h> 67 68 #define DEVICE2SOFTC(dev) ((struct isci_softc *) device_get_softc(dev)) 69 70 #define DEVICE_TIMEOUT 1000 71 #define SCI_MAX_TIMERS 32 72 73 #define ISCI_NUM_PCI_BARS 2 74 #define ISCI_MAX_LUN 8 75 76 MALLOC_DECLARE(M_ISCI); 77 78 struct ISCI_TIMER { 79 struct callout callout; 80 SCI_TIMER_CALLBACK_T callback; 81 void *cookie; 82 BOOL is_started; 83 }; 84 85 struct ISCI_REMOTE_DEVICE { 86 uint32_t index; 87 struct ISCI_DOMAIN *domain; 88 SCI_REMOTE_DEVICE_HANDLE_T sci_object; 89 BOOL is_resetting; 90 uint32_t frozen_lun_mask; 91 SCI_FAST_LIST_ELEMENT_T pending_device_reset_element; 92 93 /* 94 * This queue maintains CCBs that have been returned with 95 * SCI_IO_FAILURE_INVALID_STATE from the SCI layer. These CCBs 96 * need to be retried, but we cannot return CAM_REQUEUE_REQ because 97 * this status gets passed all the way back up to users of the pass(4) 98 * interface and breaks things like smartctl. So instead, we queue 99 * these CCBs internally. 100 */ 101 TAILQ_HEAD(,ccb_hdr) queued_ccbs; 102 103 /* 104 * Marker denoting this remote device needs its first queued ccb to 105 * be retried. 106 */ 107 BOOL release_queued_ccb; 108 109 /* 110 * Points to a CCB in the queue that is currently being processed by 111 * SCIL. This allows us to keep in flight CCBs in the queue so as to 112 * maintain ordering (i.e. in case we retry an I/O and then find out 113 * it needs to be retried again - it just keeps its same place in the 114 * queue. 115 */ 116 union ccb * queued_ccb_in_progress; 117 }; 118 119 struct ISCI_DOMAIN { 120 struct ISCI_CONTROLLER *controller; 121 SCI_DOMAIN_HANDLE_T sci_object; 122 uint8_t index; 123 struct ISCI_REMOTE_DEVICE *da_remote_device; 124 }; 125 126 struct ISCI_MEMORY 127 { 128 bus_addr_t physical_address; 129 bus_dma_tag_t dma_tag; 130 bus_dmamap_t dma_map; 131 POINTER_UINT virtual_address; 132 uint32_t size; 133 int error; 134 }; 135 136 struct ISCI_INTERRUPT_INFO 137 { 138 SCIC_CONTROLLER_HANDLER_METHODS_T *handlers; 139 void *interrupt_target_handle; 140 struct resource *res; 141 int rid; 142 void *tag; 143 144 }; 145 146 struct ISCI_PHY 147 { 148 struct cdev *cdev_fault; 149 struct cdev *cdev_locate; 150 SCI_CONTROLLER_HANDLE_T handle; 151 int index; 152 int led_fault; 153 int led_locate; 154 }; 155 156 struct ISCI_CONTROLLER 157 { 158 struct isci_softc *isci; 159 uint8_t index; 160 SCI_CONTROLLER_HANDLE_T scif_controller_handle; 161 struct ISCI_DOMAIN domain[SCI_MAX_DOMAINS]; 162 BOOL is_started; 163 BOOL has_been_scanned; 164 uint32_t initial_discovery_mask; 165 BOOL is_frozen; 166 BOOL release_queued_ccbs; 167 uint8_t *remote_device_memory; 168 struct ISCI_MEMORY cached_controller_memory; 169 struct ISCI_MEMORY uncached_controller_memory; 170 struct ISCI_MEMORY request_memory; 171 bus_dma_tag_t buffer_dma_tag; 172 struct mtx lock; 173 struct cam_sim *sim; 174 struct cam_path *path; 175 struct ISCI_REMOTE_DEVICE *remote_device[SCI_MAX_REMOTE_DEVICES]; 176 void *timer_memory; 177 SCIC_OEM_PARAMETERS_T oem_parameters; 178 uint32_t oem_parameters_version; 179 uint32_t queue_depth; 180 uint32_t sim_queue_depth; 181 SCI_FAST_LIST_T pending_device_reset_list; 182 struct ISCI_PHY phys[SCI_MAX_PHYS]; 183 184 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl; 185 186 SCI_POOL_CREATE(remote_device_pool, struct ISCI_REMOTE_DEVICE *, SCI_MAX_REMOTE_DEVICES); 187 SCI_POOL_CREATE(request_pool, struct ISCI_REQUEST *, SCI_MAX_IO_REQUESTS); 188 SCI_POOL_CREATE(timer_pool, struct ISCI_TIMER *, SCI_MAX_TIMERS); 189 SCI_POOL_CREATE(unmap_buffer_pool, void *, SCI_MAX_REMOTE_DEVICES); 190 }; 191 192 struct ISCI_REQUEST 193 { 194 SCI_CONTROLLER_HANDLE_T controller_handle; 195 SCI_REMOTE_DEVICE_HANDLE_T remote_device_handle; 196 bus_dma_tag_t dma_tag; 197 bus_dmamap_t dma_map; 198 SCI_PHYSICAL_ADDRESS physical_address; 199 struct callout timer; 200 }; 201 202 struct ISCI_IO_REQUEST 203 { 204 struct ISCI_REQUEST parent; 205 SCI_IO_REQUEST_HANDLE_T sci_object; 206 union ccb *ccb; 207 uint32_t num_segments; 208 uint32_t current_sge_index; 209 bus_dma_segment_t *sge; 210 }; 211 212 struct ISCI_TASK_REQUEST 213 { 214 struct ISCI_REQUEST parent; 215 struct scsi_sense_data sense_data; 216 SCI_TASK_REQUEST_HANDLE_T sci_object; 217 union ccb *ccb; 218 219 }; 220 221 struct ISCI_PCI_BAR { 222 223 bus_space_tag_t bus_tag; 224 bus_space_handle_t bus_handle; 225 int resource_id; 226 struct resource *resource; 227 228 }; 229 230 /* 231 * One of these per allocated PCI device. 232 */ 233 struct isci_softc { 234 235 struct ISCI_PCI_BAR pci_bar[ISCI_NUM_PCI_BARS]; 236 struct ISCI_CONTROLLER controllers[SCI_MAX_CONTROLLERS]; 237 SCI_LIBRARY_HANDLE_T sci_library_handle; 238 void * sci_library_memory; 239 SCIC_CONTROLLER_HANDLER_METHODS_T handlers[4]; 240 struct ISCI_INTERRUPT_INFO interrupt_info[4]; 241 uint32_t controller_count; 242 uint32_t num_interrupts; 243 uint32_t coalesce_number; 244 uint32_t coalesce_timeout; 245 device_t device; 246 SCI_PCI_COMMON_HEADER_T pci_common_header; 247 BOOL oem_parameters_found; 248 struct intr_config_hook config_hook; 249 }; 250 251 int isci_allocate_resources(device_t device); 252 253 int isci_allocate_dma_buffer(device_t device, struct ISCI_MEMORY *memory); 254 255 void isci_remote_device_reset(struct ISCI_REMOTE_DEVICE *remote_device, 256 union ccb *ccb); 257 258 /** 259 * Returns the negotiated link rate (in KB/s) for the associated 260 * remote device. Used to fill out bitrate field for GET_TRANS_SETTINGS. 261 * Will match the negotiated link rate for the lowest numbered local phy 262 * in the port/domain containing this remote device. 263 */ 264 uint32_t isci_remote_device_get_bitrate( 265 struct ISCI_REMOTE_DEVICE *remote_device); 266 267 void isci_remote_device_freeze_lun_queue( 268 struct ISCI_REMOTE_DEVICE *remote_device, lun_id_t lun); 269 270 void isci_remote_device_release_lun_queue( 271 struct ISCI_REMOTE_DEVICE *remote_device, lun_id_t lun); 272 273 void isci_remote_device_release_device_queue( 274 struct ISCI_REMOTE_DEVICE * remote_device); 275 276 void isci_request_construct(struct ISCI_REQUEST *request, 277 SCI_CONTROLLER_HANDLE_T scif_controller_handle, 278 bus_dma_tag_t io_buffer_dma_tag, bus_addr_t physical_address); 279 280 #define isci_io_request_get_max_io_size() \ 281 ((SCI_MAX_SCATTER_GATHER_ELEMENTS - 1) * PAGE_SIZE) 282 283 #define isci_task_request_get_object_size() \ 284 (sizeof(struct ISCI_TASK_REQUEST) + scif_task_request_get_object_size()) 285 286 #define isci_io_request_get_object_size() \ 287 (sizeof(struct ISCI_IO_REQUEST) + scif_io_request_get_object_size()) 288 289 #define isci_request_get_object_size() \ 290 max( \ 291 isci_task_request_get_object_size(), \ 292 isci_io_request_get_object_size() \ 293 ) 294 295 296 void isci_io_request_execute_scsi_io(union ccb *ccb, 297 struct ISCI_CONTROLLER *controller); 298 299 #if __FreeBSD_version >= 900026 300 void isci_io_request_execute_smp_io( 301 union ccb *ccb, struct ISCI_CONTROLLER *controller); 302 #endif 303 304 void isci_io_request_timeout(void *); 305 306 void isci_get_oem_parameters(struct isci_softc *isci); 307 308 void isci_io_request_complete( 309 SCI_CONTROLLER_HANDLE_T scif_controller, 310 SCI_REMOTE_DEVICE_HANDLE_T remote_device, 311 struct ISCI_IO_REQUEST * isci_request, SCI_IO_STATUS completion_status); 312 313 void isci_task_request_complete( 314 SCI_CONTROLLER_HANDLE_T scif_controller, 315 SCI_REMOTE_DEVICE_HANDLE_T remote_device, 316 SCI_TASK_REQUEST_HANDLE_T io_request, SCI_TASK_STATUS completion_status); 317 318 void isci_sysctl_initialize(struct isci_softc *isci); 319 320 void isci_controller_construct(struct ISCI_CONTROLLER *controller, 321 struct isci_softc *isci); 322 323 SCI_STATUS isci_controller_initialize(struct ISCI_CONTROLLER *controller); 324 325 int isci_controller_allocate_memory(struct ISCI_CONTROLLER *controller); 326 327 void isci_controller_domain_discovery_complete( 328 struct ISCI_CONTROLLER *isci_controller, struct ISCI_DOMAIN *isci_domain); 329 330 int isci_controller_attach_to_cam(struct ISCI_CONTROLLER *controller); 331 332 void isci_controller_start(void *controller); 333 334 void isci_controller_release_queued_ccbs(struct ISCI_CONTROLLER *controller); 335 336 void isci_domain_construct(struct ISCI_DOMAIN *domain, uint32_t domain_index, 337 struct ISCI_CONTROLLER *controller); 338 339 void isci_interrupt_setup(struct isci_softc *isci); 340 void isci_interrupt_poll_handler(struct ISCI_CONTROLLER *controller); 341 342 void isci_log_message(uint32_t verbosity, char *log_message_prefix, 343 char *log_message, ...); 344 345 extern uint32_t g_isci_debug_level; 346 347 #endif /* #ifndef _ISCI_H */ 348