blob: 55addd78fde4420ef58bfc9d01c53f28857abbb0 [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;
Ming Leif2b85042021-10-08 13:01:18 +0800447 struct module *mod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
David Howells65f27f32006-11-22 14:55:48 +0000449 sdev = container_of(work, struct scsi_device, ew.work);
450
Ming Leif2b85042021-10-08 13:01:18 +0800451 mod = sdev->host->hostt->module;
452
Junichi Nomura23695e42015-10-06 04:32:57 +0000453 scsi_dh_release_device(sdev);
454
David Howells65f27f32006-11-22 14:55:48 +0000455 parent = sdev->sdev_gendev.parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 spin_lock_irqsave(sdev->host->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 list_del(&sdev->siblings);
459 list_del(&sdev->same_target_siblings);
460 list_del(&sdev->starved_entry);
461 spin_unlock_irqrestore(sdev->host->host_lock, flags);
462
Jeff Garzika341cd02007-10-29 17:15:22 -0400463 cancel_work_sync(&sdev->event_work);
464
465 list_for_each_safe(this, tmp, &sdev->event_list) {
466 struct scsi_event *evt;
467
468 evt = list_entry(this, struct scsi_event, node);
469 list_del(&evt->node);
470 kfree(evt);
471 }
472
James Bottomleye73e0792011-05-25 15:52:14 -0500473 blk_put_queue(sdev->request_queue);
James Bottomley86cbfb52011-04-22 10:39:59 -0500474 /* NULL queue means the device can't be used */
475 sdev->request_queue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Ming Lei020b0f02021-01-22 10:33:17 +0800477 sbitmap_free(&sdev->budget_map);
478
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700479 mutex_lock(&sdev->inquiry_mutex);
Linus Torvaldsef2cc882019-12-02 13:37:02 -0800480 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
481 lockdep_is_held(&sdev->inquiry_mutex));
Paul E. McKenneyc0eaf152019-09-23 15:26:28 -0700482 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
483 lockdep_is_held(&sdev->inquiry_mutex));
484 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
485 lockdep_is_held(&sdev->inquiry_mutex));
Linus Torvaldsef2cc882019-12-02 13:37:02 -0800486 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
487 lockdep_is_held(&sdev->inquiry_mutex));
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700488 mutex_unlock(&sdev->inquiry_mutex);
489
Ryan Attardd188b062019-09-26 11:22:17 -0500490 if (vpd_pg0)
491 kfree_rcu(vpd_pg0, rcu);
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700492 if (vpd_pg83)
493 kfree_rcu(vpd_pg83, rcu);
494 if (vpd_pg80)
495 kfree_rcu(vpd_pg80, rcu);
Ryan Attardd188b062019-09-26 11:22:17 -0500496 if (vpd_pg89)
497 kfree_rcu(vpd_pg89, rcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 kfree(sdev->inquiry);
499 kfree(sdev);
500
501 if (parent)
502 put_device(parent);
Ming Leif2b85042021-10-08 13:01:18 +0800503 module_put(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504}
505
James Bottomley65110b22006-02-14 10:48:46 -0600506static void scsi_device_dev_release(struct device *dev)
507{
James Bottomleyffedb452006-02-23 14:27:18 -0600508 struct scsi_device *sdp = to_scsi_device(dev);
Ming Leif2b85042021-10-08 13:01:18 +0800509
510 /* Set module pointer as NULL in case of module unloading */
511 if (!try_module_get(sdp->host->hostt->module))
512 sdp->host->hostt->module = NULL;
513
David Howells65f27f32006-11-22 14:55:48 +0000514 execute_in_process_context(scsi_device_dev_release_usercontext,
James Bottomleyffedb452006-02-23 14:27:18 -0600515 &sdp->ew);
James Bottomley65110b22006-02-14 10:48:46 -0600516}
517
Adrian Bunk52c1da32005-06-23 22:05:33 -0700518static struct class sdev_class = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 .name = "scsi_device",
Tony Jonesee959b02008-02-22 00:13:36 +0100520 .dev_release = scsi_device_cls_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521};
522
523/* all probing is done in the individual ->probe routines */
524static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
525{
Hannes Reineckeb0ed4332008-03-18 14:32:28 +0100526 struct scsi_device *sdp;
527
528 if (dev->type != &scsi_dev_type)
529 return 0;
530
531 sdp = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 if (sdp->no_uld_attach)
533 return 0;
534 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
535}
536
Kay Sievers7eff2e72007-08-14 15:15:12 +0200537static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400538{
James Bottomley1f42ea72008-05-22 12:34:41 +0100539 struct scsi_device *sdev;
540
541 if (dev->type != &scsi_dev_type)
542 return 0;
543
544 sdev = to_scsi_device(dev);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400545
Kay Sievers7eff2e72007-08-14 15:15:12 +0200546 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400547 return 0;
548}
549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550struct bus_type scsi_bus_type = {
551 .name = "scsi",
552 .match = scsi_bus_match,
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400553 .uevent = scsi_bus_uevent,
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100554#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400555 .pm = &scsi_bus_pm_ops,
Alan Sterne6da54d2010-08-05 13:17:10 -0400556#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557};
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700558EXPORT_SYMBOL_GPL(scsi_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560int scsi_sysfs_register(void)
561{
562 int error;
563
564 error = bus_register(&scsi_bus_type);
565 if (!error) {
566 error = class_register(&sdev_class);
567 if (error)
568 bus_unregister(&scsi_bus_type);
569 }
570
571 return error;
572}
573
574void scsi_sysfs_unregister(void)
575{
576 class_unregister(&sdev_class);
577 bus_unregister(&scsi_bus_type);
578}
579
580/*
581 * sdev_show_function: macro to create an attr function that can be used to
582 * show a non-bit field.
583 */
584#define sdev_show_function(field, format_string) \
585static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100586sdev_show_##field (struct device *dev, struct device_attribute *attr, \
587 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{ \
589 struct scsi_device *sdev; \
590 sdev = to_scsi_device(dev); \
591 return snprintf (buf, 20, format_string, sdev->field); \
592} \
593
594/*
595 * sdev_rd_attr: macro to create a function and attribute variable for a
596 * read only field.
597 */
598#define sdev_rd_attr(field, format_string) \
599 sdev_show_function(field, format_string) \
600static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
601
602
603/*
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900604 * sdev_rw_attr: create a function and attribute variable for a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 * read/write field.
606 */
607#define sdev_rw_attr(field, format_string) \
608 sdev_show_function(field, format_string) \
609 \
610static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100611sdev_store_##field (struct device *dev, struct device_attribute *attr, \
612 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{ \
614 struct scsi_device *sdev; \
615 sdev = to_scsi_device(dev); \
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900616 sscanf (buf, format_string, &sdev->field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 return count; \
618} \
619static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
620
621/* Currently we don't export bit fields, but we might in future,
622 * so leave this code in */
623#if 0
624/*
625 * sdev_rd_attr: create a function and attribute variable for a
626 * read/write bit field.
627 */
628#define sdev_rw_attr_bit(field) \
629 sdev_show_function(field, "%d\n") \
630 \
631static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100632sdev_store_##field (struct device *dev, struct device_attribute *attr, \
633 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{ \
635 int ret; \
636 struct scsi_device *sdev; \
637 ret = scsi_sdev_check_buf_bit(buf); \
638 if (ret >= 0) { \
639 sdev = to_scsi_device(dev); \
640 sdev->field = ret; \
641 ret = count; \
642 } \
643 return ret; \
644} \
645static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
646
647/*
648 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
649 * else return -EINVAL.
650 */
651static int scsi_sdev_check_buf_bit(const char *buf)
652{
653 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
654 if (buf[0] == '1')
655 return 1;
656 else if (buf[0] == '0')
657 return 0;
658 else
659 return -EINVAL;
660 } else
661 return -EINVAL;
662}
663#endif
664/*
665 * Create the actual show/store functions and data structures.
666 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667sdev_rd_attr (type, "%d\n");
668sdev_rd_attr (scsi_level, "%d\n");
669sdev_rd_attr (vendor, "%.8s\n");
670sdev_rd_attr (model, "%.16s\n");
671sdev_rd_attr (rev, "%.4s\n");
672
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200673static ssize_t
674sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
675 char *buf)
676{
677 struct scsi_device *sdev = to_scsi_device(dev);
Ming Lei82788072021-01-22 10:33:15 +0800678 return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200679}
680static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
681
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100682static ssize_t
683sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
684 char *buf)
685{
686 struct scsi_device *sdev = to_scsi_device(dev);
687 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
688}
689static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
690
Jens Axboe242f9dc2008-09-14 05:55:09 -0700691/*
692 * TODO: can we make these symlinks to the block layer ones?
693 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400695sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696{
697 struct scsi_device *sdev;
698 sdev = to_scsi_device(dev);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700699 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
701
702static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100703sdev_store_timeout (struct device *dev, struct device_attribute *attr,
704 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705{
706 struct scsi_device *sdev;
707 int timeout;
708 sdev = to_scsi_device(dev);
709 sscanf (buf, "%d\n", &timeout);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700710 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 return count;
712}
713static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
714
715static ssize_t
Martin K. Petersen0816c922013-05-10 10:36:04 -0400716sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
717{
718 struct scsi_device *sdev;
719 sdev = to_scsi_device(dev);
720 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
721}
722
723static ssize_t
724sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
725 const char *buf, size_t count)
726{
727 struct scsi_device *sdev;
728 unsigned int eh_timeout;
729 int err;
730
731 if (!capable(CAP_SYS_ADMIN))
732 return -EACCES;
733
734 sdev = to_scsi_device(dev);
735 err = kstrtouint(buf, 10, &eh_timeout);
736 if (err)
737 return err;
738 sdev->eh_timeout = eh_timeout * HZ;
739
740 return count;
741}
742static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
743
744static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100745store_rescan_field (struct device *dev, struct device_attribute *attr,
746 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
748 scsi_rescan_device(dev);
749 return count;
750}
751static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
752
Tony Jonesee959b02008-02-22 00:13:36 +0100753static ssize_t
754sdev_store_delete(struct device *dev, struct device_attribute *attr,
755 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700757 struct kernfs_node *kn;
Yufen Yu77c30122019-10-15 21:05:56 +0800758 struct scsi_device *sdev = to_scsi_device(dev);
759
760 /*
761 * We need to try to get module, avoiding the module been removed
762 * during delete.
763 */
764 if (scsi_device_get(sdev))
765 return -ENODEV;
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700766
767 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
768 WARN_ON_ONCE(!kn);
769 /*
770 * Concurrent writes into the "delete" sysfs attribute may trigger
771 * concurrent calls to device_remove_file() and scsi_remove_device().
772 * device_remove_file() handles concurrent removal calls by
773 * serializing these and by ignoring the second and later removal
774 * attempts. Concurrent calls of scsi_remove_device() are
775 * serialized. The second and later calls of scsi_remove_device() are
776 * ignored because the first call of that function changes the device
777 * state into SDEV_DEL.
778 */
779 device_remove_file(dev, attr);
Yufen Yu77c30122019-10-15 21:05:56 +0800780 scsi_remove_device(sdev);
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700781 if (kn)
782 sysfs_unbreak_active_protection(kn);
Yufen Yu77c30122019-10-15 21:05:56 +0800783 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 return count;
785};
786static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
787
788static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100789store_state_field(struct device *dev, struct device_attribute *attr,
790 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700792 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 struct scsi_device *sdev = to_scsi_device(dev);
794 enum scsi_device_state state = 0;
795
Tobias Klauser6391a112006-06-08 22:23:48 -0700796 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 const int len = strlen(sdev_states[i].name);
798 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
799 buf[len] == '\n') {
800 state = sdev_states[i].value;
801 break;
802 }
803 }
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700804 switch (state) {
805 case SDEV_RUNNING:
806 case SDEV_OFFLINE:
807 break;
808 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 return -EINVAL;
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700810 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700812 mutex_lock(&sdev->state_mutex);
813 ret = scsi_device_set_state(sdev, state);
zhengbin70fc0852019-03-22 10:56:46 +0800814 /*
lijinlinf0f82e22021-07-27 11:44:55 +0800815 * If the device state changes to SDEV_RUNNING, we need to
Li Jinlin02c6dcd2021-08-24 10:59:21 +0800816 * run the queue to avoid I/O hang, and rescan the device
817 * to revalidate it. Running the queue first is necessary
818 * because another thread may be waiting inside
819 * blk_mq_freeze_queue_wait() and because that call may be
820 * waiting for pending I/O to finish.
zhengbin70fc0852019-03-22 10:56:46 +0800821 */
lijinlinf0f82e22021-07-27 11:44:55 +0800822 if (ret == 0 && state == SDEV_RUNNING) {
zhengbin70fc0852019-03-22 10:56:46 +0800823 blk_mq_run_hw_queues(sdev->request_queue, true);
Li Jinlin02c6dcd2021-08-24 10:59:21 +0800824 scsi_rescan_device(dev);
lijinlinf0f82e22021-07-27 11:44:55 +0800825 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700826 mutex_unlock(&sdev->state_mutex);
827
828 return ret == 0 ? count : -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
831static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400832show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833{
834 struct scsi_device *sdev = to_scsi_device(dev);
835 const char *name = scsi_device_state_name(sdev->sdev_state);
836
837 if (!name)
838 return -EINVAL;
839
840 return snprintf(buf, 20, "%s\n", name);
841}
842
843static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
844
845static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100846show_queue_type_field(struct device *dev, struct device_attribute *attr,
847 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
849 struct scsi_device *sdev = to_scsi_device(dev);
850 const char *name = "none";
851
Christoph Hellwig609aa222014-10-30 11:54:58 +0100852 if (sdev->simple_tags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 name = "simple";
854
855 return snprintf(buf, 20, "%s\n", name);
856}
857
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100858static ssize_t
859store_queue_type_field(struct device *dev, struct device_attribute *attr,
860 const char *buf, size_t count)
861{
862 struct scsi_device *sdev = to_scsi_device(dev);
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100863
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100864 if (!sdev->tagged_supported)
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100865 return -EINVAL;
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100866
867 sdev_printk(KERN_INFO, sdev,
868 "ignoring write to deprecated queue_type attribute");
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100869 return count;
870}
871
872static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
873 store_queue_type_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100875#define sdev_vpd_pg_attr(_page) \
876static ssize_t \
877show_vpd_##_page(struct file *filp, struct kobject *kobj, \
878 struct bin_attribute *bin_attr, \
879 char *buf, loff_t off, size_t count) \
880{ \
Guosong Su9e7bd9452020-02-25 18:04:11 +0800881 struct device *dev = kobj_to_dev(kobj); \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100882 struct scsi_device *sdev = to_scsi_device(dev); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700883 struct scsi_vpd *vpd_page; \
884 int ret = -EINVAL; \
885 \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100886 rcu_read_lock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700887 vpd_page = rcu_dereference(sdev->vpd_##_page); \
888 if (vpd_page) \
889 ret = memory_read_from_buffer(buf, count, &off, \
890 vpd_page->data, vpd_page->len); \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100891 rcu_read_unlock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700892 return ret; \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100893} \
894static struct bin_attribute dev_attr_vpd_##_page = { \
895 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
896 .size = 0, \
897 .read = show_vpd_##_page, \
898};
899
900sdev_vpd_pg_attr(pg83);
901sdev_vpd_pg_attr(pg80);
Ryan Attardd188b062019-09-26 11:22:17 -0500902sdev_vpd_pg_attr(pg89);
903sdev_vpd_pg_attr(pg0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100905static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
906 struct bin_attribute *bin_attr,
907 char *buf, loff_t off, size_t count)
908{
Guosong Su9e7bd9452020-02-25 18:04:11 +0800909 struct device *dev = kobj_to_dev(kobj);
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100910 struct scsi_device *sdev = to_scsi_device(dev);
911
912 if (!sdev->inquiry)
913 return -EINVAL;
914
915 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
916 sdev->inquiry_len);
917}
918
919static struct bin_attribute dev_attr_inquiry = {
920 .attr = {
921 .name = "inquiry",
922 .mode = S_IRUGO,
923 },
924 .size = 0,
925 .read = show_inquiry,
926};
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928static ssize_t
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100929show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
930 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931{
932 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
933}
934
935static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
936
937#define show_sdev_iostat(field) \
938static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100939show_iostat_##field(struct device *dev, struct device_attribute *attr, \
940 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941{ \
942 struct scsi_device *sdev = to_scsi_device(dev); \
943 unsigned long long count = atomic_read(&sdev->field); \
944 return snprintf(buf, 20, "0x%llx\n", count); \
945} \
946static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
947
948show_sdev_iostat(iorequest_cnt);
949show_sdev_iostat(iodone_cnt);
950show_sdev_iostat(ioerr_cnt);
951
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400952static ssize_t
953sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
954{
955 struct scsi_device *sdev;
956 sdev = to_scsi_device(dev);
957 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
958}
959static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
Jeff Garzika341cd02007-10-29 17:15:22 -0400961#define DECLARE_EVT_SHOW(name, Cap_name) \
962static ssize_t \
963sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
Tony Jonesee959b02008-02-22 00:13:36 +0100964 char *buf) \
Jeff Garzika341cd02007-10-29 17:15:22 -0400965{ \
966 struct scsi_device *sdev = to_scsi_device(dev); \
967 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
968 return snprintf(buf, 20, "%d\n", val); \
969}
970
971#define DECLARE_EVT_STORE(name, Cap_name) \
972static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100973sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
Jeff Garzika341cd02007-10-29 17:15:22 -0400974 const char *buf, size_t count) \
975{ \
976 struct scsi_device *sdev = to_scsi_device(dev); \
977 int val = simple_strtoul(buf, NULL, 0); \
978 if (val == 0) \
979 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
980 else if (val == 1) \
981 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
982 else \
983 return -EINVAL; \
984 return count; \
985}
986
987#define DECLARE_EVT(name, Cap_name) \
988 DECLARE_EVT_SHOW(name, Cap_name) \
989 DECLARE_EVT_STORE(name, Cap_name) \
990 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
991 sdev_store_evt_##name);
992#define REF_EVT(name) &dev_attr_evt_##name.attr
993
994DECLARE_EVT(media_change, MEDIA_CHANGE)
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400995DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
996DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
997DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
998DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
999DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
Jeff Garzika341cd02007-10-29 17:15:22 -04001000
Tony Jonesee959b02008-02-22 00:13:36 +01001001static ssize_t
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001002sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1003 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004{
1005 int depth, retval;
1006 struct scsi_device *sdev = to_scsi_device(dev);
1007 struct scsi_host_template *sht = sdev->host->hostt;
1008
1009 if (!sht->change_queue_depth)
1010 return -EINVAL;
1011
1012 depth = simple_strtoul(buf, NULL, 0);
1013
Jens Axboe1278dd682015-07-13 08:24:39 -06001014 if (depth < 1 || depth > sdev->host->can_queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 return -EINVAL;
1016
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001017 retval = sht->change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 if (retval < 0)
1019 return retval;
1020
Vasu Dev4a840672009-10-22 15:46:33 -07001021 sdev->max_queue_depth = sdev->queue_depth;
1022
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 return count;
1024}
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001025sdev_show_function(queue_depth, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001027static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1028 sdev_store_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001030static ssize_t
1031sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1032 char *buf)
1033{
1034 struct scsi_device *sdev = to_scsi_device(dev);
1035 ssize_t count;
1036
1037 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1038 if (count > 0) {
1039 buf[count] = '\n';
1040 count++;
1041 }
1042 return count;
1043}
1044static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1045
Bart Van Assche093b8882017-12-12 10:23:28 -08001046#define BLIST_FLAG_NAME(name) \
Martin Wilck14098802018-04-18 01:35:08 +02001047 [const_ilog2((__force __u64)BLIST_##name)] = #name
Hannes Reinecke345e2962017-10-02 16:26:34 +02001048static const char *const sdev_bflags_name[] = {
1049#include "scsi_devinfo_tbl.c"
1050};
1051#undef BLIST_FLAG_NAME
1052
1053static ssize_t
1054sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1055 char *buf)
1056{
1057 struct scsi_device *sdev = to_scsi_device(dev);
1058 int i;
1059 ssize_t len = 0;
1060
1061 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1062 const char *name = NULL;
1063
Bart Van Assche093b8882017-12-12 10:23:28 -08001064 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
Hannes Reinecke345e2962017-10-02 16:26:34 +02001065 continue;
1066 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1067 name = sdev_bflags_name[i];
1068
1069 if (name)
Takashi Iwai81546b32020-03-15 10:42:40 +01001070 len += scnprintf(buf + len, PAGE_SIZE - len,
1071 "%s%s", len ? " " : "", name);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001072 else
Takashi Iwai81546b32020-03-15 10:42:40 +01001073 len += scnprintf(buf + len, PAGE_SIZE - len,
1074 "%sINVALID_BIT(%d)", len ? " " : "", i);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001075 }
1076 if (len)
Takashi Iwai81546b32020-03-15 10:42:40 +01001077 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
Hannes Reinecke345e2962017-10-02 16:26:34 +02001078 return len;
1079}
1080static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1081
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001082#ifdef CONFIG_SCSI_DH
1083static ssize_t
1084sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1085 char *buf)
1086{
1087 struct scsi_device *sdev = to_scsi_device(dev);
1088
1089 if (!sdev->handler)
1090 return snprintf(buf, 20, "detached\n");
1091
1092 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1093}
1094
1095static ssize_t
1096sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1097 const char *buf, size_t count)
1098{
1099 struct scsi_device *sdev = to_scsi_device(dev);
1100 int err = -EINVAL;
1101
1102 if (sdev->sdev_state == SDEV_CANCEL ||
1103 sdev->sdev_state == SDEV_DEL)
1104 return -ENODEV;
1105
1106 if (!sdev->handler) {
1107 /*
1108 * Attach to a device handler
1109 */
1110 err = scsi_dh_attach(sdev->request_queue, buf);
1111 } else if (!strncmp(buf, "activate", 8)) {
1112 /*
1113 * Activate a device handler
1114 */
1115 if (sdev->handler->activate)
1116 err = sdev->handler->activate(sdev, NULL, NULL);
1117 else
1118 err = 0;
1119 } else if (!strncmp(buf, "detach", 6)) {
1120 /*
1121 * Detach from a device handler
1122 */
1123 sdev_printk(KERN_WARNING, sdev,
1124 "can't detach handler %s.\n",
1125 sdev->handler->name);
1126 err = -EINVAL;
1127 }
1128
1129 return err < 0 ? err : count;
1130}
1131
1132static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1133 sdev_store_dh_state);
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001134
1135static ssize_t
1136sdev_show_access_state(struct device *dev,
1137 struct device_attribute *attr,
1138 char *buf)
1139{
1140 struct scsi_device *sdev = to_scsi_device(dev);
1141 unsigned char access_state;
1142 const char *access_state_name;
1143
1144 if (!sdev->handler)
1145 return -EINVAL;
1146
1147 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1148 access_state_name = scsi_access_state_name(access_state);
1149
1150 return sprintf(buf, "%s\n",
1151 access_state_name ? access_state_name : "unknown");
1152}
1153static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1154
1155static ssize_t
1156sdev_show_preferred_path(struct device *dev,
1157 struct device_attribute *attr,
1158 char *buf)
1159{
1160 struct scsi_device *sdev = to_scsi_device(dev);
1161
1162 if (!sdev->handler)
1163 return -EINVAL;
1164
1165 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1166 return sprintf(buf, "1\n");
1167 else
1168 return sprintf(buf, "0\n");
1169}
1170static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001171#endif
1172
Tony Jonesee959b02008-02-22 00:13:36 +01001173static ssize_t
Vasu Dev4a840672009-10-22 15:46:33 -07001174sdev_show_queue_ramp_up_period(struct device *dev,
1175 struct device_attribute *attr,
1176 char *buf)
1177{
1178 struct scsi_device *sdev;
1179 sdev = to_scsi_device(dev);
1180 return snprintf(buf, 20, "%u\n",
1181 jiffies_to_msecs(sdev->queue_ramp_up_period));
1182}
1183
1184static ssize_t
1185sdev_store_queue_ramp_up_period(struct device *dev,
1186 struct device_attribute *attr,
1187 const char *buf, size_t count)
1188{
1189 struct scsi_device *sdev = to_scsi_device(dev);
Daniel Walterf7c65af2014-08-08 14:24:05 -07001190 unsigned int period;
Vasu Dev4a840672009-10-22 15:46:33 -07001191
Daniel Walterf7c65af2014-08-08 14:24:05 -07001192 if (kstrtouint(buf, 10, &period))
Vasu Dev4a840672009-10-22 15:46:33 -07001193 return -EINVAL;
1194
1195 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
Peter Oberparleiter5cb9b402015-10-26 15:54:23 +01001196 return count;
Vasu Dev4a840672009-10-22 15:46:33 -07001197}
1198
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001199static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1200 sdev_show_queue_ramp_up_period,
1201 sdev_store_queue_ramp_up_period);
Vasu Dev4a840672009-10-22 15:46:33 -07001202
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001203static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1204 struct attribute *attr, int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001206 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 struct scsi_device *sdev = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001210 if (attr == &dev_attr_queue_depth.attr &&
1211 !sdev->host->hostt->change_queue_depth)
1212 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001214 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1215 !sdev->host->hostt->change_queue_depth)
1216 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001218#ifdef CONFIG_SCSI_DH
1219 if (attr == &dev_attr_access_state.attr &&
1220 !sdev->handler)
1221 return 0;
1222 if (attr == &dev_attr_preferred_path.attr &&
1223 !sdev->handler)
1224 return 0;
1225#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001226 return attr->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227}
1228
Hannes Reinecke7e479762016-03-03 07:41:24 +01001229static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1230 struct bin_attribute *attr, int i)
1231{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001232 struct device *dev = kobj_to_dev(kobj);
Hannes Reinecke7e479762016-03-03 07:41:24 +01001233 struct scsi_device *sdev = to_scsi_device(dev);
1234
1235
Ryan Attardd188b062019-09-26 11:22:17 -05001236 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1237 return 0;
1238
Hannes Reinecke7e479762016-03-03 07:41:24 +01001239 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1240 return 0;
1241
Hannes Reinecke68887582016-03-10 11:25:26 +01001242 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
Hannes Reinecke7e479762016-03-03 07:41:24 +01001243 return 0;
1244
Ryan Attardd188b062019-09-26 11:22:17 -05001245 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1246 return 0;
1247
Hannes Reinecke7e479762016-03-03 07:41:24 +01001248 return S_IRUGO;
1249}
1250
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001251/* Default template for device attributes. May NOT be modified */
1252static struct attribute *scsi_sdev_attrs[] = {
1253 &dev_attr_device_blocked.attr,
1254 &dev_attr_type.attr,
1255 &dev_attr_scsi_level.attr,
1256 &dev_attr_device_busy.attr,
1257 &dev_attr_vendor.attr,
1258 &dev_attr_model.attr,
1259 &dev_attr_rev.attr,
1260 &dev_attr_rescan.attr,
1261 &dev_attr_delete.attr,
1262 &dev_attr_state.attr,
1263 &dev_attr_timeout.attr,
1264 &dev_attr_eh_timeout.attr,
1265 &dev_attr_iocounterbits.attr,
1266 &dev_attr_iorequest_cnt.attr,
1267 &dev_attr_iodone_cnt.attr,
1268 &dev_attr_ioerr_cnt.attr,
1269 &dev_attr_modalias.attr,
1270 &dev_attr_queue_depth.attr,
1271 &dev_attr_queue_type.attr,
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001272 &dev_attr_wwid.attr,
Hannes Reinecke345e2962017-10-02 16:26:34 +02001273 &dev_attr_blacklist.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001274#ifdef CONFIG_SCSI_DH
1275 &dev_attr_dh_state.attr,
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001276 &dev_attr_access_state.attr,
1277 &dev_attr_preferred_path.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001278#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001279 &dev_attr_queue_ramp_up_period.attr,
1280 REF_EVT(media_change),
1281 REF_EVT(inquiry_change_reported),
1282 REF_EVT(capacity_change_reported),
1283 REF_EVT(soft_threshold_reached),
1284 REF_EVT(mode_parameter_change_reported),
1285 REF_EVT(lun_change_reported),
1286 NULL
1287};
1288
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001289static struct bin_attribute *scsi_sdev_bin_attrs[] = {
Ryan Attardd188b062019-09-26 11:22:17 -05001290 &dev_attr_vpd_pg0,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001291 &dev_attr_vpd_pg83,
1292 &dev_attr_vpd_pg80,
Ryan Attardd188b062019-09-26 11:22:17 -05001293 &dev_attr_vpd_pg89,
Johannes Thumshirn92e62462015-11-09 10:56:57 +01001294 &dev_attr_inquiry,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001295 NULL
1296};
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001297static struct attribute_group scsi_sdev_attr_group = {
1298 .attrs = scsi_sdev_attrs,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001299 .bin_attrs = scsi_sdev_bin_attrs,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001300 .is_visible = scsi_sdev_attr_is_visible,
Hannes Reinecke7e479762016-03-03 07:41:24 +01001301 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001302};
1303
1304static const struct attribute_group *scsi_sdev_attr_groups[] = {
1305 &scsi_sdev_attr_group,
1306 NULL
1307};
1308
James Bottomley643eb2d2008-03-22 22:42:27 -05001309static int scsi_target_add(struct scsi_target *starget)
1310{
1311 int error;
1312
1313 if (starget->state != STARGET_CREATED)
1314 return 0;
1315
1316 error = device_add(&starget->dev);
1317 if (error) {
1318 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
James Bottomley643eb2d2008-03-22 22:42:27 -05001319 return error;
1320 }
1321 transport_add_device(&starget->dev);
1322 starget->state = STARGET_RUNNING;
1323
Alan Sternbc4f2402010-06-17 10:41:42 -04001324 pm_runtime_set_active(&starget->dev);
1325 pm_runtime_enable(&starget->dev);
1326 device_enable_async_suspend(&starget->dev);
1327
James Bottomley643eb2d2008-03-22 22:42:27 -05001328 return 0;
1329}
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331/**
1332 * scsi_sysfs_add_sdev - add scsi device to sysfs
1333 * @sdev: scsi_device to add
1334 *
1335 * Return value:
1336 * 0 on Success / non-zero on Failure
1337 **/
1338int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1339{
Bart Van Assche92c4b582021-10-12 16:35:13 -07001340 int error;
James Bottomley643eb2d2008-03-22 22:42:27 -05001341 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
James Bottomley643eb2d2008-03-22 22:42:27 -05001343 error = scsi_target_add(starget);
1344 if (error)
1345 return error;
1346
1347 transport_configure_device(&starget->dev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001348
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001349 device_enable_async_suspend(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001350 scsi_autopm_get_target(starget);
1351 pm_runtime_set_active(&sdev->sdev_gendev);
Stanley Chuc74f8052019-09-16 23:56:49 +08001352 if (!sdev->rpm_autosuspend)
1353 pm_runtime_forbid(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001354 pm_runtime_enable(&sdev->sdev_gendev);
1355 scsi_autopm_put_target(starget);
1356
Alan Sternbc4f2402010-06-17 10:41:42 -04001357 scsi_autopm_get_device(sdev);
1358
Hannes Reinecke2930f812017-09-20 09:18:52 +02001359 scsi_dh_add_device(sdev);
Christoph Hellwig086b91d2015-08-27 14:16:57 +02001360
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001361 error = device_add(&sdev->sdev_gendev);
1362 if (error) {
1363 sdev_printk(KERN_INFO, sdev,
1364 "failed to add device: %d\n", error);
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001365 return error;
1366 }
1367
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001368 device_enable_async_suspend(&sdev->sdev_dev);
Tony Jonesee959b02008-02-22 00:13:36 +01001369 error = device_add(&sdev->sdev_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001371 sdev_printk(KERN_INFO, sdev,
1372 "failed to add class device: %d\n", error);
James Bottomley860dc732009-11-19 17:48:29 -05001373 device_del(&sdev->sdev_gendev);
Alan Sternee37e092010-02-12 12:13:55 -05001374 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 }
James Bottomley860dc732009-11-19 17:48:29 -05001376 transport_add_device(&sdev->sdev_gendev);
1377 sdev->is_visible = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001379 if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1380 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1381 if (IS_ERR(sdev->bsg_dev)) {
1382 /*
1383 * We're treating error on bsg register as non-fatal, so
1384 * pretend nothing went wrong.
1385 */
Jackie Liu5f7cf822021-10-22 09:02:01 +08001386 error = PTR_ERR(sdev->bsg_dev);
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001387 sdev_printk(KERN_INFO, sdev,
1388 "Failed to register bsg queue, errno=%d\n",
1389 error);
1390 sdev->bsg_dev = NULL;
1391 }
1392 }
James Bottomley80ed71c2007-07-19 10:15:10 -05001393
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03001394 scsi_autopm_put_device(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396}
1397
Alan Stern903f4fed2005-07-26 10:20:53 -04001398void __scsi_remove_device(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399{
James Bottomleydf133c22005-11-06 11:47:08 -06001400 struct device *dev = &sdev->sdev_gendev;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001401 int res;
James Bottomleydf133c22005-11-06 11:47:08 -06001402
Vitaly Kuznetsovbe821fd2015-11-19 14:02:19 +01001403 /*
1404 * This cleanup path is not reentrant and while it is impossible
1405 * to get a new reference with scsi_device_get() someone can still
1406 * hold a previously acquired one.
1407 */
1408 if (sdev->sdev_state == SDEV_DEL)
1409 return;
1410
James Bottomley860dc732009-11-19 17:48:29 -05001411 if (sdev->is_visible) {
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001412 /*
1413 * If scsi_internal_target_block() is running concurrently,
1414 * wait until it has finished before changing the device state.
1415 */
1416 mutex_lock(&sdev->state_mutex);
Bart Van Assche255ee932017-06-02 14:21:57 -07001417 /*
1418 * If blocked, we go straight to DEL and restart the queue so
1419 * any commands issued during driver shutdown (like sync
1420 * cache) are errored immediately.
1421 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001422 res = scsi_device_set_state(sdev, SDEV_CANCEL);
Bart Van Assche255ee932017-06-02 14:21:57 -07001423 if (res != 0) {
1424 res = scsi_device_set_state(sdev, SDEV_DEL);
1425 if (res == 0)
1426 scsi_start_queue(sdev);
1427 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001428 mutex_unlock(&sdev->state_mutex);
1429
1430 if (res != 0)
James Bottomley860dc732009-11-19 17:48:29 -05001431 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001433 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1434 bsg_unregister_queue(sdev->bsg_dev);
James Bottomley860dc732009-11-19 17:48:29 -05001435 device_unregister(&sdev->sdev_dev);
1436 transport_remove_device(dev);
Bart Van Asschee619e6c2015-11-20 14:11:01 -08001437 device_del(dev);
1438 } else
1439 put_device(&sdev->sdev_dev);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001440
1441 /*
1442 * Stop accepting new requests and wait until all queuecommand() and
1443 * scsi_run_queue() invocations have finished before tearing down the
1444 * device.
1445 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001446 mutex_lock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 scsi_device_set_state(sdev, SDEV_DEL);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001448 mutex_unlock(&sdev->state_mutex);
1449
Bart Van Asscheb4854622012-06-29 15:36:07 +00001450 blk_cleanup_queue(sdev->request_queue);
1451 cancel_work_sync(&sdev->requeue_work);
1452
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 if (sdev->host->hostt->slave_destroy)
1454 sdev->host->hostt->slave_destroy(sdev);
James Bottomleydf133c22005-11-06 11:47:08 -06001455 transport_destroy_device(dev);
James Bottomley86cbfb52011-04-22 10:39:59 -05001456
James Bottomleye63ed0d2014-01-21 07:00:50 -08001457 /*
1458 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
dudengkeeee89102021-03-26 14:09:02 +08001459 * removed sysfs visibility from the device, so make the target
James Bottomleye63ed0d2014-01-21 07:00:50 -08001460 * invisible if this was the last device underneath it.
1461 */
1462 scsi_target_reap(scsi_target(sdev));
1463
James Bottomleydf133c22005-11-06 11:47:08 -06001464 put_device(dev);
Alan Stern903f4fed2005-07-26 10:20:53 -04001465}
1466
1467/**
1468 * scsi_remove_device - unregister a device from the scsi bus
1469 * @sdev: scsi_device to unregister
1470 **/
1471void scsi_remove_device(struct scsi_device *sdev)
1472{
Alan Stern54195002005-09-15 21:52:51 -04001473 struct Scsi_Host *shost = sdev->host;
1474
Arjan van de Ven0b950672006-01-11 13:16:10 +01001475 mutex_lock(&shost->scan_mutex);
Alan Stern903f4fed2005-07-26 10:20:53 -04001476 __scsi_remove_device(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01001477 mutex_unlock(&shost->scan_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478}
1479EXPORT_SYMBOL(scsi_remove_device);
1480
Adrian Bunk44818ef2007-07-09 11:59:59 -07001481static void __scsi_remove_target(struct scsi_target *starget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482{
1483 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1484 unsigned long flags;
Alan Sterna64358d2005-07-26 10:27:10 -04001485 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
1487 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001488 restart:
1489 list_for_each_entry(sdev, &shost->__devices, siblings) {
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001490 /*
1491 * We cannot call scsi_device_get() here, as
1492 * we might've been called from rmmod() causing
1493 * scsi_device_get() to fail the module_is_live()
1494 * check.
1495 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 if (sdev->channel != starget->channel ||
Hannes Reinecke81b6c992017-12-13 14:21:37 +01001497 sdev->id != starget->id)
1498 continue;
1499 if (sdev->sdev_state == SDEV_DEL ||
1500 sdev->sdev_state == SDEV_CANCEL ||
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001501 !get_device(&sdev->sdev_gendev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 continue;
1503 spin_unlock_irqrestore(shost->host_lock, flags);
1504 scsi_remove_device(sdev);
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001505 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001507 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 }
1509 spin_unlock_irqrestore(shost->host_lock, flags);
mochel@digitalimplant.org20b1e672005-03-24 19:03:59 -08001510}
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512/**
1513 * scsi_remove_target - try to remove a target and all its devices
1514 * @dev: generic starget or parent of generic stargets to be removed
1515 *
1516 * Note: This is slightly racy. It is possible that if the user
1517 * requests the addition of another device then the target won't be
1518 * removed.
1519 */
1520void scsi_remove_target(struct device *dev)
1521{
Dan Williams3b661a92012-06-21 23:47:28 -07001522 struct Scsi_Host *shost = dev_to_shost(dev->parent);
Johannes Thumshirn305c2e72016-04-05 11:50:45 +02001523 struct scsi_target *starget;
Dan Williams3b661a92012-06-21 23:47:28 -07001524 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
Christoph Hellwig40998192015-10-19 16:35:46 +02001526restart:
Dan Williams3b661a92012-06-21 23:47:28 -07001527 spin_lock_irqsave(shost->host_lock, flags);
1528 list_for_each_entry(starget, &shost->__targets, siblings) {
James Bottomley90a88d62016-02-10 08:03:26 -08001529 if (starget->state == STARGET_DEL ||
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001530 starget->state == STARGET_REMOVE ||
1531 starget->state == STARGET_CREATED_REMOVE)
Dan Williams3b661a92012-06-21 23:47:28 -07001532 continue;
1533 if (starget->dev.parent == dev || &starget->dev == dev) {
James Bottomleye63ed0d2014-01-21 07:00:50 -08001534 kref_get(&starget->reap_ref);
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001535 if (starget->state == STARGET_CREATED)
1536 starget->state = STARGET_CREATED_REMOVE;
1537 else
1538 starget->state = STARGET_REMOVE;
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001539 spin_unlock_irqrestore(shost->host_lock, flags);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001540 __scsi_remove_target(starget);
Christoph Hellwig40998192015-10-19 16:35:46 +02001541 scsi_target_reap(starget);
1542 goto restart;
Dan Williams3b661a92012-06-21 23:47:28 -07001543 }
1544 }
1545 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546}
1547EXPORT_SYMBOL(scsi_remove_target);
1548
1549int scsi_register_driver(struct device_driver *drv)
1550{
1551 drv->bus = &scsi_bus_type;
1552
1553 return driver_register(drv);
1554}
1555EXPORT_SYMBOL(scsi_register_driver);
1556
1557int scsi_register_interface(struct class_interface *intf)
1558{
1559 intf->class = &sdev_class;
1560
1561 return class_interface_register(intf);
1562}
1563EXPORT_SYMBOL(scsi_register_interface);
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565/**
1566 * scsi_sysfs_add_host - add scsi host to subsystem
1567 * @shost: scsi host struct to add to subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 **/
1569int scsi_sysfs_add_host(struct Scsi_Host *shost)
1570{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 transport_register_device(&shost->shost_gendev);
James Bottomleyd52b3812008-01-05 09:38:30 -06001572 transport_configure_device(&shost->shost_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 return 0;
1574}
1575
Kay Sieversbfd12942007-09-11 17:00:14 +02001576static struct device_type scsi_dev_type = {
1577 .name = "scsi_device",
1578 .release = scsi_device_dev_release,
1579 .groups = scsi_sdev_attr_groups,
1580};
1581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1583{
1584 unsigned long flags;
1585 struct Scsi_Host *shost = sdev->host;
Bart Van Assche92c4b582021-10-12 16:35:13 -07001586 struct scsi_host_template *hostt = shost->hostt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 struct scsi_target *starget = sdev->sdev_target;
1588
1589 device_initialize(&sdev->sdev_gendev);
1590 sdev->sdev_gendev.bus = &scsi_bus_type;
Kay Sieversbfd12942007-09-11 17:00:14 +02001591 sdev->sdev_gendev.type = &scsi_dev_type;
Bart Van Asschea19a93e2021-10-06 14:54:51 -07001592 scsi_enable_async_suspend(&sdev->sdev_gendev);
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001593 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001594 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Steffen Maier3a71f0f2021-10-26 03:42:40 +02001595 sdev->sdev_gendev.groups = hostt->sdev_groups;
Kay Sievers71610f52008-12-03 22:41:36 +01001596
Tony Jonesee959b02008-02-22 00:13:36 +01001597 device_initialize(&sdev->sdev_dev);
James Bottomley37e6ba02009-10-02 13:30:08 -05001598 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
Tony Jonesee959b02008-02-22 00:13:36 +01001599 sdev->sdev_dev.class = &sdev_class;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001600 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001601 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Alan Stern50c4e962014-09-02 11:35:50 -04001602 /*
1603 * Get a default scsi_level from the target (derived from sibling
1604 * devices). This is the best we can do for guessing how to set
1605 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1606 * setting doesn't matter, because all the bits are zero anyway.
1607 * But it does matter for higher LUNs.
1608 */
Alan Stern7c9d6f12007-01-08 11:12:32 -05001609 sdev->scsi_level = starget->scsi_level;
Alan Stern50c4e962014-09-02 11:35:50 -04001610 if (sdev->scsi_level <= SCSI_2 &&
1611 sdev->scsi_level != SCSI_UNKNOWN &&
1612 !shost->no_scsi2_lun_in_cdb)
1613 sdev->lun_in_cdb = 1;
1614
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 transport_setup_device(&sdev->sdev_gendev);
1616 spin_lock_irqsave(shost->host_lock, flags);
1617 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1618 list_add_tail(&sdev->siblings, &shost->__devices);
1619 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomleye63ed0d2014-01-21 07:00:50 -08001620 /*
1621 * device can now only be removed via __scsi_remove_device() so hold
1622 * the target. Target will be held in CREATED state until something
1623 * beneath it becomes visible (in which case it moves to RUNNING)
1624 */
1625 kref_get(&starget->reap_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626}
1627
1628int scsi_is_sdev_device(const struct device *dev)
1629{
Kay Sievers13ba9bc2007-09-26 19:54:49 +02001630 return dev->type == &scsi_dev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631}
1632EXPORT_SYMBOL(scsi_is_sdev_device);
1633
1634/* A blank transport template that is used in drivers that don't
1635 * yet implement Transport Attributes */
1636struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };