blob: 180636d54982d0db670ecaf1b3b158f1eca08956 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _SCSI_PRIV_H
3#define _SCSI_PRIV_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/device.h>
Dan Williams2955b472012-07-09 19:33:25 -07006#include <linux/async.h>
Mike Christie5d9fb5c2012-05-17 23:56:57 -05007#include <scsi/scsi_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
9struct request_queue;
Jens Axboe242f9dc2008-09-14 05:55:09 -070010struct request;
Linus Torvalds1da177e2005-04-16 15:20:36 -070011struct scsi_cmnd;
12struct scsi_device;
Alan Sternbc4f2402010-06-17 10:41:42 -040013struct scsi_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -070014struct scsi_host_template;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015struct Scsi_Host;
James Smart84314fd2006-08-18 17:30:09 -040016struct scsi_nl_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Mike Christie2a242d52020-10-01 10:35:53 -050018#define SCSI_CMD_RETRIES_NO_LIMIT -1
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 * Scsi Error Handler Flags
22 */
Hannes Reineckee494f6a2013-11-11 13:44:54 +010023#define SCSI_EH_ABORT_SCHEDULED 0x0002 /* Abort has been scheduled */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25#define SCSI_SENSE_VALID(scmd) \
26 (((scmd)->sense_buffer[0] & 0x70) == 0x70)
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/* hosts.c */
29extern int scsi_init_hosts(void);
30extern void scsi_exit_hosts(void);
31
32/* scsi.c */
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030033int scsi_init_sense_cache(struct Scsi_Host *shost);
Christoph Hellwige9c787e2017-01-02 21:55:26 +030034void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#ifdef CONFIG_SCSI_LOGGING
36void scsi_log_send(struct scsi_cmnd *cmd);
37void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
38#else
39static inline void scsi_log_send(struct scsi_cmnd *cmd)
40 { };
41static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
42 { };
43#endif
44
45/* scsi_devinfo.c */
James Bottomley598fa4b2009-06-17 15:01:58 -040046
47/* list of keys for the lists */
Bart Van Assche4b1d8e72017-12-04 10:36:33 -080048enum scsi_devinfo_key {
James Bottomley598fa4b2009-06-17 15:01:58 -040049 SCSI_DEVINFO_GLOBAL = 0,
James Bottomleya9e0edb2009-06-17 19:05:05 +000050 SCSI_DEVINFO_SPI,
James Bottomley598fa4b2009-06-17 15:01:58 -040051};
52
Hannes Reinecke5ebde462017-11-15 12:07:30 +010053extern blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
54 const unsigned char *vendor,
55 const unsigned char *model);
56extern blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
57 const unsigned char *vendor,
58 const unsigned char *model,
Bart Van Assche4b1d8e72017-12-04 10:36:33 -080059 enum scsi_devinfo_key key);
James Bottomley598fa4b2009-06-17 15:01:58 -040060extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
61 char *model, char *strflags,
Bart Van Assche4b1d8e72017-12-04 10:36:33 -080062 blist_flags_t flags,
63 enum scsi_devinfo_key key);
64extern int scsi_dev_info_list_del_keyed(char *vendor, char *model,
65 enum scsi_devinfo_key key);
66extern int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name);
67extern int scsi_dev_info_remove_list(enum scsi_devinfo_key key);
James Bottomley598fa4b2009-06-17 15:01:58 -040068
Linus Torvalds1da177e2005-04-16 15:20:36 -070069extern int __init scsi_init_devinfo(void);
70extern void scsi_exit_devinfo(void);
71
72/* scsi_error.c */
Hannes Reineckee494f6a2013-11-11 13:44:54 +010073extern void scmd_eh_abort_handler(struct work_struct *work);
Jens Axboe242f9dc2008-09-14 05:55:09 -070074extern enum blk_eh_timer_return scsi_times_out(struct request *req);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075extern int scsi_error_handler(void *host);
76extern int scsi_decide_disposition(struct scsi_cmnd *cmd);
77extern void scsi_eh_wakeup(struct Scsi_Host *shost);
Hannes Reineckea0658632017-04-06 15:36:35 +020078extern void scsi_eh_scmd_add(struct scsi_cmnd *);
Darrick J. Wongdca84e42007-01-26 14:08:49 -080079void scsi_eh_ready_devs(struct Scsi_Host *shost,
80 struct list_head *work_q,
81 struct list_head *done_q);
82int scsi_eh_get_sense(struct list_head *work_q,
83 struct list_head *done_q);
Mike Christie4a274462008-08-19 18:45:31 -050084int scsi_noretry_cmd(struct scsi_cmnd *scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86/* scsi_lib.c */
87extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
Ming Lei6eb045e2019-10-25 14:58:55 +080088extern void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd);
Bart Van Assche84feb162012-06-29 15:35:05 +000089extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
Linus Torvalds7b3d9542008-01-06 10:17:12 -080090extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091extern void scsi_run_host_queues(struct Scsi_Host *shost);
Baoyou Xied67e8b32016-08-30 19:26:00 +080092extern void scsi_requeue_run_queue(struct work_struct *work);
Christoph Hellwigd2852032014-01-17 12:06:53 +010093extern struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev);
Bart Van Assche66483a42017-06-02 14:21:56 -070094extern void scsi_start_queue(struct scsi_device *sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +010095extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
96extern void scsi_mq_destroy_tags(struct Scsi_Host *shost);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097extern void scsi_exit_queue(void);
Baoyou Xied67e8b32016-08-30 19:26:00 +080098extern void scsi_evt_thread(struct work_struct *work);
James Bottomley751bf4d2008-01-02 11:14:30 -060099struct request_queue;
100struct request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/* scsi_proc.c */
103#ifdef CONFIG_SCSI_PROC_FS
104extern void scsi_proc_hostdir_add(struct scsi_host_template *);
105extern void scsi_proc_hostdir_rm(struct scsi_host_template *);
106extern void scsi_proc_host_add(struct Scsi_Host *);
107extern void scsi_proc_host_rm(struct Scsi_Host *);
108extern int scsi_init_procfs(void);
109extern void scsi_exit_procfs(void);
110#else
111# define scsi_proc_hostdir_add(sht) do { } while (0)
112# define scsi_proc_hostdir_rm(sht) do { } while (0)
113# define scsi_proc_host_add(shost) do { } while (0)
114# define scsi_proc_host_rm(shost) do { } while (0)
115# define scsi_init_procfs() (0)
116# define scsi_exit_procfs() do { } while (0)
117#endif /* CONFIG_PROC_FS */
118
119/* scsi_scan.c */
Dan Williams3c31b522014-04-10 15:30:35 -0700120extern char scsi_scan_type[];
Alan Sternfea6d602012-02-17 16:25:08 -0500121extern int scsi_complete_async_scans(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
Hannes Reinecke1d645082016-03-17 08:39:45 +0100123 unsigned int, u64, enum scsi_scan_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124extern void scsi_forget_host(struct Scsi_Host *);
125extern void scsi_rescan_device(struct device *);
126
127/* scsi_sysctl.c */
128#ifdef CONFIG_SYSCTL
129extern int scsi_init_sysctl(void);
130extern void scsi_exit_sysctl(void);
131#else
132# define scsi_init_sysctl() (0)
133# define scsi_exit_sysctl() do { } while (0)
134#endif /* CONFIG_SYSCTL */
135
136/* scsi_sysfs.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137extern int scsi_sysfs_add_sdev(struct scsi_device *);
138extern int scsi_sysfs_add_host(struct Scsi_Host *);
139extern int scsi_sysfs_register(void);
140extern void scsi_sysfs_unregister(void);
141extern void scsi_sysfs_device_initialize(struct scsi_device *);
142extern int scsi_sysfs_target_initialize(struct scsi_device *);
143extern struct scsi_transport_template blank_transport_template;
Alan Stern903f4fed2005-07-26 10:20:53 -0400144extern void __scsi_remove_device(struct scsi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146extern struct bus_type scsi_bus_type;
David Brownella4dbd672009-06-24 10:06:31 -0700147extern const struct attribute_group *scsi_sysfs_shost_attr_groups[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
James Smart84314fd2006-08-18 17:30:09 -0400149/* scsi_netlink.c */
150#ifdef CONFIG_SCSI_NETLINK
151extern void scsi_netlink_init(void);
152extern void scsi_netlink_exit(void);
153extern struct sock *scsi_nl_sock;
154#else
155static inline void scsi_netlink_init(void) {}
156static inline void scsi_netlink_exit(void) {}
157#endif
158
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400159/* scsi_pm.c */
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100160#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400161extern const struct dev_pm_ops scsi_bus_pm_ops;
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100162
Alan Sternbc4f2402010-06-17 10:41:42 -0400163extern void scsi_autopm_get_target(struct scsi_target *);
164extern void scsi_autopm_put_target(struct scsi_target *);
165extern int scsi_autopm_get_host(struct Scsi_Host *);
166extern void scsi_autopm_put_host(struct Scsi_Host *);
167#else
168static inline void scsi_autopm_get_target(struct scsi_target *t) {}
169static inline void scsi_autopm_put_target(struct scsi_target *t) {}
170static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
171static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100172#endif /* CONFIG_PM */
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400173
Dan Williams3c31b522014-04-10 15:30:35 -0700174extern struct async_domain scsi_sd_pm_domain;
Dan Williamsa7a20d12012-03-22 17:05:11 -0700175
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200176/* scsi_dh.c */
177#ifdef CONFIG_SCSI_DH
Hannes Reinecke2930f812017-09-20 09:18:52 +0200178void scsi_dh_add_device(struct scsi_device *sdev);
Junichi Nomura23695e42015-10-06 04:32:57 +0000179void scsi_dh_release_device(struct scsi_device *sdev);
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200180#else
Hannes Reinecke2930f812017-09-20 09:18:52 +0200181static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
Junichi Nomura23695e42015-10-06 04:32:57 +0000182static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200183#endif
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185/*
186 * internal scsi timeout functions: for use by mid-layer and transport
187 * classes.
188 */
189
James Smart1c9e16e2006-05-16 16:13:36 -0400190#define SCSI_DEVICE_BLOCK_MAX_TIMEOUT 600 /* units in seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192#endif /* _SCSI_PRIV_H */