xref: /linux/drivers/scsi/scsi_priv.h (revision d67b569f5f620c0fb95d5212642746b7ba9d29e4)
1 #ifndef _SCSI_PRIV_H
2 #define _SCSI_PRIV_H
3 
4 #include <linux/config.h>
5 #include <linux/device.h>
6 
7 struct request_queue;
8 struct scsi_cmnd;
9 struct scsi_device;
10 struct scsi_host_template;
11 struct scsi_request;
12 struct Scsi_Host;
13 
14 
15 /*
16  * These are the values that the owner field can take.
17  * They are used as an indication of who the command belongs to.
18  */
19 #define SCSI_OWNER_HIGHLEVEL      0x100
20 #define SCSI_OWNER_MIDLEVEL       0x101
21 #define SCSI_OWNER_LOWLEVEL       0x102
22 #define SCSI_OWNER_ERROR_HANDLER  0x103
23 #define SCSI_OWNER_BH_HANDLER     0x104
24 #define SCSI_OWNER_NOBODY         0x105
25 
26 /*
27  * Magic values for certain scsi structs. Shouldn't ever be used.
28  */
29 #define SCSI_CMND_MAGIC		0xE25C23A5
30 #define SCSI_REQ_MAGIC		0x75F6D354
31 
32 /*
33  * Scsi Error Handler Flags
34  */
35 #define scsi_eh_eflags_chk(scp, flags) \
36 	((scp)->eh_eflags & (flags))
37 #define scsi_eh_eflags_set(scp, flags) \
38 	do { (scp)->eh_eflags |= (flags); } while(0)
39 #define scsi_eh_eflags_clr(scp, flags) \
40 	do { (scp)->eh_eflags &= ~(flags); } while(0)
41 #define scsi_eh_eflags_clr_all(scp) \
42 	(scp->eh_eflags = 0)
43 
44 #define SCSI_EH_CANCEL_CMD	0x0001	/* Cancel this cmd */
45 #define SCSI_EH_REC_TIMEOUT	0x0002	/* EH retry timed out */
46 
47 #define SCSI_SENSE_VALID(scmd) \
48 	(((scmd)->sense_buffer[0] & 0x70) == 0x70)
49 
50 /*
51  * Special value for scanning to specify scanning or rescanning of all
52  * possible channels, (target) ids, or luns on a given shost.
53  */
54 #define SCAN_WILD_CARD	~0
55 
56 /* hosts.c */
57 extern int scsi_init_hosts(void);
58 extern void scsi_exit_hosts(void);
59 
60 /* scsi.c */
61 extern int scsi_dispatch_cmd(struct scsi_cmnd *cmd);
62 extern int scsi_setup_command_freelist(struct Scsi_Host *shost);
63 extern void scsi_destroy_command_freelist(struct Scsi_Host *shost);
64 extern int scsi_insert_special_req(struct scsi_request *sreq, int);
65 extern void scsi_init_cmd_from_req(struct scsi_cmnd *cmd,
66 		struct scsi_request *sreq);
67 extern void __scsi_release_request(struct scsi_request *sreq);
68 extern void __scsi_done(struct scsi_cmnd *cmd);
69 #ifdef CONFIG_SCSI_LOGGING
70 void scsi_log_send(struct scsi_cmnd *cmd);
71 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
72 #else
73 static inline void scsi_log_send(struct scsi_cmnd *cmd)
74 	{ };
75 static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
76 	{ };
77 #endif
78 
79 /* scsi_devinfo.c */
80 extern int scsi_get_device_flags(struct scsi_device *sdev,
81 				 unsigned char *vendor, unsigned char *model);
82 extern int __init scsi_init_devinfo(void);
83 extern void scsi_exit_devinfo(void);
84 
85 /* scsi_error.c */
86 extern void scsi_times_out(struct scsi_cmnd *cmd);
87 extern int scsi_error_handler(void *host);
88 extern int scsi_decide_disposition(struct scsi_cmnd *cmd);
89 extern void scsi_eh_wakeup(struct Scsi_Host *shost);
90 extern int scsi_eh_scmd_add(struct scsi_cmnd *, int);
91 
92 /* scsi_lib.c */
93 extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
94 extern void scsi_setup_cmd_retry(struct scsi_cmnd *cmd);
95 extern void scsi_device_unbusy(struct scsi_device *sdev);
96 extern int scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
97 extern void scsi_next_command(struct scsi_cmnd *cmd);
98 extern void scsi_run_host_queues(struct Scsi_Host *shost);
99 extern struct request_queue *scsi_alloc_queue(struct scsi_device *sdev);
100 extern void scsi_free_queue(struct request_queue *q);
101 extern int scsi_init_queue(void);
102 extern void scsi_exit_queue(void);
103 
104 /* scsi_proc.c */
105 #ifdef CONFIG_SCSI_PROC_FS
106 extern void scsi_proc_hostdir_add(struct scsi_host_template *);
107 extern void scsi_proc_hostdir_rm(struct scsi_host_template *);
108 extern void scsi_proc_host_add(struct Scsi_Host *);
109 extern void scsi_proc_host_rm(struct Scsi_Host *);
110 extern int scsi_init_procfs(void);
111 extern void scsi_exit_procfs(void);
112 #else
113 # define scsi_proc_hostdir_add(sht)	do { } while (0)
114 # define scsi_proc_hostdir_rm(sht)	do { } while (0)
115 # define scsi_proc_host_add(shost)	do { } while (0)
116 # define scsi_proc_host_rm(shost)	do { } while (0)
117 # define scsi_init_procfs()		(0)
118 # define scsi_exit_procfs()		do { } while (0)
119 #endif /* CONFIG_PROC_FS */
120 
121 /* scsi_scan.c */
122 extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
123 				   unsigned int, unsigned int, int);
124 extern void scsi_forget_host(struct Scsi_Host *);
125 extern void scsi_rescan_device(struct device *);
126 
127 /* scsi_sysctl.c */
128 #ifdef CONFIG_SYSCTL
129 extern int scsi_init_sysctl(void);
130 extern 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 */
137 extern int scsi_sysfs_add_sdev(struct scsi_device *);
138 extern int scsi_sysfs_add_host(struct Scsi_Host *);
139 extern int scsi_sysfs_register(void);
140 extern void scsi_sysfs_unregister(void);
141 extern void scsi_sysfs_device_initialize(struct scsi_device *);
142 extern int scsi_sysfs_target_initialize(struct scsi_device *);
143 extern struct scsi_transport_template blank_transport_template;
144 
145 extern struct bus_type scsi_bus_type;
146 
147 /*
148  * internal scsi timeout functions: for use by mid-layer and transport
149  * classes.
150  */
151 
152 #define SCSI_DEVICE_BLOCK_MAX_TIMEOUT	(HZ*60)
153 extern int scsi_internal_device_block(struct scsi_device *sdev);
154 extern int scsi_internal_device_unblock(struct scsi_device *sdev);
155 
156 #endif /* _SCSI_PRIV_H */
157