ide.h 45 KB

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