ide.h 43 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378
  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 dsc_overlap; /* DSC overlap */
  512. u8 nice1; /* give potential excess bandwidth */
  513. unsigned present : 1; /* drive is physically present */
  514. unsigned dead : 1; /* device ejected hint */
  515. unsigned id_read : 1; /* 1=id read from disk 0 = synthetic */
  516. unsigned noprobe : 1; /* from: hdx=noprobe */
  517. unsigned removable : 1; /* 1 if need to do check_media_change */
  518. unsigned attach : 1; /* needed for removable devices */
  519. unsigned forced_geom : 1; /* 1 if hdx=c,h,s was given at boot */
  520. unsigned no_unmask : 1; /* disallow setting unmask bit */
  521. unsigned no_io_32bit : 1; /* disallow enabling 32bit I/O */
  522. unsigned atapi_overlap : 1; /* ATAPI overlap (not supported) */
  523. unsigned nice0 : 1; /* give obvious excess bandwidth */
  524. unsigned nice2 : 1; /* give a share in our own bandwidth */
  525. unsigned doorlocking : 1; /* for removable only: door lock/unlock works */
  526. unsigned autotune : 2; /* 0=default, 1=autotune, 2=noautotune */
  527. unsigned remap_0_to_1 : 1; /* 0=noremap, 1=remap 0->1 (for EZDrive) */
  528. unsigned blocked : 1; /* 1=powermanagment told us not to do anything, so sleep nicely */
  529. unsigned vdma : 1; /* 1=doing PIO over DMA 0=doing normal DMA */
  530. unsigned addressing; /* : 3;
  531. * 0=28-bit
  532. * 1=48-bit
  533. * 2=48-bit doing 28-bit
  534. * 3=64-bit
  535. */
  536. unsigned scsi : 1; /* 0=default, 1=ide-scsi emulation */
  537. unsigned sleeping : 1; /* 1=sleeping & sleep field valid */
  538. unsigned post_reset : 1;
  539. u8 quirk_list; /* considered quirky, set for a specific host */
  540. u8 init_speed; /* transfer rate set at boot */
  541. u8 pio_speed; /* unused by core, used by some drivers for fallback from DMA */
  542. u8 current_speed; /* current transfer rate set */
  543. u8 dn; /* now wide spread use */
  544. u8 wcache; /* status of write cache */
  545. u8 acoustic; /* acoustic management */
  546. u8 media; /* disk, cdrom, tape, floppy, ... */
  547. u8 ctl; /* "normal" value for IDE_CONTROL_REG */
  548. u8 ready_stat; /* min status value for drive ready */
  549. u8 mult_count; /* current multiple sector setting */
  550. u8 mult_req; /* requested multiple sector setting */
  551. u8 tune_req; /* requested drive tuning setting */
  552. u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
  553. u8 bad_wstat; /* used for ignoring WRERR_STAT */
  554. u8 nowerr; /* used for ignoring WRERR_STAT */
  555. u8 sect0; /* offset of first sector for DM6:DDO */
  556. u8 head; /* "real" number of heads */
  557. u8 sect; /* "real" sectors per track */
  558. u8 bios_head; /* BIOS/fdisk/LILO number of heads */
  559. u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
  560. unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
  561. unsigned int cyl; /* "real" number of cyls */
  562. unsigned int drive_data; /* use by tuneproc/selectproc */
  563. unsigned int usage; /* current "open()" count for drive */
  564. unsigned int failures; /* current failure count */
  565. unsigned int max_failures; /* maximum allowed failure count */
  566. u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
  567. u64 capacity64; /* total number of sectors */
  568. int lun; /* logical unit */
  569. int crc_count; /* crc counter to reduce drive speed */
  570. struct list_head list;
  571. struct device gendev;
  572. struct completion gendev_rel_comp; /* to deal with device release() */
  573. } ide_drive_t;
  574. #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
  575. #define IDE_CHIPSET_PCI_MASK \
  576. ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
  577. #define IDE_CHIPSET_IS_PCI(c) ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
  578. struct ide_pci_device_s;
  579. typedef struct hwif_s {
  580. struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
  581. struct hwif_s *mate; /* other hwif from same PCI chip */
  582. struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
  583. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  584. char name[6]; /* name of interface, eg. "ide0" */
  585. /* task file registers for pata and sata */
  586. unsigned long io_ports[IDE_NR_PORTS];
  587. unsigned long sata_scr[SATA_NR_PORTS];
  588. unsigned long sata_misc[SATA_NR_PORTS];
  589. hw_regs_t hw; /* Hardware info */
  590. ide_drive_t drives[MAX_DRIVES]; /* drive info */
  591. u8 major; /* our major number */
  592. u8 index; /* 0 for ide0; 1 for ide1; ... */
  593. u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
  594. u8 straight8; /* Alan's straight 8 check */
  595. u8 bus_state; /* power state of the IDE bus */
  596. u8 atapi_dma; /* host supports atapi_dma */
  597. u8 ultra_mask;
  598. u8 mwdma_mask;
  599. u8 swdma_mask;
  600. hwif_chipset_t chipset; /* sub-module for tuning.. */
  601. struct pci_dev *pci_dev; /* for pci chipsets */
  602. struct ide_pci_device_s *cds; /* chipset device struct */
  603. void (*rw_disk)(ide_drive_t *, struct request *);
  604. #if 0
  605. ide_hwif_ops_t *hwifops;
  606. #else
  607. /* routine to tune PIO mode for drives */
  608. void (*tuneproc)(ide_drive_t *, u8);
  609. /* routine to retune DMA modes for drives */
  610. int (*speedproc)(ide_drive_t *, u8);
  611. /* tweaks hardware to select drive */
  612. void (*selectproc)(ide_drive_t *);
  613. /* chipset polling based on hba specifics */
  614. int (*reset_poll)(ide_drive_t *);
  615. /* chipset specific changes to default for device-hba resets */
  616. void (*pre_reset)(ide_drive_t *);
  617. /* routine to reset controller after a disk reset */
  618. void (*resetproc)(ide_drive_t *);
  619. /* special interrupt handling for shared pci interrupts */
  620. void (*intrproc)(ide_drive_t *);
  621. /* special host masking for drive selection */
  622. void (*maskproc)(ide_drive_t *, int);
  623. /* check host's drive quirk list */
  624. int (*quirkproc)(ide_drive_t *);
  625. /* driver soft-power interface */
  626. int (*busproc)(ide_drive_t *, int);
  627. // /* host rate limiter */
  628. // u8 (*ratemask)(ide_drive_t *);
  629. // /* device rate limiter */
  630. // u8 (*ratefilter)(ide_drive_t *, u8);
  631. #endif
  632. void (*ata_input_data)(ide_drive_t *, void *, u32);
  633. void (*ata_output_data)(ide_drive_t *, void *, u32);
  634. void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
  635. void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
  636. int (*dma_setup)(ide_drive_t *);
  637. void (*dma_exec_cmd)(ide_drive_t *, u8);
  638. void (*dma_start)(ide_drive_t *);
  639. int (*ide_dma_end)(ide_drive_t *drive);
  640. int (*ide_dma_check)(ide_drive_t *drive);
  641. int (*ide_dma_on)(ide_drive_t *drive);
  642. int (*ide_dma_off_quietly)(ide_drive_t *drive);
  643. int (*ide_dma_test_irq)(ide_drive_t *drive);
  644. int (*ide_dma_host_on)(ide_drive_t *drive);
  645. int (*ide_dma_host_off)(ide_drive_t *drive);
  646. int (*ide_dma_lostirq)(ide_drive_t *drive);
  647. int (*ide_dma_timeout)(ide_drive_t *drive);
  648. void (*OUTB)(u8 addr, unsigned long port);
  649. void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
  650. void (*OUTW)(u16 addr, unsigned long port);
  651. void (*OUTL)(u32 addr, unsigned long port);
  652. void (*OUTSW)(unsigned long port, void *addr, u32 count);
  653. void (*OUTSL)(unsigned long port, void *addr, u32 count);
  654. u8 (*INB)(unsigned long port);
  655. u16 (*INW)(unsigned long port);
  656. u32 (*INL)(unsigned long port);
  657. void (*INSW)(unsigned long port, void *addr, u32 count);
  658. void (*INSL)(unsigned long port, void *addr, u32 count);
  659. /* dma physical region descriptor table (cpu view) */
  660. unsigned int *dmatable_cpu;
  661. /* dma physical region descriptor table (dma view) */
  662. dma_addr_t dmatable_dma;
  663. /* Scatter-gather list used to build the above */
  664. struct scatterlist *sg_table;
  665. int sg_max_nents; /* Maximum number of entries in it */
  666. int sg_nents; /* Current number of entries in it */
  667. int sg_dma_direction; /* dma transfer direction */
  668. /* data phase of the active command (currently only valid for PIO/DMA) */
  669. int data_phase;
  670. unsigned int nsect;
  671. unsigned int nleft;
  672. unsigned int cursg;
  673. unsigned int cursg_ofs;
  674. int mmio; /* hosts iomio (0) or custom (2) select */
  675. int rqsize; /* max sectors per request */
  676. int irq; /* our irq number */
  677. unsigned long dma_master; /* reference base addr dmabase */
  678. unsigned long dma_base; /* base addr for dma ports */
  679. unsigned long dma_command; /* dma command register */
  680. unsigned long dma_vendor1; /* dma vendor 1 register */
  681. unsigned long dma_status; /* dma status register */
  682. unsigned long dma_vendor3; /* dma vendor 3 register */
  683. unsigned long dma_prdtable; /* actual prd table address */
  684. unsigned long dma_base2; /* extended base addr for dma ports */
  685. unsigned dma_extra; /* extra addr for dma ports */
  686. unsigned long config_data; /* for use by chipset-specific code */
  687. unsigned long select_data; /* for use by chipset-specific code */
  688. unsigned noprobe : 1; /* don't probe for this interface */
  689. unsigned present : 1; /* this interface exists */
  690. unsigned hold : 1; /* this interface is always present */
  691. unsigned serialized : 1; /* serialized all channel operation */
  692. unsigned sharing_irq: 1; /* 1 = sharing irq with another hwif */
  693. unsigned reset : 1; /* reset after probe */
  694. unsigned autodma : 1; /* auto-attempt using DMA at boot */
  695. unsigned udma_four : 1; /* 1=ATA-66 capable, 0=default */
  696. unsigned no_lba48 : 1; /* 1 = cannot do LBA48 */
  697. unsigned no_lba48_dma : 1; /* 1 = cannot do LBA48 DMA */
  698. unsigned no_dsc : 1; /* 0 default, 1 dsc_overlap disabled */
  699. unsigned auto_poll : 1; /* supports nop auto-poll */
  700. unsigned sg_mapped : 1; /* sg_table and sg_nents are ready */
  701. unsigned no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
  702. struct device gendev;
  703. struct completion gendev_rel_comp; /* To deal with device release() */
  704. void *hwif_data; /* extra hwif data */
  705. unsigned dma;
  706. void (*led_act)(void *data, int rw);
  707. } ____cacheline_internodealigned_in_smp ide_hwif_t;
  708. /*
  709. * internal ide interrupt handler type
  710. */
  711. typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
  712. typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
  713. typedef int (ide_expiry_t)(ide_drive_t *);
  714. typedef struct hwgroup_s {
  715. /* irq handler, if active */
  716. ide_startstop_t (*handler)(ide_drive_t *);
  717. /* irq handler, suspended if active */
  718. ide_startstop_t (*handler_save)(ide_drive_t *);
  719. /* BOOL: protects all fields below */
  720. volatile int busy;
  721. /* BOOL: wake us up on timer expiry */
  722. unsigned int sleeping : 1;
  723. /* BOOL: polling active & poll_timeout field valid */
  724. unsigned int polling : 1;
  725. /* current drive */
  726. ide_drive_t *drive;
  727. /* ptr to current hwif in linked-list */
  728. ide_hwif_t *hwif;
  729. /* for pci chipsets */
  730. struct pci_dev *pci_dev;
  731. /* chipset device struct */
  732. struct ide_pci_device_s *cds;
  733. /* current request */
  734. struct request *rq;
  735. /* failsafe timer */
  736. struct timer_list timer;
  737. /* local copy of current write rq */
  738. struct request wrq;
  739. /* timeout value during long polls */
  740. unsigned long poll_timeout;
  741. /* queried upon timeouts */
  742. int (*expiry)(ide_drive_t *);
  743. /* ide_system_bus_speed */
  744. int pio_clock;
  745. unsigned char cmd_buf[4];
  746. } ide_hwgroup_t;
  747. /* structure attached to the request for IDE_TASK_CMDS */
  748. /*
  749. * configurable drive settings
  750. */
  751. #define TYPE_INT 0
  752. #define TYPE_INTA 1
  753. #define TYPE_BYTE 2
  754. #define TYPE_SHORT 3
  755. #define SETTING_READ (1 << 0)
  756. #define SETTING_WRITE (1 << 1)
  757. #define SETTING_RW (SETTING_READ | SETTING_WRITE)
  758. typedef int (ide_procset_t)(ide_drive_t *, int);
  759. typedef struct ide_settings_s {
  760. char *name;
  761. int rw;
  762. int read_ioctl;
  763. int write_ioctl;
  764. int data_type;
  765. int min;
  766. int max;
  767. int mul_factor;
  768. int div_factor;
  769. void *data;
  770. ide_procset_t *set;
  771. int auto_remove;
  772. struct ide_settings_s *next;
  773. } ide_settings_t;
  774. extern struct semaphore ide_setting_sem;
  775. 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);
  776. extern ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name);
  777. extern int ide_read_setting(ide_drive_t *t, ide_settings_t *setting);
  778. extern int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val);
  779. extern void ide_add_generic_settings(ide_drive_t *drive);
  780. /*
  781. * /proc/ide interface
  782. */
  783. typedef struct {
  784. const char *name;
  785. mode_t mode;
  786. read_proc_t *read_proc;
  787. write_proc_t *write_proc;
  788. } ide_proc_entry_t;
  789. #ifdef CONFIG_PROC_FS
  790. extern struct proc_dir_entry *proc_ide_root;
  791. extern void proc_ide_create(void);
  792. extern void proc_ide_destroy(void);
  793. extern void create_proc_ide_interfaces(void);
  794. void destroy_proc_ide_interface(ide_hwif_t *);
  795. extern void ide_add_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *, void *);
  796. extern void ide_remove_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *);
  797. read_proc_t proc_ide_read_capacity;
  798. read_proc_t proc_ide_read_geometry;
  799. #ifdef CONFIG_BLK_DEV_IDEPCI
  800. void ide_pci_create_host_proc(const char *, get_info_t *);
  801. #endif
  802. /*
  803. * Standard exit stuff:
  804. */
  805. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
  806. { \
  807. len -= off; \
  808. if (len < count) { \
  809. *eof = 1; \
  810. if (len <= 0) \
  811. return 0; \
  812. } else \
  813. len = count; \
  814. *start = page + off; \
  815. return len; \
  816. }
  817. #else
  818. static inline void create_proc_ide_interfaces(void) { ; }
  819. static inline void destroy_proc_ide_interface(ide_hwif_t *hwif) { ; }
  820. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
  821. #endif
  822. /*
  823. * Power Management step value (rq->pm->pm_step).
  824. *
  825. * The step value starts at 0 (ide_pm_state_start_suspend) for a
  826. * suspend operation or 1000 (ide_pm_state_start_resume) for a
  827. * resume operation.
  828. *
  829. * For each step, the core calls the subdriver start_power_step() first.
  830. * This can return:
  831. * - ide_stopped : In this case, the core calls us back again unless
  832. * step have been set to ide_power_state_completed.
  833. * - ide_started : In this case, the channel is left busy until an
  834. * async event (interrupt) occurs.
  835. * Typically, start_power_step() will issue a taskfile request with
  836. * do_rw_taskfile().
  837. *
  838. * Upon reception of the interrupt, the core will call complete_power_step()
  839. * with the error code if any. This routine should update the step value
  840. * and return. It should not start a new request. The core will call
  841. * start_power_step for the new step value, unless step have been set to
  842. * ide_power_state_completed.
  843. *
  844. * Subdrivers are expected to define their own additional power
  845. * steps from 1..999 for suspend and from 1001..1999 for resume,
  846. * other values are reserved for future use.
  847. */
  848. enum {
  849. ide_pm_state_completed = -1,
  850. ide_pm_state_start_suspend = 0,
  851. ide_pm_state_start_resume = 1000,
  852. };
  853. /*
  854. * Subdrivers support.
  855. *
  856. * The gendriver.owner field should be set to the module owner of this driver.
  857. * The gendriver.name field should be set to the name of this driver
  858. */
  859. typedef struct ide_driver_s {
  860. const char *version;
  861. u8 media;
  862. unsigned supports_dsc_overlap : 1;
  863. ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
  864. int (*end_request)(ide_drive_t *, int, int);
  865. ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
  866. ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
  867. ide_proc_entry_t *proc;
  868. struct device_driver gen_driver;
  869. int (*probe)(ide_drive_t *);
  870. void (*remove)(ide_drive_t *);
  871. void (*shutdown)(ide_drive_t *);
  872. } ide_driver_t;
  873. #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
  874. int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
  875. /*
  876. * ide_hwifs[] is the master data structure used to keep track
  877. * of just about everything in ide.c. Whenever possible, routines
  878. * should be using pointers to a drive (ide_drive_t *) or
  879. * pointers to a hwif (ide_hwif_t *), rather than indexing this
  880. * structure directly (the allocation/layout may change!).
  881. *
  882. */
  883. #ifndef _IDE_C
  884. extern ide_hwif_t ide_hwifs[]; /* master data repository */
  885. #endif
  886. extern int noautodma;
  887. extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
  888. int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
  889. int uptodate, int nr_sectors);
  890. /*
  891. * This is used on exit from the driver to designate the next irq handler
  892. * and also to start the safety timer.
  893. */
  894. extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
  895. /*
  896. * This is used on exit from the driver to designate the next irq handler
  897. * and start the safety time safely and atomically from the IRQ handler
  898. * with respect to the command issue (which it also does)
  899. */
  900. extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
  901. ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
  902. /*
  903. * ide_error() takes action based on the error returned by the controller.
  904. * The caller should return immediately after invoking this.
  905. *
  906. * (drive, msg, status)
  907. */
  908. ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
  909. ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
  910. /*
  911. * Abort a running command on the controller triggering the abort
  912. * from a host side, non error situation
  913. * (drive, msg)
  914. */
  915. extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
  916. extern void ide_fix_driveid(struct hd_driveid *);
  917. /*
  918. * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
  919. * removing leading/trailing blanks and compressing internal blanks.
  920. * It is primarily used to tidy up the model name/number fields as
  921. * returned by the WIN_[P]IDENTIFY commands.
  922. *
  923. * (s, bytecount, byteswap)
  924. */
  925. extern void ide_fixstring(u8 *, const int, const int);
  926. /*
  927. * This routine busy-waits for the drive status to be not "busy".
  928. * It then checks the status for all of the "good" bits and none
  929. * of the "bad" bits, and if all is okay it returns 0. All other
  930. * cases return 1 after doing "*startstop = ide_error()", and the
  931. * caller should return the updated value of "startstop" in this case.
  932. * "startstop" is unchanged when the function returns 0;
  933. * (startstop, drive, good, bad, timeout)
  934. */
  935. extern int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
  936. /*
  937. * Start a reset operation for an IDE interface.
  938. * The caller should return immediately after invoking this.
  939. */
  940. extern ide_startstop_t ide_do_reset (ide_drive_t *);
  941. /*
  942. * This function is intended to be used prior to invoking ide_do_drive_cmd().
  943. */
  944. extern void ide_init_drive_cmd (struct request *rq);
  945. /*
  946. * this function returns error location sector offset in case of a write error
  947. */
  948. extern u64 ide_get_error_location(ide_drive_t *, char *);
  949. /*
  950. * "action" parameter type for ide_do_drive_cmd() below.
  951. */
  952. typedef enum {
  953. ide_wait, /* insert rq at end of list, and wait for it */
  954. ide_preempt, /* insert rq in front of current request */
  955. ide_head_wait, /* insert rq in front of current request and wait for it */
  956. ide_end /* insert rq at end of list, but don't wait for it */
  957. } ide_action_t;
  958. extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
  959. /*
  960. * Clean up after success/failure of an explicit drive cmd.
  961. * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
  962. * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_TASK_MASK).
  963. *
  964. * (ide_drive_t *drive, u8 stat, u8 err)
  965. */
  966. extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
  967. /*
  968. * Issue ATA command and wait for completion.
  969. * Use for implementing commands in kernel
  970. *
  971. * (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
  972. */
  973. extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
  974. typedef struct ide_task_s {
  975. /*
  976. * struct hd_drive_task_hdr tf;
  977. * task_struct_t tf;
  978. * struct hd_drive_hob_hdr hobf;
  979. * hob_struct_t hobf;
  980. */
  981. task_ioreg_t tfRegister[8];
  982. task_ioreg_t hobRegister[8];
  983. ide_reg_valid_t tf_out_flags;
  984. ide_reg_valid_t tf_in_flags;
  985. int data_phase;
  986. int command_type;
  987. ide_pre_handler_t *prehandler;
  988. ide_handler_t *handler;
  989. struct request *rq; /* copy of request */
  990. void *special; /* valid_t generally */
  991. } ide_task_t;
  992. extern u32 ide_read_24(ide_drive_t *);
  993. extern void SELECT_DRIVE(ide_drive_t *);
  994. extern void SELECT_INTERRUPT(ide_drive_t *);
  995. extern void SELECT_MASK(ide_drive_t *, int);
  996. extern void QUIRK_LIST(ide_drive_t *);
  997. extern int drive_is_ready(ide_drive_t *);
  998. extern int wait_for_ready(ide_drive_t *, int /* timeout */);
  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, struct pt_regs *regs);
  1033. extern void do_ide_request(request_queue_t *);
  1034. void ide_init_disk(struct gendisk *, ide_drive_t *);
  1035. extern int ideprobe_init(void);
  1036. extern void ide_scan_pcibus(int scan_direction) __init;
  1037. extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner);
  1038. #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE)
  1039. extern void ide_pci_unregister_driver(struct pci_driver *driver);
  1040. void ide_pci_setup_ports(struct pci_dev *, struct ide_pci_device_s *, int, ata_index_t *);
  1041. extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
  1042. extern void default_hwif_iops(ide_hwif_t *);
  1043. extern void default_hwif_mmiops(ide_hwif_t *);
  1044. extern void default_hwif_transport(ide_hwif_t *);
  1045. void ide_register_subdriver(ide_drive_t *, ide_driver_t *);
  1046. void ide_unregister_subdriver(ide_drive_t *, ide_driver_t *);
  1047. #define ON_BOARD 1
  1048. #define NEVER_BOARD 0
  1049. #ifdef CONFIG_BLK_DEV_OFFBOARD
  1050. # define OFF_BOARD ON_BOARD
  1051. #else /* CONFIG_BLK_DEV_OFFBOARD */
  1052. # define OFF_BOARD NEVER_BOARD
  1053. #endif /* CONFIG_BLK_DEV_OFFBOARD */
  1054. #define NODMA 0
  1055. #define NOAUTODMA 1
  1056. #define AUTODMA 2
  1057. typedef struct ide_pci_enablebit_s {
  1058. u8 reg; /* byte pci reg holding the enable-bit */
  1059. u8 mask; /* mask to isolate the enable-bit */
  1060. u8 val; /* value of masked reg when "enabled" */
  1061. } ide_pci_enablebit_t;
  1062. enum {
  1063. /* Uses ISA control ports not PCI ones. */
  1064. IDEPCI_FLAG_ISA_PORTS = (1 << 0),
  1065. };
  1066. typedef struct ide_pci_device_s {
  1067. char *name;
  1068. int (*init_setup)(struct pci_dev *, struct ide_pci_device_s *);
  1069. void (*init_setup_dma)(struct pci_dev *, struct ide_pci_device_s *, ide_hwif_t *);
  1070. unsigned int (*init_chipset)(struct pci_dev *, const char *);
  1071. void (*init_iops)(ide_hwif_t *);
  1072. void (*init_hwif)(ide_hwif_t *);
  1073. void (*init_dma)(ide_hwif_t *, unsigned long);
  1074. void (*fixup)(ide_hwif_t *);
  1075. u8 channels;
  1076. u8 autodma;
  1077. ide_pci_enablebit_t enablebits[2];
  1078. u8 bootable;
  1079. unsigned int extra;
  1080. struct ide_pci_device_s *next;
  1081. u8 flags;
  1082. } ide_pci_device_t;
  1083. extern int ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
  1084. extern int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
  1085. void ide_map_sg(ide_drive_t *, struct request *);
  1086. void ide_init_sg_cmd(ide_drive_t *, struct request *);
  1087. #define BAD_DMA_DRIVE 0
  1088. #define GOOD_DMA_DRIVE 1
  1089. #ifdef CONFIG_BLK_DEV_IDEDMA
  1090. struct drive_list_entry {
  1091. const char *id_model;
  1092. const char *id_firmware;
  1093. };
  1094. int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
  1095. int __ide_dma_bad_drive(ide_drive_t *);
  1096. int __ide_dma_good_drive(ide_drive_t *);
  1097. int ide_use_dma(ide_drive_t *);
  1098. int __ide_dma_off(ide_drive_t *);
  1099. void ide_dma_verbose(ide_drive_t *);
  1100. ide_startstop_t ide_dma_intr(ide_drive_t *);
  1101. #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
  1102. extern int ide_build_sglist(ide_drive_t *, struct request *);
  1103. extern int ide_build_dmatable(ide_drive_t *, struct request *);
  1104. extern void ide_destroy_dmatable(ide_drive_t *);
  1105. extern int ide_release_dma(ide_hwif_t *);
  1106. extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
  1107. extern int __ide_dma_host_off(ide_drive_t *);
  1108. extern int __ide_dma_off_quietly(ide_drive_t *);
  1109. extern int __ide_dma_host_on(ide_drive_t *);
  1110. extern int __ide_dma_on(ide_drive_t *);
  1111. extern int __ide_dma_check(ide_drive_t *);
  1112. extern int ide_dma_setup(ide_drive_t *);
  1113. extern void ide_dma_start(ide_drive_t *);
  1114. extern int __ide_dma_end(ide_drive_t *);
  1115. extern int __ide_dma_lostirq(ide_drive_t *);
  1116. extern int __ide_dma_timeout(ide_drive_t *);
  1117. #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
  1118. #else
  1119. static inline int ide_use_dma(ide_drive_t *drive) { return 0; }
  1120. static inline int __ide_dma_off(ide_drive_t *drive) { return 0; }
  1121. static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
  1122. #endif /* CONFIG_BLK_DEV_IDEDMA */
  1123. #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
  1124. static inline void ide_release_dma(ide_hwif_t *drive) {;}
  1125. #endif
  1126. extern int ide_hwif_request_regions(ide_hwif_t *hwif);
  1127. extern void ide_hwif_release_regions(ide_hwif_t* hwif);
  1128. extern void ide_unregister (unsigned int index);
  1129. void ide_register_region(struct gendisk *);
  1130. void ide_unregister_region(struct gendisk *);
  1131. void ide_undecoded_slave(ide_hwif_t *);
  1132. int probe_hwif_init_with_fixup(ide_hwif_t *, void (*)(ide_hwif_t *));
  1133. extern int probe_hwif_init(ide_hwif_t *);
  1134. static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
  1135. {
  1136. return hwif->hwif_data;
  1137. }
  1138. static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
  1139. {
  1140. hwif->hwif_data = data;
  1141. }
  1142. /* ide-lib.c */
  1143. extern u8 ide_dma_speed(ide_drive_t *drive, u8 mode);
  1144. extern u8 ide_rate_filter(u8 mode, u8 speed);
  1145. extern int ide_dma_enable(ide_drive_t *drive);
  1146. extern char *ide_xfer_verbose(u8 xfer_rate);
  1147. extern void ide_toggle_bounce(ide_drive_t *drive, int on);
  1148. extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
  1149. u8 ide_dump_status(ide_drive_t *, const char *, u8);
  1150. typedef struct ide_pio_timings_s {
  1151. int setup_time; /* Address setup (ns) minimum */
  1152. int active_time; /* Active pulse (ns) minimum */
  1153. int cycle_time; /* Cycle time (ns) minimum = (setup + active + recovery) */
  1154. } ide_pio_timings_t;
  1155. typedef struct ide_pio_data_s {
  1156. u8 pio_mode;
  1157. u8 use_iordy;
  1158. u8 overridden;
  1159. u8 blacklisted;
  1160. unsigned int cycle_time;
  1161. } ide_pio_data_t;
  1162. extern u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d);
  1163. extern const ide_pio_timings_t ide_pio_timings[6];
  1164. extern spinlock_t ide_lock;
  1165. extern struct semaphore ide_cfg_sem;
  1166. /*
  1167. * Structure locking:
  1168. *
  1169. * ide_cfg_sem and ide_lock together protect changes to
  1170. * ide_hwif_t->{next,hwgroup}
  1171. * ide_drive_t->next
  1172. *
  1173. * ide_hwgroup_t->busy: ide_lock
  1174. * ide_hwgroup_t->hwif: ide_lock
  1175. * ide_hwif_t->mate: constant, no locking
  1176. * ide_drive_t->hwif: constant, no locking
  1177. */
  1178. #define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable(); } while (0)
  1179. extern struct bus_type ide_bus_type;
  1180. /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
  1181. #define ide_id_has_flush_cache(id) ((id)->cfs_enable_2 & 0x3000)
  1182. /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
  1183. #define ide_id_has_flush_cache_ext(id) \
  1184. (((id)->cfs_enable_2 & 0x2400) == 0x2400)
  1185. static inline int hwif_to_node(ide_hwif_t *hwif)
  1186. {
  1187. struct pci_dev *dev = hwif->pci_dev;
  1188. return dev ? pcibus_to_node(dev->bus) : -1;
  1189. }
  1190. #endif /* _IDE_H */