1#ifndef _UAPI_LINUX_FD_H 2#define _UAPI_LINUX_FD_H 3 4#include <linux/ioctl.h> 5#include <linux/compiler.h> 6 7/* New file layout: Now the ioctl definitions immediately follow the 8 * definitions of the structures that they use */ 9 10/* 11 * Geometry 12 */ 13struct floppy_struct { 14 unsigned int size, /* nr of sectors total */ 15 sect, /* sectors per track */ 16 head, /* nr of heads */ 17 track, /* nr of tracks */ 18 stretch; /* bit 0 !=0 means double track steps */ 19 /* bit 1 != 0 means swap sides */ 20 /* bits 2..9 give the first sector */ 21 /* number (the LSB is flipped) */ 22#define FD_STRETCH 1 23#define FD_SWAPSIDES 2 24#define FD_ZEROBASED 4 25#define FD_SECTBASEMASK 0x3FC 26#define FD_MKSECTBASE(s) (((s) ^ 1) << 2) 27#define FD_SECTBASE(floppy) ((((floppy)->stretch & FD_SECTBASEMASK) >> 2) ^ 1) 28 29 unsigned char gap, /* gap1 size */ 30 31 rate, /* data rate. |= 0x40 for perpendicular */ 32#define FD_2M 0x4 33#define FD_SIZECODEMASK 0x38 34#define FD_SIZECODE(floppy) (((((floppy)->rate&FD_SIZECODEMASK)>> 3)+ 2) %8) 35#define FD_SECTSIZE(floppy) ( (floppy)->rate & FD_2M ? \ 36 512 : 128 << FD_SIZECODE(floppy) ) 37#define FD_PERP 0x40 38 39 spec1, /* stepping rate, head unload time */ 40 fmt_gap; /* gap2 size */ 41 const char * name; /* used only for predefined formats */ 42}; 43 44 45/* commands needing write access have 0x40 set */ 46/* commands needing super user access have 0x80 set */ 47 48#define FDCLRPRM _IO(2, 0x41) 49/* clear user-defined parameters */ 50 51#define FDSETPRM _IOW(2, 0x42, struct floppy_struct) 52#define FDSETMEDIAPRM FDSETPRM 53/* set user-defined parameters for current media */ 54 55#define FDDEFPRM _IOW(2, 0x43, struct floppy_struct) 56#define FDGETPRM _IOR(2, 0x04, struct floppy_struct) 57#define FDDEFMEDIAPRM FDDEFPRM 58#define FDGETMEDIAPRM FDGETPRM 59/* set/get disk parameters */ 60 61 62#define FDMSGON _IO(2,0x45) 63#define FDMSGOFF _IO(2,0x46) 64/* issue/don't issue kernel messages on media type change */ 65 66 67/* 68 * Formatting (obsolete) 69 */ 70#define FD_FILL_BYTE 0xF6 /* format fill byte. */ 71 72struct format_descr { 73 unsigned int device,head,track; 74}; 75 76#define FDFMTBEG _IO(2,0x47) 77/* begin formatting a disk */ 78#define FDFMTTRK _IOW(2,0x48, struct format_descr) 79/* format the specified track */ 80#define FDFMTEND _IO(2,0x49) 81/* end formatting a disk */ 82 83 84/* 85 * Error thresholds 86 */ 87struct floppy_max_errors { 88 unsigned int 89 abort, /* number of errors to be reached before aborting */ 90 read_track, /* maximal number of errors permitted to read an 91 * entire track at once */ 92 reset, /* maximal number of errors before a reset is tried */ 93 recal, /* maximal number of errors before a recalibrate is 94 * tried */ 95 96 /* 97 * Threshold for reporting FDC errors to the console. 98 * Setting this to zero may flood your screen when using 99 * ultra cheap floppies ;-) 100 */ 101 reporting; 102 103}; 104 105#define FDSETEMSGTRESH _IO(2,0x4a) 106/* set fdc error reporting threshold */ 107 108#define FDFLUSH _IO(2,0x4b) 109/* flush buffers for media; either for verifying media, or for 110 * handling a media change without closing the file descriptor */ 111 112#define FDSETMAXERRS _IOW(2, 0x4c, struct floppy_max_errors) 113#define FDGETMAXERRS _IOR(2, 0x0e, struct floppy_max_errors) 114/* set/get abortion and read_track threshold. See also floppy_drive_params 115 * structure */ 116 117 118typedef char floppy_drive_name[16]; 119#define FDGETDRVTYP _IOR(2, 0x0f, floppy_drive_name) 120/* get drive type: 5 1/4 or 3 1/2 */ 121 122 123/* 124 * Drive parameters (user modifiable) 125 */ 126struct floppy_drive_params { 127 signed char cmos; /* CMOS type */ 128 129 /* Spec2 is (HLD<<1 | ND), where HLD is head load time (1=2ms, 2=4 ms 130 * etc) and ND is set means no DMA. Hardcoded to 6 (HLD=6ms, use DMA). 131 */ 132 unsigned long max_dtr; /* Step rate, usec */ 133 unsigned long hlt; /* Head load/settle time, msec */ 134 unsigned long hut; /* Head unload time (remnant of 135 * 8" drives) */ 136 unsigned long srt; /* Step rate, usec */ 137 138 unsigned long spinup; /* time needed for spinup (expressed 139 * in jiffies) */ 140 unsigned long spindown; /* timeout needed for spindown */ 141 unsigned char spindown_offset; /* decides in which position the disk 142 * will stop */ 143 unsigned char select_delay; /* delay to wait after select */ 144 unsigned char rps; /* rotations per second */ 145 unsigned char tracks; /* maximum number of tracks */ 146 unsigned long timeout; /* timeout for interrupt requests */ 147 148 unsigned char interleave_sect; /* if there are more sectors, use 149 * interleave */ 150 151 struct floppy_max_errors max_errors; 152 153 char flags; /* various flags, including ftd_msg */ 154/* 155 * Announce successful media type detection and media information loss after 156 * disk changes. 157 * Also used to enable/disable printing of overrun warnings. 158 */ 159 160#define FTD_MSG 0x10 161#define FD_BROKEN_DCL 0x20 162#define FD_DEBUG 0x02 163#define FD_SILENT_DCL_CLEAR 0x4 164#define FD_INVERTED_DCL 0x80 /* must be 0x80, because of hardware 165 considerations */ 166 167 char read_track; /* use readtrack during probing? */ 168 169/* 170 * Auto-detection. Each drive type has eight formats which are 171 * used in succession to try to read the disk. If the FDC cannot lock onto 172 * the disk, the next format is tried. This uses the variable 'probing'. 173 */ 174 short autodetect[8]; /* autodetected formats */ 175 176 int checkfreq; /* how often should the drive be checked for disk 177 * changes */ 178 int native_format; /* native format of this drive */ 179}; 180 181enum { 182 FD_NEED_TWADDLE_BIT, /* more magic */ 183 FD_VERIFY_BIT, /* inquire for write protection */ 184 FD_DISK_NEWCHANGE_BIT, /* change detected, and no action undertaken yet 185 * to clear media change status */ 186 FD_UNUSED_BIT, 187 FD_DISK_CHANGED_BIT, /* disk has been changed since last i/o */ 188 FD_DISK_WRITABLE_BIT, /* disk is writable */ 189 FD_OPEN_SHOULD_FAIL_BIT 190}; 191 192#define FDSETDRVPRM _IOW(2, 0x90, struct floppy_drive_params) 193#define FDGETDRVPRM _IOR(2, 0x11, struct floppy_drive_params) 194/* set/get drive parameters */ 195 196 197/* 198 * Current drive state (not directly modifiable by user, readonly) 199 */ 200struct floppy_drive_struct { 201 unsigned long flags; 202/* values for these flags */ 203#define FD_NEED_TWADDLE (1 << FD_NEED_TWADDLE_BIT) 204#define FD_VERIFY (1 << FD_VERIFY_BIT) 205#define FD_DISK_NEWCHANGE (1 << FD_DISK_NEWCHANGE_BIT) 206#define FD_DISK_CHANGED (1 << FD_DISK_CHANGED_BIT) 207#define FD_DISK_WRITABLE (1 << FD_DISK_WRITABLE_BIT) 208 209 unsigned long spinup_date; 210 unsigned long select_date; 211 unsigned long first_read_date; 212 short probed_format; 213 short track; /* current track */ 214 short maxblock; /* id of highest block read */ 215 short maxtrack; /* id of highest half track read */ 216 int generation; /* how many diskchanges? */ 217 218/* 219 * (User-provided) media information is _not_ discarded after a media change 220 * if the corresponding keep_data flag is non-zero. Positive values are 221 * decremented after each probe. 222 */ 223 int keep_data; 224 225 /* Prevent "aliased" accesses. */ 226 int fd_ref; 227 int fd_device; 228 unsigned long last_checked; /* when was the drive last checked for a disk 229 * change? */ 230 231 char *dmabuf; 232 int bufblocks; 233}; 234 235#define FDGETDRVSTAT _IOR(2, 0x12, struct floppy_drive_struct) 236#define FDPOLLDRVSTAT _IOR(2, 0x13, struct floppy_drive_struct) 237/* get drive state: GET returns the cached state, POLL polls for new state */ 238 239 240/* 241 * reset FDC 242 */ 243enum reset_mode { 244 FD_RESET_IF_NEEDED, /* reset only if the reset flags is set */ 245 FD_RESET_IF_RAWCMD, /* obsolete */ 246 FD_RESET_ALWAYS /* reset always */ 247}; 248#define FDRESET _IO(2, 0x54) 249 250 251/* 252 * FDC state 253 */ 254struct floppy_fdc_state { 255 int spec1; /* spec1 value last used */ 256 int spec2; /* spec2 value last used */ 257 int dtr; 258 unsigned char version; /* FDC version code */ 259 unsigned char dor; 260 unsigned long address; /* io address */ 261 unsigned int rawcmd:2; 262 unsigned int reset:1; 263 unsigned int need_configure:1; 264 unsigned int perp_mode:2; 265 unsigned int has_fifo:1; 266 unsigned int driver_version; /* version code for floppy driver */ 267#define FD_DRIVER_VERSION 0x100 268/* user programs using the floppy API should use floppy_fdc_state to 269 * get the version number of the floppy driver that they are running 270 * on. If this version number is bigger than the one compiled into the 271 * user program (the FD_DRIVER_VERSION define), it should be prepared 272 * to bigger structures 273 */ 274 275 unsigned char track[4]; 276 /* Position of the heads of the 4 units attached to this FDC, 277 * as stored on the FDC. In the future, the position as stored 278 * on the FDC might not agree with the actual physical 279 * position of these drive heads. By allowing such 280 * disagreement, it will be possible to reset the FDC without 281 * incurring the expensive cost of repositioning all heads. 282 * Right now, these positions are hard wired to 0. */ 283 284}; 285 286#define FDGETFDCSTAT _IOR(2, 0x15, struct floppy_fdc_state) 287 288 289/* 290 * Asynchronous Write error tracking 291 */ 292struct floppy_write_errors { 293 /* Write error logging. 294 * 295 * These fields can be cleared with the FDWERRORCLR ioctl. 296 * Only writes that were attempted but failed due to a physical media 297 * error are logged. write(2) calls that fail and return an error code 298 * to the user process are not counted. 299 */ 300 301 unsigned int write_errors; /* number of physical write errors 302 * encountered */ 303 304 /* position of first and last write errors */ 305 unsigned long first_error_sector; 306 int first_error_generation; 307 unsigned long last_error_sector; 308 int last_error_generation; 309 310 unsigned int badness; /* highest retry count for a read or write 311 * operation */ 312}; 313 314#define FDWERRORCLR _IO(2, 0x56) 315/* clear write error and badness information */ 316#define FDWERRORGET _IOR(2, 0x17, struct floppy_write_errors) 317/* get write error and badness information */ 318 319 320/* 321 * Raw commands 322 */ 323/* new interface flag: now we can do them in batches */ 324#define FDHAVEBATCHEDRAWCMD 325 326struct floppy_raw_cmd { 327 unsigned int flags; 328#define FD_RAW_READ 1 329#define FD_RAW_WRITE 2 330#define FD_RAW_NO_MOTOR 4 331#define FD_RAW_DISK_CHANGE 4 /* out: disk change flag was set */ 332#define FD_RAW_INTR 8 /* wait for an interrupt */ 333#define FD_RAW_SPIN 0x10 /* spin up the disk for this command */ 334#define FD_RAW_NO_MOTOR_AFTER 0x20 /* switch the motor off after command 335 * completion */ 336#define FD_RAW_NEED_DISK 0x40 /* this command needs a disk to be present */ 337#define FD_RAW_NEED_SEEK 0x80 /* this command uses an implied seek (soft) */ 338 339/* more "in" flags */ 340#define FD_RAW_MORE 0x100 /* more records follow */ 341#define FD_RAW_STOP_IF_FAILURE 0x200 /* stop if we encounter a failure */ 342#define FD_RAW_STOP_IF_SUCCESS 0x400 /* stop if command successful */ 343#define FD_RAW_SOFTFAILURE 0x800 /* consider the return value for failure 344 * detection too */ 345 346/* more "out" flags */ 347#define FD_RAW_FAILURE 0x10000 /* command sent to fdc, fdc returned error */ 348#define FD_RAW_HARDFAILURE 0x20000 /* fdc had to be reset, or timed out */ 349 350 void __user *data; 351 char *kernel_data; /* location of data buffer in the kernel */ 352 struct floppy_raw_cmd *next; /* used for chaining of raw cmd's 353 * within the kernel */ 354 long length; /* in: length of dma transfer. out: remaining bytes */ 355 long phys_length; /* physical length, if different from dma length */ 356 int buffer_length; /* length of allocated buffer */ 357 358 unsigned char rate; 359 unsigned char cmd_count; 360 unsigned char cmd[16]; 361 unsigned char reply_count; 362 unsigned char reply[16]; 363 int track; 364 int resultcode; 365 366 int reserved1; 367 int reserved2; 368}; 369 370#define FDRAWCMD _IO(2, 0x58) 371/* send a raw command to the fdc. Structure size not included, because of 372 * batches */ 373 374#define FDTWADDLE _IO(2, 0x59) 375/* flicker motor-on bit before reading a sector. Experimental */ 376 377 378#define FDEJECT _IO(2, 0x5a) 379/* eject the disk */ 380 381 382 383#endif /* _UAPI_LINUX_FD_H */ 384