4 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <dev/isci/isci.h>
36 #include <sys/sysctl.h>
37 #include <sys/malloc.h>
39 #include <cam/cam_periph.h>
41 #include <dev/led/led.h>
43 #include <dev/pci/pcireg.h>
44 #include <dev/pci/pcivar.h>
46 #include <dev/isci/scil/scic_logger.h>
47 #include <dev/isci/scil/scic_library.h>
48 #include <dev/isci/scil/scic_sgpio.h>
49 #include <dev/isci/scil/scic_user_callback.h>
51 #include <dev/isci/scil/scif_controller.h>
52 #include <dev/isci/scil/scif_library.h>
53 #include <dev/isci/scil/scif_logger.h>
54 #include <dev/isci/scil/scif_user_callback.h>
56 MALLOC_DEFINE(M_ISCI, "isci", "isci driver memory allocations");
58 struct isci_softc *g_isci;
59 uint32_t g_isci_debug_level = 0;
61 static int isci_probe(device_t);
62 static int isci_attach(device_t);
63 static int isci_detach(device_t);
65 int isci_initialize(struct isci_softc *isci);
67 void isci_allocate_dma_buffer_callback(void *arg, bus_dma_segment_t *seg,
70 static devclass_t isci_devclass;
72 static device_method_t isci_pci_methods[] = {
73 /* Device interface */
74 DEVMETHOD(device_probe, isci_probe),
75 DEVMETHOD(device_attach, isci_attach),
76 DEVMETHOD(device_detach, isci_detach),
80 static driver_t isci_pci_driver = {
83 sizeof(struct isci_softc),
86 DRIVER_MODULE(isci, pci, isci_pci_driver, isci_devclass, 0, 0);
87 MODULE_DEPEND(isci, cam, 1, 1, 1);
94 { 0x1d608086, "Intel(R) C600 Series Chipset SAS Controller" },
95 { 0x1d618086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
96 { 0x1d628086, "Intel(R) C600 Series Chipset SAS Controller" },
97 { 0x1d638086, "Intel(R) C600 Series Chipset SAS Controller" },
98 { 0x1d648086, "Intel(R) C600 Series Chipset SAS Controller" },
99 { 0x1d658086, "Intel(R) C600 Series Chipset SAS Controller" },
100 { 0x1d668086, "Intel(R) C600 Series Chipset SAS Controller" },
101 { 0x1d678086, "Intel(R) C600 Series Chipset SAS Controller" },
102 { 0x1d688086, "Intel(R) C600 Series Chipset SAS Controller" },
103 { 0x1d698086, "Intel(R) C600 Series Chipset SAS Controller" },
104 { 0x1d6a8086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
105 { 0x1d6b8086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
106 { 0x1d6c8086, "Intel(R) C600 Series Chipset SAS Controller" },
107 { 0x1d6d8086, "Intel(R) C600 Series Chipset SAS Controller" },
108 { 0x1d6e8086, "Intel(R) C600 Series Chipset SAS Controller" },
109 { 0x1d6f8086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
114 isci_probe (device_t device)
116 u_int32_t type = pci_get_devid(device);
117 struct _pcsid *ep = pci_ids;
119 while (ep->type && ep->type != type)
124 device_set_desc(device, ep->desc);
125 return (BUS_PROBE_DEFAULT);
132 isci_allocate_pci_memory(struct isci_softc *isci)
136 for (i = 0; i < ISCI_NUM_PCI_BARS; i++)
138 struct ISCI_PCI_BAR *pci_bar = &isci->pci_bar[i];
140 pci_bar->resource_id = PCIR_BAR(i*2);
141 pci_bar->resource = bus_alloc_resource(isci->device,
142 SYS_RES_MEMORY, &pci_bar->resource_id, 0, ~0, 1,
145 if(pci_bar->resource == NULL)
146 isci_log_message(0, "ISCI",
147 "unable to allocate pci resource\n");
149 pci_bar->bus_tag = rman_get_bustag(pci_bar->resource);
150 pci_bar->bus_handle =
151 rman_get_bushandle(pci_bar->resource);
159 isci_attach(device_t device)
162 struct isci_softc *isci = DEVICE2SOFTC(device);
165 isci->device = device;
167 isci_allocate_pci_memory(isci);
169 error = isci_initialize(isci);
177 isci_interrupt_setup(isci);
178 isci_sysctl_initialize(isci);
184 isci_detach(device_t device)
186 struct isci_softc *isci = DEVICE2SOFTC(device);
189 for (i = 0; i < isci->controller_count; i++) {
190 struct ISCI_CONTROLLER *controller = &isci->controllers[i];
194 if (controller->scif_controller_handle != NULL) {
195 scic_controller_disable_interrupts(
196 scif_controller_get_scic_handle(controller->scif_controller_handle));
198 mtx_lock(&controller->lock);
199 status = scif_controller_stop(controller->scif_controller_handle, 0);
200 mtx_unlock(&controller->lock);
202 while (controller->is_started == TRUE) {
203 /* Now poll for interrupts until the controller stop complete
204 * callback is received.
206 mtx_lock(&controller->lock);
207 isci_interrupt_poll_handler(controller);
208 mtx_unlock(&controller->lock);
212 if(controller->sim != NULL) {
213 mtx_lock(&controller->lock);
214 xpt_free_path(controller->path);
215 xpt_bus_deregister(cam_sim_path(controller->sim));
216 cam_sim_free(controller->sim, TRUE);
217 mtx_unlock(&controller->lock);
221 if (controller->timer_memory != NULL)
222 free(controller->timer_memory, M_ISCI);
224 if (controller->remote_device_memory != NULL)
225 free(controller->remote_device_memory, M_ISCI);
227 for (phy = 0; phy < SCI_MAX_PHYS; phy++) {
228 if (controller->phys[phy].cdev_fault)
229 led_destroy(controller->phys[phy].cdev_fault);
231 if (controller->phys[phy].cdev_locate)
232 led_destroy(controller->phys[phy].cdev_locate);
236 sci_pool_get(controller->unmap_buffer_pool, unmap_buffer);
237 if (unmap_buffer == NULL)
239 contigfree(unmap_buffer, PAGE_SIZE, M_ISCI);
243 /* The SCIF controllers have been stopped, so we can now
244 * free the SCI library memory.
246 if (isci->sci_library_memory != NULL)
247 free(isci->sci_library_memory, M_ISCI);
249 for (i = 0; i < ISCI_NUM_PCI_BARS; i++)
251 struct ISCI_PCI_BAR *pci_bar = &isci->pci_bar[i];
253 if (pci_bar->resource != NULL)
254 bus_release_resource(device, SYS_RES_MEMORY,
255 pci_bar->resource_id, pci_bar->resource);
258 for (i = 0; i < isci->num_interrupts; i++)
260 struct ISCI_INTERRUPT_INFO *interrupt_info;
262 interrupt_info = &isci->interrupt_info[i];
264 if(interrupt_info->tag != NULL)
265 bus_teardown_intr(device, interrupt_info->res,
266 interrupt_info->tag);
268 if(interrupt_info->res != NULL)
269 bus_release_resource(device, SYS_RES_IRQ,
270 rman_get_rid(interrupt_info->res),
271 interrupt_info->res);
273 pci_release_msi(device);
280 isci_initialize(struct isci_softc *isci)
284 uint32_t library_object_size;
285 uint32_t verbosity_mask;
286 uint32_t scic_log_object_mask;
287 uint32_t scif_log_object_mask;
288 uint8_t *header_buffer;
290 library_object_size = scif_library_get_object_size(SCI_MAX_CONTROLLERS);
292 isci->sci_library_memory =
293 malloc(library_object_size, M_ISCI, M_NOWAIT | M_ZERO );
295 isci->sci_library_handle = scif_library_construct(
296 isci->sci_library_memory, SCI_MAX_CONTROLLERS);
298 sci_object_set_association( isci->sci_library_handle, (void *)isci);
300 verbosity_mask = (1<<SCI_LOG_VERBOSITY_ERROR) |
301 (1<<SCI_LOG_VERBOSITY_WARNING) | (1<<SCI_LOG_VERBOSITY_INFO) |
302 (1<<SCI_LOG_VERBOSITY_TRACE);
304 scic_log_object_mask = 0xFFFFFFFF;
305 scic_log_object_mask &= ~SCIC_LOG_OBJECT_COMPLETION_QUEUE;
306 scic_log_object_mask &= ~SCIC_LOG_OBJECT_SSP_IO_REQUEST;
307 scic_log_object_mask &= ~SCIC_LOG_OBJECT_STP_IO_REQUEST;
308 scic_log_object_mask &= ~SCIC_LOG_OBJECT_SMP_IO_REQUEST;
309 scic_log_object_mask &= ~SCIC_LOG_OBJECT_CONTROLLER;
311 scif_log_object_mask = 0xFFFFFFFF;
312 scif_log_object_mask &= ~SCIF_LOG_OBJECT_CONTROLLER;
313 scif_log_object_mask &= ~SCIF_LOG_OBJECT_IO_REQUEST;
315 TUNABLE_INT_FETCH("hw.isci.debug_level", &g_isci_debug_level);
317 sci_logger_enable(sci_object_get_logger(isci->sci_library_handle),
318 scif_log_object_mask, verbosity_mask);
320 sci_logger_enable(sci_object_get_logger(
321 scif_library_get_scic_handle(isci->sci_library_handle)),
322 scic_log_object_mask, verbosity_mask);
324 header_buffer = (uint8_t *)&isci->pci_common_header;
325 for (uint8_t i = 0; i < sizeof(isci->pci_common_header); i++)
326 header_buffer[i] = pci_read_config(isci->device, i, 1);
328 scic_library_set_pci_info(
329 scif_library_get_scic_handle(isci->sci_library_handle),
330 &isci->pci_common_header);
332 isci->oem_parameters_found = FALSE;
334 isci_get_oem_parameters(isci);
336 /* trigger interrupt if 32 completions occur before timeout expires */
337 isci->coalesce_number = 32;
339 /* trigger interrupt if 2 microseconds elapse after a completion occurs,
340 * regardless if "coalesce_number" completions have occurred
342 isci->coalesce_timeout = 2;
344 isci->controller_count = scic_library_get_pci_device_controller_count(
345 scif_library_get_scic_handle(isci->sci_library_handle));
347 for (int index = 0; index < isci->controller_count; index++) {
348 struct ISCI_CONTROLLER *controller = &isci->controllers[index];
349 SCI_CONTROLLER_HANDLE_T scif_controller_handle;
351 controller->index = index;
352 isci_controller_construct(controller, isci);
354 scif_controller_handle = controller->scif_controller_handle;
356 status = isci_controller_initialize(controller);
358 if(status != SCI_SUCCESS) {
359 isci_log_message(0, "ISCI",
360 "isci_controller_initialize FAILED: %x\n",
365 error = isci_controller_allocate_memory(controller);
370 scif_controller_set_interrupt_coalescence(
371 scif_controller_handle, isci->coalesce_number,
372 isci->coalesce_timeout);
375 /* FreeBSD provides us a hook to ensure we get a chance to start
376 * our controllers and complete initial domain discovery before
377 * it searches for the boot device. Once we're done, we'll
378 * disestablish the hook, signaling the kernel that is can proceed
379 * with the boot process.
381 isci->config_hook.ich_func = &isci_controller_start;
382 isci->config_hook.ich_arg = &isci->controllers[0];
384 if (config_intrhook_establish(&isci->config_hook) != 0)
385 isci_log_message(0, "ISCI",
386 "config_intrhook_establish failed!\n");
392 isci_allocate_dma_buffer_callback(void *arg, bus_dma_segment_t *seg,
395 struct ISCI_MEMORY *memory = (struct ISCI_MEMORY *)arg;
397 memory->error = error;
399 if (nseg != 1 || error != 0)
400 isci_log_message(0, "ISCI",
401 "Failed to allocate physically contiguous memory!\n");
403 memory->physical_address = seg->ds_addr;
407 isci_allocate_dma_buffer(device_t device, struct ISCI_MEMORY *memory)
411 status = bus_dma_tag_create(bus_get_dma_tag(device),
412 0x40 /* cacheline alignment */, 0x0, BUS_SPACE_MAXADDR,
413 BUS_SPACE_MAXADDR, NULL, NULL, memory->size,
414 0x1 /* we want physically contiguous */,
415 memory->size, 0, NULL, NULL, &memory->dma_tag);
417 if(status == ENOMEM) {
418 isci_log_message(0, "ISCI", "bus_dma_tag_create failed\n");
422 status = bus_dmamem_alloc(memory->dma_tag,
423 (void **)&memory->virtual_address, BUS_DMA_ZERO, &memory->dma_map);
427 isci_log_message(0, "ISCI", "bus_dmamem_alloc failed\n");
431 status = bus_dmamap_load(memory->dma_tag, memory->dma_map,
432 (void *)memory->virtual_address, memory->size,
433 isci_allocate_dma_buffer_callback, memory, 0);
437 isci_log_message(0, "ISCI", "bus_dmamap_load failed\n");
445 * @brief This callback method asks the user to associate the supplied
446 * lock with an operating environment specific locking construct.
448 * @param[in] controller This parameter specifies the controller with
449 * which this lock is to be associated.
450 * @param[in] lock This parameter specifies the lock for which the
451 * user should associate an operating environment specific
454 * @see The SCI_LOCK_LEVEL enumeration for more information.
459 scif_cb_lock_associate(SCI_CONTROLLER_HANDLE_T controller,
460 SCI_LOCK_HANDLE_T lock)
466 * @brief This callback method asks the user to de-associate the supplied
467 * lock with an operating environment specific locking construct.
469 * @param[in] controller This parameter specifies the controller with
470 * which this lock is to be de-associated.
471 * @param[in] lock This parameter specifies the lock for which the
472 * user should de-associate an operating environment specific
475 * @see The SCI_LOCK_LEVEL enumeration for more information.
480 scif_cb_lock_disassociate(SCI_CONTROLLER_HANDLE_T controller,
481 SCI_LOCK_HANDLE_T lock)
488 * @brief This callback method asks the user to acquire/get the lock.
489 * This method should pend until the lock has been acquired.
491 * @param[in] controller This parameter specifies the controller with
492 * which this lock is associated.
493 * @param[in] lock This parameter specifies the lock to be acquired.
498 scif_cb_lock_acquire(SCI_CONTROLLER_HANDLE_T controller,
499 SCI_LOCK_HANDLE_T lock)
505 * @brief This callback method asks the user to release a lock.
507 * @param[in] controller This parameter specifies the controller with
508 * which this lock is associated.
509 * @param[in] lock This parameter specifies the lock to be released.
514 scif_cb_lock_release(SCI_CONTROLLER_HANDLE_T controller,
515 SCI_LOCK_HANDLE_T lock)
520 * @brief This callback method creates an OS specific deferred task
521 * for internal usage. The handler to deferred task is stored by OS
524 * @param[in] controller This parameter specifies the controller object
525 * with which this callback is associated.
530 scif_cb_start_internal_io_task_create(SCI_CONTROLLER_HANDLE_T controller)
536 * @brief This callback method schedules a OS specific deferred task.
538 * @param[in] controller This parameter specifies the controller
539 * object with which this callback is associated.
540 * @param[in] start_internal_io_task_routine This parameter specifies the
541 * sci start_internal_io routine.
542 * @param[in] context This parameter specifies a handle to a parameter
543 * that will be passed into the "start_internal_io_task_routine"
544 * when it is invoked.
549 scif_cb_start_internal_io_task_schedule(SCI_CONTROLLER_HANDLE_T scif_controller,
550 FUNCPTR start_internal_io_task_routine, void *context)
552 /** @todo Use FreeBSD tasklet to defer this routine to a later time,
553 * rather than calling the routine inline.
555 SCI_START_INTERNAL_IO_ROUTINE sci_start_internal_io_routine =
556 (SCI_START_INTERNAL_IO_ROUTINE)start_internal_io_task_routine;
558 sci_start_internal_io_routine(context);
562 * @brief In this method the user must write to PCI memory via access.
563 * This method is used for access to memory space and IO space.
565 * @param[in] controller The controller for which to read a DWORD.
566 * @param[in] address This parameter depicts the address into
568 * @param[out] write_value This parameter depicts the value being written
569 * into the PCI memory location.
571 * @todo These PCI memory access calls likely needs to be optimized into macros?
574 scic_cb_pci_write_dword(SCI_CONTROLLER_HANDLE_T scic_controller,
575 void *address, uint32_t write_value)
577 SCI_CONTROLLER_HANDLE_T scif_controller =
578 (SCI_CONTROLLER_HANDLE_T) sci_object_get_association(scic_controller);
579 struct ISCI_CONTROLLER *isci_controller =
580 (struct ISCI_CONTROLLER *) sci_object_get_association(scif_controller);
581 struct isci_softc *isci = isci_controller->isci;
582 uint32_t bar = (uint32_t)(((POINTER_UINT)address & 0xF0000000) >> 28);
583 bus_size_t offset = (bus_size_t)((POINTER_UINT)address & 0x0FFFFFFF);
585 bus_space_write_4(isci->pci_bar[bar].bus_tag,
586 isci->pci_bar[bar].bus_handle, offset, write_value);
590 * @brief In this method the user must read from PCI memory via access.
591 * This method is used for access to memory space and IO space.
593 * @param[in] controller The controller for which to read a DWORD.
594 * @param[in] address This parameter depicts the address from
597 * @return The value being returned from the PCI memory location.
599 * @todo This PCI memory access calls likely need to be optimized into macro?
602 scic_cb_pci_read_dword(SCI_CONTROLLER_HANDLE_T scic_controller, void *address)
604 SCI_CONTROLLER_HANDLE_T scif_controller =
605 (SCI_CONTROLLER_HANDLE_T)sci_object_get_association(scic_controller);
606 struct ISCI_CONTROLLER *isci_controller =
607 (struct ISCI_CONTROLLER *)sci_object_get_association(scif_controller);
608 struct isci_softc *isci = isci_controller->isci;
609 uint32_t bar = (uint32_t)(((POINTER_UINT)address & 0xF0000000) >> 28);
610 bus_size_t offset = (bus_size_t)((POINTER_UINT)address & 0x0FFFFFFF);
612 return (bus_space_read_4(isci->pci_bar[bar].bus_tag,
613 isci->pci_bar[bar].bus_handle, offset));
617 * @brief This method is called when the core requires the OS driver
618 * to stall execution. This method is utilized during initialization
619 * or non-performance paths only.
621 * @param[in] microseconds This parameter specifies the number of
622 * microseconds for which to stall. The operating system driver
623 * is allowed to round this value up where necessary.
628 scic_cb_stall_execution(uint32_t microseconds)
635 * @brief In this method the user must return the base address register (BAR)
636 * value for the supplied base address register number.
638 * @param[in] controller The controller for which to retrieve the bar number.
639 * @param[in] bar_number This parameter depicts the BAR index/number to be read.
641 * @return Return a pointer value indicating the contents of the BAR.
642 * @retval NULL indicates an invalid BAR index/number was specified.
643 * @retval All other values indicate a valid VIRTUAL address from the BAR.
646 scic_cb_pci_get_bar(SCI_CONTROLLER_HANDLE_T controller,
650 return ((void *)(POINTER_UINT)((uint32_t)bar_number << 28));
654 * @brief This method informs the SCI Core user that a phy/link became
655 * ready, but the phy is not allowed in the port. In some
656 * situations the underlying hardware only allows for certain phy
657 * to port mappings. If these mappings are violated, then this
660 * @param[in] controller This parameter represents the controller which
662 * @param[in] port This parameter specifies the SCI port object for which
663 * the callback is being invoked.
664 * @param[in] phy This parameter specifies the phy that came ready, but the
665 * phy can't be a valid member of the port.
670 scic_cb_port_invalid_link_up(SCI_CONTROLLER_HANDLE_T controller,
671 SCI_PORT_HANDLE_T port, SCI_PHY_HANDLE_T phy)