LXR linux/drivers/ata/libata.h

   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/driver-api/libata.rst
  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
  34/* libata-core.c */
  35enum {
  36        /* flags for ata_dev_read_id() */
  37        ATA_READID_POSTRESET    = (1 << 0), /* reading ID after reset */
  38
  39        /* selector for ata_down_xfermask_limit() */
  40        ATA_DNXFER_PIO          = 0,    /* speed down PIO */
  41        ATA_DNXFER_DMA          = 1,    /* speed down DMA */
  42        ATA_DNXFER_40C          = 2,    /* apply 40c cable limit */
  43        ATA_DNXFER_FORCE_PIO    = 3,    /* force PIO */
  44        ATA_DNXFER_FORCE_PIO0   = 4,    /* force PIO0 */
  45
  46        ATA_DNXFER_QUIET        = (1 << 31),
  47};
  48
  49extern atomic_t ata_print_id;
  50extern int atapi_passthru16;
  51extern int libata_fua;
  52extern int libata_noacpi;
  53extern int libata_allow_tpm;
  54extern const struct device_type ata_port_type;
  55extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
  56extern void ata_force_cbl(struct ata_port *ap);
  57extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
  58extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
  59extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
  60extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
  61                           u64 block, u32 n_block, unsigned int tf_flags,
  62                           unsigned int tag, int class);
  63extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
  64                             struct ata_device *dev);
  65extern unsigned ata_exec_internal(struct ata_device *dev,
  66                                  struct ata_taskfile *tf, const u8 *cdb,
  67                                  int dma_dir, void *buf, unsigned int buflen,
  68                                  unsigned long timeout);
  69extern unsigned ata_exec_internal_sg(struct ata_device *dev,
  70                                     struct ata_taskfile *tf, const u8 *cdb,
  71                                     int dma_dir, struct scatterlist *sg,
  72                                     unsigned int n_elem, unsigned long timeout);
  73extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
  74                          int (*check_ready)(struct ata_link *link));
  75extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
  76                           unsigned int flags, u16 *id);
  77extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
  78extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
  79                              unsigned int readid_flags);
  80extern int ata_dev_configure(struct ata_device *dev);
  81extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
  82extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
  83extern unsigned int ata_dev_set_feature(struct ata_device *dev,
  84                                        u8 enable, u8 feature);
  85extern void ata_qc_free(struct ata_queued_cmd *qc);
  86extern void ata_qc_issue(struct ata_queued_cmd *qc);
  87extern void __ata_qc_complete(struct ata_queued_cmd *qc);
  88extern int atapi_check_dma(struct ata_queued_cmd *qc);
  89extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
  90extern bool ata_phys_link_online(struct ata_link *link);
  91extern bool ata_phys_link_offline(struct ata_link *link);
  92extern void ata_dev_init(struct ata_device *dev);
  93extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
  94extern int sata_link_init_spd(struct ata_link *link);
  95extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
  96extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
  97extern struct ata_port *ata_port_alloc(struct ata_host *host);
  98extern const char *sata_spd_string(unsigned int spd);
  99extern int ata_port_probe(struct ata_port *ap);
 100extern void __ata_port_probe(struct ata_port *ap);
 101extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
 102                                      u8 page, void *buf, unsigned int sectors);
 103
 104#define to_ata_port(d) container_of(d, struct ata_port, tdev)
 105
 106/* libata-acpi.c */
 107#ifdef CONFIG_ATA_ACPI
 108extern unsigned int ata_acpi_gtf_filter;
 109extern void ata_acpi_dissociate(struct ata_host *host);
 110extern int ata_acpi_on_suspend(struct ata_port *ap);
 111extern void ata_acpi_on_resume(struct ata_port *ap);
 112extern int ata_acpi_on_devcfg(struct ata_device *dev);
 113extern void ata_acpi_on_disable(struct ata_device *dev);
 114extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
 115extern void ata_acpi_bind_port(struct ata_port *ap);
 116extern void ata_acpi_bind_dev(struct ata_device *dev);
 117extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
 118#else
 119static inline void ata_acpi_dissociate(struct ata_host *host) { }
 120static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
 121static inline void ata_acpi_on_resume(struct ata_port *ap) { }
 122static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
 123static inline void ata_acpi_on_disable(struct ata_device *dev) { }
 124static inline void ata_acpi_set_state(struct ata_port *ap,
 125                                      pm_message_t state) { }
 126static inline void ata_acpi_bind_port(struct ata_port *ap) {}
 127static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
 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_set_sense(struct ata_device *dev,
 136                               struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
 137extern void ata_scsi_set_sense_information(struct ata_device *dev,
 138                                           struct scsi_cmnd *cmd,
 139                                           const struct ata_taskfile *tf);
 140extern void ata_scsi_media_change_notify(struct ata_device *dev);
 141extern void ata_scsi_hotplug(struct work_struct *work);
 142extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
 143extern void ata_scsi_dev_rescan(struct work_struct *work);
 144extern int ata_bus_probe(struct ata_port *ap);
 145extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
 146                              unsigned int id, u64 lun);
 147int ata_sas_allocate_tag(struct ata_port *ap);
 148void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
 149
 150
 151/* libata-eh.c */
 152extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
 153extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
 154extern void ata_eh_acquire(struct ata_port *ap);
 155extern void ata_eh_release(struct ata_port *ap);
 156extern void ata_scsi_error(struct Scsi_Host *host);
 157extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
 158extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
 159extern void ata_dev_disable(struct ata_device *dev);
 160extern void ata_eh_detach_dev(struct ata_device *dev);
 161extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
 162                               unsigned int action);
 163extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
 164                        unsigned int action);
 165extern void ata_eh_autopsy(struct ata_port *ap);
 166const char *ata_get_cmd_descript(u8 command);
 167extern void ata_eh_report(struct ata_port *ap);
 168extern int ata_eh_reset(struct ata_link *link, int classify,
 169                        ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
 170                        ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
 171extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
 172extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
 173                          ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 174                          ata_postreset_fn_t postreset,
 175                          struct ata_link **r_failed_disk);
 176extern void ata_eh_finish(struct ata_port *ap);
 177extern int ata_ering_map(struct ata_ering *ering,
 178                         int (*map_fn)(struct ata_ering_entry *, void *),
 179                         void *arg);
 180extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
 181extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
 182                                           u8 *sense_buf, u8 dfl_sense_key);
 183
 184/* libata-pmp.c */
 185#ifdef CONFIG_SATA_PMP
 186extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
 187extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
 188extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
 189                            unsigned hints);
 190extern int sata_pmp_attach(struct ata_device *dev);
 191#else /* CONFIG_SATA_PMP */
 192static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
 193{
 194        return -EINVAL;
 195}
 196
 197static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
 198{
 199        return -EINVAL;
 200}
 201
 202static inline int sata_pmp_set_lpm(struct ata_link *link,
 203                                   enum ata_lpm_policy policy, unsigned hints)
 204{
 205        return -EINVAL;
 206}
 207
 208static inline int sata_pmp_attach(struct ata_device *dev)
 209{
 210        return -EINVAL;
 211}
 212#endif /* CONFIG_SATA_PMP */
 213
 214/* libata-sff.c */
 215#ifdef CONFIG_ATA_SFF
 216extern void ata_sff_flush_pio_task(struct ata_port *ap);
 217extern void ata_sff_port_init(struct ata_port *ap);
 218extern int ata_sff_init(void);
 219extern void ata_sff_exit(void);
 220#else /* CONFIG_ATA_SFF */
 221static inline void ata_sff_flush_pio_task(struct ata_port *ap)
 222{ }
 223static inline void ata_sff_port_init(struct ata_port *ap)
 224{ }
 225static inline int ata_sff_init(void)
 226{ return 0; }
 227static inline void ata_sff_exit(void)
 228{ }
 229#endif /* CONFIG_ATA_SFF */
 230
 231/* libata-zpodd.c */
 232#ifdef CONFIG_SATA_ZPODD
 233void zpodd_init(struct ata_device *dev);
 234void zpodd_exit(struct ata_device *dev);
 235static inline bool zpodd_dev_enabled(struct ata_device *dev)
 236{
 237        return dev->zpodd != NULL;
 238}
 239void zpodd_on_suspend(struct ata_device *dev);
 240bool zpodd_zpready(struct ata_device *dev);
 241void zpodd_enable_run_wake(struct ata_device *dev);
 242void zpodd_disable_run_wake(struct ata_device *dev);
 243void zpodd_post_poweron(struct ata_device *dev);
 244#else /* CONFIG_SATA_ZPODD */
 245static inline void zpodd_init(struct ata_device *dev) {}
 246static inline void zpodd_exit(struct ata_device *dev) {}
 247static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
 248static inline void zpodd_on_suspend(struct ata_device *dev) {}
 249static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
 250static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
 251static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
 252static inline void zpodd_post_poweron(struct ata_device *dev) {}
 253#endif /* CONFIG_SATA_ZPODD */
 254
 255#endif /* __LIBATA_H__ */
 256