blob: f1e0c131b77cd5999cb8f5b6cd7205d31c5863bf [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 Assche0a844862021-11-16 14:31:15 -0800427static const struct attribute_group scsi_shost_attr_group = {
Hannes Reineckef7120a42008-03-18 14:32:28 +0100428 .attrs = scsi_sysfs_shost_attrs,
429};
430
Bart Van Assche0a844862021-11-16 14:31:15 -0800431const struct attribute_group *scsi_shost_groups[] = {
432 &scsi_shost_attr_group,
433 NULL
434};
435
Tony Jonesee959b02008-02-22 00:13:36 +0100436static void scsi_device_cls_release(struct device *class_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
438 struct scsi_device *sdev;
439
440 sdev = class_to_sdev(class_dev);
441 put_device(&sdev->sdev_gendev);
442}
443
David Howells65f27f32006-11-22 14:55:48 +0000444static void scsi_device_dev_release_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
446 struct scsi_device *sdev;
447 struct device *parent;
Jeff Garzika341cd02007-10-29 17:15:22 -0400448 struct list_head *this, *tmp;
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700449 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
Ryan Attardd188b062019-09-26 11:22:17 -0500450 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 unsigned long flags;
Ming Leif2b85042021-10-08 13:01:18 +0800452 struct module *mod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
David Howells65f27f32006-11-22 14:55:48 +0000454 sdev = container_of(work, struct scsi_device, ew.work);
455
Ming Leif2b85042021-10-08 13:01:18 +0800456 mod = sdev->host->hostt->module;
457
Junichi Nomura23695e42015-10-06 04:32:57 +0000458 scsi_dh_release_device(sdev);
459
David Howells65f27f32006-11-22 14:55:48 +0000460 parent = sdev->sdev_gendev.parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
462 spin_lock_irqsave(sdev->host->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 list_del(&sdev->siblings);
464 list_del(&sdev->same_target_siblings);
465 list_del(&sdev->starved_entry);
466 spin_unlock_irqrestore(sdev->host->host_lock, flags);
467
Jeff Garzika341cd02007-10-29 17:15:22 -0400468 cancel_work_sync(&sdev->event_work);
469
470 list_for_each_safe(this, tmp, &sdev->event_list) {
471 struct scsi_event *evt;
472
473 evt = list_entry(this, struct scsi_event, node);
474 list_del(&evt->node);
475 kfree(evt);
476 }
477
James Bottomleye73e0792011-05-25 15:52:14 -0500478 blk_put_queue(sdev->request_queue);
James Bottomley86cbfb52011-04-22 10:39:59 -0500479 /* NULL queue means the device can't be used */
480 sdev->request_queue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Ming Lei020b0f02021-01-22 10:33:17 +0800482 sbitmap_free(&sdev->budget_map);
483
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700484 mutex_lock(&sdev->inquiry_mutex);
Linus Torvaldsef2cc882019-12-02 13:37:02 -0800485 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
486 lockdep_is_held(&sdev->inquiry_mutex));
Paul E. McKenneyc0eaf152019-09-23 15:26:28 -0700487 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
488 lockdep_is_held(&sdev->inquiry_mutex));
489 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
490 lockdep_is_held(&sdev->inquiry_mutex));
Linus Torvaldsef2cc882019-12-02 13:37:02 -0800491 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
492 lockdep_is_held(&sdev->inquiry_mutex));
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700493 mutex_unlock(&sdev->inquiry_mutex);
494
Ryan Attardd188b062019-09-26 11:22:17 -0500495 if (vpd_pg0)
496 kfree_rcu(vpd_pg0, rcu);
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700497 if (vpd_pg83)
498 kfree_rcu(vpd_pg83, rcu);
499 if (vpd_pg80)
500 kfree_rcu(vpd_pg80, rcu);
Ryan Attardd188b062019-09-26 11:22:17 -0500501 if (vpd_pg89)
502 kfree_rcu(vpd_pg89, rcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 kfree(sdev->inquiry);
504 kfree(sdev);
505
506 if (parent)
507 put_device(parent);
Ming Leif2b85042021-10-08 13:01:18 +0800508 module_put(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509}
510
James Bottomley65110b22006-02-14 10:48:46 -0600511static void scsi_device_dev_release(struct device *dev)
512{
James Bottomleyffedb452006-02-23 14:27:18 -0600513 struct scsi_device *sdp = to_scsi_device(dev);
Ming Leif2b85042021-10-08 13:01:18 +0800514
515 /* Set module pointer as NULL in case of module unloading */
516 if (!try_module_get(sdp->host->hostt->module))
517 sdp->host->hostt->module = NULL;
518
David Howells65f27f32006-11-22 14:55:48 +0000519 execute_in_process_context(scsi_device_dev_release_usercontext,
James Bottomleyffedb452006-02-23 14:27:18 -0600520 &sdp->ew);
James Bottomley65110b22006-02-14 10:48:46 -0600521}
522
Adrian Bunk52c1da32005-06-23 22:05:33 -0700523static struct class sdev_class = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 .name = "scsi_device",
Tony Jonesee959b02008-02-22 00:13:36 +0100525 .dev_release = scsi_device_cls_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526};
527
528/* all probing is done in the individual ->probe routines */
529static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
530{
Hannes Reineckeb0ed4332008-03-18 14:32:28 +0100531 struct scsi_device *sdp;
532
533 if (dev->type != &scsi_dev_type)
534 return 0;
535
536 sdp = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 if (sdp->no_uld_attach)
538 return 0;
539 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
540}
541
Kay Sievers7eff2e72007-08-14 15:15:12 +0200542static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400543{
James Bottomley1f42ea72008-05-22 12:34:41 +0100544 struct scsi_device *sdev;
545
546 if (dev->type != &scsi_dev_type)
547 return 0;
548
549 sdev = to_scsi_device(dev);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400550
Kay Sievers7eff2e72007-08-14 15:15:12 +0200551 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400552 return 0;
553}
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555struct bus_type scsi_bus_type = {
556 .name = "scsi",
557 .match = scsi_bus_match,
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400558 .uevent = scsi_bus_uevent,
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100559#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400560 .pm = &scsi_bus_pm_ops,
Alan Sterne6da54d2010-08-05 13:17:10 -0400561#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562};
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700563EXPORT_SYMBOL_GPL(scsi_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565int scsi_sysfs_register(void)
566{
567 int error;
568
569 error = bus_register(&scsi_bus_type);
570 if (!error) {
571 error = class_register(&sdev_class);
572 if (error)
573 bus_unregister(&scsi_bus_type);
574 }
575
576 return error;
577}
578
579void scsi_sysfs_unregister(void)
580{
581 class_unregister(&sdev_class);
582 bus_unregister(&scsi_bus_type);
583}
584
585/*
586 * sdev_show_function: macro to create an attr function that can be used to
587 * show a non-bit field.
588 */
589#define sdev_show_function(field, format_string) \
590static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100591sdev_show_##field (struct device *dev, struct device_attribute *attr, \
592 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593{ \
594 struct scsi_device *sdev; \
595 sdev = to_scsi_device(dev); \
596 return snprintf (buf, 20, format_string, sdev->field); \
597} \
598
599/*
600 * sdev_rd_attr: macro to create a function and attribute variable for a
601 * read only field.
602 */
603#define sdev_rd_attr(field, format_string) \
604 sdev_show_function(field, format_string) \
605static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
606
607
608/*
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900609 * sdev_rw_attr: create a function and attribute variable for a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 * read/write field.
611 */
612#define sdev_rw_attr(field, format_string) \
613 sdev_show_function(field, format_string) \
614 \
615static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100616sdev_store_##field (struct device *dev, struct device_attribute *attr, \
617 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{ \
619 struct scsi_device *sdev; \
620 sdev = to_scsi_device(dev); \
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900621 sscanf (buf, format_string, &sdev->field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return count; \
623} \
624static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
625
626/* Currently we don't export bit fields, but we might in future,
627 * so leave this code in */
628#if 0
629/*
630 * sdev_rd_attr: create a function and attribute variable for a
631 * read/write bit field.
632 */
633#define sdev_rw_attr_bit(field) \
634 sdev_show_function(field, "%d\n") \
635 \
636static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100637sdev_store_##field (struct device *dev, struct device_attribute *attr, \
638 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639{ \
640 int ret; \
641 struct scsi_device *sdev; \
642 ret = scsi_sdev_check_buf_bit(buf); \
643 if (ret >= 0) { \
644 sdev = to_scsi_device(dev); \
645 sdev->field = ret; \
646 ret = count; \
647 } \
648 return ret; \
649} \
650static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
651
652/*
653 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
654 * else return -EINVAL.
655 */
656static int scsi_sdev_check_buf_bit(const char *buf)
657{
658 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
659 if (buf[0] == '1')
660 return 1;
661 else if (buf[0] == '0')
662 return 0;
663 else
664 return -EINVAL;
665 } else
666 return -EINVAL;
667}
668#endif
669/*
670 * Create the actual show/store functions and data structures.
671 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672sdev_rd_attr (type, "%d\n");
673sdev_rd_attr (scsi_level, "%d\n");
674sdev_rd_attr (vendor, "%.8s\n");
675sdev_rd_attr (model, "%.16s\n");
676sdev_rd_attr (rev, "%.4s\n");
677
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200678static ssize_t
679sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
680 char *buf)
681{
682 struct scsi_device *sdev = to_scsi_device(dev);
Ming Lei82788072021-01-22 10:33:15 +0800683 return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200684}
685static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
686
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100687static ssize_t
688sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
689 char *buf)
690{
691 struct scsi_device *sdev = to_scsi_device(dev);
692 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
693}
694static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
695
Jens Axboe242f9dc2008-09-14 05:55:09 -0700696/*
697 * TODO: can we make these symlinks to the block layer ones?
698 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400700sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701{
702 struct scsi_device *sdev;
703 sdev = to_scsi_device(dev);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700704 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705}
706
707static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100708sdev_store_timeout (struct device *dev, struct device_attribute *attr,
709 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710{
711 struct scsi_device *sdev;
712 int timeout;
713 sdev = to_scsi_device(dev);
714 sscanf (buf, "%d\n", &timeout);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700715 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 return count;
717}
718static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
719
720static ssize_t
Martin K. Petersen0816c922013-05-10 10:36:04 -0400721sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
722{
723 struct scsi_device *sdev;
724 sdev = to_scsi_device(dev);
725 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
726}
727
728static ssize_t
729sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
730 const char *buf, size_t count)
731{
732 struct scsi_device *sdev;
733 unsigned int eh_timeout;
734 int err;
735
736 if (!capable(CAP_SYS_ADMIN))
737 return -EACCES;
738
739 sdev = to_scsi_device(dev);
740 err = kstrtouint(buf, 10, &eh_timeout);
741 if (err)
742 return err;
743 sdev->eh_timeout = eh_timeout * HZ;
744
745 return count;
746}
747static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
748
749static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100750store_rescan_field (struct device *dev, struct device_attribute *attr,
751 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752{
753 scsi_rescan_device(dev);
754 return count;
755}
756static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
757
Tony Jonesee959b02008-02-22 00:13:36 +0100758static ssize_t
759sdev_store_delete(struct device *dev, struct device_attribute *attr,
760 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700762 struct kernfs_node *kn;
Yufen Yu77c30122019-10-15 21:05:56 +0800763 struct scsi_device *sdev = to_scsi_device(dev);
764
765 /*
766 * We need to try to get module, avoiding the module been removed
767 * during delete.
768 */
769 if (scsi_device_get(sdev))
770 return -ENODEV;
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700771
772 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
773 WARN_ON_ONCE(!kn);
774 /*
775 * Concurrent writes into the "delete" sysfs attribute may trigger
776 * concurrent calls to device_remove_file() and scsi_remove_device().
777 * device_remove_file() handles concurrent removal calls by
778 * serializing these and by ignoring the second and later removal
779 * attempts. Concurrent calls of scsi_remove_device() are
780 * serialized. The second and later calls of scsi_remove_device() are
781 * ignored because the first call of that function changes the device
782 * state into SDEV_DEL.
783 */
784 device_remove_file(dev, attr);
Yufen Yu77c30122019-10-15 21:05:56 +0800785 scsi_remove_device(sdev);
Bart Van Assche0ee223b2018-08-02 10:51:41 -0700786 if (kn)
787 sysfs_unbreak_active_protection(kn);
Yufen Yu77c30122019-10-15 21:05:56 +0800788 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 return count;
790};
791static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
792
793static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100794store_state_field(struct device *dev, struct device_attribute *attr,
795 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796{
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700797 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 struct scsi_device *sdev = to_scsi_device(dev);
799 enum scsi_device_state state = 0;
Mike Christie4edd8cd2021-11-05 17:10:48 -0500800 bool rescan_dev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Tobias Klauser6391a112006-06-08 22:23:48 -0700802 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 const int len = strlen(sdev_states[i].name);
804 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
805 buf[len] == '\n') {
806 state = sdev_states[i].value;
807 break;
808 }
809 }
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700810 switch (state) {
811 case SDEV_RUNNING:
812 case SDEV_OFFLINE:
813 break;
814 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 return -EINVAL;
Bart Van Asscheac88c1f2019-06-17 08:18:18 -0700816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700818 mutex_lock(&sdev->state_mutex);
Mike Christie4edd8cd2021-11-05 17:10:48 -0500819 if (sdev->sdev_state == SDEV_RUNNING && state == SDEV_RUNNING) {
Mike Christieeb975452021-11-20 10:49:17 -0600820 ret = 0;
Mike Christie4edd8cd2021-11-05 17:10:48 -0500821 } else {
822 ret = scsi_device_set_state(sdev, state);
823 if (ret == 0 && state == SDEV_RUNNING)
824 rescan_dev = true;
825 }
826 mutex_unlock(&sdev->state_mutex);
827
828 if (rescan_dev) {
829 /*
830 * If the device state changes to SDEV_RUNNING, we need to
831 * run the queue to avoid I/O hang, and rescan the device
832 * to revalidate it. Running the queue first is necessary
833 * because another thread may be waiting inside
834 * blk_mq_freeze_queue_wait() and because that call may be
835 * waiting for pending I/O to finish.
836 */
zhengbin70fc0852019-03-22 10:56:46 +0800837 blk_mq_run_hw_queues(sdev->request_queue, true);
Li Jinlin02c6dcd2021-08-24 10:59:21 +0800838 scsi_rescan_device(dev);
lijinlinf0f82e22021-07-27 11:44:55 +0800839 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700840
841 return ret == 0 ? count : -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842}
843
844static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400845show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846{
847 struct scsi_device *sdev = to_scsi_device(dev);
848 const char *name = scsi_device_state_name(sdev->sdev_state);
849
850 if (!name)
851 return -EINVAL;
852
853 return snprintf(buf, 20, "%s\n", name);
854}
855
856static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
857
858static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100859show_queue_type_field(struct device *dev, struct device_attribute *attr,
860 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861{
862 struct scsi_device *sdev = to_scsi_device(dev);
863 const char *name = "none";
864
Christoph Hellwig609aa222014-10-30 11:54:58 +0100865 if (sdev->simple_tags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 name = "simple";
867
868 return snprintf(buf, 20, "%s\n", name);
869}
870
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100871static ssize_t
872store_queue_type_field(struct device *dev, struct device_attribute *attr,
873 const char *buf, size_t count)
874{
875 struct scsi_device *sdev = to_scsi_device(dev);
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100876
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100877 if (!sdev->tagged_supported)
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100878 return -EINVAL;
Christoph Hellwigefc3c1d2014-11-24 15:36:18 +0100879
880 sdev_printk(KERN_INFO, sdev,
881 "ignoring write to deprecated queue_type attribute");
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100882 return count;
883}
884
885static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
886 store_queue_type_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100888#define sdev_vpd_pg_attr(_page) \
889static ssize_t \
890show_vpd_##_page(struct file *filp, struct kobject *kobj, \
891 struct bin_attribute *bin_attr, \
892 char *buf, loff_t off, size_t count) \
893{ \
Guosong Su9e7bd9452020-02-25 18:04:11 +0800894 struct device *dev = kobj_to_dev(kobj); \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100895 struct scsi_device *sdev = to_scsi_device(dev); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700896 struct scsi_vpd *vpd_page; \
897 int ret = -EINVAL; \
898 \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100899 rcu_read_lock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700900 vpd_page = rcu_dereference(sdev->vpd_##_page); \
901 if (vpd_page) \
902 ret = memory_read_from_buffer(buf, count, &off, \
903 vpd_page->data, vpd_page->len); \
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100904 rcu_read_unlock(); \
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700905 return ret; \
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100906} \
907static struct bin_attribute dev_attr_vpd_##_page = { \
908 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
909 .size = 0, \
910 .read = show_vpd_##_page, \
911};
912
913sdev_vpd_pg_attr(pg83);
914sdev_vpd_pg_attr(pg80);
Ryan Attardd188b062019-09-26 11:22:17 -0500915sdev_vpd_pg_attr(pg89);
916sdev_vpd_pg_attr(pg0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100918static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
919 struct bin_attribute *bin_attr,
920 char *buf, loff_t off, size_t count)
921{
Guosong Su9e7bd9452020-02-25 18:04:11 +0800922 struct device *dev = kobj_to_dev(kobj);
Johannes Thumshirn92e62462015-11-09 10:56:57 +0100923 struct scsi_device *sdev = to_scsi_device(dev);
924
925 if (!sdev->inquiry)
926 return -EINVAL;
927
928 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
929 sdev->inquiry_len);
930}
931
932static struct bin_attribute dev_attr_inquiry = {
933 .attr = {
934 .name = "inquiry",
935 .mode = S_IRUGO,
936 },
937 .size = 0,
938 .read = show_inquiry,
939};
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941static ssize_t
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100942show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
943 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944{
945 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
946}
947
948static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
949
950#define show_sdev_iostat(field) \
951static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100952show_iostat_##field(struct device *dev, struct device_attribute *attr, \
953 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954{ \
955 struct scsi_device *sdev = to_scsi_device(dev); \
956 unsigned long long count = atomic_read(&sdev->field); \
957 return snprintf(buf, 20, "0x%llx\n", count); \
958} \
959static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
960
961show_sdev_iostat(iorequest_cnt);
962show_sdev_iostat(iodone_cnt);
963show_sdev_iostat(ioerr_cnt);
964
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400965static ssize_t
966sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
967{
968 struct scsi_device *sdev;
969 sdev = to_scsi_device(dev);
970 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
971}
972static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Jeff Garzika341cd02007-10-29 17:15:22 -0400974#define DECLARE_EVT_SHOW(name, Cap_name) \
975static ssize_t \
976sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
Tony Jonesee959b02008-02-22 00:13:36 +0100977 char *buf) \
Jeff Garzika341cd02007-10-29 17:15:22 -0400978{ \
979 struct scsi_device *sdev = to_scsi_device(dev); \
980 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
981 return snprintf(buf, 20, "%d\n", val); \
982}
983
984#define DECLARE_EVT_STORE(name, Cap_name) \
985static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100986sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
Jeff Garzika341cd02007-10-29 17:15:22 -0400987 const char *buf, size_t count) \
988{ \
989 struct scsi_device *sdev = to_scsi_device(dev); \
990 int val = simple_strtoul(buf, NULL, 0); \
991 if (val == 0) \
992 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
993 else if (val == 1) \
994 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
995 else \
996 return -EINVAL; \
997 return count; \
998}
999
1000#define DECLARE_EVT(name, Cap_name) \
1001 DECLARE_EVT_SHOW(name, Cap_name) \
1002 DECLARE_EVT_STORE(name, Cap_name) \
1003 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
1004 sdev_store_evt_##name);
1005#define REF_EVT(name) &dev_attr_evt_##name.attr
1006
1007DECLARE_EVT(media_change, MEDIA_CHANGE)
Ewan D. Milne279afdf2013-08-08 15:07:48 -04001008DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1009DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1010DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1011DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1012DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
Jeff Garzika341cd02007-10-29 17:15:22 -04001013
Tony Jonesee959b02008-02-22 00:13:36 +01001014static ssize_t
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001015sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1016 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017{
1018 int depth, retval;
1019 struct scsi_device *sdev = to_scsi_device(dev);
1020 struct scsi_host_template *sht = sdev->host->hostt;
1021
1022 if (!sht->change_queue_depth)
1023 return -EINVAL;
1024
1025 depth = simple_strtoul(buf, NULL, 0);
1026
Jens Axboe1278dd682015-07-13 08:24:39 -06001027 if (depth < 1 || depth > sdev->host->can_queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 return -EINVAL;
1029
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +01001030 retval = sht->change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 if (retval < 0)
1032 return retval;
1033
Vasu Dev4a840672009-10-22 15:46:33 -07001034 sdev->max_queue_depth = sdev->queue_depth;
1035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 return count;
1037}
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001038sdev_show_function(queue_depth, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001040static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1041 sdev_store_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001043static ssize_t
1044sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1045 char *buf)
1046{
1047 struct scsi_device *sdev = to_scsi_device(dev);
1048 ssize_t count;
1049
1050 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1051 if (count > 0) {
1052 buf[count] = '\n';
1053 count++;
1054 }
1055 return count;
1056}
1057static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1058
Bart Van Assche093b8882017-12-12 10:23:28 -08001059#define BLIST_FLAG_NAME(name) \
Martin Wilck14098802018-04-18 01:35:08 +02001060 [const_ilog2((__force __u64)BLIST_##name)] = #name
Hannes Reinecke345e2962017-10-02 16:26:34 +02001061static const char *const sdev_bflags_name[] = {
1062#include "scsi_devinfo_tbl.c"
1063};
1064#undef BLIST_FLAG_NAME
1065
1066static ssize_t
1067sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1068 char *buf)
1069{
1070 struct scsi_device *sdev = to_scsi_device(dev);
1071 int i;
1072 ssize_t len = 0;
1073
1074 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1075 const char *name = NULL;
1076
Bart Van Assche093b8882017-12-12 10:23:28 -08001077 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
Hannes Reinecke345e2962017-10-02 16:26:34 +02001078 continue;
1079 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1080 name = sdev_bflags_name[i];
1081
1082 if (name)
Takashi Iwai81546b32020-03-15 10:42:40 +01001083 len += scnprintf(buf + len, PAGE_SIZE - len,
1084 "%s%s", len ? " " : "", name);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001085 else
Takashi Iwai81546b32020-03-15 10:42:40 +01001086 len += scnprintf(buf + len, PAGE_SIZE - len,
1087 "%sINVALID_BIT(%d)", len ? " " : "", i);
Hannes Reinecke345e2962017-10-02 16:26:34 +02001088 }
1089 if (len)
Takashi Iwai81546b32020-03-15 10:42:40 +01001090 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
Hannes Reinecke345e2962017-10-02 16:26:34 +02001091 return len;
1092}
1093static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1094
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001095#ifdef CONFIG_SCSI_DH
1096static ssize_t
1097sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1098 char *buf)
1099{
1100 struct scsi_device *sdev = to_scsi_device(dev);
1101
1102 if (!sdev->handler)
1103 return snprintf(buf, 20, "detached\n");
1104
1105 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1106}
1107
1108static ssize_t
1109sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1110 const char *buf, size_t count)
1111{
1112 struct scsi_device *sdev = to_scsi_device(dev);
1113 int err = -EINVAL;
1114
1115 if (sdev->sdev_state == SDEV_CANCEL ||
1116 sdev->sdev_state == SDEV_DEL)
1117 return -ENODEV;
1118
1119 if (!sdev->handler) {
1120 /*
1121 * Attach to a device handler
1122 */
1123 err = scsi_dh_attach(sdev->request_queue, buf);
1124 } else if (!strncmp(buf, "activate", 8)) {
1125 /*
1126 * Activate a device handler
1127 */
1128 if (sdev->handler->activate)
1129 err = sdev->handler->activate(sdev, NULL, NULL);
1130 else
1131 err = 0;
1132 } else if (!strncmp(buf, "detach", 6)) {
1133 /*
1134 * Detach from a device handler
1135 */
1136 sdev_printk(KERN_WARNING, sdev,
1137 "can't detach handler %s.\n",
1138 sdev->handler->name);
1139 err = -EINVAL;
1140 }
1141
1142 return err < 0 ? err : count;
1143}
1144
1145static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1146 sdev_store_dh_state);
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001147
1148static ssize_t
1149sdev_show_access_state(struct device *dev,
1150 struct device_attribute *attr,
1151 char *buf)
1152{
1153 struct scsi_device *sdev = to_scsi_device(dev);
1154 unsigned char access_state;
1155 const char *access_state_name;
1156
1157 if (!sdev->handler)
1158 return -EINVAL;
1159
1160 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1161 access_state_name = scsi_access_state_name(access_state);
1162
1163 return sprintf(buf, "%s\n",
1164 access_state_name ? access_state_name : "unknown");
1165}
1166static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1167
1168static ssize_t
1169sdev_show_preferred_path(struct device *dev,
1170 struct device_attribute *attr,
1171 char *buf)
1172{
1173 struct scsi_device *sdev = to_scsi_device(dev);
1174
1175 if (!sdev->handler)
1176 return -EINVAL;
1177
1178 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1179 return sprintf(buf, "1\n");
1180 else
1181 return sprintf(buf, "0\n");
1182}
1183static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001184#endif
1185
Tony Jonesee959b02008-02-22 00:13:36 +01001186static ssize_t
Vasu Dev4a840672009-10-22 15:46:33 -07001187sdev_show_queue_ramp_up_period(struct device *dev,
1188 struct device_attribute *attr,
1189 char *buf)
1190{
1191 struct scsi_device *sdev;
1192 sdev = to_scsi_device(dev);
1193 return snprintf(buf, 20, "%u\n",
1194 jiffies_to_msecs(sdev->queue_ramp_up_period));
1195}
1196
1197static ssize_t
1198sdev_store_queue_ramp_up_period(struct device *dev,
1199 struct device_attribute *attr,
1200 const char *buf, size_t count)
1201{
1202 struct scsi_device *sdev = to_scsi_device(dev);
Daniel Walterf7c65af2014-08-08 14:24:05 -07001203 unsigned int period;
Vasu Dev4a840672009-10-22 15:46:33 -07001204
Daniel Walterf7c65af2014-08-08 14:24:05 -07001205 if (kstrtouint(buf, 10, &period))
Vasu Dev4a840672009-10-22 15:46:33 -07001206 return -EINVAL;
1207
1208 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
Peter Oberparleiter5cb9b402015-10-26 15:54:23 +01001209 return count;
Vasu Dev4a840672009-10-22 15:46:33 -07001210}
1211
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001212static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1213 sdev_show_queue_ramp_up_period,
1214 sdev_store_queue_ramp_up_period);
Vasu Dev4a840672009-10-22 15:46:33 -07001215
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001216static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1217 struct attribute *attr, int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001219 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 struct scsi_device *sdev = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001223 if (attr == &dev_attr_queue_depth.attr &&
1224 !sdev->host->hostt->change_queue_depth)
1225 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001227 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1228 !sdev->host->hostt->change_queue_depth)
1229 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001231#ifdef CONFIG_SCSI_DH
1232 if (attr == &dev_attr_access_state.attr &&
1233 !sdev->handler)
1234 return 0;
1235 if (attr == &dev_attr_preferred_path.attr &&
1236 !sdev->handler)
1237 return 0;
1238#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001239 return attr->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240}
1241
Hannes Reinecke7e479762016-03-03 07:41:24 +01001242static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1243 struct bin_attribute *attr, int i)
1244{
Guosong Su9e7bd9452020-02-25 18:04:11 +08001245 struct device *dev = kobj_to_dev(kobj);
Hannes Reinecke7e479762016-03-03 07:41:24 +01001246 struct scsi_device *sdev = to_scsi_device(dev);
1247
1248
Ryan Attardd188b062019-09-26 11:22:17 -05001249 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1250 return 0;
1251
Hannes Reinecke7e479762016-03-03 07:41:24 +01001252 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1253 return 0;
1254
Hannes Reinecke68887582016-03-10 11:25:26 +01001255 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
Hannes Reinecke7e479762016-03-03 07:41:24 +01001256 return 0;
1257
Ryan Attardd188b062019-09-26 11:22:17 -05001258 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1259 return 0;
1260
Hannes Reinecke7e479762016-03-03 07:41:24 +01001261 return S_IRUGO;
1262}
1263
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001264/* Default template for device attributes. May NOT be modified */
1265static struct attribute *scsi_sdev_attrs[] = {
1266 &dev_attr_device_blocked.attr,
1267 &dev_attr_type.attr,
1268 &dev_attr_scsi_level.attr,
1269 &dev_attr_device_busy.attr,
1270 &dev_attr_vendor.attr,
1271 &dev_attr_model.attr,
1272 &dev_attr_rev.attr,
1273 &dev_attr_rescan.attr,
1274 &dev_attr_delete.attr,
1275 &dev_attr_state.attr,
1276 &dev_attr_timeout.attr,
1277 &dev_attr_eh_timeout.attr,
1278 &dev_attr_iocounterbits.attr,
1279 &dev_attr_iorequest_cnt.attr,
1280 &dev_attr_iodone_cnt.attr,
1281 &dev_attr_ioerr_cnt.attr,
1282 &dev_attr_modalias.attr,
1283 &dev_attr_queue_depth.attr,
1284 &dev_attr_queue_type.attr,
Hannes Reinecke248d4fe2015-12-01 10:16:56 +01001285 &dev_attr_wwid.attr,
Hannes Reinecke345e2962017-10-02 16:26:34 +02001286 &dev_attr_blacklist.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001287#ifdef CONFIG_SCSI_DH
1288 &dev_attr_dh_state.attr,
Hannes Reinecke77c9df92016-03-03 07:54:07 +01001289 &dev_attr_access_state.attr,
1290 &dev_attr_preferred_path.attr,
Hannes Reinecke41f95dd2015-12-01 10:16:41 +01001291#endif
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001292 &dev_attr_queue_ramp_up_period.attr,
1293 REF_EVT(media_change),
1294 REF_EVT(inquiry_change_reported),
1295 REF_EVT(capacity_change_reported),
1296 REF_EVT(soft_threshold_reached),
1297 REF_EVT(mode_parameter_change_reported),
1298 REF_EVT(lun_change_reported),
1299 NULL
1300};
1301
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001302static struct bin_attribute *scsi_sdev_bin_attrs[] = {
Ryan Attardd188b062019-09-26 11:22:17 -05001303 &dev_attr_vpd_pg0,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001304 &dev_attr_vpd_pg83,
1305 &dev_attr_vpd_pg80,
Ryan Attardd188b062019-09-26 11:22:17 -05001306 &dev_attr_vpd_pg89,
Johannes Thumshirn92e62462015-11-09 10:56:57 +01001307 &dev_attr_inquiry,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001308 NULL
1309};
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001310static struct attribute_group scsi_sdev_attr_group = {
1311 .attrs = scsi_sdev_attrs,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +01001312 .bin_attrs = scsi_sdev_bin_attrs,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001313 .is_visible = scsi_sdev_attr_is_visible,
Hannes Reinecke7e479762016-03-03 07:41:24 +01001314 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
Hannes Reinecke276b20d2014-03-15 09:51:47 +01001315};
1316
1317static const struct attribute_group *scsi_sdev_attr_groups[] = {
1318 &scsi_sdev_attr_group,
1319 NULL
1320};
1321
James Bottomley643eb2d2008-03-22 22:42:27 -05001322static int scsi_target_add(struct scsi_target *starget)
1323{
1324 int error;
1325
1326 if (starget->state != STARGET_CREATED)
1327 return 0;
1328
1329 error = device_add(&starget->dev);
1330 if (error) {
1331 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
James Bottomley643eb2d2008-03-22 22:42:27 -05001332 return error;
1333 }
1334 transport_add_device(&starget->dev);
1335 starget->state = STARGET_RUNNING;
1336
Alan Sternbc4f2402010-06-17 10:41:42 -04001337 pm_runtime_set_active(&starget->dev);
1338 pm_runtime_enable(&starget->dev);
1339 device_enable_async_suspend(&starget->dev);
1340
James Bottomley643eb2d2008-03-22 22:42:27 -05001341 return 0;
1342}
1343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344/**
1345 * scsi_sysfs_add_sdev - add scsi device to sysfs
1346 * @sdev: scsi_device to add
1347 *
1348 * Return value:
1349 * 0 on Success / non-zero on Failure
1350 **/
1351int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1352{
Bart Van Assche92c4b582021-10-12 16:35:13 -07001353 int error;
James Bottomley643eb2d2008-03-22 22:42:27 -05001354 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
James Bottomley643eb2d2008-03-22 22:42:27 -05001356 error = scsi_target_add(starget);
1357 if (error)
1358 return error;
1359
1360 transport_configure_device(&starget->dev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001361
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001362 device_enable_async_suspend(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001363 scsi_autopm_get_target(starget);
1364 pm_runtime_set_active(&sdev->sdev_gendev);
Stanley Chuc74f8052019-09-16 23:56:49 +08001365 if (!sdev->rpm_autosuspend)
1366 pm_runtime_forbid(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001367 pm_runtime_enable(&sdev->sdev_gendev);
1368 scsi_autopm_put_target(starget);
1369
Alan Sternbc4f2402010-06-17 10:41:42 -04001370 scsi_autopm_get_device(sdev);
1371
Hannes Reinecke2930f812017-09-20 09:18:52 +02001372 scsi_dh_add_device(sdev);
Christoph Hellwig086b91d2015-08-27 14:16:57 +02001373
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001374 error = device_add(&sdev->sdev_gendev);
1375 if (error) {
1376 sdev_printk(KERN_INFO, sdev,
1377 "failed to add device: %d\n", error);
Hannes Reinecke4cd24592016-03-03 07:54:12 +01001378 return error;
1379 }
1380
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001381 device_enable_async_suspend(&sdev->sdev_dev);
Tony Jonesee959b02008-02-22 00:13:36 +01001382 error = device_add(&sdev->sdev_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001384 sdev_printk(KERN_INFO, sdev,
1385 "failed to add class device: %d\n", error);
James Bottomley860dc732009-11-19 17:48:29 -05001386 device_del(&sdev->sdev_gendev);
Alan Sternee37e092010-02-12 12:13:55 -05001387 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 }
James Bottomley860dc732009-11-19 17:48:29 -05001389 transport_add_device(&sdev->sdev_gendev);
1390 sdev->is_visible = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001392 if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1393 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1394 if (IS_ERR(sdev->bsg_dev)) {
1395 /*
1396 * We're treating error on bsg register as non-fatal, so
1397 * pretend nothing went wrong.
1398 */
Jackie Liu5f7cf822021-10-22 09:02:01 +08001399 error = PTR_ERR(sdev->bsg_dev);
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001400 sdev_printk(KERN_INFO, sdev,
1401 "Failed to register bsg queue, errno=%d\n",
1402 error);
1403 sdev->bsg_dev = NULL;
1404 }
1405 }
James Bottomley80ed71c2007-07-19 10:15:10 -05001406
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03001407 scsi_autopm_put_device(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409}
1410
Alan Stern903f4fed2005-07-26 10:20:53 -04001411void __scsi_remove_device(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412{
James Bottomleydf133c22005-11-06 11:47:08 -06001413 struct device *dev = &sdev->sdev_gendev;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001414 int res;
James Bottomleydf133c22005-11-06 11:47:08 -06001415
Vitaly Kuznetsovbe821fd2015-11-19 14:02:19 +01001416 /*
1417 * This cleanup path is not reentrant and while it is impossible
1418 * to get a new reference with scsi_device_get() someone can still
1419 * hold a previously acquired one.
1420 */
1421 if (sdev->sdev_state == SDEV_DEL)
1422 return;
1423
James Bottomley860dc732009-11-19 17:48:29 -05001424 if (sdev->is_visible) {
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001425 /*
1426 * If scsi_internal_target_block() is running concurrently,
1427 * wait until it has finished before changing the device state.
1428 */
1429 mutex_lock(&sdev->state_mutex);
Bart Van Assche255ee932017-06-02 14:21:57 -07001430 /*
1431 * If blocked, we go straight to DEL and restart the queue so
1432 * any commands issued during driver shutdown (like sync
1433 * cache) are errored immediately.
1434 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001435 res = scsi_device_set_state(sdev, SDEV_CANCEL);
Bart Van Assche255ee932017-06-02 14:21:57 -07001436 if (res != 0) {
1437 res = scsi_device_set_state(sdev, SDEV_DEL);
1438 if (res == 0)
1439 scsi_start_queue(sdev);
1440 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001441 mutex_unlock(&sdev->state_mutex);
1442
1443 if (res != 0)
James Bottomley860dc732009-11-19 17:48:29 -05001444 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Christoph Hellwigead09dd2021-07-29 08:48:42 +02001446 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1447 bsg_unregister_queue(sdev->bsg_dev);
James Bottomley860dc732009-11-19 17:48:29 -05001448 device_unregister(&sdev->sdev_dev);
1449 transport_remove_device(dev);
Bart Van Asschee619e6c2015-11-20 14:11:01 -08001450 device_del(dev);
1451 } else
1452 put_device(&sdev->sdev_dev);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001453
1454 /*
1455 * Stop accepting new requests and wait until all queuecommand() and
1456 * scsi_run_queue() invocations have finished before tearing down the
1457 * device.
1458 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001459 mutex_lock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 scsi_device_set_state(sdev, SDEV_DEL);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001461 mutex_unlock(&sdev->state_mutex);
1462
Bart Van Asscheb4854622012-06-29 15:36:07 +00001463 blk_cleanup_queue(sdev->request_queue);
1464 cancel_work_sync(&sdev->requeue_work);
1465
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 if (sdev->host->hostt->slave_destroy)
1467 sdev->host->hostt->slave_destroy(sdev);
James Bottomleydf133c22005-11-06 11:47:08 -06001468 transport_destroy_device(dev);
James Bottomley86cbfb52011-04-22 10:39:59 -05001469
James Bottomleye63ed0d2014-01-21 07:00:50 -08001470 /*
1471 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
dudengkeeee89102021-03-26 14:09:02 +08001472 * removed sysfs visibility from the device, so make the target
James Bottomleye63ed0d2014-01-21 07:00:50 -08001473 * invisible if this was the last device underneath it.
1474 */
1475 scsi_target_reap(scsi_target(sdev));
1476
James Bottomleydf133c22005-11-06 11:47:08 -06001477 put_device(dev);
Alan Stern903f4fed2005-07-26 10:20:53 -04001478}
1479
1480/**
1481 * scsi_remove_device - unregister a device from the scsi bus
1482 * @sdev: scsi_device to unregister
1483 **/
1484void scsi_remove_device(struct scsi_device *sdev)
1485{
Alan Stern54195002005-09-15 21:52:51 -04001486 struct Scsi_Host *shost = sdev->host;
1487
Arjan van de Ven0b950672006-01-11 13:16:10 +01001488 mutex_lock(&shost->scan_mutex);
Alan Stern903f4fed2005-07-26 10:20:53 -04001489 __scsi_remove_device(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01001490 mutex_unlock(&shost->scan_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491}
1492EXPORT_SYMBOL(scsi_remove_device);
1493
Adrian Bunk44818ef2007-07-09 11:59:59 -07001494static void __scsi_remove_target(struct scsi_target *starget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495{
1496 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1497 unsigned long flags;
Alan Sterna64358d2005-07-26 10:27:10 -04001498 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
1500 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001501 restart:
1502 list_for_each_entry(sdev, &shost->__devices, siblings) {
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001503 /*
1504 * We cannot call scsi_device_get() here, as
1505 * we might've been called from rmmod() causing
1506 * scsi_device_get() to fail the module_is_live()
1507 * check.
1508 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 if (sdev->channel != starget->channel ||
Hannes Reinecke81b6c992017-12-13 14:21:37 +01001510 sdev->id != starget->id)
1511 continue;
1512 if (sdev->sdev_state == SDEV_DEL ||
1513 sdev->sdev_state == SDEV_CANCEL ||
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001514 !get_device(&sdev->sdev_gendev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 continue;
1516 spin_unlock_irqrestore(shost->host_lock, flags);
1517 scsi_remove_device(sdev);
Hannes Reineckefbce4d92017-10-04 10:28:56 +02001518 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001520 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 }
1522 spin_unlock_irqrestore(shost->host_lock, flags);
mochel@digitalimplant.org20b1e672005-03-24 19:03:59 -08001523}
1524
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525/**
1526 * scsi_remove_target - try to remove a target and all its devices
1527 * @dev: generic starget or parent of generic stargets to be removed
1528 *
1529 * Note: This is slightly racy. It is possible that if the user
1530 * requests the addition of another device then the target won't be
1531 * removed.
1532 */
1533void scsi_remove_target(struct device *dev)
1534{
Dan Williams3b661a92012-06-21 23:47:28 -07001535 struct Scsi_Host *shost = dev_to_shost(dev->parent);
Johannes Thumshirn305c2e72016-04-05 11:50:45 +02001536 struct scsi_target *starget;
Dan Williams3b661a92012-06-21 23:47:28 -07001537 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
Christoph Hellwig40998192015-10-19 16:35:46 +02001539restart:
Dan Williams3b661a92012-06-21 23:47:28 -07001540 spin_lock_irqsave(shost->host_lock, flags);
1541 list_for_each_entry(starget, &shost->__targets, siblings) {
James Bottomley90a88d62016-02-10 08:03:26 -08001542 if (starget->state == STARGET_DEL ||
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001543 starget->state == STARGET_REMOVE ||
1544 starget->state == STARGET_CREATED_REMOVE)
Dan Williams3b661a92012-06-21 23:47:28 -07001545 continue;
1546 if (starget->dev.parent == dev || &starget->dev == dev) {
James Bottomleye63ed0d2014-01-21 07:00:50 -08001547 kref_get(&starget->reap_ref);
Ewan D. Milnef9279c92017-06-27 14:55:58 -04001548 if (starget->state == STARGET_CREATED)
1549 starget->state = STARGET_CREATED_REMOVE;
1550 else
1551 starget->state = STARGET_REMOVE;
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001552 spin_unlock_irqrestore(shost->host_lock, flags);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001553 __scsi_remove_target(starget);
Christoph Hellwig40998192015-10-19 16:35:46 +02001554 scsi_target_reap(starget);
1555 goto restart;
Dan Williams3b661a92012-06-21 23:47:28 -07001556 }
1557 }
1558 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559}
1560EXPORT_SYMBOL(scsi_remove_target);
1561
1562int scsi_register_driver(struct device_driver *drv)
1563{
1564 drv->bus = &scsi_bus_type;
1565
1566 return driver_register(drv);
1567}
1568EXPORT_SYMBOL(scsi_register_driver);
1569
1570int scsi_register_interface(struct class_interface *intf)
1571{
1572 intf->class = &sdev_class;
1573
1574 return class_interface_register(intf);
1575}
1576EXPORT_SYMBOL(scsi_register_interface);
1577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578/**
1579 * scsi_sysfs_add_host - add scsi host to subsystem
1580 * @shost: scsi host struct to add to subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 **/
1582int scsi_sysfs_add_host(struct Scsi_Host *shost)
1583{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 transport_register_device(&shost->shost_gendev);
James Bottomleyd52b3812008-01-05 09:38:30 -06001585 transport_configure_device(&shost->shost_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 return 0;
1587}
1588
Kay Sieversbfd12942007-09-11 17:00:14 +02001589static struct device_type scsi_dev_type = {
1590 .name = "scsi_device",
1591 .release = scsi_device_dev_release,
1592 .groups = scsi_sdev_attr_groups,
1593};
1594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1596{
1597 unsigned long flags;
1598 struct Scsi_Host *shost = sdev->host;
Bart Van Assche92c4b582021-10-12 16:35:13 -07001599 struct scsi_host_template *hostt = shost->hostt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 struct scsi_target *starget = sdev->sdev_target;
1601
1602 device_initialize(&sdev->sdev_gendev);
1603 sdev->sdev_gendev.bus = &scsi_bus_type;
Kay Sieversbfd12942007-09-11 17:00:14 +02001604 sdev->sdev_gendev.type = &scsi_dev_type;
Bart Van Asschea19a93e2021-10-06 14:54:51 -07001605 scsi_enable_async_suspend(&sdev->sdev_gendev);
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001606 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001607 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Steffen Maier3a71f0f2021-10-26 03:42:40 +02001608 sdev->sdev_gendev.groups = hostt->sdev_groups;
Kay Sievers71610f52008-12-03 22:41:36 +01001609
Tony Jonesee959b02008-02-22 00:13:36 +01001610 device_initialize(&sdev->sdev_dev);
James Bottomley37e6ba02009-10-02 13:30:08 -05001611 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
Tony Jonesee959b02008-02-22 00:13:36 +01001612 sdev->sdev_dev.class = &sdev_class;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001613 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001614 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Alan Stern50c4e962014-09-02 11:35:50 -04001615 /*
1616 * Get a default scsi_level from the target (derived from sibling
1617 * devices). This is the best we can do for guessing how to set
1618 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1619 * setting doesn't matter, because all the bits are zero anyway.
1620 * But it does matter for higher LUNs.
1621 */
Alan Stern7c9d6f12007-01-08 11:12:32 -05001622 sdev->scsi_level = starget->scsi_level;
Alan Stern50c4e962014-09-02 11:35:50 -04001623 if (sdev->scsi_level <= SCSI_2 &&
1624 sdev->scsi_level != SCSI_UNKNOWN &&
1625 !shost->no_scsi2_lun_in_cdb)
1626 sdev->lun_in_cdb = 1;
1627
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 transport_setup_device(&sdev->sdev_gendev);
1629 spin_lock_irqsave(shost->host_lock, flags);
1630 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1631 list_add_tail(&sdev->siblings, &shost->__devices);
1632 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomleye63ed0d2014-01-21 07:00:50 -08001633 /*
1634 * device can now only be removed via __scsi_remove_device() so hold
1635 * the target. Target will be held in CREATED state until something
1636 * beneath it becomes visible (in which case it moves to RUNNING)
1637 */
1638 kref_get(&starget->reap_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639}
1640
1641int scsi_is_sdev_device(const struct device *dev)
1642{
Kay Sievers13ba9bc2007-09-26 19:54:49 +02001643 return dev->type == &scsi_dev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644}
1645EXPORT_SYMBOL(scsi_is_sdev_device);
1646
1647/* A blank transport template that is used in drivers that don't
1648 * yet implement Transport Attributes */
1649struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };