ide.h 45 KB

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