fdcio.h revision 76588
1/*
2 * Copyright (C) 1992-1994,2001 by Joerg Wunsch, Dresden
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 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
20 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
21 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
24 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25 * DAMAGE.
26 *
27 * $FreeBSD: head/sys/sys/fdcio.h 76588 2001-05-14 20:20:11Z joerg $
28 */
29
30#ifndef	_MACHINE_IOCTL_FD_H_
31#define	_MACHINE_IOCTL_FD_H_
32
33#ifndef _KERNEL
34#include <sys/types.h>
35#endif
36#include <sys/ioccom.h>
37
38#define FD_FORMAT_VERSION 110	/* used to validate before formatting */
39#define FD_MAX_NSEC 36		/* highest known number of spt - allow for */
40				/* 2.88 MB drives */
41
42struct fd_formb {
43	int format_version;	/* == FD_FORMAT_VERSION */
44	int cyl, head;
45	int transfer_rate;	/* fdreg.h: FDC_???KBPS */
46
47	union {
48		struct fd_form_data {
49			/*
50			 * DO NOT CHANGE THE LAYOUT OF THIS STRUCTS
51			 * it is hardware-dependent since it exactly
52			 * matches the byte sequence to write to FDC
53			 * during its `format track' operation
54			 */
55			u_char secshift; /* 0 -> 128, ...; usually 2 -> 512 */
56			u_char nsecs;	/* must be <= FD_MAX_NSEC */
57			u_char gaplen;	/* GAP 3 length; usually 84 */
58			u_char fillbyte; /* usually 0xf6 */
59			struct fd_idfield_data {
60				/*
61				 * data to write into id fields;
62				 * for obscure formats, they mustn't match
63				 * the real values (but mostly do)
64				 */
65				u_char cylno;	/* 0 thru 79 (or 39) */
66				u_char headno;	/* 0, or 1 */
67				u_char secno;	/* starting at 1! */
68				u_char secsize;	/* usually 2 */
69			} idfields[FD_MAX_NSEC]; /* 0 <= idx < nsecs used */
70		} structured;
71		u_char raw[1];	/* to have continuous indexed access */
72	} format_info;
73};
74
75/* make life easier */
76# define fd_formb_secshift   format_info.structured.secshift
77# define fd_formb_nsecs      format_info.structured.nsecs
78# define fd_formb_gaplen     format_info.structured.gaplen
79# define fd_formb_fillbyte   format_info.structured.fillbyte
80/* these data must be filled in for(i = 0; i < fd_formb_nsecs; i++) */
81# define fd_formb_cylno(i)   format_info.structured.idfields[i].cylno
82# define fd_formb_headno(i)  format_info.structured.idfields[i].headno
83# define fd_formb_secno(i)   format_info.structured.idfields[i].secno
84# define fd_formb_secsize(i) format_info.structured.idfields[i].secsize
85
86struct fd_type {
87	int	sectrac;		/* sectors per track         */
88	int	secsize;		/* size code for sectors     */
89	int	datalen;		/* data len when secsize = 0 */
90	int	gap;			/* gap len between sectors   */
91	int	tracks;			/* total num of tracks       */
92	int	size;			/* size of disk in sectors   */
93	int	steptrac;		/* steps per cylinder        */
94	int	trans;			/* transfer speed code       */
95	int	heads;			/* number of heads	     */
96	int     f_gap;                  /* format gap len            */
97	int     f_inter;                /* format interleave factor  */
98};
99
100struct fdc_status {
101	u_int	status[7];
102};
103
104#define FD_FORM   _IOW('F', 61, struct fd_formb) /* format a track */
105#define FD_GTYPE  _IOR('F', 62, struct fd_type)  /* get drive type */
106#define FD_STYPE  _IOW('F', 63, struct fd_type)  /* set drive type */
107
108#define FD_GOPTS  _IOR('F', 64, int) /* drive options, see below */
109#define FD_SOPTS  _IOW('F', 65, int)
110
111#define FD_DEBUG  _IOW('F', 66, int)
112
113#define FD_CLRERR _IO('F', 67)	/* clear error counter */
114
115/*
116 * Obtain NE765 status registers.  Only successful if there is
117 * a valid status stored in fdc->status[].
118 */
119#define FD_GSTAT  _IOR('F', 68, struct fdc_status)
120
121/* Options for FD_GOPTS/FD_SOPTS, cleared on device close */
122#define FDOPT_NORETRY 0x0001	/* no retries on failure */
123#define FDOPT_NOERRLOG 0x002	/* no "hard error" kernel log messages */
124#define FDOPT_NOERROR 0x0004	/* do not indicate errors, caller will use
125				   FD_GSTAT in order to obtain status */
126
127/*
128 * The following definitions duplicate those in sys/i386/isa/fdreg.h
129 * They are here since their values are to be used in the above
130 * structure when formatting a floppy. For very obvious reasons, both
131 * definitions must match ;-)
132 */
133#ifndef FDC_500KBPS
134#define	FDC_500KBPS	0x00	/* 500KBPS MFM drive transfer rate */
135#define	FDC_300KBPS	0x01	/* 300KBPS MFM drive transfer rate */
136#define	FDC_250KBPS	0x02	/* 250KBPS MFM drive transfer rate */
137#define	FDC_125KBPS	0x03	/* 125KBPS FM drive transfer rate */
138				/* for some controllers 1MPBS instead */
139#endif /* FDC_500KBPS */
140
141#endif /* !_MACHINE_IOCTL_FD_H_ */
142