blob: fa064bf9a55cdc94ca122d0716f27c296fcdf6d8 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * scsi_sysfs.c
4 *
5 * SCSI sysfs interface routines.
6 *
7 * Created to pull SCSI mid layer sysfs routines into one file.
8 */
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/init.h>
13#include <linux/blkdev.h>
14#include <linux/device.h>
Alan Sternbc4f2402010-06-17 10:41:42 -040015#include <linux/pm_runtime.h>
Christoph Hellwigead09dd2021-07-29 08:48:42 +020016#include <linux/bsg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
18#include <scsi/scsi.h>
19#include <scsi/scsi_device.h>
20#include <scsi/scsi_host.h>
21#include <scsi/scsi_tcq.h>
Hannes Reinecke41f95dd2015-12-01 10:16:41 +010022#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <scsi/scsi_transport.h>
Adrian Bunk44818ef2007-07-09 11:59:59 -070024#include <scsi/scsi_driver.h>
Hannes Reinecke345e2962017-10-02 16:26:34 +020025#include <scsi/scsi_devinfo.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#include "scsi_priv.h"
28#include "scsi_logging.h"
29
Hannes Reineckeb0ed4332008-03-18 14:32:28 +010030static struct device_type scsi_dev_type;
31
Arjan van de Ven0ad78202005-11-28 16:22:25 +010032static const struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 enum scsi_device_state value;
34 char *name;
35} sdev_states[] = {
36 { SDEV_CREATED, "created" },
37 { SDEV_RUNNING, "running" },
38 { SDEV_CANCEL, "cancel" },
39 { SDEV_DEL, "deleted" },
40 { SDEV_QUIESCE, "quiesce" },
41 { SDEV_OFFLINE, "offline" },
Mike Christie1b8d2622012-05-17 23:56:56 -050042 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 { SDEV_BLOCK, "blocked" },
James Bottomley6f4267e2008-08-22 16:53:31 -050044 { SDEV_CREATED_BLOCK, "created-blocked" },
Linus Torvalds1da177e2005-04-16 15:20:36 -070045};
46
47const char *scsi_device_state_name(enum scsi_device_state state)
48{
49 int i;
50 char *name = NULL;
51
Tobias Klauser6391a112006-06-08 22:23:48 -070052 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 if (sdev_states[i].value == state) {
54 name = sdev_states[i].name;
55 break;
56 }
57 }
58 return name;
59}
60
Arjan van de Ven0ad78202005-11-28 16:22:25 +010061static const struct {
Mike Andersond3301872005-06-16 11:12:38 -070062 enum scsi_host_state value;
63 char *name;
64} shost_states[] = {
65 { SHOST_CREATED, "created" },
66 { SHOST_RUNNING, "running" },
67 { SHOST_CANCEL, "cancel" },
68 { SHOST_DEL, "deleted" },
69 { SHOST_RECOVERY, "recovery" },
James Bottomley939647e2005-09-18 15:05:20 -050070 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
71 { SHOST_DEL_RECOVERY, "deleted/recovery", },
Mike Andersond3301872005-06-16 11:12:38 -070072};
73const char *scsi_host_state_name(enum scsi_host_state state)
74{
75 int i;
76 char *name = NULL;
77
Tobias Klauser6391a112006-06-08 22:23:48 -070078 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
Mike Andersond3301872005-06-16 11:12:38 -070079 if (shost_states[i].value == state) {
80 name = shost_states[i].name;
81 break;
82 }
83 }
84 return name;
85}
86
Bart Van Assched78540d2016-03-28 11:13:16 -070087#ifdef CONFIG_SCSI_DH
Hannes Reinecke77c9df92016-03-03 07:54:07 +010088static const struct {
89 unsigned char value;
90 char *name;
91} sdev_access_states[] = {
92 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
93 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
94 { SCSI_ACCESS_STATE_STANDBY, "standby" },
95 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
96 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
97 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
98 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
99};
100
Bart Van Assched78540d2016-03-28 11:13:16 -0700101static const char *scsi_access_state_name(unsigned char state)
Hannes Reinecke77c9df92016-03-03 07:54:07 +0100102{
103 int i;
104 char *name = NULL;
105
106 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
107 if (sdev_access_states[i].value == state) {
108 name = sdev_access_states[i].name;
109 break;
110 }
111 }
112 return name;
113}
Bart Van Assched78540d2016-03-28 11:13:16 -0700114#endif
Hannes Reinecke77c9df92016-03-03 07:54:07 +0100115
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200116static int check_set(unsigned long long *val, char *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117{
118 char *last;
119
Bart Van Assche3991e462017-08-25 13:46:30 -0700120 if (strcmp(src, "-") == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 *val = SCAN_WILD_CARD;
122 } else {
123 /*
124 * Doesn't check for int overflow
125 */
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200126 *val = simple_strtoull(src, &last, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 if (*last != '\0')
128 return 1;
129 }
130 return 0;
131}
132
133static int scsi_scan(struct Scsi_Host *shost, const char *str)
134{
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200135 char s1[15], s2[15], s3[17], junk;
136 unsigned long long channel, id, lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 int res;
138
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200139 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 if (res != 3)
141 return -EINVAL;
142 if (check_set(&channel, s1))
143 return -EINVAL;
144 if (check_set(&id, s2))
145 return -EINVAL;
146 if (check_set(&lun, s3))
147 return -EINVAL;
Christoph Hellwige02f3f52006-01-13 19:04:00 +0100148 if (shost->transportt->user_scan)
149 res = shost->transportt->user_scan(shost, channel, id, lun);
150 else
Hannes Reinecke1d645082016-03-17 08:39:45 +0100151 res = scsi_scan_host_selected(shost, channel, id, lun,
152 SCSI_SCAN_MANUAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 return res;
154}
155
156/*
157 * shost_show_function: macro to create an attr function that can be used to
158 * show a non-bit field.
159 */
160#define shost_show_function(name, field, format_string) \
161static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100162show_##name (struct device *dev, struct device_attribute *attr, \
163 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100165 struct Scsi_Host *shost = class_to_shost(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 return snprintf (buf, 20, format_string, shost->field); \
167}
168
169/*
170 * shost_rd_attr: macro to create a function and attribute variable for a
171 * read only field.
172 */
173#define shost_rd_attr2(name, field, format_string) \
174 shost_show_function(name, field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100175static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177#define shost_rd_attr(field, format_string) \
178shost_rd_attr2(field, field, format_string)
179
180/*
181 * Create the actual show/store functions and data structures.
182 */
183
Tony Jonesee959b02008-02-22 00:13:36 +0100184static ssize_t
185store_scan(struct device *dev, struct device_attribute *attr,
186 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187{
Tony Jonesee959b02008-02-22 00:13:36 +0100188 struct Scsi_Host *shost = class_to_shost(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 int res;
190
191 res = scsi_scan(shost, buf);
192 if (res == 0)
193 res = count;
194 return res;
195};
Tony Jonesee959b02008-02-22 00:13:36 +0100196static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Mike Andersond3301872005-06-16 11:12:38 -0700198static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100199store_shost_state(struct device *dev, struct device_attribute *attr,
200 const char *buf, size_t count)
Mike Andersond3301872005-06-16 11:12:38 -0700201{
202 int i;
Tony Jonesee959b02008-02-22 00:13:36 +0100203 struct Scsi_Host *shost = class_to_shost(dev);
Mike Andersond3301872005-06-16 11:12:38 -0700204 enum scsi_host_state state = 0;
205
Tobias Klauser6391a112006-06-08 22:23:48 -0700206 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
Mike Andersond3301872005-06-16 11:12:38 -0700207 const int len = strlen(shost_states[i].name);
208 if (strncmp(shost_states[i].name, buf, len) == 0 &&
209 buf[len] == '\n') {
210 state = shost_states[i].value;
211 break;
212 }
213 }
214 if (!state)
215 return -EINVAL;
216
217 if (scsi_host_set_state(shost, state))
218 return -EINVAL;
219 return count;
220}
221
222static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100223show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
Mike Andersond3301872005-06-16 11:12:38 -0700224{
Tony Jonesee959b02008-02-22 00:13:36 +0100225 struct Scsi_Host *shost = class_to_shost(dev);
Mike Andersond3301872005-06-16 11:12:38 -0700226 const char *name = scsi_host_state_name(shost->shost_state);
227
228 if (!name)
229 return -EINVAL;
230
231 return snprintf(buf, 20, "%s\n", name);
232}
233
Tony Jonesee959b02008-02-22 00:13:36 +0100234/* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
Bart Van Assched78540d2016-03-28 11:13:16 -0700235static struct device_attribute dev_attr_hstate =
Tony Jonesee959b02008-02-22 00:13:36 +0100236 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
Mike Andersond3301872005-06-16 11:12:38 -0700237
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900238static ssize_t
239show_shost_mode(unsigned int mode, char *buf)
240{
241 ssize_t len = 0;
242
243 if (mode & MODE_INITIATOR)
244 len = sprintf(buf, "%s", "Initiator");
245
246 if (mode & MODE_TARGET)
247 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
248
249 len += sprintf(buf + len, "\n");
250
251 return len;
252}
253
Tony Jonesee959b02008-02-22 00:13:36 +0100254static ssize_t
255show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
256 char *buf)
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900257{
Tony Jonesee959b02008-02-22 00:13:36 +0100258 struct Scsi_Host *shost = class_to_shost(dev);
James Bottomley7a39ac32007-09-25 22:45:53 -0500259 unsigned int supported_mode = shost->hostt->supported_mode;
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900260
James Bottomley7a39ac32007-09-25 22:45:53 -0500261 if (supported_mode == MODE_UNKNOWN)
262 /* by default this should be initiator */
263 supported_mode = MODE_INITIATOR;
264
265 return show_shost_mode(supported_mode, buf);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900266}
267
Tony Jonesee959b02008-02-22 00:13:36 +0100268static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900269
Tony Jonesee959b02008-02-22 00:13:36 +0100270static ssize_t
271show_shost_active_mode(struct device *dev,
272 struct device_attribute *attr, char *buf)
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900273{
Tony Jonesee959b02008-02-22 00:13:36 +0100274 struct Scsi_Host *shost = class_to_shost(dev);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900275
276 if (shost->active_mode == MODE_UNKNOWN)
277 return snprintf(buf, 20, "unknown\n");
278 else
279 return show_shost_mode(shost->active_mode, buf);
280}
281
Tony Jonesee959b02008-02-22 00:13:36 +0100282static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900283
Sasha Levin072f19b2012-11-15 15:51:46 -0500284static int check_reset_type(const char *str)
Vikas Chaudhary29443692011-08-12 02:51:28 -0700285{
Sasha Levin072f19b2012-11-15 15:51:46 -0500286 if (sysfs_streq(str, "adapter"))
Vikas Chaudhary29443692011-08-12 02:51:28 -0700287 return SCSI_ADAPTER_RESET;
Sasha Levin072f19b2012-11-15 15:51:46 -0500288 else if (sysfs_streq(str, "firmware"))
Vikas Chaudhary29443692011-08-12 02:51:28 -0700289 return SCSI_FIRMWARE_RESET;
290 else
291 return 0;
292}
293
294static ssize_t
295store_host_reset(struct device *dev, struct device_attribute *attr,
296 const char *buf, size_t count)
297{
298 struct Scsi_Host *shost = class_to_shost(dev);
299 struct scsi_host_template *sht = shost->hostt;
300 int ret = -EINVAL;
Vikas Chaudhary29443692011-08-12 02:51:28 -0700301 int type;
302
Sasha Levin072f19b2012-11-15 15:51:46 -0500303 type = check_reset_type(buf);
Vikas Chaudhary29443692011-08-12 02:51:28 -0700304 if (!type)
305 goto exit_store_host_reset;
306
307 if (sht->host_reset)
308 ret = sht->host_reset(shost, type);
weiping zhang92227b82017-08-11 01:52:17 +0800309 else
310 ret = -EOPNOTSUPP;
Vikas Chaudhary29443692011-08-12 02:51:28 -0700311
312exit_store_host_reset:
313 if (ret == 0)
314 ret = count;
315 return ret;
316}
317
318static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
319
Hannes Reineckeb4562022013-10-23 10:51:21 +0200320static ssize_t
321show_shost_eh_deadline(struct device *dev,
322 struct device_attribute *attr, char *buf)
323{
324 struct Scsi_Host *shost = class_to_shost(dev);
325
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100326 if (shost->eh_deadline == -1)
327 return snprintf(buf, strlen("off") + 2, "off\n");
328 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
Hannes Reineckeb4562022013-10-23 10:51:21 +0200329}
330
331static ssize_t
332store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
333 const char *buf, size_t count)
334{
335 struct Scsi_Host *shost = class_to_shost(dev);
336 int ret = -EINVAL;
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100337 unsigned long deadline, flags;
Hannes Reineckeb4562022013-10-23 10:51:21 +0200338
Hannes Reineckead469a52014-01-17 16:05:38 +0100339 if (shost->transportt &&
340 (shost->transportt->eh_strategy_handler ||
341 !shost->hostt->eh_host_reset_handler))
Hannes Reineckeb4562022013-10-23 10:51:21 +0200342 return ret;
343
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100344 if (!strncmp(buf, "off", strlen("off")))
345 deadline = -1;
346 else {
347 ret = kstrtoul(buf, 10, &deadline);
348 if (ret)
349 return ret;
350 if (deadline * HZ > UINT_MAX)
351 return -EINVAL;
Hannes Reineckeb4562022013-10-23 10:51:21 +0200352 }
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100353
354 spin_lock_irqsave(shost->host_lock, flags);
355 if (scsi_host_in_recovery(shost))
356 ret = -EBUSY;
357 else {
358 if (deadline == -1)
359 shost->eh_deadline = -1;
360 else
361 shost->eh_deadline = deadline * HZ;
362
363 ret = count;
364 }
365 spin_unlock_irqrestore(shost->host_lock, flags);
366
Hannes Reineckeb4562022013-10-23 10:51:21 +0200367 return ret;
368}
369
370static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
371
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372shost_rd_attr(unique_id, "%u\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373shost_rd_attr(cmd_per_lun, "%hd\n");
Nick Desaulniers88392822020-11-07 00:11:32 -0800374shost_rd_attr(can_queue, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375shost_rd_attr(sg_tablesize, "%hu\n");
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200376shost_rd_attr(sg_prot_tablesize, "%hu\n");
Martin K. Petersen4469f982008-07-17 04:28:30 -0400377shost_rd_attr(prot_capabilities, "%u\n");
378shost_rd_attr(prot_guard_type, "%hd\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
380
Christoph Hellwig74665012014-01-22 15:29:29 +0100381static ssize_t
382show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
383{
384 struct Scsi_Host *shost = class_to_shost(dev);
Ming Leic84b0232018-06-24 22:03:26 +0800385 return snprintf(buf, 20, "%d\n", scsi_host_busy(shost));
Christoph Hellwig74665012014-01-22 15:29:29 +0100386}
387static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
388
Jens Axboef664a3c2018-11-01 16:36:27 -0600389static ssize_t
390show_use_blk_mq(struct device *dev, struct device_attribute *attr, char *buf)
391{
392 return sprintf(buf, "1\n");
393}
394static DEVICE_ATTR(use_blk_mq, S_IRUGO, show_use_blk_mq, NULL);
395
John Garry64f15012020-08-19 23:20:31 +0800396static ssize_t
397show_nr_hw_queues(struct device *dev, struct device_attribute *attr, char *buf)
398{
399 struct Scsi_Host *shost = class_to_shost(dev);
400 struct blk_mq_tag_set *tag_set = &shost->tag_set;
401
402 return snprintf(buf, 20, "%d\n", tag_set->nr_hw_queues);
403}
404static DEVICE_ATTR(nr_hw_queues, S_IRUGO, show_nr_hw_queues, NULL);
405
Hannes Reineckef7120a42008-03-18 14:32:28 +0100406static struct attribute *scsi_sysfs_shost_attrs[] = {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100407 &dev_attr_use_blk_mq.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100408 &dev_attr_unique_id.attr,
409 &dev_attr_host_busy.attr,
410 &dev_attr_cmd_per_lun.attr,
411 &dev_attr_can_queue.attr,
412 &dev_attr_sg_tablesize.attr,
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200413 &dev_attr_sg_prot_tablesize.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100414 &dev_attr_proc_name.attr,
415 &dev_attr_scan.attr,
416 &dev_attr_hstate.attr,
417 &dev_attr_supported_mode.attr,
418 &dev_attr_active_mode.attr,
Martin K. Petersen4469f982008-07-17 04:28:30 -0400419 &dev_attr_prot_capabilities.attr,
420 &dev_attr_prot_guard_type.attr,
Vikas Chaudhary29443692011-08-12 02:51:28 -0700421 &dev_attr_host_reset.attr,
Hannes Reineckeb4562022013-10-23 10:51:21 +0200422 &dev_attr_eh_deadline.attr,
John Garry64f15012020-08-19 23:20:31 +0800423 &dev_attr_nr_hw_queues.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100424 NULL
425};
426
Bart Van Assche92c4b582021-10-12 16:35:13 -0700427const struct attribute_group scsi_shost_attr_group = {
Hannes Reineckef7120a42008-03-18 14:32:28 +0100428 .attrs = scsi_sysfs_shost_attrs,
429};
430
Tony Jonesee959b02008-02-22 00:13:36 +0100431static void scsi_device_cls_release(struct device *class_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
433 struct scsi_device *sdev;
434
435 sdev = class_to_sdev(class_dev);
436 put_device(&sdev->sdev_gendev);
437}
438
David Howells65f27f32006-11-22 14:55:48 +0000439static void scsi_device_dev_release_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
441 struct scsi_device *sdev;
442 struct device *parent;
Jeff Garzika341cd02007-10-29 17:15:22 -0400443 struct list_head *this, *tmp;
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700444 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
Ryan Attardd188b062019-09-26 11:22:17 -0500445 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 unsigned long flags;
447
David Howells65f27f32006-11-22 14:55:48 +0000448 sdev = container_of(work, struct scsi_device, ew.work);
449
Junichi Nomura23695e42015-10-06 04:32:57 +0000450 scsi_dh_release_device(sdev);
451
David Howells65f27f32006-11-22 14:55:48 +0000452 parent = sdev->sdev_gendev.parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454 spin_lock_irqsave(sdev->host->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 list_del(&sdev->siblings);
456 list_del(&sdev->same_target_siblings);
457 list_del(&sdev->starved_entry);
458 spin_unlock_irqrestore(sdev->host->host_lock, flags);
459
Jeff Garzika341cd02007-10-29 17:15:22 -0400460 cancel_work_sync(&sdev->event_work);
461
462 list_for_each_safe(this, tmp, &sdev->event_list) {
463 struct scsi_event *evt;
464
465 evt = list_entry(this, struct scsi_event, node);
466 list_del(&evt->node);
467 kfree(evt);
468 }
469
James Bottomleye73e0792011-05-25 15:52:14 -0500470 blk_put_queue(sdev->request_queue);
James Bottomley86cbfb52011-04-22 10:39:59 -0500471 /* NULL queue means the device can't be used */
472 sdev->request_queue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Ming Lei020b0f02021-01-22 10:33:17 +0800474 sbitmap_free(&sdev->budget_map);
475
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700476 mutex_lock(&sdev->inquiry_mutex);
Linus Torvaldsef2cc882019-12-02 13:37:02 -0800477 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
478 lockdep_is_held(&sdev->inquiry_mutex));
Paul E. McKenneyc0eaf152019-09-23 15:26:28 -0700479 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
480 lockdep_is_held(&sdev->inquiry_mutex));
481 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
482 lockdep_is_held(&sdev->inquiry_mutex));
Linus Torvaldsef2cc882019-12-02 13:37:02 -0800483 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
484 lockdep_is_held(&sdev->inquiry_mutex));
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700485 mutex_unlock(&sdev->inquiry_mutex);
486
Ryan Attardd188b062019-09-26 11:22:17 -0500487 if (vpd_pg0)
488 kfree_rcu(vpd_pg0, rcu);
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700489 if (vpd_pg83)
490 kfree_rcu(vpd_pg83, rcu);
491 if (vpd_pg80)
492 kfree_rcu(vpd_pg80, rcu);
Ryan Attardd188b062019-09-26 11:22:17 -0500493 if (vpd_pg89)
494 kfree_rcu(vpd_pg89, rcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 kfree(sdev->inquiry);
496 kfree(sdev);
497
498 if (parent)
499 put_device(parent);
500}
501
James Bottomley65110b22006-02-14 10:48:46 -0600502static void scsi_device_dev_release(struct device *dev)
503{
James Bottomleyffedb452006-02-23 14:27:18 -0600504 struct scsi_device *sdp = to_scsi_device(dev);
David Howells65f27f32006-11-22 14:55:48 +0000505 execute_in_process_context(scsi_device_dev_release_usercontext,
James Bottomleyffedb452006-02-23 14:27:18 -0600506 &sdp->ew);
James Bottomley65110b22006-02-14 10:48:46 -0600507}
508
Adrian Bunk52c1da32005-06-23 22:05:33 -0700509static struct class sdev_class = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 .name = "scsi_device",
Tony Jonesee959b02008-02-22 00:13:36 +0100511 .dev_release = scsi_device_cls_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512};
513
514/* all probing is done in the individual ->probe routines */
515static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
516{
Hannes Reineckeb0ed4332008-03-18 14:32:28 +0100517 struct scsi_device *sdp;
518
519 if (dev->type != &scsi_dev_type)
520 return 0;
521
522 sdp = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 if (sdp->no_uld_attach)
524 return 0;
525 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
526}
527
Kay Sievers7eff2e72007-08-14 15:15:12 +0200528static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400529{
James Bottomley1f42ea72008-05-22 12:34:41 +0100530 struct scsi_device *sdev;
531
532 if (dev->type != &scsi_dev_type)
533 return 0;
534
535 sdev = to_scsi_device(dev);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400536
Kay Sievers7eff2e72007-08-14 15:15:12 +0200537 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400538 return 0;
539}
540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541struct bus_type scsi_bus_type = {
542 .name = "scsi",
543 .match = scsi_bus_match,
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400544 .uevent = scsi_bus_uevent,
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100545#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400546 .pm = &scsi_bus_pm_ops,
Alan Sterne6da54d2010-08-05 13:17:10 -0400547#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548};
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700549EXPORT_SYMBOL_GPL(scsi_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
551int scsi_sysfs_register(void)
552{
553 int error;
554
555 error = bus_register(&scsi_bus_type);
556 if (!error) {
557 error = class_register(&sdev_class);
558 if (error)
559 bus_unregister(&scsi_bus_type);
560 }
561
562 return error;
563}
564
565void scsi_sysfs_unregister(void)
566{
567 class_unregister(&sdev_class);
568 bus_unregister(&scsi_bus_type);
569}
570
571/*
572 * sdev_show_function: macro to create an attr function that can be used to
573 * show a non-bit field.
574 */
575#define sdev_show_function(field, format_string) \
576static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100577sdev_show_##field (struct device *dev, struct device_attribute *attr, \
578 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{ \
580 struct scsi_device *sdev; \
581 sdev = to_scsi_device(dev); \
582 return snprintf (buf, 20, format_string, sdev->field); \
583} \
584
585/*
586 * sdev_rd_attr: macro to create a function and attribute variable for a
587 * read only field.
588 */
589#define sdev_rd_attr(field, format_string) \
590 sdev_show_function(field, format_string) \
591static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
592
593
594/*
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900595 * sdev_rw_attr: create a function and attribute variable for a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 * read/write field.
597 */
598#define sdev_rw_attr(field, format_string) \
599 sdev_show_function(field, format_string) \
600 \
601static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100602sdev_store_##field (struct device *dev, struct device_attribute *attr, \
603 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604{ \
605 struct scsi_device *sdev; \
606 sdev = to_scsi_device(dev); \
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900607 sscanf (buf, format_string, &sdev->field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 return count; \
609} \
610static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
611
612/* Currently we don't export bit fields, but we might in future,
613 * so leave this code in */
614#if 0
615/*
616 * sdev_rd_attr: create a function and attribute variable for a
617 * read/write bit field.
618 */
619#define sdev_rw_attr_bit(field) \
620 sdev_show_function(field, "%d\n") \
621 \
622static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100623sdev_store_##field (struct device *dev, struct device_attribute *attr, \
624 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625{ \
626 int ret; \
627 struct scsi_device *sdev; \
628 ret = scsi_sdev_check_buf_bit(buf); \
629 if (ret >= 0) { \
630 sdev = to_scsi_device(dev); \
631 sdev->field = ret; \
632 ret = count; \
633 } \
634 return ret; \
635} \
636static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
637
638/*
639 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
640 * else return -EINVAL.
641 */
642static int scsi_sdev_check_buf_bit(const char *buf)
643{
644 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
645 if (buf[0] == '1')
646 return 1;
647 else if (buf[0] == '0')
648 return 0;
649 else
650 return -EINVAL;
651 } else
652 return -EINVAL;
653}
654#endif
655/*
656 * Create the actual show/store functions and data structures.
657 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658sdev_rd_attr (type, "%d\n");
659sdev_rd_attr (scsi_level, "%d\n");
660sdev_rd_attr (vendor, "%.8s\n");
661sdev_rd_attr (model, "%.16s\n");
662sdev_rd_attr (rev, "%.4s\n");
663
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200664static ssize_t
665sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
666 char *buf)
667{
668 struct scsi_device *sdev = to_scsi_device(dev);
Ming Lei82788072021-01-22 10:33:15 +0800669 return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200670}
671static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
672
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100673static ssize_t
674sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
675 char *buf)
676{
677 struct scsi_device *sdev = to_scsi_device(dev);
678 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
679}
680static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
681
Jens Axboe242f9dc2008-09-14 05:55:09 -0700682/*
683 * TODO: can we make these symlinks to the block layer ones?
684 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400686sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687{
688 struct scsi_device *sdev;
689 sdev = to_scsi_device(dev);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700690 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691}
692
693static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100694sdev_store_timeout (struct device *dev, struct device_attribute *attr,
695 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696{
697 struct scsi_device *sdev;
698 int timeout;
699 sdev = to_scsi_device(dev);
700 sscanf (buf, "%d\n", &timeout);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700701 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 return count;
703}
704static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
705
706static ssize_t
Martin K. Petersen0816c922013-05-10 10:36:04 -0400707sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
708{
709 struct scsi_device *sdev;
710 sdev = to_scsi_device(dev);
711 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
712}
713
714static ssize_t
715sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
716 const char *buf, size_t count)
717{
718 struct scsi_device *sdev;
719 unsigned int eh_timeout;
720 int err;
721
722 if (!capable(CAP_SYS_ADMIN))
723 return -EACCES;
724
725 sdev = to_scsi_device(dev);
726 err = kstrtouint(buf, 10, &eh_timeout);
727 if (err)
728 return err;
729 sdev->eh_timeout = eh_timeout * HZ;
730
731 return count;
732}
733static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
734
735static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100736store_rescan_field (struct device *dev, struct device_attribute *attr,
737 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
739 scsi_rescan_device(dev);
740 return count;
741}
742static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
743
Tony Jonesee959b02008-02-22 00:13:36 +0100744static ssize_t
745sdev_store_delete(struct device *dev, struct device_attribute *attr,
746 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700748 struct kernfs_node *kn;
Yufen Yu77c30122019-10-15 21:05:56 +0800749 struct scsi_device *sdev = to_scsi_device(dev);
750
751 /*
752 * We need to try to get module, avoiding the module been removed
753 * during delete.
754 */
755 if (scsi_device_get(sdev))
756 return -ENODEV;
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700757
758 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
759 WARN_ON_ONCE(!kn);
760 /*
761 * Concurrent writes into the "delete" sysfs attribute may trigger
762 * concurrent calls to device_remove_file() and scsi_remove_device().
763 * device_remove_file() handles concurrent removal calls by
764 * serializing these and by ignoring the second and later removal
765 * attempts. Concurrent calls of scsi_remove_device() are
766 * serialized. The second and later calls of scsi_remove_device() are
767 * ignored because the first call of that function changes the device
768 * state into SDEV_DEL.
769 */
770 device_remove_file(dev, attr);
Yufen Yu77c30122019-10-15 21:05:56 +0800771 scsi_remove_device(sdev);
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700772 if (kn)
773 sysfs_unbreak_active_protection(kn);
Yufen Yu77c30122019-10-15 21:05:56 +0800774 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 return count;
776};
777static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
778
779static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100780store_state_field(struct device *dev, struct device_attribute *attr,
781 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782{
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700783 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 struct scsi_device *sdev = to_scsi_device(dev);
785 enum scsi_device_state state = 0;
786
Tobias Klauser6391a112006-06-08 22:23:48 -0700787 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 const int len = strlen(sdev_states[i].name);
789 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
790 buf[len] == '\n') {
791 state = sdev_states[i].value;
792 break;
793 }
794 }
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700795 switch (state) {
796 case SDEV_RUNNING:
797 case SDEV_OFFLINE:
798 break;
799 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 return -EINVAL;
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700801 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700803 mutex_lock(&sdev->state_mutex);
804 ret = scsi_device_set_state(sdev, state);
zhengbin70fc0852019-03-22 10:56:46 +0800805 /*
lijinlinf0f82e22021-07-27 11:44:55 +0800806 * If the device state changes to SDEV_RUNNING, we need to
Li Jinlin02c6dcd2021-08-24 10:59:21 +0800807 * run the queue to avoid I/O hang, and rescan the device
808 * to revalidate it. Running the queue first is necessary
809 * because another thread may be waiting inside
810 * blk_mq_freeze_queue_wait() and because that call may be
811 * waiting for pending I/O to finish.
zhengbin70fc0852019-03-22 10:56:46 +0800812 */
lijinlinf0f82e22021-07-27 11:44:55 +0800813 if (ret == 0 && state == SDEV_RUNNING) {
zhengbin70fc0852019-03-22 10:56:46 +0800814 blk_mq_run_hw_queues(sdev->request_queue, true);
Li Jinlin02c6dcd2021-08-24 10:59:21 +0800815 scsi_rescan_device(dev);
lijinlinf0f82e22021-07-27 11:44:55 +0800816 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700817 mutex_unlock(&sdev->state_mutex);
818
819 return ret == 0 ? count : -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820}
821
822static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400823show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824{
825 struct scsi_device *sdev = to_scsi_device(dev);
826 const char *name = scsi_device_state_name(sdev->sdev_state);
827
828 if (!name)
829 return -EINVAL;
830
831 return snprintf(buf, 20, "%s\n", name);
832}
833
834static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
835
836static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100837show_queue_type_field(struct device *dev, struct device_attribute *attr,
838 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839{
840 struct scsi_device *sdev = to_scsi_device(dev);
841 const char *name = "none";
842
Christoph Hellwig609aa222014-10-30 11:54:58 +0100843 if (sdev->simple_tags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 name = "simple";
845
846 return snprintf(buf, 20, "%s\n", name);
847}
848
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100849static ssize_t
850store_queue_type_field(struct device *dev, struct device_attribute *attr,
851 const char *buf, size_t count)
852{
853 struct scsi_device *sdev = to_scsi_device(dev);
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100854
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100855 if (!sdev->tagged_supported)
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100856 return -EINVAL;
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100857
858 sdev_printk(KERN_INFO, sdev,
859 "ignoring write to deprecated queue_type attribute");
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100860 return count;
861}
862
863static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
864 store_queue_type_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100866#define sdev_vpd_pg_attr(_page) \
867static ssize_t \
868show_vpd_##_page(struct file *filp, struct kobject *kobj, \
869 struct bin_attribute *bin_attr, \
870 char *buf, loff_t off, size_t count) \
871{ \
Guosong Su9e7bd9452020-02-25 18:04:11 +0800872 struct device *dev = kobj_to_dev(kobj); \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100873 struct scsi_device *sdev = to_scsi_device(dev); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700874 struct scsi_vpd *vpd_page; \
875 int ret = -EINVAL; \
876 \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100877 rcu_read_lock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700878 vpd_page = rcu_dereference(sdev->vpd_##_page); \
879 if (vpd_page) \
880 ret = memory_read_from_buffer(buf, count, &off, \
881 vpd_page->data, vpd_page->len); \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100882 rcu_read_unlock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700883 return ret; \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100884} \
885static struct bin_attribute dev_attr_vpd_##_page = { \
886 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
887 .size = 0, \
888 .read = show_vpd_##_page, \
889};
890
891sdev_vpd_pg_attr(pg83);
892sdev_vpd_pg_attr(pg80);
Ryan Attardd188b062019-09-26 11:22:17 -0500893sdev_vpd_pg_attr(pg89);
894sdev_vpd_pg_attr(pg0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100896static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
897 struct bin_attribute *bin_attr,
898 char *buf, loff_t off, size_t count)
899{
Guosong Su9e7bd9452020-02-25 18:04:11 +0800900 struct device *dev = kobj_to_dev(kobj);
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100901 struct scsi_device *sdev = to_scsi_device(dev);
902
903 if (!sdev->inquiry)
904 return -EINVAL;
905
906 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
907 sdev->inquiry_len);
908}
909
910static struct bin_attribute dev_attr_inquiry = {
911 .attr = {
912 .name = "inquiry",
913 .mode = S_IRUGO,
914 },
915 .size = 0,
916 .read = show_inquiry,
917};
918
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919static ssize_t
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100920show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
921 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922{
923 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
924}
925
926static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
927
928#define show_sdev_iostat(field) \
929static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100930show_iostat_##field(struct device *dev, struct device_attribute *attr, \
931 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932{ \
933 struct scsi_device *sdev = to_scsi_device(dev); \
934 unsigned long long count = atomic_read(&sdev->field); \
935 return snprintf(buf, 20, "0x%llx\n", count); \
936} \
937static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
938
939show_sdev_iostat(iorequest_cnt);
940show_sdev_iostat(iodone_cnt);
941show_sdev_iostat(ioerr_cnt);
942
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400943static ssize_t
944sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
945{
946 struct scsi_device *sdev;
947 sdev = to_scsi_device(dev);
948 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
949}
950static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Jeff Garzika341cd02007-10-29 17:15:22 -0400952#define DECLARE_EVT_SHOW(name, Cap_name) \
953static ssize_t \
954sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
Tony Jonesee959b02008-02-22 00:13:36 +0100955 char *buf) \
Jeff Garzika341cd02007-10-29 17:15:22 -0400956{ \
957 struct scsi_device *sdev = to_scsi_device(dev); \
958 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
959 return snprintf(buf, 20, "%d\n", val); \
960}
961
962#define DECLARE_EVT_STORE(name, Cap_name) \
963static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100964sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
Jeff Garzika341cd02007-10-29 17:15:22 -0400965 const char *buf, size_t count) \
966{ \
967 struct scsi_device *sdev = to_scsi_device(dev); \
968 int val = simple_strtoul(buf, NULL, 0); \
969 if (val == 0) \
970 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
971 else if (val == 1) \
972 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
973 else \
974 return -EINVAL; \
975 return count; \
976}
977
978#define DECLARE_EVT(name, Cap_name) \
979 DECLARE_EVT_SHOW(name, Cap_name) \
980 DECLARE_EVT_STORE(name, Cap_name) \
981 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
982 sdev_store_evt_##name);
983#define REF_EVT(name) &dev_attr_evt_##name.attr
984
985DECLARE_EVT(media_change, MEDIA_CHANGE)
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400986DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
987DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
988DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
989DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
990DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
Jeff Garzika341cd02007-10-29 17:15:22 -0400991
Tony Jonesee959b02008-02-22 00:13:36 +0100992static ssize_t
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100993sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
994 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995{
996 int depth, retval;
997 struct scsi_device *sdev = to_scsi_device(dev);
998 struct scsi_host_template *sht = sdev->host->hostt;
999
1000 if (!sht->change_queue_depth)
1001 return -EINVAL;
1002
1003 depth = simple_strtoul(buf, NULL, 0);
1004
Jens Axboe1278dd682015-07-13 08:24:39 -06001005 if (depth < 1 || depth > sdev->host->can_queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 return -EINVAL;
1007
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001008 retval = sht->change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 if (retval < 0)
1010 return retval;
1011
Vasu Dev4a840672009-10-22 15:46:33 -07001012 sdev->max_queue_depth = sdev->queue_depth;
1013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 return count;
1015}
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001016sdev_show_function(queue_depth, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001018static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1019 sdev_store_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001021static ssize_t
1022sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1023 char *buf)
1024{
1025 struct scsi_device *sdev = to_scsi_device(dev);
1026 ssize_t count;
1027
1028 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1029 if (count > 0) {
1030 buf[count] = '\n';
1031 count++;
1032 }
1033 return count;
1034}
1035static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1036
Bart Van Assche093b8882017-12-12 10:23:28 -08001037#define BLIST_FLAG_NAME(name) \
Martin Wilck14098802018-04-18 01:35:08 +02001038 [const_ilog2((__force __u64)BLIST_##name)] = #name
Hannes Reinecke345e2962017-10-02 16:26:34 +02001039static const char *const sdev_bflags_name[] = {
1040#include "scsi_devinfo_tbl.c"
1041};
1042#undef BLIST_FLAG_NAME
1043
1044static ssize_t
1045sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1046 char *buf)
1047{
1048 struct scsi_device *sdev = to_scsi_device(dev);
1049 int i;
1050 ssize_t len = 0;
1051
1052 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1053 const char *name = NULL;
1054
Bart Van Assche093b8882017-12-12 10:23:28 -08001055 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
Hannes Reinecke345e2962017-10-02 16:26:34 +02001056 continue;
1057 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1058 name = sdev_bflags_name[i];
1059
1060 if (name)
Takashi Iwai81546b32020-03-15 10:42:40 +01001061 len += scnprintf(buf + len, PAGE_SIZE - len,
1062 "%s%s", len ? " " : "", name);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001063 else
Takashi Iwai81546b32020-03-15 10:42:40 +01001064 len += scnprintf(buf + len, PAGE_SIZE - len,
1065 "%sINVALID_BIT(%d)", len ? " " : "", i);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001066 }
1067 if (len)
Takashi Iwai81546b32020-03-15 10:42:40 +01001068 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
Hannes Reinecke345e2962017-10-02 16:26:34 +02001069 return len;
1070}
1071static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1072
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001073#ifdef CONFIG_SCSI_DH
1074static ssize_t
1075sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1076 char *buf)
1077{
1078 struct scsi_device *sdev = to_scsi_device(dev);
1079
1080 if (!sdev->handler)
1081 return snprintf(buf, 20, "detached\n");
1082
1083 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1084}
1085
1086static ssize_t
1087sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1088 const char *buf, size_t count)
1089{
1090 struct scsi_device *sdev = to_scsi_device(dev);
1091 int err = -EINVAL;
1092
1093 if (sdev->sdev_state == SDEV_CANCEL ||
1094 sdev->sdev_state == SDEV_DEL)
1095 return -ENODEV;
1096
1097 if (!sdev->handler) {
1098 /*
1099 * Attach to a device handler
1100 */
1101 err = scsi_dh_attach(sdev->request_queue, buf);
1102 } else if (!strncmp(buf, "activate", 8)) {
1103 /*
1104 * Activate a device handler
1105 */
1106 if (sdev->handler->activate)
1107 err = sdev->handler->activate(sdev, NULL, NULL);
1108 else
1109 err = 0;
1110 } else if (!strncmp(buf, "detach", 6)) {
1111 /*
1112 * Detach from a device handler
1113 */
1114 sdev_printk(KERN_WARNING, sdev,
1115 "can't detach handler %s.\n",
1116 sdev->handler->name);
1117 err = -EINVAL;
1118 }
1119
1120 return err < 0 ? err : count;
1121}
1122
1123static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1124 sdev_store_dh_state);
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001125
1126static ssize_t
1127sdev_show_access_state(struct device *dev,
1128 struct device_attribute *attr,
1129 char *buf)
1130{
1131 struct scsi_device *sdev = to_scsi_device(dev);
1132 unsigned char access_state;
1133 const char *access_state_name;
1134
1135 if (!sdev->handler)
1136 return -EINVAL;
1137
1138 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1139 access_state_name = scsi_access_state_name(access_state);
1140
1141 return sprintf(buf, "%s\n",
1142 access_state_name ? access_state_name : "unknown");
1143}
1144static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1145
1146static ssize_t
1147sdev_show_preferred_path(struct device *dev,
1148 struct device_attribute *attr,
1149 char *buf)
1150{
1151 struct scsi_device *sdev = to_scsi_device(dev);
1152
1153 if (!sdev->handler)
1154 return -EINVAL;
1155
1156 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1157 return sprintf(buf, "1\n");
1158 else
1159 return sprintf(buf, "0\n");
1160}
1161static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001162#endif
1163
Tony Jonesee959b02008-02-22 00:13:36 +01001164static ssize_t
Vasu Dev4a840672009-10-22 15:46:33 -07001165sdev_show_queue_ramp_up_period(struct device *dev,
1166 struct device_attribute *attr,
1167 char *buf)
1168{
1169 struct scsi_device *sdev;
1170 sdev = to_scsi_device(dev);
1171 return snprintf(buf, 20, "%u\n",
1172 jiffies_to_msecs(sdev->queue_ramp_up_period));
1173}
1174
1175static ssize_t
1176sdev_store_queue_ramp_up_period(struct device *dev,
1177 struct device_attribute *attr,
1178 const char *buf, size_t count)
1179{
1180 struct scsi_device *sdev = to_scsi_device(dev);
Daniel Walterf7c65af2014-08-08 14:24:05 -07001181 unsigned int period;
Vasu Dev4a840672009-10-22 15:46:33 -07001182
Daniel Walterf7c65af2014-08-08 14:24:05 -07001183 if (kstrtouint(buf, 10, &period))
Vasu Dev4a840672009-10-22 15:46:33 -07001184 return -EINVAL;
1185
1186 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
Peter Oberparleiter5cb9b402015-10-26 15:54:23 +01001187 return count;
Vasu Dev4a840672009-10-22 15:46:33 -07001188}
1189
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001190static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1191 sdev_show_queue_ramp_up_period,
1192 sdev_store_queue_ramp_up_period);
Vasu Dev4a840672009-10-22 15:46:33 -07001193
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001194static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1195 struct attribute *attr, int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001197 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 struct scsi_device *sdev = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001201 if (attr == &dev_attr_queue_depth.attr &&
1202 !sdev->host->hostt->change_queue_depth)
1203 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001205 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1206 !sdev->host->hostt->change_queue_depth)
1207 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001209#ifdef CONFIG_SCSI_DH
1210 if (attr == &dev_attr_access_state.attr &&
1211 !sdev->handler)
1212 return 0;
1213 if (attr == &dev_attr_preferred_path.attr &&
1214 !sdev->handler)
1215 return 0;
1216#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001217 return attr->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218}
1219
Hannes Reinecke7e479762016-03-03 07:41:24 +01001220static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1221 struct bin_attribute *attr, int i)
1222{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001223 struct device *dev = kobj_to_dev(kobj);
Hannes Reinecke7e479762016-03-03 07:41:24 +01001224 struct scsi_device *sdev = to_scsi_device(dev);
1225
1226
Ryan Attardd188b062019-09-26 11:22:17 -05001227 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1228 return 0;
1229
Hannes Reinecke7e479762016-03-03 07:41:24 +01001230 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1231 return 0;
1232
Hannes Reinecke68887582016-03-10 11:25:26 +01001233 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
Hannes Reinecke7e479762016-03-03 07:41:24 +01001234 return 0;
1235
Ryan Attardd188b062019-09-26 11:22:17 -05001236 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1237 return 0;
1238
Hannes Reinecke7e479762016-03-03 07:41:24 +01001239 return S_IRUGO;
1240}
1241
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001242/* Default template for device attributes. May NOT be modified */
1243static struct attribute *scsi_sdev_attrs[] = {
1244 &dev_attr_device_blocked.attr,
1245 &dev_attr_type.attr,
1246 &dev_attr_scsi_level.attr,
1247 &dev_attr_device_busy.attr,
1248 &dev_attr_vendor.attr,
1249 &dev_attr_model.attr,
1250 &dev_attr_rev.attr,
1251 &dev_attr_rescan.attr,
1252 &dev_attr_delete.attr,
1253 &dev_attr_state.attr,
1254 &dev_attr_timeout.attr,
1255 &dev_attr_eh_timeout.attr,
1256 &dev_attr_iocounterbits.attr,
1257 &dev_attr_iorequest_cnt.attr,
1258 &dev_attr_iodone_cnt.attr,
1259 &dev_attr_ioerr_cnt.attr,
1260 &dev_attr_modalias.attr,
1261 &dev_attr_queue_depth.attr,
1262 &dev_attr_queue_type.attr,
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001263 &dev_attr_wwid.attr,
Hannes Reinecke345e2962017-10-02 16:26:34 +02001264 &dev_attr_blacklist.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001265#ifdef CONFIG_SCSI_DH
1266 &dev_attr_dh_state.attr,
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001267 &dev_attr_access_state.attr,
1268 &dev_attr_preferred_path.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001269#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001270 &dev_attr_queue_ramp_up_period.attr,
1271 REF_EVT(media_change),
1272 REF_EVT(inquiry_change_reported),
1273 REF_EVT(capacity_change_reported),
1274 REF_EVT(soft_threshold_reached),
1275 REF_EVT(mode_parameter_change_reported),
1276 REF_EVT(lun_change_reported),
1277 NULL
1278};
1279
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001280static struct bin_attribute *scsi_sdev_bin_attrs[] = {
Ryan Attardd188b062019-09-26 11:22:17 -05001281 &dev_attr_vpd_pg0,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001282 &dev_attr_vpd_pg83,
1283 &dev_attr_vpd_pg80,
Ryan Attardd188b062019-09-26 11:22:17 -05001284 &dev_attr_vpd_pg89,
Johannes Thumshirn92e62462015-11-09 10:56:57 +01001285 &dev_attr_inquiry,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001286 NULL
1287};
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001288static struct attribute_group scsi_sdev_attr_group = {
1289 .attrs = scsi_sdev_attrs,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001290 .bin_attrs = scsi_sdev_bin_attrs,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001291 .is_visible = scsi_sdev_attr_is_visible,
Hannes Reinecke7e479762016-03-03 07:41:24 +01001292 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001293};
1294
1295static const struct attribute_group *scsi_sdev_attr_groups[] = {
1296 &scsi_sdev_attr_group,
1297 NULL
1298};
1299
James Bottomley643eb2d2008-03-22 22:42:27 -05001300static int scsi_target_add(struct scsi_target *starget)
1301{
1302 int error;
1303
1304 if (starget->state != STARGET_CREATED)
1305 return 0;
1306
1307 error = device_add(&starget->dev);
1308 if (error) {
1309 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
James Bottomley643eb2d2008-03-22 22:42:27 -05001310 return error;
1311 }
1312 transport_add_device(&starget->dev);
1313 starget->state = STARGET_RUNNING;
1314
Alan Sternbc4f2402010-06-17 10:41:42 -04001315 pm_runtime_set_active(&starget->dev);
1316 pm_runtime_enable(&starget->dev);
1317 device_enable_async_suspend(&starget->dev);
1318
James Bottomley643eb2d2008-03-22 22:42:27 -05001319 return 0;
1320}
1321
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322/**
1323 * scsi_sysfs_add_sdev - add scsi device to sysfs
1324 * @sdev: scsi_device to add
1325 *
1326 * Return value:
1327 * 0 on Success / non-zero on Failure
1328 **/
1329int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1330{
Bart Van Assche92c4b582021-10-12 16:35:13 -07001331 int error;
James Bottomley643eb2d2008-03-22 22:42:27 -05001332 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
James Bottomley643eb2d2008-03-22 22:42:27 -05001334 error = scsi_target_add(starget);
1335 if (error)
1336 return error;
1337
1338 transport_configure_device(&starget->dev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001339
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001340 device_enable_async_suspend(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001341 scsi_autopm_get_target(starget);
1342 pm_runtime_set_active(&sdev->sdev_gendev);
Stanley Chuc74f8052019-09-16 23:56:49 +08001343 if (!sdev->rpm_autosuspend)
1344 pm_runtime_forbid(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001345 pm_runtime_enable(&sdev->sdev_gendev);
1346 scsi_autopm_put_target(starget);
1347
Alan Sternbc4f2402010-06-17 10:41:42 -04001348 scsi_autopm_get_device(sdev);
1349
Hannes Reinecke2930f812017-09-20 09:18:52 +02001350 scsi_dh_add_device(sdev);
Christoph Hellwig086b91d2015-08-27 14:16:57 +02001351
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001352 error = device_add(&sdev->sdev_gendev);
1353 if (error) {
1354 sdev_printk(KERN_INFO, sdev,
1355 "failed to add device: %d\n", error);
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001356 return error;
1357 }
1358
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001359 device_enable_async_suspend(&sdev->sdev_dev);
Tony Jonesee959b02008-02-22 00:13:36 +01001360 error = device_add(&sdev->sdev_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001362 sdev_printk(KERN_INFO, sdev,
1363 "failed to add class device: %d\n", error);
James Bottomley860dc732009-11-19 17:48:29 -05001364 device_del(&sdev->sdev_gendev);
Alan Sternee37e092010-02-12 12:13:55 -05001365 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 }
James Bottomley860dc732009-11-19 17:48:29 -05001367 transport_add_device(&sdev->sdev_gendev);
1368 sdev->is_visible = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001370 if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1371 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1372 if (IS_ERR(sdev->bsg_dev)) {
1373 /*
1374 * We're treating error on bsg register as non-fatal, so
1375 * pretend nothing went wrong.
1376 */
1377 sdev_printk(KERN_INFO, sdev,
1378 "Failed to register bsg queue, errno=%d\n",
1379 error);
1380 sdev->bsg_dev = NULL;
1381 }
1382 }
James Bottomley80ed71c2007-07-19 10:15:10 -05001383
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03001384 scsi_autopm_put_device(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386}
1387
Alan Stern903f4fed2005-07-26 10:20:53 -04001388void __scsi_remove_device(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389{
James Bottomleydf133c22005-11-06 11:47:08 -06001390 struct device *dev = &sdev->sdev_gendev;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001391 int res;
James Bottomleydf133c22005-11-06 11:47:08 -06001392
Vitaly Kuznetsovbe821fd2015-11-19 14:02:19 +01001393 /*
1394 * This cleanup path is not reentrant and while it is impossible
1395 * to get a new reference with scsi_device_get() someone can still
1396 * hold a previously acquired one.
1397 */
1398 if (sdev->sdev_state == SDEV_DEL)
1399 return;
1400
James Bottomley860dc732009-11-19 17:48:29 -05001401 if (sdev->is_visible) {
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001402 /*
1403 * If scsi_internal_target_block() is running concurrently,
1404 * wait until it has finished before changing the device state.
1405 */
1406 mutex_lock(&sdev->state_mutex);
Bart Van Assche255ee932017-06-02 14:21:57 -07001407 /*
1408 * If blocked, we go straight to DEL and restart the queue so
1409 * any commands issued during driver shutdown (like sync
1410 * cache) are errored immediately.
1411 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001412 res = scsi_device_set_state(sdev, SDEV_CANCEL);
Bart Van Assche255ee932017-06-02 14:21:57 -07001413 if (res != 0) {
1414 res = scsi_device_set_state(sdev, SDEV_DEL);
1415 if (res == 0)
1416 scsi_start_queue(sdev);
1417 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001418 mutex_unlock(&sdev->state_mutex);
1419
1420 if (res != 0)
James Bottomley860dc732009-11-19 17:48:29 -05001421 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001423 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1424 bsg_unregister_queue(sdev->bsg_dev);
James Bottomley860dc732009-11-19 17:48:29 -05001425 device_unregister(&sdev->sdev_dev);
1426 transport_remove_device(dev);
Bart Van Asschee619e6c2015-11-20 14:11:01 -08001427 device_del(dev);
1428 } else
1429 put_device(&sdev->sdev_dev);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001430
1431 /*
1432 * Stop accepting new requests and wait until all queuecommand() and
1433 * scsi_run_queue() invocations have finished before tearing down the
1434 * device.
1435 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001436 mutex_lock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 scsi_device_set_state(sdev, SDEV_DEL);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001438 mutex_unlock(&sdev->state_mutex);
1439
Bart Van Asscheb4854622012-06-29 15:36:07 +00001440 blk_cleanup_queue(sdev->request_queue);
1441 cancel_work_sync(&sdev->requeue_work);
1442
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 if (sdev->host->hostt->slave_destroy)
1444 sdev->host->hostt->slave_destroy(sdev);
James Bottomleydf133c22005-11-06 11:47:08 -06001445 transport_destroy_device(dev);
James Bottomley86cbfb52011-04-22 10:39:59 -05001446
James Bottomleye63ed0d2014-01-21 07:00:50 -08001447 /*
1448 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
dudengkeeee89102021-03-26 14:09:02 +08001449 * removed sysfs visibility from the device, so make the target
James Bottomleye63ed0d2014-01-21 07:00:50 -08001450 * invisible if this was the last device underneath it.
1451 */
1452 scsi_target_reap(scsi_target(sdev));
1453
James Bottomleydf133c22005-11-06 11:47:08 -06001454 put_device(dev);
Alan Stern903f4fed2005-07-26 10:20:53 -04001455}
1456
1457/**
1458 * scsi_remove_device - unregister a device from the scsi bus
1459 * @sdev: scsi_device to unregister
1460 **/
1461void scsi_remove_device(struct scsi_device *sdev)
1462{
Alan Stern54195002005-09-15 21:52:51 -04001463 struct Scsi_Host *shost = sdev->host;
1464
Arjan van de Ven0b950672006-01-11 13:16:10 +01001465 mutex_lock(&shost->scan_mutex);
Alan Stern903f4fed2005-07-26 10:20:53 -04001466 __scsi_remove_device(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01001467 mutex_unlock(&shost->scan_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468}
1469EXPORT_SYMBOL(scsi_remove_device);
1470
Adrian Bunk44818ef2007-07-09 11:59:59 -07001471static void __scsi_remove_target(struct scsi_target *starget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472{
1473 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1474 unsigned long flags;
Alan Sterna64358d2005-07-26 10:27:10 -04001475 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
1477 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001478 restart:
1479 list_for_each_entry(sdev, &shost->__devices, siblings) {
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001480 /*
1481 * We cannot call scsi_device_get() here, as
1482 * we might've been called from rmmod() causing
1483 * scsi_device_get() to fail the module_is_live()
1484 * check.
1485 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 if (sdev->channel != starget->channel ||
Hannes Reinecke81b6c992017-12-13 14:21:37 +01001487 sdev->id != starget->id)
1488 continue;
1489 if (sdev->sdev_state == SDEV_DEL ||
1490 sdev->sdev_state == SDEV_CANCEL ||
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001491 !get_device(&sdev->sdev_gendev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 continue;
1493 spin_unlock_irqrestore(shost->host_lock, flags);
1494 scsi_remove_device(sdev);
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001495 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001497 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 }
1499 spin_unlock_irqrestore(shost->host_lock, flags);
mochel@digitalimplant.org20b1e672005-03-24 19:03:59 -08001500}
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502/**
1503 * scsi_remove_target - try to remove a target and all its devices
1504 * @dev: generic starget or parent of generic stargets to be removed
1505 *
1506 * Note: This is slightly racy. It is possible that if the user
1507 * requests the addition of another device then the target won't be
1508 * removed.
1509 */
1510void scsi_remove_target(struct device *dev)
1511{
Dan Williams3b661a92012-06-21 23:47:28 -07001512 struct Scsi_Host *shost = dev_to_shost(dev->parent);
Johannes Thumshirn305c2e72016-04-05 11:50:45 +02001513 struct scsi_target *starget;
Dan Williams3b661a92012-06-21 23:47:28 -07001514 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Christoph Hellwig40998192015-10-19 16:35:46 +02001516restart:
Dan Williams3b661a92012-06-21 23:47:28 -07001517 spin_lock_irqsave(shost->host_lock, flags);
1518 list_for_each_entry(starget, &shost->__targets, siblings) {
James Bottomley90a88d62016-02-10 08:03:26 -08001519 if (starget->state == STARGET_DEL ||
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001520 starget->state == STARGET_REMOVE ||
1521 starget->state == STARGET_CREATED_REMOVE)
Dan Williams3b661a92012-06-21 23:47:28 -07001522 continue;
1523 if (starget->dev.parent == dev || &starget->dev == dev) {
James Bottomleye63ed0d2014-01-21 07:00:50 -08001524 kref_get(&starget->reap_ref);
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001525 if (starget->state == STARGET_CREATED)
1526 starget->state = STARGET_CREATED_REMOVE;
1527 else
1528 starget->state = STARGET_REMOVE;
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001529 spin_unlock_irqrestore(shost->host_lock, flags);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001530 __scsi_remove_target(starget);
Christoph Hellwig40998192015-10-19 16:35:46 +02001531 scsi_target_reap(starget);
1532 goto restart;
Dan Williams3b661a92012-06-21 23:47:28 -07001533 }
1534 }
1535 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536}
1537EXPORT_SYMBOL(scsi_remove_target);
1538
1539int scsi_register_driver(struct device_driver *drv)
1540{
1541 drv->bus = &scsi_bus_type;
1542
1543 return driver_register(drv);
1544}
1545EXPORT_SYMBOL(scsi_register_driver);
1546
1547int scsi_register_interface(struct class_interface *intf)
1548{
1549 intf->class = &sdev_class;
1550
1551 return class_interface_register(intf);
1552}
1553EXPORT_SYMBOL(scsi_register_interface);
1554
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555/**
1556 * scsi_sysfs_add_host - add scsi host to subsystem
1557 * @shost: scsi host struct to add to subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 **/
1559int scsi_sysfs_add_host(struct Scsi_Host *shost)
1560{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 transport_register_device(&shost->shost_gendev);
James Bottomleyd52b3812008-01-05 09:38:30 -06001562 transport_configure_device(&shost->shost_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 return 0;
1564}
1565
Kay Sieversbfd12942007-09-11 17:00:14 +02001566static struct device_type scsi_dev_type = {
1567 .name = "scsi_device",
1568 .release = scsi_device_dev_release,
1569 .groups = scsi_sdev_attr_groups,
1570};
1571
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1573{
1574 unsigned long flags;
1575 struct Scsi_Host *shost = sdev->host;
Bart Van Assche92c4b582021-10-12 16:35:13 -07001576 struct scsi_host_template *hostt = shost->hostt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 struct scsi_target *starget = sdev->sdev_target;
1578
1579 device_initialize(&sdev->sdev_gendev);
1580 sdev->sdev_gendev.bus = &scsi_bus_type;
Kay Sieversbfd12942007-09-11 17:00:14 +02001581 sdev->sdev_gendev.type = &scsi_dev_type;
Bart Van Asschea19a93e2021-10-06 14:54:51 -07001582 scsi_enable_async_suspend(&sdev->sdev_gendev);
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001583 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001584 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Steffen Maier3a71f0f2021-10-26 03:42:40 +02001585 sdev->sdev_gendev.groups = hostt->sdev_groups;
Kay Sievers71610f52008-12-03 22:41:36 +01001586
Tony Jonesee959b02008-02-22 00:13:36 +01001587 device_initialize(&sdev->sdev_dev);
James Bottomley37e6ba02009-10-02 13:30:08 -05001588 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
Tony Jonesee959b02008-02-22 00:13:36 +01001589 sdev->sdev_dev.class = &sdev_class;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001590 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001591 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Alan Stern50c4e962014-09-02 11:35:50 -04001592 /*
1593 * Get a default scsi_level from the target (derived from sibling
1594 * devices). This is the best we can do for guessing how to set
1595 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1596 * setting doesn't matter, because all the bits are zero anyway.
1597 * But it does matter for higher LUNs.
1598 */
Alan Stern7c9d6f12007-01-08 11:12:32 -05001599 sdev->scsi_level = starget->scsi_level;
Alan Stern50c4e962014-09-02 11:35:50 -04001600 if (sdev->scsi_level <= SCSI_2 &&
1601 sdev->scsi_level != SCSI_UNKNOWN &&
1602 !shost->no_scsi2_lun_in_cdb)
1603 sdev->lun_in_cdb = 1;
1604
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 transport_setup_device(&sdev->sdev_gendev);
1606 spin_lock_irqsave(shost->host_lock, flags);
1607 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1608 list_add_tail(&sdev->siblings, &shost->__devices);
1609 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomleye63ed0d2014-01-21 07:00:50 -08001610 /*
1611 * device can now only be removed via __scsi_remove_device() so hold
1612 * the target. Target will be held in CREATED state until something
1613 * beneath it becomes visible (in which case it moves to RUNNING)
1614 */
1615 kref_get(&starget->reap_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616}
1617
1618int scsi_is_sdev_device(const struct device *dev)
1619{
Kay Sievers13ba9bc2007-09-26 19:54:49 +02001620 return dev->type == &scsi_dev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621}
1622EXPORT_SYMBOL(scsi_is_sdev_device);
1623
1624/* A blank transport template that is used in drivers that don't
1625 * yet implement Transport Attributes */
1626struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };