fd.h 11 KB

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