2 * Copyright (c) 1997,1998 Junichi Satoh <junichi@astec.co.jp>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer as
10 * the first lines of this file unmodified.
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.
15 * THIS SOFTWARE IS PROVIDED BY Junichi Satoh ``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 Junichi Satoh 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.
30 * ATAPI Floppy, LS-120 driver
36 #if NWFD > 0 && NWDC > 0
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
43 #include <sys/malloc.h>
45 #include <sys/devicestat.h>
46 #include <sys/disklabel.h>
47 #include <sys/diskslice.h>
50 #include <i386/isa/atapi.h>
52 static d_open_t wfdopen;
53 static d_close_t wfdclose;
54 static d_ioctl_t wfdioctl;
55 static d_strategy_t wfdstrategy;
60 static struct cdevsw wfd_cdevsw = {
64 /* write */ physwrite,
68 /* strategy */ wfdstrategy,
77 int wfdattach(struct atapi*, int, struct atapi_params*, int);
79 #define NUNIT (NWDC*2) /* Max. number of devices */
80 #define UNIT(d) ((minor(d) >> 3) & 3) /* Unit part of minor device number */
82 #define F_BOPEN 0x0001 /* The block device is opened */
83 #define F_MEDIA_CHANGED 0x0002 /* The media have changed since open */
84 #define F_DEBUG 0x0004 /* Print debug info */
87 * LS-120 Capabilities and Mechanical Status Page
90 /* Mode data header */
93 #define MDT_UNKNOWN 0x00
94 #define MDT_NO_DISC 0x70
95 #define MDT_DOOR_OPEN 0x71
96 #define MDT_FMT_ERROR 0x72
98 #define MDT_2DD_UN 0x10
100 #define MDT_2HD_UN 0x20
101 #define MDT_2HD_12_98 0x22
102 #define MDT_2HD_12 0x23
103 #define MDT_2HD_144 0x24
104 #define MDT_LS120 0x31
106 unsigned reserved0 :7;
107 unsigned wp :1; /* Write protect */
110 /* Capabilities page */
111 unsigned page_code :6; /* Page code - Should be 0x5 */
112 #define CAP_PAGE 0x05
113 unsigned reserved1_6 :1; /* Reserved */
114 unsigned ps :1; /* The device is capable of saving the page */
115 u_char page_length; /* Page Length - Should be 0x1e */
116 u_short transfer_rate; /* In kilobits per second */
117 u_char heads, sectors; /* Number of heads, Number of sectors per track */
118 u_short sector_size; /* Byes per sector */
119 u_short cyls; /* Number of cylinders */
120 u_char reserved10[10];
121 u_char motor_delay; /* Motor off delay */
122 u_char reserved21[7];
123 u_short rpm; /* Rotations per minute */
124 u_char reserved30[2];
128 struct atapi *ata; /* Controller structure */
129 int unit; /* IDE bus drive unit */
130 int lun; /* Logical device unit */
131 int flags; /* Device state flags */
132 int refcnt; /* The number of raw opens */
133 int maxblks; /* transfer size limit */
134 struct buf_queue_head buf_queue; /* Queue of i/o requests */
135 struct atapi_params *param; /* Drive parameters table */
136 struct cappage cap; /* Capabilities page info */
137 char description[80]; /* Device description */
138 struct diskslices *dk_slices; /* virtual drives */
140 struct devstat device_stats;
143 static struct wfd *wfdtab[NUNIT]; /* Drive info by unit number */
144 static int wfdnlun = 0; /* Number of configured drives */
146 static void wfd_start (struct wfd *t);
147 static void wfd_done (struct wfd *t, struct buf *bp, int resid,
148 struct atapires result);
149 static void wfd_error (struct wfd *t, struct atapires result);
150 static int wfd_request_wait (struct wfd *t, u_char cmd, u_char a1, u_char a2,
151 u_char a3, u_char a4, u_char a5, u_char a6, u_char a7, u_char a8,
152 u_char a9, char *addr, int count);
153 static void wfd_describe (struct wfd *t);
154 static int wfd_eject (struct wfd *t, int closeit);
157 * Dump the array in hexadecimal format for debugging purposes.
159 static void wfd_dump (int lun, char *label, void *data, int len)
163 printf ("wfd%d: %s %x", lun, label, *p++);
165 printf ("-%x", *p++);
170 wfdattach (struct atapi *ata, int unit, struct atapi_params *ap, int debug)
173 struct atapires result;
176 if (wfdnlun >= NUNIT) {
177 printf ("wfd: too many units\n");
180 if (!atapi_request_immediate) {
181 printf("wfd: configuration error, ATAPI core code not present!\n");
182 printf("wfd: check `options ATAPI_STATIC' in your kernel config file!\n");
185 t = malloc (sizeof (struct wfd), M_TEMP, M_NOWAIT);
187 printf ("wfd: out of memory\n");
191 bzero (t, sizeof (struct wfd));
192 bufq_init(&t->buf_queue);
195 lun = t->lun = wfdnlun;
197 t->flags = F_MEDIA_CHANGED;
202 wfd_dump (t->lun, "info", ap, sizeof *ap);
205 /* Get drive capabilities. */
206 /* Do it twice to avoid the stale media changed state. */
207 for (i = 0; i < 2; i++) {
208 result = atapi_request_immediate (ata, unit, ATAPI_MODE_SENSE,
209 0, CAP_PAGE, 0, 0, 0, 0,
210 sizeof (t->cap) >> 8, sizeof (t->cap),
211 0, 0, 0, 0, 0, 0, 0, (char*) &t->cap, sizeof (t->cap));
214 if (result.code == RES_ERR &&
215 (result.error & AER_SKEY) == AER_SK_UNIT_ATTENTION)
216 result = atapi_request_immediate (ata, unit, ATAPI_MODE_SENSE,
217 0, CAP_PAGE, 0, 0, 0, 0, sizeof (t->cap) >> 8,
218 sizeof (t->cap), 0, 0, 0, 0, 0, 0, 0,
219 (char*) &t->cap, sizeof (t->cap));
221 /* Some drives have shorter capabilities page. */
222 if (result.code == RES_UNDERRUN)
225 if (result.code == 0) {
227 if (t->flags & F_DEBUG)
228 wfd_dump (t->lun, "cap", &t->cap, sizeof t->cap);
233 * The IOMEGA ZIP 100, at firmware 21.* and 23.* at least
234 * is known to lock up if transfers > 64 blocks are
237 if (!strcmp(ap->model, "IOMEGA ZIP 100 ATAPI")) {
238 printf("wfd%d: buggy Zip drive, 64-block transfer limit set\n",
242 t->maxblks = 0; /* no limit */
247 make_dev(&wfd_cdevsw, dkmakeminor(t->lun, WHOLE_DISK_SLICE, RAW_PART),
248 UID_ROOT, GID_OPERATOR, 0640, "rwfd%d", t->lun);
251 * Export the drive to the devstat interface.
253 devstat_add_entry(&t->device_stats, "wfd",
254 t->lun, t->cap.sector_size,
255 DEVSTAT_NO_ORDERED_TAGS,
256 DEVSTAT_TYPE_FLOPPY | DEVSTAT_TYPE_IF_IDE,
257 DEVSTAT_PRIORITY_WFD);
262 void wfd_describe (struct wfd *t)
266 t->cap.cyls = ntohs (t->cap.cyls);
267 t->cap.sector_size = ntohs (t->cap.sector_size);
269 printf ("wfd%d: ", t->lun);
270 switch (t->cap.medium_type) {
272 printf ("medium type unknown (no disk)");
276 printf ("2DD(capacity unknown) floppy disk loaded");
280 printf ("720KB floppy disk loaded");
283 printf ("2HD(capacity unknown) floppy disk loaded");
287 printf ("1.25MB(PC-9801 format) floppy disk loaded");
290 printf ("1.2MB floppy disk loaded");
293 printf ("1.44MB floppy disk loaded");
296 printf ("120MB floppy disk loaded");
299 printf ("no disc inside");
303 printf ("door open");
307 printf ("medium format error");
311 printf ("medium type=0x%x", t->cap.medium_type);
315 printf(", write protected");
319 printf ("wfd%d: ", t->lun);
320 printf ("%u cyls", t->cap.cyls);
321 printf (", %u heads, %u S/T", t->cap.heads, t->cap.sectors);
322 printf (", %u B/S", t->cap.sector_size);
327 int wfdopen (dev_t dev, int flags, int fmt, struct proc *p)
331 struct atapires result;
333 struct disklabel label;
335 /* Check that the device number is legal
336 * and the ATAPI driver is loaded. */
337 if (lun >= wfdnlun || ! atapi_request_immediate)
341 t->flags &= ~F_MEDIA_CHANGED;
342 /* Lock the media. */
343 wfd_request_wait (t, ATAPI_PREVENT_ALLOW,
344 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0);
346 /* Sense the media type */
347 result = atapi_request_wait (t->ata, t->unit, ATAPI_MODE_SENSE,
348 0, CAP_PAGE, 0, 0, 0, 0,
349 sizeof (t->cap) >> 8, sizeof (t->cap),
351 (char*) &t->cap, sizeof (t->cap));
353 printf ("wfd%d: Sense the media type is failed.\n", t->lun);
355 t->cap.cyls = ntohs (t->cap.cyls);
356 t->cap.sector_size = ntohs (t->cap.sector_size);
359 /* Build label for whole disk. */
360 bzero(&label, sizeof label);
361 label.d_secsize = t->cap.sector_size;
362 label.d_nsectors = t->cap.sectors;
363 label.d_ntracks = t->cap.heads;
364 label.d_ncylinders = t->cap.cyls;
365 label.d_secpercyl = t->cap.heads * t->cap.sectors;
367 label.d_secperunit = label.d_secpercyl * t->cap.cyls;
369 /* Initialize slice tables. */
370 errcode = dsopen(dev, fmt, 0, &t->dk_slices, &label);
379 * Close the device. Only called if we are the LAST
380 * occurence of an open device.
382 int wfdclose (dev_t dev, int flags, int fmt, struct proc *p)
385 struct wfd *t = wfdtab[lun];
387 dsclose(dev, fmt, t->dk_slices);
388 if(!dsisopen(t->dk_slices)) {
389 /* If we were the last open of the entire device, release it. */
391 wfd_request_wait (t, ATAPI_PREVENT_ALLOW,
392 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
393 t->flags &= ~F_BOPEN;
399 * Actually translate the requested transfer into one the physical driver can
400 * understand. The transfer is described by a buf and will include only one
403 void wfdstrategy (struct buf *bp)
405 int lun = UNIT(bp->b_dev);
406 struct wfd *t = wfdtab[lun];
409 /* If it's a null transfer, return immediatly. */
410 if (bp->b_bcount == 0) {
417 * Do bounds checking, adjust transfer, and set b_pblkno.
419 if (dscheck(bp, t->dk_slices) <= 0) {
426 /* Place it in the queue of disk activities for this disk. */
427 bufqdisksort (&t->buf_queue, bp);
429 /* Tell the device to get going on the transfer if it's
430 * not doing anything, otherwise just wait for completion. */
436 * Look to see if there is a buf waiting for the device
437 * and that the device is not already busy. If both are true,
438 * It dequeues the buf and creates an ATAPI command to perform the
439 * transfer in the buf.
440 * The bufs are queued by the strategy routine (wfdstrategy).
441 * Must be called at the correct (splbio) level.
443 static void wfd_start (struct wfd *t)
445 struct buf *bp = bufq_first(&t->buf_queue);
453 /* See if there is a buf to do and we are not already doing one. */
457 /* Unqueue the request. */
458 bufq_remove(&t->buf_queue, bp);
460 /* Tell devstat we are starting on the transaction */
461 devstat_start_transaction(&t->device_stats);
463 /* We have a buf, now we should make a command
464 * First, translate the block to absolute and put it in terms of the
465 * logical blocksize of the device. */
466 blkno = bp->b_pblkno / (t->cap.sector_size / 512);
467 nblk = (bp->b_bcount + (t->cap.sector_size - 1)) / t->cap.sector_size;
469 if ((t->maxblks == 0) || (nblk <= t->maxblks)) {
471 if(bp->b_flags & B_READ) {
472 op_code = ATAPI_READ_BIG;
473 count = bp->b_bcount;
475 op_code = ATAPI_WRITE_BIG;
476 count = -bp->b_bcount;
479 /* only one transfer */
480 (int)bp->b_driver1 = 0;
481 (int)bp->b_driver2 = 0;
482 atapi_request_callback (t->ata, t->unit, op_code, 0,
483 blkno>>24, blkno>>16, blkno>>8, blkno,
484 0, nblk>>8, nblk, 0, 0,
486 (u_char*) bp->b_data, count,
487 (void*)wfd_done, t, bp);
491 * We can't handle this request in a single
492 * read/write operation. Instead, queue a set of
493 * transfers, and record the number of transfers
494 * and the running residual in the b_driver
498 if(bp->b_flags & B_READ) {
499 op_code = ATAPI_READ_BIG;
501 op_code = ATAPI_WRITE_BIG;
504 /* calculate number of transfers */
505 (int)bp->b_driver1 = (nblk - 1) / t->maxblks;
506 (int)bp->b_driver2 = 0;
508 pxdest = (u_char *)bp->b_data;
509 pxcount = bp->b_bcount;
511 /* construct partial transfer requests */
513 pxnblk = min(nblk, t->maxblks);
514 count = min(pxcount, t->maxblks * t->cap.sector_size);
516 atapi_request_callback(t->ata, t->unit, op_code, 0,
517 blkno>>24, blkno>>16, blkno>>8,
518 blkno, 0, pxnblk>>8, pxnblk,
521 (bp->b_flags & B_READ) ?
523 (void*)wfd_done, t, bp);
532 static void wfd_done (struct wfd *t, struct buf *bp, int resid,
533 struct atapires result)
537 wfd_error (t, result);
539 bp->b_flags |= B_ERROR;
541 (int)bp->b_driver2 += resid;
543 * We can't call biodone until all outstanding
544 * transfer fragments are handled. If one hits
545 * an error, we will be returning an error, but
546 * only when all are complete.
548 if (((int)bp->b_driver1)-- <= 0) {
549 bp->b_resid = (int)bp->b_driver2;
550 devstat_end_transaction_buf(&t->device_stats, bp);
557 static void wfd_error (struct wfd *t, struct atapires result)
559 if (result.code != RES_ERR)
561 switch (result.error & AER_SKEY) {
562 case AER_SK_NOT_READY:
563 if (result.error & ~AER_SKEY) {
565 printf ("wfd%d: not ready\n", t->lun);
569 if (! (t->flags & F_MEDIA_CHANGED))
570 printf ("wfd%d: tray open\n", t->lun);
571 t->flags |= F_MEDIA_CHANGED;
574 case AER_SK_UNIT_ATTENTION:
576 if (! (t->flags & F_MEDIA_CHANGED))
577 printf ("wfd%d: media changed\n", t->lun);
578 t->flags |= F_MEDIA_CHANGED;
581 case AER_SK_ILLEGAL_REQUEST:
582 /* Unknown command or invalid command arguments. */
583 if (t->flags & F_DEBUG)
584 printf ("wfd%d: invalid command\n", t->lun);
587 printf ("wfd%d: i/o error, status=%b, error=%b\n", t->lun,
588 result.status, ARS_BITS, result.error, AER_BITS);
591 static int wfd_request_wait (struct wfd *t, u_char cmd, u_char a1, u_char a2,
592 u_char a3, u_char a4, u_char a5, u_char a6, u_char a7, u_char a8,
593 u_char a9, char *addr, int count)
595 struct atapires result;
597 result = atapi_request_wait (t->ata, t->unit, cmd,
598 a1, a2, a3, a4, a5, a6, a7, a8, a9, 0, 0, 0, 0, 0, 0,
601 wfd_error (t, result);
608 * Perform special action on behalf of the user.
609 * Knows about the internals of this device
611 int wfdioctl (dev_t dev, u_long cmd, caddr_t addr, int flag, struct proc *p)
614 struct wfd *t = wfdtab[lun];
617 error = dsioctl(dev, cmd, addr, flag, &t->dk_slices);
618 if (error != ENOIOCTL)
621 if (t->flags & F_MEDIA_CHANGED)
626 /* These ops are media change transparent. */
629 /* Lock the media. */
630 wfd_request_wait (t, ATAPI_PREVENT_ALLOW,
631 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0);
640 atapi_debug (t->ata, 1);
646 t->flags &= ~F_DEBUG;
647 atapi_debug (t->ata, 0);
653 return wfd_request_wait (t, ATAPI_TEST_UNIT_READY,
654 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
656 /* Don't allow eject if the device is opened
657 * by somebody (not us) in block mode. */
658 if ((t->flags & F_BOPEN) && t->refcnt)
660 return wfd_eject (t, 0);
662 if ((t->flags & F_BOPEN) && t->refcnt)
664 return wfd_eject (t, 1);
671 static int wfd_eject (struct wfd *t, int closeit)
673 struct atapires result;
675 /* Try to stop the disc. */
676 result = atapi_request_wait (t->ata, t->unit, ATAPI_START_STOP,
677 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
679 if (result.code == RES_ERR &&
680 ((result.error & AER_SKEY) == AER_SK_NOT_READY ||
681 (result.error & AER_SKEY) == AER_SK_UNIT_ATTENTION)) {
687 * The disc was unloaded.
688 * Load it (close tray).
689 * Read the table of contents.
691 err = wfd_request_wait (t, ATAPI_START_STOP,
692 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0);
696 /* Lock the media. */
697 wfd_request_wait (t, ATAPI_PREVENT_ALLOW,
698 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0);
704 wfd_error (t, result);
711 /* Give it some time to stop spinning. */
712 tsleep ((caddr_t)&lbolt, PRIBIO, "wfdej1", 0);
713 tsleep ((caddr_t)&lbolt, PRIBIO, "wfdej2", 0);
716 wfd_request_wait (t, ATAPI_PREVENT_ALLOW,
717 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
720 t->flags |= F_MEDIA_CHANGED;
721 return wfd_request_wait (t, ATAPI_START_STOP,
722 0, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0);
725 static void wfd_drvinit(void *unused)
727 cdevsw_add(&wfd_cdevsw);
730 SYSINIT(wfddev,SI_SUB_DRIVERS,SI_ORDER_MIDDLE+CDEV_MAJOR,wfd_drvinit,NULL)
732 #endif /* NWFD && NWDC */