linux/drivers/ata/libata.h
<<
>>
Prefs
   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_passthru16;
  70extern int libata_fua;
  71extern int libata_noacpi;
  72extern int libata_allow_tpm;
  73extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
  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_port_flush_task(struct ata_port *ap);
  83extern unsigned ata_exec_internal(struct ata_device *dev,
  84                                  struct ata_taskfile *tf, const u8 *cdb,
  85                                  int dma_dir, void *buf, unsigned int buflen,
  86                                  unsigned long timeout);
  87extern unsigned ata_exec_internal_sg(struct ata_device *dev,
  88                                     struct ata_taskfile *tf, const u8 *cdb,
  89                                     int dma_dir, struct scatterlist *sg,
  90                                     unsigned int n_elem, unsigned long timeout);
  91extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
  92extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
  93                          int (*check_ready)(struct ata_link *link));
  94extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
  95                           unsigned int flags, u16 *id);
  96extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
  97extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
  98                              unsigned int readid_flags);
  99extern int ata_dev_configure(struct ata_device *dev);
 100extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
 101extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
 102extern void ata_sg_clean(struct ata_queued_cmd *qc);
 103extern void ata_qc_free(struct ata_queued_cmd *qc);
 104extern void ata_qc_issue(struct ata_queued_cmd *qc);
 105extern void __ata_qc_complete(struct ata_queued_cmd *qc);
 106extern int atapi_check_dma(struct ata_queued_cmd *qc);
 107extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
 108extern bool ata_phys_link_online(struct ata_link *link);
 109extern bool ata_phys_link_offline(struct ata_link *link);
 110extern void ata_dev_init(struct ata_device *dev);
 111extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
 112extern int sata_link_init_spd(struct ata_link *link);
 113extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
 114extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
 115extern struct ata_port *ata_port_alloc(struct ata_host *host);
 116extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
 117extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
 118
 119/* libata-acpi.c */
 120#ifdef CONFIG_ATA_ACPI
 121extern unsigned int ata_acpi_gtf_filter;
 122
 123extern void ata_acpi_associate_sata_port(struct ata_port *ap);
 124extern void ata_acpi_associate(struct ata_host *host);
 125extern void ata_acpi_dissociate(struct ata_host *host);
 126extern int ata_acpi_on_suspend(struct ata_port *ap);
 127extern void ata_acpi_on_resume(struct ata_port *ap);
 128extern int ata_acpi_on_devcfg(struct ata_device *dev);
 129extern void ata_acpi_on_disable(struct ata_device *dev);
 130extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
 131#else
 132static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
 133static inline void ata_acpi_associate(struct ata_host *host) { }
 134static inline void ata_acpi_dissociate(struct ata_host *host) { }
 135static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
 136static inline void ata_acpi_on_resume(struct ata_port *ap) { }
 137static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
 138static inline void ata_acpi_on_disable(struct ata_device *dev) { }
 139static inline void ata_acpi_set_state(struct ata_port *ap,
 140                                      pm_message_t state) { }
 141#endif
 142
 143/* libata-scsi.c */
 144extern int ata_scsi_add_hosts(struct ata_host *host,
 145                              struct scsi_host_template *sht);
 146extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
 147extern int ata_scsi_offline_dev(struct ata_device *dev);
 148extern void ata_scsi_media_change_notify(struct ata_device *dev);
 149extern void ata_scsi_hotplug(struct work_struct *work);
 150extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
 151extern void ata_scsi_dev_rescan(struct work_struct *work);
 152extern int ata_bus_probe(struct ata_port *ap);
 153
 154/* libata-eh.c */
 155extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
 156extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
 157extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
 158extern void ata_scsi_error(struct Scsi_Host *host);
 159extern void ata_port_wait_eh(struct ata_port *ap);
 160extern void ata_eh_fastdrain_timerfn(unsigned long arg);
 161extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
 162extern void ata_dev_disable(struct ata_device *dev);
 163extern void ata_eh_detach_dev(struct ata_device *dev);
 164extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
 165                               unsigned int action);
 166extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
 167                        unsigned int action);
 168extern void ata_eh_autopsy(struct ata_port *ap);
 169const char *ata_get_cmd_descript(u8 command);
 170extern void ata_eh_report(struct ata_port *ap);
 171extern int ata_eh_reset(struct ata_link *link, int classify,
 172                        ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
 173                        ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
 174extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
 175extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
 176                          ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 177                          ata_postreset_fn_t postreset,
 178                          struct ata_link **r_failed_disk);
 179extern void ata_eh_finish(struct ata_port *ap);
 180
 181/* libata-pmp.c */
 182#ifdef CONFIG_SATA_PMP
 183extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
 184extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
 185extern int sata_pmp_attach(struct ata_device *dev);
 186#else /* CONFIG_SATA_PMP */
 187static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
 188{
 189        return -EINVAL;
 190}
 191
 192static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
 193{
 194        return -EINVAL;
 195}
 196
 197static inline int sata_pmp_attach(struct ata_device *dev)
 198{
 199        return -EINVAL;
 200}
 201#endif /* CONFIG_SATA_PMP */
 202
 203/* libata-sff.c */
 204#ifdef CONFIG_ATA_SFF
 205extern void ata_dev_select(struct ata_port *ap, unsigned int device,
 206                           unsigned int wait, unsigned int can_sleep);
 207extern u8 ata_irq_on(struct ata_port *ap);
 208extern void ata_pio_task(struct work_struct *work);
 209#endif /* CONFIG_ATA_SFF */
 210
 211#endif /* __LIBATA_H__ */
 212