ide.h 46 KB

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