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