blob: a998a175f9f144b50e4df782bbf7d1afd5f506cb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * libata.h - helper library for ATA
3 *
4 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
5 * Copyright 2003-2004 Jeff Garzik
6 *
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
11 * any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; see the file COPYING. If not, write to
20 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 *
23 * libata documentation is available via 'make {ps|pdf}docs',
24 * as Documentation/DocBook/libata.*
25 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 */
27
28#ifndef __LIBATA_H__
29#define __LIBATA_H__
30
31#define DRV_NAME "libata"
Tejun Heo633273a32007-09-23 13:19:54 +090032#define DRV_VERSION "3.00" /* must be exactly four chars */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34struct ata_scsi_args {
Tejun Heo9a3dccc2006-01-06 09:56:18 +010035 struct ata_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 u16 *id;
37 struct scsi_cmnd *cmd;
38 void (*done)(struct scsi_cmnd *);
39};
40
41/* libata-core.c */
Tejun Heobff04642006-11-10 18:08:10 +090042enum {
43 /* flags for ata_dev_read_id() */
44 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
Tejun Heo458337d2007-02-02 16:22:30 +090045
46 /* selector for ata_down_xfermask_limit() */
47 ATA_DNXFER_PIO = 0, /* speed down PIO */
48 ATA_DNXFER_DMA = 1, /* speed down DMA */
49 ATA_DNXFER_40C = 2, /* apply 40c cable limit */
50 ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
51 ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
Tejun Heo458337d2007-02-02 16:22:30 +090052
53 ATA_DNXFER_QUIET = (1 << 31),
Tejun Heobff04642006-11-10 18:08:10 +090054};
55
Dan Williams85d67252012-03-10 23:28:46 -080056extern atomic_t ata_print_id;
Mark Lordbaf4fdf2007-08-08 01:08:45 +090057extern int atapi_passthru16;
Jeff Garzikc3c013a2006-02-27 22:31:19 -050058extern int libata_fua;
Jeff Garzikd7d0dad2007-03-28 01:57:37 -040059extern int libata_noacpi;
Alan Coxae8d4ee2007-11-04 22:05:49 -050060extern int libata_allow_tpm;
Lin Ming5ef41082011-12-05 09:20:27 +080061extern struct device_type ata_port_type;
Tejun Heob1c72912008-07-31 17:02:43 +090062extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
Tejun Heo33267322008-02-13 09:15:09 +090063extern void ata_force_cbl(struct ata_port *ap);
Tejun Heoa5987e02008-03-27 19:14:23 +090064extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
65extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
Shaohua Li12cb5ce2015-01-15 17:32:27 -080066extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
Tejun Heobd056d72006-11-14 22:47:10 +090067extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
68 u64 block, u32 n_block, unsigned int tf_flags,
69 unsigned int tag);
Hannes Reineckea1524f22015-03-27 16:46:37 +010070extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
71 struct ata_device *dev);
Tejun Heo3373efd2006-05-15 20:57:53 +090072extern unsigned ata_exec_internal(struct ata_device *dev,
Tejun Heo1ad8e7f2006-04-02 18:51:53 +090073 struct ata_taskfile *tf, const u8 *cdb,
Tejun Heo2b789102007-10-09 15:05:44 +090074 int dma_dir, void *buf, unsigned int buflen,
75 unsigned long timeout);
Tejun Heo24326972006-11-14 22:47:09 +090076extern unsigned ata_exec_internal_sg(struct ata_device *dev,
77 struct ata_taskfile *tf, const u8 *cdb,
78 int dma_dir, struct scatterlist *sg,
Tejun Heo2b789102007-10-09 15:05:44 +090079 unsigned int n_elem, unsigned long timeout);
Tejun Heoaa2731a2008-04-07 22:47:19 +090080extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
81 int (*check_ready)(struct ata_link *link));
Tejun Heoa9beec92006-05-31 18:27:44 +090082extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
Tejun Heobff04642006-11-10 18:08:10 +090083 unsigned int flags, u16 *id);
Tejun Heofe309112007-05-15 03:28:15 +090084extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
Tejun Heo422c9da2007-09-23 13:14:12 +090085extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
86 unsigned int readid_flags);
Tejun Heoefdaedc2006-11-01 18:38:52 +090087extern int ata_dev_configure(struct ata_device *dev);
Tejun Heoa07d4992009-01-29 20:31:33 +090088extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
Tejun Heo458337d2007-02-02 16:22:30 +090089extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
Tejun Heo1152b262010-09-01 17:50:05 +020090extern unsigned int ata_dev_set_feature(struct ata_device *dev,
91 u8 enable, u8 feature);
Tejun Heo70e6ad02006-11-14 22:47:10 +090092extern void ata_sg_clean(struct ata_queued_cmd *qc);
Tejun Heo8a8bc222008-11-10 14:48:21 +090093extern void ata_qc_free(struct ata_queued_cmd *qc);
Tejun Heo8e0e6942006-03-31 20:41:11 +090094extern void ata_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof686bcb2006-05-15 20:58:05 +090095extern void __ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo5895ef92008-06-17 12:36:26 +090096extern int atapi_check_dma(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
Tejun Heob1c72912008-07-31 17:02:43 +090098extern bool ata_phys_link_online(struct ata_link *link);
99extern bool ata_phys_link_offline(struct ata_link *link);
Tejun Heo3ef3b432006-05-31 18:27:30 +0900100extern void ata_dev_init(struct ata_device *dev);
Tejun Heofb7fd612007-09-23 13:14:12 +0900101extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
102extern int sata_link_init_spd(struct ata_link *link);
Jeff Garzikb0955182005-05-12 15:45:22 -0400103extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
104extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
Tejun Heof3187192007-04-17 23:44:07 +0900105extern struct ata_port *ata_port_alloc(struct ata_host *host);
Gwendal Grignoud9027472010-05-25 12:31:38 -0700106extern const char *sata_spd_string(unsigned int spd);
James Bottomley238c9cf2011-01-23 08:28:33 -0600107extern int ata_port_probe(struct ata_port *ap);
Dan Williams9508a662012-01-18 20:47:01 -0800108extern void __ata_port_probe(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Matthew Garrett6b66d952012-06-25 16:13:03 +0800110#define to_ata_port(d) container_of(d, struct ata_port, tdev)
111
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700112/* libata-acpi.c */
Tejun Heoe92351b2007-05-05 23:50:38 +0900113#ifdef CONFIG_ATA_ACPI
Tejun Heo110f66d2009-09-16 04:17:28 +0900114extern unsigned int ata_acpi_gtf_filter;
Tejun Heo562f0c22007-12-15 15:05:01 +0900115extern void ata_acpi_dissociate(struct ata_host *host);
Tejun Heo64578a32007-05-15 03:28:16 +0900116extern int ata_acpi_on_suspend(struct ata_port *ap);
Tejun Heo67465442007-05-15 03:28:16 +0900117extern void ata_acpi_on_resume(struct ata_port *ap);
Tejun Heo562f0c22007-12-15 15:05:01 +0900118extern int ata_acpi_on_devcfg(struct ata_device *dev);
119extern void ata_acpi_on_disable(struct ata_device *dev);
Shaohua Libd3adca2007-11-02 09:32:38 +0800120extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
Aaron Luf1bc1e42013-08-23 10:17:54 +0800121extern void ata_acpi_bind_port(struct ata_port *ap);
122extern void ata_acpi_bind_dev(struct ata_device *dev);
123extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700124#else
Tejun Heo562f0c22007-12-15 15:05:01 +0900125static inline void ata_acpi_dissociate(struct ata_host *host) { }
Tejun Heo64578a32007-05-15 03:28:16 +0900126static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
Tejun Heo67465442007-05-15 03:28:16 +0900127static inline void ata_acpi_on_resume(struct ata_port *ap) { }
Tejun Heo562f0c22007-12-15 15:05:01 +0900128static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
129static inline void ata_acpi_on_disable(struct ata_device *dev) { }
Shaohua Libd3adca2007-11-02 09:32:38 +0800130static inline void ata_acpi_set_state(struct ata_port *ap,
131 pm_message_t state) { }
Aaron Luf1bc1e42013-08-23 10:17:54 +0800132static inline void ata_acpi_bind_port(struct ata_port *ap) {}
133static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700134#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/* libata-scsi.c */
Tejun Heof3187192007-04-17 23:44:07 +0900137extern int ata_scsi_add_hosts(struct ata_host *host,
138 struct scsi_host_template *sht);
Tejun Heo1ae46312007-07-16 14:29:40 +0900139extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
Tejun Heo0ea035a2006-05-31 18:28:01 +0900140extern int ata_scsi_offline_dev(struct ata_device *dev);
Hannes Reinecke42b966f2015-03-27 16:46:35 +0100141extern void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
Hannes Reineckea1524f22015-03-27 16:46:37 +0100142extern void ata_scsi_set_sense_information(struct scsi_cmnd *cmd,
143 const struct ata_taskfile *tf);
Tejun Heo7d77b242007-09-23 13:14:13 +0900144extern void ata_scsi_media_change_notify(struct ata_device *dev);
David Howells65f27f32006-11-22 14:55:48 +0000145extern void ata_scsi_hotplug(struct work_struct *work);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900146extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
David Howells65f27f32006-11-22 14:55:48 +0000147extern void ata_scsi_dev_rescan(struct work_struct *work);
Brian King80289162006-08-07 14:27:31 -0500148extern int ata_bus_probe(struct ata_port *ap);
Gwendal Grignoud9027472010-05-25 12:31:38 -0700149extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200150 unsigned int id, u64 lun);
Shaohua Li98bd4be2015-01-23 19:52:07 -0800151int ata_sas_allocate_tag(struct ata_port *ap);
152void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
Gwendal Grignoud9027472010-05-25 12:31:38 -0700153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Tejun Heoece1d632006-04-02 18:51:53 +0900155/* libata-eh.c */
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900156extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
157extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
Tejun Heoc0c362b2010-09-06 17:57:14 +0200158extern void ata_eh_acquire(struct ata_port *ap);
159extern void ata_eh_release(struct ata_port *ap);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700160extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
Jeff Garzik381544b2006-04-11 13:04:39 -0400161extern void ata_scsi_error(struct Scsi_Host *host);
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900162extern void ata_eh_fastdrain_timerfn(unsigned long arg);
Tejun Heof686bcb2006-05-15 20:58:05 +0900163extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
Tejun Heo678afac2009-01-29 20:31:30 +0900164extern void ata_dev_disable(struct ata_device *dev);
Tejun Heofb7fd612007-09-23 13:14:12 +0900165extern void ata_eh_detach_dev(struct ata_device *dev);
166extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
167 unsigned int action);
168extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
169 unsigned int action);
Shane Huang65fe1f02012-09-07 22:40:01 +0800170extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
171 u8 page, void *buf, unsigned int sectors);
Tejun Heofb7fd612007-09-23 13:14:12 +0900172extern void ata_eh_autopsy(struct ata_port *ap);
Robert Hancock65211482009-07-14 20:43:39 -0600173const char *ata_get_cmd_descript(u8 command);
Tejun Heofb7fd612007-09-23 13:14:12 +0900174extern void ata_eh_report(struct ata_port *ap);
175extern int ata_eh_reset(struct ata_link *link, int classify,
176 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
177 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
Tejun Heo6f1d1e32007-11-27 19:28:55 +0900178extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
Tejun Heofb7fd612007-09-23 13:14:12 +0900179extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
180 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
181 ata_postreset_fn_t postreset,
182 struct ata_link **r_failed_disk);
183extern void ata_eh_finish(struct ata_port *ap);
Gwendal Grignoud9027472010-05-25 12:31:38 -0700184extern int ata_ering_map(struct ata_ering *ering,
185 int (*map_fn)(struct ata_ering_entry *, void *),
186 void *arg);
Aaron Lu3dc67442013-01-15 17:21:00 +0800187extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
188extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
189 u8 *sense_buf, u8 dfl_sense_key);
Tejun Heoece1d632006-04-02 18:51:53 +0900190
Tejun Heo48515f62008-04-07 22:47:21 +0900191/* libata-pmp.c */
Tejun Heo88fcd562008-04-07 22:47:22 +0900192#ifdef CONFIG_SATA_PMP
Tejun Heo48515f62008-04-07 22:47:21 +0900193extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
194extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
Tejun Heo6c8ea892010-09-01 17:50:07 +0200195extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
196 unsigned hints);
Tejun Heo48515f62008-04-07 22:47:21 +0900197extern int sata_pmp_attach(struct ata_device *dev);
Tejun Heo88fcd562008-04-07 22:47:22 +0900198#else /* CONFIG_SATA_PMP */
199static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
200{
201 return -EINVAL;
202}
203
204static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
205{
206 return -EINVAL;
207}
208
Tejun Heo6c8ea892010-09-01 17:50:07 +0200209static inline int sata_pmp_set_lpm(struct ata_link *link,
210 enum ata_lpm_policy policy, unsigned hints)
211{
212 return -EINVAL;
213}
214
Tejun Heo88fcd562008-04-07 22:47:22 +0900215static inline int sata_pmp_attach(struct ata_device *dev)
216{
217 return -EINVAL;
218}
219#endif /* CONFIG_SATA_PMP */
Tejun Heo48515f62008-04-07 22:47:21 +0900220
Tejun Heo90088bb2006-10-09 11:10:26 +0900221/* libata-sff.c */
Tejun Heo127102a2008-04-07 22:47:21 +0900222#ifdef CONFIG_ATA_SFF
Tejun Heoc4291372010-05-10 21:41:38 +0200223extern void ata_sff_flush_pio_task(struct ata_port *ap);
Tejun Heo270390e2010-05-10 21:41:35 +0200224extern void ata_sff_port_init(struct ata_port *ap);
225extern int ata_sff_init(void);
226extern void ata_sff_exit(void);
227#else /* CONFIG_ATA_SFF */
Tejun Heoc4291372010-05-10 21:41:38 +0200228static inline void ata_sff_flush_pio_task(struct ata_port *ap)
229{ }
Tejun Heo270390e2010-05-10 21:41:35 +0200230static inline void ata_sff_port_init(struct ata_port *ap)
231{ }
232static inline int ata_sff_init(void)
233{ return 0; }
234static inline void ata_sff_exit(void)
235{ }
Tejun Heo127102a2008-04-07 22:47:21 +0900236#endif /* CONFIG_ATA_SFF */
Adrian Bunk77a527e2007-01-30 00:59:17 -0800237
Aaron Luafe75952013-01-15 17:20:58 +0800238/* libata-zpodd.c */
239#ifdef CONFIG_SATA_ZPODD
240void zpodd_init(struct ata_device *dev);
241void zpodd_exit(struct ata_device *dev);
242static inline bool zpodd_dev_enabled(struct ata_device *dev)
243{
244 return dev->zpodd != NULL;
245}
Aaron Lu3dc67442013-01-15 17:21:00 +0800246void zpodd_on_suspend(struct ata_device *dev);
Aaron Lu21334202013-01-15 17:21:01 +0800247bool zpodd_zpready(struct ata_device *dev);
248void zpodd_enable_run_wake(struct ata_device *dev);
249void zpodd_disable_run_wake(struct ata_device *dev);
250void zpodd_post_poweron(struct ata_device *dev);
Aaron Luafe75952013-01-15 17:20:58 +0800251#else /* CONFIG_SATA_ZPODD */
252static inline void zpodd_init(struct ata_device *dev) {}
253static inline void zpodd_exit(struct ata_device *dev) {}
254static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
Aaron Lu3dc67442013-01-15 17:21:00 +0800255static inline void zpodd_on_suspend(struct ata_device *dev) {}
Aaron Lu21334202013-01-15 17:21:01 +0800256static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
257static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
258static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
259static inline void zpodd_post_poweron(struct ata_device *dev) {}
Aaron Luafe75952013-01-15 17:20:58 +0800260#endif /* CONFIG_SATA_ZPODD */
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262#endif /* __LIBATA_H__ */