Merge 5.18-rc5 into usb-next
[linux-2.6-microblaze.git] / drivers / scsi / scsi_sysfs.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
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 #include <linux/bsg.h>
17
18 #include <scsi/scsi.h>
19 #include <scsi/scsi_device.h>
20 #include <scsi/scsi_host.h>
21 #include <scsi/scsi_tcq.h>
22 #include <scsi/scsi_dh.h>
23 #include <scsi/scsi_transport.h>
24 #include <scsi/scsi_driver.h>
25 #include <scsi/scsi_devinfo.h>
26
27 #include "scsi_priv.h"
28 #include "scsi_logging.h"
29
30 static struct device_type scsi_dev_type;
31
32 static const struct {
33         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" },
42         { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
43         { SDEV_BLOCK,   "blocked" },
44         { SDEV_CREATED_BLOCK, "created-blocked" },
45 };
46
47 const char *scsi_device_state_name(enum scsi_device_state state)
48 {
49         int i;
50         char *name = NULL;
51
52         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
53                 if (sdev_states[i].value == state) {
54                         name = sdev_states[i].name;
55                         break;
56                 }
57         }
58         return name;
59 }
60
61 static const struct {
62         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" },
70         { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
71         { SHOST_DEL_RECOVERY, "deleted/recovery", },
72 };
73 const char *scsi_host_state_name(enum scsi_host_state state)
74 {
75         int i;
76         char *name = NULL;
77
78         for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
79                 if (shost_states[i].value == state) {
80                         name = shost_states[i].name;
81                         break;
82                 }
83         }
84         return name;
85 }
86
87 #ifdef CONFIG_SCSI_DH
88 static 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
101 static const char *scsi_access_state_name(unsigned char state)
102 {
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 }
114 #endif
115
116 static int check_set(unsigned long long *val, char *src)
117 {
118         char *last;
119
120         if (strcmp(src, "-") == 0) {
121                 *val = SCAN_WILD_CARD;
122         } else {
123                 /*
124                  * Doesn't check for int overflow
125                  */
126                 *val = simple_strtoull(src, &last, 0);
127                 if (*last != '\0')
128                         return 1;
129         }
130         return 0;
131 }
132
133 static int scsi_scan(struct Scsi_Host *shost, const char *str)
134 {
135         char s1[15], s2[15], s3[17], junk;
136         unsigned long long channel, id, lun;
137         int res;
138
139         res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
140         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;
148         if (shost->transportt->user_scan)
149                 res = shost->transportt->user_scan(shost, channel, id, lun);
150         else
151                 res = scsi_scan_host_selected(shost, channel, id, lun,
152                                               SCSI_SCAN_MANUAL);
153         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)                 \
161 static ssize_t                                                          \
162 show_##name (struct device *dev, struct device_attribute *attr,         \
163              char *buf)                                                 \
164 {                                                                       \
165         struct Scsi_Host *shost = class_to_shost(dev);                  \
166         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)                 \
175 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
176
177 #define shost_rd_attr(field, format_string) \
178 shost_rd_attr2(field, field, format_string)
179
180 /*
181  * Create the actual show/store functions and data structures.
182  */
183
184 static ssize_t
185 store_scan(struct device *dev, struct device_attribute *attr,
186            const char *buf, size_t count)
187 {
188         struct Scsi_Host *shost = class_to_shost(dev);
189         int res;
190
191         res = scsi_scan(shost, buf);
192         if (res == 0)
193                 res = count;
194         return res;
195 };
196 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
197
198 static ssize_t
199 store_shost_state(struct device *dev, struct device_attribute *attr,
200                   const char *buf, size_t count)
201 {
202         int i;
203         struct Scsi_Host *shost = class_to_shost(dev);
204         enum scsi_host_state state = 0;
205
206         for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
207                 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
222 static ssize_t
223 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
224 {
225         struct Scsi_Host *shost = class_to_shost(dev);
226         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
234 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
235 static struct device_attribute dev_attr_hstate =
236         __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
237
238 static ssize_t
239 show_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
254 static ssize_t
255 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
256                           char *buf)
257 {
258         struct Scsi_Host *shost = class_to_shost(dev);
259         unsigned int supported_mode = shost->hostt->supported_mode;
260
261         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);
266 }
267
268 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
269
270 static ssize_t
271 show_shost_active_mode(struct device *dev,
272                        struct device_attribute *attr, char *buf)
273 {
274         struct Scsi_Host *shost = class_to_shost(dev);
275
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
282 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
283
284 static int check_reset_type(const char *str)
285 {
286         if (sysfs_streq(str, "adapter"))
287                 return SCSI_ADAPTER_RESET;
288         else if (sysfs_streq(str, "firmware"))
289                 return SCSI_FIRMWARE_RESET;
290         else
291                 return 0;
292 }
293
294 static ssize_t
295 store_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;
301         int type;
302
303         type = check_reset_type(buf);
304         if (!type)
305                 goto exit_store_host_reset;
306
307         if (sht->host_reset)
308                 ret = sht->host_reset(shost, type);
309         else
310                 ret = -EOPNOTSUPP;
311
312 exit_store_host_reset:
313         if (ret == 0)
314                 ret = count;
315         return ret;
316 }
317
318 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
319
320 static ssize_t
321 show_shost_eh_deadline(struct device *dev,
322                       struct device_attribute *attr, char *buf)
323 {
324         struct Scsi_Host *shost = class_to_shost(dev);
325
326         if (shost->eh_deadline == -1)
327                 return snprintf(buf, strlen("off") + 2, "off\n");
328         return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
329 }
330
331 static ssize_t
332 store_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;
337         unsigned long deadline, flags;
338
339         if (shost->transportt &&
340             (shost->transportt->eh_strategy_handler ||
341              !shost->hostt->eh_host_reset_handler))
342                 return ret;
343
344         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;
352         }
353
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
367         return ret;
368 }
369
370 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
371
372 shost_rd_attr(unique_id, "%u\n");
373 shost_rd_attr(cmd_per_lun, "%hd\n");
374 shost_rd_attr(can_queue, "%d\n");
375 shost_rd_attr(sg_tablesize, "%hu\n");
376 shost_rd_attr(sg_prot_tablesize, "%hu\n");
377 shost_rd_attr(prot_capabilities, "%u\n");
378 shost_rd_attr(prot_guard_type, "%hd\n");
379 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
380
381 static ssize_t
382 show_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 }
387 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
388
389 static ssize_t
390 show_use_blk_mq(struct device *dev, struct device_attribute *attr, char *buf)
391 {
392         return sprintf(buf, "1\n");
393 }
394 static DEVICE_ATTR(use_blk_mq, S_IRUGO, show_use_blk_mq, NULL);
395
396 static ssize_t
397 show_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 }
404 static DEVICE_ATTR(nr_hw_queues, S_IRUGO, show_nr_hw_queues, NULL);
405
406 static struct attribute *scsi_sysfs_shost_attrs[] = {
407         &dev_attr_use_blk_mq.attr,
408         &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,
413         &dev_attr_sg_prot_tablesize.attr,
414         &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,
419         &dev_attr_prot_capabilities.attr,
420         &dev_attr_prot_guard_type.attr,
421         &dev_attr_host_reset.attr,
422         &dev_attr_eh_deadline.attr,
423         &dev_attr_nr_hw_queues.attr,
424         NULL
425 };
426
427 static const struct attribute_group scsi_shost_attr_group = {
428         .attrs =        scsi_sysfs_shost_attrs,
429 };
430
431 const struct attribute_group *scsi_shost_groups[] = {
432         &scsi_shost_attr_group,
433         NULL
434 };
435
436 static void scsi_device_cls_release(struct device *class_dev)
437 {
438         struct scsi_device *sdev;
439
440         sdev = class_to_sdev(class_dev);
441         put_device(&sdev->sdev_gendev);
442 }
443
444 static void scsi_device_dev_release_usercontext(struct work_struct *work)
445 {
446         struct scsi_device *sdev;
447         struct device *parent;
448         struct list_head *this, *tmp;
449         struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
450         struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
451         unsigned long flags;
452         struct module *mod;
453
454         sdev = container_of(work, struct scsi_device, ew.work);
455
456         mod = sdev->host->hostt->module;
457
458         scsi_dh_release_device(sdev);
459
460         parent = sdev->sdev_gendev.parent;
461
462         spin_lock_irqsave(sdev->host->host_lock, flags);
463         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
468         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
478         blk_put_queue(sdev->request_queue);
479         /* NULL queue means the device can't be used */
480         sdev->request_queue = NULL;
481
482         sbitmap_free(&sdev->budget_map);
483
484         mutex_lock(&sdev->inquiry_mutex);
485         vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
486                                        lockdep_is_held(&sdev->inquiry_mutex));
487         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));
491         vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
492                                        lockdep_is_held(&sdev->inquiry_mutex));
493         mutex_unlock(&sdev->inquiry_mutex);
494
495         if (vpd_pg0)
496                 kfree_rcu(vpd_pg0, rcu);
497         if (vpd_pg83)
498                 kfree_rcu(vpd_pg83, rcu);
499         if (vpd_pg80)
500                 kfree_rcu(vpd_pg80, rcu);
501         if (vpd_pg89)
502                 kfree_rcu(vpd_pg89, rcu);
503         kfree(sdev->inquiry);
504         kfree(sdev);
505
506         if (parent)
507                 put_device(parent);
508         module_put(mod);
509 }
510
511 static void scsi_device_dev_release(struct device *dev)
512 {
513         struct scsi_device *sdp = to_scsi_device(dev);
514
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
519         execute_in_process_context(scsi_device_dev_release_usercontext,
520                                    &sdp->ew);
521 }
522
523 static struct class sdev_class = {
524         .name           = "scsi_device",
525         .dev_release    = scsi_device_cls_release,
526 };
527
528 /* all probing is done in the individual ->probe routines */
529 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
530 {
531         struct scsi_device *sdp;
532
533         if (dev->type != &scsi_dev_type)
534                 return 0;
535
536         sdp = to_scsi_device(dev);
537         if (sdp->no_uld_attach)
538                 return 0;
539         return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
540 }
541
542 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
543 {
544         struct scsi_device *sdev;
545
546         if (dev->type != &scsi_dev_type)
547                 return 0;
548
549         sdev = to_scsi_device(dev);
550
551         add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
552         return 0;
553 }
554
555 struct bus_type scsi_bus_type = {
556         .name           = "scsi",
557         .match          = scsi_bus_match,
558         .uevent         = scsi_bus_uevent,
559 #ifdef CONFIG_PM
560         .pm             = &scsi_bus_pm_ops,
561 #endif
562 };
563 EXPORT_SYMBOL_GPL(scsi_bus_type);
564
565 int 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
579 void 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)                                \
590 static ssize_t                                                          \
591 sdev_show_##field (struct device *dev, struct device_attribute *attr,   \
592                    char *buf)                                           \
593 {                                                                       \
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)                        \
605 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
606
607
608 /*
609  * sdev_rw_attr: create a function and attribute variable for a
610  * read/write field.
611  */
612 #define sdev_rw_attr(field, format_string)                              \
613         sdev_show_function(field, format_string)                                \
614                                                                         \
615 static ssize_t                                                          \
616 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
617                     const char *buf, size_t count)                      \
618 {                                                                       \
619         struct scsi_device *sdev;                                       \
620         sdev = to_scsi_device(dev);                                     \
621         sscanf (buf, format_string, &sdev->field);                      \
622         return count;                                                   \
623 }                                                                       \
624 static 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                                                                         \
636 static ssize_t                                                          \
637 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
638                     const char *buf, size_t count)                      \
639 {                                                                       \
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 }                                                                       \
650 static 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  */
656 static 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  */
672 sdev_rd_attr (type, "%d\n");
673 sdev_rd_attr (scsi_level, "%d\n");
674 sdev_rd_attr (vendor, "%.8s\n");
675 sdev_rd_attr (model, "%.16s\n");
676 sdev_rd_attr (rev, "%.4s\n");
677
678 static ssize_t
679 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
680                 char *buf)
681 {
682         struct scsi_device *sdev = to_scsi_device(dev);
683         return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
684 }
685 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
686
687 static ssize_t
688 sdev_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 }
694 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
695
696 /*
697  * TODO: can we make these symlinks to the block layer ones?
698  */
699 static ssize_t
700 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
701 {
702         struct scsi_device *sdev;
703         sdev = to_scsi_device(dev);
704         return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
705 }
706
707 static ssize_t
708 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
709                     const char *buf, size_t count)
710 {
711         struct scsi_device *sdev;
712         int timeout;
713         sdev = to_scsi_device(dev);
714         sscanf (buf, "%d\n", &timeout);
715         blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
716         return count;
717 }
718 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
719
720 static ssize_t
721 sdev_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
728 static ssize_t
729 sdev_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 }
747 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
748
749 static ssize_t
750 store_rescan_field (struct device *dev, struct device_attribute *attr,
751                     const char *buf, size_t count)
752 {
753         scsi_rescan_device(dev);
754         return count;
755 }
756 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
757
758 static ssize_t
759 sdev_store_delete(struct device *dev, struct device_attribute *attr,
760                   const char *buf, size_t count)
761 {
762         struct kernfs_node *kn;
763         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;
771
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);
785         scsi_remove_device(sdev);
786         if (kn)
787                 sysfs_unbreak_active_protection(kn);
788         scsi_device_put(sdev);
789         return count;
790 };
791 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
792
793 static ssize_t
794 store_state_field(struct device *dev, struct device_attribute *attr,
795                   const char *buf, size_t count)
796 {
797         int i, ret;
798         struct scsi_device *sdev = to_scsi_device(dev);
799         enum scsi_device_state state = 0;
800         bool rescan_dev = false;
801
802         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
803                 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         }
810         switch (state) {
811         case SDEV_RUNNING:
812         case SDEV_OFFLINE:
813                 break;
814         default:
815                 return -EINVAL;
816         }
817
818         mutex_lock(&sdev->state_mutex);
819         if (sdev->sdev_state == SDEV_RUNNING && state == SDEV_RUNNING) {
820                 ret = 0;
821         } 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                  */
837                 blk_mq_run_hw_queues(sdev->request_queue, true);
838                 scsi_rescan_device(dev);
839         }
840
841         return ret == 0 ? count : -EINVAL;
842 }
843
844 static ssize_t
845 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
846 {
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
856 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
857
858 static ssize_t
859 show_queue_type_field(struct device *dev, struct device_attribute *attr,
860                       char *buf)
861 {
862         struct scsi_device *sdev = to_scsi_device(dev);
863         const char *name = "none";
864
865         if (sdev->simple_tags)
866                 name = "simple";
867
868         return snprintf(buf, 20, "%s\n", name);
869 }
870
871 static ssize_t
872 store_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);
876
877         if (!sdev->tagged_supported)
878                 return -EINVAL;
879                 
880         sdev_printk(KERN_INFO, sdev,
881                     "ignoring write to deprecated queue_type attribute");
882         return count;
883 }
884
885 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
886                    store_queue_type_field);
887
888 #define sdev_vpd_pg_attr(_page)                                         \
889 static ssize_t                                                  \
890 show_vpd_##_page(struct file *filp, struct kobject *kobj,       \
891                  struct bin_attribute *bin_attr,                        \
892                  char *buf, loff_t off, size_t count)                   \
893 {                                                                       \
894         struct device *dev = kobj_to_dev(kobj);                         \
895         struct scsi_device *sdev = to_scsi_device(dev);                 \
896         struct scsi_vpd *vpd_page;                                      \
897         int ret = -EINVAL;                                              \
898                                                                         \
899         rcu_read_lock();                                                \
900         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);         \
904         rcu_read_unlock();                                              \
905         return ret;                                                     \
906 }                                                                       \
907 static 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
913 sdev_vpd_pg_attr(pg83);
914 sdev_vpd_pg_attr(pg80);
915 sdev_vpd_pg_attr(pg89);
916 sdev_vpd_pg_attr(pg0);
917
918 static 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 {
922         struct device *dev = kobj_to_dev(kobj);
923         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
932 static 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
941 static ssize_t
942 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
943                         char *buf)
944 {
945         return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
946 }
947
948 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
949
950 #define show_sdev_iostat(field)                                         \
951 static ssize_t                                                          \
952 show_iostat_##field(struct device *dev, struct device_attribute *attr,  \
953                     char *buf)                                          \
954 {                                                                       \
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 }                                                                       \
959 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
960
961 show_sdev_iostat(iorequest_cnt);
962 show_sdev_iostat(iodone_cnt);
963 show_sdev_iostat(ioerr_cnt);
964
965 static ssize_t
966 sdev_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 }
972 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
973
974 #define DECLARE_EVT_SHOW(name, Cap_name)                                \
975 static ssize_t                                                          \
976 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
977                      char *buf)                                         \
978 {                                                                       \
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)                               \
985 static ssize_t                                                          \
986 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
987                       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
1007 DECLARE_EVT(media_change, MEDIA_CHANGE)
1008 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1009 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1010 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1011 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1012 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
1013
1014 static ssize_t
1015 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1016                        const char *buf, size_t count)
1017 {
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
1027         if (depth < 1 || depth > sdev->host->can_queue)
1028                 return -EINVAL;
1029
1030         retval = sht->change_queue_depth(sdev, depth);
1031         if (retval < 0)
1032                 return retval;
1033
1034         sdev->max_queue_depth = sdev->queue_depth;
1035
1036         return count;
1037 }
1038 sdev_show_function(queue_depth, "%d\n");
1039
1040 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1041                    sdev_store_queue_depth);
1042
1043 static ssize_t
1044 sdev_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 }
1057 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1058
1059 #define BLIST_FLAG_NAME(name)                                   \
1060         [const_ilog2((__force __u64)BLIST_##name)] = #name
1061 static const char *const sdev_bflags_name[] = {
1062 #include "scsi_devinfo_tbl.c"
1063 };
1064 #undef BLIST_FLAG_NAME
1065
1066 static ssize_t
1067 sdev_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
1077                 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1078                         continue;
1079                 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1080                         name = sdev_bflags_name[i];
1081
1082                 if (name)
1083                         len += scnprintf(buf + len, PAGE_SIZE - len,
1084                                          "%s%s", len ? " " : "", name);
1085                 else
1086                         len += scnprintf(buf + len, PAGE_SIZE - len,
1087                                          "%sINVALID_BIT(%d)", len ? " " : "", i);
1088         }
1089         if (len)
1090                 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
1091         return len;
1092 }
1093 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1094
1095 #ifdef CONFIG_SCSI_DH
1096 static ssize_t
1097 sdev_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
1108 static ssize_t
1109 sdev_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
1145 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1146                    sdev_store_dh_state);
1147
1148 static ssize_t
1149 sdev_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 }
1166 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1167
1168 static ssize_t
1169 sdev_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 }
1183 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1184 #endif
1185
1186 static ssize_t
1187 sdev_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
1197 static ssize_t
1198 sdev_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);
1203         unsigned int period;
1204
1205         if (kstrtouint(buf, 10, &period))
1206                 return -EINVAL;
1207
1208         sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1209         return count;
1210 }
1211
1212 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1213                    sdev_show_queue_ramp_up_period,
1214                    sdev_store_queue_ramp_up_period);
1215
1216 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1217                                          struct attribute *attr, int i)
1218 {
1219         struct device *dev = kobj_to_dev(kobj);
1220         struct scsi_device *sdev = to_scsi_device(dev);
1221
1222
1223         if (attr == &dev_attr_queue_depth.attr &&
1224             !sdev->host->hostt->change_queue_depth)
1225                 return S_IRUGO;
1226
1227         if (attr == &dev_attr_queue_ramp_up_period.attr &&
1228             !sdev->host->hostt->change_queue_depth)
1229                 return 0;
1230
1231         return attr->mode;
1232 }
1233
1234 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1235                                              struct bin_attribute *attr, int i)
1236 {
1237         struct device *dev = kobj_to_dev(kobj);
1238         struct scsi_device *sdev = to_scsi_device(dev);
1239
1240
1241         if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1242                 return 0;
1243
1244         if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1245                 return 0;
1246
1247         if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1248                 return 0;
1249
1250         if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1251                 return 0;
1252
1253         return S_IRUGO;
1254 }
1255
1256 /* Default template for device attributes.  May NOT be modified */
1257 static struct attribute *scsi_sdev_attrs[] = {
1258         &dev_attr_device_blocked.attr,
1259         &dev_attr_type.attr,
1260         &dev_attr_scsi_level.attr,
1261         &dev_attr_device_busy.attr,
1262         &dev_attr_vendor.attr,
1263         &dev_attr_model.attr,
1264         &dev_attr_rev.attr,
1265         &dev_attr_rescan.attr,
1266         &dev_attr_delete.attr,
1267         &dev_attr_state.attr,
1268         &dev_attr_timeout.attr,
1269         &dev_attr_eh_timeout.attr,
1270         &dev_attr_iocounterbits.attr,
1271         &dev_attr_iorequest_cnt.attr,
1272         &dev_attr_iodone_cnt.attr,
1273         &dev_attr_ioerr_cnt.attr,
1274         &dev_attr_modalias.attr,
1275         &dev_attr_queue_depth.attr,
1276         &dev_attr_queue_type.attr,
1277         &dev_attr_wwid.attr,
1278         &dev_attr_blacklist.attr,
1279 #ifdef CONFIG_SCSI_DH
1280         &dev_attr_dh_state.attr,
1281         &dev_attr_access_state.attr,
1282         &dev_attr_preferred_path.attr,
1283 #endif
1284         &dev_attr_queue_ramp_up_period.attr,
1285         REF_EVT(media_change),
1286         REF_EVT(inquiry_change_reported),
1287         REF_EVT(capacity_change_reported),
1288         REF_EVT(soft_threshold_reached),
1289         REF_EVT(mode_parameter_change_reported),
1290         REF_EVT(lun_change_reported),
1291         NULL
1292 };
1293
1294 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1295         &dev_attr_vpd_pg0,
1296         &dev_attr_vpd_pg83,
1297         &dev_attr_vpd_pg80,
1298         &dev_attr_vpd_pg89,
1299         &dev_attr_inquiry,
1300         NULL
1301 };
1302 static struct attribute_group scsi_sdev_attr_group = {
1303         .attrs =        scsi_sdev_attrs,
1304         .bin_attrs =    scsi_sdev_bin_attrs,
1305         .is_visible =   scsi_sdev_attr_is_visible,
1306         .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1307 };
1308
1309 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1310         &scsi_sdev_attr_group,
1311         NULL
1312 };
1313
1314 static int scsi_target_add(struct scsi_target *starget)
1315 {
1316         int error;
1317
1318         if (starget->state != STARGET_CREATED)
1319                 return 0;
1320
1321         error = device_add(&starget->dev);
1322         if (error) {
1323                 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1324                 return error;
1325         }
1326         transport_add_device(&starget->dev);
1327         starget->state = STARGET_RUNNING;
1328
1329         pm_runtime_set_active(&starget->dev);
1330         pm_runtime_enable(&starget->dev);
1331         device_enable_async_suspend(&starget->dev);
1332
1333         return 0;
1334 }
1335
1336 /**
1337  * scsi_sysfs_add_sdev - add scsi device to sysfs
1338  * @sdev:       scsi_device to add
1339  *
1340  * Return value:
1341  *      0 on Success / non-zero on Failure
1342  **/
1343 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1344 {
1345         int error;
1346         struct scsi_target *starget = sdev->sdev_target;
1347
1348         error = scsi_target_add(starget);
1349         if (error)
1350                 return error;
1351
1352         transport_configure_device(&starget->dev);
1353
1354         device_enable_async_suspend(&sdev->sdev_gendev);
1355         scsi_autopm_get_target(starget);
1356         pm_runtime_set_active(&sdev->sdev_gendev);
1357         if (!sdev->rpm_autosuspend)
1358                 pm_runtime_forbid(&sdev->sdev_gendev);
1359         pm_runtime_enable(&sdev->sdev_gendev);
1360         scsi_autopm_put_target(starget);
1361
1362         scsi_autopm_get_device(sdev);
1363
1364         scsi_dh_add_device(sdev);
1365
1366         error = device_add(&sdev->sdev_gendev);
1367         if (error) {
1368                 sdev_printk(KERN_INFO, sdev,
1369                                 "failed to add device: %d\n", error);
1370                 return error;
1371         }
1372
1373         device_enable_async_suspend(&sdev->sdev_dev);
1374         error = device_add(&sdev->sdev_dev);
1375         if (error) {
1376                 sdev_printk(KERN_INFO, sdev,
1377                                 "failed to add class device: %d\n", error);
1378                 device_del(&sdev->sdev_gendev);
1379                 return error;
1380         }
1381         transport_add_device(&sdev->sdev_gendev);
1382         sdev->is_visible = 1;
1383
1384         if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1385                 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1386                 if (IS_ERR(sdev->bsg_dev)) {
1387                         error = PTR_ERR(sdev->bsg_dev);
1388                         sdev_printk(KERN_INFO, sdev,
1389                                     "Failed to register bsg queue, errno=%d\n",
1390                                     error);
1391                         sdev->bsg_dev = NULL;
1392                 }
1393         }
1394
1395         scsi_autopm_put_device(sdev);
1396         return error;
1397 }
1398
1399 void __scsi_remove_device(struct scsi_device *sdev)
1400 {
1401         struct device *dev = &sdev->sdev_gendev;
1402         int res;
1403
1404         /*
1405          * This cleanup path is not reentrant and while it is impossible
1406          * to get a new reference with scsi_device_get() someone can still
1407          * hold a previously acquired one.
1408          */
1409         if (sdev->sdev_state == SDEV_DEL)
1410                 return;
1411
1412         if (sdev->is_visible) {
1413                 /*
1414                  * If scsi_internal_target_block() is running concurrently,
1415                  * wait until it has finished before changing the device state.
1416                  */
1417                 mutex_lock(&sdev->state_mutex);
1418                 /*
1419                  * If blocked, we go straight to DEL and restart the queue so
1420                  * any commands issued during driver shutdown (like sync
1421                  * cache) are errored immediately.
1422                  */
1423                 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1424                 if (res != 0) {
1425                         res = scsi_device_set_state(sdev, SDEV_DEL);
1426                         if (res == 0)
1427                                 scsi_start_queue(sdev);
1428                 }
1429                 mutex_unlock(&sdev->state_mutex);
1430
1431                 if (res != 0)
1432                         return;
1433
1434                 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1435                         bsg_unregister_queue(sdev->bsg_dev);
1436                 device_unregister(&sdev->sdev_dev);
1437                 transport_remove_device(dev);
1438                 device_del(dev);
1439         } else
1440                 put_device(&sdev->sdev_dev);
1441
1442         /*
1443          * Stop accepting new requests and wait until all queuecommand() and
1444          * scsi_run_queue() invocations have finished before tearing down the
1445          * device.
1446          */
1447         mutex_lock(&sdev->state_mutex);
1448         scsi_device_set_state(sdev, SDEV_DEL);
1449         mutex_unlock(&sdev->state_mutex);
1450
1451         blk_cleanup_queue(sdev->request_queue);
1452         cancel_work_sync(&sdev->requeue_work);
1453
1454         if (sdev->host->hostt->slave_destroy)
1455                 sdev->host->hostt->slave_destroy(sdev);
1456         transport_destroy_device(dev);
1457
1458         /*
1459          * Paired with the kref_get() in scsi_sysfs_initialize().  We have
1460          * removed sysfs visibility from the device, so make the target
1461          * invisible if this was the last device underneath it.
1462          */
1463         scsi_target_reap(scsi_target(sdev));
1464
1465         put_device(dev);
1466 }
1467
1468 /**
1469  * scsi_remove_device - unregister a device from the scsi bus
1470  * @sdev:       scsi_device to unregister
1471  **/
1472 void scsi_remove_device(struct scsi_device *sdev)
1473 {
1474         struct Scsi_Host *shost = sdev->host;
1475
1476         mutex_lock(&shost->scan_mutex);
1477         __scsi_remove_device(sdev);
1478         mutex_unlock(&shost->scan_mutex);
1479 }
1480 EXPORT_SYMBOL(scsi_remove_device);
1481
1482 static void __scsi_remove_target(struct scsi_target *starget)
1483 {
1484         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1485         unsigned long flags;
1486         struct scsi_device *sdev;
1487
1488         spin_lock_irqsave(shost->host_lock, flags);
1489  restart:
1490         list_for_each_entry(sdev, &shost->__devices, siblings) {
1491                 /*
1492                  * We cannot call scsi_device_get() here, as
1493                  * we might've been called from rmmod() causing
1494                  * scsi_device_get() to fail the module_is_live()
1495                  * check.
1496                  */
1497                 if (sdev->channel != starget->channel ||
1498                     sdev->id != starget->id)
1499                         continue;
1500                 if (sdev->sdev_state == SDEV_DEL ||
1501                     sdev->sdev_state == SDEV_CANCEL ||
1502                     !get_device(&sdev->sdev_gendev))
1503                         continue;
1504                 spin_unlock_irqrestore(shost->host_lock, flags);
1505                 scsi_remove_device(sdev);
1506                 put_device(&sdev->sdev_gendev);
1507                 spin_lock_irqsave(shost->host_lock, flags);
1508                 goto restart;
1509         }
1510         spin_unlock_irqrestore(shost->host_lock, flags);
1511 }
1512
1513 /**
1514  * scsi_remove_target - try to remove a target and all its devices
1515  * @dev: generic starget or parent of generic stargets to be removed
1516  *
1517  * Note: This is slightly racy.  It is possible that if the user
1518  * requests the addition of another device then the target won't be
1519  * removed.
1520  */
1521 void scsi_remove_target(struct device *dev)
1522 {
1523         struct Scsi_Host *shost = dev_to_shost(dev->parent);
1524         struct scsi_target *starget;
1525         unsigned long flags;
1526
1527 restart:
1528         spin_lock_irqsave(shost->host_lock, flags);
1529         list_for_each_entry(starget, &shost->__targets, siblings) {
1530                 if (starget->state == STARGET_DEL ||
1531                     starget->state == STARGET_REMOVE ||
1532                     starget->state == STARGET_CREATED_REMOVE)
1533                         continue;
1534                 if (starget->dev.parent == dev || &starget->dev == dev) {
1535                         kref_get(&starget->reap_ref);
1536                         if (starget->state == STARGET_CREATED)
1537                                 starget->state = STARGET_CREATED_REMOVE;
1538                         else
1539                                 starget->state = STARGET_REMOVE;
1540                         spin_unlock_irqrestore(shost->host_lock, flags);
1541                         __scsi_remove_target(starget);
1542                         scsi_target_reap(starget);
1543                         goto restart;
1544                 }
1545         }
1546         spin_unlock_irqrestore(shost->host_lock, flags);
1547 }
1548 EXPORT_SYMBOL(scsi_remove_target);
1549
1550 int scsi_register_driver(struct device_driver *drv)
1551 {
1552         drv->bus = &scsi_bus_type;
1553
1554         return driver_register(drv);
1555 }
1556 EXPORT_SYMBOL(scsi_register_driver);
1557
1558 int scsi_register_interface(struct class_interface *intf)
1559 {
1560         intf->class = &sdev_class;
1561
1562         return class_interface_register(intf);
1563 }
1564 EXPORT_SYMBOL(scsi_register_interface);
1565
1566 /**
1567  * scsi_sysfs_add_host - add scsi host to subsystem
1568  * @shost:     scsi host struct to add to subsystem
1569  **/
1570 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1571 {
1572         transport_register_device(&shost->shost_gendev);
1573         transport_configure_device(&shost->shost_gendev);
1574         return 0;
1575 }
1576
1577 static struct device_type scsi_dev_type = {
1578         .name =         "scsi_device",
1579         .release =      scsi_device_dev_release,
1580         .groups =       scsi_sdev_attr_groups,
1581 };
1582
1583 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1584 {
1585         unsigned long flags;
1586         struct Scsi_Host *shost = sdev->host;
1587         struct scsi_host_template *hostt = shost->hostt;
1588         struct scsi_target  *starget = sdev->sdev_target;
1589
1590         device_initialize(&sdev->sdev_gendev);
1591         sdev->sdev_gendev.bus = &scsi_bus_type;
1592         sdev->sdev_gendev.type = &scsi_dev_type;
1593         scsi_enable_async_suspend(&sdev->sdev_gendev);
1594         dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1595                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1596         sdev->sdev_gendev.groups = hostt->sdev_groups;
1597
1598         device_initialize(&sdev->sdev_dev);
1599         sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1600         sdev->sdev_dev.class = &sdev_class;
1601         dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1602                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1603         /*
1604          * Get a default scsi_level from the target (derived from sibling
1605          * devices).  This is the best we can do for guessing how to set
1606          * sdev->lun_in_cdb for the initial INQUIRY command.  For LUN 0 the
1607          * setting doesn't matter, because all the bits are zero anyway.
1608          * But it does matter for higher LUNs.
1609          */
1610         sdev->scsi_level = starget->scsi_level;
1611         if (sdev->scsi_level <= SCSI_2 &&
1612                         sdev->scsi_level != SCSI_UNKNOWN &&
1613                         !shost->no_scsi2_lun_in_cdb)
1614                 sdev->lun_in_cdb = 1;
1615
1616         transport_setup_device(&sdev->sdev_gendev);
1617         spin_lock_irqsave(shost->host_lock, flags);
1618         list_add_tail(&sdev->same_target_siblings, &starget->devices);
1619         list_add_tail(&sdev->siblings, &shost->__devices);
1620         spin_unlock_irqrestore(shost->host_lock, flags);
1621         /*
1622          * device can now only be removed via __scsi_remove_device() so hold
1623          * the target.  Target will be held in CREATED state until something
1624          * beneath it becomes visible (in which case it moves to RUNNING)
1625          */
1626         kref_get(&starget->reap_ref);
1627 }
1628
1629 int scsi_is_sdev_device(const struct device *dev)
1630 {
1631         return dev->type == &scsi_dev_type;
1632 }
1633 EXPORT_SYMBOL(scsi_is_sdev_device);
1634
1635 /* A blank transport template that is used in drivers that don't
1636  * yet implement Transport Attributes */
1637 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };