ide.h 44 KB

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