1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2#ifndef _LINUX_FDREG_H
3#define _LINUX_FDREG_H
4/*
5 * This file contains some defines for the floppy disk controller.
6 * Various sources. Mostly "IBM Microcomputers: A Programmers
7 * Handbook", Sanches and Canton.
8 */
9
10/* 82077's auxiliary status registers A & B (R) */
11#define FD_SRA 0
12#define FD_SRB 1
13
14/* Digital Output Register */
15#define FD_DOR 2
16
17/* 82077's tape drive register (R/W) */
18#define FD_TDR 3
19
20/* 82077's data rate select register (W) */
21#define FD_DSR 4
22
23/* Fd controller regs. S&C, about page 340 */
24#define FD_STATUS 4
25#define FD_DATA 5
26
27/* Digital Input Register (read) */
28#define FD_DIR 7
29
30/* Diskette Control Register (write)*/
31#define FD_DCR 7
32
33/* Bits of main status register */
34#define STATUS_BUSYMASK 0x0F /* drive busy mask */
35#define STATUS_BUSY 0x10 /* FDC busy */
36#define STATUS_DMA 0x20 /* 0- DMA mode */
37#define STATUS_DIR 0x40 /* 0- cpu->fdc */
38#define STATUS_READY 0x80 /* Data reg ready */
39
40/* Bits of FD_ST0 */
41#define ST0_DS 0x03 /* drive select mask */
42#define ST0_HA 0x04 /* Head (Address) */
43#define ST0_NR 0x08 /* Not Ready */
44#define ST0_ECE 0x10 /* Equipment check error */
45#define ST0_SE 0x20 /* Seek end */
46#define ST0_INTR 0xC0 /* Interrupt code mask */
47
48/* Bits of FD_ST1 */
49#define ST1_MAM 0x01 /* Missing Address Mark */
50#define ST1_WP 0x02 /* Write Protect */
51#define ST1_ND 0x04 /* No Data - unreadable */
52#define ST1_OR 0x10 /* OverRun */
53#define ST1_CRC 0x20 /* CRC error in data or addr */
54#define ST1_EOC 0x80 /* End Of Cylinder */
55
56/* Bits of FD_ST2 */
57#define ST2_MAM 0x01 /* Missing Address Mark (again) */
58#define ST2_BC 0x02 /* Bad Cylinder */
59#define ST2_SNS 0x04 /* Scan Not Satisfied */
60#define ST2_SEH 0x08 /* Scan Equal Hit */
61#define ST2_WC 0x10 /* Wrong Cylinder */
62#define ST2_CRC 0x20 /* CRC error in data field */
63#define ST2_CM 0x40 /* Control Mark = deleted */
64
65/* Bits of FD_ST3 */
66#define ST3_HA 0x04 /* Head (Address) */
67#define ST3_DS 0x08 /* drive is double-sided */
68#define ST3_TZ 0x10 /* Track Zero signal (1=track 0) */
69#define ST3_RY 0x20 /* drive is ready */
70#define ST3_WP 0x40 /* Write Protect */
71#define ST3_FT 0x80 /* Drive Fault */
72
73/* Values for FD_COMMAND */
74#define FD_RECALIBRATE 0x07 /* move to track 0 */
75#define FD_SEEK 0x0F /* seek track */
76#define FD_READ 0xE6 /* read with MT, MFM, SKip deleted */
77#define FD_WRITE 0xC5 /* write with MT, MFM */
78#define FD_SENSEI 0x08 /* Sense Interrupt Status */
79#define FD_SPECIFY 0x03 /* specify HUT etc */
80#define FD_FORMAT 0x4D /* format one track */
81#define FD_VERSION 0x10 /* get version code */
82#define FD_CONFIGURE 0x13 /* configure FIFO operation */
83#define FD_PERPENDICULAR 0x12 /* perpendicular r/w mode */
84#define FD_GETSTATUS 0x04 /* read ST3 */
85#define FD_DUMPREGS 0x0E /* dump the contents of the fdc regs */
86#define FD_READID 0xEA /* prints the header of a sector */
87#define FD_UNLOCK 0x14 /* Fifo config unlock */
88#define FD_LOCK 0x94 /* Fifo config lock */
89#define FD_RSEEK_OUT 0x8f /* seek out (i.e. to lower tracks) */
90#define FD_RSEEK_IN 0xcf /* seek in (i.e. to higher tracks) */
91
92/* the following commands are new in the 82078. They are not used in the
93 * floppy driver, except the first three. These commands may be useful for apps
94 * which use the FDRAWCMD interface. For doc, get the 82078 spec sheets at
95 * http://www.intel.com/design/archives/periphrl/docs/29046803.htm */
96
97#define FD_PARTID 0x18 /* part id ("extended" version cmd) */
98#define FD_SAVE 0x2e /* save fdc regs for later restore */
99#define FD_DRIVESPEC 0x8e /* drive specification: Access to the
100 * 2 Mbps data transfer rate for tape
101 * drives */
102
103#define FD_RESTORE 0x4e /* later restore */
104#define FD_POWERDOWN 0x27 /* configure FDC's powersave features */
105#define FD_FORMAT_N_WRITE 0xef /* format and write in one go. */
106#define FD_OPTION 0x33 /* ISO format (which is a clean way to
107 * pack more sectors on a track) */
108
109/* DMA commands */
110#define DMA_READ 0x46
111#define DMA_WRITE 0x4A
112
113/* FDC version return types */
114#define FDC_NONE 0x00
115#define FDC_UNKNOWN 0x10 /* DO NOT USE THIS TYPE EXCEPT IF IDENTIFICATION
116 FAILS EARLY */
117#define FDC_8272A 0x20 /* Intel 8272a, NEC 765 */
118#define FDC_765ED 0x30 /* Non-Intel 1MB-compatible FDC, can't detect */
119#define FDC_82072 0x40 /* Intel 82072; 8272a + FIFO + DUMPREGS */
120#define FDC_82072A 0x45 /* 82072A (on Sparcs) */
121#define FDC_82077_ORIG 0x51 /* Original version of 82077AA, sans LOCK */
122#define FDC_82077 0x52 /* 82077AA-1 */
123#define FDC_82078_UNKN 0x5f /* Unknown 82078 variant */
124#define FDC_82078 0x60 /* 44pin 82078 or 64pin 82078SL */
125#define FDC_82078_1 0x61 /* 82078-1 (2Mbps fdc) */
126#define FDC_S82078B 0x62 /* S82078B (first seen on Adaptec AVA-2825 VLB
127 * SCSI/EIDE/Floppy controller) */
128#define FDC_87306 0x63 /* National Semiconductor PC 87306 */
129
130/*
131 * Beware: the fdc type list is roughly sorted by increasing features.
132 * Presence of features is tested by comparing the FDC version id with the
133 * "oldest" version that has the needed feature.
134 * If during FDC detection, an obscure test fails late in the sequence, don't
135 * assign FDC_UNKNOWN. Else the FDC will be treated as a dumb 8272a, or worse.
136 * This is especially true if the tests are unneeded.
137 */
138
139#define FD_RESET_DELAY 20
140#endif