drivers/scsi/scsi_priv.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _SCSI_PRIV_H
   3 #define _SCSI_PRIV_H
   4
   5 #include <linux/device.h>
   6 #include <linux/async.h>
   7 #include <scsi/scsi_device.h>
   8 #include <linux/sbitmap.h>
   9
  10 struct request_queue;
  11 struct request;
  12 struct scsi_cmnd;
  13 struct scsi_device;
  14 struct scsi_target;
  15 struct scsi_host_template;
  16 struct Scsi_Host;
  17 struct scsi_nl_hdr;
  18
  19 #define SCSI_CMD_RETRIES_NO_LIMIT -1
  20
  21 /*
  22  * Scsi Error Handler Flags
  23  */
  24 #define SCSI_EH_ABORT_SCHEDULED 0x0002  /* Abort has been scheduled */
  25
  26 #define SCSI_SENSE_VALID(scmd) \
  27         (((scmd)->sense_buffer[0] & 0x70) == 0x70)
  28
  29 /* hosts.c */
  30 extern int scsi_init_hosts(void);
  31 extern void scsi_exit_hosts(void);
  32
  33 /* scsi.c */
  34 int scsi_init_sense_cache(struct Scsi_Host *shost);
  35 void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd);
  36 #ifdef CONFIG_SCSI_LOGGING
  37 void scsi_log_send(struct scsi_cmnd *cmd);
  38 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
  39 #else
  40 static inline void scsi_log_send(struct scsi_cmnd *cmd)
  41         { };
  42 static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
  43         { };
  44 #endif
  45
  46 /* scsi_devinfo.c */
  47
  48 /* list of keys for the lists */
  49 enum scsi_devinfo_key {
  50         SCSI_DEVINFO_GLOBAL = 0,
  51         SCSI_DEVINFO_SPI,
  52 };
  53
  54 extern blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
  55                                            const unsigned char *vendor,
  56                                            const unsigned char *model);
  57 extern blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
  58                                                  const unsigned char *vendor,
  59                                                  const unsigned char *model,
  60                                                  enum scsi_devinfo_key key);
  61 extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
  62                                         char *model, char *strflags,
  63                                         blist_flags_t flags,
  64                                         enum scsi_devinfo_key key);
  65 extern int scsi_dev_info_list_del_keyed(char *vendor, char *model,
  66                                         enum scsi_devinfo_key key);
  67 extern int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name);
  68 extern int scsi_dev_info_remove_list(enum scsi_devinfo_key key);
  69
  70 extern int __init scsi_init_devinfo(void);
  71 extern void scsi_exit_devinfo(void);
  72
  73 /* scsi_error.c */
  74 extern void scmd_eh_abort_handler(struct work_struct *work);
  75 extern enum blk_eh_timer_return scsi_times_out(struct request *req);
  76 extern int scsi_error_handler(void *host);
  77 extern enum scsi_disposition scsi_decide_disposition(struct scsi_cmnd *cmd);
  78 extern void scsi_eh_wakeup(struct Scsi_Host *shost);
  79 extern void scsi_eh_scmd_add(struct scsi_cmnd *);
  80 void scsi_eh_ready_devs(struct Scsi_Host *shost,
  81                         struct list_head *work_q,
  82                         struct list_head *done_q);
  83 int scsi_eh_get_sense(struct list_head *work_q,
  84                       struct list_head *done_q);
  85 int scsi_noretry_cmd(struct scsi_cmnd *scmd);
  86
  87 /* scsi_lib.c */
  88 extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
  89 extern void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd);
  90 extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
  91 extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
  92 extern void scsi_run_host_queues(struct Scsi_Host *shost);
  93 extern void scsi_requeue_run_queue(struct work_struct *work);
  94 extern void scsi_start_queue(struct scsi_device *sdev);
  95 extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
  96 extern void scsi_mq_destroy_tags(struct Scsi_Host *shost);
  97 extern void scsi_exit_queue(void);
  98 extern void scsi_evt_thread(struct work_struct *work);
  99
 100 /* scsi_proc.c */
 101 #ifdef CONFIG_SCSI_PROC_FS
 102 extern void scsi_proc_hostdir_add(struct scsi_host_template *);
 103 extern void scsi_proc_hostdir_rm(struct scsi_host_template *);
 104 extern void scsi_proc_host_add(struct Scsi_Host *);
 105 extern void scsi_proc_host_rm(struct Scsi_Host *);
 106 extern int scsi_init_procfs(void);
 107 extern void scsi_exit_procfs(void);
 108 #else
 109 # define scsi_proc_hostdir_add(sht)     do { } while (0)
 110 # define scsi_proc_hostdir_rm(sht)      do { } while (0)
 111 # define scsi_proc_host_add(shost)      do { } while (0)
 112 # define scsi_proc_host_rm(shost)       do { } while (0)
 113 # define scsi_init_procfs()             (0)
 114 # define scsi_exit_procfs()             do { } while (0)
 115 #endif /* CONFIG_PROC_FS */
 116
 117 /* scsi_scan.c */
 118 extern char scsi_scan_type[];
 119 extern int scsi_complete_async_scans(void);
 120 extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
 121                                    unsigned int, u64, enum scsi_scan_mode);
 122 extern void scsi_forget_host(struct Scsi_Host *);
 123 extern void scsi_rescan_device(struct device *);
 124
 125 /* scsi_sysctl.c */
 126 #ifdef CONFIG_SYSCTL
 127 extern int scsi_init_sysctl(void);
 128 extern void scsi_exit_sysctl(void);
 129 #else
 130 # define scsi_init_sysctl()             (0)
 131 # define scsi_exit_sysctl()             do { } while (0)
 132 #endif /* CONFIG_SYSCTL */
 133
 134 /* scsi_sysfs.c */
 135 extern int scsi_sysfs_add_sdev(struct scsi_device *);
 136 extern int scsi_sysfs_add_host(struct Scsi_Host *);
 137 extern int scsi_sysfs_register(void);
 138 extern void scsi_sysfs_unregister(void);
 139 extern void scsi_sysfs_device_initialize(struct scsi_device *);
 140 extern int scsi_sysfs_target_initialize(struct scsi_device *);
 141 extern struct scsi_transport_template blank_transport_template;
 142 extern void __scsi_remove_device(struct scsi_device *);
 143
 144 extern struct bus_type scsi_bus_type;
 145 extern const struct attribute_group *scsi_sysfs_shost_attr_groups[];
 146
 147 /* scsi_netlink.c */
 148 #ifdef CONFIG_SCSI_NETLINK
 149 extern void scsi_netlink_init(void);
 150 extern void scsi_netlink_exit(void);
 151 extern struct sock *scsi_nl_sock;
 152 #else
 153 static inline void scsi_netlink_init(void) {}
 154 static inline void scsi_netlink_exit(void) {}
 155 #endif
 156
 157 /* scsi_pm.c */
 158 #ifdef CONFIG_PM
 159 extern const struct dev_pm_ops scsi_bus_pm_ops;
 160
 161 extern void scsi_autopm_get_target(struct scsi_target *);
 162 extern void scsi_autopm_put_target(struct scsi_target *);
 163 extern int scsi_autopm_get_host(struct Scsi_Host *);
 164 extern void scsi_autopm_put_host(struct Scsi_Host *);
 165 #else
 166 static inline void scsi_autopm_get_target(struct scsi_target *t) {}
 167 static inline void scsi_autopm_put_target(struct scsi_target *t) {}
 168 static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
 169 static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
 170 #endif /* CONFIG_PM */
 171
 172 extern struct async_domain scsi_sd_pm_domain;
 173
 174 /* scsi_dh.c */
 175 #ifdef CONFIG_SCSI_DH
 176 void scsi_dh_add_device(struct scsi_device *sdev);
 177 void scsi_dh_release_device(struct scsi_device *sdev);
 178 #else
 179 static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
 180 static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
 181 #endif
 182
 183 extern int scsi_device_max_queue_depth(struct scsi_device *sdev);
 184
 185 /*
 186  * internal scsi timeout functions: for use by mid-layer and transport
 187  * classes.
 188  */
 189
 190 #define SCSI_DEVICE_BLOCK_MAX_TIMEOUT   600     /* units in seconds */
 191
 192 #endif /* _SCSI_PRIV_H */