ide.h 45 KB

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