ide.h 45 KB

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