ide.h 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380
  1. #ifndef _IDE_H
  2. #define _IDE_H
  3. /*
  4. * linux/include/linux/ide.h
  5. *
  6. * Copyright (C) 1994-2002 Linus Torvalds & authors
  7. */
  8. #include <linux/init.h>
  9. #include <linux/ioport.h>
  10. #include <linux/hdreg.h>
  11. #include <linux/hdsmart.h>
  12. #include <linux/blkdev.h>
  13. #include <linux/proc_fs.h>
  14. #include <linux/interrupt.h>
  15. #include <linux/bitops.h>
  16. #include <linux/bio.h>
  17. #include <linux/device.h>
  18. #include <linux/pci.h>
  19. #include <linux/completion.h>
  20. #include <asm/byteorder.h>
  21. #include <asm/system.h>
  22. #include <asm/io.h>
  23. #include <asm/semaphore.h>
  24. /******************************************************************************
  25. * IDE driver configuration options (play with these as desired):
  26. *
  27. * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
  28. */
  29. #define INITIAL_MULT_COUNT 0 /* off=0; on=2,4,8,16,32, etc.. */
  30. #ifndef SUPPORT_SLOW_DATA_PORTS /* 1 to support slow data ports */
  31. #define SUPPORT_SLOW_DATA_PORTS 1 /* 0 to reduce kernel size */
  32. #endif
  33. #ifndef SUPPORT_VLB_SYNC /* 1 to support weird 32-bit chips */
  34. #define SUPPORT_VLB_SYNC 1 /* 0 to reduce kernel size */
  35. #endif
  36. #ifndef OK_TO_RESET_CONTROLLER /* 1 needed for good error recovery */
  37. #define OK_TO_RESET_CONTROLLER 1 /* 0 for use with AH2372A/B interface */
  38. #endif
  39. #ifndef DISABLE_IRQ_NOSYNC
  40. #define DISABLE_IRQ_NOSYNC 0
  41. #endif
  42. /*
  43. * Used to indicate "no IRQ", should be a value that cannot be an IRQ
  44. * number.
  45. */
  46. #define IDE_NO_IRQ (-1)
  47. /*
  48. * "No user-serviceable parts" beyond this point :)
  49. *****************************************************************************/
  50. typedef unsigned char byte; /* used everywhere */
  51. /*
  52. * Probably not wise to fiddle with these
  53. */
  54. #define ERROR_MAX 8 /* Max read/write errors per sector */
  55. #define ERROR_RESET 3 /* Reset controller every 4th retry */
  56. #define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
  57. /*
  58. * Tune flags
  59. */
  60. #define IDE_TUNE_NOAUTO 2
  61. #define IDE_TUNE_AUTO 1
  62. #define IDE_TUNE_DEFAULT 0
  63. /*
  64. * state flags
  65. */
  66. #define DMA_PIO_RETRY 1 /* retrying in PIO */
  67. #define HWIF(drive) ((ide_hwif_t *)((drive)->hwif))
  68. #define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  69. /*
  70. * Definitions for accessing IDE controller registers
  71. */
  72. #define IDE_NR_PORTS (10)
  73. #define IDE_DATA_OFFSET (0)
  74. #define IDE_ERROR_OFFSET (1)
  75. #define IDE_NSECTOR_OFFSET (2)
  76. #define IDE_SECTOR_OFFSET (3)
  77. #define IDE_LCYL_OFFSET (4)
  78. #define IDE_HCYL_OFFSET (5)
  79. #define IDE_SELECT_OFFSET (6)
  80. #define IDE_STATUS_OFFSET (7)
  81. #define IDE_CONTROL_OFFSET (8)
  82. #define IDE_IRQ_OFFSET (9)
  83. #define IDE_FEATURE_OFFSET IDE_ERROR_OFFSET
  84. #define IDE_COMMAND_OFFSET IDE_STATUS_OFFSET
  85. #define IDE_CONTROL_OFFSET_HOB (7)
  86. #define IDE_DATA_REG (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
  87. #define IDE_ERROR_REG (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
  88. #define IDE_NSECTOR_REG (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
  89. #define IDE_SECTOR_REG (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
  90. #define IDE_LCYL_REG (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
  91. #define IDE_HCYL_REG (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
  92. #define IDE_SELECT_REG (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
  93. #define IDE_STATUS_REG (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
  94. #define IDE_CONTROL_REG (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
  95. #define IDE_IRQ_REG (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
  96. #define IDE_FEATURE_REG IDE_ERROR_REG
  97. #define IDE_COMMAND_REG IDE_STATUS_REG
  98. #define IDE_ALTSTATUS_REG IDE_CONTROL_REG
  99. #define IDE_IREASON_REG IDE_NSECTOR_REG
  100. #define IDE_BCOUNTL_REG IDE_LCYL_REG
  101. #define IDE_BCOUNTH_REG IDE_HCYL_REG
  102. #define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
  103. #define BAD_R_STAT (BUSY_STAT | ERR_STAT)
  104. #define BAD_W_STAT (BAD_R_STAT | WRERR_STAT)
  105. #define BAD_STAT (BAD_R_STAT | DRQ_STAT)
  106. #define DRIVE_READY (READY_STAT | SEEK_STAT)
  107. #define DATA_READY (DRQ_STAT)
  108. #define BAD_CRC (ABRT_ERR | ICRC_ERR)
  109. #define SATA_NR_PORTS (3) /* 16 possible ?? */
  110. #define SATA_STATUS_OFFSET (0)
  111. #define SATA_STATUS_REG (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
  112. #define SATA_ERROR_OFFSET (1)
  113. #define SATA_ERROR_REG (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
  114. #define SATA_CONTROL_OFFSET (2)
  115. #define SATA_CONTROL_REG (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
  116. #define SATA_MISC_OFFSET (0)
  117. #define SATA_MISC_REG (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
  118. #define SATA_PHY_OFFSET (1)
  119. #define SATA_PHY_REG (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
  120. #define SATA_IEN_OFFSET (2)
  121. #define SATA_IEN_REG (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
  122. /*
  123. * Our Physical Region Descriptor (PRD) table should be large enough
  124. * to handle the biggest I/O request we are likely to see. Since requests
  125. * can have no more than 256 sectors, and since the typical blocksize is
  126. * two or more sectors, we could get by with a limit of 128 entries here for
  127. * the usual worst case. Most requests seem to include some contiguous blocks,
  128. * further reducing the number of table entries required.
  129. *
  130. * The driver reverts to PIO mode for individual requests that exceed
  131. * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
  132. * 100% of all crazy scenarios here is not necessary.
  133. *
  134. * As it turns out though, we must allocate a full 4KB page for this,
  135. * so the two PRD tables (ide0 & ide1) will each get half of that,
  136. * allowing each to have about 256 entries (8 bytes each) from this.
  137. */
  138. #define PRD_BYTES 8
  139. #define PRD_ENTRIES 256
  140. /*
  141. * Some more useful definitions
  142. */
  143. #define PARTN_BITS 6 /* number of minor dev bits for partitions */
  144. #define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
  145. #define SECTOR_SIZE 512
  146. #define SECTOR_WORDS (SECTOR_SIZE / 4) /* number of 32bit words per sector */
  147. #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
  148. /*
  149. * Timeouts for various operations:
  150. */
  151. #define WAIT_DRQ (HZ/10) /* 100msec - spec allows up to 20ms */
  152. #define WAIT_READY (5*HZ) /* 5sec - some laptops are very slow */
  153. #define WAIT_PIDENTIFY (10*HZ) /* 10sec - should be less than 3ms (?), if all ATAPI CD is closed at boot */
  154. #define WAIT_WORSTCASE (30*HZ) /* 30sec - worst case when spinning up */
  155. #define WAIT_CMD (10*HZ) /* 10sec - maximum wait for an IRQ to happen */
  156. #define WAIT_MIN_SLEEP (2*HZ/100) /* 20msec - minimum sleep time */
  157. /*
  158. * Check for an interrupt and acknowledge the interrupt status
  159. */
  160. struct hwif_s;
  161. typedef int (ide_ack_intr_t)(struct hwif_s *);
  162. #ifndef NO_DMA
  163. #define NO_DMA 255
  164. #endif
  165. /*
  166. * hwif_chipset_t is used to keep track of the specific hardware
  167. * chipset used by each IDE interface, if known.
  168. */
  169. typedef enum { ide_unknown, ide_generic, ide_pci,
  170. ide_cmd640, ide_dtc2278, ide_ali14xx,
  171. ide_qd65xx, ide_umc8672, ide_ht6560b,
  172. ide_rz1000, ide_trm290,
  173. ide_cmd646, ide_cy82c693, ide_4drives,
  174. ide_pmac, ide_etrax100, ide_acorn,
  175. ide_au1xxx, ide_forced
  176. } hwif_chipset_t;
  177. /*
  178. * Structure to hold all information about the location of this port
  179. */
  180. typedef struct hw_regs_s {
  181. unsigned long io_ports[IDE_NR_PORTS]; /* task file registers */
  182. int irq; /* our irq number */
  183. int dma; /* our dma entry */
  184. ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
  185. hwif_chipset_t chipset;
  186. struct device *dev;
  187. } hw_regs_t;
  188. /*
  189. * Register new hardware with ide
  190. */
  191. int ide_register_hw(hw_regs_t *hw, struct hwif_s **hwifp);
  192. int ide_register_hw_with_fixup(hw_regs_t *, struct hwif_s **, void (*)(struct hwif_s *));
  193. /*
  194. * Set up hw_regs_t structure before calling ide_register_hw (optional)
  195. */
  196. void ide_setup_ports( hw_regs_t *hw,
  197. unsigned long base,
  198. int *offsets,
  199. unsigned long ctrl,
  200. unsigned long intr,
  201. ide_ack_intr_t *ack_intr,
  202. #if 0
  203. ide_io_ops_t *iops,
  204. #endif
  205. int irq);
  206. static inline void ide_std_init_ports(hw_regs_t *hw,
  207. unsigned long io_addr,
  208. unsigned long ctl_addr)
  209. {
  210. unsigned int i;
  211. for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
  212. hw->io_ports[i] = io_addr++;
  213. hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
  214. }
  215. #include <asm/ide.h>
  216. #ifndef MAX_HWIFS
  217. #define MAX_HWIFS CONFIG_IDE_MAX_HWIFS
  218. #endif
  219. /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
  220. #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
  221. # define ide_default_io_base(index) (0)
  222. # define ide_default_irq(base) (0)
  223. # define ide_init_default_irq(base) (0)
  224. #endif
  225. /*
  226. * ide_init_hwif_ports() is OBSOLETE and will be removed in 2.7 series.
  227. * New ports shouldn't define IDE_ARCH_OBSOLETE_INIT in <asm/ide.h>.
  228. */
  229. #ifdef IDE_ARCH_OBSOLETE_INIT
  230. static inline void ide_init_hwif_ports(hw_regs_t *hw,
  231. unsigned long io_addr,
  232. unsigned long ctl_addr,
  233. int *irq)
  234. {
  235. if (!ctl_addr)
  236. ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
  237. else
  238. ide_std_init_ports(hw, io_addr, ctl_addr);
  239. if (irq)
  240. *irq = 0;
  241. hw->io_ports[IDE_IRQ_OFFSET] = 0;
  242. #ifdef CONFIG_PPC32
  243. if (ppc_ide_md.ide_init_hwif)
  244. ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
  245. #endif
  246. }
  247. #else
  248. static inline void ide_init_hwif_ports(hw_regs_t *hw,
  249. unsigned long io_addr,
  250. unsigned long ctl_addr,
  251. int *irq)
  252. {
  253. if (io_addr || ctl_addr)
  254. printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
  255. }
  256. #endif /* IDE_ARCH_OBSOLETE_INIT */
  257. /* Currently only m68k, apus and m8xx need it */
  258. #ifndef IDE_ARCH_ACK_INTR
  259. # define ide_ack_intr(hwif) (1)
  260. #endif
  261. /* Currently only Atari needs it */
  262. #ifndef IDE_ARCH_LOCK
  263. # define ide_release_lock() do {} while (0)
  264. # define ide_get_lock(hdlr, data) do {} while (0)
  265. #endif /* IDE_ARCH_LOCK */
  266. /*
  267. * Now for the data we need to maintain per-drive: ide_drive_t
  268. */
  269. #define ide_scsi 0x21
  270. #define ide_disk 0x20
  271. #define ide_optical 0x7
  272. #define ide_cdrom 0x5
  273. #define ide_tape 0x1
  274. #define ide_floppy 0x0
  275. /*
  276. * Special Driver Flags
  277. *
  278. * set_geometry : respecify drive geometry
  279. * recalibrate : seek to cyl 0
  280. * set_multmode : set multmode count
  281. * set_tune : tune interface for drive
  282. * serviced : service command
  283. * reserved : unused
  284. */
  285. typedef union {
  286. unsigned all : 8;
  287. struct {
  288. #if defined(__LITTLE_ENDIAN_BITFIELD)
  289. unsigned set_geometry : 1;
  290. unsigned recalibrate : 1;
  291. unsigned set_multmode : 1;
  292. unsigned set_tune : 1;
  293. unsigned serviced : 1;
  294. unsigned reserved : 3;
  295. #elif defined(__BIG_ENDIAN_BITFIELD)
  296. unsigned reserved : 3;
  297. unsigned serviced : 1;
  298. unsigned set_tune : 1;
  299. unsigned set_multmode : 1;
  300. unsigned recalibrate : 1;
  301. unsigned set_geometry : 1;
  302. #else
  303. #error "Please fix <asm/byteorder.h>"
  304. #endif
  305. } b;
  306. } special_t;
  307. /*
  308. * ATA DATA Register Special.
  309. * ATA NSECTOR Count Register().
  310. * ATAPI Byte Count Register.
  311. * Channel index ordering pairs.
  312. */
  313. typedef union {
  314. unsigned all :16;
  315. struct {
  316. #if defined(__LITTLE_ENDIAN_BITFIELD)
  317. unsigned low :8; /* LSB */
  318. unsigned high :8; /* MSB */
  319. #elif defined(__BIG_ENDIAN_BITFIELD)
  320. unsigned high :8; /* MSB */
  321. unsigned low :8; /* LSB */
  322. #else
  323. #error "Please fix <asm/byteorder.h>"
  324. #endif
  325. } b;
  326. } ata_nsector_t, ata_data_t, atapi_bcount_t, ata_index_t;
  327. /*
  328. * ATA-IDE Select Register, aka Device-Head
  329. *
  330. * head : always zeros here
  331. * unit : drive select number: 0/1
  332. * bit5 : always 1
  333. * lba : using LBA instead of CHS
  334. * bit7 : always 1
  335. */
  336. typedef union {
  337. unsigned all : 8;
  338. struct {
  339. #if defined(__LITTLE_ENDIAN_BITFIELD)
  340. unsigned head : 4;
  341. unsigned unit : 1;
  342. unsigned bit5 : 1;
  343. unsigned lba : 1;
  344. unsigned bit7 : 1;
  345. #elif defined(__BIG_ENDIAN_BITFIELD)
  346. unsigned bit7 : 1;
  347. unsigned lba : 1;
  348. unsigned bit5 : 1;
  349. unsigned unit : 1;
  350. unsigned head : 4;
  351. #else
  352. #error "Please fix <asm/byteorder.h>"
  353. #endif
  354. } b;
  355. } select_t, ata_select_t;
  356. /*
  357. * The ATA-IDE Status Register.
  358. * The ATAPI Status Register.
  359. *
  360. * check : Error occurred
  361. * idx : Index Error
  362. * corr : Correctable error occurred
  363. * drq : Data is request by the device
  364. * dsc : Disk Seek Complete : ata
  365. * : Media access command finished : atapi
  366. * df : Device Fault : ata
  367. * : Reserved : atapi
  368. * drdy : Ready, Command Mode Capable : ata
  369. * : Ignored for ATAPI commands : atapi
  370. * bsy : Disk is Busy
  371. * : The device has access to the command block
  372. */
  373. typedef union {
  374. unsigned all :8;
  375. struct {
  376. #if defined(__LITTLE_ENDIAN_BITFIELD)
  377. unsigned check :1;
  378. unsigned idx :1;
  379. unsigned corr :1;
  380. unsigned drq :1;
  381. unsigned dsc :1;
  382. unsigned df :1;
  383. unsigned drdy :1;
  384. unsigned bsy :1;
  385. #elif defined(__BIG_ENDIAN_BITFIELD)
  386. unsigned bsy :1;
  387. unsigned drdy :1;
  388. unsigned df :1;
  389. unsigned dsc :1;
  390. unsigned drq :1;
  391. unsigned corr :1;
  392. unsigned idx :1;
  393. unsigned check :1;
  394. #else
  395. #error "Please fix <asm/byteorder.h>"
  396. #endif
  397. } b;
  398. } ata_status_t, atapi_status_t;
  399. /*
  400. * ATAPI Feature Register
  401. *
  402. * dma : Using DMA or PIO
  403. * reserved321 : Reserved
  404. * reserved654 : Reserved (Tag Type)
  405. * reserved7 : Reserved
  406. */
  407. typedef union {
  408. unsigned all :8;
  409. struct {
  410. #if defined(__LITTLE_ENDIAN_BITFIELD)
  411. unsigned dma :1;
  412. unsigned reserved321 :3;
  413. unsigned reserved654 :3;
  414. unsigned reserved7 :1;
  415. #elif defined(__BIG_ENDIAN_BITFIELD)
  416. unsigned reserved7 :1;
  417. unsigned reserved654 :3;
  418. unsigned reserved321 :3;
  419. unsigned dma :1;
  420. #else
  421. #error "Please fix <asm/byteorder.h>"
  422. #endif
  423. } b;
  424. } atapi_feature_t;
  425. /*
  426. * ATAPI Interrupt Reason Register.
  427. *
  428. * cod : Information transferred is command (1) or data (0)
  429. * io : The device requests us to read (1) or write (0)
  430. * reserved : Reserved
  431. */
  432. typedef union {
  433. unsigned all :8;
  434. struct {
  435. #if defined(__LITTLE_ENDIAN_BITFIELD)
  436. unsigned cod :1;
  437. unsigned io :1;
  438. unsigned reserved :6;
  439. #elif defined(__BIG_ENDIAN_BITFIELD)
  440. unsigned reserved :6;
  441. unsigned io :1;
  442. unsigned cod :1;
  443. #else
  444. #error "Please fix <asm/byteorder.h>"
  445. #endif
  446. } b;
  447. } atapi_ireason_t;
  448. /*
  449. * The ATAPI error register.
  450. *
  451. * ili : Illegal Length Indication
  452. * eom : End Of Media Detected
  453. * abrt : Aborted command - As defined by ATA
  454. * mcr : Media Change Requested - As defined by ATA
  455. * sense_key : Sense key of the last failed packet command
  456. */
  457. typedef union {
  458. unsigned all :8;
  459. struct {
  460. #if defined(__LITTLE_ENDIAN_BITFIELD)
  461. unsigned ili :1;
  462. unsigned eom :1;
  463. unsigned abrt :1;
  464. unsigned mcr :1;
  465. unsigned sense_key :4;
  466. #elif defined(__BIG_ENDIAN_BITFIELD)
  467. unsigned sense_key :4;
  468. unsigned mcr :1;
  469. unsigned abrt :1;
  470. unsigned eom :1;
  471. unsigned ili :1;
  472. #else
  473. #error "Please fix <asm/byteorder.h>"
  474. #endif
  475. } b;
  476. } atapi_error_t;
  477. /*
  478. * Status returned from various ide_ functions
  479. */
  480. typedef enum {
  481. ide_stopped, /* no drive operation was started */
  482. ide_started, /* a drive operation was started, handler was set */
  483. } ide_startstop_t;
  484. struct ide_driver_s;
  485. struct ide_settings_s;
  486. typedef struct ide_drive_s {
  487. char name[4]; /* drive name, such as "hda" */
  488. char driver_req[10]; /* requests specific driver */
  489. request_queue_t *queue; /* request queue */
  490. struct request *rq; /* current request */
  491. struct ide_drive_s *next; /* circular list of hwgroup drives */
  492. void *driver_data; /* extra driver data */
  493. struct hd_driveid *id; /* drive model identification info */
  494. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  495. struct ide_settings_s *settings;/* /proc/ide/ drive settings */
  496. struct hwif_s *hwif; /* actually (ide_hwif_t *) */
  497. unsigned long sleep; /* sleep until this time */
  498. unsigned long service_start; /* time we started last request */
  499. unsigned long service_time; /* service time of last request */
  500. unsigned long timeout; /* max time to wait for irq */
  501. special_t special; /* special action flags */
  502. select_t select; /* basic drive/head select reg value */
  503. u8 keep_settings; /* restore settings after drive reset */
  504. u8 autodma; /* device can safely use dma on host */
  505. u8 using_dma; /* disk is using dma for read/write */
  506. u8 retry_pio; /* retrying dma capable host in pio */
  507. u8 state; /* retry state */
  508. u8 waiting_for_dma; /* dma currently in progress */
  509. u8 unmask; /* okay to unmask other irqs */
  510. u8 bswap; /* byte swap data */
  511. u8 noflush; /* don't attempt flushes */
  512. u8 dsc_overlap; /* DSC overlap */
  513. u8 nice1; /* give potential excess bandwidth */
  514. unsigned present : 1; /* drive is physically present */
  515. unsigned dead : 1; /* device ejected hint */
  516. unsigned id_read : 1; /* 1=id read from disk 0 = synthetic */
  517. unsigned noprobe : 1; /* from: hdx=noprobe */
  518. unsigned removable : 1; /* 1 if need to do check_media_change */
  519. unsigned attach : 1; /* needed for removable devices */
  520. unsigned forced_geom : 1; /* 1 if hdx=c,h,s was given at boot */
  521. unsigned no_unmask : 1; /* disallow setting unmask bit */
  522. unsigned no_io_32bit : 1; /* disallow enabling 32bit I/O */
  523. unsigned atapi_overlap : 1; /* ATAPI overlap (not supported) */
  524. unsigned nice0 : 1; /* give obvious excess bandwidth */
  525. unsigned nice2 : 1; /* give a share in our own bandwidth */
  526. unsigned doorlocking : 1; /* for removable only: door lock/unlock works */
  527. unsigned autotune : 2; /* 0=default, 1=autotune, 2=noautotune */
  528. unsigned remap_0_to_1 : 1; /* 0=noremap, 1=remap 0->1 (for EZDrive) */
  529. unsigned blocked : 1; /* 1=powermanagment told us not to do anything, so sleep nicely */
  530. unsigned vdma : 1; /* 1=doing PIO over DMA 0=doing normal DMA */
  531. unsigned addressing; /* : 3;
  532. * 0=28-bit
  533. * 1=48-bit
  534. * 2=48-bit doing 28-bit
  535. * 3=64-bit
  536. */
  537. unsigned scsi : 1; /* 0=default, 1=ide-scsi emulation */
  538. unsigned sleeping : 1; /* 1=sleeping & sleep field valid */
  539. unsigned post_reset : 1;
  540. u8 quirk_list; /* considered quirky, set for a specific host */
  541. u8 init_speed; /* transfer rate set at boot */
  542. u8 pio_speed; /* unused by core, used by some drivers for fallback from DMA */
  543. u8 current_speed; /* current transfer rate set */
  544. u8 dn; /* now wide spread use */
  545. u8 wcache; /* status of write cache */
  546. u8 acoustic; /* acoustic management */
  547. u8 media; /* disk, cdrom, tape, floppy, ... */
  548. u8 ctl; /* "normal" value for IDE_CONTROL_REG */
  549. u8 ready_stat; /* min status value for drive ready */
  550. u8 mult_count; /* current multiple sector setting */
  551. u8 mult_req; /* requested multiple sector setting */
  552. u8 tune_req; /* requested drive tuning setting */
  553. u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
  554. u8 bad_wstat; /* used for ignoring WRERR_STAT */
  555. u8 nowerr; /* used for ignoring WRERR_STAT */
  556. u8 sect0; /* offset of first sector for DM6:DDO */
  557. u8 head; /* "real" number of heads */
  558. u8 sect; /* "real" sectors per track */
  559. u8 bios_head; /* BIOS/fdisk/LILO number of heads */
  560. u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
  561. unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
  562. unsigned int cyl; /* "real" number of cyls */
  563. unsigned int drive_data; /* use by tuneproc/selectproc */
  564. unsigned int usage; /* current "open()" count for drive */
  565. unsigned int failures; /* current failure count */
  566. unsigned int max_failures; /* maximum allowed failure count */
  567. u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
  568. u64 capacity64; /* total number of sectors */
  569. int lun; /* logical unit */
  570. int crc_count; /* crc counter to reduce drive speed */
  571. struct list_head list;
  572. struct device gendev;
  573. struct completion gendev_rel_comp; /* to deal with device release() */
  574. } ide_drive_t;
  575. #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
  576. #define IDE_CHIPSET_PCI_MASK \
  577. ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
  578. #define IDE_CHIPSET_IS_PCI(c) ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
  579. struct ide_pci_device_s;
  580. typedef struct hwif_s {
  581. struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
  582. struct hwif_s *mate; /* other hwif from same PCI chip */
  583. struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
  584. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  585. char name[6]; /* name of interface, eg. "ide0" */
  586. /* task file registers for pata and sata */
  587. unsigned long io_ports[IDE_NR_PORTS];
  588. unsigned long sata_scr[SATA_NR_PORTS];
  589. unsigned long sata_misc[SATA_NR_PORTS];
  590. hw_regs_t hw; /* Hardware info */
  591. ide_drive_t drives[MAX_DRIVES]; /* drive info */
  592. u8 major; /* our major number */
  593. u8 index; /* 0 for ide0; 1 for ide1; ... */
  594. u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
  595. u8 straight8; /* Alan's straight 8 check */
  596. u8 bus_state; /* power state of the IDE bus */
  597. u8 atapi_dma; /* host supports atapi_dma */
  598. u8 ultra_mask;
  599. u8 mwdma_mask;
  600. u8 swdma_mask;
  601. hwif_chipset_t chipset; /* sub-module for tuning.. */
  602. struct pci_dev *pci_dev; /* for pci chipsets */
  603. struct ide_pci_device_s *cds; /* chipset device struct */
  604. void (*rw_disk)(ide_drive_t *, struct request *);
  605. #if 0
  606. ide_hwif_ops_t *hwifops;
  607. #else
  608. /* routine to tune PIO mode for drives */
  609. void (*tuneproc)(ide_drive_t *, u8);
  610. /* routine to retune DMA modes for drives */
  611. int (*speedproc)(ide_drive_t *, u8);
  612. /* tweaks hardware to select drive */
  613. void (*selectproc)(ide_drive_t *);
  614. /* chipset polling based on hba specifics */
  615. int (*reset_poll)(ide_drive_t *);
  616. /* chipset specific changes to default for device-hba resets */
  617. void (*pre_reset)(ide_drive_t *);
  618. /* routine to reset controller after a disk reset */
  619. void (*resetproc)(ide_drive_t *);
  620. /* special interrupt handling for shared pci interrupts */
  621. void (*intrproc)(ide_drive_t *);
  622. /* special host masking for drive selection */
  623. void (*maskproc)(ide_drive_t *, int);
  624. /* check host's drive quirk list */
  625. int (*quirkproc)(ide_drive_t *);
  626. /* driver soft-power interface */
  627. int (*busproc)(ide_drive_t *, int);
  628. // /* host rate limiter */
  629. // u8 (*ratemask)(ide_drive_t *);
  630. // /* device rate limiter */
  631. // u8 (*ratefilter)(ide_drive_t *, u8);
  632. #endif
  633. void (*ata_input_data)(ide_drive_t *, void *, u32);
  634. void (*ata_output_data)(ide_drive_t *, void *, u32);
  635. void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
  636. void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
  637. int (*dma_setup)(ide_drive_t *);
  638. void (*dma_exec_cmd)(ide_drive_t *, u8);
  639. void (*dma_start)(ide_drive_t *);
  640. int (*ide_dma_end)(ide_drive_t *drive);
  641. int (*ide_dma_check)(ide_drive_t *drive);
  642. int (*ide_dma_on)(ide_drive_t *drive);
  643. int (*ide_dma_off_quietly)(ide_drive_t *drive);
  644. int (*ide_dma_test_irq)(ide_drive_t *drive);
  645. int (*ide_dma_host_on)(ide_drive_t *drive);
  646. int (*ide_dma_host_off)(ide_drive_t *drive);
  647. int (*ide_dma_lostirq)(ide_drive_t *drive);
  648. int (*ide_dma_timeout)(ide_drive_t *drive);
  649. void (*OUTB)(u8 addr, unsigned long port);
  650. void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
  651. void (*OUTW)(u16 addr, unsigned long port);
  652. void (*OUTL)(u32 addr, unsigned long port);
  653. void (*OUTSW)(unsigned long port, void *addr, u32 count);
  654. void (*OUTSL)(unsigned long port, void *addr, u32 count);
  655. u8 (*INB)(unsigned long port);
  656. u16 (*INW)(unsigned long port);
  657. u32 (*INL)(unsigned long port);
  658. void (*INSW)(unsigned long port, void *addr, u32 count);
  659. void (*INSL)(unsigned long port, void *addr, u32 count);
  660. /* dma physical region descriptor table (cpu view) */
  661. unsigned int *dmatable_cpu;
  662. /* dma physical region descriptor table (dma view) */
  663. dma_addr_t dmatable_dma;
  664. /* Scatter-gather list used to build the above */
  665. struct scatterlist *sg_table;
  666. int sg_max_nents; /* Maximum number of entries in it */
  667. int sg_nents; /* Current number of entries in it */
  668. int sg_dma_direction; /* dma transfer direction */
  669. /* data phase of the active command (currently only valid for PIO/DMA) */
  670. int data_phase;
  671. unsigned int nsect;
  672. unsigned int nleft;
  673. unsigned int cursg;
  674. unsigned int cursg_ofs;
  675. int mmio; /* hosts iomio (0) or custom (2) select */
  676. int rqsize; /* max sectors per request */
  677. int irq; /* our irq number */
  678. unsigned long dma_master; /* reference base addr dmabase */
  679. unsigned long dma_base; /* base addr for dma ports */
  680. unsigned long dma_command; /* dma command register */
  681. unsigned long dma_vendor1; /* dma vendor 1 register */
  682. unsigned long dma_status; /* dma status register */
  683. unsigned long dma_vendor3; /* dma vendor 3 register */
  684. unsigned long dma_prdtable; /* actual prd table address */
  685. unsigned long dma_base2; /* extended base addr for dma ports */
  686. unsigned dma_extra; /* extra addr for dma ports */
  687. unsigned long config_data; /* for use by chipset-specific code */
  688. unsigned long select_data; /* for use by chipset-specific code */
  689. unsigned noprobe : 1; /* don't probe for this interface */
  690. unsigned present : 1; /* this interface exists */
  691. unsigned hold : 1; /* this interface is always present */
  692. unsigned serialized : 1; /* serialized all channel operation */
  693. unsigned sharing_irq: 1; /* 1 = sharing irq with another hwif */
  694. unsigned reset : 1; /* reset after probe */
  695. unsigned autodma : 1; /* auto-attempt using DMA at boot */
  696. unsigned udma_four : 1; /* 1=ATA-66 capable, 0=default */
  697. unsigned no_lba48 : 1; /* 1 = cannot do LBA48 */
  698. unsigned no_lba48_dma : 1; /* 1 = cannot do LBA48 DMA */
  699. unsigned no_dsc : 1; /* 0 default, 1 dsc_overlap disabled */
  700. unsigned auto_poll : 1; /* supports nop auto-poll */
  701. unsigned sg_mapped : 1; /* sg_table and sg_nents are ready */
  702. unsigned no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
  703. unsigned err_stops_fifo : 1; /* 1=data FIFO is cleared by an error */
  704. struct device gendev;
  705. struct completion gendev_rel_comp; /* To deal with device release() */
  706. void *hwif_data; /* extra hwif data */
  707. unsigned dma;
  708. void (*led_act)(void *data, int rw);
  709. } ____cacheline_internodealigned_in_smp ide_hwif_t;
  710. /*
  711. * internal ide interrupt handler type
  712. */
  713. typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
  714. typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
  715. typedef int (ide_expiry_t)(ide_drive_t *);
  716. typedef struct hwgroup_s {
  717. /* irq handler, if active */
  718. ide_startstop_t (*handler)(ide_drive_t *);
  719. /* irq handler, suspended if active */
  720. ide_startstop_t (*handler_save)(ide_drive_t *);
  721. /* BOOL: protects all fields below */
  722. volatile int busy;
  723. /* BOOL: wake us up on timer expiry */
  724. unsigned int sleeping : 1;
  725. /* BOOL: polling active & poll_timeout field valid */
  726. unsigned int polling : 1;
  727. /* current drive */
  728. ide_drive_t *drive;
  729. /* ptr to current hwif in linked-list */
  730. ide_hwif_t *hwif;
  731. /* for pci chipsets */
  732. struct pci_dev *pci_dev;
  733. /* chipset device struct */
  734. struct ide_pci_device_s *cds;
  735. /* current request */
  736. struct request *rq;
  737. /* failsafe timer */
  738. struct timer_list timer;
  739. /* local copy of current write rq */
  740. struct request wrq;
  741. /* timeout value during long polls */
  742. unsigned long poll_timeout;
  743. /* queried upon timeouts */
  744. int (*expiry)(ide_drive_t *);
  745. /* ide_system_bus_speed */
  746. int pio_clock;
  747. unsigned char cmd_buf[4];
  748. } ide_hwgroup_t;
  749. /* structure attached to the request for IDE_TASK_CMDS */
  750. /*
  751. * configurable drive settings
  752. */
  753. #define TYPE_INT 0
  754. #define TYPE_INTA 1
  755. #define TYPE_BYTE 2
  756. #define TYPE_SHORT 3
  757. #define SETTING_READ (1 << 0)
  758. #define SETTING_WRITE (1 << 1)
  759. #define SETTING_RW (SETTING_READ | SETTING_WRITE)
  760. typedef int (ide_procset_t)(ide_drive_t *, int);
  761. typedef struct ide_settings_s {
  762. char *name;
  763. int rw;
  764. int read_ioctl;
  765. int write_ioctl;
  766. int data_type;
  767. int min;
  768. int max;
  769. int mul_factor;
  770. int div_factor;
  771. void *data;
  772. ide_procset_t *set;
  773. int auto_remove;
  774. struct ide_settings_s *next;
  775. } ide_settings_t;
  776. extern struct semaphore ide_setting_sem;
  777. extern int ide_add_setting(ide_drive_t *drive, const char *name, int rw, int read_ioctl, int write_ioctl, int data_type, int min, int max, int mul_factor, int div_factor, void *data, ide_procset_t *set);
  778. extern ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name);
  779. extern int ide_read_setting(ide_drive_t *t, ide_settings_t *setting);
  780. extern int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val);
  781. extern void ide_add_generic_settings(ide_drive_t *drive);
  782. /*
  783. * /proc/ide interface
  784. */
  785. typedef struct {
  786. const char *name;
  787. mode_t mode;
  788. read_proc_t *read_proc;
  789. write_proc_t *write_proc;
  790. } ide_proc_entry_t;
  791. #ifdef CONFIG_PROC_FS
  792. extern struct proc_dir_entry *proc_ide_root;
  793. extern void proc_ide_create(void);
  794. extern void proc_ide_destroy(void);
  795. extern void create_proc_ide_interfaces(void);
  796. void destroy_proc_ide_interface(ide_hwif_t *);
  797. extern void ide_add_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *, void *);
  798. extern void ide_remove_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *);
  799. read_proc_t proc_ide_read_capacity;
  800. read_proc_t proc_ide_read_geometry;
  801. #ifdef CONFIG_BLK_DEV_IDEPCI
  802. void ide_pci_create_host_proc(const char *, get_info_t *);
  803. #endif
  804. /*
  805. * Standard exit stuff:
  806. */
  807. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
  808. { \
  809. len -= off; \
  810. if (len < count) { \
  811. *eof = 1; \
  812. if (len <= 0) \
  813. return 0; \
  814. } else \
  815. len = count; \
  816. *start = page + off; \
  817. return len; \
  818. }
  819. #else
  820. static inline void create_proc_ide_interfaces(void) { ; }
  821. static inline void destroy_proc_ide_interface(ide_hwif_t *hwif) { ; }
  822. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
  823. #endif
  824. /*
  825. * Power Management step value (rq->pm->pm_step).
  826. *
  827. * The step value starts at 0 (ide_pm_state_start_suspend) for a
  828. * suspend operation or 1000 (ide_pm_state_start_resume) for a
  829. * resume operation.
  830. *
  831. * For each step, the core calls the subdriver start_power_step() first.
  832. * This can return:
  833. * - ide_stopped : In this case, the core calls us back again unless
  834. * step have been set to ide_power_state_completed.
  835. * - ide_started : In this case, the channel is left busy until an
  836. * async event (interrupt) occurs.
  837. * Typically, start_power_step() will issue a taskfile request with
  838. * do_rw_taskfile().
  839. *
  840. * Upon reception of the interrupt, the core will call complete_power_step()
  841. * with the error code if any. This routine should update the step value
  842. * and return. It should not start a new request. The core will call
  843. * start_power_step for the new step value, unless step have been set to
  844. * ide_power_state_completed.
  845. *
  846. * Subdrivers are expected to define their own additional power
  847. * steps from 1..999 for suspend and from 1001..1999 for resume,
  848. * other values are reserved for future use.
  849. */
  850. enum {
  851. ide_pm_state_completed = -1,
  852. ide_pm_state_start_suspend = 0,
  853. ide_pm_state_start_resume = 1000,
  854. };
  855. /*
  856. * Subdrivers support.
  857. *
  858. * The gendriver.owner field should be set to the module owner of this driver.
  859. * The gendriver.name field should be set to the name of this driver
  860. */
  861. typedef struct ide_driver_s {
  862. const char *version;
  863. u8 media;
  864. unsigned supports_dsc_overlap : 1;
  865. ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
  866. int (*end_request)(ide_drive_t *, int, int);
  867. ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
  868. ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
  869. ide_proc_entry_t *proc;
  870. struct device_driver gen_driver;
  871. int (*probe)(ide_drive_t *);
  872. void (*remove)(ide_drive_t *);
  873. void (*shutdown)(ide_drive_t *);
  874. } ide_driver_t;
  875. #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
  876. int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
  877. /*
  878. * ide_hwifs[] is the master data structure used to keep track
  879. * of just about everything in ide.c. Whenever possible, routines
  880. * should be using pointers to a drive (ide_drive_t *) or
  881. * pointers to a hwif (ide_hwif_t *), rather than indexing this
  882. * structure directly (the allocation/layout may change!).
  883. *
  884. */
  885. #ifndef _IDE_C
  886. extern ide_hwif_t ide_hwifs[]; /* master data repository */
  887. #endif
  888. extern int noautodma;
  889. extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
  890. int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
  891. int uptodate, int nr_sectors);
  892. /*
  893. * This is used on exit from the driver to designate the next irq handler
  894. * and also to start the safety timer.
  895. */
  896. extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
  897. /*
  898. * This is used on exit from the driver to designate the next irq handler
  899. * and start the safety time safely and atomically from the IRQ handler
  900. * with respect to the command issue (which it also does)
  901. */
  902. extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
  903. ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
  904. /*
  905. * ide_error() takes action based on the error returned by the controller.
  906. * The caller should return immediately after invoking this.
  907. *
  908. * (drive, msg, status)
  909. */
  910. ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
  911. ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
  912. /*
  913. * Abort a running command on the controller triggering the abort
  914. * from a host side, non error situation
  915. * (drive, msg)
  916. */
  917. extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
  918. extern void ide_fix_driveid(struct hd_driveid *);
  919. /*
  920. * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
  921. * removing leading/trailing blanks and compressing internal blanks.
  922. * It is primarily used to tidy up the model name/number fields as
  923. * returned by the WIN_[P]IDENTIFY commands.
  924. *
  925. * (s, bytecount, byteswap)
  926. */
  927. extern void ide_fixstring(u8 *, const int, const int);
  928. /*
  929. * This routine busy-waits for the drive status to be not "busy".
  930. * It then checks the status for all of the "good" bits and none
  931. * of the "bad" bits, and if all is okay it returns 0. All other
  932. * cases return 1 after doing "*startstop = ide_error()", and the
  933. * caller should return the updated value of "startstop" in this case.
  934. * "startstop" is unchanged when the function returns 0;
  935. * (startstop, drive, good, bad, timeout)
  936. */
  937. extern int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
  938. /*
  939. * Start a reset operation for an IDE interface.
  940. * The caller should return immediately after invoking this.
  941. */
  942. extern ide_startstop_t ide_do_reset (ide_drive_t *);
  943. /*
  944. * This function is intended to be used prior to invoking ide_do_drive_cmd().
  945. */
  946. extern void ide_init_drive_cmd (struct request *rq);
  947. /*
  948. * this function returns error location sector offset in case of a write error
  949. */
  950. extern u64 ide_get_error_location(ide_drive_t *, char *);
  951. /*
  952. * "action" parameter type for ide_do_drive_cmd() below.
  953. */
  954. typedef enum {
  955. ide_wait, /* insert rq at end of list, and wait for it */
  956. ide_preempt, /* insert rq in front of current request */
  957. ide_head_wait, /* insert rq in front of current request and wait for it */
  958. ide_end /* insert rq at end of list, but don't wait for it */
  959. } ide_action_t;
  960. extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
  961. /*
  962. * Clean up after success/failure of an explicit drive cmd.
  963. * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
  964. * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_TASK_MASK).
  965. *
  966. * (ide_drive_t *drive, u8 stat, u8 err)
  967. */
  968. extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
  969. /*
  970. * Issue ATA command and wait for completion.
  971. * Use for implementing commands in kernel
  972. *
  973. * (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
  974. */
  975. extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
  976. typedef struct ide_task_s {
  977. /*
  978. * struct hd_drive_task_hdr tf;
  979. * task_struct_t tf;
  980. * struct hd_drive_hob_hdr hobf;
  981. * hob_struct_t hobf;
  982. */
  983. task_ioreg_t tfRegister[8];
  984. task_ioreg_t hobRegister[8];
  985. ide_reg_valid_t tf_out_flags;
  986. ide_reg_valid_t tf_in_flags;
  987. int data_phase;
  988. int command_type;
  989. ide_pre_handler_t *prehandler;
  990. ide_handler_t *handler;
  991. struct request *rq; /* copy of request */
  992. void *special; /* valid_t generally */
  993. } ide_task_t;
  994. extern u32 ide_read_24(ide_drive_t *);
  995. extern void SELECT_DRIVE(ide_drive_t *);
  996. extern void SELECT_INTERRUPT(ide_drive_t *);
  997. extern void SELECT_MASK(ide_drive_t *, int);
  998. extern void QUIRK_LIST(ide_drive_t *);
  999. extern int drive_is_ready(ide_drive_t *);
  1000. extern int wait_for_ready(ide_drive_t *, int /* timeout */);
  1001. /*
  1002. * taskfile io for disks for now...and builds request from ide_ioctl
  1003. */
  1004. extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
  1005. /*
  1006. * Special Flagged Register Validation Caller
  1007. */
  1008. extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
  1009. extern ide_startstop_t set_multmode_intr(ide_drive_t *);
  1010. extern ide_startstop_t set_geometry_intr(ide_drive_t *);
  1011. extern ide_startstop_t recal_intr(ide_drive_t *);
  1012. extern ide_startstop_t task_no_data_intr(ide_drive_t *);
  1013. extern ide_startstop_t task_in_intr(ide_drive_t *);
  1014. extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
  1015. extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
  1016. int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
  1017. int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
  1018. int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
  1019. extern int system_bus_clock(void);
  1020. extern int ide_driveid_update(ide_drive_t *);
  1021. extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
  1022. extern int ide_config_drive_speed(ide_drive_t *, u8);
  1023. extern u8 eighty_ninty_three (ide_drive_t *);
  1024. extern int set_transfer(ide_drive_t *, ide_task_t *);
  1025. extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
  1026. extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
  1027. /*
  1028. * ide_stall_queue() can be used by a drive to give excess bandwidth back
  1029. * to the hwgroup by sleeping for timeout jiffies.
  1030. */
  1031. extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
  1032. extern int ide_spin_wait_hwgroup(ide_drive_t *);
  1033. extern void ide_timer_expiry(unsigned long);
  1034. extern irqreturn_t ide_intr(int irq, void *dev_id, struct pt_regs *regs);
  1035. extern void do_ide_request(request_queue_t *);
  1036. void ide_init_disk(struct gendisk *, ide_drive_t *);
  1037. extern int ideprobe_init(void);
  1038. extern void ide_scan_pcibus(int scan_direction) __init;
  1039. extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner);
  1040. #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE)
  1041. extern void ide_pci_unregister_driver(struct pci_driver *driver);
  1042. void ide_pci_setup_ports(struct pci_dev *, struct ide_pci_device_s *, int, ata_index_t *);
  1043. extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
  1044. extern void default_hwif_iops(ide_hwif_t *);
  1045. extern void default_hwif_mmiops(ide_hwif_t *);
  1046. extern void default_hwif_transport(ide_hwif_t *);
  1047. void ide_register_subdriver(ide_drive_t *, ide_driver_t *);
  1048. void ide_unregister_subdriver(ide_drive_t *, ide_driver_t *);
  1049. #define ON_BOARD 1
  1050. #define NEVER_BOARD 0
  1051. #ifdef CONFIG_BLK_DEV_OFFBOARD
  1052. # define OFF_BOARD ON_BOARD
  1053. #else /* CONFIG_BLK_DEV_OFFBOARD */
  1054. # define OFF_BOARD NEVER_BOARD
  1055. #endif /* CONFIG_BLK_DEV_OFFBOARD */
  1056. #define NODMA 0
  1057. #define NOAUTODMA 1
  1058. #define AUTODMA 2
  1059. typedef struct ide_pci_enablebit_s {
  1060. u8 reg; /* byte pci reg holding the enable-bit */
  1061. u8 mask; /* mask to isolate the enable-bit */
  1062. u8 val; /* value of masked reg when "enabled" */
  1063. } ide_pci_enablebit_t;
  1064. enum {
  1065. /* Uses ISA control ports not PCI ones. */
  1066. IDEPCI_FLAG_ISA_PORTS = (1 << 0),
  1067. };
  1068. typedef struct ide_pci_device_s {
  1069. char *name;
  1070. int (*init_setup)(struct pci_dev *, struct ide_pci_device_s *);
  1071. void (*init_setup_dma)(struct pci_dev *, struct ide_pci_device_s *, ide_hwif_t *);
  1072. unsigned int (*init_chipset)(struct pci_dev *, const char *);
  1073. void (*init_iops)(ide_hwif_t *);
  1074. void (*init_hwif)(ide_hwif_t *);
  1075. void (*init_dma)(ide_hwif_t *, unsigned long);
  1076. void (*fixup)(ide_hwif_t *);
  1077. u8 channels;
  1078. u8 autodma;
  1079. ide_pci_enablebit_t enablebits[2];
  1080. u8 bootable;
  1081. unsigned int extra;
  1082. struct ide_pci_device_s *next;
  1083. u8 flags;
  1084. } ide_pci_device_t;
  1085. extern int ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
  1086. extern int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
  1087. void ide_map_sg(ide_drive_t *, struct request *);
  1088. void ide_init_sg_cmd(ide_drive_t *, struct request *);
  1089. #define BAD_DMA_DRIVE 0
  1090. #define GOOD_DMA_DRIVE 1
  1091. #ifdef CONFIG_BLK_DEV_IDEDMA
  1092. struct drive_list_entry {
  1093. const char *id_model;
  1094. const char *id_firmware;
  1095. };
  1096. int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
  1097. int __ide_dma_bad_drive(ide_drive_t *);
  1098. int __ide_dma_good_drive(ide_drive_t *);
  1099. int ide_use_dma(ide_drive_t *);
  1100. int __ide_dma_off(ide_drive_t *);
  1101. void ide_dma_verbose(ide_drive_t *);
  1102. ide_startstop_t ide_dma_intr(ide_drive_t *);
  1103. #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
  1104. extern int ide_build_sglist(ide_drive_t *, struct request *);
  1105. extern int ide_build_dmatable(ide_drive_t *, struct request *);
  1106. extern void ide_destroy_dmatable(ide_drive_t *);
  1107. extern int ide_release_dma(ide_hwif_t *);
  1108. extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
  1109. extern int __ide_dma_host_off(ide_drive_t *);
  1110. extern int __ide_dma_off_quietly(ide_drive_t *);
  1111. extern int __ide_dma_host_on(ide_drive_t *);
  1112. extern int __ide_dma_on(ide_drive_t *);
  1113. extern int __ide_dma_check(ide_drive_t *);
  1114. extern int ide_dma_setup(ide_drive_t *);
  1115. extern void ide_dma_start(ide_drive_t *);
  1116. extern int __ide_dma_end(ide_drive_t *);
  1117. extern int __ide_dma_lostirq(ide_drive_t *);
  1118. extern int __ide_dma_timeout(ide_drive_t *);
  1119. #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
  1120. #else
  1121. static inline int ide_use_dma(ide_drive_t *drive) { return 0; }
  1122. static inline int __ide_dma_off(ide_drive_t *drive) { return 0; }
  1123. static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
  1124. #endif /* CONFIG_BLK_DEV_IDEDMA */
  1125. #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
  1126. static inline void ide_release_dma(ide_hwif_t *drive) {;}
  1127. #endif
  1128. extern int ide_hwif_request_regions(ide_hwif_t *hwif);
  1129. extern void ide_hwif_release_regions(ide_hwif_t* hwif);
  1130. extern void ide_unregister (unsigned int index);
  1131. void ide_register_region(struct gendisk *);
  1132. void ide_unregister_region(struct gendisk *);
  1133. void ide_undecoded_slave(ide_hwif_t *);
  1134. int probe_hwif_init_with_fixup(ide_hwif_t *, void (*)(ide_hwif_t *));
  1135. extern int probe_hwif_init(ide_hwif_t *);
  1136. static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
  1137. {
  1138. return hwif->hwif_data;
  1139. }
  1140. static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
  1141. {
  1142. hwif->hwif_data = data;
  1143. }
  1144. /* ide-lib.c */
  1145. extern u8 ide_dma_speed(ide_drive_t *drive, u8 mode);
  1146. extern u8 ide_rate_filter(u8 mode, u8 speed);
  1147. extern int ide_dma_enable(ide_drive_t *drive);
  1148. extern char *ide_xfer_verbose(u8 xfer_rate);
  1149. extern void ide_toggle_bounce(ide_drive_t *drive, int on);
  1150. extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
  1151. u8 ide_dump_status(ide_drive_t *, const char *, u8);
  1152. typedef struct ide_pio_timings_s {
  1153. int setup_time; /* Address setup (ns) minimum */
  1154. int active_time; /* Active pulse (ns) minimum */
  1155. int cycle_time; /* Cycle time (ns) minimum = (setup + active + recovery) */
  1156. } ide_pio_timings_t;
  1157. typedef struct ide_pio_data_s {
  1158. u8 pio_mode;
  1159. u8 use_iordy;
  1160. u8 overridden;
  1161. u8 blacklisted;
  1162. unsigned int cycle_time;
  1163. } ide_pio_data_t;
  1164. extern u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d);
  1165. extern const ide_pio_timings_t ide_pio_timings[6];
  1166. extern spinlock_t ide_lock;
  1167. extern struct semaphore ide_cfg_sem;
  1168. /*
  1169. * Structure locking:
  1170. *
  1171. * ide_cfg_sem and ide_lock together protect changes to
  1172. * ide_hwif_t->{next,hwgroup}
  1173. * ide_drive_t->next
  1174. *
  1175. * ide_hwgroup_t->busy: ide_lock
  1176. * ide_hwgroup_t->hwif: ide_lock
  1177. * ide_hwif_t->mate: constant, no locking
  1178. * ide_drive_t->hwif: constant, no locking
  1179. */
  1180. #define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
  1181. extern struct bus_type ide_bus_type;
  1182. /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
  1183. #define ide_id_has_flush_cache(id) ((id)->cfs_enable_2 & 0x3000)
  1184. /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
  1185. #define ide_id_has_flush_cache_ext(id) \
  1186. (((id)->cfs_enable_2 & 0x2400) == 0x2400)
  1187. static inline int hwif_to_node(ide_hwif_t *hwif)
  1188. {
  1189. struct pci_dev *dev = hwif->pci_dev;
  1190. return dev ? pcibus_to_node(dev->bus) : -1;
  1191. }
  1192. #endif /* _IDE_H */