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