2 * SPDX-License-Identifier: BSD-2-Clause
6 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
43 #include <sys/mutex.h>
44 #include <sys/types.h>
45 #include <sys/malloc.h>
48 #include <machine/bus.h>
49 #include <machine/resource.h>
52 #include <cam/cam_ccb.h>
53 #include <cam/cam_sim.h>
54 #include <cam/cam_xpt_sim.h>
56 #include <dev/isci/environment.h>
57 #include <dev/isci/scil/intel_pci.h>
59 #include <dev/isci/scil/sci_types.h>
60 #include <dev/isci/scil/sci_object.h>
61 #include <dev/isci/scil/sci_status.h>
62 #include <dev/isci/scil/sci_pool.h>
63 #include <dev/isci/scil/sci_fast_list.h>
65 #include <dev/isci/scil/sci_controller_constants.h>
67 #include <dev/isci/scil/scic_controller.h>
68 #include <dev/isci/scil/scic_config_parameters.h>
70 #define DEVICE2SOFTC(dev) ((struct isci_softc *) device_get_softc(dev))
72 #define DEVICE_TIMEOUT 1000
73 #define SCI_MAX_TIMERS 32
75 #define ISCI_NUM_PCI_BARS 2
76 #define ISCI_MAX_LUN 8
78 /* This device cannot DMA across a 4GB boundary */
79 #define ISCI_DMA_BOUNDARY ((bus_addr_t)((uint64_t)1 << 32))
81 MALLOC_DECLARE(M_ISCI);
84 struct callout callout;
85 SCI_TIMER_CALLBACK_T callback;
90 struct ISCI_REMOTE_DEVICE {
92 struct ISCI_DOMAIN *domain;
93 SCI_REMOTE_DEVICE_HANDLE_T sci_object;
95 uint32_t frozen_lun_mask;
96 SCI_FAST_LIST_ELEMENT_T pending_device_reset_element;
99 * This queue maintains CCBs that have been returned with
100 * SCI_IO_FAILURE_INVALID_STATE from the SCI layer. These CCBs
101 * need to be retried, but we cannot return CAM_REQUEUE_REQ because
102 * this status gets passed all the way back up to users of the pass(4)
103 * interface and breaks things like smartctl. So instead, we queue
104 * these CCBs internally.
106 TAILQ_HEAD(,ccb_hdr) queued_ccbs;
109 * Marker denoting this remote device needs its first queued ccb to
112 BOOL release_queued_ccb;
115 * Points to a CCB in the queue that is currently being processed by
116 * SCIL. This allows us to keep in flight CCBs in the queue so as to
117 * maintain ordering (i.e. in case we retry an I/O and then find out
118 * it needs to be retried again - it just keeps its same place in the
121 union ccb * queued_ccb_in_progress;
125 struct ISCI_CONTROLLER *controller;
126 SCI_DOMAIN_HANDLE_T sci_object;
128 struct ISCI_REMOTE_DEVICE *da_remote_device;
133 bus_addr_t physical_address;
134 bus_dma_tag_t dma_tag;
135 bus_dmamap_t dma_map;
136 POINTER_UINT virtual_address;
141 struct ISCI_INTERRUPT_INFO
143 SCIC_CONTROLLER_HANDLER_METHODS_T *handlers;
144 void *interrupt_target_handle;
145 struct resource *res;
153 struct cdev *cdev_fault;
154 struct cdev *cdev_locate;
155 SCI_CONTROLLER_HANDLE_T handle;
161 struct ISCI_CONTROLLER
163 struct isci_softc *isci;
165 SCI_CONTROLLER_HANDLE_T scif_controller_handle;
166 struct ISCI_DOMAIN domain[SCI_MAX_DOMAINS];
168 BOOL has_been_scanned;
169 uint32_t initial_discovery_mask;
171 BOOL release_queued_ccbs;
172 BOOL fail_on_task_timeout;
173 uint8_t *remote_device_memory;
174 struct ISCI_MEMORY cached_controller_memory;
175 struct ISCI_MEMORY uncached_controller_memory;
176 struct ISCI_MEMORY request_memory;
177 bus_dma_tag_t buffer_dma_tag;
180 struct cam_path *path;
181 struct ISCI_REMOTE_DEVICE *remote_device[SCI_MAX_REMOTE_DEVICES];
183 SCIC_OEM_PARAMETERS_T oem_parameters;
184 uint32_t oem_parameters_version;
185 uint32_t queue_depth;
186 uint32_t sim_queue_depth;
187 SCI_FAST_LIST_T pending_device_reset_list;
188 struct ISCI_PHY phys[SCI_MAX_PHYS];
190 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl;
192 SCI_POOL_CREATE(remote_device_pool, struct ISCI_REMOTE_DEVICE *, SCI_MAX_REMOTE_DEVICES);
193 SCI_POOL_CREATE(request_pool, struct ISCI_REQUEST *, SCI_MAX_IO_REQUESTS);
194 SCI_POOL_CREATE(timer_pool, struct ISCI_TIMER *, SCI_MAX_TIMERS);
195 SCI_POOL_CREATE(unmap_buffer_pool, void *, SCI_MAX_REMOTE_DEVICES);
200 SCI_CONTROLLER_HANDLE_T controller_handle;
201 SCI_REMOTE_DEVICE_HANDLE_T remote_device_handle;
202 bus_dma_tag_t dma_tag;
203 bus_dmamap_t dma_map;
204 SCI_PHYSICAL_ADDRESS physical_address;
205 struct callout timer;
208 struct ISCI_IO_REQUEST
210 struct ISCI_REQUEST parent;
211 SCI_IO_REQUEST_HANDLE_T sci_object;
213 uint32_t num_segments;
214 uint32_t current_sge_index;
215 bus_dma_segment_t *sge;
218 struct ISCI_TASK_REQUEST
220 struct ISCI_REQUEST parent;
221 struct scsi_sense_data sense_data;
222 SCI_TASK_REQUEST_HANDLE_T sci_object;
227 struct ISCI_PCI_BAR {
229 bus_space_tag_t bus_tag;
230 bus_space_handle_t bus_handle;
232 struct resource *resource;
237 * One of these per allocated PCI device.
241 struct ISCI_PCI_BAR pci_bar[ISCI_NUM_PCI_BARS];
242 struct ISCI_CONTROLLER controllers[SCI_MAX_CONTROLLERS];
243 SCI_LIBRARY_HANDLE_T sci_library_handle;
244 void * sci_library_memory;
245 SCIC_CONTROLLER_HANDLER_METHODS_T handlers[4];
246 struct ISCI_INTERRUPT_INFO interrupt_info[4];
247 uint32_t controller_count;
248 uint32_t num_interrupts;
249 uint32_t coalesce_number;
250 uint32_t coalesce_timeout;
252 SCI_PCI_COMMON_HEADER_T pci_common_header;
253 BOOL oem_parameters_found;
254 struct intr_config_hook config_hook;
257 int isci_allocate_resources(device_t device);
259 int isci_allocate_dma_buffer(device_t device, struct ISCI_CONTROLLER *lock,
260 struct ISCI_MEMORY *memory);
262 void isci_remote_device_reset(struct ISCI_REMOTE_DEVICE *remote_device,
266 * Returns the negotiated link rate (in KB/s) for the associated
267 * remote device. Used to fill out bitrate field for GET_TRANS_SETTINGS.
268 * Will match the negotiated link rate for the lowest numbered local phy
269 * in the port/domain containing this remote device.
271 uint32_t isci_remote_device_get_bitrate(
272 struct ISCI_REMOTE_DEVICE *remote_device);
274 void isci_remote_device_freeze_lun_queue(
275 struct ISCI_REMOTE_DEVICE *remote_device, lun_id_t lun);
277 void isci_remote_device_release_lun_queue(
278 struct ISCI_REMOTE_DEVICE *remote_device, lun_id_t lun);
280 void isci_remote_device_release_device_queue(
281 struct ISCI_REMOTE_DEVICE * remote_device);
283 void isci_request_construct(struct ISCI_REQUEST *request,
284 SCI_CONTROLLER_HANDLE_T scif_controller_handle,
285 bus_dma_tag_t io_buffer_dma_tag, bus_addr_t physical_address);
287 #define isci_io_request_get_max_io_size() \
288 ((SCI_MAX_SCATTER_GATHER_ELEMENTS - 1) * PAGE_SIZE)
290 #define isci_task_request_get_object_size() \
291 (sizeof(struct ISCI_TASK_REQUEST) + scif_task_request_get_object_size())
293 #define isci_io_request_get_object_size() \
294 (sizeof(struct ISCI_IO_REQUEST) + scif_io_request_get_object_size())
296 #define isci_request_get_object_size() \
298 isci_task_request_get_object_size(), \
299 isci_io_request_get_object_size() \
303 void isci_io_request_execute_scsi_io(union ccb *ccb,
304 struct ISCI_CONTROLLER *controller);
306 #if __FreeBSD_version >= 900026
307 void isci_io_request_execute_smp_io(
308 union ccb *ccb, struct ISCI_CONTROLLER *controller);
311 void isci_io_request_timeout(void *);
313 void isci_get_oem_parameters(struct isci_softc *isci);
315 void isci_io_request_complete(
316 SCI_CONTROLLER_HANDLE_T scif_controller,
317 SCI_REMOTE_DEVICE_HANDLE_T remote_device,
318 struct ISCI_IO_REQUEST * isci_request, SCI_IO_STATUS completion_status);
320 void isci_task_request_complete(
321 SCI_CONTROLLER_HANDLE_T scif_controller,
322 SCI_REMOTE_DEVICE_HANDLE_T remote_device,
323 SCI_TASK_REQUEST_HANDLE_T io_request, SCI_TASK_STATUS completion_status);
325 void isci_sysctl_initialize(struct isci_softc *isci);
327 void isci_controller_construct(struct ISCI_CONTROLLER *controller,
328 struct isci_softc *isci);
330 SCI_STATUS isci_controller_initialize(struct ISCI_CONTROLLER *controller);
332 int isci_controller_allocate_memory(struct ISCI_CONTROLLER *controller);
334 void isci_controller_domain_discovery_complete(
335 struct ISCI_CONTROLLER *isci_controller, struct ISCI_DOMAIN *isci_domain);
337 int isci_controller_attach_to_cam(struct ISCI_CONTROLLER *controller);
339 void isci_controller_start(void *controller);
341 void isci_controller_release_queued_ccbs(struct ISCI_CONTROLLER *controller);
343 void isci_domain_construct(struct ISCI_DOMAIN *domain, uint32_t domain_index,
344 struct ISCI_CONTROLLER *controller);
346 void isci_interrupt_setup(struct isci_softc *isci);
347 void isci_interrupt_poll_handler(struct ISCI_CONTROLLER *controller);
349 void isci_log_message(uint32_t verbosity, char *log_message_prefix,
350 char *log_message, ...);
352 extern uint32_t g_isci_debug_level;
354 #endif /* #ifndef _ISCI_H */