2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2003 Paul Saab
4 * Copyright (c) 2003 Vinod Kashyap
5 * Copyright (c) 2000 BSDi
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $FreeBSD: src/sys/dev/twe/twe_freebsd.c,v 1.2.2.9 2004/06/11 18:57:31 vkashyap Exp $
30 * $DragonFly: src/sys/dev/raid/twe/twe_freebsd.c,v 1.27 2007/06/17 23:50:16 dillon Exp $
34 * FreeBSD-specific code.
37 #include <dev/raid/twe/twe_compat.h>
38 #include <dev/raid/twe/twereg.h>
39 #include <dev/raid/twe/twe_tables.h>
40 #include <dev/raid/twe/tweio.h>
41 #include <dev/raid/twe/twevar.h>
42 #include <sys/dtype.h>
44 static devclass_t twe_devclass;
47 static u_int32_t twed_bio_in;
48 #define TWED_BIO_IN twed_bio_in++
49 static u_int32_t twed_bio_out;
50 #define TWED_BIO_OUT twed_bio_out++
56 /********************************************************************************
57 ********************************************************************************
58 Control device interface
59 ********************************************************************************
60 ********************************************************************************/
62 static d_open_t twe_open;
63 static d_close_t twe_close;
64 static d_ioctl_t twe_ioctl_wrapper;
66 static struct dev_ops twe_ops = {
67 { "twe", TWE_CDEV_MAJOR, 0 },
70 .d_ioctl = twe_ioctl_wrapper,
73 /********************************************************************************
74 * Accept an open operation on the control device.
77 twe_open(struct dev_open_args *ap)
79 cdev_t dev = ap->a_head.a_dev;
80 int unit = minor(dev);
81 struct twe_softc *sc = devclass_get_softc(twe_devclass, unit);
83 sc->twe_state |= TWE_STATE_OPEN;
87 /********************************************************************************
88 * Accept the last close on the control device.
91 twe_close(struct dev_close_args *ap)
93 cdev_t dev = ap->a_head.a_dev;
94 int unit = minor(dev);
95 struct twe_softc *sc = devclass_get_softc(twe_devclass, unit);
97 sc->twe_state &= ~TWE_STATE_OPEN;
101 /********************************************************************************
102 * Handle controller-specific control operations.
105 twe_ioctl_wrapper(struct dev_ioctl_args *ap)
107 cdev_t dev = ap->a_head.a_dev;
108 struct twe_softc *sc = (struct twe_softc *)dev->si_drv1;
110 return(twe_ioctl(sc, ap->a_cmd, ap->a_data));
113 /********************************************************************************
114 ********************************************************************************
116 ********************************************************************************
117 ********************************************************************************/
119 static int twe_probe(device_t dev);
120 static int twe_attach(device_t dev);
121 static void twe_free(struct twe_softc *sc);
122 static int twe_detach(device_t dev);
123 static int twe_shutdown(device_t dev);
124 static int twe_suspend(device_t dev);
125 static int twe_resume(device_t dev);
126 static void twe_pci_intr(void *arg);
127 static void twe_intrhook(void *arg);
128 static void twe_free_request(struct twe_request *tr);
129 static void twe_setup_data_dmamap(void *arg, bus_dma_segment_t *segs,
130 int nsegments, int error);
131 static void twe_setup_request_dmamap(void *arg, bus_dma_segment_t *segs,
132 int nsegments, int error);
134 static device_method_t twe_methods[] = {
135 /* Device interface */
136 DEVMETHOD(device_probe, twe_probe),
137 DEVMETHOD(device_attach, twe_attach),
138 DEVMETHOD(device_detach, twe_detach),
139 DEVMETHOD(device_shutdown, twe_shutdown),
140 DEVMETHOD(device_suspend, twe_suspend),
141 DEVMETHOD(device_resume, twe_resume),
143 DEVMETHOD(bus_print_child, bus_generic_print_child),
144 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
148 static driver_t twe_pci_driver = {
151 sizeof(struct twe_softc)
155 DRIVER_MODULE(Xtwe, pci, twe_pci_driver, twe_devclass, 0, 0);
157 DRIVER_MODULE(twe, pci, twe_pci_driver, twe_devclass, 0, 0);
160 /********************************************************************************
161 * Match a 3ware Escalade ATA RAID controller.
164 twe_probe(device_t dev)
169 if ((pci_get_vendor(dev) == TWE_VENDOR_ID) &&
170 ((pci_get_device(dev) == TWE_DEVICE_ID) ||
171 (pci_get_device(dev) == TWE_DEVICE_ID_ASIC))) {
172 device_set_desc(dev, TWE_DEVICE_NAME " driver ver. " TWE_DRIVER_VERSION_STRING);
182 /********************************************************************************
183 * Allocate resources, initialise the controller.
186 twe_attach(device_t dev)
188 struct twe_softc *sc;
195 * Initialise the softc structure.
197 sc = device_get_softc(dev);
200 sysctl_ctx_init(&sc->sysctl_ctx);
201 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
202 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
203 device_get_nameunit(dev), CTLFLAG_RD, 0, "");
204 if (sc->sysctl_tree == NULL) {
205 twe_printf(sc, "cannot add sysctl tree node\n");
208 SYSCTL_ADD_STRING(&sc->sysctl_ctx, SYSCTL_CHILDREN(sc->sysctl_tree),
209 OID_AUTO, "driver_version", CTLFLAG_RD, TWE_DRIVER_VERSION_STRING, 0,
210 "TWE driver version");
213 * Make sure we are going to be able to talk to this board.
215 command = pci_read_config(dev, PCIR_COMMAND, 2);
216 if ((command & PCIM_CMD_PORTEN) == 0) {
217 twe_printf(sc, "register window not available\n");
221 * Force the busmaster enable bit on, in case the BIOS forgot.
223 command |= PCIM_CMD_BUSMASTEREN;
224 pci_write_config(dev, PCIR_COMMAND, command, 2);
227 * Allocate the PCI register window.
229 rid = TWE_IO_CONFIG_REG;
230 if ((sc->twe_io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1, RF_ACTIVE)) == NULL) {
231 twe_printf(sc, "can't allocate register window\n");
235 sc->twe_btag = rman_get_bustag(sc->twe_io);
236 sc->twe_bhandle = rman_get_bushandle(sc->twe_io);
239 * Allocate the parent bus DMA tag appropriate for PCI.
241 if (bus_dma_tag_create(NULL, /* parent */
242 1, 0, /* alignment, boundary */
243 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
244 BUS_SPACE_MAXADDR, /* highaddr */
245 NULL, NULL, /* filter, filterarg */
246 MAXBSIZE, TWE_MAX_SGL_LENGTH, /* maxsize, nsegments */
247 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
248 BUS_DMA_ALLOCNOW, /* flags */
249 &sc->twe_parent_dmat)) {
250 twe_printf(sc, "can't allocate parent DMA tag\n");
256 * Allocate and connect our interrupt.
259 if ((sc->twe_irq = bus_alloc_resource(sc->twe_dev, SYS_RES_IRQ, &rid, 0, ~0, 1, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
260 twe_printf(sc, "can't allocate interrupt\n");
264 if (bus_setup_intr(sc->twe_dev, sc->twe_irq, 0,
265 twe_pci_intr, sc, &sc->twe_intr, NULL)) {
266 twe_printf(sc, "can't set up interrupt\n");
272 * Create DMA tag for mapping objects into controller-addressable space.
274 if (bus_dma_tag_create(sc->twe_parent_dmat, /* parent */
275 1, 0, /* alignment, boundary */
276 BUS_SPACE_MAXADDR, /* lowaddr */
277 BUS_SPACE_MAXADDR, /* highaddr */
278 NULL, NULL, /* filter, filterarg */
279 MAXBSIZE, TWE_MAX_SGL_LENGTH,/* maxsize, nsegments */
280 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
282 &sc->twe_buffer_dmat)) {
283 twe_printf(sc, "can't allocate data buffer DMA tag\n");
289 * Initialise the controller and driver core.
291 if ((error = twe_setup(sc))) {
297 * Print some information about the controller and configuration.
299 twe_describe_controller(sc);
302 * Create the control device.
304 sc->twe_dev_t = make_dev(&twe_ops, device_get_unit(sc->twe_dev),
305 UID_ROOT, GID_OPERATOR,
306 S_IRUSR | S_IWUSR, "twe%d",
307 device_get_unit(sc->twe_dev));
308 sc->twe_dev_t->si_drv1 = sc;
311 * Schedule ourselves to bring the controller up once interrupts are
312 * available. This isn't strictly necessary, since we disable
313 * interrupts while probing the controller, but it is more in keeping
314 * with common practice for other disk devices.
316 sc->twe_ich.ich_func = twe_intrhook;
317 sc->twe_ich.ich_arg = sc;
318 if (config_intrhook_establish(&sc->twe_ich) != 0) {
319 twe_printf(sc, "can't establish configuration hook\n");
327 /********************************************************************************
328 * Free all of the resources associated with (sc).
330 * Should not be called if the controller is active.
333 twe_free(struct twe_softc *sc)
335 struct twe_request *tr;
339 /* throw away any command buffers */
340 while ((tr = twe_dequeue_free(sc)) != NULL)
341 twe_free_request(tr);
343 /* destroy the data-transfer DMA tag */
344 if (sc->twe_buffer_dmat)
345 bus_dma_tag_destroy(sc->twe_buffer_dmat);
347 /* disconnect the interrupt handler */
349 bus_teardown_intr(sc->twe_dev, sc->twe_irq, sc->twe_intr);
350 if (sc->twe_irq != NULL)
351 bus_release_resource(sc->twe_dev, SYS_RES_IRQ, 0, sc->twe_irq);
353 /* destroy the parent DMA tag */
354 if (sc->twe_parent_dmat)
355 bus_dma_tag_destroy(sc->twe_parent_dmat);
357 /* release the register window mapping */
358 if (sc->twe_io != NULL)
359 bus_release_resource(sc->twe_dev, SYS_RES_IOPORT, TWE_IO_CONFIG_REG, sc->twe_io);
361 dev_ops_remove_minor(&twe_ops, device_get_unit(sc->twe_dev));
362 /* destroy control device */
363 if (sc->twe_dev_t != (cdev_t)NULL)
364 destroy_dev(sc->twe_dev_t);
366 sysctl_ctx_free(&sc->sysctl_ctx);
369 /********************************************************************************
370 * Disconnect from the controller completely, in preparation for unload.
373 twe_detach(device_t dev)
375 struct twe_softc *sc = device_get_softc(dev);
382 if (sc->twe_state & TWE_STATE_OPEN)
386 * Shut the controller down.
388 if ((error = twe_shutdown(dev)))
399 /********************************************************************************
400 * Bring the controller down to a dormant state and detach all child devices.
402 * Note that we can assume that the bioq on the controller is empty, as we won't
403 * allow shutdown if any device is open.
406 twe_shutdown(device_t dev)
408 struct twe_softc *sc = device_get_softc(dev);
416 * Delete all our child devices.
418 for (i = 0; i < TWE_MAX_UNITS; i++) {
419 if (sc->twe_drive[i].td_disk != 0)
420 if ((error = twe_detach_drive(sc, i)) != 0)
425 * Bring the controller down.
434 /********************************************************************************
435 * Bring the controller to a quiescent state, ready for system suspend.
438 twe_suspend(device_t dev)
440 struct twe_softc *sc = device_get_softc(dev);
445 sc->twe_state |= TWE_STATE_SUSPEND;
447 twe_disable_interrupts(sc);
453 /********************************************************************************
454 * Bring the controller back to a state ready for operation.
457 twe_resume(device_t dev)
459 struct twe_softc *sc = device_get_softc(dev);
463 sc->twe_state &= ~TWE_STATE_SUSPEND;
464 twe_enable_interrupts(sc);
469 /*******************************************************************************
470 * Take an interrupt, or be poked by other code to look for interrupt-worthy
474 twe_pci_intr(void *arg)
476 twe_intr((struct twe_softc *)arg);
479 /********************************************************************************
480 * Delayed-startup hook
483 twe_intrhook(void *arg)
485 struct twe_softc *sc = (struct twe_softc *)arg;
487 /* pull ourselves off the intrhook chain */
488 config_intrhook_disestablish(&sc->twe_ich);
490 /* call core startup routine */
494 /********************************************************************************
495 * Given a detected drive, attach it to the bio interface.
497 * This is called from twe_add_unit.
500 twe_attach_drive(struct twe_softc *sc, struct twe_drive *dr)
505 dr->td_disk = device_add_child(sc->twe_dev, NULL, -1);
506 if (dr->td_disk == NULL) {
507 twe_printf(sc, "Cannot add unit\n");
510 device_set_ivars(dr->td_disk, dr);
513 * XXX It would make sense to test the online/initialising bits, but they seem to be
516 ksprintf(buf, "Unit %d, %s, %s",
518 twe_describe_code(twe_table_unittype, dr->td_type),
519 twe_describe_code(twe_table_unitstate, dr->td_state & TWE_PARAM_UNITSTATUS_MASK));
520 device_set_desc_copy(dr->td_disk, buf);
522 if ((error = bus_generic_attach(sc->twe_dev)) != 0) {
523 twe_printf(sc, "Cannot attach unit to controller. error = %d\n", error);
529 /********************************************************************************
530 * Detach the specified unit if it exsists
532 * This is called from twe_del_unit.
535 twe_detach_drive(struct twe_softc *sc, int unit)
539 if ((error = device_delete_child(sc->twe_dev, sc->twe_drive[unit].td_disk))) {
540 twe_printf(sc, "Cannot delete unit. error = %d\n", error);
543 bzero(&sc->twe_drive[unit], sizeof(sc->twe_drive[unit]));
547 /********************************************************************************
548 * Clear a PCI parity error.
551 twe_clear_pci_parity_error(struct twe_softc *sc)
553 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_PARITY_ERROR);
554 pci_write_config(sc->twe_dev, PCIR_STATUS, TWE_PCI_CLEAR_PARITY_ERROR, 2);
557 /********************************************************************************
561 twe_clear_pci_abort(struct twe_softc *sc)
563 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_PCI_ABORT);
564 pci_write_config(sc->twe_dev, PCIR_STATUS, TWE_PCI_CLEAR_PCI_ABORT, 2);
567 /********************************************************************************
568 ********************************************************************************
570 ********************************************************************************
571 ********************************************************************************/
574 * Disk device bus interface
576 static int twed_probe(device_t dev);
577 static int twed_attach(device_t dev);
578 static int twed_detach(device_t dev);
580 static device_method_t twed_methods[] = {
581 DEVMETHOD(device_probe, twed_probe),
582 DEVMETHOD(device_attach, twed_attach),
583 DEVMETHOD(device_detach, twed_detach),
587 static driver_t twed_driver = {
590 sizeof(struct twed_softc)
593 static devclass_t twed_devclass;
595 DRIVER_MODULE(Xtwed, Xtwe, twed_driver, twed_devclass, 0, 0);
597 DRIVER_MODULE(twed, twe, twed_driver, twed_devclass, 0, 0);
601 * Disk device control interface.
603 static d_open_t twed_open;
604 static d_close_t twed_close;
605 static d_strategy_t twed_strategy;
606 static d_dump_t twed_dump;
608 static struct dev_ops twed_ops = {
609 { "twed", TWED_CDEV_MAJOR, D_DISK },
611 .d_close = twed_close,
613 .d_write = physwrite,
614 .d_strategy = twed_strategy,
619 static int disks_registered = 0;
622 /********************************************************************************
623 * Handle open from generic layer.
625 * Note that this is typically only called by the diskslice code, and not
626 * for opens on subdevices (eg. slices, partitions).
629 twed_open(struct dev_open_args *ap)
631 cdev_t dev = ap->a_head.a_dev;
632 struct twed_softc *sc = (struct twed_softc *)dev->si_drv1;
639 /* check that the controller is up and running */
640 if (sc->twed_controller->twe_state & TWE_STATE_SHUTDOWN)
643 /* build disk info */
644 bzero(&info, sizeof(info));
645 info.d_media_blksize = TWE_BLOCK_SIZE; /* mandatory */
646 info.d_media_blocks = sc->twed_drive->td_size;
648 info.d_type = DTYPE_ESDI; /* optional */
649 info.d_secpertrack = sc->twed_drive->td_sectors;
650 info.d_nheads = sc->twed_drive->td_heads;
651 info.d_ncylinders = sc->twed_drive->td_cylinders;
652 info.d_secpercyl = sc->twed_drive->td_sectors * sc->twed_drive->td_heads;
654 disk_setdiskinfo(&sc->twed_disk, &info);
656 sc->twed_flags |= TWED_OPEN;
660 /********************************************************************************
661 * Handle last close of the disk device.
664 twed_close(struct dev_close_args *ap)
666 cdev_t dev = ap->a_head.a_dev;
667 struct twed_softc *sc = (struct twed_softc *)dev->si_drv1;
674 sc->twed_flags &= ~TWED_OPEN;
678 /********************************************************************************
679 * Handle an I/O request.
682 twed_strategy(struct dev_strategy_args *ap)
684 cdev_t dev = ap->a_head.a_dev;
685 struct bio *bio = ap->a_bio;
686 struct twed_softc *sc = dev->si_drv1;
687 struct buf *bp = bio->bio_buf;
689 bio->bio_driver_info = sc;
696 if ((sc == NULL) || (!sc->twed_drive->td_disk)) {
697 bp->b_error = EINVAL;
698 bp->b_flags |= B_ERROR;
699 kprintf("twe: bio for invalid disk!\n");
705 /* perform accounting */
706 devstat_start_transaction(&sc->twed_stats);
708 /* queue the bio on the controller */
709 twe_enqueue_bio(sc->twed_controller, bio);
711 /* poke the controller to start I/O */
712 twe_startio(sc->twed_controller);
716 /********************************************************************************
717 * System crashdump support
720 twed_dump(struct dev_dump_args *ap)
722 cdev_t dev = ap->a_head.a_dev;
723 struct twed_softc *twed_sc = (struct twed_softc *)dev->si_drv1;
724 struct twe_softc *twe_sc = (struct twe_softc *)twed_sc->twed_controller;
727 int dumppages = MAXDUMPPGS;
731 if (!twed_sc || !twe_sc)
734 blkcnt = howmany(PAGE_SIZE, ap->a_secsize);
736 while (ap->a_count > 0) {
739 if ((ap->a_count / blkcnt) < dumppages)
740 dumppages = ap->a_count / blkcnt;
742 for (i = 0; i < dumppages; ++i) {
743 vm_paddr_t a = addr + (i * PAGE_SIZE);
744 if (is_physical_memory(a))
745 va = pmap_kenter_temporary(trunc_page(a), i);
747 va = pmap_kenter_temporary(trunc_page(0), i);
750 if ((error = twe_dump_blocks(twe_sc, twed_sc->twed_drive->td_twe_unit, ap->a_blkno, va,
751 (PAGE_SIZE * dumppages) / TWE_BLOCK_SIZE)) != 0)
755 if (dumpstatus(addr, (off_t)ap->a_count * DEV_BSIZE) < 0)
758 ap->a_blkno += blkcnt * dumppages;
759 ap->a_count -= blkcnt * dumppages;
760 addr += PAGE_SIZE * dumppages;
765 /********************************************************************************
766 * Handle completion of an I/O request.
769 twed_intr(struct bio *bio)
771 struct buf *bp = bio->bio_buf;
772 struct twed_softc *sc = bio->bio_driver_info;
775 /* if no error, transfer completed */
776 if ((bp->b_flags & B_ERROR) == 0)
778 devstat_end_transaction_buf(&sc->twed_stats, bp);
783 /********************************************************************************
784 * Default probe stub.
787 twed_probe(device_t dev)
792 /********************************************************************************
793 * Attach a unit to the controller.
796 twed_attach(device_t dev)
798 struct twed_softc *sc;
799 struct disk_info info;
805 /* initialise our softc */
806 sc = device_get_softc(dev);
807 parent = device_get_parent(dev);
808 sc->twed_controller = (struct twe_softc *)device_get_softc(parent);
809 sc->twed_drive = device_get_ivars(dev);
810 sc->twed_drive->td_sys_unit = device_get_unit(dev);
813 /* report the drive */
814 twed_printf(sc, "%uMB (%u sectors)\n",
815 sc->twed_drive->td_size / ((1024 * 1024) / TWE_BLOCK_SIZE),
816 sc->twed_drive->td_size);
818 devstat_add_entry(&sc->twed_stats, "twed", sc->twed_drive->td_sys_unit,
820 DEVSTAT_NO_ORDERED_TAGS,
821 DEVSTAT_TYPE_STORARRAY | DEVSTAT_TYPE_IF_OTHER,
822 DEVSTAT_PRIORITY_ARRAY);
824 /* attach a generic disk device to ourselves */
825 dsk = disk_create(sc->twed_drive->td_sys_unit, &sc->twed_disk, &twed_ops);
827 /* dsk->si_drv2 = sc->twed_drive;*/
828 sc->twed_dev_t = dsk;
833 /* set the maximum I/O size to the theoretical maximum allowed by the S/G list size */
834 dsk->si_iosize_max = (TWE_MAX_SGL_LENGTH - 1) * PAGE_SIZE;
837 * Set disk info, as it appears that all needed data is available already.
838 * Setting the disk info will also cause the probing to start.
840 bzero(&info, sizeof(info));
841 info.d_media_blksize = TWE_BLOCK_SIZE; /* mandatory */
842 info.d_media_blocks = sc->twed_drive->td_size;
844 info.d_type = DTYPE_ESDI; /* optional */
845 info.d_secpertrack = sc->twed_drive->td_sectors;
846 info.d_nheads = sc->twed_drive->td_heads;
847 info.d_ncylinders = sc->twed_drive->td_cylinders;
848 info.d_secpercyl = sc->twed_drive->td_sectors * sc->twed_drive->td_heads;
850 disk_setdiskinfo(&sc->twed_disk, &info);
855 /********************************************************************************
856 * Disconnect ourselves from the system.
859 twed_detach(device_t dev)
861 struct twed_softc *sc = (struct twed_softc *)device_get_softc(dev);
865 if (sc->twed_flags & TWED_OPEN)
868 devstat_remove_entry(&sc->twed_stats);
869 disk_destroy(&sc->twed_disk);
871 kprintf("Disks registered: %d\n", disks_registered);
873 if (--disks_registered == 0)
874 dev_ops_remove_all(&tweddisk_ops);
881 /********************************************************************************
882 ********************************************************************************
884 ********************************************************************************
885 ********************************************************************************/
887 MALLOC_DEFINE(TWE_MALLOC_CLASS, "twe commands", "twe commands");
888 /********************************************************************************
889 * Allocate a command buffer
892 twe_allocate_request(struct twe_softc *sc)
894 struct twe_request *tr;
898 * TWE requires requests to be 512-byte aligned. Depend on malloc()
899 * guarenteeing alignment for power-of-2 requests. Note that the old
900 * (FreeBSD-4.x) malloc code aligned all requests, but the new slab
901 * allocator only guarentees same-size alignment for power-of-2 requests.
903 aligned_size = (sizeof(struct twe_request) + TWE_ALIGNMASK) &
905 tr = kmalloc(aligned_size, TWE_MALLOC_CLASS, M_INTWAIT|M_ZERO);
907 if (bus_dmamap_create(sc->twe_buffer_dmat, 0, &tr->tr_cmdmap)) {
908 twe_free_request(tr);
911 bus_dmamap_load(sc->twe_buffer_dmat, tr->tr_cmdmap, &tr->tr_command,
912 sizeof(tr->tr_command), twe_setup_request_dmamap, tr, 0);
913 if (bus_dmamap_create(sc->twe_buffer_dmat, 0, &tr->tr_dmamap)) {
914 bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_cmdmap);
915 twe_free_request(tr);
921 /********************************************************************************
922 * Permanently discard a command buffer.
925 twe_free_request(struct twe_request *tr)
927 struct twe_softc *sc = tr->tr_sc;
931 bus_dmamap_unload(sc->twe_buffer_dmat, tr->tr_cmdmap);
932 bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_cmdmap);
933 bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_dmamap);
934 kfree(tr, TWE_MALLOC_CLASS);
937 /********************************************************************************
938 * Map/unmap (tr)'s command and data in the controller's addressable space.
940 * These routines ensure that the data which the controller is going to try to
941 * access is actually visible to the controller, in a machine-independant
942 * fashion. Due to a hardware limitation, I/O buffers must be 512-byte aligned
943 * and we take care of that here as well.
946 twe_fillin_sgl(TWE_SG_Entry *sgl, bus_dma_segment_t *segs, int nsegments, int max_sgl)
950 for (i = 0; i < nsegments; i++) {
951 sgl[i].address = segs[i].ds_addr;
952 sgl[i].length = segs[i].ds_len;
954 for (; i < max_sgl; i++) { /* XXX necessary? */
961 twe_setup_data_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
963 struct twe_request *tr = (struct twe_request *)arg;
964 TWE_Command *cmd = &tr->tr_command;
968 if (tr->tr_flags & TWE_CMD_MAPPED)
969 panic("already mapped command");
971 tr->tr_flags |= TWE_CMD_MAPPED;
973 if (tr->tr_flags & TWE_CMD_IN_PROGRESS)
974 tr->tr_sc->twe_state &= ~TWE_STATE_FRZN;
975 /* save base of first segment in command (applicable if there only one segment) */
976 tr->tr_dataphys = segs[0].ds_addr;
978 /* correct command size for s/g list size */
979 tr->tr_command.generic.size += 2 * nsegments;
982 * Due to the fact that parameter and I/O commands have the scatter/gather list in
983 * different places, we need to determine which sort of command this actually is
984 * before we can populate it correctly.
986 switch(cmd->generic.opcode) {
987 case TWE_OP_GET_PARAM:
988 case TWE_OP_SET_PARAM:
989 cmd->generic.sgl_offset = 2;
990 twe_fillin_sgl(&cmd->param.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
994 cmd->generic.sgl_offset = 3;
995 twe_fillin_sgl(&cmd->io.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
997 case TWE_OP_ATA_PASSTHROUGH:
998 cmd->generic.sgl_offset = 5;
999 twe_fillin_sgl(&cmd->ata.sgl[0], segs, nsegments, TWE_MAX_ATA_SGL_LENGTH);
1003 * Fall back to what the linux driver does.
1004 * Do this because the API may send an opcode
1005 * the driver knows nothing about and this will
1006 * at least stop PCIABRT's from hosing us.
1008 switch (cmd->generic.sgl_offset) {
1010 twe_fillin_sgl(&cmd->param.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
1013 twe_fillin_sgl(&cmd->io.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
1016 twe_fillin_sgl(&cmd->ata.sgl[0], segs, nsegments, TWE_MAX_ATA_SGL_LENGTH);
1020 if (tr->tr_flags & TWE_CMD_DATAIN)
1021 bus_dmamap_sync(tr->tr_sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_PREREAD);
1022 if (tr->tr_flags & TWE_CMD_DATAOUT) {
1023 /* if we're using an alignment buffer, and we're writing data, copy the real data out */
1024 if (tr->tr_flags & TWE_CMD_ALIGNBUF)
1025 bcopy(tr->tr_realdata, tr->tr_data, tr->tr_length);
1026 bus_dmamap_sync(tr->tr_sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_PREWRITE);
1028 if (twe_start(tr) == EBUSY) {
1029 tr->tr_sc->twe_state |= TWE_STATE_CTLR_BUSY;
1030 twe_requeue_ready(tr);
1035 twe_setup_request_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
1037 struct twe_request *tr = (struct twe_request *)arg;
1041 /* command can't cross a page boundary */
1042 tr->tr_cmdphys = segs[0].ds_addr;
1046 twe_map_request(struct twe_request *tr)
1048 struct twe_softc *sc = tr->tr_sc;
1053 if (sc->twe_state & (TWE_STATE_CTLR_BUSY | TWE_STATE_FRZN)) {
1054 twe_requeue_ready(tr);
1059 * Map the command into bus space.
1061 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_cmdmap, BUS_DMASYNC_PREWRITE);
1064 * If the command involves data, map that too.
1066 if ((tr->tr_data != NULL) && ((tr->tr_flags & TWE_CMD_MAPPED) == 0)) {
1069 * Data must be 512-byte aligned; allocate a fixup buffer if it's not.
1071 * DragonFly's malloc only guarentees alignment for requests which
1072 * are power-of-2 sized.
1074 if (((vm_offset_t)tr->tr_data % TWE_ALIGNMENT) != 0) {
1077 tr->tr_realdata = tr->tr_data; /* save pointer to 'real' data */
1078 aligned_size = TWE_ALIGNMENT;
1079 while (aligned_size < tr->tr_length)
1081 tr->tr_flags |= TWE_CMD_ALIGNBUF;
1082 tr->tr_data = kmalloc(aligned_size, TWE_MALLOC_CLASS, M_INTWAIT);
1083 if (tr->tr_data == NULL) {
1084 twe_printf(sc, "%s: malloc failed\n", __func__);
1085 tr->tr_data = tr->tr_realdata; /* restore original data pointer */
1091 * Map the data buffer into bus space and build the s/g list.
1093 if ((error = bus_dmamap_load(sc->twe_buffer_dmat, tr->tr_dmamap, tr->tr_data,
1094 tr->tr_length, twe_setup_data_dmamap, tr, BUS_DMA_NOWAIT)
1096 tr->tr_flags |= TWE_CMD_IN_PROGRESS;
1097 sc->twe_state |= TWE_STATE_FRZN;
1101 if ((error = twe_start(tr)) == EBUSY) {
1102 sc->twe_state |= TWE_STATE_CTLR_BUSY;
1103 twe_requeue_ready(tr);
1111 twe_unmap_request(struct twe_request *tr)
1113 struct twe_softc *sc = tr->tr_sc;
1117 * Unmap the command from bus space.
1119 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_cmdmap, BUS_DMASYNC_POSTWRITE);
1122 * If the command involved data, unmap that too.
1124 if (tr->tr_data != NULL) {
1126 if (tr->tr_flags & TWE_CMD_DATAIN) {
1127 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_POSTREAD);
1128 /* if we're using an alignment buffer, and we're reading data, copy the real data in */
1129 if (tr->tr_flags & TWE_CMD_ALIGNBUF)
1130 bcopy(tr->tr_data, tr->tr_realdata, tr->tr_length);
1132 if (tr->tr_flags & TWE_CMD_DATAOUT)
1133 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_POSTWRITE);
1135 bus_dmamap_unload(sc->twe_buffer_dmat, tr->tr_dmamap);
1138 /* free alignment buffer if it was used */
1139 if (tr->tr_flags & TWE_CMD_ALIGNBUF) {
1140 kfree(tr->tr_data, TWE_MALLOC_CLASS);
1141 tr->tr_data = tr->tr_realdata; /* restore 'real' data pointer */
1146 void twe_report(void);
1147 /********************************************************************************
1148 * Print current controller status, call from DDB.
1153 struct twe_softc *sc;
1157 for (i = 0; (sc = devclass_get_softc(twe_devclass, i)) != NULL; i++)
1158 twe_print_controller(sc);
1159 kprintf("twed: total bio count in %u out %u\n", twed_bio_in, twed_bio_out);