blob: 7afcec250f9b5a909f0857a9f6b3d0a9a1b464e9 [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;
Mike Christie4edd8cd2021-11-05 17:10:48 -0500795 bool rescan_dev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Tobias Klauser6391a112006-06-08 22:23:48 -0700797 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 const int len = strlen(sdev_states[i].name);
799 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
800 buf[len] == '\n') {
801 state = sdev_states[i].value;
802 break;
803 }
804 }
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700805 switch (state) {
806 case SDEV_RUNNING:
807 case SDEV_OFFLINE:
808 break;
809 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 return -EINVAL;
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700811 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700813 mutex_lock(&sdev->state_mutex);
Mike Christie4edd8cd2021-11-05 17:10:48 -0500814 if (sdev->sdev_state == SDEV_RUNNING && state == SDEV_RUNNING) {
815 ret = count;
816 } else {
817 ret = scsi_device_set_state(sdev, state);
818 if (ret == 0 && state == SDEV_RUNNING)
819 rescan_dev = true;
820 }
821 mutex_unlock(&sdev->state_mutex);
822
823 if (rescan_dev) {
824 /*
825 * If the device state changes to SDEV_RUNNING, we need to
826 * run the queue to avoid I/O hang, and rescan the device
827 * to revalidate it. Running the queue first is necessary
828 * because another thread may be waiting inside
829 * blk_mq_freeze_queue_wait() and because that call may be
830 * waiting for pending I/O to finish.
831 */
zhengbin70fc0852019-03-22 10:56:46 +0800832 blk_mq_run_hw_queues(sdev->request_queue, true);
Li Jinlin02c6dcd2021-08-24 10:59:21 +0800833 scsi_rescan_device(dev);
lijinlinf0f82e22021-07-27 11:44:55 +0800834 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700835
836 return ret == 0 ? count : -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837}
838
839static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400840show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
842 struct scsi_device *sdev = to_scsi_device(dev);
843 const char *name = scsi_device_state_name(sdev->sdev_state);
844
845 if (!name)
846 return -EINVAL;
847
848 return snprintf(buf, 20, "%s\n", name);
849}
850
851static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
852
853static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100854show_queue_type_field(struct device *dev, struct device_attribute *attr,
855 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856{
857 struct scsi_device *sdev = to_scsi_device(dev);
858 const char *name = "none";
859
Christoph Hellwig609aa222014-10-30 11:54:58 +0100860 if (sdev->simple_tags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 name = "simple";
862
863 return snprintf(buf, 20, "%s\n", name);
864}
865
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100866static ssize_t
867store_queue_type_field(struct device *dev, struct device_attribute *attr,
868 const char *buf, size_t count)
869{
870 struct scsi_device *sdev = to_scsi_device(dev);
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100871
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100872 if (!sdev->tagged_supported)
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100873 return -EINVAL;
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100874
875 sdev_printk(KERN_INFO, sdev,
876 "ignoring write to deprecated queue_type attribute");
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100877 return count;
878}
879
880static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
881 store_queue_type_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100883#define sdev_vpd_pg_attr(_page) \
884static ssize_t \
885show_vpd_##_page(struct file *filp, struct kobject *kobj, \
886 struct bin_attribute *bin_attr, \
887 char *buf, loff_t off, size_t count) \
888{ \
Guosong Su9e7bd9452020-02-25 18:04:11 +0800889 struct device *dev = kobj_to_dev(kobj); \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100890 struct scsi_device *sdev = to_scsi_device(dev); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700891 struct scsi_vpd *vpd_page; \
892 int ret = -EINVAL; \
893 \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100894 rcu_read_lock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700895 vpd_page = rcu_dereference(sdev->vpd_##_page); \
896 if (vpd_page) \
897 ret = memory_read_from_buffer(buf, count, &off, \
898 vpd_page->data, vpd_page->len); \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100899 rcu_read_unlock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700900 return ret; \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100901} \
902static struct bin_attribute dev_attr_vpd_##_page = { \
903 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
904 .size = 0, \
905 .read = show_vpd_##_page, \
906};
907
908sdev_vpd_pg_attr(pg83);
909sdev_vpd_pg_attr(pg80);
Ryan Attardd188b062019-09-26 11:22:17 -0500910sdev_vpd_pg_attr(pg89);
911sdev_vpd_pg_attr(pg0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100913static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
914 struct bin_attribute *bin_attr,
915 char *buf, loff_t off, size_t count)
916{
Guosong Su9e7bd9452020-02-25 18:04:11 +0800917 struct device *dev = kobj_to_dev(kobj);
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100918 struct scsi_device *sdev = to_scsi_device(dev);
919
920 if (!sdev->inquiry)
921 return -EINVAL;
922
923 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
924 sdev->inquiry_len);
925}
926
927static struct bin_attribute dev_attr_inquiry = {
928 .attr = {
929 .name = "inquiry",
930 .mode = S_IRUGO,
931 },
932 .size = 0,
933 .read = show_inquiry,
934};
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936static ssize_t
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100937show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
938 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
940 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
941}
942
943static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
944
945#define show_sdev_iostat(field) \
946static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100947show_iostat_##field(struct device *dev, struct device_attribute *attr, \
948 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949{ \
950 struct scsi_device *sdev = to_scsi_device(dev); \
951 unsigned long long count = atomic_read(&sdev->field); \
952 return snprintf(buf, 20, "0x%llx\n", count); \
953} \
954static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
955
956show_sdev_iostat(iorequest_cnt);
957show_sdev_iostat(iodone_cnt);
958show_sdev_iostat(ioerr_cnt);
959
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400960static ssize_t
961sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
962{
963 struct scsi_device *sdev;
964 sdev = to_scsi_device(dev);
965 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
966}
967static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
Jeff Garzika341cd02007-10-29 17:15:22 -0400969#define DECLARE_EVT_SHOW(name, Cap_name) \
970static ssize_t \
971sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
Tony Jonesee959b02008-02-22 00:13:36 +0100972 char *buf) \
Jeff Garzika341cd02007-10-29 17:15:22 -0400973{ \
974 struct scsi_device *sdev = to_scsi_device(dev); \
975 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
976 return snprintf(buf, 20, "%d\n", val); \
977}
978
979#define DECLARE_EVT_STORE(name, Cap_name) \
980static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100981sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
Jeff Garzika341cd02007-10-29 17:15:22 -0400982 const char *buf, size_t count) \
983{ \
984 struct scsi_device *sdev = to_scsi_device(dev); \
985 int val = simple_strtoul(buf, NULL, 0); \
986 if (val == 0) \
987 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
988 else if (val == 1) \
989 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
990 else \
991 return -EINVAL; \
992 return count; \
993}
994
995#define DECLARE_EVT(name, Cap_name) \
996 DECLARE_EVT_SHOW(name, Cap_name) \
997 DECLARE_EVT_STORE(name, Cap_name) \
998 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
999 sdev_store_evt_##name);
1000#define REF_EVT(name) &dev_attr_evt_##name.attr
1001
1002DECLARE_EVT(media_change, MEDIA_CHANGE)
Ewan D. Milne279afdf2013-08-08 15:07:48 -04001003DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1004DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1005DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1006DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1007DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
Jeff Garzika341cd02007-10-29 17:15:22 -04001008
Tony Jonesee959b02008-02-22 00:13:36 +01001009static ssize_t
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001010sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1011 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012{
1013 int depth, retval;
1014 struct scsi_device *sdev = to_scsi_device(dev);
1015 struct scsi_host_template *sht = sdev->host->hostt;
1016
1017 if (!sht->change_queue_depth)
1018 return -EINVAL;
1019
1020 depth = simple_strtoul(buf, NULL, 0);
1021
Jens Axboe1278dd682015-07-13 08:24:39 -06001022 if (depth < 1 || depth > sdev->host->can_queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 return -EINVAL;
1024
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001025 retval = sht->change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 if (retval < 0)
1027 return retval;
1028
Vasu Dev4a840672009-10-22 15:46:33 -07001029 sdev->max_queue_depth = sdev->queue_depth;
1030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 return count;
1032}
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001033sdev_show_function(queue_depth, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001035static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1036 sdev_store_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001038static ssize_t
1039sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1040 char *buf)
1041{
1042 struct scsi_device *sdev = to_scsi_device(dev);
1043 ssize_t count;
1044
1045 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1046 if (count > 0) {
1047 buf[count] = '\n';
1048 count++;
1049 }
1050 return count;
1051}
1052static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1053
Bart Van Assche093b8882017-12-12 10:23:28 -08001054#define BLIST_FLAG_NAME(name) \
Martin Wilck14098802018-04-18 01:35:08 +02001055 [const_ilog2((__force __u64)BLIST_##name)] = #name
Hannes Reinecke345e2962017-10-02 16:26:34 +02001056static const char *const sdev_bflags_name[] = {
1057#include "scsi_devinfo_tbl.c"
1058};
1059#undef BLIST_FLAG_NAME
1060
1061static ssize_t
1062sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1063 char *buf)
1064{
1065 struct scsi_device *sdev = to_scsi_device(dev);
1066 int i;
1067 ssize_t len = 0;
1068
1069 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1070 const char *name = NULL;
1071
Bart Van Assche093b8882017-12-12 10:23:28 -08001072 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
Hannes Reinecke345e2962017-10-02 16:26:34 +02001073 continue;
1074 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1075 name = sdev_bflags_name[i];
1076
1077 if (name)
Takashi Iwai81546b32020-03-15 10:42:40 +01001078 len += scnprintf(buf + len, PAGE_SIZE - len,
1079 "%s%s", len ? " " : "", name);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001080 else
Takashi Iwai81546b32020-03-15 10:42:40 +01001081 len += scnprintf(buf + len, PAGE_SIZE - len,
1082 "%sINVALID_BIT(%d)", len ? " " : "", i);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001083 }
1084 if (len)
Takashi Iwai81546b32020-03-15 10:42:40 +01001085 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
Hannes Reinecke345e2962017-10-02 16:26:34 +02001086 return len;
1087}
1088static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1089
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001090#ifdef CONFIG_SCSI_DH
1091static ssize_t
1092sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1093 char *buf)
1094{
1095 struct scsi_device *sdev = to_scsi_device(dev);
1096
1097 if (!sdev->handler)
1098 return snprintf(buf, 20, "detached\n");
1099
1100 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1101}
1102
1103static ssize_t
1104sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1105 const char *buf, size_t count)
1106{
1107 struct scsi_device *sdev = to_scsi_device(dev);
1108 int err = -EINVAL;
1109
1110 if (sdev->sdev_state == SDEV_CANCEL ||
1111 sdev->sdev_state == SDEV_DEL)
1112 return -ENODEV;
1113
1114 if (!sdev->handler) {
1115 /*
1116 * Attach to a device handler
1117 */
1118 err = scsi_dh_attach(sdev->request_queue, buf);
1119 } else if (!strncmp(buf, "activate", 8)) {
1120 /*
1121 * Activate a device handler
1122 */
1123 if (sdev->handler->activate)
1124 err = sdev->handler->activate(sdev, NULL, NULL);
1125 else
1126 err = 0;
1127 } else if (!strncmp(buf, "detach", 6)) {
1128 /*
1129 * Detach from a device handler
1130 */
1131 sdev_printk(KERN_WARNING, sdev,
1132 "can't detach handler %s.\n",
1133 sdev->handler->name);
1134 err = -EINVAL;
1135 }
1136
1137 return err < 0 ? err : count;
1138}
1139
1140static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1141 sdev_store_dh_state);
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001142
1143static ssize_t
1144sdev_show_access_state(struct device *dev,
1145 struct device_attribute *attr,
1146 char *buf)
1147{
1148 struct scsi_device *sdev = to_scsi_device(dev);
1149 unsigned char access_state;
1150 const char *access_state_name;
1151
1152 if (!sdev->handler)
1153 return -EINVAL;
1154
1155 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1156 access_state_name = scsi_access_state_name(access_state);
1157
1158 return sprintf(buf, "%s\n",
1159 access_state_name ? access_state_name : "unknown");
1160}
1161static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1162
1163static ssize_t
1164sdev_show_preferred_path(struct device *dev,
1165 struct device_attribute *attr,
1166 char *buf)
1167{
1168 struct scsi_device *sdev = to_scsi_device(dev);
1169
1170 if (!sdev->handler)
1171 return -EINVAL;
1172
1173 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1174 return sprintf(buf, "1\n");
1175 else
1176 return sprintf(buf, "0\n");
1177}
1178static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001179#endif
1180
Tony Jonesee959b02008-02-22 00:13:36 +01001181static ssize_t
Vasu Dev4a840672009-10-22 15:46:33 -07001182sdev_show_queue_ramp_up_period(struct device *dev,
1183 struct device_attribute *attr,
1184 char *buf)
1185{
1186 struct scsi_device *sdev;
1187 sdev = to_scsi_device(dev);
1188 return snprintf(buf, 20, "%u\n",
1189 jiffies_to_msecs(sdev->queue_ramp_up_period));
1190}
1191
1192static ssize_t
1193sdev_store_queue_ramp_up_period(struct device *dev,
1194 struct device_attribute *attr,
1195 const char *buf, size_t count)
1196{
1197 struct scsi_device *sdev = to_scsi_device(dev);
Daniel Walterf7c65af2014-08-08 14:24:05 -07001198 unsigned int period;
Vasu Dev4a840672009-10-22 15:46:33 -07001199
Daniel Walterf7c65af2014-08-08 14:24:05 -07001200 if (kstrtouint(buf, 10, &period))
Vasu Dev4a840672009-10-22 15:46:33 -07001201 return -EINVAL;
1202
1203 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
Peter Oberparleiter5cb9b402015-10-26 15:54:23 +01001204 return count;
Vasu Dev4a840672009-10-22 15:46:33 -07001205}
1206
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001207static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1208 sdev_show_queue_ramp_up_period,
1209 sdev_store_queue_ramp_up_period);
Vasu Dev4a840672009-10-22 15:46:33 -07001210
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001211static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1212 struct attribute *attr, int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001214 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 struct scsi_device *sdev = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001218 if (attr == &dev_attr_queue_depth.attr &&
1219 !sdev->host->hostt->change_queue_depth)
1220 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001222 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1223 !sdev->host->hostt->change_queue_depth)
1224 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001226#ifdef CONFIG_SCSI_DH
1227 if (attr == &dev_attr_access_state.attr &&
1228 !sdev->handler)
1229 return 0;
1230 if (attr == &dev_attr_preferred_path.attr &&
1231 !sdev->handler)
1232 return 0;
1233#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001234 return attr->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235}
1236
Hannes Reinecke7e479762016-03-03 07:41:24 +01001237static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1238 struct bin_attribute *attr, int i)
1239{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001240 struct device *dev = kobj_to_dev(kobj);
Hannes Reinecke7e479762016-03-03 07:41:24 +01001241 struct scsi_device *sdev = to_scsi_device(dev);
1242
1243
Ryan Attardd188b062019-09-26 11:22:17 -05001244 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1245 return 0;
1246
Hannes Reinecke7e479762016-03-03 07:41:24 +01001247 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1248 return 0;
1249
Hannes Reinecke68887582016-03-10 11:25:26 +01001250 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
Hannes Reinecke7e479762016-03-03 07:41:24 +01001251 return 0;
1252
Ryan Attardd188b062019-09-26 11:22:17 -05001253 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1254 return 0;
1255
Hannes Reinecke7e479762016-03-03 07:41:24 +01001256 return S_IRUGO;
1257}
1258
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001259/* Default template for device attributes. May NOT be modified */
1260static struct attribute *scsi_sdev_attrs[] = {
1261 &dev_attr_device_blocked.attr,
1262 &dev_attr_type.attr,
1263 &dev_attr_scsi_level.attr,
1264 &dev_attr_device_busy.attr,
1265 &dev_attr_vendor.attr,
1266 &dev_attr_model.attr,
1267 &dev_attr_rev.attr,
1268 &dev_attr_rescan.attr,
1269 &dev_attr_delete.attr,
1270 &dev_attr_state.attr,
1271 &dev_attr_timeout.attr,
1272 &dev_attr_eh_timeout.attr,
1273 &dev_attr_iocounterbits.attr,
1274 &dev_attr_iorequest_cnt.attr,
1275 &dev_attr_iodone_cnt.attr,
1276 &dev_attr_ioerr_cnt.attr,
1277 &dev_attr_modalias.attr,
1278 &dev_attr_queue_depth.attr,
1279 &dev_attr_queue_type.attr,
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001280 &dev_attr_wwid.attr,
Hannes Reinecke345e2962017-10-02 16:26:34 +02001281 &dev_attr_blacklist.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001282#ifdef CONFIG_SCSI_DH
1283 &dev_attr_dh_state.attr,
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001284 &dev_attr_access_state.attr,
1285 &dev_attr_preferred_path.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001286#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001287 &dev_attr_queue_ramp_up_period.attr,
1288 REF_EVT(media_change),
1289 REF_EVT(inquiry_change_reported),
1290 REF_EVT(capacity_change_reported),
1291 REF_EVT(soft_threshold_reached),
1292 REF_EVT(mode_parameter_change_reported),
1293 REF_EVT(lun_change_reported),
1294 NULL
1295};
1296
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001297static struct bin_attribute *scsi_sdev_bin_attrs[] = {
Ryan Attardd188b062019-09-26 11:22:17 -05001298 &dev_attr_vpd_pg0,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001299 &dev_attr_vpd_pg83,
1300 &dev_attr_vpd_pg80,
Ryan Attardd188b062019-09-26 11:22:17 -05001301 &dev_attr_vpd_pg89,
Johannes Thumshirn92e62462015-11-09 10:56:57 +01001302 &dev_attr_inquiry,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001303 NULL
1304};
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001305static struct attribute_group scsi_sdev_attr_group = {
1306 .attrs = scsi_sdev_attrs,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001307 .bin_attrs = scsi_sdev_bin_attrs,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001308 .is_visible = scsi_sdev_attr_is_visible,
Hannes Reinecke7e479762016-03-03 07:41:24 +01001309 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001310};
1311
1312static const struct attribute_group *scsi_sdev_attr_groups[] = {
1313 &scsi_sdev_attr_group,
1314 NULL
1315};
1316
James Bottomley643eb2d2008-03-22 22:42:27 -05001317static int scsi_target_add(struct scsi_target *starget)
1318{
1319 int error;
1320
1321 if (starget->state != STARGET_CREATED)
1322 return 0;
1323
1324 error = device_add(&starget->dev);
1325 if (error) {
1326 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
James Bottomley643eb2d2008-03-22 22:42:27 -05001327 return error;
1328 }
1329 transport_add_device(&starget->dev);
1330 starget->state = STARGET_RUNNING;
1331
Alan Sternbc4f2402010-06-17 10:41:42 -04001332 pm_runtime_set_active(&starget->dev);
1333 pm_runtime_enable(&starget->dev);
1334 device_enable_async_suspend(&starget->dev);
1335
James Bottomley643eb2d2008-03-22 22:42:27 -05001336 return 0;
1337}
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339/**
1340 * scsi_sysfs_add_sdev - add scsi device to sysfs
1341 * @sdev: scsi_device to add
1342 *
1343 * Return value:
1344 * 0 on Success / non-zero on Failure
1345 **/
1346int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1347{
Bart Van Assche92c4b582021-10-12 16:35:13 -07001348 int error;
James Bottomley643eb2d2008-03-22 22:42:27 -05001349 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
James Bottomley643eb2d2008-03-22 22:42:27 -05001351 error = scsi_target_add(starget);
1352 if (error)
1353 return error;
1354
1355 transport_configure_device(&starget->dev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001356
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001357 device_enable_async_suspend(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001358 scsi_autopm_get_target(starget);
1359 pm_runtime_set_active(&sdev->sdev_gendev);
Stanley Chuc74f8052019-09-16 23:56:49 +08001360 if (!sdev->rpm_autosuspend)
1361 pm_runtime_forbid(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001362 pm_runtime_enable(&sdev->sdev_gendev);
1363 scsi_autopm_put_target(starget);
1364
Alan Sternbc4f2402010-06-17 10:41:42 -04001365 scsi_autopm_get_device(sdev);
1366
Hannes Reinecke2930f812017-09-20 09:18:52 +02001367 scsi_dh_add_device(sdev);
Christoph Hellwig086b91d2015-08-27 14:16:57 +02001368
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001369 error = device_add(&sdev->sdev_gendev);
1370 if (error) {
1371 sdev_printk(KERN_INFO, sdev,
1372 "failed to add device: %d\n", error);
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001373 return error;
1374 }
1375
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001376 device_enable_async_suspend(&sdev->sdev_dev);
Tony Jonesee959b02008-02-22 00:13:36 +01001377 error = device_add(&sdev->sdev_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001379 sdev_printk(KERN_INFO, sdev,
1380 "failed to add class device: %d\n", error);
James Bottomley860dc732009-11-19 17:48:29 -05001381 device_del(&sdev->sdev_gendev);
Alan Sternee37e092010-02-12 12:13:55 -05001382 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 }
James Bottomley860dc732009-11-19 17:48:29 -05001384 transport_add_device(&sdev->sdev_gendev);
1385 sdev->is_visible = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001387 if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1388 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1389 if (IS_ERR(sdev->bsg_dev)) {
1390 /*
1391 * We're treating error on bsg register as non-fatal, so
1392 * pretend nothing went wrong.
1393 */
Jackie Liu5f7cf822021-10-22 09:02:01 +08001394 error = PTR_ERR(sdev->bsg_dev);
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001395 sdev_printk(KERN_INFO, sdev,
1396 "Failed to register bsg queue, errno=%d\n",
1397 error);
1398 sdev->bsg_dev = NULL;
1399 }
1400 }
James Bottomley80ed71c2007-07-19 10:15:10 -05001401
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03001402 scsi_autopm_put_device(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
1405
Alan Stern903f4fed2005-07-26 10:20:53 -04001406void __scsi_remove_device(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407{
James Bottomleydf133c22005-11-06 11:47:08 -06001408 struct device *dev = &sdev->sdev_gendev;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001409 int res;
James Bottomleydf133c22005-11-06 11:47:08 -06001410
Vitaly Kuznetsovbe821fd2015-11-19 14:02:19 +01001411 /*
1412 * This cleanup path is not reentrant and while it is impossible
1413 * to get a new reference with scsi_device_get() someone can still
1414 * hold a previously acquired one.
1415 */
1416 if (sdev->sdev_state == SDEV_DEL)
1417 return;
1418
James Bottomley860dc732009-11-19 17:48:29 -05001419 if (sdev->is_visible) {
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001420 /*
1421 * If scsi_internal_target_block() is running concurrently,
1422 * wait until it has finished before changing the device state.
1423 */
1424 mutex_lock(&sdev->state_mutex);
Bart Van Assche255ee932017-06-02 14:21:57 -07001425 /*
1426 * If blocked, we go straight to DEL and restart the queue so
1427 * any commands issued during driver shutdown (like sync
1428 * cache) are errored immediately.
1429 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001430 res = scsi_device_set_state(sdev, SDEV_CANCEL);
Bart Van Assche255ee932017-06-02 14:21:57 -07001431 if (res != 0) {
1432 res = scsi_device_set_state(sdev, SDEV_DEL);
1433 if (res == 0)
1434 scsi_start_queue(sdev);
1435 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001436 mutex_unlock(&sdev->state_mutex);
1437
1438 if (res != 0)
James Bottomley860dc732009-11-19 17:48:29 -05001439 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001441 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1442 bsg_unregister_queue(sdev->bsg_dev);
James Bottomley860dc732009-11-19 17:48:29 -05001443 device_unregister(&sdev->sdev_dev);
1444 transport_remove_device(dev);
Bart Van Asschee619e6c2015-11-20 14:11:01 -08001445 device_del(dev);
1446 } else
1447 put_device(&sdev->sdev_dev);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001448
1449 /*
1450 * Stop accepting new requests and wait until all queuecommand() and
1451 * scsi_run_queue() invocations have finished before tearing down the
1452 * device.
1453 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001454 mutex_lock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 scsi_device_set_state(sdev, SDEV_DEL);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001456 mutex_unlock(&sdev->state_mutex);
1457
Bart Van Asscheb4854622012-06-29 15:36:07 +00001458 blk_cleanup_queue(sdev->request_queue);
1459 cancel_work_sync(&sdev->requeue_work);
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 if (sdev->host->hostt->slave_destroy)
1462 sdev->host->hostt->slave_destroy(sdev);
James Bottomleydf133c22005-11-06 11:47:08 -06001463 transport_destroy_device(dev);
James Bottomley86cbfb52011-04-22 10:39:59 -05001464
James Bottomleye63ed0d2014-01-21 07:00:50 -08001465 /*
1466 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
dudengkeeee89102021-03-26 14:09:02 +08001467 * removed sysfs visibility from the device, so make the target
James Bottomleye63ed0d2014-01-21 07:00:50 -08001468 * invisible if this was the last device underneath it.
1469 */
1470 scsi_target_reap(scsi_target(sdev));
1471
James Bottomleydf133c22005-11-06 11:47:08 -06001472 put_device(dev);
Alan Stern903f4fed2005-07-26 10:20:53 -04001473}
1474
1475/**
1476 * scsi_remove_device - unregister a device from the scsi bus
1477 * @sdev: scsi_device to unregister
1478 **/
1479void scsi_remove_device(struct scsi_device *sdev)
1480{
Alan Stern54195002005-09-15 21:52:51 -04001481 struct Scsi_Host *shost = sdev->host;
1482
Arjan van de Ven0b950672006-01-11 13:16:10 +01001483 mutex_lock(&shost->scan_mutex);
Alan Stern903f4fed2005-07-26 10:20:53 -04001484 __scsi_remove_device(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01001485 mutex_unlock(&shost->scan_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486}
1487EXPORT_SYMBOL(scsi_remove_device);
1488
Adrian Bunk44818ef2007-07-09 11:59:59 -07001489static void __scsi_remove_target(struct scsi_target *starget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490{
1491 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1492 unsigned long flags;
Alan Sterna64358d2005-07-26 10:27:10 -04001493 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
1495 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001496 restart:
1497 list_for_each_entry(sdev, &shost->__devices, siblings) {
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001498 /*
1499 * We cannot call scsi_device_get() here, as
1500 * we might've been called from rmmod() causing
1501 * scsi_device_get() to fail the module_is_live()
1502 * check.
1503 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 if (sdev->channel != starget->channel ||
Hannes Reinecke81b6c992017-12-13 14:21:37 +01001505 sdev->id != starget->id)
1506 continue;
1507 if (sdev->sdev_state == SDEV_DEL ||
1508 sdev->sdev_state == SDEV_CANCEL ||
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001509 !get_device(&sdev->sdev_gendev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 continue;
1511 spin_unlock_irqrestore(shost->host_lock, flags);
1512 scsi_remove_device(sdev);
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001513 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001515 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 }
1517 spin_unlock_irqrestore(shost->host_lock, flags);
mochel@digitalimplant.org20b1e672005-03-24 19:03:59 -08001518}
1519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520/**
1521 * scsi_remove_target - try to remove a target and all its devices
1522 * @dev: generic starget or parent of generic stargets to be removed
1523 *
1524 * Note: This is slightly racy. It is possible that if the user
1525 * requests the addition of another device then the target won't be
1526 * removed.
1527 */
1528void scsi_remove_target(struct device *dev)
1529{
Dan Williams3b661a92012-06-21 23:47:28 -07001530 struct Scsi_Host *shost = dev_to_shost(dev->parent);
Johannes Thumshirn305c2e72016-04-05 11:50:45 +02001531 struct scsi_target *starget;
Dan Williams3b661a92012-06-21 23:47:28 -07001532 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Christoph Hellwig40998192015-10-19 16:35:46 +02001534restart:
Dan Williams3b661a92012-06-21 23:47:28 -07001535 spin_lock_irqsave(shost->host_lock, flags);
1536 list_for_each_entry(starget, &shost->__targets, siblings) {
James Bottomley90a88d62016-02-10 08:03:26 -08001537 if (starget->state == STARGET_DEL ||
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001538 starget->state == STARGET_REMOVE ||
1539 starget->state == STARGET_CREATED_REMOVE)
Dan Williams3b661a92012-06-21 23:47:28 -07001540 continue;
1541 if (starget->dev.parent == dev || &starget->dev == dev) {
James Bottomleye63ed0d2014-01-21 07:00:50 -08001542 kref_get(&starget->reap_ref);
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001543 if (starget->state == STARGET_CREATED)
1544 starget->state = STARGET_CREATED_REMOVE;
1545 else
1546 starget->state = STARGET_REMOVE;
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001547 spin_unlock_irqrestore(shost->host_lock, flags);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001548 __scsi_remove_target(starget);
Christoph Hellwig40998192015-10-19 16:35:46 +02001549 scsi_target_reap(starget);
1550 goto restart;
Dan Williams3b661a92012-06-21 23:47:28 -07001551 }
1552 }
1553 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554}
1555EXPORT_SYMBOL(scsi_remove_target);
1556
1557int scsi_register_driver(struct device_driver *drv)
1558{
1559 drv->bus = &scsi_bus_type;
1560
1561 return driver_register(drv);
1562}
1563EXPORT_SYMBOL(scsi_register_driver);
1564
1565int scsi_register_interface(struct class_interface *intf)
1566{
1567 intf->class = &sdev_class;
1568
1569 return class_interface_register(intf);
1570}
1571EXPORT_SYMBOL(scsi_register_interface);
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573/**
1574 * scsi_sysfs_add_host - add scsi host to subsystem
1575 * @shost: scsi host struct to add to subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 **/
1577int scsi_sysfs_add_host(struct Scsi_Host *shost)
1578{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 transport_register_device(&shost->shost_gendev);
James Bottomleyd52b3812008-01-05 09:38:30 -06001580 transport_configure_device(&shost->shost_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 return 0;
1582}
1583
Kay Sieversbfd12942007-09-11 17:00:14 +02001584static struct device_type scsi_dev_type = {
1585 .name = "scsi_device",
1586 .release = scsi_device_dev_release,
1587 .groups = scsi_sdev_attr_groups,
1588};
1589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1591{
1592 unsigned long flags;
1593 struct Scsi_Host *shost = sdev->host;
Bart Van Assche92c4b582021-10-12 16:35:13 -07001594 struct scsi_host_template *hostt = shost->hostt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 struct scsi_target *starget = sdev->sdev_target;
1596
1597 device_initialize(&sdev->sdev_gendev);
1598 sdev->sdev_gendev.bus = &scsi_bus_type;
Kay Sieversbfd12942007-09-11 17:00:14 +02001599 sdev->sdev_gendev.type = &scsi_dev_type;
Bart Van Asschea19a93e2021-10-06 14:54:51 -07001600 scsi_enable_async_suspend(&sdev->sdev_gendev);
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001601 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001602 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Steffen Maier3a71f0f2021-10-26 03:42:40 +02001603 sdev->sdev_gendev.groups = hostt->sdev_groups;
Kay Sievers71610f52008-12-03 22:41:36 +01001604
Tony Jonesee959b02008-02-22 00:13:36 +01001605 device_initialize(&sdev->sdev_dev);
James Bottomley37e6ba02009-10-02 13:30:08 -05001606 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
Tony Jonesee959b02008-02-22 00:13:36 +01001607 sdev->sdev_dev.class = &sdev_class;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001608 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001609 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Alan Stern50c4e962014-09-02 11:35:50 -04001610 /*
1611 * Get a default scsi_level from the target (derived from sibling
1612 * devices). This is the best we can do for guessing how to set
1613 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1614 * setting doesn't matter, because all the bits are zero anyway.
1615 * But it does matter for higher LUNs.
1616 */
Alan Stern7c9d6f12007-01-08 11:12:32 -05001617 sdev->scsi_level = starget->scsi_level;
Alan Stern50c4e962014-09-02 11:35:50 -04001618 if (sdev->scsi_level <= SCSI_2 &&
1619 sdev->scsi_level != SCSI_UNKNOWN &&
1620 !shost->no_scsi2_lun_in_cdb)
1621 sdev->lun_in_cdb = 1;
1622
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 transport_setup_device(&sdev->sdev_gendev);
1624 spin_lock_irqsave(shost->host_lock, flags);
1625 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1626 list_add_tail(&sdev->siblings, &shost->__devices);
1627 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomleye63ed0d2014-01-21 07:00:50 -08001628 /*
1629 * device can now only be removed via __scsi_remove_device() so hold
1630 * the target. Target will be held in CREATED state until something
1631 * beneath it becomes visible (in which case it moves to RUNNING)
1632 */
1633 kref_get(&starget->reap_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634}
1635
1636int scsi_is_sdev_device(const struct device *dev)
1637{
Kay Sievers13ba9bc2007-09-26 19:54:49 +02001638 return dev->type == &scsi_dev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639}
1640EXPORT_SYMBOL(scsi_is_sdev_device);
1641
1642/* A blank transport template that is used in drivers that don't
1643 * yet implement Transport Attributes */
1644struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };