blob: 6aeb79e744e0b7cbcf47d77be855822f31316863 [file] [log] [blame]
David Brazdil0f672f62019-12-10 10:32:29 +00001// SPDX-License-Identifier: GPL-2.0-only
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002/*
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
10#include <linux/module.h>
11#include <linux/slab.h>
12#include <linux/init.h>
13#include <linux/blkdev.h>
14#include <linux/device.h>
15#include <linux/pm_runtime.h>
16
17#include <scsi/scsi.h>
18#include <scsi/scsi_device.h>
19#include <scsi/scsi_host.h>
20#include <scsi/scsi_tcq.h>
21#include <scsi/scsi_dh.h>
22#include <scsi/scsi_transport.h>
23#include <scsi/scsi_driver.h>
24#include <scsi/scsi_devinfo.h>
25
26#include "scsi_priv.h"
27#include "scsi_logging.h"
28
29static struct device_type scsi_dev_type;
30
31static const struct {
32 enum scsi_device_state value;
33 char *name;
34} sdev_states[] = {
35 { SDEV_CREATED, "created" },
36 { SDEV_RUNNING, "running" },
37 { SDEV_CANCEL, "cancel" },
38 { SDEV_DEL, "deleted" },
39 { SDEV_QUIESCE, "quiesce" },
40 { SDEV_OFFLINE, "offline" },
41 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
42 { SDEV_BLOCK, "blocked" },
43 { SDEV_CREATED_BLOCK, "created-blocked" },
44};
45
46const char *scsi_device_state_name(enum scsi_device_state state)
47{
48 int i;
49 char *name = NULL;
50
51 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
52 if (sdev_states[i].value == state) {
53 name = sdev_states[i].name;
54 break;
55 }
56 }
57 return name;
58}
59
60static const struct {
61 enum scsi_host_state value;
62 char *name;
63} shost_states[] = {
64 { SHOST_CREATED, "created" },
65 { SHOST_RUNNING, "running" },
66 { SHOST_CANCEL, "cancel" },
67 { SHOST_DEL, "deleted" },
68 { SHOST_RECOVERY, "recovery" },
69 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
70 { SHOST_DEL_RECOVERY, "deleted/recovery", },
71};
72const char *scsi_host_state_name(enum scsi_host_state state)
73{
74 int i;
75 char *name = NULL;
76
77 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
78 if (shost_states[i].value == state) {
79 name = shost_states[i].name;
80 break;
81 }
82 }
83 return name;
84}
85
86#ifdef CONFIG_SCSI_DH
87static const struct {
88 unsigned char value;
89 char *name;
90} sdev_access_states[] = {
91 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
92 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
93 { SCSI_ACCESS_STATE_STANDBY, "standby" },
94 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
95 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
96 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
97 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
98};
99
100static const char *scsi_access_state_name(unsigned char state)
101{
102 int i;
103 char *name = NULL;
104
105 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
106 if (sdev_access_states[i].value == state) {
107 name = sdev_access_states[i].name;
108 break;
109 }
110 }
111 return name;
112}
113#endif
114
115static int check_set(unsigned long long *val, char *src)
116{
117 char *last;
118
119 if (strcmp(src, "-") == 0) {
120 *val = SCAN_WILD_CARD;
121 } else {
122 /*
123 * Doesn't check for int overflow
124 */
125 *val = simple_strtoull(src, &last, 0);
126 if (*last != '\0')
127 return 1;
128 }
129 return 0;
130}
131
132static int scsi_scan(struct Scsi_Host *shost, const char *str)
133{
134 char s1[15], s2[15], s3[17], junk;
135 unsigned long long channel, id, lun;
136 int res;
137
138 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
139 if (res != 3)
140 return -EINVAL;
141 if (check_set(&channel, s1))
142 return -EINVAL;
143 if (check_set(&id, s2))
144 return -EINVAL;
145 if (check_set(&lun, s3))
146 return -EINVAL;
147 if (shost->transportt->user_scan)
148 res = shost->transportt->user_scan(shost, channel, id, lun);
149 else
150 res = scsi_scan_host_selected(shost, channel, id, lun,
151 SCSI_SCAN_MANUAL);
152 return res;
153}
154
155/*
156 * shost_show_function: macro to create an attr function that can be used to
157 * show a non-bit field.
158 */
159#define shost_show_function(name, field, format_string) \
160static ssize_t \
161show_##name (struct device *dev, struct device_attribute *attr, \
162 char *buf) \
163{ \
164 struct Scsi_Host *shost = class_to_shost(dev); \
165 return snprintf (buf, 20, format_string, shost->field); \
166}
167
168/*
169 * shost_rd_attr: macro to create a function and attribute variable for a
170 * read only field.
171 */
172#define shost_rd_attr2(name, field, format_string) \
173 shost_show_function(name, field, format_string) \
174static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
175
176#define shost_rd_attr(field, format_string) \
177shost_rd_attr2(field, field, format_string)
178
179/*
180 * Create the actual show/store functions and data structures.
181 */
182
183static ssize_t
184store_scan(struct device *dev, struct device_attribute *attr,
185 const char *buf, size_t count)
186{
187 struct Scsi_Host *shost = class_to_shost(dev);
188 int res;
189
190 res = scsi_scan(shost, buf);
191 if (res == 0)
192 res = count;
193 return res;
194};
195static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
196
197static ssize_t
198store_shost_state(struct device *dev, struct device_attribute *attr,
199 const char *buf, size_t count)
200{
201 int i;
202 struct Scsi_Host *shost = class_to_shost(dev);
203 enum scsi_host_state state = 0;
204
205 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
206 const int len = strlen(shost_states[i].name);
207 if (strncmp(shost_states[i].name, buf, len) == 0 &&
208 buf[len] == '\n') {
209 state = shost_states[i].value;
210 break;
211 }
212 }
213 if (!state)
214 return -EINVAL;
215
216 if (scsi_host_set_state(shost, state))
217 return -EINVAL;
218 return count;
219}
220
221static ssize_t
222show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
223{
224 struct Scsi_Host *shost = class_to_shost(dev);
225 const char *name = scsi_host_state_name(shost->shost_state);
226
227 if (!name)
228 return -EINVAL;
229
230 return snprintf(buf, 20, "%s\n", name);
231}
232
233/* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
234static struct device_attribute dev_attr_hstate =
235 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
236
237static ssize_t
238show_shost_mode(unsigned int mode, char *buf)
239{
240 ssize_t len = 0;
241
242 if (mode & MODE_INITIATOR)
243 len = sprintf(buf, "%s", "Initiator");
244
245 if (mode & MODE_TARGET)
246 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
247
248 len += sprintf(buf + len, "\n");
249
250 return len;
251}
252
253static ssize_t
254show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
255 char *buf)
256{
257 struct Scsi_Host *shost = class_to_shost(dev);
258 unsigned int supported_mode = shost->hostt->supported_mode;
259
260 if (supported_mode == MODE_UNKNOWN)
261 /* by default this should be initiator */
262 supported_mode = MODE_INITIATOR;
263
264 return show_shost_mode(supported_mode, buf);
265}
266
267static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
268
269static ssize_t
270show_shost_active_mode(struct device *dev,
271 struct device_attribute *attr, char *buf)
272{
273 struct Scsi_Host *shost = class_to_shost(dev);
274
275 if (shost->active_mode == MODE_UNKNOWN)
276 return snprintf(buf, 20, "unknown\n");
277 else
278 return show_shost_mode(shost->active_mode, buf);
279}
280
281static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
282
283static int check_reset_type(const char *str)
284{
285 if (sysfs_streq(str, "adapter"))
286 return SCSI_ADAPTER_RESET;
287 else if (sysfs_streq(str, "firmware"))
288 return SCSI_FIRMWARE_RESET;
289 else
290 return 0;
291}
292
293static ssize_t
294store_host_reset(struct device *dev, struct device_attribute *attr,
295 const char *buf, size_t count)
296{
297 struct Scsi_Host *shost = class_to_shost(dev);
298 struct scsi_host_template *sht = shost->hostt;
299 int ret = -EINVAL;
300 int type;
301
302 type = check_reset_type(buf);
303 if (!type)
304 goto exit_store_host_reset;
305
306 if (sht->host_reset)
307 ret = sht->host_reset(shost, type);
308 else
309 ret = -EOPNOTSUPP;
310
311exit_store_host_reset:
312 if (ret == 0)
313 ret = count;
314 return ret;
315}
316
317static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
318
319static ssize_t
320show_shost_eh_deadline(struct device *dev,
321 struct device_attribute *attr, char *buf)
322{
323 struct Scsi_Host *shost = class_to_shost(dev);
324
325 if (shost->eh_deadline == -1)
326 return snprintf(buf, strlen("off") + 2, "off\n");
327 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
328}
329
330static ssize_t
331store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
332 const char *buf, size_t count)
333{
334 struct Scsi_Host *shost = class_to_shost(dev);
335 int ret = -EINVAL;
336 unsigned long deadline, flags;
337
338 if (shost->transportt &&
339 (shost->transportt->eh_strategy_handler ||
340 !shost->hostt->eh_host_reset_handler))
341 return ret;
342
343 if (!strncmp(buf, "off", strlen("off")))
344 deadline = -1;
345 else {
346 ret = kstrtoul(buf, 10, &deadline);
347 if (ret)
348 return ret;
349 if (deadline * HZ > UINT_MAX)
350 return -EINVAL;
351 }
352
353 spin_lock_irqsave(shost->host_lock, flags);
354 if (scsi_host_in_recovery(shost))
355 ret = -EBUSY;
356 else {
357 if (deadline == -1)
358 shost->eh_deadline = -1;
359 else
360 shost->eh_deadline = deadline * HZ;
361
362 ret = count;
363 }
364 spin_unlock_irqrestore(shost->host_lock, flags);
365
366 return ret;
367}
368
369static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
370
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000371shost_rd_attr(unique_id, "%u\n");
372shost_rd_attr(cmd_per_lun, "%hd\n");
373shost_rd_attr(can_queue, "%hd\n");
374shost_rd_attr(sg_tablesize, "%hu\n");
375shost_rd_attr(sg_prot_tablesize, "%hu\n");
376shost_rd_attr(unchecked_isa_dma, "%d\n");
377shost_rd_attr(prot_capabilities, "%u\n");
378shost_rd_attr(prot_guard_type, "%hd\n");
379shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
380
381static ssize_t
382show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
383{
384 struct Scsi_Host *shost = class_to_shost(dev);
385 return snprintf(buf, 20, "%d\n", scsi_host_busy(shost));
386}
387static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
388
David Brazdil0f672f62019-12-10 10:32:29 +0000389static 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
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000396static struct attribute *scsi_sysfs_shost_attrs[] = {
397 &dev_attr_use_blk_mq.attr,
398 &dev_attr_unique_id.attr,
399 &dev_attr_host_busy.attr,
400 &dev_attr_cmd_per_lun.attr,
401 &dev_attr_can_queue.attr,
402 &dev_attr_sg_tablesize.attr,
403 &dev_attr_sg_prot_tablesize.attr,
404 &dev_attr_unchecked_isa_dma.attr,
405 &dev_attr_proc_name.attr,
406 &dev_attr_scan.attr,
407 &dev_attr_hstate.attr,
408 &dev_attr_supported_mode.attr,
409 &dev_attr_active_mode.attr,
410 &dev_attr_prot_capabilities.attr,
411 &dev_attr_prot_guard_type.attr,
412 &dev_attr_host_reset.attr,
413 &dev_attr_eh_deadline.attr,
414 NULL
415};
416
417static struct attribute_group scsi_shost_attr_group = {
418 .attrs = scsi_sysfs_shost_attrs,
419};
420
421const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
422 &scsi_shost_attr_group,
423 NULL
424};
425
426static void scsi_device_cls_release(struct device *class_dev)
427{
428 struct scsi_device *sdev;
429
430 sdev = class_to_sdev(class_dev);
431 put_device(&sdev->sdev_gendev);
432}
433
434static void scsi_device_dev_release_usercontext(struct work_struct *work)
435{
436 struct scsi_device *sdev;
437 struct device *parent;
438 struct list_head *this, *tmp;
439 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
440 unsigned long flags;
441
442 sdev = container_of(work, struct scsi_device, ew.work);
443
444 scsi_dh_release_device(sdev);
445
446 parent = sdev->sdev_gendev.parent;
447
448 spin_lock_irqsave(sdev->host->host_lock, flags);
449 list_del(&sdev->siblings);
450 list_del(&sdev->same_target_siblings);
451 list_del(&sdev->starved_entry);
452 spin_unlock_irqrestore(sdev->host->host_lock, flags);
453
454 cancel_work_sync(&sdev->event_work);
455
456 list_for_each_safe(this, tmp, &sdev->event_list) {
457 struct scsi_event *evt;
458
459 evt = list_entry(this, struct scsi_event, node);
460 list_del(&evt->node);
461 kfree(evt);
462 }
463
464 blk_put_queue(sdev->request_queue);
465 /* NULL queue means the device can't be used */
466 sdev->request_queue = NULL;
467
468 mutex_lock(&sdev->inquiry_mutex);
469 rcu_swap_protected(sdev->vpd_pg80, vpd_pg80,
470 lockdep_is_held(&sdev->inquiry_mutex));
471 rcu_swap_protected(sdev->vpd_pg83, vpd_pg83,
472 lockdep_is_held(&sdev->inquiry_mutex));
473 mutex_unlock(&sdev->inquiry_mutex);
474
475 if (vpd_pg83)
476 kfree_rcu(vpd_pg83, rcu);
477 if (vpd_pg80)
478 kfree_rcu(vpd_pg80, rcu);
479 kfree(sdev->inquiry);
480 kfree(sdev);
481
482 if (parent)
483 put_device(parent);
484}
485
486static void scsi_device_dev_release(struct device *dev)
487{
488 struct scsi_device *sdp = to_scsi_device(dev);
489 execute_in_process_context(scsi_device_dev_release_usercontext,
490 &sdp->ew);
491}
492
493static struct class sdev_class = {
494 .name = "scsi_device",
495 .dev_release = scsi_device_cls_release,
496};
497
498/* all probing is done in the individual ->probe routines */
499static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
500{
501 struct scsi_device *sdp;
502
503 if (dev->type != &scsi_dev_type)
504 return 0;
505
506 sdp = to_scsi_device(dev);
507 if (sdp->no_uld_attach)
508 return 0;
509 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
510}
511
512static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
513{
514 struct scsi_device *sdev;
515
516 if (dev->type != &scsi_dev_type)
517 return 0;
518
519 sdev = to_scsi_device(dev);
520
521 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
522 return 0;
523}
524
525struct bus_type scsi_bus_type = {
526 .name = "scsi",
527 .match = scsi_bus_match,
528 .uevent = scsi_bus_uevent,
529#ifdef CONFIG_PM
530 .pm = &scsi_bus_pm_ops,
531#endif
532};
533EXPORT_SYMBOL_GPL(scsi_bus_type);
534
535int scsi_sysfs_register(void)
536{
537 int error;
538
539 error = bus_register(&scsi_bus_type);
540 if (!error) {
541 error = class_register(&sdev_class);
542 if (error)
543 bus_unregister(&scsi_bus_type);
544 }
545
546 return error;
547}
548
549void scsi_sysfs_unregister(void)
550{
551 class_unregister(&sdev_class);
552 bus_unregister(&scsi_bus_type);
553}
554
555/*
556 * sdev_show_function: macro to create an attr function that can be used to
557 * show a non-bit field.
558 */
559#define sdev_show_function(field, format_string) \
560static ssize_t \
561sdev_show_##field (struct device *dev, struct device_attribute *attr, \
562 char *buf) \
563{ \
564 struct scsi_device *sdev; \
565 sdev = to_scsi_device(dev); \
566 return snprintf (buf, 20, format_string, sdev->field); \
567} \
568
569/*
570 * sdev_rd_attr: macro to create a function and attribute variable for a
571 * read only field.
572 */
573#define sdev_rd_attr(field, format_string) \
574 sdev_show_function(field, format_string) \
575static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
576
577
578/*
579 * sdev_rw_attr: create a function and attribute variable for a
580 * read/write field.
581 */
582#define sdev_rw_attr(field, format_string) \
583 sdev_show_function(field, format_string) \
584 \
585static ssize_t \
586sdev_store_##field (struct device *dev, struct device_attribute *attr, \
587 const char *buf, size_t count) \
588{ \
589 struct scsi_device *sdev; \
590 sdev = to_scsi_device(dev); \
591 sscanf (buf, format_string, &sdev->field); \
592 return count; \
593} \
594static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
595
596/* Currently we don't export bit fields, but we might in future,
597 * so leave this code in */
598#if 0
599/*
600 * sdev_rd_attr: create a function and attribute variable for a
601 * read/write bit field.
602 */
603#define sdev_rw_attr_bit(field) \
604 sdev_show_function(field, "%d\n") \
605 \
606static ssize_t \
607sdev_store_##field (struct device *dev, struct device_attribute *attr, \
608 const char *buf, size_t count) \
609{ \
610 int ret; \
611 struct scsi_device *sdev; \
612 ret = scsi_sdev_check_buf_bit(buf); \
613 if (ret >= 0) { \
614 sdev = to_scsi_device(dev); \
615 sdev->field = ret; \
616 ret = count; \
617 } \
618 return ret; \
619} \
620static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
621
622/*
623 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
624 * else return -EINVAL.
625 */
626static int scsi_sdev_check_buf_bit(const char *buf)
627{
628 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
629 if (buf[0] == '1')
630 return 1;
631 else if (buf[0] == '0')
632 return 0;
633 else
634 return -EINVAL;
635 } else
636 return -EINVAL;
637}
638#endif
639/*
640 * Create the actual show/store functions and data structures.
641 */
642sdev_rd_attr (type, "%d\n");
643sdev_rd_attr (scsi_level, "%d\n");
644sdev_rd_attr (vendor, "%.8s\n");
645sdev_rd_attr (model, "%.16s\n");
646sdev_rd_attr (rev, "%.4s\n");
647
648static ssize_t
649sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
650 char *buf)
651{
652 struct scsi_device *sdev = to_scsi_device(dev);
653 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
654}
655static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
656
657static ssize_t
658sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
659 char *buf)
660{
661 struct scsi_device *sdev = to_scsi_device(dev);
662 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
663}
664static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
665
666/*
667 * TODO: can we make these symlinks to the block layer ones?
668 */
669static ssize_t
670sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
671{
672 struct scsi_device *sdev;
673 sdev = to_scsi_device(dev);
674 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
675}
676
677static ssize_t
678sdev_store_timeout (struct device *dev, struct device_attribute *attr,
679 const char *buf, size_t count)
680{
681 struct scsi_device *sdev;
682 int timeout;
683 sdev = to_scsi_device(dev);
684 sscanf (buf, "%d\n", &timeout);
685 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
686 return count;
687}
688static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
689
690static ssize_t
691sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
692{
693 struct scsi_device *sdev;
694 sdev = to_scsi_device(dev);
695 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
696}
697
698static ssize_t
699sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
700 const char *buf, size_t count)
701{
702 struct scsi_device *sdev;
703 unsigned int eh_timeout;
704 int err;
705
706 if (!capable(CAP_SYS_ADMIN))
707 return -EACCES;
708
709 sdev = to_scsi_device(dev);
710 err = kstrtouint(buf, 10, &eh_timeout);
711 if (err)
712 return err;
713 sdev->eh_timeout = eh_timeout * HZ;
714
715 return count;
716}
717static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
718
719static ssize_t
720store_rescan_field (struct device *dev, struct device_attribute *attr,
721 const char *buf, size_t count)
722{
723 scsi_rescan_device(dev);
724 return count;
725}
726static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
727
728static ssize_t
729sdev_store_delete(struct device *dev, struct device_attribute *attr,
730 const char *buf, size_t count)
731{
732 struct kernfs_node *kn;
David Brazdil0f672f62019-12-10 10:32:29 +0000733 struct scsi_device *sdev = to_scsi_device(dev);
734
735 /*
736 * We need to try to get module, avoiding the module been removed
737 * during delete.
738 */
739 if (scsi_device_get(sdev))
740 return -ENODEV;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000741
742 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
743 WARN_ON_ONCE(!kn);
744 /*
745 * Concurrent writes into the "delete" sysfs attribute may trigger
746 * concurrent calls to device_remove_file() and scsi_remove_device().
747 * device_remove_file() handles concurrent removal calls by
748 * serializing these and by ignoring the second and later removal
749 * attempts. Concurrent calls of scsi_remove_device() are
750 * serialized. The second and later calls of scsi_remove_device() are
751 * ignored because the first call of that function changes the device
752 * state into SDEV_DEL.
753 */
754 device_remove_file(dev, attr);
David Brazdil0f672f62019-12-10 10:32:29 +0000755 scsi_remove_device(sdev);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000756 if (kn)
757 sysfs_unbreak_active_protection(kn);
David Brazdil0f672f62019-12-10 10:32:29 +0000758 scsi_device_put(sdev);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000759 return count;
760};
761static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
762
763static ssize_t
764store_state_field(struct device *dev, struct device_attribute *attr,
765 const char *buf, size_t count)
766{
767 int i, ret;
768 struct scsi_device *sdev = to_scsi_device(dev);
769 enum scsi_device_state state = 0;
770
771 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
772 const int len = strlen(sdev_states[i].name);
773 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
774 buf[len] == '\n') {
775 state = sdev_states[i].value;
776 break;
777 }
778 }
David Brazdil0f672f62019-12-10 10:32:29 +0000779 switch (state) {
780 case SDEV_RUNNING:
781 case SDEV_OFFLINE:
782 break;
783 default:
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000784 return -EINVAL;
David Brazdil0f672f62019-12-10 10:32:29 +0000785 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000786
787 mutex_lock(&sdev->state_mutex);
788 ret = scsi_device_set_state(sdev, state);
David Brazdil0f672f62019-12-10 10:32:29 +0000789 /*
Olivier Deprez0e641232021-09-23 10:07:05 +0200790 * If the device state changes to SDEV_RUNNING, we need to
791 * run the queue to avoid I/O hang, and rescan the device
792 * to revalidate it. Running the queue first is necessary
793 * because another thread may be waiting inside
794 * blk_mq_freeze_queue_wait() and because that call may be
795 * waiting for pending I/O to finish.
David Brazdil0f672f62019-12-10 10:32:29 +0000796 */
Olivier Deprez0e641232021-09-23 10:07:05 +0200797 if (ret == 0 && state == SDEV_RUNNING) {
David Brazdil0f672f62019-12-10 10:32:29 +0000798 blk_mq_run_hw_queues(sdev->request_queue, true);
Olivier Deprez0e641232021-09-23 10:07:05 +0200799 scsi_rescan_device(dev);
800 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000801 mutex_unlock(&sdev->state_mutex);
802
803 return ret == 0 ? count : -EINVAL;
804}
805
806static ssize_t
807show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
808{
809 struct scsi_device *sdev = to_scsi_device(dev);
810 const char *name = scsi_device_state_name(sdev->sdev_state);
811
812 if (!name)
813 return -EINVAL;
814
815 return snprintf(buf, 20, "%s\n", name);
816}
817
818static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
819
820static ssize_t
821show_queue_type_field(struct device *dev, struct device_attribute *attr,
822 char *buf)
823{
824 struct scsi_device *sdev = to_scsi_device(dev);
825 const char *name = "none";
826
827 if (sdev->simple_tags)
828 name = "simple";
829
830 return snprintf(buf, 20, "%s\n", name);
831}
832
833static ssize_t
834store_queue_type_field(struct device *dev, struct device_attribute *attr,
835 const char *buf, size_t count)
836{
837 struct scsi_device *sdev = to_scsi_device(dev);
838
839 if (!sdev->tagged_supported)
840 return -EINVAL;
841
842 sdev_printk(KERN_INFO, sdev,
843 "ignoring write to deprecated queue_type attribute");
844 return count;
845}
846
847static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
848 store_queue_type_field);
849
850#define sdev_vpd_pg_attr(_page) \
851static ssize_t \
852show_vpd_##_page(struct file *filp, struct kobject *kobj, \
853 struct bin_attribute *bin_attr, \
854 char *buf, loff_t off, size_t count) \
855{ \
856 struct device *dev = container_of(kobj, struct device, kobj); \
857 struct scsi_device *sdev = to_scsi_device(dev); \
858 struct scsi_vpd *vpd_page; \
859 int ret = -EINVAL; \
860 \
861 rcu_read_lock(); \
862 vpd_page = rcu_dereference(sdev->vpd_##_page); \
863 if (vpd_page) \
864 ret = memory_read_from_buffer(buf, count, &off, \
865 vpd_page->data, vpd_page->len); \
866 rcu_read_unlock(); \
867 return ret; \
868} \
869static struct bin_attribute dev_attr_vpd_##_page = { \
870 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
871 .size = 0, \
872 .read = show_vpd_##_page, \
873};
874
875sdev_vpd_pg_attr(pg83);
876sdev_vpd_pg_attr(pg80);
877
878static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
879 struct bin_attribute *bin_attr,
880 char *buf, loff_t off, size_t count)
881{
882 struct device *dev = container_of(kobj, struct device, kobj);
883 struct scsi_device *sdev = to_scsi_device(dev);
884
885 if (!sdev->inquiry)
886 return -EINVAL;
887
888 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
889 sdev->inquiry_len);
890}
891
892static struct bin_attribute dev_attr_inquiry = {
893 .attr = {
894 .name = "inquiry",
895 .mode = S_IRUGO,
896 },
897 .size = 0,
898 .read = show_inquiry,
899};
900
901static ssize_t
902show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
903 char *buf)
904{
905 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
906}
907
908static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
909
910#define show_sdev_iostat(field) \
911static ssize_t \
912show_iostat_##field(struct device *dev, struct device_attribute *attr, \
913 char *buf) \
914{ \
915 struct scsi_device *sdev = to_scsi_device(dev); \
916 unsigned long long count = atomic_read(&sdev->field); \
917 return snprintf(buf, 20, "0x%llx\n", count); \
918} \
919static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
920
921show_sdev_iostat(iorequest_cnt);
922show_sdev_iostat(iodone_cnt);
923show_sdev_iostat(ioerr_cnt);
924
925static ssize_t
926sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
927{
928 struct scsi_device *sdev;
929 sdev = to_scsi_device(dev);
930 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
931}
932static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
933
934#define DECLARE_EVT_SHOW(name, Cap_name) \
935static ssize_t \
936sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
937 char *buf) \
938{ \
939 struct scsi_device *sdev = to_scsi_device(dev); \
940 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
941 return snprintf(buf, 20, "%d\n", val); \
942}
943
944#define DECLARE_EVT_STORE(name, Cap_name) \
945static ssize_t \
946sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
947 const char *buf, size_t count) \
948{ \
949 struct scsi_device *sdev = to_scsi_device(dev); \
950 int val = simple_strtoul(buf, NULL, 0); \
951 if (val == 0) \
952 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
953 else if (val == 1) \
954 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
955 else \
956 return -EINVAL; \
957 return count; \
958}
959
960#define DECLARE_EVT(name, Cap_name) \
961 DECLARE_EVT_SHOW(name, Cap_name) \
962 DECLARE_EVT_STORE(name, Cap_name) \
963 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
964 sdev_store_evt_##name);
965#define REF_EVT(name) &dev_attr_evt_##name.attr
966
967DECLARE_EVT(media_change, MEDIA_CHANGE)
968DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
969DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
970DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
971DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
972DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
973
974static ssize_t
975sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
976 const char *buf, size_t count)
977{
978 int depth, retval;
979 struct scsi_device *sdev = to_scsi_device(dev);
980 struct scsi_host_template *sht = sdev->host->hostt;
981
982 if (!sht->change_queue_depth)
983 return -EINVAL;
984
985 depth = simple_strtoul(buf, NULL, 0);
986
987 if (depth < 1 || depth > sdev->host->can_queue)
988 return -EINVAL;
989
990 retval = sht->change_queue_depth(sdev, depth);
991 if (retval < 0)
992 return retval;
993
994 sdev->max_queue_depth = sdev->queue_depth;
995
996 return count;
997}
998sdev_show_function(queue_depth, "%d\n");
999
1000static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1001 sdev_store_queue_depth);
1002
1003static ssize_t
1004sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1005 char *buf)
1006{
1007 struct scsi_device *sdev = to_scsi_device(dev);
1008 ssize_t count;
1009
1010 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1011 if (count > 0) {
1012 buf[count] = '\n';
1013 count++;
1014 }
1015 return count;
1016}
1017static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1018
1019#define BLIST_FLAG_NAME(name) \
1020 [const_ilog2((__force __u64)BLIST_##name)] = #name
1021static const char *const sdev_bflags_name[] = {
1022#include "scsi_devinfo_tbl.c"
1023};
1024#undef BLIST_FLAG_NAME
1025
1026static ssize_t
1027sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1028 char *buf)
1029{
1030 struct scsi_device *sdev = to_scsi_device(dev);
1031 int i;
1032 ssize_t len = 0;
1033
1034 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1035 const char *name = NULL;
1036
1037 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1038 continue;
1039 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1040 name = sdev_bflags_name[i];
1041
1042 if (name)
1043 len += snprintf(buf + len, PAGE_SIZE - len,
1044 "%s%s", len ? " " : "", name);
1045 else
1046 len += snprintf(buf + len, PAGE_SIZE - len,
1047 "%sINVALID_BIT(%d)", len ? " " : "", i);
1048 }
1049 if (len)
1050 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
1051 return len;
1052}
1053static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1054
1055#ifdef CONFIG_SCSI_DH
1056static ssize_t
1057sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1058 char *buf)
1059{
1060 struct scsi_device *sdev = to_scsi_device(dev);
1061
1062 if (!sdev->handler)
1063 return snprintf(buf, 20, "detached\n");
1064
1065 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1066}
1067
1068static ssize_t
1069sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1070 const char *buf, size_t count)
1071{
1072 struct scsi_device *sdev = to_scsi_device(dev);
1073 int err = -EINVAL;
1074
1075 if (sdev->sdev_state == SDEV_CANCEL ||
1076 sdev->sdev_state == SDEV_DEL)
1077 return -ENODEV;
1078
1079 if (!sdev->handler) {
1080 /*
1081 * Attach to a device handler
1082 */
1083 err = scsi_dh_attach(sdev->request_queue, buf);
1084 } else if (!strncmp(buf, "activate", 8)) {
1085 /*
1086 * Activate a device handler
1087 */
1088 if (sdev->handler->activate)
1089 err = sdev->handler->activate(sdev, NULL, NULL);
1090 else
1091 err = 0;
1092 } else if (!strncmp(buf, "detach", 6)) {
1093 /*
1094 * Detach from a device handler
1095 */
1096 sdev_printk(KERN_WARNING, sdev,
1097 "can't detach handler %s.\n",
1098 sdev->handler->name);
1099 err = -EINVAL;
1100 }
1101
1102 return err < 0 ? err : count;
1103}
1104
1105static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1106 sdev_store_dh_state);
1107
1108static ssize_t
1109sdev_show_access_state(struct device *dev,
1110 struct device_attribute *attr,
1111 char *buf)
1112{
1113 struct scsi_device *sdev = to_scsi_device(dev);
1114 unsigned char access_state;
1115 const char *access_state_name;
1116
1117 if (!sdev->handler)
1118 return -EINVAL;
1119
1120 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1121 access_state_name = scsi_access_state_name(access_state);
1122
1123 return sprintf(buf, "%s\n",
1124 access_state_name ? access_state_name : "unknown");
1125}
1126static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1127
1128static ssize_t
1129sdev_show_preferred_path(struct device *dev,
1130 struct device_attribute *attr,
1131 char *buf)
1132{
1133 struct scsi_device *sdev = to_scsi_device(dev);
1134
1135 if (!sdev->handler)
1136 return -EINVAL;
1137
1138 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1139 return sprintf(buf, "1\n");
1140 else
1141 return sprintf(buf, "0\n");
1142}
1143static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1144#endif
1145
1146static ssize_t
1147sdev_show_queue_ramp_up_period(struct device *dev,
1148 struct device_attribute *attr,
1149 char *buf)
1150{
1151 struct scsi_device *sdev;
1152 sdev = to_scsi_device(dev);
1153 return snprintf(buf, 20, "%u\n",
1154 jiffies_to_msecs(sdev->queue_ramp_up_period));
1155}
1156
1157static ssize_t
1158sdev_store_queue_ramp_up_period(struct device *dev,
1159 struct device_attribute *attr,
1160 const char *buf, size_t count)
1161{
1162 struct scsi_device *sdev = to_scsi_device(dev);
1163 unsigned int period;
1164
1165 if (kstrtouint(buf, 10, &period))
1166 return -EINVAL;
1167
1168 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1169 return count;
1170}
1171
1172static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1173 sdev_show_queue_ramp_up_period,
1174 sdev_store_queue_ramp_up_period);
1175
1176static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1177 struct attribute *attr, int i)
1178{
1179 struct device *dev = container_of(kobj, struct device, kobj);
1180 struct scsi_device *sdev = to_scsi_device(dev);
1181
1182
1183 if (attr == &dev_attr_queue_depth.attr &&
1184 !sdev->host->hostt->change_queue_depth)
1185 return S_IRUGO;
1186
1187 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1188 !sdev->host->hostt->change_queue_depth)
1189 return 0;
1190
1191#ifdef CONFIG_SCSI_DH
1192 if (attr == &dev_attr_access_state.attr &&
1193 !sdev->handler)
1194 return 0;
1195 if (attr == &dev_attr_preferred_path.attr &&
1196 !sdev->handler)
1197 return 0;
1198#endif
1199 return attr->mode;
1200}
1201
1202static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1203 struct bin_attribute *attr, int i)
1204{
1205 struct device *dev = container_of(kobj, struct device, kobj);
1206 struct scsi_device *sdev = to_scsi_device(dev);
1207
1208
1209 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1210 return 0;
1211
1212 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1213 return 0;
1214
1215 return S_IRUGO;
1216}
1217
1218/* Default template for device attributes. May NOT be modified */
1219static struct attribute *scsi_sdev_attrs[] = {
1220 &dev_attr_device_blocked.attr,
1221 &dev_attr_type.attr,
1222 &dev_attr_scsi_level.attr,
1223 &dev_attr_device_busy.attr,
1224 &dev_attr_vendor.attr,
1225 &dev_attr_model.attr,
1226 &dev_attr_rev.attr,
1227 &dev_attr_rescan.attr,
1228 &dev_attr_delete.attr,
1229 &dev_attr_state.attr,
1230 &dev_attr_timeout.attr,
1231 &dev_attr_eh_timeout.attr,
1232 &dev_attr_iocounterbits.attr,
1233 &dev_attr_iorequest_cnt.attr,
1234 &dev_attr_iodone_cnt.attr,
1235 &dev_attr_ioerr_cnt.attr,
1236 &dev_attr_modalias.attr,
1237 &dev_attr_queue_depth.attr,
1238 &dev_attr_queue_type.attr,
1239 &dev_attr_wwid.attr,
1240 &dev_attr_blacklist.attr,
1241#ifdef CONFIG_SCSI_DH
1242 &dev_attr_dh_state.attr,
1243 &dev_attr_access_state.attr,
1244 &dev_attr_preferred_path.attr,
1245#endif
1246 &dev_attr_queue_ramp_up_period.attr,
1247 REF_EVT(media_change),
1248 REF_EVT(inquiry_change_reported),
1249 REF_EVT(capacity_change_reported),
1250 REF_EVT(soft_threshold_reached),
1251 REF_EVT(mode_parameter_change_reported),
1252 REF_EVT(lun_change_reported),
1253 NULL
1254};
1255
1256static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1257 &dev_attr_vpd_pg83,
1258 &dev_attr_vpd_pg80,
1259 &dev_attr_inquiry,
1260 NULL
1261};
1262static struct attribute_group scsi_sdev_attr_group = {
1263 .attrs = scsi_sdev_attrs,
1264 .bin_attrs = scsi_sdev_bin_attrs,
1265 .is_visible = scsi_sdev_attr_is_visible,
1266 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1267};
1268
1269static const struct attribute_group *scsi_sdev_attr_groups[] = {
1270 &scsi_sdev_attr_group,
1271 NULL
1272};
1273
1274static int scsi_target_add(struct scsi_target *starget)
1275{
1276 int error;
1277
1278 if (starget->state != STARGET_CREATED)
1279 return 0;
1280
1281 error = device_add(&starget->dev);
1282 if (error) {
1283 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1284 return error;
1285 }
1286 transport_add_device(&starget->dev);
1287 starget->state = STARGET_RUNNING;
1288
1289 pm_runtime_set_active(&starget->dev);
1290 pm_runtime_enable(&starget->dev);
1291 device_enable_async_suspend(&starget->dev);
1292
1293 return 0;
1294}
1295
1296/**
1297 * scsi_sysfs_add_sdev - add scsi device to sysfs
1298 * @sdev: scsi_device to add
1299 *
1300 * Return value:
1301 * 0 on Success / non-zero on Failure
1302 **/
1303int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1304{
1305 int error, i;
1306 struct request_queue *rq = sdev->request_queue;
1307 struct scsi_target *starget = sdev->sdev_target;
1308
1309 error = scsi_target_add(starget);
1310 if (error)
1311 return error;
1312
1313 transport_configure_device(&starget->dev);
1314
1315 device_enable_async_suspend(&sdev->sdev_gendev);
1316 scsi_autopm_get_target(starget);
1317 pm_runtime_set_active(&sdev->sdev_gendev);
1318 pm_runtime_forbid(&sdev->sdev_gendev);
1319 pm_runtime_enable(&sdev->sdev_gendev);
1320 scsi_autopm_put_target(starget);
1321
1322 scsi_autopm_get_device(sdev);
1323
1324 scsi_dh_add_device(sdev);
1325
1326 error = device_add(&sdev->sdev_gendev);
1327 if (error) {
1328 sdev_printk(KERN_INFO, sdev,
1329 "failed to add device: %d\n", error);
1330 return error;
1331 }
1332
1333 device_enable_async_suspend(&sdev->sdev_dev);
1334 error = device_add(&sdev->sdev_dev);
1335 if (error) {
1336 sdev_printk(KERN_INFO, sdev,
1337 "failed to add class device: %d\n", error);
1338 device_del(&sdev->sdev_gendev);
1339 return error;
1340 }
1341 transport_add_device(&sdev->sdev_gendev);
1342 sdev->is_visible = 1;
1343
1344 error = bsg_scsi_register_queue(rq, &sdev->sdev_gendev);
1345 if (error)
1346 /* we're treating error on bsg register as non-fatal,
1347 * so pretend nothing went wrong */
1348 sdev_printk(KERN_INFO, sdev,
1349 "Failed to register bsg queue, errno=%d\n", error);
1350
1351 /* add additional host specific attributes */
1352 if (sdev->host->hostt->sdev_attrs) {
1353 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1354 error = device_create_file(&sdev->sdev_gendev,
1355 sdev->host->hostt->sdev_attrs[i]);
1356 if (error)
1357 return error;
1358 }
1359 }
1360
1361 if (sdev->host->hostt->sdev_groups) {
1362 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1363 sdev->host->hostt->sdev_groups);
1364 if (error)
1365 return error;
1366 }
1367
1368 scsi_autopm_put_device(sdev);
1369 return error;
1370}
1371
1372void __scsi_remove_device(struct scsi_device *sdev)
1373{
1374 struct device *dev = &sdev->sdev_gendev;
1375 int res;
1376
1377 /*
1378 * This cleanup path is not reentrant and while it is impossible
1379 * to get a new reference with scsi_device_get() someone can still
1380 * hold a previously acquired one.
1381 */
1382 if (sdev->sdev_state == SDEV_DEL)
1383 return;
1384
1385 if (sdev->is_visible) {
1386 /*
1387 * If scsi_internal_target_block() is running concurrently,
1388 * wait until it has finished before changing the device state.
1389 */
1390 mutex_lock(&sdev->state_mutex);
1391 /*
1392 * If blocked, we go straight to DEL and restart the queue so
1393 * any commands issued during driver shutdown (like sync
1394 * cache) are errored immediately.
1395 */
1396 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1397 if (res != 0) {
1398 res = scsi_device_set_state(sdev, SDEV_DEL);
1399 if (res == 0)
1400 scsi_start_queue(sdev);
1401 }
1402 mutex_unlock(&sdev->state_mutex);
1403
1404 if (res != 0)
1405 return;
1406
1407 if (sdev->host->hostt->sdev_groups)
1408 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1409 sdev->host->hostt->sdev_groups);
1410
1411 bsg_unregister_queue(sdev->request_queue);
1412 device_unregister(&sdev->sdev_dev);
1413 transport_remove_device(dev);
1414 device_del(dev);
1415 } else
1416 put_device(&sdev->sdev_dev);
1417
1418 /*
1419 * Stop accepting new requests and wait until all queuecommand() and
1420 * scsi_run_queue() invocations have finished before tearing down the
1421 * device.
1422 */
1423 mutex_lock(&sdev->state_mutex);
1424 scsi_device_set_state(sdev, SDEV_DEL);
1425 mutex_unlock(&sdev->state_mutex);
1426
1427 blk_cleanup_queue(sdev->request_queue);
1428 cancel_work_sync(&sdev->requeue_work);
1429
1430 if (sdev->host->hostt->slave_destroy)
1431 sdev->host->hostt->slave_destroy(sdev);
1432 transport_destroy_device(dev);
1433
1434 /*
1435 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1436 * remoed sysfs visibility from the device, so make the target
1437 * invisible if this was the last device underneath it.
1438 */
1439 scsi_target_reap(scsi_target(sdev));
1440
1441 put_device(dev);
1442}
1443
1444/**
1445 * scsi_remove_device - unregister a device from the scsi bus
1446 * @sdev: scsi_device to unregister
1447 **/
1448void scsi_remove_device(struct scsi_device *sdev)
1449{
1450 struct Scsi_Host *shost = sdev->host;
1451
1452 mutex_lock(&shost->scan_mutex);
1453 __scsi_remove_device(sdev);
1454 mutex_unlock(&shost->scan_mutex);
1455}
1456EXPORT_SYMBOL(scsi_remove_device);
1457
1458static void __scsi_remove_target(struct scsi_target *starget)
1459{
1460 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1461 unsigned long flags;
1462 struct scsi_device *sdev;
1463
1464 spin_lock_irqsave(shost->host_lock, flags);
1465 restart:
1466 list_for_each_entry(sdev, &shost->__devices, siblings) {
1467 /*
1468 * We cannot call scsi_device_get() here, as
1469 * we might've been called from rmmod() causing
1470 * scsi_device_get() to fail the module_is_live()
1471 * check.
1472 */
1473 if (sdev->channel != starget->channel ||
1474 sdev->id != starget->id)
1475 continue;
1476 if (sdev->sdev_state == SDEV_DEL ||
1477 sdev->sdev_state == SDEV_CANCEL ||
1478 !get_device(&sdev->sdev_gendev))
1479 continue;
1480 spin_unlock_irqrestore(shost->host_lock, flags);
1481 scsi_remove_device(sdev);
1482 put_device(&sdev->sdev_gendev);
1483 spin_lock_irqsave(shost->host_lock, flags);
1484 goto restart;
1485 }
1486 spin_unlock_irqrestore(shost->host_lock, flags);
1487}
1488
1489/**
1490 * scsi_remove_target - try to remove a target and all its devices
1491 * @dev: generic starget or parent of generic stargets to be removed
1492 *
1493 * Note: This is slightly racy. It is possible that if the user
1494 * requests the addition of another device then the target won't be
1495 * removed.
1496 */
1497void scsi_remove_target(struct device *dev)
1498{
1499 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1500 struct scsi_target *starget;
1501 unsigned long flags;
1502
1503restart:
1504 spin_lock_irqsave(shost->host_lock, flags);
1505 list_for_each_entry(starget, &shost->__targets, siblings) {
1506 if (starget->state == STARGET_DEL ||
1507 starget->state == STARGET_REMOVE ||
1508 starget->state == STARGET_CREATED_REMOVE)
1509 continue;
1510 if (starget->dev.parent == dev || &starget->dev == dev) {
1511 kref_get(&starget->reap_ref);
1512 if (starget->state == STARGET_CREATED)
1513 starget->state = STARGET_CREATED_REMOVE;
1514 else
1515 starget->state = STARGET_REMOVE;
1516 spin_unlock_irqrestore(shost->host_lock, flags);
1517 __scsi_remove_target(starget);
1518 scsi_target_reap(starget);
1519 goto restart;
1520 }
1521 }
1522 spin_unlock_irqrestore(shost->host_lock, flags);
1523}
1524EXPORT_SYMBOL(scsi_remove_target);
1525
1526int scsi_register_driver(struct device_driver *drv)
1527{
1528 drv->bus = &scsi_bus_type;
1529
1530 return driver_register(drv);
1531}
1532EXPORT_SYMBOL(scsi_register_driver);
1533
1534int scsi_register_interface(struct class_interface *intf)
1535{
1536 intf->class = &sdev_class;
1537
1538 return class_interface_register(intf);
1539}
1540EXPORT_SYMBOL(scsi_register_interface);
1541
1542/**
1543 * scsi_sysfs_add_host - add scsi host to subsystem
1544 * @shost: scsi host struct to add to subsystem
1545 **/
1546int scsi_sysfs_add_host(struct Scsi_Host *shost)
1547{
1548 int error, i;
1549
1550 /* add host specific attributes */
1551 if (shost->hostt->shost_attrs) {
1552 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1553 error = device_create_file(&shost->shost_dev,
1554 shost->hostt->shost_attrs[i]);
1555 if (error)
1556 return error;
1557 }
1558 }
1559
1560 transport_register_device(&shost->shost_gendev);
1561 transport_configure_device(&shost->shost_gendev);
1562 return 0;
1563}
1564
1565static struct device_type scsi_dev_type = {
1566 .name = "scsi_device",
1567 .release = scsi_device_dev_release,
1568 .groups = scsi_sdev_attr_groups,
1569};
1570
1571void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1572{
1573 unsigned long flags;
1574 struct Scsi_Host *shost = sdev->host;
1575 struct scsi_target *starget = sdev->sdev_target;
1576
1577 device_initialize(&sdev->sdev_gendev);
1578 sdev->sdev_gendev.bus = &scsi_bus_type;
1579 sdev->sdev_gendev.type = &scsi_dev_type;
1580 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1581 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1582
1583 device_initialize(&sdev->sdev_dev);
1584 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1585 sdev->sdev_dev.class = &sdev_class;
1586 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1587 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1588 /*
1589 * Get a default scsi_level from the target (derived from sibling
1590 * devices). This is the best we can do for guessing how to set
1591 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1592 * setting doesn't matter, because all the bits are zero anyway.
1593 * But it does matter for higher LUNs.
1594 */
1595 sdev->scsi_level = starget->scsi_level;
1596 if (sdev->scsi_level <= SCSI_2 &&
1597 sdev->scsi_level != SCSI_UNKNOWN &&
1598 !shost->no_scsi2_lun_in_cdb)
1599 sdev->lun_in_cdb = 1;
1600
1601 transport_setup_device(&sdev->sdev_gendev);
1602 spin_lock_irqsave(shost->host_lock, flags);
1603 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1604 list_add_tail(&sdev->siblings, &shost->__devices);
1605 spin_unlock_irqrestore(shost->host_lock, flags);
1606 /*
1607 * device can now only be removed via __scsi_remove_device() so hold
1608 * the target. Target will be held in CREATED state until something
1609 * beneath it becomes visible (in which case it moves to RUNNING)
1610 */
1611 kref_get(&starget->reap_ref);
1612}
1613
1614int scsi_is_sdev_device(const struct device *dev)
1615{
1616 return dev->type == &scsi_dev_type;
1617}
1618EXPORT_SYMBOL(scsi_is_sdev_device);
1619
1620/* A blank transport template that is used in drivers that don't
1621 * yet implement Transport Attributes */
1622struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };