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