libata.h revision f0761be344f9b1cc4284b1d945933cd983c233a4
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 41static inline int ata_is_builtin_hardreset(ata_reset_fn_t reset) 42{ 43 if (reset == sata_std_hardreset) 44 return 1; 45#ifdef CONFIG_ATA_SFF 46 if (reset == sata_sff_hardreset) 47 return 1; 48#endif 49 return 0; 50} 51 52/* libata-core.c */ 53enum { 54 /* flags for ata_dev_read_id() */ 55 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */ 56 57 /* selector for ata_down_xfermask_limit() */ 58 ATA_DNXFER_PIO = 0, /* speed down PIO */ 59 ATA_DNXFER_DMA = 1, /* speed down DMA */ 60 ATA_DNXFER_40C = 2, /* apply 40c cable limit */ 61 ATA_DNXFER_FORCE_PIO = 3, /* force PIO */ 62 ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */ 63 64 ATA_DNXFER_QUIET = (1 << 31), 65}; 66 67extern unsigned int ata_print_id; 68extern struct workqueue_struct *ata_aux_wq; 69extern int atapi_enabled; 70extern int atapi_passthru16; 71extern int libata_fua; 72extern int libata_noacpi; 73extern int libata_allow_tpm; 74extern void ata_force_cbl(struct ata_port *ap); 75extern u64 ata_tf_to_lba(const struct ata_taskfile *tf); 76extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf); 77extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev); 78extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev, 79 u64 block, u32 n_block, unsigned int tf_flags, 80 unsigned int tag); 81extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev); 82extern void ata_dev_disable(struct ata_device *dev); 83extern void ata_pio_queue_task(struct ata_port *ap, void *data, 84 unsigned long delay); 85extern void ata_port_flush_task(struct ata_port *ap); 86extern unsigned ata_exec_internal(struct ata_device *dev, 87 struct ata_taskfile *tf, const u8 *cdb, 88 int dma_dir, void *buf, unsigned int buflen, 89 unsigned long timeout); 90extern unsigned ata_exec_internal_sg(struct ata_device *dev, 91 struct ata_taskfile *tf, const u8 *cdb, 92 int dma_dir, struct scatterlist *sg, 93 unsigned int n_elem, unsigned long timeout); 94extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd); 95extern int ata_wait_ready(struct ata_link *link, unsigned long deadline, 96 int (*check_ready)(struct ata_link *link)); 97extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class, 98 unsigned int flags, u16 *id); 99extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags); 100extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class, 101 unsigned int readid_flags); 102extern int ata_dev_configure(struct ata_device *dev); 103extern int sata_down_spd_limit(struct ata_link *link); 104extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel); 105extern void ata_sg_clean(struct ata_queued_cmd *qc); 106extern void ata_qc_free(struct ata_queued_cmd *qc); 107extern void ata_qc_issue(struct ata_queued_cmd *qc); 108extern void __ata_qc_complete(struct ata_queued_cmd *qc); 109extern int ata_check_atapi_dma(struct ata_queued_cmd *qc); 110extern void swap_buf_le16(u16 *buf, unsigned int buf_words); 111extern void ata_dev_init(struct ata_device *dev); 112extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp); 113extern int sata_link_init_spd(struct ata_link *link); 114extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg); 115extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg); 116extern struct ata_port *ata_port_alloc(struct ata_host *host); 117extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy); 118extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm); 119 120/* libata-acpi.c */ 121#ifdef CONFIG_ATA_ACPI 122extern void ata_acpi_associate_sata_port(struct ata_port *ap); 123extern void ata_acpi_associate(struct ata_host *host); 124extern void ata_acpi_dissociate(struct ata_host *host); 125extern int ata_acpi_on_suspend(struct ata_port *ap); 126extern void ata_acpi_on_resume(struct ata_port *ap); 127extern int ata_acpi_on_devcfg(struct ata_device *dev); 128extern void ata_acpi_on_disable(struct ata_device *dev); 129extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state); 130#else 131static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { } 132static inline void ata_acpi_associate(struct ata_host *host) { } 133static inline void ata_acpi_dissociate(struct ata_host *host) { } 134static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; } 135static inline void ata_acpi_on_resume(struct ata_port *ap) { } 136static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; } 137static inline void ata_acpi_on_disable(struct ata_device *dev) { } 138static inline void ata_acpi_set_state(struct ata_port *ap, 139 pm_message_t state) { } 140#endif 141 142/* libata-scsi.c */ 143extern int ata_scsi_add_hosts(struct ata_host *host, 144 struct scsi_host_template *sht); 145extern void ata_scsi_scan_host(struct ata_port *ap, int sync); 146extern int ata_scsi_offline_dev(struct ata_device *dev); 147extern void ata_scsi_media_change_notify(struct ata_device *dev); 148extern void ata_scsi_hotplug(struct work_struct *work); 149extern void ata_schedule_scsi_eh(struct Scsi_Host *shost); 150extern void ata_scsi_dev_rescan(struct work_struct *work); 151extern int ata_bus_probe(struct ata_port *ap); 152 153/* libata-eh.c */ 154extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd); 155extern void ata_scsi_error(struct Scsi_Host *host); 156extern void ata_port_wait_eh(struct ata_port *ap); 157extern void ata_eh_fastdrain_timerfn(unsigned long arg); 158extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc); 159extern void ata_eh_detach_dev(struct ata_device *dev); 160extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev, 161 unsigned int action); 162extern void ata_eh_done(struct ata_link *link, struct ata_device *dev, 163 unsigned int action); 164extern void ata_eh_autopsy(struct ata_port *ap); 165extern void ata_eh_report(struct ata_port *ap); 166extern int ata_eh_reset(struct ata_link *link, int classify, 167 ata_prereset_fn_t prereset, ata_reset_fn_t softreset, 168 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset); 169extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); 170extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset, 171 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 172 ata_postreset_fn_t postreset, 173 struct ata_link **r_failed_disk); 174extern void ata_eh_finish(struct ata_port *ap); 175 176/* libata-pmp.c */ 177#ifdef CONFIG_SATA_PMP 178extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val); 179extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val); 180extern int sata_pmp_attach(struct ata_device *dev); 181#else /* CONFIG_SATA_PMP */ 182static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val) 183{ 184 return -EINVAL; 185} 186 187static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val) 188{ 189 return -EINVAL; 190} 191 192static inline int sata_pmp_attach(struct ata_device *dev) 193{ 194 return -EINVAL; 195} 196#endif /* CONFIG_SATA_PMP */ 197 198/* libata-sff.c */ 199#ifdef CONFIG_ATA_SFF 200extern void ata_dev_select(struct ata_port *ap, unsigned int device, 201 unsigned int wait, unsigned int can_sleep); 202extern u8 ata_irq_on(struct ata_port *ap); 203extern void ata_pio_task(struct work_struct *work); 204#endif /* CONFIG_ATA_SFF */ 205 206#endif /* __LIBATA_H__ */ 207