1/* 2 * 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 * 26 */ 27 28#ifndef __LIBATA_H__ 29#define __LIBATA_H__ 30 31#define DRV_NAME "libata" 32#define DRV_VERSION "3.00" /* must be exactly four chars */ 33 34struct ata_scsi_args { 35 struct ata_device *dev; 36 u16 *id; 37 struct scsi_cmnd *cmd; 38 void (*done)(struct scsi_cmnd *); 39}; 40 41/* libata-core.c */ 42enum { 43 /* flags for ata_dev_read_id() */ 44 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */ 45 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 */ 52 53 ATA_DNXFER_QUIET = (1 << 31), 54}; 55 56extern unsigned int ata_print_id; 57extern int atapi_passthru16; 58extern int libata_fua; 59extern int libata_noacpi; 60extern int libata_allow_tpm; 61extern struct ata_link *ata_dev_phys_link(struct ata_device *dev); 62extern void ata_force_cbl(struct ata_port *ap); 63extern u64 ata_tf_to_lba(const struct ata_taskfile *tf); 64extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf); 65extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev); 66extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev, 67 u64 block, u32 n_block, unsigned int tf_flags, 68 unsigned int tag); 69extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev); 70extern unsigned ata_exec_internal(struct ata_device *dev, 71 struct ata_taskfile *tf, const u8 *cdb, 72 int dma_dir, void *buf, unsigned int buflen, 73 unsigned long timeout); 74extern unsigned ata_exec_internal_sg(struct ata_device *dev, 75 struct ata_taskfile *tf, const u8 *cdb, 76 int dma_dir, struct scatterlist *sg, 77 unsigned int n_elem, unsigned long timeout); 78extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd); 79extern int ata_wait_ready(struct ata_link *link, unsigned long deadline, 80 int (*check_ready)(struct ata_link *link)); 81extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class, 82 unsigned int flags, u16 *id); 83extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags); 84extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class, 85 unsigned int readid_flags); 86extern int ata_dev_configure(struct ata_device *dev); 87extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit); 88extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel); 89extern void ata_sg_clean(struct ata_queued_cmd *qc); 90extern void ata_qc_free(struct ata_queued_cmd *qc); 91extern void ata_qc_issue(struct ata_queued_cmd *qc); 92extern void __ata_qc_complete(struct ata_queued_cmd *qc); 93extern int atapi_check_dma(struct ata_queued_cmd *qc); 94extern void swap_buf_le16(u16 *buf, unsigned int buf_words); 95extern bool ata_phys_link_online(struct ata_link *link); 96extern bool ata_phys_link_offline(struct ata_link *link); 97extern void ata_dev_init(struct ata_device *dev); 98extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp); 99extern int sata_link_init_spd(struct ata_link *link); 100extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg); 101extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg); 102extern struct ata_port *ata_port_alloc(struct ata_host *host); 103extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy); 104extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm); 105 106/* libata-acpi.c */ 107#ifdef CONFIG_ATA_ACPI 108extern unsigned int ata_acpi_gtf_filter; 109 110extern void ata_acpi_associate_sata_port(struct ata_port *ap); 111extern void ata_acpi_associate(struct ata_host *host); 112extern void ata_acpi_dissociate(struct ata_host *host); 113extern int ata_acpi_on_suspend(struct ata_port *ap); 114extern void ata_acpi_on_resume(struct ata_port *ap); 115extern int ata_acpi_on_devcfg(struct ata_device *dev); 116extern void ata_acpi_on_disable(struct ata_device *dev); 117extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state); 118#else 119static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { } 120static inline void ata_acpi_associate(struct ata_host *host) { } 121static inline void ata_acpi_dissociate(struct ata_host *host) { } 122static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; } 123static inline void ata_acpi_on_resume(struct ata_port *ap) { } 124static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; } 125static inline void ata_acpi_on_disable(struct ata_device *dev) { } 126static inline void ata_acpi_set_state(struct ata_port *ap, 127 pm_message_t state) { } 128#endif 129 130/* libata-scsi.c */ 131extern int ata_scsi_add_hosts(struct ata_host *host, 132 struct scsi_host_template *sht); 133extern void ata_scsi_scan_host(struct ata_port *ap, int sync); 134extern int ata_scsi_offline_dev(struct ata_device *dev); 135extern void ata_scsi_media_change_notify(struct ata_device *dev); 136extern void ata_scsi_hotplug(struct work_struct *work); 137extern void ata_schedule_scsi_eh(struct Scsi_Host *shost); 138extern void ata_scsi_dev_rescan(struct work_struct *work); 139extern int ata_bus_probe(struct ata_port *ap); 140 141/* libata-eh.c */ 142extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd); 143extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd); 144extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd); 145extern void ata_scsi_error(struct Scsi_Host *host); 146extern void ata_port_wait_eh(struct ata_port *ap); 147extern void ata_eh_fastdrain_timerfn(unsigned long arg); 148extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc); 149extern void ata_dev_disable(struct ata_device *dev); 150extern void ata_eh_detach_dev(struct ata_device *dev); 151extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev, 152 unsigned int action); 153extern void ata_eh_done(struct ata_link *link, struct ata_device *dev, 154 unsigned int action); 155extern void ata_eh_autopsy(struct ata_port *ap); 156const char *ata_get_cmd_descript(u8 command); 157extern void ata_eh_report(struct ata_port *ap); 158extern int ata_eh_reset(struct ata_link *link, int classify, 159 ata_prereset_fn_t prereset, ata_reset_fn_t softreset, 160 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset); 161extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); 162extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset, 163 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 164 ata_postreset_fn_t postreset, 165 struct ata_link **r_failed_disk); 166extern void ata_eh_finish(struct ata_port *ap); 167 168/* libata-pmp.c */ 169#ifdef CONFIG_SATA_PMP 170extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val); 171extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val); 172extern int sata_pmp_attach(struct ata_device *dev); 173#else /* CONFIG_SATA_PMP */ 174static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val) 175{ 176 return -EINVAL; 177} 178 179static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val) 180{ 181 return -EINVAL; 182} 183 184static inline int sata_pmp_attach(struct ata_device *dev) 185{ 186 return -EINVAL; 187} 188#endif /* CONFIG_SATA_PMP */ 189 190/* libata-sff.c */ 191#ifdef CONFIG_ATA_SFF 192extern void ata_sff_flush_pio_task(struct ata_port *ap); 193extern void ata_sff_port_init(struct ata_port *ap); 194extern int ata_sff_init(void); 195extern void ata_sff_exit(void); 196#else /* CONFIG_ATA_SFF */ 197static inline void ata_sff_flush_pio_task(struct ata_port *ap) 198{ } 199static inline void ata_sff_port_init(struct ata_port *ap) 200{ } 201static inline int ata_sff_init(void) 202{ return 0; } 203static inline void ata_sff_exit(void) 204{ } 205#endif /* CONFIG_ATA_SFF */ 206 207#endif /* __LIBATA_H__ */ 208