blob: d7669caa98936d3d2ebe6c4b22f47024fee145b1 [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
18
19/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 * Scsi Error Handler Flags
21 */
Hannes Reineckee494f6a2013-11-11 13:44:54 +010022#define SCSI_EH_ABORT_SCHEDULED 0x0002 /* Abort has been scheduled */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24#define SCSI_SENSE_VALID(scmd) \
25 (((scmd)->sense_buffer[0] & 0x70) == 0x70)
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* hosts.c */
28extern int scsi_init_hosts(void);
29extern void scsi_exit_hosts(void);
30
31/* scsi.c */
Bart Van Assche8d588812016-09-22 14:20:54 -070032extern bool scsi_use_blk_mq;
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 */
48enum {
49 SCSI_DEVINFO_GLOBAL = 0,
James Bottomleya9e0edb2009-06-17 19:05:05 +000050 SCSI_DEVINFO_SPI,
James Bottomley598fa4b2009-06-17 15:01:58 -040051};
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053extern int scsi_get_device_flags(struct scsi_device *sdev,
James Bottomley7f23e142005-12-01 12:50:13 -060054 const unsigned char *vendor,
55 const unsigned char *model);
James Bottomley598fa4b2009-06-17 15:01:58 -040056extern int scsi_get_device_flags_keyed(struct scsi_device *sdev,
57 const unsigned char *vendor,
58 const unsigned char *model, int key);
59extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
60 char *model, char *strflags,
61 int flags, int key);
Peter Jones38a039b2011-01-06 15:31:29 -050062extern int scsi_dev_info_list_del_keyed(char *vendor, char *model, int key);
James Bottomley598fa4b2009-06-17 15:01:58 -040063extern int scsi_dev_info_add_list(int key, const char *name);
64extern int scsi_dev_info_remove_list(int key);
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066extern int __init scsi_init_devinfo(void);
67extern void scsi_exit_devinfo(void);
68
69/* scsi_error.c */
Hannes Reineckee494f6a2013-11-11 13:44:54 +010070extern void scmd_eh_abort_handler(struct work_struct *work);
Jens Axboe242f9dc2008-09-14 05:55:09 -070071extern enum blk_eh_timer_return scsi_times_out(struct request *req);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072extern int scsi_error_handler(void *host);
73extern int scsi_decide_disposition(struct scsi_cmnd *cmd);
74extern void scsi_eh_wakeup(struct Scsi_Host *shost);
Hannes Reineckea0658632017-04-06 15:36:35 +020075extern void scsi_eh_scmd_add(struct scsi_cmnd *);
Darrick J. Wongdca84e42007-01-26 14:08:49 -080076void scsi_eh_ready_devs(struct Scsi_Host *shost,
77 struct list_head *work_q,
78 struct list_head *done_q);
79int scsi_eh_get_sense(struct list_head *work_q,
80 struct list_head *done_q);
Mike Christie4a274462008-08-19 18:45:31 -050081int scsi_noretry_cmd(struct scsi_cmnd *scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/* scsi_lib.c */
Bart Van Assche2dd6fb52017-06-02 14:21:58 -070084extern void scsi_add_cmd_to_list(struct scsi_cmnd *cmd);
85extern void scsi_del_cmd_from_list(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087extern void scsi_device_unbusy(struct scsi_device *sdev);
Bart Van Assche84feb162012-06-29 15:35:05 +000088extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
Linus Torvalds7b3d9542008-01-06 10:17:12 -080089extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090extern void scsi_run_host_queues(struct Scsi_Host *shost);
Baoyou Xied67e8b32016-08-30 19:26:00 +080091extern void scsi_requeue_run_queue(struct work_struct *work);
Bart Van Asschee7008ff2017-08-25 13:46:31 -070092extern struct request_queue *scsi_old_alloc_queue(struct scsi_device *sdev);
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 int scsi_init_queue(void);
98extern void scsi_exit_queue(void);
Baoyou Xied67e8b32016-08-30 19:26:00 +080099extern void scsi_evt_thread(struct work_struct *work);
James Bottomley751bf4d2008-01-02 11:14:30 -0600100struct request_queue;
101struct request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103/* scsi_proc.c */
104#ifdef CONFIG_SCSI_PROC_FS
105extern void scsi_proc_hostdir_add(struct scsi_host_template *);
106extern void scsi_proc_hostdir_rm(struct scsi_host_template *);
107extern void scsi_proc_host_add(struct Scsi_Host *);
108extern void scsi_proc_host_rm(struct Scsi_Host *);
109extern int scsi_init_procfs(void);
110extern void scsi_exit_procfs(void);
111#else
112# define scsi_proc_hostdir_add(sht) do { } while (0)
113# define scsi_proc_hostdir_rm(sht) do { } while (0)
114# define scsi_proc_host_add(shost) do { } while (0)
115# define scsi_proc_host_rm(shost) do { } while (0)
116# define scsi_init_procfs() (0)
117# define scsi_exit_procfs() do { } while (0)
118#endif /* CONFIG_PROC_FS */
119
120/* scsi_scan.c */
Dan Williams3c31b522014-04-10 15:30:35 -0700121extern char scsi_scan_type[];
Alan Sternfea6d602012-02-17 16:25:08 -0500122extern int scsi_complete_async_scans(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
Hannes Reinecke1d645082016-03-17 08:39:45 +0100124 unsigned int, u64, enum scsi_scan_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125extern void scsi_forget_host(struct Scsi_Host *);
126extern void scsi_rescan_device(struct device *);
127
128/* scsi_sysctl.c */
129#ifdef CONFIG_SYSCTL
130extern int scsi_init_sysctl(void);
131extern void scsi_exit_sysctl(void);
132#else
133# define scsi_init_sysctl() (0)
134# define scsi_exit_sysctl() do { } while (0)
135#endif /* CONFIG_SYSCTL */
136
137/* scsi_sysfs.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138extern int scsi_sysfs_add_sdev(struct scsi_device *);
139extern int scsi_sysfs_add_host(struct Scsi_Host *);
140extern int scsi_sysfs_register(void);
141extern void scsi_sysfs_unregister(void);
142extern void scsi_sysfs_device_initialize(struct scsi_device *);
143extern int scsi_sysfs_target_initialize(struct scsi_device *);
144extern struct scsi_transport_template blank_transport_template;
Alan Stern903f4fe2005-07-26 10:20:53 -0400145extern void __scsi_remove_device(struct scsi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147extern struct bus_type scsi_bus_type;
David Brownella4dbd672009-06-24 10:06:31 -0700148extern const struct attribute_group *scsi_sysfs_shost_attr_groups[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
James Smart84314fd2006-08-18 17:30:09 -0400150/* scsi_netlink.c */
151#ifdef CONFIG_SCSI_NETLINK
152extern void scsi_netlink_init(void);
153extern void scsi_netlink_exit(void);
154extern struct sock *scsi_nl_sock;
155#else
156static inline void scsi_netlink_init(void) {}
157static inline void scsi_netlink_exit(void) {}
158#endif
159
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400160/* scsi_pm.c */
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100161#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400162extern const struct dev_pm_ops scsi_bus_pm_ops;
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100163
Alan Sternbc4f2402010-06-17 10:41:42 -0400164extern void scsi_autopm_get_target(struct scsi_target *);
165extern void scsi_autopm_put_target(struct scsi_target *);
166extern int scsi_autopm_get_host(struct Scsi_Host *);
167extern void scsi_autopm_put_host(struct Scsi_Host *);
168#else
169static inline void scsi_autopm_get_target(struct scsi_target *t) {}
170static inline void scsi_autopm_put_target(struct scsi_target *t) {}
171static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
172static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100173#endif /* CONFIG_PM */
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400174
Dan Williams3c31b522014-04-10 15:30:35 -0700175extern struct async_domain scsi_sd_pm_domain;
Dan Williams2955b472012-07-09 19:33:25 -0700176extern struct async_domain scsi_sd_probe_domain;
Dan Williamsa7a20d12012-03-22 17:05:11 -0700177
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200178/* scsi_dh.c */
179#ifdef CONFIG_SCSI_DH
180int scsi_dh_add_device(struct scsi_device *sdev);
Junichi Nomura23695e42015-10-06 04:32:57 +0000181void scsi_dh_release_device(struct scsi_device *sdev);
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200182#else
183static inline int scsi_dh_add_device(struct scsi_device *sdev) { return 0; }
Junichi Nomura23695e42015-10-06 04:32:57 +0000184static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200185#endif
Hannes Reinecke41f95dd2015-12-01 10:16:41 +0100186static inline void scsi_dh_remove_device(struct scsi_device *sdev) { }
Christoph Hellwig086b91d2015-08-27 14:16:57 +0200187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188/*
189 * internal scsi timeout functions: for use by mid-layer and transport
190 * classes.
191 */
192
James Smart1c9e16e2006-05-16 16:13:36 -0400193#define SCSI_DEVICE_BLOCK_MAX_TIMEOUT 600 /* units in seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
195#endif /* _SCSI_PRIV_H */