2 * Copyright (c) 2015 Luiz Otavio O Souza <loos@freebsd.org> All rights reserved.
3 * Copyright (c) 2014-2015 M. Warner Losh <imp@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * The magic-bit-bang sequence used in this code may be based on a linux
27 * platform driver in the Allwinner SDK from Allwinner Technology Co., Ltd.
28 * www.allwinnertech.com, by Daniel Wang <danielwang@allwinnertech.com>
29 * though none of the original code was copied.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/module.h>
44 #include <machine/bus.h>
45 #include <dev/ofw/ofw_bus.h>
46 #include <dev/ofw/ofw_bus_subr.h>
48 #include <dev/ahci/ahci.h>
49 #include <dev/extres/clk/clk.h>
50 #include <dev/extres/regulator/regulator.h>
53 * Allwinner a1x/a2x/a8x SATA attachment. This is just the AHCI register
54 * set with a few extra implementation-specific registers that need to
55 * be accounted for. There's only one PHY in the system, and it needs
56 * to be trained to bring the link up. In addition, there's some DMA
57 * specific things that need to be done as well. These things are also
58 * just about completely undocumented, except in ugly code in the Linux
59 * SDK Allwinner releases.
62 /* BITx -- Unknown bit that needs to be set/cleared at position x */
63 /* UFx -- Uknown multi-bit field frobbed during init */
64 #define AHCI_BISTAFR 0x00A0
65 #define AHCI_BISTCR 0x00A4
66 #define AHCI_BISTFCTR 0x00A8
67 #define AHCI_BISTSR 0x00AC
68 #define AHCI_BISTDECR 0x00B0
69 #define AHCI_DIAGNR 0x00B4
70 #define AHCI_DIAGNR1 0x00B8
71 #define AHCI_OOBR 0x00BC
72 #define AHCI_PHYCS0R 0x00C0
73 /* Bits 0..17 are a mystery */
74 #define PHYCS0R_BIT18 (1 << 18)
75 #define PHYCS0R_POWER_ENABLE (1 << 19)
76 #define PHYCS0R_UF1_MASK (7 << 20) /* Unknown Field 1 */
77 #define PHYCS0R_UF1_INIT (3 << 20)
78 #define PHYCS0R_BIT23 (1 << 23)
79 #define PHYCS0R_UF2_MASK (7 << 24) /* Uknown Field 2 */
80 #define PHYCS0R_UF2_INIT (5 << 24)
82 #define PHYCS0R_POWER_STATUS_MASK (7 << 28)
83 #define PHYCS0R_PS_GOOD (2 << 28)
85 #define AHCI_PHYCS1R 0x00C4
86 /* Bits 0..5 are a mystery */
87 #define PHYCS1R_UF1_MASK (3 << 6)
88 #define PHYCS1R_UF1_INIT (2 << 6)
89 #define PHYCS1R_UF2_MASK (0x1f << 8)
90 #define PHYCS1R_UF2_INIT (6 << 8)
91 /* Bits 13..14 are a mystery */
92 #define PHYCS1R_BIT15 (1 << 15)
93 #define PHYCS1R_UF3_MASK (3 << 16)
94 #define PHYCS1R_UF3_INIT (2 << 16)
96 #define PHYCS1R_HIGHZ (1 << 19)
97 /* Bits 20..27 mystery */
98 #define PHYCS1R_BIT28 (1 << 28)
99 /* Bits 29..31 mystery */
100 #define AHCI_PHYCS2R 0x00C8
101 /* bits 0..4 mystery */
102 #define PHYCS2R_UF1_MASK (0x1f << 5)
103 #define PHYCS2R_UF1_INIT (0x19 << 5)
104 /* Bits 10..23 mystery */
105 #define PHYCS2R_CALIBRATE (1 << 24)
106 /* Bits 25..31 mystery */
107 #define AHCI_TIMER1MS 0x00E0
108 #define AHCI_GPARAM1R 0x00E8
109 #define AHCI_GPARAM2R 0x00EC
110 #define AHCI_PPARAMR 0x00F0
111 #define AHCI_TESTR 0x00F4
112 #define AHCI_VERSIONR 0x00F8
113 #define AHCI_IDR 0x00FC
114 #define AHCI_RWCR 0x00FC
116 #define AHCI_P0DMACR 0x0070
117 #define AHCI_P0PHYCR 0x0078
118 #define AHCI_P0PHYSR 0x007C
120 #define PLL_FREQ 100000000
122 struct ahci_a10_softc {
123 struct ahci_controller ahci_ctlr;
124 regulator_t ahci_reg;
130 ahci_set(struct resource *m, bus_size_t off, uint32_t set)
132 uint32_t val = ATA_INL(m, off);
135 ATA_OUTL(m, off, val);
139 ahci_clr(struct resource *m, bus_size_t off, uint32_t clr)
141 uint32_t val = ATA_INL(m, off);
144 ATA_OUTL(m, off, val);
148 ahci_mask_set(struct resource *m, bus_size_t off, uint32_t mask, uint32_t set)
150 uint32_t val = ATA_INL(m, off);
154 ATA_OUTL(m, off, val);
158 * Should this be phy_reset or phy_init
160 #define PHY_RESET_TIMEOUT 1000
162 ahci_a10_phy_reset(device_t dev)
165 struct ahci_controller *ctlr = device_get_softc(dev);
168 * Here starts the magic -- most of the comments are based
169 * on guesswork, names of routines and printf error
170 * messages. The code works, but it will do that even if the
171 * comments are 100% BS.
175 * Lock out other access while we initialize. Or at least that
176 * seems to be the case based on Linux SDK #defines. Maybe this
177 * put things into reset?
179 ATA_OUTL(ctlr->r_mem, AHCI_RWCR, 0);
183 * Set bit 19 in PHYCS1R. Guessing this disables driving the PHY
184 * port for a bit while we reset things.
186 ahci_set(ctlr->r_mem, AHCI_PHYCS1R, PHYCS1R_HIGHZ);
191 ahci_mask_set(ctlr->r_mem, AHCI_PHYCS0R,
193 PHYCS0R_UF2_INIT | PHYCS0R_BIT23 | PHYCS0R_BIT18);
196 * Set three fields in PHYCS1R
198 ahci_mask_set(ctlr->r_mem, AHCI_PHYCS1R,
199 ~(PHYCS1R_UF1_MASK | PHYCS1R_UF2_MASK | PHYCS1R_UF3_MASK),
200 PHYCS1R_UF1_INIT | PHYCS1R_UF2_INIT | PHYCS1R_UF3_INIT);
203 * Two more mystery bits in PHYCS1R. -- can these be combined above?
205 ahci_set(ctlr->r_mem, AHCI_PHYCS1R, PHYCS1R_BIT15 | PHYCS1R_BIT28);
208 * Now clear that first mysery bit. Perhaps this starts
209 * driving the PHY again so we can power it up and start
210 * talking to the SATA drive, if any below.
212 ahci_clr(ctlr->r_mem, AHCI_PHYCS1R, PHYCS1R_HIGHZ);
215 * Frob PHYCS0R again...
217 ahci_mask_set(ctlr->r_mem, AHCI_PHYCS0R,
218 ~PHYCS0R_UF1_MASK, PHYCS0R_UF1_INIT);
221 * Frob PHYCS2R, because 25 means something?
223 ahci_mask_set(ctlr->r_mem, AHCI_PHYCS2R, ~PHYCS2R_UF1_MASK,
226 DELAY(100); /* WAG */
229 * Turn on the power to the PHY and wait for it to report back
232 ahci_set(ctlr->r_mem, AHCI_PHYCS0R, PHYCS0R_POWER_ENABLE);
233 for (to = PHY_RESET_TIMEOUT; to > 0; to--) {
234 val = ATA_INL(ctlr->r_mem, AHCI_PHYCS0R);
235 if ((val & PHYCS0R_POWER_STATUS_MASK) == PHYCS0R_PS_GOOD)
239 if (to == 0 && bootverbose)
240 device_printf(dev, "PHY Power Failed PHYCS0R = %#x\n", val);
243 * Calibrate the clocks between the device and the host. This appears
244 * to be an automated process that clears the bit when it is done.
246 ahci_set(ctlr->r_mem, AHCI_PHYCS2R, PHYCS2R_CALIBRATE);
247 for (to = PHY_RESET_TIMEOUT; to > 0; to--) {
248 val = ATA_INL(ctlr->r_mem, AHCI_PHYCS2R);
249 if ((val & PHYCS2R_CALIBRATE) == 0)
253 if (to == 0 && bootverbose)
254 device_printf(dev, "PHY Cal Failed PHYCS2R %#x\n", val);
257 * OK, let things settle down a bit.
262 * Go back into normal mode now that we've calibrated the PHY.
264 ATA_OUTL(ctlr->r_mem, AHCI_RWCR, 7);
268 ahci_a10_ch_start(struct ahci_channel *ch)
273 * Magical values from Allwinner SDK, setup the DMA before start
274 * operations on this channel.
276 reg = ATA_INL(ch->r_mem, AHCI_P0DMACR);
279 ATA_OUTL(ch->r_mem, AHCI_P0DMACR, reg);
283 ahci_a10_ctlr_reset(device_t dev)
286 ahci_a10_phy_reset(dev);
288 return (ahci_ctlr_reset(dev));
292 ahci_a10_probe(device_t dev)
295 if (!ofw_bus_is_compatible(dev, "allwinner,sun4i-a10-ahci"))
297 device_set_desc(dev, "Allwinner Integrated AHCI controller");
299 return (BUS_PROBE_DEFAULT);
303 ahci_a10_attach(device_t dev)
306 struct ahci_a10_softc *sc;
307 struct ahci_controller *ctlr;
309 sc = device_get_softc(dev);
310 ctlr = &sc->ahci_ctlr;
312 ctlr->quirks = AHCI_Q_NOPMP;
315 ctlr->subvendorid = 0;
316 ctlr->subdeviceid = 0;
318 if (!(ctlr->r_mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
319 &ctlr->r_rid, RF_ACTIVE)))
322 /* Enable the (optional) regulator */
323 if (regulator_get_by_ofw_property(dev, 0, "target-supply",
324 &sc->ahci_reg) == 0) {
325 error = regulator_enable(sc->ahci_reg);
327 device_printf(dev, "Could not enable regulator\n");
333 error = clk_get_by_ofw_index(dev, 0, 0, &sc->clk_gate);
335 device_printf(dev, "Cannot get gate clock\n");
338 error = clk_get_by_ofw_index(dev, 0, 1, &sc->clk_pll);
340 device_printf(dev, "Cannot get PLL clock\n");
343 error = clk_set_freq(sc->clk_pll, PLL_FREQ, CLK_SET_ROUND_DOWN);
345 device_printf(dev, "Cannot set PLL frequency\n");
348 error = clk_enable(sc->clk_pll);
350 device_printf(dev, "Cannot enable PLL\n");
353 error = clk_enable(sc->clk_gate);
355 device_printf(dev, "Cannot enable clk gate\n");
359 /* Reset controller */
360 if ((error = ahci_a10_ctlr_reset(dev)) != 0)
364 * No MSI registers on this platform.
369 /* Channel start callback(). */
370 ctlr->ch_start = ahci_a10_ch_start;
373 * Note: ahci_attach will release ctlr->r_mem on errors automatically
375 return (ahci_attach(dev));
378 if (sc->ahci_reg != NULL)
379 regulator_disable(sc->ahci_reg);
380 if (sc->clk_gate != NULL)
381 clk_release(sc->clk_gate);
382 if (sc->clk_pll != NULL)
383 clk_release(sc->clk_pll);
384 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
389 ahci_a10_detach(device_t dev)
391 struct ahci_a10_softc *sc;
392 struct ahci_controller *ctlr;
394 sc = device_get_softc(dev);
395 ctlr = &sc->ahci_ctlr;
397 if (sc->ahci_reg != NULL)
398 regulator_disable(sc->ahci_reg);
399 if (sc->clk_gate != NULL)
400 clk_release(sc->clk_gate);
401 if (sc->clk_pll != NULL)
402 clk_release(sc->clk_pll);
403 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
404 return (ahci_detach(dev));
407 static device_method_t ahci_ata_methods[] = {
408 DEVMETHOD(device_probe, ahci_a10_probe),
409 DEVMETHOD(device_attach, ahci_a10_attach),
410 DEVMETHOD(device_detach, ahci_a10_detach),
411 DEVMETHOD(bus_print_child, ahci_print_child),
412 DEVMETHOD(bus_alloc_resource, ahci_alloc_resource),
413 DEVMETHOD(bus_release_resource, ahci_release_resource),
414 DEVMETHOD(bus_setup_intr, ahci_setup_intr),
415 DEVMETHOD(bus_teardown_intr,ahci_teardown_intr),
416 DEVMETHOD(bus_child_location_str, ahci_child_location_str),
420 static driver_t ahci_ata_driver = {
423 sizeof(struct ahci_a10_softc)
426 DRIVER_MODULE(a10_ahci, simplebus, ahci_ata_driver, ahci_devclass, 0, 0);