1 /* $NetBSD: ahcisatavar.h,v 1.28 2023/09/10 14:04:28 abs Exp $ */ 2 3 /* 4 * Copyright (c) 2006 Manuel Bouyer. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 */ 27 28 #include <dev/ic/ahcisatareg.h> 29 30 #define AHCI_DEBUG 31 32 #define DEBUG_INTR 0x01 33 #define DEBUG_XFERS 0x02 34 #define DEBUG_FUNCS 0x08 35 #define DEBUG_PROBE 0x10 36 #define DEBUG_DETACH 0x20 37 #ifdef AHCI_DEBUG 38 extern int ahcidebug_mask; 39 #define AHCIDEBUG_PRINT(args, level) \ 40 if (ahcidebug_mask & (level)) \ 41 printf args 42 #else 43 #define AHCIDEBUG_PRINT(args, level) 44 #endif 45 46 struct ahci_softc { 47 struct atac_softc sc_atac; 48 bus_space_tag_t sc_ahcit; /* ahci registers mapping */ 49 bus_space_handle_t sc_ahcih; 50 bus_size_t sc_ahcis; 51 bus_dma_tag_t sc_dmat; /* DMA memory mappings: */ 52 void *sc_cmd_hdr; /* command tables and received FIS */ 53 bus_dmamap_t sc_cmd_hdrd; 54 bus_dma_segment_t sc_cmd_hdr_seg; 55 int sc_cmd_hdr_nseg; 56 int sc_atac_capflags; 57 int sc_ahci_quirks; 58 #define AHCI_PCI_QUIRK_FORCE __BIT(0) /* force attach */ 59 #define AHCI_PCI_QUIRK_BAD64 __BIT(1) /* broken 64-bit DMA */ 60 #define AHCI_QUIRK_BADPMP __BIT(2) /* broken PMP support, ignore */ 61 #define AHCI_QUIRK_BADNCQ __BIT(3) /* possibly broken NCQ support, ignore */ 62 63 uint32_t sc_ahci_cap; /* copy of AHCI_CAP */ 64 int sc_ncmds; /* number of command slots */ 65 uint32_t sc_ahci_ports; 66 struct ata_channel *sc_chanarray[AHCI_MAX_PORTS]; 67 struct ahci_channel { 68 struct ata_channel ata_channel; /* generic part */ 69 bus_space_handle_t ahcic_scontrol; 70 bus_space_handle_t ahcic_sstatus; 71 bus_space_handle_t ahcic_serror; 72 /* pointers allocated from sc_cmd_hdrd */ 73 struct ahci_r_fis *ahcic_rfis; /* received FIS */ 74 bus_addr_t ahcic_bus_rfis; 75 struct ahci_cmd_header *ahcic_cmdh; /* command headers */ 76 bus_addr_t ahcic_bus_cmdh; 77 /* command tables (allocated per-channel) */ 78 bus_dmamap_t ahcic_cmd_tbld; 79 bus_dma_segment_t ahcic_cmd_tbl_seg; 80 int ahcic_cmd_tbl_nseg; 81 struct ahci_cmd_tbl *ahcic_cmd_tbl[AHCI_MAX_CMDS]; 82 bus_addr_t ahcic_bus_cmd_tbl[AHCI_MAX_CMDS]; 83 bus_dmamap_t ahcic_datad[AHCI_MAX_CMDS]; 84 } sc_channels[AHCI_MAX_PORTS]; 85 86 void (*sc_channel_start)(struct ahci_softc *, struct ata_channel *); 87 void (*sc_channel_stop)(struct ahci_softc *, struct ata_channel *); 88 int (*sc_intr_establish)(struct ahci_softc *, int); 89 90 bool sc_ghc_mrsm; 91 bool sc_save_init_data; 92 struct { 93 uint32_t cap; 94 uint32_t cap2; 95 uint32_t ports; 96 } sc_init_data; 97 }; 98 99 #define AHCINAME(sc) (device_xname((sc)->sc_atac.atac_dev)) 100 101 #define AHCI_CMDH_SYNC(sc, achp, cmd, op) bus_dmamap_sync((sc)->sc_dmat, \ 102 (sc)->sc_cmd_hdrd, \ 103 (char *)(&(achp)->ahcic_cmdh[(cmd)]) - (char *)(sc)->sc_cmd_hdr, \ 104 sizeof(struct ahci_cmd_header), (op)) 105 #define AHCI_RFIS_SYNC(sc, achp, op) bus_dmamap_sync((sc)->sc_dmat, \ 106 (sc)->sc_cmd_hdrd, \ 107 (char *)(achp)->ahcic_rfis - (char *)(sc)->sc_cmd_hdr, \ 108 AHCI_RFIS_SIZE, (op)) 109 #define AHCI_CMDTBL_SYNC(sc, achp, cmd, op) bus_dmamap_sync((sc)->sc_dmat, \ 110 (achp)->ahcic_cmd_tbld, AHCI_CMDTBL_SIZE * (cmd), \ 111 AHCI_CMDTBL_SIZE, (op)) 112 113 #define AHCI_READ(sc, reg) bus_space_read_4((sc)->sc_ahcit, \ 114 (sc)->sc_ahcih, (reg)) 115 #define AHCI_WRITE(sc, reg, val) bus_space_write_4((sc)->sc_ahcit, \ 116 (sc)->sc_ahcih, (reg), (val)) 117 118 #define AHCI_CH2SC(chp) (struct ahci_softc *)((chp)->ch_atac) 119 120 void ahci_attach(struct ahci_softc *); 121 int ahci_detach(struct ahci_softc *, int); 122 void ahci_childdetached(struct ahci_softc *, device_t); 123 void ahci_resume(struct ahci_softc *); 124 125 int ahci_intr(void *); 126 int ahci_intr_port(void *); 127 128