xref: /netbsd-src/sys/dev/pci/artsata.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: artsata.c,v 1.28 2017/10/20 07:06:08 jdolecek Exp $	*/
2 
3 /*-
4  * Copyright (c) 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of Wasabi Systems, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: artsata.c,v 1.28 2017/10/20 07:06:08 jdolecek Exp $");
34 
35 #include "opt_pciide.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 
40 #include <dev/pci/pcivar.h>
41 #include <dev/pci/pcidevs.h>
42 #include <dev/pci/pciidereg.h>
43 #include <dev/pci/pciidevar.h>
44 #include <dev/pci/pciide_i31244_reg.h>
45 
46 #include <dev/ata/satareg.h>
47 #include <dev/ata/satavar.h>
48 #include <dev/ata/atareg.h>
49 #include <dev/ata/atavar.h>
50 
51 static void artisea_chip_map(struct pciide_softc*,
52     const struct pci_attach_args *);
53 
54 static int  artsata_match(device_t, cfdata_t, void *);
55 static void artsata_attach(device_t, device_t, void *);
56 
57 static const struct pciide_product_desc pciide_artsata_products[] =  {
58 	{ PCI_PRODUCT_INTEL_31244,
59 	  0,
60 	  "Intel 31244 Serial ATA Controller",
61 	  artisea_chip_map,
62 	},
63 	{ 0,
64 	  0,
65 	  NULL,
66 	  NULL
67 	}
68 };
69 
70 struct artisea_cmd_map
71 {
72 	u_int8_t offset;
73 	u_int8_t size;
74 };
75 
76 static const struct artisea_cmd_map artisea_dpa_cmd_map[] =
77 {
78 	{ARTISEA_SUPDDR, 4},	/* 0 Data */
79 	{ARTISEA_SUPDER, 1},	/* 1 Error */
80 	{ARTISEA_SUPDCSR, 2},	/* 2 Sector Count */
81 	{ARTISEA_SUPDSNR, 2},	/* 3 Sector Number */
82 	{ARTISEA_SUPDCLR, 2},	/* 4 Cylinder Low */
83 	{ARTISEA_SUPDCHR, 2},	/* 5 Cylinder High */
84 	{ARTISEA_SUPDDHR, 1},	/* 6 Device/Head */
85 	{ARTISEA_SUPDCR, 1},	/* 7 Command */
86 	{ARTISEA_SUPDSR, 1},	/* 8 Status */
87 	{ARTISEA_SUPDFR, 2}	/* 9 Feature */
88 };
89 
90 #define ARTISEA_NUM_CHAN 4
91 
92 CFATTACH_DECL_NEW(artsata, sizeof(struct pciide_softc),
93     artsata_match, artsata_attach, pciide_detach, NULL);
94 
95 static int
96 artsata_match(device_t parent, cfdata_t match, void *aux)
97 {
98 	struct pci_attach_args *pa = aux;
99 
100 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_INTEL) {
101 		if (pciide_lookup_product(pa->pa_id, pciide_artsata_products))
102 			return (2);
103 	}
104 	return (0);
105 }
106 
107 static void
108 artsata_attach(device_t parent, device_t self, void *aux)
109 {
110 	struct pci_attach_args *pa = aux;
111 	struct pciide_softc *sc = device_private(self);
112 
113 	sc->sc_wdcdev.sc_atac.atac_dev = self;
114 
115 	pciide_common_attach(sc, pa,
116 	    pciide_lookup_product(pa->pa_id, pciide_artsata_products));
117 
118 }
119 
120 static void
121 artisea_mapregs(const struct pci_attach_args *pa, struct pciide_channel *cp,
122     int (*pci_intr)(void *))
123 {
124 	struct pciide_softc *sc = CHAN_TO_PCIIDE(&cp->ata_channel);
125 	struct ata_channel *wdc_cp = &cp->ata_channel;
126 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(wdc_cp);
127 	const char *intrstr;
128 	pci_intr_handle_t intrhandle;
129 	int i;
130 	char intrbuf[PCI_INTRSTR_LEN];
131 
132 	cp->compat = 0;
133 
134 	if (sc->sc_pci_ih == NULL) {
135 		if (pci_intr_map(pa, &intrhandle) != 0) {
136 			aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
137 			    "couldn't map native-PCI interrupt\n");
138 			goto bad;
139 		}
140 		intrstr = pci_intr_string(pa->pa_pc, intrhandle,
141 		    intrbuf, sizeof(intrbuf));
142 		sc->sc_pci_ih = pci_intr_establish(pa->pa_pc,
143 		    intrhandle, IPL_BIO, pci_intr, sc);
144 		if (sc->sc_pci_ih != NULL) {
145 			aprint_normal_dev(sc->sc_wdcdev.sc_atac.atac_dev,
146 			    "using %s for native-PCI interrupt\n", intrstr);
147 		} else {
148 			aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
149 			    "couldn't establish native-PCI interrupt");
150 			if (intrstr != NULL)
151 				aprint_error(" at %s", intrstr);
152 			aprint_error("\n");
153 			goto bad;
154 		}
155 	}
156 	cp->ih = sc->sc_pci_ih;
157 	wdr->cmd_iot = sc->sc_ba5_st;
158 	if (bus_space_subregion (sc->sc_ba5_st, sc->sc_ba5_sh,
159 	    ARTISEA_DPA_PORT_BASE(wdc_cp->ch_channel), 0x200,
160 	    &wdr->cmd_baseioh) != 0) {
161 		aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
162 		    "couldn't map %s channel cmd regs\n", cp->name);
163 		goto bad;
164 	}
165 
166 	wdr->ctl_iot = sc->sc_ba5_st;
167 	if (bus_space_subregion(wdr->cmd_iot, wdr->cmd_baseioh,
168 	    ARTISEA_SUPDDCTLR, 1, &cp->ctl_baseioh) != 0) {
169 		aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
170 		    "couldn't map %s channel ctl regs\n", cp->name);
171 		goto bad;
172 	}
173 	wdr->ctl_ioh = cp->ctl_baseioh;
174 
175 	for (i = 0; i < WDC_NREG + 2; i++) {
176 
177 		if (bus_space_subregion(wdr->cmd_iot, wdr->cmd_baseioh,
178 		    artisea_dpa_cmd_map[i].offset, artisea_dpa_cmd_map[i].size,
179 		    &wdr->cmd_iohs[i]) != 0) {
180 			aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
181 			    "couldn't subregion %s channel cmd regs\n",
182 			    cp->name);
183 			goto bad;
184 		}
185 	}
186 	wdr->data32iot = wdr->cmd_iot;
187 	wdr->data32ioh = wdr->cmd_iohs[0];
188 
189 	wdr->sata_iot = wdr->cmd_iot;
190 	wdr->sata_baseioh = wdr->cmd_baseioh;
191 
192 	if (bus_space_subregion(wdr->sata_iot, wdr->sata_baseioh,
193 	    ARTISEA_SUPERSET_DPA_OFF + ARTISEA_SUPDSSSR, 1,
194 	    &wdr->sata_status) != 0) {
195 		aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
196 		    "couldn't map channel %d sata_status regs\n",
197 		    wdc_cp->ch_channel);
198 		goto bad;
199 	}
200 	if (bus_space_subregion(wdr->sata_iot, wdr->sata_baseioh,
201 	    ARTISEA_SUPERSET_DPA_OFF + ARTISEA_SUPDSSER, 1,
202 	    &wdr->sata_error) != 0) {
203 		aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
204 		    "couldn't map channel %d sata_error regs\n",
205 		    wdc_cp->ch_channel);
206 		goto bad;
207 	}
208 	if (bus_space_subregion(wdr->sata_iot, wdr->sata_baseioh,
209 	    ARTISEA_SUPERSET_DPA_OFF + ARTISEA_SUPDSSCR, 1,
210 	    &wdr->sata_control) != 0) {
211 		aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
212 		    "couldn't map channel %d sata_control regs\n",
213 		    wdc_cp->ch_channel);
214 		goto bad;
215 	}
216 
217 	wdcattach(wdc_cp);
218 	return;
219 
220 bad:
221 	wdc_cp->ch_flags |= ATACH_DISABLED;
222 	return;
223 }
224 
225 static int
226 artisea_chansetup(struct pciide_softc *sc, int channel,
227     pcireg_t interface)
228 {
229 	struct pciide_channel *cp = &sc->pciide_channels[channel];
230 	sc->wdc_chanarray[channel] = &cp->ata_channel;
231 	cp->name = PCIIDE_CHANNEL_NAME(channel);
232 	cp->ata_channel.ch_channel = channel;
233 	cp->ata_channel.ch_atac = &sc->sc_wdcdev.sc_atac;
234 
235 	return 1;
236 }
237 
238 static void
239 artisea_mapreg_dma(struct pciide_softc *sc, const struct pci_attach_args *pa)
240 {
241 	struct pciide_channel *pc;
242 	int chan;
243 	u_int32_t dma_ctl;
244 	u_int32_t cacheline_len;
245 
246 	aprint_verbose_dev(sc->sc_wdcdev.sc_atac.atac_dev,
247 	    "bus-master DMA support present");
248 
249 	sc->sc_dma_ok = 1;
250 
251 	/*
252 	 * Errata #4 says that if the cacheline length is not set correctly,
253 	 * we can get corrupt MWI and Memory-Block-Write transactions.
254 	 */
255 	cacheline_len = PCI_CACHELINE(pci_conf_read (pa->pa_pc, pa->pa_tag,
256 	    PCI_BHLC_REG));
257 	if (cacheline_len == 0) {
258 		aprint_verbose(", but unused (cacheline size not set in PCI conf)\n");
259 		sc->sc_dma_ok = 0;
260 		return;
261 	}
262 
263 	/*
264 	 * Final step of the work-around is to force the DMA engine to use
265 	 * the cache-line length information.
266 	 */
267 	dma_ctl = pci_conf_read(pa->pa_pc, pa->pa_tag, ARTISEA_PCI_SUDCSCR);
268 	dma_ctl |= SUDCSCR_DMA_WCAE | SUDCSCR_DMA_RCAE;
269 	pci_conf_write(pa->pa_pc, pa->pa_tag, ARTISEA_PCI_SUDCSCR, dma_ctl);
270 
271 	sc->sc_wdcdev.dma_arg = sc;
272 	sc->sc_wdcdev.dma_init = pciide_dma_init;
273 	sc->sc_wdcdev.dma_start = pciide_dma_start;
274 	sc->sc_wdcdev.dma_finish = pciide_dma_finish;
275 	sc->sc_dma_iot = sc->sc_ba5_st;
276 	sc->sc_dmat = pa->pa_dmat;
277 
278 	if (device_cfdata(sc->sc_wdcdev.sc_atac.atac_dev)->cf_flags &
279 	    PCIIDE_OPTIONS_NODMA) {
280 		aprint_verbose(
281 		    ", but unused (forced off by config file)\n");
282 		sc->sc_dma_ok = 0;
283 		return;
284 	}
285 
286 	/*
287 	 * Set up the default handles for the DMA registers.
288 	 * Just reserve 32 bits for each handle, unless space
289 	 * doesn't permit it.
290 	 */
291 	for (chan = 0; chan < ARTISEA_NUM_CHAN; chan++) {
292 		pc = &sc->pciide_channels[chan];
293 		if (bus_space_subregion(sc->sc_ba5_st, sc->sc_ba5_sh,
294 		    ARTISEA_DPA_PORT_BASE(chan) + ARTISEA_SUPDDCMDR, 2,
295 		    &pc->dma_iohs[IDEDMA_CMD]) != 0 ||
296 		    bus_space_subregion(sc->sc_ba5_st, sc->sc_ba5_sh,
297 		    ARTISEA_DPA_PORT_BASE(chan) + ARTISEA_SUPDDSR, 1,
298 		    &pc->dma_iohs[IDEDMA_CTL]) != 0 ||
299 		    bus_space_subregion(sc->sc_ba5_st, sc->sc_ba5_sh,
300 		    ARTISEA_DPA_PORT_BASE(chan) + ARTISEA_SUPDDDTPR, 4,
301 		    &pc->dma_iohs[IDEDMA_TBL]) != 0) {
302 			sc->sc_dma_ok = 0;
303 			aprint_verbose(", but can't subregion registers\n");
304 			return;
305 		}
306 	}
307 
308 	aprint_verbose("\n");
309 }
310 
311 static void
312 artisea_chip_map_dpa(struct pciide_softc *sc, const struct pci_attach_args *pa)
313 {
314 	struct pciide_channel *cp;
315 	pcireg_t interface;
316 	int channel;
317 
318 	interface = PCI_INTERFACE(pa->pa_class);
319 
320 	aprint_normal_dev(sc->sc_wdcdev.sc_atac.atac_dev,
321 	    "interface wired in DPA mode\n");
322 
323 	if (pci_mapreg_map(pa, ARTISEA_PCI_DPA_BASE, PCI_MAPREG_MEM_TYPE_64BIT,
324 	    0, &sc->sc_ba5_st, &sc->sc_ba5_sh, NULL, &sc->sc_ba5_ss) != 0)
325 		return;
326 
327 	artisea_mapreg_dma(sc, pa);
328 
329 	sc->sc_wdcdev.cap = WDC_CAPABILITY_WIDEREGS;
330 
331 	sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA16 | ATAC_CAP_DATA32;
332 	sc->sc_wdcdev.sc_atac.atac_pio_cap = 4;
333 	if (sc->sc_dma_ok) {
334 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DMA | ATAC_CAP_UDMA;
335 		sc->sc_wdcdev.irqack = pciide_irqack;
336 		sc->sc_wdcdev.sc_atac.atac_dma_cap = 2;
337 		sc->sc_wdcdev.sc_atac.atac_udma_cap = 6;
338 	}
339 	sc->sc_wdcdev.sc_atac.atac_set_modes = sata_setup_channel;
340 
341 	sc->sc_wdcdev.sc_atac.atac_channels = sc->wdc_chanarray;
342 	sc->sc_wdcdev.sc_atac.atac_nchannels = ARTISEA_NUM_CHAN;
343 	sc->sc_wdcdev.sc_atac.atac_probe = wdc_sataprobe;
344 	sc->sc_wdcdev.wdc_maxdrives = 1;
345 
346 	wdc_allocate_regs(&sc->sc_wdcdev);
347 
348 	/*
349 	 * Perform a quick check to ensure that the device isn't configured
350 	 * in Spread-spectrum clocking mode.  This feature is buggy and has
351 	 * been removed from the latest documentation.
352 	 *
353 	 * Note that although this bit is in the Channel regs, it's the same
354 	 * for all channels, so we check it just once here.
355 	 */
356 	if ((bus_space_read_4 (sc->sc_ba5_st, sc->sc_ba5_sh,
357 	    ARTISEA_DPA_PORT_BASE(0) + ARTISEA_SUPERSET_DPA_OFF +
358 	    ARTISEA_SUPDPFR) & SUPDPFR_SSCEN) != 0) {
359 		aprint_error_dev(sc->sc_wdcdev.sc_atac.atac_dev,
360 		    "Spread-specturm clocking not supported by device\n");
361 		return;
362 	}
363 
364 	/* Clear the LED0-only bit.  */
365 	pci_conf_write (pa->pa_pc, pa->pa_tag, ARTISEA_PCI_SUECSR0,
366 	    pci_conf_read (pa->pa_pc, pa->pa_tag, ARTISEA_PCI_SUECSR0) &
367 	    ~SUECSR0_LED0_ONLY);
368 
369 	for (channel = 0; channel < sc->sc_wdcdev.sc_atac.atac_nchannels;
370 	     channel++) {
371 		cp = &sc->pciide_channels[channel];
372 		if (artisea_chansetup(sc, channel, interface) == 0)
373 			continue;
374 		/* XXX We can probably do interrupts more efficiently.  */
375 		artisea_mapregs(pa, cp, pciide_pci_intr);
376 	}
377 }
378 
379 static void
380 artisea_chip_map(struct pciide_softc *sc, const struct pci_attach_args *pa)
381 {
382 	struct pciide_channel *cp;
383 	pcireg_t interface;
384 	int channel;
385 
386 	if (pciide_chipen(sc, pa) == 0)
387 		return;
388 
389 	interface = PCI_INTERFACE(pa->pa_class);
390 
391 	if (interface == 0) {
392 		artisea_chip_map_dpa (sc, pa);
393 		return;
394 	}
395 
396 	aprint_verbose_dev(sc->sc_wdcdev.sc_atac.atac_dev,
397 	    "bus-master DMA support present");
398 #ifdef PCIIDE_I31244_DISABLEDMA
399 	if (sc->sc_pp->ide_product == PCI_PRODUCT_INTEL_31244 &&
400 	    PCI_REVISION(pa->pa_class) == 0) {
401 		aprint_verbose(" but disabled due to rev. 0");
402 		sc->sc_dma_ok = 0;
403 	} else
404 #endif
405 		pciide_mapreg_dma(sc, pa);
406 	aprint_verbose("\n");
407 
408 	/*
409 	 * XXX Configure LEDs to show activity.
410 	 */
411 
412 	sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA16 | ATAC_CAP_DATA32;
413 	sc->sc_wdcdev.sc_atac.atac_pio_cap = 4;
414 	if (sc->sc_dma_ok) {
415 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DMA | ATAC_CAP_UDMA;
416 		sc->sc_wdcdev.irqack = pciide_irqack;
417 		sc->sc_wdcdev.sc_atac.atac_dma_cap = 2;
418 		sc->sc_wdcdev.sc_atac.atac_udma_cap = 6;
419 	}
420 	sc->sc_wdcdev.sc_atac.atac_set_modes = sata_setup_channel;
421 
422 	sc->sc_wdcdev.sc_atac.atac_channels = sc->wdc_chanarray;
423 	sc->sc_wdcdev.sc_atac.atac_nchannels = PCIIDE_NUM_CHANNELS;
424 
425 	wdc_allocate_regs(&sc->sc_wdcdev);
426 
427 	for (channel = 0; channel < sc->sc_wdcdev.sc_atac.atac_nchannels;
428 	     channel++) {
429 		cp = &sc->pciide_channels[channel];
430 		if (pciide_chansetup(sc, channel, interface) == 0)
431 			continue;
432 		pciide_mapchan(pa, cp, interface, pciide_pci_intr);
433 	}
434 }
435