xref: /freebsd/sys/dev/ic/nec765.h (revision 2a63c3be158216222d89a073dcbd6a72ee4aab5a)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1991 The Regents of the University of California.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	from: @(#)nec765.h	7.1 (Berkeley) 5/9/91
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 /* Data Rate Select Register DSR (enhanced controller) */
95 #define I8207X_DSR_SR	0x80	/* software reset */
96 #define I8207X_DSR_LP	0x40	/* low power */
97 #define I8207X_DSR_PS	0x1c	/* precompensation select */
98 #define I8207X_DSR_RS	0x03	/* data rate select */
99 
100 /* Commands */
101 /*
102  * the top three bits -- where appropriate -- are set as follows:
103  *
104  * MT  - multi-track; allow both sides to be handled in single cmd
105  * MFM - modified frequency modulation; use MFM encoding
106  * SK  - skip; skip sectors marked as "deleted"
107  */
108 
109 #define NE7CMD_MT	0x80	/* READ, WRITE, WRITEDEL, READDEL, SCAN* */
110 #define NE7CMD_MFM	0x40	/* same as MT, plus READTRK, READID, FORMAT */
111 #define NE7CMD_SK	0x20	/* READ, READDEL, SCAN* */
112 
113 #define NE7CMD_READTRK	0x02	/*  read whole track */
114 #define NE7CMD_SPECIFY	0x03	/*  specify drive parameters - requires unit
115 				 *  parameters byte */
116 #define NE7CMD_SENSED	0x04	/*  sense drive - requires unit select byte */
117 #define NE7CMD_WRITE	0x05	/*  write - requires eight additional bytes */
118 #define NE7CMD_READ	0x06	/*  read - requires eight additional bytes */
119 #define NE7CMD_RECAL	0x07	/*  recalibrate drive - requires
120 				 *  unit select byte */
121 #define NE7CMD_SENSEI	0x08	/*  sense controller interrupt status */
122 #define NE7CMD_WRITEDEL	0x09	/*  write deleted data */
123 #define NE7CMD_READID	0x0a	/*  read ID field */
124 #define NE7CMD_READDEL	0x0c	/*  read deleted data */
125 #define NE7CMD_FORMAT	0x0d	/*  format - requires five additional bytes */
126 #define NE7CMD_SEEK	0x0f	/*  seek drive - requires unit select byte
127 				 *  and new cyl byte */
128 #define NE7CMD_VERSION	0x10	/*  get version */
129 #define NE7CMD_SCNEQU	0x11	/*  scan equal */
130 #define NE7CMD_SCNLE	0x19	/*  scan less or equal */
131 #define NE7CMD_SCNGE	0x1d	/*  scan greater or equal */
132 
133 /*
134  * Enhanced controller commands:
135  */
136 #define I8207X_DUMPREG	0x0e	/*  dump internal registers */
137 #define I8207X_CONFIG	0x13	/*  configure enhanced features */
138 
139 /*
140  * "specify" definitions
141  *
142  * acronyms (times are relative to a FDC clock of 8 MHz):
143  * srt - step rate; PC usually 3 ms
144  * hut - head unload time; PC usually maximum of 240 ms
145  * hlt - head load time; PC usually minimum of 2 ms
146  * nd  - no DMA flag; PC usually not set (0)
147  */
148 
149 #define NE7_SPEC_1(srt, hut)	(((16 - (srt)) << 4) | (((hut) / 16)))
150 #define NE7_SPEC_2(hlt, nd)	(((hlt) & 0xFE) | ((nd) & 1))
151