xref: /freebsd/sys/dev/ata/ata-all.c (revision d876124d6ae9d56da5b4ff4c6015efd1d0c9222a)
1 /*-
2  * Copyright (c) 1998 - 2008 S�ren Schmidt <sos@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification, immediately at the beginning of the file.
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 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include "opt_ata.h"
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/ata.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/endian.h>
37 #include <sys/ctype.h>
38 #include <sys/conf.h>
39 #include <sys/bus.h>
40 #include <sys/bio.h>
41 #include <sys/malloc.h>
42 #include <sys/sysctl.h>
43 #include <sys/sema.h>
44 #include <sys/taskqueue.h>
45 #include <vm/uma.h>
46 #include <machine/stdarg.h>
47 #include <machine/resource.h>
48 #include <machine/bus.h>
49 #include <sys/rman.h>
50 #include <dev/ata/ata-all.h>
51 #include <ata_if.h>
52 
53 /* device structure */
54 static  d_ioctl_t       ata_ioctl;
55 static struct cdevsw ata_cdevsw = {
56 	.d_version =    D_VERSION,
57 	.d_flags =      D_NEEDGIANT, /* we need this as newbus isn't mpsafe */
58 	.d_ioctl =      ata_ioctl,
59 	.d_name =       "ata",
60 };
61 
62 /* prototypes */
63 static void ata_boot_attach(void);
64 static device_t ata_add_child(device_t, struct ata_device *, int);
65 static void bswap(int8_t *, int);
66 static void btrim(int8_t *, int);
67 static void bpack(int8_t *, int8_t *, int);
68 
69 /* global vars */
70 MALLOC_DEFINE(M_ATA, "ata_generic", "ATA driver generic layer");
71 int (*ata_raid_ioctl_func)(u_long cmd, caddr_t data) = NULL;
72 struct intr_config_hook *ata_delayed_attach = NULL;
73 devclass_t ata_devclass;
74 uma_zone_t ata_request_zone;
75 uma_zone_t ata_composite_zone;
76 int ata_wc = 1;
77 int ata_setmax = 0;
78 
79 /* local vars */
80 static int ata_dma = 1;
81 static int atapi_dma = 1;
82 
83 /* sysctl vars */
84 SYSCTL_NODE(_hw, OID_AUTO, ata, CTLFLAG_RD, 0, "ATA driver parameters");
85 TUNABLE_INT("hw.ata.ata_dma", &ata_dma);
86 SYSCTL_INT(_hw_ata, OID_AUTO, ata_dma, CTLFLAG_RDTUN, &ata_dma, 0,
87 	   "ATA disk DMA mode control");
88 TUNABLE_INT("hw.ata.atapi_dma", &atapi_dma);
89 SYSCTL_INT(_hw_ata, OID_AUTO, atapi_dma, CTLFLAG_RDTUN, &atapi_dma, 0,
90 	   "ATAPI device DMA mode control");
91 TUNABLE_INT("hw.ata.wc", &ata_wc);
92 SYSCTL_INT(_hw_ata, OID_AUTO, wc, CTLFLAG_RDTUN, &ata_wc, 0,
93 	   "ATA disk write caching");
94 TUNABLE_INT("hw.ata.setmax", &ata_setmax);
95 SYSCTL_INT(_hw_ata, OID_AUTO, setmax, CTLFLAG_RDTUN, &ata_setmax, 0,
96 	   "ATA disk set max native address");
97 
98 /*
99  * newbus device interface related functions
100  */
101 int
102 ata_probe(device_t dev)
103 {
104     return 0;
105 }
106 
107 int
108 ata_attach(device_t dev)
109 {
110     struct ata_channel *ch = device_get_softc(dev);
111     int error, rid;
112 
113     /* check that we have a virgin channel to attach */
114     if (ch->r_irq)
115 	return EEXIST;
116 
117     /* initialize the softc basics */
118     ch->dev = dev;
119     ch->state = ATA_IDLE;
120     bzero(&ch->state_mtx, sizeof(struct mtx));
121     mtx_init(&ch->state_mtx, "ATA state lock", NULL, MTX_DEF);
122     bzero(&ch->queue_mtx, sizeof(struct mtx));
123     mtx_init(&ch->queue_mtx, "ATA queue lock", NULL, MTX_DEF);
124     TAILQ_INIT(&ch->ata_queue);
125 
126     /* reset the controller HW, the channel and device(s) */
127     while (ATA_LOCKING(dev, ATA_LF_LOCK) != ch->unit)
128 	pause("ataatch", 1);
129     ATA_RESET(dev);
130     ATA_LOCKING(dev, ATA_LF_UNLOCK);
131 
132     /* setup interrupt delivery */
133     rid = ATA_IRQ_RID;
134     ch->r_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
135 				       RF_SHAREABLE | RF_ACTIVE);
136     if (!ch->r_irq) {
137 	device_printf(dev, "unable to allocate interrupt\n");
138 	return ENXIO;
139     }
140     if ((error = bus_setup_intr(dev, ch->r_irq, ATA_INTR_FLAGS, NULL,
141 				(driver_intr_t *)ata_interrupt, ch, &ch->ih))) {
142 	device_printf(dev, "unable to setup interrupt\n");
143 	return error;
144     }
145 
146     /* probe and attach devices on this channel unless we are in early boot */
147     if (!ata_delayed_attach)
148 	ata_identify(dev);
149     return 0;
150 }
151 
152 int
153 ata_detach(device_t dev)
154 {
155     struct ata_channel *ch = device_get_softc(dev);
156     device_t *children;
157     int nchildren, i;
158 
159     /* check that we have a valid channel to detach */
160     if (!ch->r_irq)
161 	return ENXIO;
162 
163     /* grap the channel lock so no new requests gets launched */
164     mtx_lock(&ch->state_mtx);
165     ch->state |= ATA_STALL_QUEUE;
166     mtx_unlock(&ch->state_mtx);
167 
168     /* detach & delete all children */
169     if (!device_get_children(dev, &children, &nchildren)) {
170 	for (i = 0; i < nchildren; i++)
171 	    if (children[i])
172 		device_delete_child(dev, children[i]);
173 	free(children, M_TEMP);
174     }
175 
176     /* release resources */
177     bus_teardown_intr(dev, ch->r_irq, ch->ih);
178     bus_release_resource(dev, SYS_RES_IRQ, ATA_IRQ_RID, ch->r_irq);
179     ch->r_irq = NULL;
180     mtx_destroy(&ch->state_mtx);
181     mtx_destroy(&ch->queue_mtx);
182     return 0;
183 }
184 
185 int
186 ata_reinit(device_t dev)
187 {
188     struct ata_channel *ch = device_get_softc(dev);
189     struct ata_request *request;
190     device_t *children;
191     int nchildren, i;
192 
193     /* check that we have a valid channel to reinit */
194     if (!ch || !ch->r_irq)
195 	return ENXIO;
196 
197     if (bootverbose)
198 	device_printf(dev, "reiniting channel ..\n");
199 
200     /* poll for locking the channel */
201     while (ATA_LOCKING(dev, ATA_LF_LOCK) != ch->unit)
202 	pause("atarini", 1);
203 
204     /* catch eventual request in ch->running */
205     mtx_lock(&ch->state_mtx);
206     if ((request = ch->running))
207 	callout_stop(&request->callout);
208     ch->running = NULL;
209 
210     /* unconditionally grap the channel lock */
211     ch->state |= ATA_STALL_QUEUE;
212     mtx_unlock(&ch->state_mtx);
213 
214     /* reset the controller HW, the channel and device(s) */
215     ATA_RESET(dev);
216 
217     /* reinit the children and delete any that fails */
218     if (!device_get_children(dev, &children, &nchildren)) {
219 	mtx_lock(&Giant);       /* newbus suckage it needs Giant */
220 	for (i = 0; i < nchildren; i++) {
221 	    /* did any children go missing ? */
222 	    if (children[i] && device_is_attached(children[i]) &&
223 		ATA_REINIT(children[i])) {
224 		/*
225 		 * if we had a running request and its device matches
226 		 * this child we need to inform the request that the
227 		 * device is gone.
228 		 */
229 		if (request && request->dev == children[i]) {
230 		    request->result = ENXIO;
231 		    device_printf(request->dev, "FAILURE - device detached\n");
232 
233 		    /* if not timeout finish request here */
234 		    if (!(request->flags & ATA_R_TIMEOUT))
235 			    ata_finish(request);
236 		    request = NULL;
237 		}
238 		device_delete_child(dev, children[i]);
239 	    }
240 	}
241 	free(children, M_TEMP);
242 	mtx_unlock(&Giant);     /* newbus suckage dealt with, release Giant */
243     }
244 
245     /* if we still have a good request put it on the queue again */
246     if (request && !(request->flags & ATA_R_TIMEOUT)) {
247 	device_printf(request->dev,
248 		      "WARNING - %s requeued due to channel reset",
249 		      ata_cmd2str(request));
250 	if (!(request->flags & (ATA_R_ATAPI | ATA_R_CONTROL)))
251 	    printf(" LBA=%ju", request->u.ata.lba);
252 	printf("\n");
253 	request->flags |= ATA_R_REQUEUE;
254 	ata_queue_request(request);
255     }
256 
257     /* we're done release the channel for new work */
258     mtx_lock(&ch->state_mtx);
259     ch->state = ATA_IDLE;
260     mtx_unlock(&ch->state_mtx);
261     ATA_LOCKING(dev, ATA_LF_UNLOCK);
262 
263     if (bootverbose)
264 	device_printf(dev, "reinit done ..\n");
265 
266     /* kick off requests on the queue */
267     ata_start(dev);
268     return 0;
269 }
270 
271 int
272 ata_suspend(device_t dev)
273 {
274     struct ata_channel *ch;
275 
276     /* check for valid device */
277     if (!dev || !(ch = device_get_softc(dev)))
278 	return ENXIO;
279 
280     /* wait for the channel to be IDLE or detached before suspending */
281     while (ch->r_irq) {
282 	mtx_lock(&ch->state_mtx);
283 	if (ch->state == ATA_IDLE) {
284 	    ch->state = ATA_ACTIVE;
285 	    mtx_unlock(&ch->state_mtx);
286 	    break;
287 	}
288 	mtx_unlock(&ch->state_mtx);
289 	tsleep(ch, PRIBIO, "atasusp", hz/10);
290     }
291     ATA_LOCKING(dev, ATA_LF_UNLOCK);
292     return 0;
293 }
294 
295 int
296 ata_resume(device_t dev)
297 {
298     struct ata_channel *ch;
299     int error;
300 
301     /* check for valid device */
302     if (!dev || !(ch = device_get_softc(dev)))
303 	return ENXIO;
304 
305     /* reinit the devices, we dont know what mode/state they are in */
306     error = ata_reinit(dev);
307 
308     /* kick off requests on the queue */
309     ata_start(dev);
310     return error;
311 }
312 
313 int
314 ata_interrupt(void *data)
315 {
316     struct ata_channel *ch = (struct ata_channel *)data;
317     struct ata_request *request;
318 
319     mtx_lock(&ch->state_mtx);
320     do {
321 	/* ignore interrupt if its not for us */
322 	if (ch->hw.status && !ch->hw.status(ch->dev))
323 	    break;
324 
325 	/* do we have a running request */
326 	if (!(request = ch->running))
327 	    break;
328 
329 	ATA_DEBUG_RQ(request, "interrupt");
330 
331 	/* safetycheck for the right state */
332 	if (ch->state == ATA_IDLE) {
333 	    device_printf(request->dev, "interrupt on idle channel ignored\n");
334 	    break;
335 	}
336 
337 	/*
338 	 * we have the HW locks, so end the transaction for this request
339 	 * if it finishes immediately otherwise wait for next interrupt
340 	 */
341 	if (ch->hw.end_transaction(request) == ATA_OP_FINISHED) {
342 	    ch->running = NULL;
343 	    if (ch->state == ATA_ACTIVE)
344 		ch->state = ATA_IDLE;
345 	    mtx_unlock(&ch->state_mtx);
346 	    ATA_LOCKING(ch->dev, ATA_LF_UNLOCK);
347 	    ata_finish(request);
348 	    return 1;
349 	}
350     } while (0);
351     mtx_unlock(&ch->state_mtx);
352     return 0;
353 }
354 
355 /*
356  * device related interfaces
357  */
358 static int
359 ata_ioctl(struct cdev *dev, u_long cmd, caddr_t data,
360 	  int32_t flag, struct thread *td)
361 {
362     device_t device, *children;
363     struct ata_ioc_devices *devices = (struct ata_ioc_devices *)data;
364     int *value = (int *)data;
365     int i, nchildren, error = ENOTTY;
366 
367     switch (cmd) {
368     case IOCATAGMAXCHANNEL:
369 	/* In case we have channel 0..n this will return n+1. */
370 	*value = devclass_get_maxunit(ata_devclass);
371 	error = 0;
372 	break;
373 
374     case IOCATAREINIT:
375 	if (*value >= devclass_get_maxunit(ata_devclass) ||
376 	    !(device = devclass_get_device(ata_devclass, *value)))
377 	    return ENXIO;
378 	error = ata_reinit(device);
379 	ata_start(device);
380 	break;
381 
382     case IOCATAATTACH:
383 	if (*value >= devclass_get_maxunit(ata_devclass) ||
384 	    !(device = devclass_get_device(ata_devclass, *value)))
385 	    return ENXIO;
386 	/* XXX SOS should enable channel HW on controller */
387 	error = ata_attach(device);
388 	break;
389 
390     case IOCATADETACH:
391 	if (*value >= devclass_get_maxunit(ata_devclass) ||
392 	    !(device = devclass_get_device(ata_devclass, *value)))
393 	    return ENXIO;
394 	error = ata_detach(device);
395 	/* XXX SOS should disable channel HW on controller */
396 	break;
397 
398     case IOCATADEVICES:
399 	if (devices->channel >= devclass_get_maxunit(ata_devclass) ||
400 	    !(device = devclass_get_device(ata_devclass, devices->channel)))
401 	    return ENXIO;
402 	bzero(devices->name[0], 32);
403 	bzero(&devices->params[0], sizeof(struct ata_params));
404 	bzero(devices->name[1], 32);
405 	bzero(&devices->params[1], sizeof(struct ata_params));
406 	if (!device_get_children(device, &children, &nchildren)) {
407 	    for (i = 0; i < nchildren; i++) {
408 		if (children[i] && device_is_attached(children[i])) {
409 		    struct ata_device *atadev = device_get_softc(children[i]);
410 
411 		    if (atadev->unit == ATA_MASTER) { /* XXX SOS PM */
412 			strncpy(devices->name[0],
413 				device_get_nameunit(children[i]), 32);
414 			bcopy(&atadev->param, &devices->params[0],
415 			      sizeof(struct ata_params));
416 		    }
417 		    if (atadev->unit == ATA_SLAVE) { /* XXX SOS PM */
418 			strncpy(devices->name[1],
419 				device_get_nameunit(children[i]), 32);
420 			bcopy(&atadev->param, &devices->params[1],
421 			      sizeof(struct ata_params));
422 		    }
423 		}
424 	    }
425 	    free(children, M_TEMP);
426 	    error = 0;
427 	}
428 	else
429 	    error = ENODEV;
430 	break;
431 
432     default:
433 	if (ata_raid_ioctl_func)
434 	    error = ata_raid_ioctl_func(cmd, data);
435     }
436     return error;
437 }
438 
439 int
440 ata_device_ioctl(device_t dev, u_long cmd, caddr_t data)
441 {
442     struct ata_device *atadev = device_get_softc(dev);
443     struct ata_ioc_request *ioc_request = (struct ata_ioc_request *)data;
444     struct ata_params *params = (struct ata_params *)data;
445     int *mode = (int *)data;
446     struct ata_request *request;
447     caddr_t buf;
448     int error;
449 
450     switch (cmd) {
451     case IOCATAREQUEST:
452 	if (!(buf = malloc(ioc_request->count, M_ATA, M_NOWAIT))) {
453 	    return ENOMEM;
454 	}
455 	if (!(request = ata_alloc_request())) {
456 	    free(buf, M_ATA);
457 	    return  ENOMEM;
458 	}
459 	request->dev = atadev->dev;
460 	if (ioc_request->flags & ATA_CMD_WRITE) {
461 	    error = copyin(ioc_request->data, buf, ioc_request->count);
462 	    if (error) {
463 		free(buf, M_ATA);
464 		ata_free_request(request);
465 		return error;
466 	    }
467 	}
468 	if (ioc_request->flags & ATA_CMD_ATAPI) {
469 	    request->flags = ATA_R_ATAPI;
470 	    bcopy(ioc_request->u.atapi.ccb, request->u.atapi.ccb, 16);
471 	}
472 	else {
473 	    request->u.ata.command = ioc_request->u.ata.command;
474 	    request->u.ata.feature = ioc_request->u.ata.feature;
475 	    request->u.ata.lba = ioc_request->u.ata.lba;
476 	    request->u.ata.count = ioc_request->u.ata.count;
477 	}
478 	request->timeout = ioc_request->timeout;
479 	request->data = buf;
480 	request->bytecount = ioc_request->count;
481 	request->transfersize = request->bytecount;
482 	if (ioc_request->flags & ATA_CMD_CONTROL)
483 	    request->flags |= ATA_R_CONTROL;
484 	if (ioc_request->flags & ATA_CMD_READ)
485 	    request->flags |= ATA_R_READ;
486 	if (ioc_request->flags & ATA_CMD_WRITE)
487 	    request->flags |= ATA_R_WRITE;
488 	ata_queue_request(request);
489 	if (request->flags & ATA_R_ATAPI) {
490 	    bcopy(&request->u.atapi.sense, &ioc_request->u.atapi.sense,
491 		  sizeof(struct atapi_sense));
492 	}
493 	else {
494 	    ioc_request->u.ata.command = request->u.ata.command;
495 	    ioc_request->u.ata.feature = request->u.ata.feature;
496 	    ioc_request->u.ata.lba = request->u.ata.lba;
497 	    ioc_request->u.ata.count = request->u.ata.count;
498 	}
499 	ioc_request->error = request->result;
500 	if (ioc_request->flags & ATA_CMD_READ)
501 	    error = copyout(buf, ioc_request->data, ioc_request->count);
502 	else
503 	    error = 0;
504 	free(buf, M_ATA);
505 	ata_free_request(request);
506 	return error;
507 
508     case IOCATAGPARM:
509 	ata_getparam(atadev, 0);
510 	bcopy(&atadev->param, params, sizeof(struct ata_params));
511 	return 0;
512 
513     case IOCATASMODE:
514 	atadev->mode = *mode;
515 	ATA_SETMODE(device_get_parent(dev), dev);
516 	return 0;
517 
518     case IOCATAGMODE:
519 	*mode = atadev->mode;
520 	return 0;
521     case IOCATASSPINDOWN:
522 	atadev->spindown = *mode;
523 	return 0;
524     case IOCATAGSPINDOWN:
525 	*mode = atadev->spindown;
526 	return 0;
527     default:
528 	return ENOTTY;
529     }
530 }
531 
532 static void
533 ata_boot_attach(void)
534 {
535     struct ata_channel *ch;
536     int ctlr;
537 
538     mtx_lock(&Giant);       /* newbus suckage it needs Giant */
539 
540     /* kick of probe and attach on all channels */
541     for (ctlr = 0; ctlr < devclass_get_maxunit(ata_devclass); ctlr++) {
542 	if ((ch = devclass_get_softc(ata_devclass, ctlr))) {
543 	    ata_identify(ch->dev);
544 	}
545     }
546 
547     /* release the hook that got us here, we are only needed once during boot */
548     if (ata_delayed_attach) {
549 	config_intrhook_disestablish(ata_delayed_attach);
550 	free(ata_delayed_attach, M_TEMP);
551 	ata_delayed_attach = NULL;
552     }
553 
554     mtx_unlock(&Giant);     /* newbus suckage dealt with, release Giant */
555 }
556 
557 
558 /*
559  * misc support functions
560  */
561 static device_t
562 ata_add_child(device_t parent, struct ata_device *atadev, int unit)
563 {
564     device_t child;
565 
566     if ((child = device_add_child(parent, NULL, unit))) {
567 	device_set_softc(child, atadev);
568 	device_quiet(child);
569 	atadev->dev = child;
570 	atadev->max_iosize = DEV_BSIZE;
571 	atadev->mode = ATA_PIO_MAX;
572     }
573     return child;
574 }
575 
576 int
577 ata_getparam(struct ata_device *atadev, int init)
578 {
579     struct ata_channel *ch = device_get_softc(device_get_parent(atadev->dev));
580     struct ata_request *request;
581     u_int8_t command = 0;
582     int error = ENOMEM, retries = 2;
583 
584     if (ch->devices & (ATA_ATA_MASTER << atadev->unit))
585 	command = ATA_ATA_IDENTIFY;
586     if (ch->devices & (ATA_ATAPI_MASTER << atadev->unit))
587 	command = ATA_ATAPI_IDENTIFY;
588     if (!command)
589 	return ENXIO;
590 
591     while (retries-- > 0 && error) {
592 	if (!(request = ata_alloc_request()))
593 	    break;
594 	request->dev = atadev->dev;
595 	request->timeout = 1;
596 	request->retries = 0;
597 	request->u.ata.command = command;
598 	request->flags = (ATA_R_READ|ATA_R_AT_HEAD|ATA_R_DIRECT|ATA_R_QUIET);
599 	request->data = (void *)&atadev->param;
600 	request->bytecount = sizeof(struct ata_params);
601 	request->donecount = 0;
602 	request->transfersize = DEV_BSIZE;
603 	ata_queue_request(request);
604 	error = request->result;
605 	ata_free_request(request);
606     }
607 
608     if (!error && (isprint(atadev->param.model[0]) ||
609 		   isprint(atadev->param.model[1]))) {
610 	struct ata_params *atacap = &atadev->param;
611 	char buffer[64];
612 	int16_t *ptr;
613 
614 	for (ptr = (int16_t *)atacap;
615 	     ptr < (int16_t *)atacap + sizeof(struct ata_params)/2; ptr++) {
616 	    *ptr = le16toh(*ptr);
617 	}
618 	if (!(!strncmp(atacap->model, "FX", 2) ||
619 	      !strncmp(atacap->model, "NEC", 3) ||
620 	      !strncmp(atacap->model, "Pioneer", 7) ||
621 	      !strncmp(atacap->model, "SHARP", 5))) {
622 	    bswap(atacap->model, sizeof(atacap->model));
623 	    bswap(atacap->revision, sizeof(atacap->revision));
624 	    bswap(atacap->serial, sizeof(atacap->serial));
625 	}
626 	btrim(atacap->model, sizeof(atacap->model));
627 	bpack(atacap->model, atacap->model, sizeof(atacap->model));
628 	btrim(atacap->revision, sizeof(atacap->revision));
629 	bpack(atacap->revision, atacap->revision, sizeof(atacap->revision));
630 	btrim(atacap->serial, sizeof(atacap->serial));
631 	bpack(atacap->serial, atacap->serial, sizeof(atacap->serial));
632 
633 	if (bootverbose)
634 	    printf("ata%d-%s: pio=%s wdma=%s udma=%s cable=%s wire\n",
635 		   device_get_unit(ch->dev),
636 		   ata_unit2str(atadev),
637 		   ata_mode2str(ata_pmode(atacap)),
638 		   ata_mode2str(ata_wmode(atacap)),
639 		   ata_mode2str(ata_umode(atacap)),
640 		   (atacap->hwres & ATA_CABLE_ID) ? "80":"40");
641 
642 	if (init) {
643 	    sprintf(buffer, "%.40s/%.8s", atacap->model, atacap->revision);
644 	    device_set_desc_copy(atadev->dev, buffer);
645 	    if ((atadev->param.config & ATA_PROTO_ATAPI) &&
646 		(atadev->param.config != ATA_CFA_MAGIC1) &&
647 		(atadev->param.config != ATA_CFA_MAGIC2)) {
648 		if (atapi_dma &&
649 		    (atadev->param.config & ATA_DRQ_MASK) != ATA_DRQ_INTR &&
650 		    ata_umode(&atadev->param) >= ATA_UDMA2)
651 		    atadev->mode = ATA_DMA_MAX;
652 	    }
653 	    else {
654 		if (ata_dma &&
655 		    (ata_umode(&atadev->param) > 0 ||
656 		     ata_wmode(&atadev->param) > 0))
657 		    atadev->mode = ATA_DMA_MAX;
658 	    }
659 	}
660     }
661     else {
662 	if (!error)
663 	    error = ENXIO;
664     }
665     return error;
666 }
667 
668 int
669 ata_identify(device_t dev)
670 {
671     struct ata_channel *ch = device_get_softc(dev);
672     struct ata_device *devices[ATA_PM];
673     device_t childdevs[ATA_PM];
674     int i;
675 
676     if (bootverbose)
677 	device_printf(dev, "identify ch->devices=%08x\n", ch->devices);
678 
679     for (i = 0; i < ATA_PM; ++i) {
680 	if (ch->devices & (((ATA_ATA_MASTER | ATA_ATAPI_MASTER) << i))) {
681 	    int unit = -1;
682 
683 	    if (!(devices[i] = malloc(sizeof(struct ata_device),
684 				      M_ATA, M_NOWAIT | M_ZERO))) {
685 		device_printf(dev, "out of memory\n");
686 		return ENOMEM;
687 	    }
688 	    devices[i]->unit = i;
689 #ifdef ATA_STATIC_ID
690 	    if (ch->devices & ((ATA_ATA_MASTER << i)))
691 		unit = (device_get_unit(dev) << 1) + i;
692 #endif
693 	    if (!(childdevs[i] = ata_add_child(dev, devices[i], unit))) {
694 		free(devices[i], M_ATA);
695 		devices[i]=NULL;
696 	    }
697 	    else {
698 		if (ata_getparam(devices[i], 1)) {
699 		    device_delete_child(dev, childdevs[i]);
700 		    free(devices[i], M_ATA);
701 		    childdevs[i] = NULL;
702 		    devices[i] = NULL;
703 		}
704 	    }
705 	}
706 	devices[i] = NULL;
707 	childdevs[i] = NULL;
708     }
709 
710     bus_generic_probe(dev);
711     bus_generic_attach(dev);
712     return 0;
713 }
714 
715 void
716 ata_default_registers(device_t dev)
717 {
718     struct ata_channel *ch = device_get_softc(dev);
719 
720     /* fill in the defaults from whats setup already */
721     ch->r_io[ATA_ERROR].res = ch->r_io[ATA_FEATURE].res;
722     ch->r_io[ATA_ERROR].offset = ch->r_io[ATA_FEATURE].offset;
723     ch->r_io[ATA_IREASON].res = ch->r_io[ATA_COUNT].res;
724     ch->r_io[ATA_IREASON].offset = ch->r_io[ATA_COUNT].offset;
725     ch->r_io[ATA_STATUS].res = ch->r_io[ATA_COMMAND].res;
726     ch->r_io[ATA_STATUS].offset = ch->r_io[ATA_COMMAND].offset;
727     ch->r_io[ATA_ALTSTAT].res = ch->r_io[ATA_CONTROL].res;
728     ch->r_io[ATA_ALTSTAT].offset = ch->r_io[ATA_CONTROL].offset;
729 }
730 
731 void
732 ata_modify_if_48bit(struct ata_request *request)
733 {
734     struct ata_channel *ch = device_get_softc(device_get_parent(request->dev));
735     struct ata_device *atadev = device_get_softc(request->dev);
736 
737     atadev->flags &= ~ATA_D_48BIT_ACTIVE;
738 
739     if (((request->u.ata.lba + request->u.ata.count) >= ATA_MAX_28BIT_LBA ||
740 	 request->u.ata.count > 256) &&
741 	atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48) {
742 
743 	/* translate command into 48bit version */
744 	switch (request->u.ata.command) {
745 	case ATA_READ:
746 	    request->u.ata.command = ATA_READ48;
747 	    break;
748 	case ATA_READ_MUL:
749 	    request->u.ata.command = ATA_READ_MUL48;
750 	    break;
751 	case ATA_READ_DMA:
752 	    if (ch->flags & ATA_NO_48BIT_DMA) {
753 		if (request->transfersize > DEV_BSIZE)
754 		    request->u.ata.command = ATA_READ_MUL48;
755 		else
756 		    request->u.ata.command = ATA_READ48;
757 		request->flags &= ~ATA_R_DMA;
758 	    }
759 	    else
760 		request->u.ata.command = ATA_READ_DMA48;
761 	    break;
762 	case ATA_READ_DMA_QUEUED:
763 	    if (ch->flags & ATA_NO_48BIT_DMA) {
764 		if (request->transfersize > DEV_BSIZE)
765 		    request->u.ata.command = ATA_READ_MUL48;
766 		else
767 		    request->u.ata.command = ATA_READ48;
768 		request->flags &= ~ATA_R_DMA;
769 	    }
770 	    else
771 		request->u.ata.command = ATA_READ_DMA_QUEUED48;
772 	    break;
773 	case ATA_WRITE:
774 	    request->u.ata.command = ATA_WRITE48;
775 	    break;
776 	case ATA_WRITE_MUL:
777 	    request->u.ata.command = ATA_WRITE_MUL48;
778 	    break;
779 	case ATA_WRITE_DMA:
780 	    if (ch->flags & ATA_NO_48BIT_DMA) {
781 		if (request->transfersize > DEV_BSIZE)
782 		    request->u.ata.command = ATA_WRITE_MUL48;
783 		else
784 		    request->u.ata.command = ATA_WRITE48;
785 		request->flags &= ~ATA_R_DMA;
786 	    }
787 	    else
788 		request->u.ata.command = ATA_WRITE_DMA48;
789 	    break;
790 	case ATA_WRITE_DMA_QUEUED:
791 	    if (ch->flags & ATA_NO_48BIT_DMA) {
792 		if (request->transfersize > DEV_BSIZE)
793 		    request->u.ata.command = ATA_WRITE_MUL48;
794 		else
795 		    request->u.ata.command = ATA_WRITE48;
796 		request->u.ata.command = ATA_WRITE48;
797 		request->flags &= ~ATA_R_DMA;
798 	    }
799 	    else
800 		request->u.ata.command = ATA_WRITE_DMA_QUEUED48;
801 	    break;
802 	case ATA_FLUSHCACHE:
803 	    request->u.ata.command = ATA_FLUSHCACHE48;
804 	    break;
805 	case ATA_SET_MAX_ADDRESS:
806 	    request->u.ata.command = ATA_SET_MAX_ADDRESS48;
807 	    break;
808 	default:
809 	    return;
810 	}
811 	atadev->flags |= ATA_D_48BIT_ACTIVE;
812     }
813     else if (atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48) {
814 
815 	/* translate command into 48bit version */
816 	switch (request->u.ata.command) {
817 	case ATA_FLUSHCACHE:
818 	    request->u.ata.command = ATA_FLUSHCACHE48;
819 	    break;
820 	case ATA_READ_NATIVE_MAX_ADDRESS:
821 	    request->u.ata.command = ATA_READ_NATIVE_MAX_ADDRESS48;
822 	    break;
823 	case ATA_SET_MAX_ADDRESS:
824 	    request->u.ata.command = ATA_SET_MAX_ADDRESS48;
825 	    break;
826 	default:
827 	    return;
828 	}
829 	atadev->flags |= ATA_D_48BIT_ACTIVE;
830     }
831 }
832 
833 void
834 ata_udelay(int interval)
835 {
836     /* for now just use DELAY, the timer/sleep subsytems are not there yet */
837     if (1 || interval < (1000000/hz) || ata_delayed_attach)
838 	DELAY(interval);
839     else
840 	pause("ataslp", interval/(1000000/hz));
841 }
842 
843 char *
844 ata_unit2str(struct ata_device *atadev)
845 {
846     struct ata_channel *ch = device_get_softc(device_get_parent(atadev->dev));
847     static char str[8];
848 
849     if (ch->devices & ATA_PORTMULTIPLIER)
850 	sprintf(str, "port%d", atadev->unit);
851     else
852 	sprintf(str, "%s", atadev->unit == ATA_MASTER ? "master" : "slave");
853     return str;
854 }
855 
856 char *
857 ata_mode2str(int mode)
858 {
859     switch (mode) {
860     case -1: return "UNSUPPORTED";
861     case ATA_PIO0: return "PIO0";
862     case ATA_PIO1: return "PIO1";
863     case ATA_PIO2: return "PIO2";
864     case ATA_PIO3: return "PIO3";
865     case ATA_PIO4: return "PIO4";
866     case ATA_WDMA0: return "WDMA0";
867     case ATA_WDMA1: return "WDMA1";
868     case ATA_WDMA2: return "WDMA2";
869     case ATA_UDMA0: return "UDMA16";
870     case ATA_UDMA1: return "UDMA25";
871     case ATA_UDMA2: return "UDMA33";
872     case ATA_UDMA3: return "UDMA40";
873     case ATA_UDMA4: return "UDMA66";
874     case ATA_UDMA5: return "UDMA100";
875     case ATA_UDMA6: return "UDMA133";
876     case ATA_SA150: return "SATA150";
877     case ATA_SA300: return "SATA300";
878     case ATA_USB: return "USB";
879     case ATA_USB1: return "USB1";
880     case ATA_USB2: return "USB2";
881     default:
882 	if (mode & ATA_DMA_MASK)
883 	    return "BIOSDMA";
884 	else
885 	    return "BIOSPIO";
886     }
887 }
888 
889 int
890 ata_pmode(struct ata_params *ap)
891 {
892     if (ap->atavalid & ATA_FLAG_64_70) {
893 	if (ap->apiomodes & 0x02)
894 	    return ATA_PIO4;
895 	if (ap->apiomodes & 0x01)
896 	    return ATA_PIO3;
897     }
898     if (ap->mwdmamodes & 0x04)
899 	return ATA_PIO4;
900     if (ap->mwdmamodes & 0x02)
901 	return ATA_PIO3;
902     if (ap->mwdmamodes & 0x01)
903 	return ATA_PIO2;
904     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x200)
905 	return ATA_PIO2;
906     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x100)
907 	return ATA_PIO1;
908     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x000)
909 	return ATA_PIO0;
910     return ATA_PIO0;
911 }
912 
913 int
914 ata_wmode(struct ata_params *ap)
915 {
916     if (ap->mwdmamodes & 0x04)
917 	return ATA_WDMA2;
918     if (ap->mwdmamodes & 0x02)
919 	return ATA_WDMA1;
920     if (ap->mwdmamodes & 0x01)
921 	return ATA_WDMA0;
922     return -1;
923 }
924 
925 int
926 ata_umode(struct ata_params *ap)
927 {
928     if (ap->atavalid & ATA_FLAG_88) {
929 	if (ap->udmamodes & 0x40)
930 	    return ATA_UDMA6;
931 	if (ap->udmamodes & 0x20)
932 	    return ATA_UDMA5;
933 	if (ap->udmamodes & 0x10)
934 	    return ATA_UDMA4;
935 	if (ap->udmamodes & 0x08)
936 	    return ATA_UDMA3;
937 	if (ap->udmamodes & 0x04)
938 	    return ATA_UDMA2;
939 	if (ap->udmamodes & 0x02)
940 	    return ATA_UDMA1;
941 	if (ap->udmamodes & 0x01)
942 	    return ATA_UDMA0;
943     }
944     return -1;
945 }
946 
947 int
948 ata_limit_mode(device_t dev, int mode, int maxmode)
949 {
950     struct ata_device *atadev = device_get_softc(dev);
951 
952     if (maxmode && mode > maxmode)
953 	mode = maxmode;
954 
955     if (mode >= ATA_UDMA0 && ata_umode(&atadev->param) > 0)
956 	return min(mode, ata_umode(&atadev->param));
957 
958     if (mode >= ATA_WDMA0 && ata_wmode(&atadev->param) > 0)
959 	return min(mode, ata_wmode(&atadev->param));
960 
961     if (mode > ata_pmode(&atadev->param))
962 	return min(mode, ata_pmode(&atadev->param));
963 
964     return mode;
965 }
966 
967 static void
968 bswap(int8_t *buf, int len)
969 {
970     u_int16_t *ptr = (u_int16_t*)(buf + len);
971 
972     while (--ptr >= (u_int16_t*)buf)
973 	*ptr = ntohs(*ptr);
974 }
975 
976 static void
977 btrim(int8_t *buf, int len)
978 {
979     int8_t *ptr;
980 
981     for (ptr = buf; ptr < buf+len; ++ptr)
982 	if (!*ptr || *ptr == '_')
983 	    *ptr = ' ';
984     for (ptr = buf + len - 1; ptr >= buf && *ptr == ' '; --ptr)
985 	*ptr = 0;
986 }
987 
988 static void
989 bpack(int8_t *src, int8_t *dst, int len)
990 {
991     int i, j, blank;
992 
993     for (i = j = blank = 0 ; i < len; i++) {
994 	if (blank && src[i] == ' ') continue;
995 	if (blank && src[i] != ' ') {
996 	    dst[j++] = src[i];
997 	    blank = 0;
998 	    continue;
999 	}
1000 	if (src[i] == ' ') {
1001 	    blank = 1;
1002 	    if (i == 0)
1003 		continue;
1004 	}
1005 	dst[j++] = src[i];
1006     }
1007     if (j < len)
1008 	dst[j] = 0x00;
1009 }
1010 
1011 
1012 /*
1013  * module handeling
1014  */
1015 static int
1016 ata_module_event_handler(module_t mod, int what, void *arg)
1017 {
1018     static struct cdev *atacdev;
1019 
1020     switch (what) {
1021     case MOD_LOAD:
1022 	/* register controlling device */
1023 	atacdev = make_dev(&ata_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600, "ata");
1024 
1025 	if (cold) {
1026 	    /* register boot attach to be run when interrupts are enabled */
1027 	    if (!(ata_delayed_attach = (struct intr_config_hook *)
1028 				       malloc(sizeof(struct intr_config_hook),
1029 					      M_TEMP, M_NOWAIT | M_ZERO))) {
1030 		printf("ata: malloc of delayed attach hook failed\n");
1031 		return EIO;
1032 	    }
1033 	    ata_delayed_attach->ich_func = (void*)ata_boot_attach;
1034 	    if (config_intrhook_establish(ata_delayed_attach) != 0) {
1035 		printf("ata: config_intrhook_establish failed\n");
1036 		free(ata_delayed_attach, M_TEMP);
1037 	    }
1038 	}
1039 	return 0;
1040 
1041     case MOD_UNLOAD:
1042 	/* deregister controlling device */
1043 	destroy_dev(atacdev);
1044 	return 0;
1045 
1046     default:
1047 	return EOPNOTSUPP;
1048     }
1049 }
1050 
1051 static moduledata_t ata_moduledata = { "ata", ata_module_event_handler, NULL };
1052 DECLARE_MODULE(ata, ata_moduledata, SI_SUB_CONFIGURE, SI_ORDER_SECOND);
1053 MODULE_VERSION(ata, 1);
1054 
1055 static void
1056 ata_init(void)
1057 {
1058     ata_request_zone = uma_zcreate("ata_request", sizeof(struct ata_request),
1059 				   NULL, NULL, NULL, NULL, 0, 0);
1060     ata_composite_zone = uma_zcreate("ata_composite",
1061 				     sizeof(struct ata_composite),
1062 				     NULL, NULL, NULL, NULL, 0, 0);
1063 }
1064 SYSINIT(ata_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, ata_init, NULL);
1065 
1066 static void
1067 ata_uninit(void)
1068 {
1069     uma_zdestroy(ata_composite_zone);
1070     uma_zdestroy(ata_request_zone);
1071 }
1072 SYSUNINIT(ata_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, ata_uninit, NULL);
1073