ide.h 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568
  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/ata.h>
  11. #include <linux/blkdev.h>
  12. #include <linux/proc_fs.h>
  13. #include <linux/interrupt.h>
  14. #include <linux/bitops.h>
  15. #include <linux/bio.h>
  16. #include <linux/device.h>
  17. #include <linux/pci.h>
  18. #include <linux/completion.h>
  19. #include <linux/pm.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/mutex.h>
  27. /* for request_sense */
  28. #include <linux/cdrom.h>
  29. #if defined(CONFIG_CRIS) || defined(CONFIG_FRV) || defined(CONFIG_MN10300)
  30. # define SUPPORT_VLB_SYNC 0
  31. #else
  32. # define SUPPORT_VLB_SYNC 1
  33. #endif
  34. /*
  35. * Probably not wise to fiddle with these
  36. */
  37. #define IDE_DEFAULT_MAX_FAILURES 1
  38. #define ERROR_MAX 8 /* Max read/write errors per sector */
  39. #define ERROR_RESET 3 /* Reset controller every 4th retry */
  40. #define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
  41. /* Error codes returned in rq->errors to the higher part of the driver. */
  42. enum {
  43. IDE_DRV_ERROR_GENERAL = 101,
  44. IDE_DRV_ERROR_FILEMARK = 102,
  45. IDE_DRV_ERROR_EOD = 103,
  46. };
  47. /*
  48. * Definitions for accessing IDE controller registers
  49. */
  50. #define IDE_NR_PORTS (10)
  51. struct ide_io_ports {
  52. unsigned long data_addr;
  53. union {
  54. unsigned long error_addr; /* read: error */
  55. unsigned long feature_addr; /* write: feature */
  56. };
  57. unsigned long nsect_addr;
  58. unsigned long lbal_addr;
  59. unsigned long lbam_addr;
  60. unsigned long lbah_addr;
  61. unsigned long device_addr;
  62. union {
  63. unsigned long status_addr; /*  read: status  */
  64. unsigned long command_addr; /* write: command */
  65. };
  66. unsigned long ctl_addr;
  67. unsigned long irq_addr;
  68. };
  69. #define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
  70. #define BAD_R_STAT (ATA_BUSY | ATA_ERR)
  71. #define BAD_W_STAT (BAD_R_STAT | ATA_DF)
  72. #define BAD_STAT (BAD_R_STAT | ATA_DRQ)
  73. #define DRIVE_READY (ATA_DRDY | ATA_DSC)
  74. #define BAD_CRC (ATA_ABORTED | ATA_ICRC)
  75. #define SATA_NR_PORTS (3) /* 16 possible ?? */
  76. #define SATA_STATUS_OFFSET (0)
  77. #define SATA_ERROR_OFFSET (1)
  78. #define SATA_CONTROL_OFFSET (2)
  79. /*
  80. * Our Physical Region Descriptor (PRD) table should be large enough
  81. * to handle the biggest I/O request we are likely to see. Since requests
  82. * can have no more than 256 sectors, and since the typical blocksize is
  83. * two or more sectors, we could get by with a limit of 128 entries here for
  84. * the usual worst case. Most requests seem to include some contiguous blocks,
  85. * further reducing the number of table entries required.
  86. *
  87. * The driver reverts to PIO mode for individual requests that exceed
  88. * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
  89. * 100% of all crazy scenarios here is not necessary.
  90. *
  91. * As it turns out though, we must allocate a full 4KB page for this,
  92. * so the two PRD tables (ide0 & ide1) will each get half of that,
  93. * allowing each to have about 256 entries (8 bytes each) from this.
  94. */
  95. #define PRD_BYTES 8
  96. #define PRD_ENTRIES 256
  97. /*
  98. * Some more useful definitions
  99. */
  100. #define PARTN_BITS 6 /* number of minor dev bits for partitions */
  101. #define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
  102. #define SECTOR_SIZE 512
  103. /*
  104. * Timeouts for various operations:
  105. */
  106. enum {
  107. /* spec allows up to 20ms */
  108. WAIT_DRQ = HZ / 10, /* 100ms */
  109. /* some laptops are very slow */
  110. WAIT_READY = 5 * HZ, /* 5s */
  111. /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
  112. WAIT_PIDENTIFY = 10 * HZ, /* 10s */
  113. /* worst case when spinning up */
  114. WAIT_WORSTCASE = 30 * HZ, /* 30s */
  115. /* maximum wait for an IRQ to happen */
  116. WAIT_CMD = 10 * HZ, /* 10s */
  117. /* Some drives require a longer IRQ timeout. */
  118. WAIT_FLOPPY_CMD = 50 * HZ, /* 50s */
  119. /*
  120. * Some drives (for example, Seagate STT3401A Travan) require a very
  121. * long timeout, because they don't return an interrupt or clear their
  122. * BSY bit until after the command completes (even retension commands).
  123. */
  124. WAIT_TAPE_CMD = 900 * HZ, /* 900s */
  125. /* minimum sleep time */
  126. WAIT_MIN_SLEEP = HZ / 50, /* 20ms */
  127. };
  128. /*
  129. * Op codes for special requests to be handled by ide_special_rq().
  130. * Values should be in the range of 0x20 to 0x3f.
  131. */
  132. #define REQ_DRIVE_RESET 0x20
  133. #define REQ_DEVSET_EXEC 0x21
  134. #define REQ_PARK_HEADS 0x22
  135. #define REQ_UNPARK_HEADS 0x23
  136. /*
  137. * Check for an interrupt and acknowledge the interrupt status
  138. */
  139. struct hwif_s;
  140. typedef int (ide_ack_intr_t)(struct hwif_s *);
  141. /*
  142. * hwif_chipset_t is used to keep track of the specific hardware
  143. * chipset used by each IDE interface, if known.
  144. */
  145. enum { ide_unknown, ide_generic, ide_pci,
  146. ide_cmd640, ide_dtc2278, ide_ali14xx,
  147. ide_qd65xx, ide_umc8672, ide_ht6560b,
  148. ide_4drives, ide_pmac, ide_acorn,
  149. ide_au1xxx, ide_palm3710
  150. };
  151. typedef u8 hwif_chipset_t;
  152. /*
  153. * Structure to hold all information about the location of this port
  154. */
  155. typedef struct hw_regs_s {
  156. union {
  157. struct ide_io_ports io_ports;
  158. unsigned long io_ports_array[IDE_NR_PORTS];
  159. };
  160. int irq; /* our irq number */
  161. ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
  162. hwif_chipset_t chipset;
  163. struct device *dev, *parent;
  164. unsigned long config;
  165. } hw_regs_t;
  166. static inline void ide_std_init_ports(hw_regs_t *hw,
  167. unsigned long io_addr,
  168. unsigned long ctl_addr)
  169. {
  170. unsigned int i;
  171. for (i = 0; i <= 7; i++)
  172. hw->io_ports_array[i] = io_addr++;
  173. hw->io_ports.ctl_addr = ctl_addr;
  174. }
  175. #define MAX_HWIFS 10
  176. /*
  177. * Now for the data we need to maintain per-drive: ide_drive_t
  178. */
  179. #define ide_scsi 0x21
  180. #define ide_disk 0x20
  181. #define ide_optical 0x7
  182. #define ide_cdrom 0x5
  183. #define ide_tape 0x1
  184. #define ide_floppy 0x0
  185. /*
  186. * Special Driver Flags
  187. *
  188. * set_geometry : respecify drive geometry
  189. * recalibrate : seek to cyl 0
  190. * set_multmode : set multmode count
  191. * reserved : unused
  192. */
  193. typedef union {
  194. unsigned all : 8;
  195. struct {
  196. unsigned set_geometry : 1;
  197. unsigned recalibrate : 1;
  198. unsigned set_multmode : 1;
  199. unsigned reserved : 5;
  200. } b;
  201. } special_t;
  202. /*
  203. * Status returned from various ide_ functions
  204. */
  205. typedef enum {
  206. ide_stopped, /* no drive operation was started */
  207. ide_started, /* a drive operation was started, handler was set */
  208. } ide_startstop_t;
  209. enum {
  210. IDE_VALID_ERROR = (1 << 1),
  211. IDE_VALID_FEATURE = IDE_VALID_ERROR,
  212. IDE_VALID_NSECT = (1 << 2),
  213. IDE_VALID_LBAL = (1 << 3),
  214. IDE_VALID_LBAM = (1 << 4),
  215. IDE_VALID_LBAH = (1 << 5),
  216. IDE_VALID_DEVICE = (1 << 6),
  217. IDE_VALID_LBA = IDE_VALID_LBAL |
  218. IDE_VALID_LBAM |
  219. IDE_VALID_LBAH,
  220. IDE_VALID_OUT_TF = IDE_VALID_FEATURE |
  221. IDE_VALID_NSECT |
  222. IDE_VALID_LBA,
  223. IDE_VALID_IN_TF = IDE_VALID_NSECT |
  224. IDE_VALID_LBA,
  225. IDE_VALID_OUT_HOB = IDE_VALID_OUT_TF,
  226. IDE_VALID_IN_HOB = IDE_VALID_ERROR |
  227. IDE_VALID_NSECT |
  228. IDE_VALID_LBA,
  229. };
  230. enum {
  231. IDE_TFLAG_LBA48 = (1 << 0),
  232. IDE_TFLAG_WRITE = (1 << 1),
  233. IDE_TFLAG_CUSTOM_HANDLER = (1 << 2),
  234. IDE_TFLAG_DMA_PIO_FALLBACK = (1 << 3),
  235. /* force 16-bit I/O operations */
  236. IDE_TFLAG_IO_16BIT = (1 << 4),
  237. /* struct ide_cmd was allocated using kmalloc() */
  238. IDE_TFLAG_DYN = (1 << 5),
  239. IDE_TFLAG_FS = (1 << 6),
  240. IDE_TFLAG_MULTI_PIO = (1 << 7),
  241. };
  242. enum {
  243. IDE_FTFLAG_FLAGGED = (1 << 0),
  244. IDE_FTFLAG_SET_IN_FLAGS = (1 << 1),
  245. IDE_FTFLAG_OUT_DATA = (1 << 2),
  246. IDE_FTFLAG_IN_DATA = (1 << 3),
  247. };
  248. struct ide_taskfile {
  249. u8 data; /* 0: data byte (for TASKFILE ioctl) */
  250. union { /* 1: */
  251. u8 error; /* read: error */
  252. u8 feature; /* write: feature */
  253. };
  254. u8 nsect; /* 2: number of sectors */
  255. u8 lbal; /* 3: LBA low */
  256. u8 lbam; /* 4: LBA mid */
  257. u8 lbah; /* 5: LBA high */
  258. u8 device; /* 6: device select */
  259. union { /* 7: */
  260. u8 status; /* read: status */
  261. u8 command; /* write: command */
  262. };
  263. };
  264. struct ide_cmd {
  265. struct ide_taskfile tf;
  266. struct ide_taskfile hob;
  267. struct {
  268. struct {
  269. u8 tf;
  270. u8 hob;
  271. } out, in;
  272. } valid;
  273. u8 tf_flags;
  274. u8 ftf_flags; /* for TASKFILE ioctl */
  275. int protocol;
  276. int sg_nents; /* number of sg entries */
  277. int orig_sg_nents;
  278. int sg_dma_direction; /* DMA transfer direction */
  279. unsigned int nbytes;
  280. unsigned int nleft;
  281. unsigned int last_xfer_len;
  282. struct scatterlist *cursg;
  283. unsigned int cursg_ofs;
  284. struct request *rq; /* copy of request */
  285. };
  286. /* ATAPI packet command flags */
  287. enum {
  288. /* set when an error is considered normal - no retry (ide-tape) */
  289. PC_FLAG_ABORT = (1 << 0),
  290. PC_FLAG_SUPPRESS_ERROR = (1 << 1),
  291. PC_FLAG_WAIT_FOR_DSC = (1 << 2),
  292. PC_FLAG_DMA_OK = (1 << 3),
  293. PC_FLAG_DMA_IN_PROGRESS = (1 << 4),
  294. PC_FLAG_DMA_ERROR = (1 << 5),
  295. PC_FLAG_WRITING = (1 << 6),
  296. };
  297. #define ATAPI_WAIT_PC (60 * HZ)
  298. struct ide_atapi_pc {
  299. /* actual packet bytes */
  300. u8 c[12];
  301. /* incremented on each retry */
  302. int retries;
  303. int error;
  304. /* bytes to transfer */
  305. int req_xfer;
  306. /* the corresponding request */
  307. struct request *rq;
  308. unsigned long flags;
  309. /*
  310. * those are more or less driver-specific and some of them are subject
  311. * to change/removal later.
  312. */
  313. unsigned long timeout;
  314. };
  315. struct ide_devset;
  316. struct ide_driver;
  317. #ifdef CONFIG_BLK_DEV_IDEACPI
  318. struct ide_acpi_drive_link;
  319. struct ide_acpi_hwif_link;
  320. #endif
  321. struct ide_drive_s;
  322. struct ide_disk_ops {
  323. int (*check)(struct ide_drive_s *, const char *);
  324. int (*get_capacity)(struct ide_drive_s *);
  325. void (*setup)(struct ide_drive_s *);
  326. void (*flush)(struct ide_drive_s *);
  327. int (*init_media)(struct ide_drive_s *, struct gendisk *);
  328. int (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
  329. int);
  330. ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
  331. sector_t);
  332. int (*ioctl)(struct ide_drive_s *, struct block_device *,
  333. fmode_t, unsigned int, unsigned long);
  334. };
  335. /* ATAPI device flags */
  336. enum {
  337. IDE_AFLAG_DRQ_INTERRUPT = (1 << 0),
  338. /* ide-cd */
  339. /* Drive cannot eject the disc. */
  340. IDE_AFLAG_NO_EJECT = (1 << 1),
  341. /* Drive is a pre ATAPI 1.2 drive. */
  342. IDE_AFLAG_PRE_ATAPI12 = (1 << 2),
  343. /* TOC addresses are in BCD. */
  344. IDE_AFLAG_TOCADDR_AS_BCD = (1 << 3),
  345. /* TOC track numbers are in BCD. */
  346. IDE_AFLAG_TOCTRACKS_AS_BCD = (1 << 4),
  347. /* Saved TOC information is current. */
  348. IDE_AFLAG_TOC_VALID = (1 << 6),
  349. /* We think that the drive door is locked. */
  350. IDE_AFLAG_DOOR_LOCKED = (1 << 7),
  351. /* SET_CD_SPEED command is unsupported. */
  352. IDE_AFLAG_NO_SPEED_SELECT = (1 << 8),
  353. IDE_AFLAG_VERTOS_300_SSD = (1 << 9),
  354. IDE_AFLAG_VERTOS_600_ESD = (1 << 10),
  355. IDE_AFLAG_SANYO_3CD = (1 << 11),
  356. IDE_AFLAG_FULL_CAPS_PAGE = (1 << 12),
  357. IDE_AFLAG_PLAY_AUDIO_OK = (1 << 13),
  358. IDE_AFLAG_LE_SPEED_FIELDS = (1 << 14),
  359. /* ide-floppy */
  360. /* Avoid commands not supported in Clik drive */
  361. IDE_AFLAG_CLIK_DRIVE = (1 << 15),
  362. /* Requires BH algorithm for packets */
  363. IDE_AFLAG_ZIP_DRIVE = (1 << 16),
  364. /* Supports format progress report */
  365. IDE_AFLAG_SRFP = (1 << 17),
  366. /* ide-tape */
  367. IDE_AFLAG_IGNORE_DSC = (1 << 18),
  368. /* 0 When the tape position is unknown */
  369. IDE_AFLAG_ADDRESS_VALID = (1 << 19),
  370. /* Device already opened */
  371. IDE_AFLAG_BUSY = (1 << 20),
  372. /* Attempt to auto-detect the current user block size */
  373. IDE_AFLAG_DETECT_BS = (1 << 21),
  374. /* Currently on a filemark */
  375. IDE_AFLAG_FILEMARK = (1 << 22),
  376. /* 0 = no tape is loaded, so we don't rewind after ejecting */
  377. IDE_AFLAG_MEDIUM_PRESENT = (1 << 23),
  378. IDE_AFLAG_NO_AUTOCLOSE = (1 << 24),
  379. };
  380. /* device flags */
  381. enum {
  382. /* restore settings after device reset */
  383. IDE_DFLAG_KEEP_SETTINGS = (1 << 0),
  384. /* device is using DMA for read/write */
  385. IDE_DFLAG_USING_DMA = (1 << 1),
  386. /* okay to unmask other IRQs */
  387. IDE_DFLAG_UNMASK = (1 << 2),
  388. /* don't attempt flushes */
  389. IDE_DFLAG_NOFLUSH = (1 << 3),
  390. /* DSC overlap */
  391. IDE_DFLAG_DSC_OVERLAP = (1 << 4),
  392. /* give potential excess bandwidth */
  393. IDE_DFLAG_NICE1 = (1 << 5),
  394. /* device is physically present */
  395. IDE_DFLAG_PRESENT = (1 << 6),
  396. /* id read from device (synthetic if not set) */
  397. IDE_DFLAG_ID_READ = (1 << 8),
  398. IDE_DFLAG_NOPROBE = (1 << 9),
  399. /* need to do check_media_change() */
  400. IDE_DFLAG_REMOVABLE = (1 << 10),
  401. /* needed for removable devices */
  402. IDE_DFLAG_ATTACH = (1 << 11),
  403. IDE_DFLAG_FORCED_GEOM = (1 << 12),
  404. /* disallow setting unmask bit */
  405. IDE_DFLAG_NO_UNMASK = (1 << 13),
  406. /* disallow enabling 32-bit I/O */
  407. IDE_DFLAG_NO_IO_32BIT = (1 << 14),
  408. /* for removable only: door lock/unlock works */
  409. IDE_DFLAG_DOORLOCKING = (1 << 15),
  410. /* disallow DMA */
  411. IDE_DFLAG_NODMA = (1 << 16),
  412. /* powermanagment told us not to do anything, so sleep nicely */
  413. IDE_DFLAG_BLOCKED = (1 << 17),
  414. /* sleeping & sleep field valid */
  415. IDE_DFLAG_SLEEPING = (1 << 18),
  416. IDE_DFLAG_POST_RESET = (1 << 19),
  417. IDE_DFLAG_UDMA33_WARNED = (1 << 20),
  418. IDE_DFLAG_LBA48 = (1 << 21),
  419. /* status of write cache */
  420. IDE_DFLAG_WCACHE = (1 << 22),
  421. /* used for ignoring ATA_DF */
  422. IDE_DFLAG_NOWERR = (1 << 23),
  423. /* retrying in PIO */
  424. IDE_DFLAG_DMA_PIO_RETRY = (1 << 24),
  425. IDE_DFLAG_LBA = (1 << 25),
  426. /* don't unload heads */
  427. IDE_DFLAG_NO_UNLOAD = (1 << 26),
  428. /* heads unloaded, please don't reset port */
  429. IDE_DFLAG_PARKED = (1 << 27),
  430. IDE_DFLAG_MEDIA_CHANGED = (1 << 28),
  431. /* write protect */
  432. IDE_DFLAG_WP = (1 << 29),
  433. IDE_DFLAG_FORMAT_IN_PROGRESS = (1 << 30),
  434. };
  435. struct ide_drive_s {
  436. char name[4]; /* drive name, such as "hda" */
  437. char driver_req[10]; /* requests specific driver */
  438. struct request_queue *queue; /* request queue */
  439. struct request *rq; /* current request */
  440. void *driver_data; /* extra driver data */
  441. u16 *id; /* identification info */
  442. #ifdef CONFIG_IDE_PROC_FS
  443. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  444. const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
  445. #endif
  446. struct hwif_s *hwif; /* actually (ide_hwif_t *) */
  447. const struct ide_disk_ops *disk_ops;
  448. unsigned long dev_flags;
  449. unsigned long sleep; /* sleep until this time */
  450. unsigned long timeout; /* max time to wait for irq */
  451. special_t special; /* special action flags */
  452. u8 select; /* basic drive/head select reg value */
  453. u8 retry_pio; /* retrying dma capable host in pio */
  454. u8 waiting_for_dma; /* dma currently in progress */
  455. u8 dma; /* atapi dma flag */
  456. u8 quirk_list; /* considered quirky, set for a specific host */
  457. u8 init_speed; /* transfer rate set at boot */
  458. u8 current_speed; /* current transfer rate set */
  459. u8 desired_speed; /* desired transfer rate set */
  460. u8 dn; /* now wide spread use */
  461. u8 acoustic; /* acoustic management */
  462. u8 media; /* disk, cdrom, tape, floppy, ... */
  463. u8 ready_stat; /* min status value for drive ready */
  464. u8 mult_count; /* current multiple sector setting */
  465. u8 mult_req; /* requested multiple sector setting */
  466. u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
  467. u8 bad_wstat; /* used for ignoring ATA_DF */
  468. u8 head; /* "real" number of heads */
  469. u8 sect; /* "real" sectors per track */
  470. u8 bios_head; /* BIOS/fdisk/LILO number of heads */
  471. u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
  472. /* delay this long before sending packet command */
  473. u8 pc_delay;
  474. unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
  475. unsigned int cyl; /* "real" number of cyls */
  476. unsigned int drive_data; /* used by set_pio_mode/dev_select() */
  477. unsigned int failures; /* current failure count */
  478. unsigned int max_failures; /* maximum allowed failure count */
  479. u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
  480. u64 capacity64; /* total number of sectors */
  481. int lun; /* logical unit */
  482. int crc_count; /* crc counter to reduce drive speed */
  483. unsigned long debug_mask; /* debugging levels switch */
  484. #ifdef CONFIG_BLK_DEV_IDEACPI
  485. struct ide_acpi_drive_link *acpidata;
  486. #endif
  487. struct list_head list;
  488. struct device gendev;
  489. struct completion gendev_rel_comp; /* to deal with device release() */
  490. /* current packet command */
  491. struct ide_atapi_pc *pc;
  492. /* last failed packet command */
  493. struct ide_atapi_pc *failed_pc;
  494. /* callback for packet commands */
  495. int (*pc_callback)(struct ide_drive_s *, int);
  496. ide_startstop_t (*irq_handler)(struct ide_drive_s *);
  497. unsigned long atapi_flags;
  498. struct ide_atapi_pc request_sense_pc;
  499. /* current sense rq and buffer */
  500. bool sense_rq_armed;
  501. struct request sense_rq;
  502. struct request_sense sense_data;
  503. };
  504. typedef struct ide_drive_s ide_drive_t;
  505. #define to_ide_device(dev) container_of(dev, ide_drive_t, gendev)
  506. #define to_ide_drv(obj, cont_type) \
  507. container_of(obj, struct cont_type, dev)
  508. #define ide_drv_g(disk, cont_type) \
  509. container_of((disk)->private_data, struct cont_type, driver)
  510. struct ide_port_info;
  511. struct ide_tp_ops {
  512. void (*exec_command)(struct hwif_s *, u8);
  513. u8 (*read_status)(struct hwif_s *);
  514. u8 (*read_altstatus)(struct hwif_s *);
  515. void (*write_devctl)(struct hwif_s *, u8);
  516. void (*dev_select)(ide_drive_t *);
  517. void (*tf_load)(ide_drive_t *, struct ide_taskfile *, u8);
  518. void (*tf_read)(ide_drive_t *, struct ide_taskfile *, u8);
  519. void (*input_data)(ide_drive_t *, struct ide_cmd *,
  520. void *, unsigned int);
  521. void (*output_data)(ide_drive_t *, struct ide_cmd *,
  522. void *, unsigned int);
  523. };
  524. extern const struct ide_tp_ops default_tp_ops;
  525. /**
  526. * struct ide_port_ops - IDE port operations
  527. *
  528. * @init_dev: host specific initialization of a device
  529. * @set_pio_mode: routine to program host for PIO mode
  530. * @set_dma_mode: routine to program host for DMA mode
  531. * @reset_poll: chipset polling based on hba specifics
  532. * @pre_reset: chipset specific changes to default for device-hba resets
  533. * @resetproc: routine to reset controller after a disk reset
  534. * @maskproc: special host masking for drive selection
  535. * @quirkproc: check host's drive quirk list
  536. * @clear_irq: clear IRQ
  537. *
  538. * @mdma_filter: filter MDMA modes
  539. * @udma_filter: filter UDMA modes
  540. *
  541. * @cable_detect: detect cable type
  542. */
  543. struct ide_port_ops {
  544. void (*init_dev)(ide_drive_t *);
  545. void (*set_pio_mode)(ide_drive_t *, const u8);
  546. void (*set_dma_mode)(ide_drive_t *, const u8);
  547. int (*reset_poll)(ide_drive_t *);
  548. void (*pre_reset)(ide_drive_t *);
  549. void (*resetproc)(ide_drive_t *);
  550. void (*maskproc)(ide_drive_t *, int);
  551. void (*quirkproc)(ide_drive_t *);
  552. void (*clear_irq)(ide_drive_t *);
  553. u8 (*mdma_filter)(ide_drive_t *);
  554. u8 (*udma_filter)(ide_drive_t *);
  555. u8 (*cable_detect)(struct hwif_s *);
  556. };
  557. struct ide_dma_ops {
  558. void (*dma_host_set)(struct ide_drive_s *, int);
  559. int (*dma_setup)(struct ide_drive_s *, struct ide_cmd *);
  560. void (*dma_start)(struct ide_drive_s *);
  561. int (*dma_end)(struct ide_drive_s *);
  562. int (*dma_test_irq)(struct ide_drive_s *);
  563. void (*dma_lost_irq)(struct ide_drive_s *);
  564. /* below ones are optional */
  565. int (*dma_check)(struct ide_drive_s *, struct ide_cmd *);
  566. int (*dma_timer_expiry)(struct ide_drive_s *);
  567. void (*dma_clear)(struct ide_drive_s *);
  568. /*
  569. * The following method is optional and only required to be
  570. * implemented for the SFF-8038i compatible controllers.
  571. */
  572. u8 (*dma_sff_read_status)(struct hwif_s *);
  573. };
  574. struct ide_host;
  575. typedef struct hwif_s {
  576. struct hwif_s *mate; /* other hwif from same PCI chip */
  577. struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
  578. struct ide_host *host;
  579. char name[6]; /* name of interface, eg. "ide0" */
  580. struct ide_io_ports io_ports;
  581. unsigned long sata_scr[SATA_NR_PORTS];
  582. ide_drive_t *devices[MAX_DRIVES + 1];
  583. u8 major; /* our major number */
  584. u8 index; /* 0 for ide0; 1 for ide1; ... */
  585. u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
  586. u32 host_flags;
  587. u8 pio_mask;
  588. u8 ultra_mask;
  589. u8 mwdma_mask;
  590. u8 swdma_mask;
  591. u8 cbl; /* cable type */
  592. hwif_chipset_t chipset; /* sub-module for tuning.. */
  593. struct device *dev;
  594. ide_ack_intr_t *ack_intr;
  595. void (*rw_disk)(ide_drive_t *, struct request *);
  596. const struct ide_tp_ops *tp_ops;
  597. const struct ide_port_ops *port_ops;
  598. const struct ide_dma_ops *dma_ops;
  599. /* dma physical region descriptor table (cpu view) */
  600. unsigned int *dmatable_cpu;
  601. /* dma physical region descriptor table (dma view) */
  602. dma_addr_t dmatable_dma;
  603. /* maximum number of PRD table entries */
  604. int prd_max_nents;
  605. /* PRD entry size in bytes */
  606. int prd_ent_size;
  607. /* Scatter-gather list used to build the above */
  608. struct scatterlist *sg_table;
  609. int sg_max_nents; /* Maximum number of entries in it */
  610. struct ide_cmd cmd; /* current command */
  611. int rqsize; /* max sectors per request */
  612. int irq; /* our irq number */
  613. unsigned long dma_base; /* base addr for dma ports */
  614. unsigned long config_data; /* for use by chipset-specific code */
  615. unsigned long select_data; /* for use by chipset-specific code */
  616. unsigned long extra_base; /* extra addr for dma ports */
  617. unsigned extra_ports; /* number of extra dma ports */
  618. unsigned present : 1; /* this interface exists */
  619. unsigned busy : 1; /* serializes devices on a port */
  620. struct device gendev;
  621. struct device *portdev;
  622. struct completion gendev_rel_comp; /* To deal with device release() */
  623. void *hwif_data; /* extra hwif data */
  624. #ifdef CONFIG_BLK_DEV_IDEACPI
  625. struct ide_acpi_hwif_link *acpidata;
  626. #endif
  627. /* IRQ handler, if active */
  628. ide_startstop_t (*handler)(ide_drive_t *);
  629. /* BOOL: polling active & poll_timeout field valid */
  630. unsigned int polling : 1;
  631. /* current drive */
  632. ide_drive_t *cur_dev;
  633. /* current request */
  634. struct request *rq;
  635. /* failsafe timer */
  636. struct timer_list timer;
  637. /* timeout value during long polls */
  638. unsigned long poll_timeout;
  639. /* queried upon timeouts */
  640. int (*expiry)(ide_drive_t *);
  641. int req_gen;
  642. int req_gen_timer;
  643. spinlock_t lock;
  644. } ____cacheline_internodealigned_in_smp ide_hwif_t;
  645. #define MAX_HOST_PORTS 4
  646. struct ide_host {
  647. ide_hwif_t *ports[MAX_HOST_PORTS + 1];
  648. unsigned int n_ports;
  649. struct device *dev[2];
  650. int (*init_chipset)(struct pci_dev *);
  651. void (*get_lock)(irq_handler_t, void *);
  652. void (*release_lock)(void);
  653. irq_handler_t irq_handler;
  654. unsigned long host_flags;
  655. int irq_flags;
  656. void *host_priv;
  657. ide_hwif_t *cur_port; /* for hosts requiring serialization */
  658. /* used for hosts requiring serialization */
  659. volatile unsigned long host_busy;
  660. };
  661. #define IDE_HOST_BUSY 0
  662. /*
  663. * internal ide interrupt handler type
  664. */
  665. typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
  666. typedef int (ide_expiry_t)(ide_drive_t *);
  667. /* used by ide-cd, ide-floppy, etc. */
  668. typedef void (xfer_func_t)(ide_drive_t *, struct ide_cmd *, void *, unsigned);
  669. extern struct mutex ide_setting_mtx;
  670. /*
  671. * configurable drive settings
  672. */
  673. #define DS_SYNC (1 << 0)
  674. struct ide_devset {
  675. int (*get)(ide_drive_t *);
  676. int (*set)(ide_drive_t *, int);
  677. unsigned int flags;
  678. };
  679. #define __DEVSET(_flags, _get, _set) { \
  680. .flags = _flags, \
  681. .get = _get, \
  682. .set = _set, \
  683. }
  684. #define ide_devset_get(name, field) \
  685. static int get_##name(ide_drive_t *drive) \
  686. { \
  687. return drive->field; \
  688. }
  689. #define ide_devset_set(name, field) \
  690. static int set_##name(ide_drive_t *drive, int arg) \
  691. { \
  692. drive->field = arg; \
  693. return 0; \
  694. }
  695. #define ide_devset_get_flag(name, flag) \
  696. static int get_##name(ide_drive_t *drive) \
  697. { \
  698. return !!(drive->dev_flags & flag); \
  699. }
  700. #define ide_devset_set_flag(name, flag) \
  701. static int set_##name(ide_drive_t *drive, int arg) \
  702. { \
  703. if (arg) \
  704. drive->dev_flags |= flag; \
  705. else \
  706. drive->dev_flags &= ~flag; \
  707. return 0; \
  708. }
  709. #define __IDE_DEVSET(_name, _flags, _get, _set) \
  710. const struct ide_devset ide_devset_##_name = \
  711. __DEVSET(_flags, _get, _set)
  712. #define IDE_DEVSET(_name, _flags, _get, _set) \
  713. static __IDE_DEVSET(_name, _flags, _get, _set)
  714. #define ide_devset_rw(_name, _func) \
  715. IDE_DEVSET(_name, 0, get_##_func, set_##_func)
  716. #define ide_devset_w(_name, _func) \
  717. IDE_DEVSET(_name, 0, NULL, set_##_func)
  718. #define ide_ext_devset_rw(_name, _func) \
  719. __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
  720. #define ide_ext_devset_rw_sync(_name, _func) \
  721. __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
  722. #define ide_decl_devset(_name) \
  723. extern const struct ide_devset ide_devset_##_name
  724. ide_decl_devset(io_32bit);
  725. ide_decl_devset(keepsettings);
  726. ide_decl_devset(pio_mode);
  727. ide_decl_devset(unmaskirq);
  728. ide_decl_devset(using_dma);
  729. #ifdef CONFIG_IDE_PROC_FS
  730. /*
  731. * /proc/ide interface
  732. */
  733. #define ide_devset_rw_field(_name, _field) \
  734. ide_devset_get(_name, _field); \
  735. ide_devset_set(_name, _field); \
  736. IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
  737. #define ide_devset_rw_flag(_name, _field) \
  738. ide_devset_get_flag(_name, _field); \
  739. ide_devset_set_flag(_name, _field); \
  740. IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
  741. struct ide_proc_devset {
  742. const char *name;
  743. const struct ide_devset *setting;
  744. int min, max;
  745. int (*mulf)(ide_drive_t *);
  746. int (*divf)(ide_drive_t *);
  747. };
  748. #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
  749. .name = __stringify(_name), \
  750. .setting = &ide_devset_##_name, \
  751. .min = _min, \
  752. .max = _max, \
  753. .mulf = _mulf, \
  754. .divf = _divf, \
  755. }
  756. #define IDE_PROC_DEVSET(_name, _min, _max) \
  757. __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
  758. typedef struct {
  759. const char *name;
  760. mode_t mode;
  761. read_proc_t *read_proc;
  762. write_proc_t *write_proc;
  763. } ide_proc_entry_t;
  764. void proc_ide_create(void);
  765. void proc_ide_destroy(void);
  766. void ide_proc_register_port(ide_hwif_t *);
  767. void ide_proc_port_register_devices(ide_hwif_t *);
  768. void ide_proc_unregister_device(ide_drive_t *);
  769. void ide_proc_unregister_port(ide_hwif_t *);
  770. void ide_proc_register_driver(ide_drive_t *, struct ide_driver *);
  771. void ide_proc_unregister_driver(ide_drive_t *, struct ide_driver *);
  772. read_proc_t proc_ide_read_capacity;
  773. read_proc_t proc_ide_read_geometry;
  774. /*
  775. * Standard exit stuff:
  776. */
  777. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
  778. { \
  779. len -= off; \
  780. if (len < count) { \
  781. *eof = 1; \
  782. if (len <= 0) \
  783. return 0; \
  784. } else \
  785. len = count; \
  786. *start = page + off; \
  787. return len; \
  788. }
  789. #else
  790. static inline void proc_ide_create(void) { ; }
  791. static inline void proc_ide_destroy(void) { ; }
  792. static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
  793. static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
  794. static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
  795. static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
  796. static inline void ide_proc_register_driver(ide_drive_t *drive,
  797. struct ide_driver *driver) { ; }
  798. static inline void ide_proc_unregister_driver(ide_drive_t *drive,
  799. struct ide_driver *driver) { ; }
  800. #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
  801. #endif
  802. enum {
  803. /* enter/exit functions */
  804. IDE_DBG_FUNC = (1 << 0),
  805. /* sense key/asc handling */
  806. IDE_DBG_SENSE = (1 << 1),
  807. /* packet commands handling */
  808. IDE_DBG_PC = (1 << 2),
  809. /* request handling */
  810. IDE_DBG_RQ = (1 << 3),
  811. /* driver probing/setup */
  812. IDE_DBG_PROBE = (1 << 4),
  813. };
  814. /* DRV_NAME has to be defined in the driver before using the macro below */
  815. #define __ide_debug_log(lvl, fmt, args...) \
  816. { \
  817. if (unlikely(drive->debug_mask & lvl)) \
  818. printk(KERN_INFO DRV_NAME ": %s: " fmt "\n", \
  819. __func__, ## args); \
  820. }
  821. /*
  822. * Power Management state machine (rq->pm->pm_step).
  823. *
  824. * For each step, the core calls ide_start_power_step() first.
  825. * This can return:
  826. * - ide_stopped : In this case, the core calls us back again unless
  827. * step have been set to ide_power_state_completed.
  828. * - ide_started : In this case, the channel is left busy until an
  829. * async event (interrupt) occurs.
  830. * Typically, ide_start_power_step() will issue a taskfile request with
  831. * do_rw_taskfile().
  832. *
  833. * Upon reception of the interrupt, the core will call ide_complete_power_step()
  834. * with the error code if any. This routine should update the step value
  835. * and return. It should not start a new request. The core will call
  836. * ide_start_power_step() for the new step value, unless step have been
  837. * set to IDE_PM_COMPLETED.
  838. */
  839. enum {
  840. IDE_PM_START_SUSPEND,
  841. IDE_PM_FLUSH_CACHE = IDE_PM_START_SUSPEND,
  842. IDE_PM_STANDBY,
  843. IDE_PM_START_RESUME,
  844. IDE_PM_RESTORE_PIO = IDE_PM_START_RESUME,
  845. IDE_PM_IDLE,
  846. IDE_PM_RESTORE_DMA,
  847. IDE_PM_COMPLETED,
  848. };
  849. int generic_ide_suspend(struct device *, pm_message_t);
  850. int generic_ide_resume(struct device *);
  851. void ide_complete_power_step(ide_drive_t *, struct request *);
  852. ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
  853. void ide_complete_pm_rq(ide_drive_t *, struct request *);
  854. void ide_check_pm_state(ide_drive_t *, struct request *);
  855. /*
  856. * Subdrivers support.
  857. *
  858. * The gendriver.owner field should be set to the module owner of this driver.
  859. * The gendriver.name field should be set to the name of this driver
  860. */
  861. struct ide_driver {
  862. const char *version;
  863. ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
  864. struct device_driver gen_driver;
  865. int (*probe)(ide_drive_t *);
  866. void (*remove)(ide_drive_t *);
  867. void (*resume)(ide_drive_t *);
  868. void (*shutdown)(ide_drive_t *);
  869. #ifdef CONFIG_IDE_PROC_FS
  870. ide_proc_entry_t * (*proc_entries)(ide_drive_t *);
  871. const struct ide_proc_devset * (*proc_devsets)(ide_drive_t *);
  872. #endif
  873. };
  874. #define to_ide_driver(drv) container_of(drv, struct ide_driver, gen_driver)
  875. int ide_device_get(ide_drive_t *);
  876. void ide_device_put(ide_drive_t *);
  877. struct ide_ioctl_devset {
  878. unsigned int get_ioctl;
  879. unsigned int set_ioctl;
  880. const struct ide_devset *setting;
  881. };
  882. int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
  883. unsigned long, const struct ide_ioctl_devset *);
  884. int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
  885. extern int ide_vlb_clk;
  886. extern int ide_pci_clk;
  887. unsigned int ide_rq_bytes(struct request *);
  888. int ide_end_rq(ide_drive_t *, struct request *, int, unsigned int);
  889. void ide_kill_rq(ide_drive_t *, struct request *);
  890. void __ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
  891. void ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
  892. void ide_execute_command(ide_drive_t *, struct ide_cmd *, ide_handler_t *,
  893. unsigned int);
  894. void ide_pad_transfer(ide_drive_t *, int, int);
  895. ide_startstop_t ide_error(ide_drive_t *, const char *, u8);
  896. void ide_fix_driveid(u16 *);
  897. extern void ide_fixstring(u8 *, const int, const int);
  898. int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
  899. int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
  900. ide_startstop_t ide_do_park_unpark(ide_drive_t *, struct request *);
  901. ide_startstop_t ide_do_devset(ide_drive_t *, struct request *);
  902. extern ide_startstop_t ide_do_reset (ide_drive_t *);
  903. extern int ide_devset_execute(ide_drive_t *drive,
  904. const struct ide_devset *setting, int arg);
  905. void ide_complete_cmd(ide_drive_t *, struct ide_cmd *, u8, u8);
  906. int ide_complete_rq(ide_drive_t *, int, unsigned int);
  907. void ide_tf_readback(ide_drive_t *drive, struct ide_cmd *cmd);
  908. void ide_tf_dump(const char *, struct ide_cmd *);
  909. void ide_exec_command(ide_hwif_t *, u8);
  910. u8 ide_read_status(ide_hwif_t *);
  911. u8 ide_read_altstatus(ide_hwif_t *);
  912. void ide_write_devctl(ide_hwif_t *, u8);
  913. void ide_dev_select(ide_drive_t *);
  914. void ide_tf_load(ide_drive_t *, struct ide_taskfile *, u8);
  915. void ide_tf_read(ide_drive_t *, struct ide_taskfile *, u8);
  916. void ide_input_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
  917. void ide_output_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
  918. void SELECT_MASK(ide_drive_t *, int);
  919. u8 ide_read_error(ide_drive_t *);
  920. void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
  921. int ide_check_atapi_device(ide_drive_t *, const char *);
  922. void ide_init_pc(struct ide_atapi_pc *);
  923. /* Disk head parking */
  924. extern wait_queue_head_t ide_park_wq;
  925. ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
  926. char *buf);
  927. ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
  928. const char *buf, size_t len);
  929. /*
  930. * Special requests for ide-tape block device strategy routine.
  931. *
  932. * In order to service a character device command, we add special requests to
  933. * the tail of our block device request queue and wait for their completion.
  934. */
  935. enum {
  936. REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
  937. REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
  938. REQ_IDETAPE_READ = (1 << 2),
  939. REQ_IDETAPE_WRITE = (1 << 3),
  940. };
  941. int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *,
  942. void *, unsigned int);
  943. int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
  944. int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
  945. int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
  946. void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
  947. void ide_retry_pc(ide_drive_t *drive);
  948. void ide_prep_sense(ide_drive_t *drive, struct request *rq);
  949. int ide_queue_sense_rq(ide_drive_t *drive, void *special);
  950. int ide_cd_expiry(ide_drive_t *);
  951. int ide_cd_get_xferlen(struct request *);
  952. ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_cmd *);
  953. ide_startstop_t do_rw_taskfile(ide_drive_t *, struct ide_cmd *);
  954. void ide_pio_bytes(ide_drive_t *, struct ide_cmd *, unsigned int, unsigned int);
  955. void ide_finish_cmd(ide_drive_t *, struct ide_cmd *, u8);
  956. int ide_raw_taskfile(ide_drive_t *, struct ide_cmd *, u8 *, u16);
  957. int ide_no_data_taskfile(ide_drive_t *, struct ide_cmd *);
  958. int ide_taskfile_ioctl(ide_drive_t *, unsigned long);
  959. int ide_dev_read_id(ide_drive_t *, u8, u16 *);
  960. extern int ide_driveid_update(ide_drive_t *);
  961. extern int ide_config_drive_speed(ide_drive_t *, u8);
  962. extern u8 eighty_ninty_three (ide_drive_t *);
  963. extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
  964. extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
  965. extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
  966. extern void ide_timer_expiry(unsigned long);
  967. extern irqreturn_t ide_intr(int irq, void *dev_id);
  968. extern void do_ide_request(struct request_queue *);
  969. void ide_init_disk(struct gendisk *, ide_drive_t *);
  970. #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
  971. extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
  972. #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
  973. #else
  974. #define ide_pci_register_driver(d) pci_register_driver(d)
  975. #endif
  976. static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
  977. {
  978. if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
  979. return 1;
  980. return 0;
  981. }
  982. void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *,
  983. hw_regs_t *, hw_regs_t **);
  984. void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
  985. #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
  986. int ide_pci_set_master(struct pci_dev *, const char *);
  987. unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
  988. int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
  989. int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
  990. #else
  991. static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
  992. const struct ide_port_info *d)
  993. {
  994. return -EINVAL;
  995. }
  996. #endif
  997. struct ide_pci_enablebit {
  998. u8 reg; /* byte pci reg holding the enable-bit */
  999. u8 mask; /* mask to isolate the enable-bit */
  1000. u8 val; /* value of masked reg when "enabled" */
  1001. };
  1002. enum {
  1003. /* Uses ISA control ports not PCI ones. */
  1004. IDE_HFLAG_ISA_PORTS = (1 << 0),
  1005. /* single port device */
  1006. IDE_HFLAG_SINGLE = (1 << 1),
  1007. /* don't use legacy PIO blacklist */
  1008. IDE_HFLAG_PIO_NO_BLACKLIST = (1 << 2),
  1009. /* set for the second port of QD65xx */
  1010. IDE_HFLAG_QD_2ND_PORT = (1 << 3),
  1011. /* use PIO8/9 for prefetch off/on */
  1012. IDE_HFLAG_ABUSE_PREFETCH = (1 << 4),
  1013. /* use PIO6/7 for fast-devsel off/on */
  1014. IDE_HFLAG_ABUSE_FAST_DEVSEL = (1 << 5),
  1015. /* use 100-102 and 200-202 PIO values to set DMA modes */
  1016. IDE_HFLAG_ABUSE_DMA_MODES = (1 << 6),
  1017. /*
  1018. * keep DMA setting when programming PIO mode, may be used only
  1019. * for hosts which have separate PIO and DMA timings (ie. PMAC)
  1020. */
  1021. IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
  1022. /* program host for the transfer mode after programming device */
  1023. IDE_HFLAG_POST_SET_MODE = (1 << 8),
  1024. /* don't program host/device for the transfer mode ("smart" hosts) */
  1025. IDE_HFLAG_NO_SET_MODE = (1 << 9),
  1026. /* trust BIOS for programming chipset/device for DMA */
  1027. IDE_HFLAG_TRUST_BIOS_FOR_DMA = (1 << 10),
  1028. /* host is CS5510/CS5520 */
  1029. IDE_HFLAG_CS5520 = (1 << 11),
  1030. /* ATAPI DMA is unsupported */
  1031. IDE_HFLAG_NO_ATAPI_DMA = (1 << 12),
  1032. /* set if host is a "non-bootable" controller */
  1033. IDE_HFLAG_NON_BOOTABLE = (1 << 13),
  1034. /* host doesn't support DMA */
  1035. IDE_HFLAG_NO_DMA = (1 << 14),
  1036. /* check if host is PCI IDE device before allowing DMA */
  1037. IDE_HFLAG_NO_AUTODMA = (1 << 15),
  1038. /* host uses MMIO */
  1039. IDE_HFLAG_MMIO = (1 << 16),
  1040. /* no LBA48 */
  1041. IDE_HFLAG_NO_LBA48 = (1 << 17),
  1042. /* no LBA48 DMA */
  1043. IDE_HFLAG_NO_LBA48_DMA = (1 << 18),
  1044. /* data FIFO is cleared by an error */
  1045. IDE_HFLAG_ERROR_STOPS_FIFO = (1 << 19),
  1046. /* serialize ports */
  1047. IDE_HFLAG_SERIALIZE = (1 << 20),
  1048. /* host is DTC2278 */
  1049. IDE_HFLAG_DTC2278 = (1 << 21),
  1050. /* 4 devices on a single set of I/O ports */
  1051. IDE_HFLAG_4DRIVES = (1 << 22),
  1052. /* host is TRM290 */
  1053. IDE_HFLAG_TRM290 = (1 << 23),
  1054. /* use 32-bit I/O ops */
  1055. IDE_HFLAG_IO_32BIT = (1 << 24),
  1056. /* unmask IRQs */
  1057. IDE_HFLAG_UNMASK_IRQS = (1 << 25),
  1058. IDE_HFLAG_BROKEN_ALTSTATUS = (1 << 26),
  1059. /* serialize ports if DMA is possible (for sl82c105) */
  1060. IDE_HFLAG_SERIALIZE_DMA = (1 << 27),
  1061. /* force host out of "simplex" mode */
  1062. IDE_HFLAG_CLEAR_SIMPLEX = (1 << 28),
  1063. /* DSC overlap is unsupported */
  1064. IDE_HFLAG_NO_DSC = (1 << 29),
  1065. /* never use 32-bit I/O ops */
  1066. IDE_HFLAG_NO_IO_32BIT = (1 << 30),
  1067. /* never unmask IRQs */
  1068. IDE_HFLAG_NO_UNMASK_IRQS = (1 << 31),
  1069. };
  1070. #ifdef CONFIG_BLK_DEV_OFFBOARD
  1071. # define IDE_HFLAG_OFF_BOARD 0
  1072. #else
  1073. # define IDE_HFLAG_OFF_BOARD IDE_HFLAG_NON_BOOTABLE
  1074. #endif
  1075. struct ide_port_info {
  1076. char *name;
  1077. int (*init_chipset)(struct pci_dev *);
  1078. void (*get_lock)(irq_handler_t, void *);
  1079. void (*release_lock)(void);
  1080. void (*init_iops)(ide_hwif_t *);
  1081. void (*init_hwif)(ide_hwif_t *);
  1082. int (*init_dma)(ide_hwif_t *,
  1083. const struct ide_port_info *);
  1084. const struct ide_tp_ops *tp_ops;
  1085. const struct ide_port_ops *port_ops;
  1086. const struct ide_dma_ops *dma_ops;
  1087. struct ide_pci_enablebit enablebits[2];
  1088. hwif_chipset_t chipset;
  1089. u16 max_sectors; /* if < than the default one */
  1090. u32 host_flags;
  1091. int irq_flags;
  1092. u8 pio_mask;
  1093. u8 swdma_mask;
  1094. u8 mwdma_mask;
  1095. u8 udma_mask;
  1096. };
  1097. int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
  1098. int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
  1099. const struct ide_port_info *, void *);
  1100. void ide_pci_remove(struct pci_dev *);
  1101. #ifdef CONFIG_PM
  1102. int ide_pci_suspend(struct pci_dev *, pm_message_t);
  1103. int ide_pci_resume(struct pci_dev *);
  1104. #else
  1105. #define ide_pci_suspend NULL
  1106. #define ide_pci_resume NULL
  1107. #endif
  1108. void ide_map_sg(ide_drive_t *, struct ide_cmd *);
  1109. void ide_init_sg_cmd(struct ide_cmd *, unsigned int);
  1110. #define BAD_DMA_DRIVE 0
  1111. #define GOOD_DMA_DRIVE 1
  1112. struct drive_list_entry {
  1113. const char *id_model;
  1114. const char *id_firmware;
  1115. };
  1116. int ide_in_drive_list(u16 *, const struct drive_list_entry *);
  1117. #ifdef CONFIG_BLK_DEV_IDEDMA
  1118. int ide_dma_good_drive(ide_drive_t *);
  1119. int __ide_dma_bad_drive(ide_drive_t *);
  1120. int ide_id_dma_bug(ide_drive_t *);
  1121. u8 ide_find_dma_mode(ide_drive_t *, u8);
  1122. static inline u8 ide_max_dma_mode(ide_drive_t *drive)
  1123. {
  1124. return ide_find_dma_mode(drive, XFER_UDMA_6);
  1125. }
  1126. void ide_dma_off_quietly(ide_drive_t *);
  1127. void ide_dma_off(ide_drive_t *);
  1128. void ide_dma_on(ide_drive_t *);
  1129. int ide_set_dma(ide_drive_t *);
  1130. void ide_check_dma_crc(ide_drive_t *);
  1131. ide_startstop_t ide_dma_intr(ide_drive_t *);
  1132. int ide_allocate_dma_engine(ide_hwif_t *);
  1133. void ide_release_dma_engine(ide_hwif_t *);
  1134. int ide_dma_prepare(ide_drive_t *, struct ide_cmd *);
  1135. void ide_dma_unmap_sg(ide_drive_t *, struct ide_cmd *);
  1136. #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
  1137. int config_drive_for_dma(ide_drive_t *);
  1138. int ide_build_dmatable(ide_drive_t *, struct ide_cmd *);
  1139. void ide_dma_host_set(ide_drive_t *, int);
  1140. int ide_dma_setup(ide_drive_t *, struct ide_cmd *);
  1141. extern void ide_dma_start(ide_drive_t *);
  1142. int ide_dma_end(ide_drive_t *);
  1143. int ide_dma_test_irq(ide_drive_t *);
  1144. int ide_dma_sff_timer_expiry(ide_drive_t *);
  1145. u8 ide_dma_sff_read_status(ide_hwif_t *);
  1146. extern const struct ide_dma_ops sff_dma_ops;
  1147. #else
  1148. static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
  1149. #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
  1150. void ide_dma_lost_irq(ide_drive_t *);
  1151. ide_startstop_t ide_dma_timeout_retry(ide_drive_t *, int);
  1152. #else
  1153. static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
  1154. static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
  1155. static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
  1156. static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
  1157. static inline void ide_dma_off(ide_drive_t *drive) { ; }
  1158. static inline void ide_dma_on(ide_drive_t *drive) { ; }
  1159. static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
  1160. static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
  1161. static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
  1162. static inline ide_startstop_t ide_dma_intr(ide_drive_t *drive) { return ide_stopped; }
  1163. static inline ide_startstop_t ide_dma_timeout_retry(ide_drive_t *drive, int error) { return ide_stopped; }
  1164. static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
  1165. static inline int ide_dma_prepare(ide_drive_t *drive,
  1166. struct ide_cmd *cmd) { return 1; }
  1167. static inline void ide_dma_unmap_sg(ide_drive_t *drive,
  1168. struct ide_cmd *cmd) { ; }
  1169. #endif /* CONFIG_BLK_DEV_IDEDMA */
  1170. #ifdef CONFIG_BLK_DEV_IDEACPI
  1171. int ide_acpi_init(void);
  1172. extern int ide_acpi_exec_tfs(ide_drive_t *drive);
  1173. extern void ide_acpi_get_timing(ide_hwif_t *hwif);
  1174. extern void ide_acpi_push_timing(ide_hwif_t *hwif);
  1175. void ide_acpi_init_port(ide_hwif_t *);
  1176. void ide_acpi_port_init_devices(ide_hwif_t *);
  1177. extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
  1178. #else
  1179. static inline int ide_acpi_init(void) { return 0; }
  1180. static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
  1181. static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
  1182. static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
  1183. static inline void ide_acpi_init_port(ide_hwif_t *hwif) { ; }
  1184. static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
  1185. static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
  1186. #endif
  1187. void ide_register_region(struct gendisk *);
  1188. void ide_unregister_region(struct gendisk *);
  1189. void ide_undecoded_slave(ide_drive_t *);
  1190. void ide_port_apply_params(ide_hwif_t *);
  1191. int ide_sysfs_register_port(ide_hwif_t *);
  1192. struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
  1193. void ide_host_free(struct ide_host *);
  1194. int ide_host_register(struct ide_host *, const struct ide_port_info *,
  1195. hw_regs_t **);
  1196. int ide_host_add(const struct ide_port_info *, hw_regs_t **,
  1197. struct ide_host **);
  1198. void ide_host_remove(struct ide_host *);
  1199. int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
  1200. void ide_port_unregister_devices(ide_hwif_t *);
  1201. void ide_port_scan(ide_hwif_t *);
  1202. static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
  1203. {
  1204. return hwif->hwif_data;
  1205. }
  1206. static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
  1207. {
  1208. hwif->hwif_data = data;
  1209. }
  1210. extern void ide_toggle_bounce(ide_drive_t *drive, int on);
  1211. u64 ide_get_lba_addr(struct ide_cmd *, int);
  1212. u8 ide_dump_status(ide_drive_t *, const char *, u8);
  1213. struct ide_timing {
  1214. u8 mode;
  1215. u8 setup; /* t1 */
  1216. u16 act8b; /* t2 for 8-bit io */
  1217. u16 rec8b; /* t2i for 8-bit io */
  1218. u16 cyc8b; /* t0 for 8-bit io */
  1219. u16 active; /* t2 or tD */
  1220. u16 recover; /* t2i or tK */
  1221. u16 cycle; /* t0 */
  1222. u16 udma; /* t2CYCTYP/2 */
  1223. };
  1224. enum {
  1225. IDE_TIMING_SETUP = (1 << 0),
  1226. IDE_TIMING_ACT8B = (1 << 1),
  1227. IDE_TIMING_REC8B = (1 << 2),
  1228. IDE_TIMING_CYC8B = (1 << 3),
  1229. IDE_TIMING_8BIT = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
  1230. IDE_TIMING_CYC8B,
  1231. IDE_TIMING_ACTIVE = (1 << 4),
  1232. IDE_TIMING_RECOVER = (1 << 5),
  1233. IDE_TIMING_CYCLE = (1 << 6),
  1234. IDE_TIMING_UDMA = (1 << 7),
  1235. IDE_TIMING_ALL = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
  1236. IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
  1237. IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
  1238. };
  1239. struct ide_timing *ide_timing_find_mode(u8);
  1240. u16 ide_pio_cycle_time(ide_drive_t *, u8);
  1241. void ide_timing_merge(struct ide_timing *, struct ide_timing *,
  1242. struct ide_timing *, unsigned int);
  1243. int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
  1244. #ifdef CONFIG_IDE_XFER_MODE
  1245. int ide_scan_pio_blacklist(char *);
  1246. const char *ide_xfer_verbose(u8);
  1247. u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
  1248. int ide_set_pio_mode(ide_drive_t *, u8);
  1249. int ide_set_dma_mode(ide_drive_t *, u8);
  1250. void ide_set_pio(ide_drive_t *, u8);
  1251. int ide_set_xfer_rate(ide_drive_t *, u8);
  1252. #else
  1253. static inline void ide_set_pio(ide_drive_t *drive, u8 pio) { ; }
  1254. static inline int ide_set_xfer_rate(ide_drive_t *drive, u8 rate) { return -1; }
  1255. #endif
  1256. static inline void ide_set_max_pio(ide_drive_t *drive)
  1257. {
  1258. ide_set_pio(drive, 255);
  1259. }
  1260. char *ide_media_string(ide_drive_t *);
  1261. extern struct device_attribute ide_dev_attrs[];
  1262. extern struct bus_type ide_bus_type;
  1263. extern struct class *ide_port_class;
  1264. static inline void ide_dump_identify(u8 *id)
  1265. {
  1266. print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
  1267. }
  1268. static inline int hwif_to_node(ide_hwif_t *hwif)
  1269. {
  1270. return hwif->dev ? dev_to_node(hwif->dev) : -1;
  1271. }
  1272. static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
  1273. {
  1274. ide_drive_t *peer = drive->hwif->devices[(drive->dn ^ 1) & 1];
  1275. return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
  1276. }
  1277. #define ide_port_for_each_dev(i, dev, port) \
  1278. for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++)
  1279. #define ide_port_for_each_present_dev(i, dev, port) \
  1280. for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++) \
  1281. if ((dev)->dev_flags & IDE_DFLAG_PRESENT)
  1282. #define ide_host_for_each_port(i, port, host) \
  1283. for ((i) = 0; ((port) = (host)->ports[i]) || (i) < MAX_HOST_PORTS; (i)++)
  1284. #endif /* _IDE_H */