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