8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man7d / fd.7d
blobecd82a7be6a3c4d30e711aa1cb79726e383e4831
1 '\" te
2 .\"  Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH FD 7D "Mar 2, 2007"
7 .SH NAME
8 fd, fdc \- drivers for floppy disks and floppy disk controllers
9 .SH SYNOPSIS
10 .SS "SPARC"
11 .LP
12 .nf
13 \fB/dev/diskette0\fR
14 .fi
16 .LP
17 .nf
18 \fB/dev/rdiskette0\fR
19 .fi
21 .SS "x86"
22 .LP
23 .nf
24 \fB/dev/diskette[0-1]\fR
25 .fi
27 .LP
28 .nf
29 \fB/dev/rdiskette[0-1]\fR
30 .fi
32 .SH DESCRIPTION
33 .sp
34 .LP
35 The \fBfd\fR and \fBfdc\fR drivers provide the interfaces to floppy disks using
36 the Intel 8272, Intel 82077, NEC 765, or compatible disk controllers on x86
37 based systems.
38 .sp
39 .LP
40 The default partitions for the floppy driver are:
41 .sp
42 .ne 2
43 .na
44 \fBa\fR
45 .ad
46 .RS 5n
47 All cylinders except the last
48 .RE
50 .sp
51 .ne 2
52 .na
53 \fBb\fR
54 .ad
55 .RS 5n
56 Only the last cylinder
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fBc\fR
63 .ad
64 .RS 5n
65 Entire diskette
66 .RE
68 .sp
69 .LP
70 The \fBfd\fR driver autosenses the density of the diskette.
71 .sp
72 .LP
73 When the floppy is first opened the driver looks for a SunOS label in logical
74 block 0 of the diskette. If attempts to read the SunOS label fail, the open
75 will fail. If block 0 is read successfully but a SunOS label is not found,
76 auto-sensed geometry and default partitioning are assumed.
77 .sp
78 .LP
79 The \fBfd\fR driver supports both block and raw interfaces.
80 .sp
81 .LP
82 The block files (\fB/dev/diskette*\fR) access the diskette using the system's
83 normal buffering mechanism and may be read and written without regard to
84 physical diskette records.
85 .sp
86 .LP
87 There is also a raw (\fB/dev/rdiskette*\fR) interface that provides for direct
88 transmission between the diskette and the user's read or write buffer. A single
89 \fBread\fR(2) or \fBwrite\fR(2) call usually results in one I/O operation;
90 therefore raw I/O is considerably more efficient when larger blocking factors
91 are used. A blocking factor of no less than 8 Kbytes is recommended. See the
92 Notes section, below, for information on the number of sectors per track.
93 .SS "3.5" Diskettes"
94 .sp
95 .LP
96 For 3.5" double-sided diskettes, the following densities are supported:
97 .SS "SPARC"
98 .sp
99 .ne 2
101 \fB1.7 Mbyte density\fR
103 .RS 21n
104 80 cylinders, 21 sectors per track, 1.7 Mbyte capacity
108 .ne 2
110 \fBhigh density\fR
112 .RS 21n
113 80 cylinders, 18 sectors per track, 1.44 Mbyte capacity
117 .ne 2
119 \fBdouble density\fR
121 .RS 21n
122 80 cylinders, 9 sectors per track, 720 Kbyte capacity
125 .SS "x86"
127 .ne 2
129 \fBextended density\fR
131 .RS 21n
132 80 cylinders, 36 sectors per track, 2.88 Mbyte capacity
136 .ne 2
138 \fB1.7 Mbyte density\fR
140 .RS 21n
141 80 cylinders, 21 sectors per track, 1.7 Mbyte capacity
145 .ne 2
147 \fBhigh density\fR
149 .RS 21n
150 80 cylinders, 18 sectors per track, 1.44 Mbyte capacity
154 .ne 2
156 \fBdouble density\fR
158 .RS 21n
159 80 cylinders, 9 sectors per track, 760 Kbyte capacity
162 .SS "5.25" Diskettes"
165 For 5.25" double-sided diskettes on x86 platforms, the densities listed below
166 are supported:
167 .SS "SPARC"
170 5.25" diskettes are not supported on SPARC platforms.
171 .SS "x86"
173 .ne 2
175 \fBhigh density\fR
177 .RS 18n
178 80 cylinders, 15 sectors per track, 1.2 Mbyte capacity
182 .ne 2
184 \fBdouble density\fR
186 .RS 18n
187 40 cylinders, 9 sectors per track, 360 Kbyte capacity
191 .ne 2
193 \fBdouble density\fR
195 .RS 18n
196 40 cylinders, 8 sectors per track, 320 Kbyte capacity
200 .ne 2
202 \fBquad density\fR
204 .RS 18n
205 80 cylinders, 9 sectors per track, 720 Kbyte capacity
209 .ne 2
211 \fBdouble density\fR
213 .RS 18n
214 40 cylinders, 16 sectors per track (256 bytes per sector), 320 Kbyte capacity
218 .ne 2
220 \fBdouble density\fR
222 .RS 18n
223 40 cylinders, 4 sectors per track (1024 bytes per sector), 320 Kbyte capacity
226 .SH ERRORS
228 .ne 2
230 \fB\fBEBUSY\fR\fR
232 .RS 10n
233 During opening, the partition has been opened for exclusive access and another
234 process wants to open the partition. Once open, this error is returned if the
235 floppy disk driver attempted to pass a command to the floppy disk controller
236 when the controller was busy handling another command. In this case, the
237 application should try the operation again.
241 .ne 2
243 \fB\fBEFAULT\fR\fR
245 .RS 10n
246 An invalid address was specified in an ioctl command (see \fBfdio\fR(7I)).
250 .ne 2
252 \fB\fBEINVAL\fR\fR
254 .RS 10n
255 The number of bytes read or written is not a multiple of the diskette's sector
256 size. This error is also returned when an unsupported command is specified
257 using the \fBFDIOCMD\fR ioctl command (see \fBfdio\fR(7I)).
261 .ne 2
263 \fB\fBEIO\fR\fR
265 .RS 10n
266 During opening, the diskette does not have a label or there is no diskette in
267 the drive. Once open, this error is returned if the requested I/O transfer
268 could not be completed.
272 .ne 2
274 \fB\fBENOSPC\fR\fR
276 .RS 10n
277 An attempt was made to write past the end of the diskette.
281 .ne 2
283 \fB\fBENOTTY\fR\fR
285 .RS 10n
286 The floppy disk driver does not support the requested ioctl functions (see
287 \fBfdio\fR(7I)).
291 .ne 2
293 \fB\fBENXIO\fR\fR
295 .RS 10n
296 The floppy disk device does not exist or the device is not ready.
300 .ne 2
302 \fB\fBEROFS\fR\fR
304 .RS 10n
305 The floppy disk device is opened for write access and the diskette in the drive
306 is write protected.
309 .SS "x86 Only"
311 .ne 2
313 \fB\fBENOSYS\fR\fR
315 .RS 10n
316 The floppy disk device does not support the requested ioctl function (
317 \fBFDEJECT\fR).
320 .SH X86 CONFIGURATION
323 The driver attempts to initialize itself using the information found in the
324 configuration file, \fB/platform/i86pc/kernel/drv/fd.conf\fR.
326 .in +2
328 name="fd"  parent="fdc"  unit=0;
329 name="fd"  parent="fdc"  unit=1;
331 .in -2
333 .SH FILES
334 .SS "SPARC"
336 .ne 2
338 \fB\fB/platform/sun4u/kernel/drv/fd\fR\fR
340 .sp .6
341 .RS 4n
342 driver module
346 .ne 2
348 \fB\fB/usr/include/sys/fdreg.h\fR\fR
350 .sp .6
351 .RS 4n
352 structs and definitions for Intel 82072 and 82077 controllers
356 .ne 2
358 \fB\fB/usr/include/sys/fdvar.h\fR\fR
360 .sp .6
361 .RS 4n
362 structs and definitions for floppy drivers
366 .ne 2
368 \fB\fB/dev/diskette\fR\fR
370 .sp .6
371 .RS 4n
372 device file
376 .ne 2
378 \fB\fB/dev/diskette0\fR\fR
380 .sp .6
381 .RS 4n
382 device file
386 .ne 2
388 \fB\fB/dev/rdiskette\fR\fR
390 .sp .6
391 .RS 4n
392 raw device file
396 .ne 2
398 \fB\fB/dev/rdiskette0\fR\fR
400 .sp .6
401 .RS 4n
402 raw device file
405 .SS "For ucb Compatibility"
407 .ne 2
409 \fB\fB/dev/fd0[a-c]\fR\fR
411 .RS 24n
412 block file
416 .ne 2
418 \fB\fB/dev/rfd0[a-c]\fR\fR
420 .RS 24n
421 raw file
425 .ne 2
427 \fB\fB/dev/diskette0\fR\fR
429 .RS 24n
430 directory containing volume management character device file
434 .ne 2
436 \fB\fB/dev/rdiskette0\fR\fR
438 .RS 24n
439 directory containing the volume management raw character device file
443 .ne 2
445 \fB\fB/dev/aliases/floppy0\fR\fR
447 .RS 24n
448 symbolic link to the entry in \fB/dev/rdiskette0\fR
451 .SS "x86"
453 .ne 2
455 \fB\fB/platform/i86pc/kernel/drv/fd\fR\fR
457 .sp .6
458 .RS 4n
459 driver module
463 .ne 2
465 \fB\fB/platform/i86pc/kernel/drv/fd.conf\fR\fR
467 .sp .6
468 .RS 4n
469 configuration file for floppy driver
473 .ne 2
475 \fB\fB/platform/i86pc/kernel/drv/fdc\fR\fR
477 .sp .6
478 .RS 4n
479 floppy-controller driver module
483 .ne 2
485 \fB\fB/platform/i86pc/kernel/drv/fdc.con\fRf\fR
487 .sp .6
488 .RS 4n
489 configuration file for the floppy-controller
493 .ne 2
495 \fB\fB/usr/include/sys/fdc.h\fR\fR
497 .sp .6
498 .RS 4n
499 structs and definitions for x86 floppy devices
503 .ne 2
505 \fB\fB/usr/include/sys/fdmedia.h\fR\fR
507 .sp .6
508 .RS 4n
509 structs and definitions for x86 floppy media
512 .SS "x86 First Drive"
514 .ne 2
516 \fB\fB/dev/diskette\fR\fR
518 .RS 19n
519 device file
523 .ne 2
525 \fB\fB/dev/diskette0\fR\fR
527 .RS 19n
528 device file
532 .ne 2
534 \fB\fB/dev/rdiskette\fR\fR
536 .RS 19n
537 raw device file
541 .ne 2
543 \fB\fB/dev/rdiskette0\fR\fR
545 .RS 19n
546 raw device file
549 .SS "For ucb Compatibility"
551 .ne 2
553 \fB\fB/dev/fd0[a-c]\fR\fR
555 .RS 24n
556 block file
560 .ne 2
562 \fB\fB/dev/rfd0[a-c]\fR\fR
564 .RS 24n
565 raw file
569 .ne 2
571 \fB\fB/dev/diskette0\fR\fR
573 .RS 24n
574 directory containing volume management character device file
578 .ne 2
580 \fB\fB/dev/rdiskette0\fR\fR
582 .RS 24n
583 directory containing the volume management raw character device file
587 .ne 2
589 \fB\fB/dev/aliases/floppy0\fR\fR
591 .RS 24n
592 symbolic link to the entry in /dev/rdiskette0
595 .SS "x86 Second Drive"
597 .ne 2
599 \fB\fB/dev/diskette1\fR\fR
601 .RS 19n
602 device file
606 .ne 2
608 \fB\fB/dev/rdiskette1\fR\fR
610 .RS 19n
611 raw device file
614 .SS "For ucb Compatibility"
616 .ne 2
618 \fB\fB/dev/fd1[a-c]\fR\fR
620 .RS 24n
621 block file
625 .ne 2
627 \fB\fB/dev/rfd1[a-c]\fR\fR
629 .RS 24n
630 raw file
634 .ne 2
636 \fB\fB/dev/diskette1\fR\fR
638 .RS 24n
639 directory containing volume management character device file
643 .ne 2
645 \fB\fB/dev/rdiskette1\fR\fR
647 .RS 24n
648 directory containing the volume management raw character device file
652 .ne 2
654 \fB\fB/dev/aliases/floppy1\fR\fR
656 .RS 24n
657 symbolic link to the entry in \fB/dev/rdiskette1\fR
660 .SH SEE ALSO
663 \fBfdformat\fR(1), \fBdd\fR(1M), \fBdrvconfig\fR(1M), \fBread\fR(2),
664 \fBwrite\fR(2), \fBdriver.conf\fR(4), \fBdkio\fR(7I) \fBfdio\fR(7I)
665 .SH DIAGNOSTICS
666 .SS "All Platforms"
668 .ne 2
670 \fB\fBfd<n>: <command name> failed (<sr1> <sr2> <sr3>)\fR\fR
672 .sp .6
673 .RS 4n
674 The <command name> failed after several retries on drive <n>. The three hex
675 values in parenthesis are the contents of status register 0, status register 1,
676 and status register 2 of the Intel 8272, the Intel 82072, and the Intel 82077
677 Floppy Disk Controller on completion of the command, as documented in the data
678 sheet for that part. This error message is usually followed by one of the
679 following, interpreting the bits of the status register:
681 .ne 2
683 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
685 .RS 10n
686 \fBnot writable\fR
690 .ne 2
692 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
694 .RS 10n
695 \fBcrc error blk <block number>\fR
697 There was a data error on <block number>.
701 .ne 2
703 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
705 .RS 10n
706 \fBbad format\fR
710 .ne 2
712 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
714 .RS 10n
715 \fBtimeout\fR
719 .ne 2
721 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
723 .RS 10n
724 \fBdrive not ready\fR
728 .ne 2
730 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
732 .RS 10n
733 \fBunformatted diskette or no diskette in drive\fR
737 .ne 2
739 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
741 .RS 10n
742 \fBblock <block number> is past the end!\fR
744 \fB(nblk=<total number of blocks>)\fR
746 The operation tried to access a block number that is greater than the total
747 number of blocks.
751 .ne 2
753 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
755 .RS 10n
756 \fBb_bcount 0x<op_size> not % 0x<sect_size>\fR
758 The size of an operation is not a multiple of the sector size.
762 .ne 2
764 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
766 .RS 10n
767 \fBoverrun/underrun\fR
771 .ne 2
773 \fB\fBfd<\fR\fIn\fR\fB>:\fR\fR
775 .RS 10n
776 \fBhost bus error\fR. There was a hardware error on a system bus.
781 .SS "SPARC Only"
784 Overrun/underrun errors occur when accessing a diskette while the system is
785 heavily loaded. Decrease the load on the system and retry the diskette access.
786 .SH NOTES
789 3.5" high density diskettes have 18 sectors per track and 5.25" high density
790 diskettes have 15 sectors per track. They can cross a track (though not a
791 cylinder) boundary without losing data, so when using \fBdd\fR(1M) or
792 \fBread\fR(2)/\fBwrite\fR(2) calls to or from the raw diskette, you should
793 specify \fBbs=18k\fR or multiples thereof for 3.5" diskettes, and \fBbs=15k\fR
794 or multiples thereof for 5.25" diskettes.
797 The SPARC \fBfd\fR driver is \fInot\fR an unloadable module.
800 Under Solaris (x86 Edition), the configuration of the floppy drives is
801 specified in \fBCMOS\fR configuration memory. Use the \fBBIOS\fR setup program
802 for the system to define the diskette size and density/capacity for each
803 installed drive. Note that \fBMS-DOS\fR may operate the floppy drives
804 correctly, even though the \fBCMOS\fR configuration may be in error. Solaris
805 (x86 Edition) relies on the \fBCMOS\fR configuration to be accurate.