xref: /freebsd/sys/dev/ata/ata-all.c (revision c128b2d129a8e305b673ef5e3da76af1fb91ae60)
1 /*-
2  * Copyright (c) 1998 - 2006 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 #ifdef __alpha__
51 #include <machine/md_var.h>
52 #endif
53 #include <dev/ata/ata-all.h>
54 #include <ata_if.h>
55 
56 /* device structure */
57 static  d_ioctl_t       ata_ioctl;
58 static struct cdevsw ata_cdevsw = {
59 	.d_version =    D_VERSION,
60 	.d_flags =      D_NEEDGIANT, /* we need this as newbus isn't mpsafe */
61 	.d_ioctl =      ata_ioctl,
62 	.d_name =       "ata",
63 };
64 
65 /* prototypes */
66 static void ata_boot_attach(void);
67 static device_t ata_add_child(device_t, struct ata_device *, int);
68 static int ata_getparam(struct ata_device *, int);
69 static void bswap(int8_t *, int);
70 static void btrim(int8_t *, int);
71 static void bpack(int8_t *, int8_t *, int);
72 
73 /* global vars */
74 MALLOC_DEFINE(M_ATA, "ata_generic", "ATA driver generic layer");
75 int (*ata_raid_ioctl_func)(u_long cmd, caddr_t data) = NULL;
76 devclass_t ata_devclass;
77 uma_zone_t ata_request_zone;
78 uma_zone_t ata_composite_zone;
79 int ata_wc = 1;
80 
81 /* local vars */
82 static struct intr_config_hook *ata_delayed_attach = NULL;
83 static int ata_dma = 1;
84 static int atapi_dma = 1;
85 
86 /* sysctl vars */
87 SYSCTL_NODE(_hw, OID_AUTO, ata, CTLFLAG_RD, 0, "ATA driver parameters");
88 TUNABLE_INT("hw.ata.ata_dma", &ata_dma);
89 SYSCTL_INT(_hw_ata, OID_AUTO, ata_dma, CTLFLAG_RDTUN, &ata_dma, 0,
90 	   "ATA disk DMA mode control");
91 TUNABLE_INT("hw.ata.atapi_dma", &atapi_dma);
92 SYSCTL_INT(_hw_ata, OID_AUTO, atapi_dma, CTLFLAG_RDTUN, &atapi_dma, 0,
93 	   "ATAPI device DMA mode control");
94 TUNABLE_INT("hw.ata.wc", &ata_wc);
95 SYSCTL_INT(_hw_ata, OID_AUTO, wc, CTLFLAG_RDTUN, &ata_wc, 0,
96 	   "ATA disk write caching");
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 	tsleep(&error, PRIBIO, "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,
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 	tsleep(&dev, PRIBIO, "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=%llu", (unsigned long long)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 before entering suspend mode */
281     while (1) {
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 tranaction 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 	*value = devclass_get_maxunit(ata_devclass);
370 	error = 0;
371 	break;
372 
373     case IOCATAREINIT:
374 	if (*value > devclass_get_maxunit(ata_devclass) ||
375 	    !(device = devclass_get_device(ata_devclass, *value)))
376 	    return ENXIO;
377 	error = ata_reinit(device);
378 	ata_start(device);
379 	break;
380 
381     case IOCATAATTACH:
382 	if (*value > devclass_get_maxunit(ata_devclass) ||
383 	    !(device = devclass_get_device(ata_devclass, *value)))
384 	    return ENXIO;
385 	/* XXX SOS should enable channel HW on controller */
386 	error = ata_attach(device);
387 	break;
388 
389     case IOCATADETACH:
390 	if (*value > devclass_get_maxunit(ata_devclass) ||
391 	    !(device = devclass_get_device(ata_devclass, *value)))
392 	    return ENXIO;
393 	error = ata_detach(device);
394 	/* XXX SOS should disable channel HW on controller */
395 	break;
396 
397     case IOCATADEVICES:
398 	if (devices->channel > devclass_get_maxunit(ata_devclass) ||
399 	    !(device = devclass_get_device(ata_devclass, devices->channel)))
400 	    return ENXIO;
401 	bzero(devices->name[0], 32);
402 	bzero(&devices->params[0], sizeof(struct ata_params));
403 	bzero(devices->name[1], 32);
404 	bzero(&devices->params[1], sizeof(struct ata_params));
405 	if (!device_get_children(device, &children, &nchildren)) {
406 	    for (i = 0; i < nchildren; i++) {
407 		if (children[i] && device_is_attached(children[i])) {
408 		    struct ata_device *atadev = device_get_softc(children[i]);
409 
410 		    if (atadev->unit == ATA_MASTER) {
411 			strncpy(devices->name[0],
412 				device_get_nameunit(children[i]), 32);
413 			bcopy(&atadev->param, &devices->params[0],
414 			      sizeof(struct ata_params));
415 		    }
416 		    if (atadev->unit == ATA_SLAVE) {
417 			strncpy(devices->name[1],
418 				device_get_nameunit(children[i]), 32);
419 			bcopy(&atadev->param, &devices->params[1],
420 			      sizeof(struct ata_params));
421 		    }
422 		}
423 	    }
424 	    free(children, M_TEMP);
425 	    error = 0;
426 	}
427 	else
428 	    error = ENODEV;
429 	break;
430 
431     default:
432 	if (ata_raid_ioctl_func)
433 	    error = ata_raid_ioctl_func(cmd, data);
434     }
435     return error;
436 }
437 
438 int
439 ata_device_ioctl(device_t dev, u_long cmd, caddr_t data)
440 {
441     struct ata_device *atadev = device_get_softc(dev);
442     struct ata_ioc_request *ioc_request = (struct ata_ioc_request *)data;
443     struct ata_params *params = (struct ata_params *)data;
444     int *mode = (int *)data;
445     struct ata_request *request;
446     caddr_t buf;
447     int error;
448 
449     switch (cmd) {
450     case IOCATAREQUEST:
451 	if (!(buf = malloc(ioc_request->count, M_ATA, M_NOWAIT))) {
452 	    return ENOMEM;
453 	}
454 	if (!(request = ata_alloc_request())) {
455 	    free(buf, M_ATA);
456 	    return  ENOMEM;
457 	}
458 	if (ioc_request->flags & ATA_CMD_WRITE) {
459 	    error = copyin(ioc_request->data, buf, ioc_request->count);
460 	    if (error) {
461 		free(buf, M_ATA);
462 		ata_free_request(request);
463 		return error;
464 	    }
465 	}
466 	request->dev = dev;
467 	if (ioc_request->flags & ATA_CMD_ATAPI) {
468 	    request->flags = ATA_R_ATAPI;
469 	    bcopy(ioc_request->u.atapi.ccb, request->u.atapi.ccb, 16);
470 	}
471 	else {
472 	    request->u.ata.command = ioc_request->u.ata.command;
473 	    request->u.ata.feature = ioc_request->u.ata.feature;
474 	    request->u.ata.lba = ioc_request->u.ata.lba;
475 	    request->u.ata.count = ioc_request->u.ata.count;
476 	}
477 	request->timeout = ioc_request->timeout;
478 	request->data = buf;
479 	request->bytecount = ioc_request->count;
480 	request->transfersize = request->bytecount;
481 	if (ioc_request->flags & ATA_CMD_CONTROL)
482 	    request->flags |= ATA_R_CONTROL;
483 	if (ioc_request->flags & ATA_CMD_READ)
484 	    request->flags |= ATA_R_READ;
485 	if (ioc_request->flags & ATA_CMD_WRITE)
486 	    request->flags |= ATA_R_WRITE;
487 	ata_queue_request(request);
488 	if (!(request->flags & ATA_R_ATAPI)) {
489 	    ioc_request->u.ata.command = request->u.ata.command;
490 	    ioc_request->u.ata.feature = request->u.ata.feature;
491 	    ioc_request->u.ata.lba = request->u.ata.lba;
492 	    ioc_request->u.ata.count = request->u.ata.count;
493 	}
494 	ioc_request->error = request->result;
495 	if (ioc_request->flags & ATA_CMD_READ)
496 	    error = copyout(buf, ioc_request->data, ioc_request->count);
497 	else
498 	    error = 0;
499 	free(buf, M_ATA);
500 	ata_free_request(request);
501 	return error;
502 
503     case IOCATAGPARM:
504 	ata_getparam(atadev, 0);
505 	bcopy(&atadev->param, params, sizeof(struct ata_params));
506 	return 0;
507 
508     case IOCATASMODE:
509 	atadev->mode = *mode;
510 	ATA_SETMODE(device_get_parent(dev), dev);
511 	return 0;
512 
513     case IOCATAGMODE:
514 	*mode = atadev->mode;
515 	return 0;
516     default:
517 	return ENOTTY;
518     }
519 }
520 
521 static void
522 ata_boot_attach(void)
523 {
524     struct ata_channel *ch;
525     int ctlr;
526 
527     mtx_lock(&Giant);       /* newbus suckage it needs Giant */
528 
529     /* kick of probe and attach on all channels */
530     for (ctlr = 0; ctlr < devclass_get_maxunit(ata_devclass); ctlr++) {
531 	if ((ch = devclass_get_softc(ata_devclass, ctlr))) {
532 	    ata_identify(ch->dev);
533 	}
534     }
535 
536     /* release the hook that got us here, we are only needed once during boot */
537     if (ata_delayed_attach) {
538 	config_intrhook_disestablish(ata_delayed_attach);
539 	free(ata_delayed_attach, M_TEMP);
540 	ata_delayed_attach = NULL;
541     }
542 
543     mtx_unlock(&Giant);     /* newbus suckage dealt with, release Giant */
544 }
545 
546 
547 /*
548  * misc support functions
549  */
550 static device_t
551 ata_add_child(device_t parent, struct ata_device *atadev, int unit)
552 {
553     device_t child;
554 
555     if ((child = device_add_child(parent, NULL, unit))) {
556 	device_set_softc(child, atadev);
557 	device_quiet(child);
558 	atadev->dev = child;
559 	atadev->max_iosize = DEV_BSIZE;
560 	atadev->mode = ATA_PIO_MAX;
561     }
562     return child;
563 }
564 
565 static int
566 ata_getparam(struct ata_device *atadev, int init)
567 {
568     struct ata_channel *ch = device_get_softc(device_get_parent(atadev->dev));
569     struct ata_request *request;
570     u_int8_t command = 0;
571     int error = ENOMEM, retries = 2;
572 
573     if (ch->devices &
574 	(atadev->unit == ATA_MASTER ? ATA_ATA_MASTER : ATA_ATA_SLAVE))
575 	command = ATA_ATA_IDENTIFY;
576     if (ch->devices &
577 	(atadev->unit == ATA_MASTER ? ATA_ATAPI_MASTER : ATA_ATAPI_SLAVE))
578 	command = ATA_ATAPI_IDENTIFY;
579     if (!command)
580 	return ENXIO;
581 
582     while (retries-- > 0 && error) {
583 	if (!(request = ata_alloc_request()))
584 	    break;
585 	request->dev = atadev->dev;
586 	request->timeout = 1;
587 	request->retries = 0;
588 	request->u.ata.command = command;
589 	request->flags = (ATA_R_READ|ATA_R_AT_HEAD|ATA_R_DIRECT|ATA_R_QUIET);
590 	request->data = (void *)&atadev->param;
591 	request->bytecount = sizeof(struct ata_params);
592 	request->donecount = 0;
593 	request->transfersize = DEV_BSIZE;
594 	ata_queue_request(request);
595 	error = request->result;
596 	ata_free_request(request);
597     }
598 
599     if (!error && (isprint(atadev->param.model[0]) ||
600 		   isprint(atadev->param.model[1]))) {
601 	struct ata_params *atacap = &atadev->param;
602 	char buffer[64];
603 #if BYTE_ORDER == BIG_ENDIAN
604 	int16_t *ptr;
605 
606 	for (ptr = (int16_t *)atacap;
607 	     ptr < (int16_t *)atacap + sizeof(struct ata_params)/2; ptr++) {
608 	    *ptr = bswap16(*ptr);
609 	}
610 #endif
611 	if (!(!strncmp(atacap->model, "FX", 2) ||
612 	      !strncmp(atacap->model, "NEC", 3) ||
613 	      !strncmp(atacap->model, "Pioneer", 7) ||
614 	      !strncmp(atacap->model, "SHARP", 5))) {
615 	    bswap(atacap->model, sizeof(atacap->model));
616 	    bswap(atacap->revision, sizeof(atacap->revision));
617 	    bswap(atacap->serial, sizeof(atacap->serial));
618 	}
619 	btrim(atacap->model, sizeof(atacap->model));
620 	bpack(atacap->model, atacap->model, sizeof(atacap->model));
621 	btrim(atacap->revision, sizeof(atacap->revision));
622 	bpack(atacap->revision, atacap->revision, sizeof(atacap->revision));
623 	btrim(atacap->serial, sizeof(atacap->serial));
624 	bpack(atacap->serial, atacap->serial, sizeof(atacap->serial));
625 
626 	if (bootverbose)
627 	    printf("ata%d-%s: pio=%s wdma=%s udma=%s cable=%s wire\n",
628 		   ch->unit, atadev->unit == ATA_MASTER ? "master":"slave",
629 		   ata_mode2str(ata_pmode(atacap)),
630 		   ata_mode2str(ata_wmode(atacap)),
631 		   ata_mode2str(ata_umode(atacap)),
632 		   (atacap->hwres & ATA_CABLE_ID) ? "80":"40");
633 
634 	if (init) {
635 	    sprintf(buffer, "%.40s/%.8s", atacap->model, atacap->revision);
636 	    device_set_desc_copy(atadev->dev, buffer);
637 	    if (atadev->param.config & ATA_PROTO_ATAPI) {
638 		if (atapi_dma && ch->dma &&
639 		    (atadev->param.config & ATA_DRQ_MASK) != ATA_DRQ_INTR &&
640 		    ata_umode(&atadev->param) >= ATA_UDMA2)
641 		    atadev->mode = ATA_DMA_MAX;
642 	    }
643 	    else {
644 		if (ata_dma && ch->dma &&
645 		    (ata_umode(&atadev->param) > 0 ||
646 		     ata_wmode(&atadev->param) > 0))
647 		    atadev->mode = ATA_DMA_MAX;
648 	    }
649 	}
650     }
651     else {
652 	if (!error)
653 	    error = ENXIO;
654     }
655     return error;
656 }
657 
658 int
659 ata_identify(device_t dev)
660 {
661     struct ata_channel *ch = device_get_softc(dev);
662     struct ata_device *master = NULL, *slave = NULL;
663     device_t master_child = NULL, slave_child = NULL;
664     int master_unit = -1, slave_unit = -1;
665 
666     if (ch->devices & (ATA_ATA_MASTER | ATA_ATAPI_MASTER)) {
667 	if (!(master = malloc(sizeof(struct ata_device),
668 			      M_ATA, M_NOWAIT | M_ZERO))) {
669 	    device_printf(dev, "out of memory\n");
670 	    return ENOMEM;
671 	}
672 	master->unit = ATA_MASTER;
673     }
674     if (ch->devices & (ATA_ATA_SLAVE | ATA_ATAPI_SLAVE)) {
675 	if (!(slave = malloc(sizeof(struct ata_device),
676 			     M_ATA, M_NOWAIT | M_ZERO))) {
677 	    free(master, M_ATA);
678 	    device_printf(dev, "out of memory\n");
679 	    return ENOMEM;
680 	}
681 	slave->unit = ATA_SLAVE;
682     }
683 
684 #ifdef ATA_STATIC_ID
685     if (ch->devices & ATA_ATA_MASTER)
686 	master_unit = (device_get_unit(dev) << 1);
687 #endif
688     if (master && !(master_child = ata_add_child(dev, master, master_unit))) {
689 	free(master, M_ATA);
690 	master = NULL;
691     }
692 #ifdef ATA_STATIC_ID
693     if (ch->devices & ATA_ATA_SLAVE)
694 	slave_unit = (device_get_unit(dev) << 1) + 1;
695 #endif
696     if (slave && !(slave_child = ata_add_child(dev, slave, slave_unit))) {
697 	free(slave, M_ATA);
698 	slave = NULL;
699     }
700 
701     if (slave && ata_getparam(slave, 1)) {
702 	device_delete_child(dev, slave_child);
703 	free(slave, M_ATA);
704     }
705     if (master && ata_getparam(master, 1)) {
706 	device_delete_child(dev, master_child);
707 	free(master, M_ATA);
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 >= 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_READ_NATIVE_MAX_ADDDRESS:
806 	    request->u.ata.command = ATA_READ_NATIVE_MAX_ADDDRESS48;
807 	    break;
808 	case ATA_SET_MAX_ADDRESS:
809 	    request->u.ata.command = ATA_SET_MAX_ADDRESS48;
810 	    break;
811 	default:
812 	    return;
813 	}
814 	atadev->flags |= ATA_D_48BIT_ACTIVE;
815     }
816 }
817 
818 void
819 ata_udelay(int interval)
820 {
821     /* for now just use DELAY, the timer/sleep subsytems are not there yet */
822     if (1 || interval < (1000000/hz) || ata_delayed_attach)
823 	DELAY(interval);
824     else
825 	tsleep(&interval, PRIBIO, "ataslp", interval/(1000000/hz));
826 }
827 
828 char *
829 ata_mode2str(int mode)
830 {
831     switch (mode) {
832     case -1: return "UNSUPPORTED";
833     case ATA_PIO0: return "PIO0";
834     case ATA_PIO1: return "PIO1";
835     case ATA_PIO2: return "PIO2";
836     case ATA_PIO3: return "PIO3";
837     case ATA_PIO4: return "PIO4";
838     case ATA_WDMA0: return "WDMA0";
839     case ATA_WDMA1: return "WDMA1";
840     case ATA_WDMA2: return "WDMA2";
841     case ATA_UDMA0: return "UDMA16";
842     case ATA_UDMA1: return "UDMA25";
843     case ATA_UDMA2: return "UDMA33";
844     case ATA_UDMA3: return "UDMA40";
845     case ATA_UDMA4: return "UDMA66";
846     case ATA_UDMA5: return "UDMA100";
847     case ATA_UDMA6: return "UDMA133";
848     case ATA_SA150: return "SATA150";
849     case ATA_SA300: return "SATA300";
850     default:
851 	if (mode & ATA_DMA_MASK)
852 	    return "BIOSDMA";
853 	else
854 	    return "BIOSPIO";
855     }
856 }
857 
858 int
859 ata_pmode(struct ata_params *ap)
860 {
861     if (ap->atavalid & ATA_FLAG_64_70) {
862 	if (ap->apiomodes & 0x02)
863 	    return ATA_PIO4;
864 	if (ap->apiomodes & 0x01)
865 	    return ATA_PIO3;
866     }
867     if (ap->mwdmamodes & 0x04)
868 	return ATA_PIO4;
869     if (ap->mwdmamodes & 0x02)
870 	return ATA_PIO3;
871     if (ap->mwdmamodes & 0x01)
872 	return ATA_PIO2;
873     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x200)
874 	return ATA_PIO2;
875     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x100)
876 	return ATA_PIO1;
877     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x000)
878 	return ATA_PIO0;
879     return ATA_PIO0;
880 }
881 
882 int
883 ata_wmode(struct ata_params *ap)
884 {
885     if (ap->mwdmamodes & 0x04)
886 	return ATA_WDMA2;
887     if (ap->mwdmamodes & 0x02)
888 	return ATA_WDMA1;
889     if (ap->mwdmamodes & 0x01)
890 	return ATA_WDMA0;
891     return -1;
892 }
893 
894 int
895 ata_umode(struct ata_params *ap)
896 {
897     if (ap->atavalid & ATA_FLAG_88) {
898 	if (ap->udmamodes & 0x40)
899 	    return ATA_UDMA6;
900 	if (ap->udmamodes & 0x20)
901 	    return ATA_UDMA5;
902 	if (ap->udmamodes & 0x10)
903 	    return ATA_UDMA4;
904 	if (ap->udmamodes & 0x08)
905 	    return ATA_UDMA3;
906 	if (ap->udmamodes & 0x04)
907 	    return ATA_UDMA2;
908 	if (ap->udmamodes & 0x02)
909 	    return ATA_UDMA1;
910 	if (ap->udmamodes & 0x01)
911 	    return ATA_UDMA0;
912     }
913     return -1;
914 }
915 
916 int
917 ata_limit_mode(device_t dev, int mode, int maxmode)
918 {
919     struct ata_device *atadev = device_get_softc(dev);
920 
921     if (maxmode && mode > maxmode)
922 	mode = maxmode;
923 
924     if (mode >= ATA_UDMA0 && ata_umode(&atadev->param) > 0)
925 	return min(mode, ata_umode(&atadev->param));
926 
927     if (mode >= ATA_WDMA0 && ata_wmode(&atadev->param) > 0)
928 	return min(mode, ata_wmode(&atadev->param));
929 
930     if (mode > ata_pmode(&atadev->param))
931 	return min(mode, ata_pmode(&atadev->param));
932 
933     return mode;
934 }
935 
936 static void
937 bswap(int8_t *buf, int len)
938 {
939     u_int16_t *ptr = (u_int16_t*)(buf + len);
940 
941     while (--ptr >= (u_int16_t*)buf)
942 	*ptr = ntohs(*ptr);
943 }
944 
945 static void
946 btrim(int8_t *buf, int len)
947 {
948     int8_t *ptr;
949 
950     for (ptr = buf; ptr < buf+len; ++ptr)
951 	if (!*ptr || *ptr == '_')
952 	    *ptr = ' ';
953     for (ptr = buf + len - 1; ptr >= buf && *ptr == ' '; --ptr)
954 	*ptr = 0;
955 }
956 
957 static void
958 bpack(int8_t *src, int8_t *dst, int len)
959 {
960     int i, j, blank;
961 
962     for (i = j = blank = 0 ; i < len; i++) {
963 	if (blank && src[i] == ' ') continue;
964 	if (blank && src[i] != ' ') {
965 	    dst[j++] = src[i];
966 	    blank = 0;
967 	    continue;
968 	}
969 	if (src[i] == ' ') {
970 	    blank = 1;
971 	    if (i == 0)
972 		continue;
973 	}
974 	dst[j++] = src[i];
975     }
976     if (j < len)
977 	dst[j] = 0x00;
978 }
979 
980 
981 /*
982  * module handeling
983  */
984 static int
985 ata_module_event_handler(module_t mod, int what, void *arg)
986 {
987     static struct cdev *atacdev;
988 
989     switch (what) {
990     case MOD_LOAD:
991 	/* register controlling device */
992 	atacdev = make_dev(&ata_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600, "ata");
993 
994 	if (cold) {
995 	    /* register boot attach to be run when interrupts are enabled */
996 	    if (!(ata_delayed_attach = (struct intr_config_hook *)
997 				       malloc(sizeof(struct intr_config_hook),
998 					      M_TEMP, M_NOWAIT | M_ZERO))) {
999 		printf("ata: malloc of delayed attach hook failed\n");
1000 		return EIO;
1001 	    }
1002 	    ata_delayed_attach->ich_func = (void*)ata_boot_attach;
1003 	    if (config_intrhook_establish(ata_delayed_attach) != 0) {
1004 		printf("ata: config_intrhook_establish failed\n");
1005 		free(ata_delayed_attach, M_TEMP);
1006 	    }
1007 	}
1008 	return 0;
1009 
1010     case MOD_UNLOAD:
1011 	/* deregister controlling device */
1012 	destroy_dev(atacdev);
1013 	return 0;
1014 
1015     default:
1016 	return EOPNOTSUPP;
1017     }
1018 }
1019 
1020 static moduledata_t ata_moduledata = { "ata", ata_module_event_handler, NULL };
1021 DECLARE_MODULE(ata, ata_moduledata, SI_SUB_CONFIGURE, SI_ORDER_SECOND);
1022 MODULE_VERSION(ata, 1);
1023 
1024 static void
1025 ata_init(void)
1026 {
1027     ata_request_zone = uma_zcreate("ata_request", sizeof(struct ata_request),
1028 				   NULL, NULL, NULL, NULL, 0, 0);
1029     ata_composite_zone = uma_zcreate("ata_composite",
1030 				     sizeof(struct ata_composite),
1031 				     NULL, NULL, NULL, NULL, 0, 0);
1032 }
1033 SYSINIT(ata_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, ata_init, NULL);
1034 
1035 static void
1036 ata_uninit(void)
1037 {
1038     uma_zdestroy(ata_composite_zone);
1039     uma_zdestroy(ata_request_zone);
1040 }
1041 SYSUNINIT(ata_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, ata_uninit, NULL);
1042