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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <dev/isci/isci.h>
38 #include <sys/sysctl.h>
39 #include <sys/malloc.h>
41 #include <cam/cam_periph.h>
43 #include <dev/led/led.h>
45 #include <dev/pci/pcireg.h>
46 #include <dev/pci/pcivar.h>
48 #include <dev/isci/scil/scic_logger.h>
49 #include <dev/isci/scil/scic_library.h>
50 #include <dev/isci/scil/scic_sgpio.h>
51 #include <dev/isci/scil/scic_user_callback.h>
53 #include <dev/isci/scil/scif_controller.h>
54 #include <dev/isci/scil/scif_library.h>
55 #include <dev/isci/scil/scif_logger.h>
56 #include <dev/isci/scil/scif_user_callback.h>
58 MALLOC_DEFINE(M_ISCI, "isci", "isci driver memory allocations");
60 struct isci_softc *g_isci;
61 uint32_t g_isci_debug_level = 0;
63 static int isci_probe(device_t);
64 static int isci_attach(device_t);
65 static int isci_detach(device_t);
67 int isci_initialize(struct isci_softc *isci);
69 void isci_allocate_dma_buffer_callback(void *arg, bus_dma_segment_t *seg,
72 static devclass_t isci_devclass;
74 static device_method_t isci_pci_methods[] = {
75 /* Device interface */
76 DEVMETHOD(device_probe, isci_probe),
77 DEVMETHOD(device_attach, isci_attach),
78 DEVMETHOD(device_detach, isci_detach),
82 static driver_t isci_pci_driver = {
85 sizeof(struct isci_softc),
88 DRIVER_MODULE(isci, pci, isci_pci_driver, isci_devclass, 0, 0);
89 MODULE_DEPEND(isci, cam, 1, 1, 1);
96 { 0x1d608086, "Intel(R) C600 Series Chipset SAS Controller" },
97 { 0x1d618086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
98 { 0x1d628086, "Intel(R) C600 Series Chipset SAS Controller" },
99 { 0x1d638086, "Intel(R) C600 Series Chipset SAS Controller" },
100 { 0x1d648086, "Intel(R) C600 Series Chipset SAS Controller" },
101 { 0x1d658086, "Intel(R) C600 Series Chipset SAS Controller" },
102 { 0x1d668086, "Intel(R) C600 Series Chipset SAS Controller" },
103 { 0x1d678086, "Intel(R) C600 Series Chipset SAS Controller" },
104 { 0x1d688086, "Intel(R) C600 Series Chipset SAS Controller" },
105 { 0x1d698086, "Intel(R) C600 Series Chipset SAS Controller" },
106 { 0x1d6a8086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
107 { 0x1d6b8086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
108 { 0x1d6c8086, "Intel(R) C600 Series Chipset SAS Controller" },
109 { 0x1d6d8086, "Intel(R) C600 Series Chipset SAS Controller" },
110 { 0x1d6e8086, "Intel(R) C600 Series Chipset SAS Controller" },
111 { 0x1d6f8086, "Intel(R) C600 Series Chipset SAS Controller (SATA mode)" },
116 isci_probe (device_t device)
118 u_int32_t type = pci_get_devid(device);
119 struct _pcsid *ep = pci_ids;
121 while (ep->type && ep->type != type)
126 device_set_desc(device, ep->desc);
127 return (BUS_PROBE_DEFAULT);
134 isci_allocate_pci_memory(struct isci_softc *isci)
138 for (i = 0; i < ISCI_NUM_PCI_BARS; i++)
140 struct ISCI_PCI_BAR *pci_bar = &isci->pci_bar[i];
142 pci_bar->resource_id = PCIR_BAR(i*2);
143 pci_bar->resource = bus_alloc_resource_any(isci->device,
144 SYS_RES_MEMORY, &pci_bar->resource_id,
147 if(pci_bar->resource == NULL)
148 isci_log_message(0, "ISCI",
149 "unable to allocate pci resource\n");
151 pci_bar->bus_tag = rman_get_bustag(pci_bar->resource);
152 pci_bar->bus_handle =
153 rman_get_bushandle(pci_bar->resource);
161 isci_attach(device_t device)
164 struct isci_softc *isci = DEVICE2SOFTC(device);
167 isci->device = device;
168 pci_enable_busmaster(device);
170 isci_allocate_pci_memory(isci);
172 error = isci_initialize(isci);
180 isci_interrupt_setup(isci);
181 isci_sysctl_initialize(isci);
187 isci_detach(device_t device)
189 struct isci_softc *isci = DEVICE2SOFTC(device);
192 for (i = 0; i < isci->controller_count; i++) {
193 struct ISCI_CONTROLLER *controller = &isci->controllers[i];
197 if (controller->scif_controller_handle != NULL) {
198 scic_controller_disable_interrupts(
199 scif_controller_get_scic_handle(controller->scif_controller_handle));
201 mtx_lock(&controller->lock);
202 status = scif_controller_stop(controller->scif_controller_handle, 0);
203 mtx_unlock(&controller->lock);
205 while (controller->is_started == TRUE) {
206 /* Now poll for interrupts until the controller stop complete
207 * callback is received.
209 mtx_lock(&controller->lock);
210 isci_interrupt_poll_handler(controller);
211 mtx_unlock(&controller->lock);
215 if(controller->sim != NULL) {
216 mtx_lock(&controller->lock);
217 xpt_free_path(controller->path);
218 xpt_bus_deregister(cam_sim_path(controller->sim));
219 cam_sim_free(controller->sim, TRUE);
220 mtx_unlock(&controller->lock);
224 if (controller->timer_memory != NULL)
225 free(controller->timer_memory, M_ISCI);
227 if (controller->remote_device_memory != NULL)
228 free(controller->remote_device_memory, M_ISCI);
230 for (phy = 0; phy < SCI_MAX_PHYS; phy++) {
231 if (controller->phys[phy].cdev_fault)
232 led_destroy(controller->phys[phy].cdev_fault);
234 if (controller->phys[phy].cdev_locate)
235 led_destroy(controller->phys[phy].cdev_locate);
239 sci_pool_get(controller->unmap_buffer_pool, unmap_buffer);
240 if (unmap_buffer == NULL)
242 contigfree(unmap_buffer, PAGE_SIZE, M_ISCI);
246 /* The SCIF controllers have been stopped, so we can now
247 * free the SCI library memory.
249 if (isci->sci_library_memory != NULL)
250 free(isci->sci_library_memory, M_ISCI);
252 for (i = 0; i < ISCI_NUM_PCI_BARS; i++)
254 struct ISCI_PCI_BAR *pci_bar = &isci->pci_bar[i];
256 if (pci_bar->resource != NULL)
257 bus_release_resource(device, SYS_RES_MEMORY,
258 pci_bar->resource_id, pci_bar->resource);
261 for (i = 0; i < isci->num_interrupts; i++)
263 struct ISCI_INTERRUPT_INFO *interrupt_info;
265 interrupt_info = &isci->interrupt_info[i];
267 if(interrupt_info->tag != NULL)
268 bus_teardown_intr(device, interrupt_info->res,
269 interrupt_info->tag);
271 if(interrupt_info->res != NULL)
272 bus_release_resource(device, SYS_RES_IRQ,
273 rman_get_rid(interrupt_info->res),
274 interrupt_info->res);
276 pci_release_msi(device);
278 pci_disable_busmaster(device);
284 isci_initialize(struct isci_softc *isci)
288 uint32_t library_object_size;
289 uint32_t verbosity_mask;
290 uint32_t scic_log_object_mask;
291 uint32_t scif_log_object_mask;
292 uint8_t *header_buffer;
294 library_object_size = scif_library_get_object_size(SCI_MAX_CONTROLLERS);
296 isci->sci_library_memory =
297 malloc(library_object_size, M_ISCI, M_NOWAIT | M_ZERO );
299 isci->sci_library_handle = scif_library_construct(
300 isci->sci_library_memory, SCI_MAX_CONTROLLERS);
302 sci_object_set_association( isci->sci_library_handle, (void *)isci);
304 verbosity_mask = (1<<SCI_LOG_VERBOSITY_ERROR) |
305 (1<<SCI_LOG_VERBOSITY_WARNING) | (1<<SCI_LOG_VERBOSITY_INFO) |
306 (1<<SCI_LOG_VERBOSITY_TRACE);
308 scic_log_object_mask = 0xFFFFFFFF;
309 scic_log_object_mask &= ~SCIC_LOG_OBJECT_COMPLETION_QUEUE;
310 scic_log_object_mask &= ~SCIC_LOG_OBJECT_SSP_IO_REQUEST;
311 scic_log_object_mask &= ~SCIC_LOG_OBJECT_STP_IO_REQUEST;
312 scic_log_object_mask &= ~SCIC_LOG_OBJECT_SMP_IO_REQUEST;
313 scic_log_object_mask &= ~SCIC_LOG_OBJECT_CONTROLLER;
315 scif_log_object_mask = 0xFFFFFFFF;
316 scif_log_object_mask &= ~SCIF_LOG_OBJECT_CONTROLLER;
317 scif_log_object_mask &= ~SCIF_LOG_OBJECT_IO_REQUEST;
319 TUNABLE_INT_FETCH("hw.isci.debug_level", &g_isci_debug_level);
321 sci_logger_enable(sci_object_get_logger(isci->sci_library_handle),
322 scif_log_object_mask, verbosity_mask);
324 sci_logger_enable(sci_object_get_logger(
325 scif_library_get_scic_handle(isci->sci_library_handle)),
326 scic_log_object_mask, verbosity_mask);
328 header_buffer = (uint8_t *)&isci->pci_common_header;
329 for (uint8_t i = 0; i < sizeof(isci->pci_common_header); i++)
330 header_buffer[i] = pci_read_config(isci->device, i, 1);
332 scic_library_set_pci_info(
333 scif_library_get_scic_handle(isci->sci_library_handle),
334 &isci->pci_common_header);
336 isci->oem_parameters_found = FALSE;
338 isci_get_oem_parameters(isci);
340 /* trigger interrupt if 32 completions occur before timeout expires */
341 isci->coalesce_number = 32;
343 /* trigger interrupt if 2 microseconds elapse after a completion occurs,
344 * regardless if "coalesce_number" completions have occurred
346 isci->coalesce_timeout = 2;
348 isci->controller_count = scic_library_get_pci_device_controller_count(
349 scif_library_get_scic_handle(isci->sci_library_handle));
351 for (int index = 0; index < isci->controller_count; index++) {
352 struct ISCI_CONTROLLER *controller = &isci->controllers[index];
353 SCI_CONTROLLER_HANDLE_T scif_controller_handle;
355 controller->index = index;
356 isci_controller_construct(controller, isci);
358 scif_controller_handle = controller->scif_controller_handle;
360 status = isci_controller_initialize(controller);
362 if(status != SCI_SUCCESS) {
363 isci_log_message(0, "ISCI",
364 "isci_controller_initialize FAILED: %x\n",
369 error = isci_controller_allocate_memory(controller);
374 scif_controller_set_interrupt_coalescence(
375 scif_controller_handle, isci->coalesce_number,
376 isci->coalesce_timeout);
379 /* FreeBSD provides us a hook to ensure we get a chance to start
380 * our controllers and complete initial domain discovery before
381 * it searches for the boot device. Once we're done, we'll
382 * disestablish the hook, signaling the kernel that is can proceed
383 * with the boot process.
385 isci->config_hook.ich_func = &isci_controller_start;
386 isci->config_hook.ich_arg = &isci->controllers[0];
388 if (config_intrhook_establish(&isci->config_hook) != 0)
389 isci_log_message(0, "ISCI",
390 "config_intrhook_establish failed!\n");
396 isci_allocate_dma_buffer_callback(void *arg, bus_dma_segment_t *seg,
399 struct ISCI_MEMORY *memory = (struct ISCI_MEMORY *)arg;
401 memory->error = error;
403 if (nseg != 1 || error != 0)
404 isci_log_message(0, "ISCI",
405 "Failed to allocate physically contiguous memory!\n");
407 memory->physical_address = seg->ds_addr;
411 isci_allocate_dma_buffer(device_t device, struct ISCI_CONTROLLER *controller,
412 struct ISCI_MEMORY *memory)
416 status = bus_dma_tag_create(bus_get_dma_tag(device),
417 0x40 /* cacheline alignment */,
418 ISCI_DMA_BOUNDARY, BUS_SPACE_MAXADDR,
419 BUS_SPACE_MAXADDR, NULL, NULL, memory->size,
420 0x1 /* we want physically contiguous */,
421 memory->size, 0, busdma_lock_mutex, &controller->lock,
424 if(status == ENOMEM) {
425 isci_log_message(0, "ISCI", "bus_dma_tag_create failed\n");
429 status = bus_dmamem_alloc(memory->dma_tag,
430 (void **)&memory->virtual_address, BUS_DMA_ZERO, &memory->dma_map);
434 isci_log_message(0, "ISCI", "bus_dmamem_alloc failed\n");
438 status = bus_dmamap_load(memory->dma_tag, memory->dma_map,
439 (void *)memory->virtual_address, memory->size,
440 isci_allocate_dma_buffer_callback, memory, 0);
444 isci_log_message(0, "ISCI", "bus_dmamap_load failed\n");
452 * @brief This callback method asks the user to associate the supplied
453 * lock with an operating environment specific locking construct.
455 * @param[in] controller This parameter specifies the controller with
456 * which this lock is to be associated.
457 * @param[in] lock This parameter specifies the lock for which the
458 * user should associate an operating environment specific
461 * @see The SCI_LOCK_LEVEL enumeration for more information.
466 scif_cb_lock_associate(SCI_CONTROLLER_HANDLE_T controller,
467 SCI_LOCK_HANDLE_T lock)
473 * @brief This callback method asks the user to de-associate the supplied
474 * lock with an operating environment specific locking construct.
476 * @param[in] controller This parameter specifies the controller with
477 * which this lock is to be de-associated.
478 * @param[in] lock This parameter specifies the lock for which the
479 * user should de-associate an operating environment specific
482 * @see The SCI_LOCK_LEVEL enumeration for more information.
487 scif_cb_lock_disassociate(SCI_CONTROLLER_HANDLE_T controller,
488 SCI_LOCK_HANDLE_T lock)
495 * @brief This callback method asks the user to acquire/get the lock.
496 * This method should pend until the lock has been acquired.
498 * @param[in] controller This parameter specifies the controller with
499 * which this lock is associated.
500 * @param[in] lock This parameter specifies the lock to be acquired.
505 scif_cb_lock_acquire(SCI_CONTROLLER_HANDLE_T controller,
506 SCI_LOCK_HANDLE_T lock)
512 * @brief This callback method asks the user to release a lock.
514 * @param[in] controller This parameter specifies the controller with
515 * which this lock is associated.
516 * @param[in] lock This parameter specifies the lock to be released.
521 scif_cb_lock_release(SCI_CONTROLLER_HANDLE_T controller,
522 SCI_LOCK_HANDLE_T lock)
527 * @brief This callback method creates an OS specific deferred task
528 * for internal usage. The handler to deferred task is stored by OS
531 * @param[in] controller This parameter specifies the controller object
532 * with which this callback is associated.
537 scif_cb_start_internal_io_task_create(SCI_CONTROLLER_HANDLE_T controller)
543 * @brief This callback method schedules a OS specific deferred task.
545 * @param[in] controller This parameter specifies the controller
546 * object with which this callback is associated.
547 * @param[in] start_internal_io_task_routine This parameter specifies the
548 * sci start_internal_io routine.
549 * @param[in] context This parameter specifies a handle to a parameter
550 * that will be passed into the "start_internal_io_task_routine"
551 * when it is invoked.
556 scif_cb_start_internal_io_task_schedule(SCI_CONTROLLER_HANDLE_T scif_controller,
557 FUNCPTR start_internal_io_task_routine, void *context)
559 /** @todo Use FreeBSD tasklet to defer this routine to a later time,
560 * rather than calling the routine inline.
562 SCI_START_INTERNAL_IO_ROUTINE sci_start_internal_io_routine =
563 (SCI_START_INTERNAL_IO_ROUTINE)start_internal_io_task_routine;
565 sci_start_internal_io_routine(context);
569 * @brief In this method the user must write to PCI memory via access.
570 * This method is used for access to memory space and IO space.
572 * @param[in] controller The controller for which to read a DWORD.
573 * @param[in] address This parameter depicts the address into
575 * @param[out] write_value This parameter depicts the value being written
576 * into the PCI memory location.
578 * @todo These PCI memory access calls likely needs to be optimized into macros?
581 scic_cb_pci_write_dword(SCI_CONTROLLER_HANDLE_T scic_controller,
582 void *address, uint32_t write_value)
584 SCI_CONTROLLER_HANDLE_T scif_controller =
585 (SCI_CONTROLLER_HANDLE_T) sci_object_get_association(scic_controller);
586 struct ISCI_CONTROLLER *isci_controller =
587 (struct ISCI_CONTROLLER *) sci_object_get_association(scif_controller);
588 struct isci_softc *isci = isci_controller->isci;
589 uint32_t bar = (uint32_t)(((POINTER_UINT)address & 0xF0000000) >> 28);
590 bus_size_t offset = (bus_size_t)((POINTER_UINT)address & 0x0FFFFFFF);
592 bus_space_write_4(isci->pci_bar[bar].bus_tag,
593 isci->pci_bar[bar].bus_handle, offset, write_value);
597 * @brief In this method the user must read from PCI memory via access.
598 * This method is used for access to memory space and IO space.
600 * @param[in] controller The controller for which to read a DWORD.
601 * @param[in] address This parameter depicts the address from
604 * @return The value being returned from the PCI memory location.
606 * @todo This PCI memory access calls likely need to be optimized into macro?
609 scic_cb_pci_read_dword(SCI_CONTROLLER_HANDLE_T scic_controller, void *address)
611 SCI_CONTROLLER_HANDLE_T scif_controller =
612 (SCI_CONTROLLER_HANDLE_T)sci_object_get_association(scic_controller);
613 struct ISCI_CONTROLLER *isci_controller =
614 (struct ISCI_CONTROLLER *)sci_object_get_association(scif_controller);
615 struct isci_softc *isci = isci_controller->isci;
616 uint32_t bar = (uint32_t)(((POINTER_UINT)address & 0xF0000000) >> 28);
617 bus_size_t offset = (bus_size_t)((POINTER_UINT)address & 0x0FFFFFFF);
619 return (bus_space_read_4(isci->pci_bar[bar].bus_tag,
620 isci->pci_bar[bar].bus_handle, offset));
624 * @brief This method is called when the core requires the OS driver
625 * to stall execution. This method is utilized during initialization
626 * or non-performance paths only.
628 * @param[in] microseconds This parameter specifies the number of
629 * microseconds for which to stall. The operating system driver
630 * is allowed to round this value up where necessary.
635 scic_cb_stall_execution(uint32_t microseconds)
642 * @brief In this method the user must return the base address register (BAR)
643 * value for the supplied base address register number.
645 * @param[in] controller The controller for which to retrieve the bar number.
646 * @param[in] bar_number This parameter depicts the BAR index/number to be read.
648 * @return Return a pointer value indicating the contents of the BAR.
649 * @retval NULL indicates an invalid BAR index/number was specified.
650 * @retval All other values indicate a valid VIRTUAL address from the BAR.
653 scic_cb_pci_get_bar(SCI_CONTROLLER_HANDLE_T controller,
657 return ((void *)(POINTER_UINT)((uint32_t)bar_number << 28));
661 * @brief This method informs the SCI Core user that a phy/link became
662 * ready, but the phy is not allowed in the port. In some
663 * situations the underlying hardware only allows for certain phy
664 * to port mappings. If these mappings are violated, then this
667 * @param[in] controller This parameter represents the controller which
669 * @param[in] port This parameter specifies the SCI port object for which
670 * the callback is being invoked.
671 * @param[in] phy This parameter specifies the phy that came ready, but the
672 * phy can't be a valid member of the port.
677 scic_cb_port_invalid_link_up(SCI_CONTROLLER_HANDLE_T controller,
678 SCI_PORT_HANDLE_T port, SCI_PHY_HANDLE_T phy)