xref: /dragonfly/sys/dev/disk/fd/nec765.h (revision 2c64e990ea2bb1213bd0758af732469466873ba6)
1 /*-
2  * Copyright (c) 1991 The Regents of the University of California.
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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *        from: @(#)nec765.h  7.1 (Berkeley) 5/9/91
30  * $FreeBSD: src/sys/isa/ic/nec765.h,v 1.8 1999/08/28 00:46:04 peter Exp $
31  * $DragonFly: src/sys/dev/disk/fd/nec765.h,v 1.2 2003/06/17 04:28:40 dillon Exp $
32  */
33 
34 /*
35  * Nec 765 floppy disc controller definitions
36  */
37 
38 /* Main status register */
39 #define NE7_DAB     0x01      /* Diskette drive A is seeking, thus busy */
40 #define NE7_DBB     0x02      /* Diskette drive B is seeking, thus busy */
41 #define NE7_CB      0x10      /* Diskette Controller Busy */
42 #define NE7_NDM     0x20      /* Diskette Controller in Non Dma Mode */
43 #define NE7_DIO     0x40      /* Diskette Controller Data register I/O */
44 #define NE7_RQM     0x80      /* Diskette Controller ReQuest for Master */
45 
46 /* Status register ST0 */
47 #define NE7_ST0BITS "\020\010invld\007abnrml\006seek_cmplt\005equ_chck\004drive_notrdy\003top_head"
48 
49 #define NE7_ST0_IC  0xc0      /* interrupt completion code */
50 
51 #define NE7_ST0_IC_RC         0xc0      /* terminated due to ready changed, n/a */
52 #define NE7_ST0_IC_IV         0x80      /* invalid command; must reset FDC */
53 #define NE7_ST0_IC_AT         0x40      /* abnormal termination, check error stat */
54 #define NE7_ST0_IC_NT         0x00      /* normal termination */
55 
56 #define NE7_ST0_SE  0x20      /* seek end */
57 #define NE7_ST0_EC  0x10      /* equipment check, recalibrated but no trk0 */
58 #define NE7_ST0_NR  0x08      /* not ready (n/a) */
59 #define NE7_ST0_HD  0x04      /* upper head selected */
60 #define NE7_ST0_DR  0x03      /* drive code */
61 
62 /* Status register ST1 */
63 #define NE7_ST1BITS "\020\010end_of_cyl\006bad_crc\005data_overrun\003sec_not_fnd\002write_protect\001no_am"
64 
65 #define NE7_ST1_EN  0x80      /* end of cylinder, access past last record */
66 #define NE7_ST1_DE  0x20      /* data error, CRC fail in ID or data */
67 #define NE7_ST1_OR  0x10      /* DMA overrun, DMA failed to do i/o quickly */
68 #define NE7_ST1_ND  0x04      /* no data, sector not found or CRC in ID f. */
69 #define NE7_ST1_NW  0x02      /* not writeable, attempt to violate WP */
70 #define NE7_ST1_MA  0x01      /* missing address mark (in ID or data field)*/
71 
72 /* Status register ST2 */
73 #define NE7_ST2BITS "\020\007ctrl_mrk\006bad_crc\005wrong_cyl\004scn_eq\003scn_not_fnd\002bad_cyl\001no_dam"
74 
75 #define NE7_ST2_CM  0x40      /* control mark; found deleted data */
76 #define NE7_ST2_DD  0x20      /* data error in data field, CRC fail */
77 #define NE7_ST2_WC  0x10      /* wrong cylinder, ID field mismatches cmd */
78 #define NE7_ST2_SH  0x08      /* scan equal hit */
79 #define NE7_ST2_SN  0x04      /* scan not satisfied */
80 #define NE7_ST2_BC  0x02      /* bad cylinder, cylinder marked 0xff */
81 #define NE7_ST2_MD  0x01      /* missing address mark in data field */
82 
83 /* Status register ST3 */
84 #define NE7_ST3BITS "\020\010fault\007write_protect\006drdy\005tk0\004two_side\003side_sel\002"
85 
86 #define NE7_ST3_FT  0x80      /* fault; PC: n/a */
87 #define NE7_ST3_WP  0x40      /* write protected */
88 #define NE7_ST3_RD  0x20      /* ready; PC: always true */
89 #define NE7_ST3_T0  0x10      /* track 0 */
90 #define NE7_ST3_TS  0x08      /* two-sided; PC: n/a */
91 #define NE7_ST3_HD  0x04      /* upper head select */
92 #define NE7_ST3_US  0x03      /* unit select */
93 
94 /* Commands */
95 /*
96  * the top three bits -- where appropriate -- are set as follows:
97  *
98  * 0x80 - MT  multi-track; allow both sides to be handled in single cmd
99  * 0x40 - MFM modified frequency modulation; use MFM encoding
100  * 0x20 - SK  skip; skip sectors marked as "deleted"
101  */
102 #define NE7CMD_READTRK        0x42      /*  read whole track */
103 #define NE7CMD_SPECIFY        3         /*  specify drive parameters - requires unit
104                                                   parameters byte */
105 #define NE7CMD_SENSED         4         /*  sense drive - requires unit select byte */
106 #define NE7CMD_WRITE          0xc5      /*  write - requires eight additional bytes */
107 #define NE7CMD_READ 0xe6      /*  read - requires eight additional bytes */
108 #define NE7CMD_RECAL          7         /*  recalibrate drive - requires
109                                                   unit select byte */
110 #define NE7CMD_SENSEI         8         /*  sense controller interrupt status */
111 #define NE7CMD_WRITEDEL       0xc9      /*  write deleted data */
112 #define NE7CMD_READID         0x4a      /*  read ID field */
113 #define NE7CMD_READDEL        0xec      /*  read deleted data */
114 #define NE7CMD_FORMAT         0x4d      /*  format - requires five additional bytes */
115 #define NE7CMD_SEEK 0x0f      /*  seek drive - requires unit select byte
116                                                   and new cyl byte */
117 #define NE7CMD_SCNEQU         0xf1      /*  scan equal */
118 #define NE7CMD_SCNLE          0xf9      /*  scan less or equal */
119 #define NE7CMD_SCNGE          0xfd      /*  scan greater or equal */
120 
121 /*
122  * Enhanced controller commands:
123  */
124 #define NE7CMD_VERSION        0x10      /*  version (ok for all controllers) */
125 
126 #define I8207X_CONFIGURE 0x13   /*  configure enhanced features */
127 
128 /*
129  * "specify" definitions
130  *
131  * acronyms (times are relative to a FDC clock of 8 MHz):
132  * srt - step rate; PC usually 3 ms
133  * hut - head unload time; PC usually maximum of 240 ms
134  * hlt - head load time; PC usually minimum of 2 ms
135  * nd  - no DMA flag; PC usually not set (0)
136  */
137 
138 #define NE7_SPEC_1(srt, hut) (((16 - (srt)) << 4) | (((hut) / 16)))
139 #define NE7_SPEC_2(hlt, nd)  (((hlt) & 0xFE) | ((nd) & 1))
140