Merge branch 'perf-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[cascardo/linux.git] / drivers / scsi / scsi_sysfs.c
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
26 static struct device_type scsi_dev_type;
27
28 static 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_TRANSPORT_OFFLINE, "transport-offline" },
39         { SDEV_BLOCK,   "blocked" },
40         { SDEV_CREATED_BLOCK, "created-blocked" },
41 };
42
43 const char *scsi_device_state_name(enum scsi_device_state state)
44 {
45         int i;
46         char *name = NULL;
47
48         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
49                 if (sdev_states[i].value == state) {
50                         name = sdev_states[i].name;
51                         break;
52                 }
53         }
54         return name;
55 }
56
57 static const struct {
58         enum scsi_host_state    value;
59         char                    *name;
60 } shost_states[] = {
61         { SHOST_CREATED, "created" },
62         { SHOST_RUNNING, "running" },
63         { SHOST_CANCEL, "cancel" },
64         { SHOST_DEL, "deleted" },
65         { SHOST_RECOVERY, "recovery" },
66         { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
67         { SHOST_DEL_RECOVERY, "deleted/recovery", },
68 };
69 const char *scsi_host_state_name(enum scsi_host_state state)
70 {
71         int i;
72         char *name = NULL;
73
74         for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
75                 if (shost_states[i].value == state) {
76                         name = shost_states[i].name;
77                         break;
78                 }
79         }
80         return name;
81 }
82
83 static int check_set(unsigned long long *val, char *src)
84 {
85         char *last;
86
87         if (strncmp(src, "-", 20) == 0) {
88                 *val = SCAN_WILD_CARD;
89         } else {
90                 /*
91                  * Doesn't check for int overflow
92                  */
93                 *val = simple_strtoull(src, &last, 0);
94                 if (*last != '\0')
95                         return 1;
96         }
97         return 0;
98 }
99
100 static int scsi_scan(struct Scsi_Host *shost, const char *str)
101 {
102         char s1[15], s2[15], s3[17], junk;
103         unsigned long long channel, id, lun;
104         int res;
105
106         res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
107         if (res != 3)
108                 return -EINVAL;
109         if (check_set(&channel, s1))
110                 return -EINVAL;
111         if (check_set(&id, s2))
112                 return -EINVAL;
113         if (check_set(&lun, s3))
114                 return -EINVAL;
115         if (shost->transportt->user_scan)
116                 res = shost->transportt->user_scan(shost, channel, id, lun);
117         else
118                 res = scsi_scan_host_selected(shost, channel, id, lun, 1);
119         return res;
120 }
121
122 /*
123  * shost_show_function: macro to create an attr function that can be used to
124  * show a non-bit field.
125  */
126 #define shost_show_function(name, field, format_string)                 \
127 static ssize_t                                                          \
128 show_##name (struct device *dev, struct device_attribute *attr,         \
129              char *buf)                                                 \
130 {                                                                       \
131         struct Scsi_Host *shost = class_to_shost(dev);                  \
132         return snprintf (buf, 20, format_string, shost->field);         \
133 }
134
135 /*
136  * shost_rd_attr: macro to create a function and attribute variable for a
137  * read only field.
138  */
139 #define shost_rd_attr2(name, field, format_string)                      \
140         shost_show_function(name, field, format_string)                 \
141 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
142
143 #define shost_rd_attr(field, format_string) \
144 shost_rd_attr2(field, field, format_string)
145
146 /*
147  * Create the actual show/store functions and data structures.
148  */
149
150 static ssize_t
151 store_scan(struct device *dev, struct device_attribute *attr,
152            const char *buf, size_t count)
153 {
154         struct Scsi_Host *shost = class_to_shost(dev);
155         int res;
156
157         res = scsi_scan(shost, buf);
158         if (res == 0)
159                 res = count;
160         return res;
161 };
162 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
163
164 static ssize_t
165 store_shost_state(struct device *dev, struct device_attribute *attr,
166                   const char *buf, size_t count)
167 {
168         int i;
169         struct Scsi_Host *shost = class_to_shost(dev);
170         enum scsi_host_state state = 0;
171
172         for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
173                 const int len = strlen(shost_states[i].name);
174                 if (strncmp(shost_states[i].name, buf, len) == 0 &&
175                    buf[len] == '\n') {
176                         state = shost_states[i].value;
177                         break;
178                 }
179         }
180         if (!state)
181                 return -EINVAL;
182
183         if (scsi_host_set_state(shost, state))
184                 return -EINVAL;
185         return count;
186 }
187
188 static ssize_t
189 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
190 {
191         struct Scsi_Host *shost = class_to_shost(dev);
192         const char *name = scsi_host_state_name(shost->shost_state);
193
194         if (!name)
195                 return -EINVAL;
196
197         return snprintf(buf, 20, "%s\n", name);
198 }
199
200 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
201 struct device_attribute dev_attr_hstate =
202         __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
203
204 static ssize_t
205 show_shost_mode(unsigned int mode, char *buf)
206 {
207         ssize_t len = 0;
208
209         if (mode & MODE_INITIATOR)
210                 len = sprintf(buf, "%s", "Initiator");
211
212         if (mode & MODE_TARGET)
213                 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
214
215         len += sprintf(buf + len, "\n");
216
217         return len;
218 }
219
220 static ssize_t
221 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
222                           char *buf)
223 {
224         struct Scsi_Host *shost = class_to_shost(dev);
225         unsigned int supported_mode = shost->hostt->supported_mode;
226
227         if (supported_mode == MODE_UNKNOWN)
228                 /* by default this should be initiator */
229                 supported_mode = MODE_INITIATOR;
230
231         return show_shost_mode(supported_mode, buf);
232 }
233
234 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
235
236 static ssize_t
237 show_shost_active_mode(struct device *dev,
238                        struct device_attribute *attr, char *buf)
239 {
240         struct Scsi_Host *shost = class_to_shost(dev);
241
242         if (shost->active_mode == MODE_UNKNOWN)
243                 return snprintf(buf, 20, "unknown\n");
244         else
245                 return show_shost_mode(shost->active_mode, buf);
246 }
247
248 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
249
250 static int check_reset_type(const char *str)
251 {
252         if (sysfs_streq(str, "adapter"))
253                 return SCSI_ADAPTER_RESET;
254         else if (sysfs_streq(str, "firmware"))
255                 return SCSI_FIRMWARE_RESET;
256         else
257                 return 0;
258 }
259
260 static ssize_t
261 store_host_reset(struct device *dev, struct device_attribute *attr,
262                 const char *buf, size_t count)
263 {
264         struct Scsi_Host *shost = class_to_shost(dev);
265         struct scsi_host_template *sht = shost->hostt;
266         int ret = -EINVAL;
267         int type;
268
269         type = check_reset_type(buf);
270         if (!type)
271                 goto exit_store_host_reset;
272
273         if (sht->host_reset)
274                 ret = sht->host_reset(shost, type);
275
276 exit_store_host_reset:
277         if (ret == 0)
278                 ret = count;
279         return ret;
280 }
281
282 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
283
284 static ssize_t
285 show_shost_eh_deadline(struct device *dev,
286                       struct device_attribute *attr, char *buf)
287 {
288         struct Scsi_Host *shost = class_to_shost(dev);
289
290         if (shost->eh_deadline == -1)
291                 return snprintf(buf, strlen("off") + 2, "off\n");
292         return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
293 }
294
295 static ssize_t
296 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
297                 const char *buf, size_t count)
298 {
299         struct Scsi_Host *shost = class_to_shost(dev);
300         int ret = -EINVAL;
301         unsigned long deadline, flags;
302
303         if (shost->transportt &&
304             (shost->transportt->eh_strategy_handler ||
305              !shost->hostt->eh_host_reset_handler))
306                 return ret;
307
308         if (!strncmp(buf, "off", strlen("off")))
309                 deadline = -1;
310         else {
311                 ret = kstrtoul(buf, 10, &deadline);
312                 if (ret)
313                         return ret;
314                 if (deadline * HZ > UINT_MAX)
315                         return -EINVAL;
316         }
317
318         spin_lock_irqsave(shost->host_lock, flags);
319         if (scsi_host_in_recovery(shost))
320                 ret = -EBUSY;
321         else {
322                 if (deadline == -1)
323                         shost->eh_deadline = -1;
324                 else
325                         shost->eh_deadline = deadline * HZ;
326
327                 ret = count;
328         }
329         spin_unlock_irqrestore(shost->host_lock, flags);
330
331         return ret;
332 }
333
334 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
335
336 shost_rd_attr(use_blk_mq, "%d\n");
337 shost_rd_attr(unique_id, "%u\n");
338 shost_rd_attr(cmd_per_lun, "%hd\n");
339 shost_rd_attr(can_queue, "%hd\n");
340 shost_rd_attr(sg_tablesize, "%hu\n");
341 shost_rd_attr(sg_prot_tablesize, "%hu\n");
342 shost_rd_attr(unchecked_isa_dma, "%d\n");
343 shost_rd_attr(prot_capabilities, "%u\n");
344 shost_rd_attr(prot_guard_type, "%hd\n");
345 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
346
347 static ssize_t
348 show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
349 {
350         struct Scsi_Host *shost = class_to_shost(dev);
351         return snprintf(buf, 20, "%d\n", atomic_read(&shost->host_busy));
352 }
353 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
354
355 static struct attribute *scsi_sysfs_shost_attrs[] = {
356         &dev_attr_use_blk_mq.attr,
357         &dev_attr_unique_id.attr,
358         &dev_attr_host_busy.attr,
359         &dev_attr_cmd_per_lun.attr,
360         &dev_attr_can_queue.attr,
361         &dev_attr_sg_tablesize.attr,
362         &dev_attr_sg_prot_tablesize.attr,
363         &dev_attr_unchecked_isa_dma.attr,
364         &dev_attr_proc_name.attr,
365         &dev_attr_scan.attr,
366         &dev_attr_hstate.attr,
367         &dev_attr_supported_mode.attr,
368         &dev_attr_active_mode.attr,
369         &dev_attr_prot_capabilities.attr,
370         &dev_attr_prot_guard_type.attr,
371         &dev_attr_host_reset.attr,
372         &dev_attr_eh_deadline.attr,
373         NULL
374 };
375
376 struct attribute_group scsi_shost_attr_group = {
377         .attrs =        scsi_sysfs_shost_attrs,
378 };
379
380 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
381         &scsi_shost_attr_group,
382         NULL
383 };
384
385 static void scsi_device_cls_release(struct device *class_dev)
386 {
387         struct scsi_device *sdev;
388
389         sdev = class_to_sdev(class_dev);
390         put_device(&sdev->sdev_gendev);
391 }
392
393 static void scsi_device_dev_release_usercontext(struct work_struct *work)
394 {
395         struct scsi_device *sdev;
396         struct device *parent;
397         struct list_head *this, *tmp;
398         unsigned long flags;
399
400         sdev = container_of(work, struct scsi_device, ew.work);
401
402         parent = sdev->sdev_gendev.parent;
403
404         spin_lock_irqsave(sdev->host->host_lock, flags);
405         list_del(&sdev->siblings);
406         list_del(&sdev->same_target_siblings);
407         list_del(&sdev->starved_entry);
408         spin_unlock_irqrestore(sdev->host->host_lock, flags);
409
410         cancel_work_sync(&sdev->event_work);
411
412         list_for_each_safe(this, tmp, &sdev->event_list) {
413                 struct scsi_event *evt;
414
415                 evt = list_entry(this, struct scsi_event, node);
416                 list_del(&evt->node);
417                 kfree(evt);
418         }
419
420         blk_put_queue(sdev->request_queue);
421         /* NULL queue means the device can't be used */
422         sdev->request_queue = NULL;
423
424         kfree(sdev->vpd_pg83);
425         kfree(sdev->vpd_pg80);
426         kfree(sdev->inquiry);
427         kfree(sdev);
428
429         if (parent)
430                 put_device(parent);
431 }
432
433 static void scsi_device_dev_release(struct device *dev)
434 {
435         struct scsi_device *sdp = to_scsi_device(dev);
436         execute_in_process_context(scsi_device_dev_release_usercontext,
437                                    &sdp->ew);
438 }
439
440 static struct class sdev_class = {
441         .name           = "scsi_device",
442         .dev_release    = scsi_device_cls_release,
443 };
444
445 /* all probing is done in the individual ->probe routines */
446 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
447 {
448         struct scsi_device *sdp;
449
450         if (dev->type != &scsi_dev_type)
451                 return 0;
452
453         sdp = to_scsi_device(dev);
454         if (sdp->no_uld_attach)
455                 return 0;
456         return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
457 }
458
459 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
460 {
461         struct scsi_device *sdev;
462
463         if (dev->type != &scsi_dev_type)
464                 return 0;
465
466         sdev = to_scsi_device(dev);
467
468         add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
469         return 0;
470 }
471
472 struct bus_type scsi_bus_type = {
473         .name           = "scsi",
474         .match          = scsi_bus_match,
475         .uevent         = scsi_bus_uevent,
476 #ifdef CONFIG_PM
477         .pm             = &scsi_bus_pm_ops,
478 #endif
479 };
480 EXPORT_SYMBOL_GPL(scsi_bus_type);
481
482 int scsi_sysfs_register(void)
483 {
484         int error;
485
486         error = bus_register(&scsi_bus_type);
487         if (!error) {
488                 error = class_register(&sdev_class);
489                 if (error)
490                         bus_unregister(&scsi_bus_type);
491         }
492
493         return error;
494 }
495
496 void scsi_sysfs_unregister(void)
497 {
498         class_unregister(&sdev_class);
499         bus_unregister(&scsi_bus_type);
500 }
501
502 /*
503  * sdev_show_function: macro to create an attr function that can be used to
504  * show a non-bit field.
505  */
506 #define sdev_show_function(field, format_string)                                \
507 static ssize_t                                                          \
508 sdev_show_##field (struct device *dev, struct device_attribute *attr,   \
509                    char *buf)                                           \
510 {                                                                       \
511         struct scsi_device *sdev;                                       \
512         sdev = to_scsi_device(dev);                                     \
513         return snprintf (buf, 20, format_string, sdev->field);          \
514 }                                                                       \
515
516 /*
517  * sdev_rd_attr: macro to create a function and attribute variable for a
518  * read only field.
519  */
520 #define sdev_rd_attr(field, format_string)                              \
521         sdev_show_function(field, format_string)                        \
522 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
523
524
525 /*
526  * sdev_rw_attr: create a function and attribute variable for a
527  * read/write field.
528  */
529 #define sdev_rw_attr(field, format_string)                              \
530         sdev_show_function(field, format_string)                                \
531                                                                         \
532 static ssize_t                                                          \
533 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
534                     const char *buf, size_t count)                      \
535 {                                                                       \
536         struct scsi_device *sdev;                                       \
537         sdev = to_scsi_device(dev);                                     \
538         sscanf (buf, format_string, &sdev->field);                      \
539         return count;                                                   \
540 }                                                                       \
541 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
542
543 /* Currently we don't export bit fields, but we might in future,
544  * so leave this code in */
545 #if 0
546 /*
547  * sdev_rd_attr: create a function and attribute variable for a
548  * read/write bit field.
549  */
550 #define sdev_rw_attr_bit(field)                                         \
551         sdev_show_function(field, "%d\n")                                       \
552                                                                         \
553 static ssize_t                                                          \
554 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
555                     const char *buf, size_t count)                      \
556 {                                                                       \
557         int ret;                                                        \
558         struct scsi_device *sdev;                                       \
559         ret = scsi_sdev_check_buf_bit(buf);                             \
560         if (ret >= 0)   {                                               \
561                 sdev = to_scsi_device(dev);                             \
562                 sdev->field = ret;                                      \
563                 ret = count;                                            \
564         }                                                               \
565         return ret;                                                     \
566 }                                                                       \
567 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
568
569 /*
570  * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
571  * else return -EINVAL.
572  */
573 static int scsi_sdev_check_buf_bit(const char *buf)
574 {
575         if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
576                 if (buf[0] == '1')
577                         return 1;
578                 else if (buf[0] == '0')
579                         return 0;
580                 else 
581                         return -EINVAL;
582         } else
583                 return -EINVAL;
584 }
585 #endif
586 /*
587  * Create the actual show/store functions and data structures.
588  */
589 sdev_rd_attr (type, "%d\n");
590 sdev_rd_attr (scsi_level, "%d\n");
591 sdev_rd_attr (vendor, "%.8s\n");
592 sdev_rd_attr (model, "%.16s\n");
593 sdev_rd_attr (rev, "%.4s\n");
594
595 static ssize_t
596 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
597                 char *buf)
598 {
599         struct scsi_device *sdev = to_scsi_device(dev);
600         return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
601 }
602 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
603
604 static ssize_t
605 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
606                 char *buf)
607 {
608         struct scsi_device *sdev = to_scsi_device(dev);
609         return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
610 }
611 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
612
613 /*
614  * TODO: can we make these symlinks to the block layer ones?
615  */
616 static ssize_t
617 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
618 {
619         struct scsi_device *sdev;
620         sdev = to_scsi_device(dev);
621         return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
622 }
623
624 static ssize_t
625 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
626                     const char *buf, size_t count)
627 {
628         struct scsi_device *sdev;
629         int timeout;
630         sdev = to_scsi_device(dev);
631         sscanf (buf, "%d\n", &timeout);
632         blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
633         return count;
634 }
635 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
636
637 static ssize_t
638 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
639 {
640         struct scsi_device *sdev;
641         sdev = to_scsi_device(dev);
642         return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
643 }
644
645 static ssize_t
646 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
647                     const char *buf, size_t count)
648 {
649         struct scsi_device *sdev;
650         unsigned int eh_timeout;
651         int err;
652
653         if (!capable(CAP_SYS_ADMIN))
654                 return -EACCES;
655
656         sdev = to_scsi_device(dev);
657         err = kstrtouint(buf, 10, &eh_timeout);
658         if (err)
659                 return err;
660         sdev->eh_timeout = eh_timeout * HZ;
661
662         return count;
663 }
664 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
665
666 static ssize_t
667 store_rescan_field (struct device *dev, struct device_attribute *attr,
668                     const char *buf, size_t count)
669 {
670         scsi_rescan_device(dev);
671         return count;
672 }
673 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
674
675 static ssize_t
676 sdev_store_delete(struct device *dev, struct device_attribute *attr,
677                   const char *buf, size_t count)
678 {
679         if (device_remove_file_self(dev, attr))
680                 scsi_remove_device(to_scsi_device(dev));
681         return count;
682 };
683 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
684
685 static ssize_t
686 store_state_field(struct device *dev, struct device_attribute *attr,
687                   const char *buf, size_t count)
688 {
689         int i;
690         struct scsi_device *sdev = to_scsi_device(dev);
691         enum scsi_device_state state = 0;
692
693         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
694                 const int len = strlen(sdev_states[i].name);
695                 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
696                    buf[len] == '\n') {
697                         state = sdev_states[i].value;
698                         break;
699                 }
700         }
701         if (!state)
702                 return -EINVAL;
703
704         if (scsi_device_set_state(sdev, state))
705                 return -EINVAL;
706         return count;
707 }
708
709 static ssize_t
710 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
711 {
712         struct scsi_device *sdev = to_scsi_device(dev);
713         const char *name = scsi_device_state_name(sdev->sdev_state);
714
715         if (!name)
716                 return -EINVAL;
717
718         return snprintf(buf, 20, "%s\n", name);
719 }
720
721 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
722
723 static ssize_t
724 show_queue_type_field(struct device *dev, struct device_attribute *attr,
725                       char *buf)
726 {
727         struct scsi_device *sdev = to_scsi_device(dev);
728         const char *name = "none";
729
730         if (sdev->simple_tags)
731                 name = "simple";
732
733         return snprintf(buf, 20, "%s\n", name);
734 }
735
736 static ssize_t
737 store_queue_type_field(struct device *dev, struct device_attribute *attr,
738                        const char *buf, size_t count)
739 {
740         struct scsi_device *sdev = to_scsi_device(dev);
741         struct scsi_host_template *sht = sdev->host->hostt;
742         int tag_type = 0, retval;
743         int prev_tag_type = scsi_get_tag_type(sdev);
744
745         if (!sdev->tagged_supported || !sht->change_queue_type)
746                 return -EINVAL;
747
748         /*
749          * We're never issueing order tags these days, but allow the value
750          * for backwards compatibility.
751          */
752         if (strncmp(buf, "ordered", 7) == 0 ||
753             strncmp(buf, "simple", 6) == 0)
754                 tag_type = MSG_SIMPLE_TAG;
755         else if (strncmp(buf, "none", 4) != 0)
756                 return -EINVAL;
757
758         if (tag_type == prev_tag_type)
759                 return count;
760
761         retval = sht->change_queue_type(sdev, tag_type);
762         if (retval < 0)
763                 return retval;
764
765         return count;
766 }
767
768 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
769                    store_queue_type_field);
770
771 #define sdev_vpd_pg_attr(_page)                                         \
772 static ssize_t                                                  \
773 show_vpd_##_page(struct file *filp, struct kobject *kobj,       \
774                  struct bin_attribute *bin_attr,                        \
775                  char *buf, loff_t off, size_t count)                   \
776 {                                                                       \
777         struct device *dev = container_of(kobj, struct device, kobj);   \
778         struct scsi_device *sdev = to_scsi_device(dev);                 \
779         if (!sdev->vpd_##_page)                                         \
780                 return -EINVAL;                                         \
781         return memory_read_from_buffer(buf, count, &off,                \
782                                        sdev->vpd_##_page,               \
783                                        sdev->vpd_##_page##_len);        \
784 }                                                                       \
785 static struct bin_attribute dev_attr_vpd_##_page = {            \
786         .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO },   \
787         .size = 0,                                                      \
788         .read = show_vpd_##_page,                                       \
789 };
790
791 sdev_vpd_pg_attr(pg83);
792 sdev_vpd_pg_attr(pg80);
793
794 static ssize_t
795 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
796                         char *buf)
797 {
798         return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
799 }
800
801 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
802
803 #define show_sdev_iostat(field)                                         \
804 static ssize_t                                                          \
805 show_iostat_##field(struct device *dev, struct device_attribute *attr,  \
806                     char *buf)                                          \
807 {                                                                       \
808         struct scsi_device *sdev = to_scsi_device(dev);                 \
809         unsigned long long count = atomic_read(&sdev->field);           \
810         return snprintf(buf, 20, "0x%llx\n", count);                    \
811 }                                                                       \
812 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
813
814 show_sdev_iostat(iorequest_cnt);
815 show_sdev_iostat(iodone_cnt);
816 show_sdev_iostat(ioerr_cnt);
817
818 static ssize_t
819 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
820 {
821         struct scsi_device *sdev;
822         sdev = to_scsi_device(dev);
823         return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
824 }
825 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
826
827 #define DECLARE_EVT_SHOW(name, Cap_name)                                \
828 static ssize_t                                                          \
829 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
830                      char *buf)                                         \
831 {                                                                       \
832         struct scsi_device *sdev = to_scsi_device(dev);                 \
833         int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
834         return snprintf(buf, 20, "%d\n", val);                          \
835 }
836
837 #define DECLARE_EVT_STORE(name, Cap_name)                               \
838 static ssize_t                                                          \
839 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
840                       const char *buf, size_t count)                    \
841 {                                                                       \
842         struct scsi_device *sdev = to_scsi_device(dev);                 \
843         int val = simple_strtoul(buf, NULL, 0);                         \
844         if (val == 0)                                                   \
845                 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
846         else if (val == 1)                                              \
847                 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events);   \
848         else                                                            \
849                 return -EINVAL;                                         \
850         return count;                                                   \
851 }
852
853 #define DECLARE_EVT(name, Cap_name)                                     \
854         DECLARE_EVT_SHOW(name, Cap_name)                                \
855         DECLARE_EVT_STORE(name, Cap_name)                               \
856         static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name,   \
857                            sdev_store_evt_##name);
858 #define REF_EVT(name) &dev_attr_evt_##name.attr
859
860 DECLARE_EVT(media_change, MEDIA_CHANGE)
861 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
862 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
863 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
864 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
865 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
866
867 static ssize_t
868 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
869                        const char *buf, size_t count)
870 {
871         int depth, retval;
872         struct scsi_device *sdev = to_scsi_device(dev);
873         struct scsi_host_template *sht = sdev->host->hostt;
874
875         if (!sht->change_queue_depth)
876                 return -EINVAL;
877
878         depth = simple_strtoul(buf, NULL, 0);
879
880         if (depth < 1 || depth > sht->can_queue)
881                 return -EINVAL;
882
883         retval = sht->change_queue_depth(sdev, depth);
884         if (retval < 0)
885                 return retval;
886
887         sdev->max_queue_depth = sdev->queue_depth;
888
889         return count;
890 }
891 sdev_show_function(queue_depth, "%d\n");
892
893 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
894                    sdev_store_queue_depth);
895
896 static ssize_t
897 sdev_show_queue_ramp_up_period(struct device *dev,
898                                struct device_attribute *attr,
899                                char *buf)
900 {
901         struct scsi_device *sdev;
902         sdev = to_scsi_device(dev);
903         return snprintf(buf, 20, "%u\n",
904                         jiffies_to_msecs(sdev->queue_ramp_up_period));
905 }
906
907 static ssize_t
908 sdev_store_queue_ramp_up_period(struct device *dev,
909                                 struct device_attribute *attr,
910                                 const char *buf, size_t count)
911 {
912         struct scsi_device *sdev = to_scsi_device(dev);
913         unsigned int period;
914
915         if (kstrtouint(buf, 10, &period))
916                 return -EINVAL;
917
918         sdev->queue_ramp_up_period = msecs_to_jiffies(period);
919         return period;
920 }
921
922 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
923                    sdev_show_queue_ramp_up_period,
924                    sdev_store_queue_ramp_up_period);
925
926 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
927                                          struct attribute *attr, int i)
928 {
929         struct device *dev = container_of(kobj, struct device, kobj);
930         struct scsi_device *sdev = to_scsi_device(dev);
931
932
933         if (attr == &dev_attr_queue_depth.attr &&
934             !sdev->host->hostt->change_queue_depth)
935                 return S_IRUGO;
936
937         if (attr == &dev_attr_queue_ramp_up_period.attr &&
938             !sdev->host->hostt->change_queue_depth)
939                 return 0;
940
941         if (attr == &dev_attr_queue_type.attr &&
942             !sdev->host->hostt->change_queue_type)
943                 return S_IRUGO;
944
945         return attr->mode;
946 }
947
948 /* Default template for device attributes.  May NOT be modified */
949 static struct attribute *scsi_sdev_attrs[] = {
950         &dev_attr_device_blocked.attr,
951         &dev_attr_type.attr,
952         &dev_attr_scsi_level.attr,
953         &dev_attr_device_busy.attr,
954         &dev_attr_vendor.attr,
955         &dev_attr_model.attr,
956         &dev_attr_rev.attr,
957         &dev_attr_rescan.attr,
958         &dev_attr_delete.attr,
959         &dev_attr_state.attr,
960         &dev_attr_timeout.attr,
961         &dev_attr_eh_timeout.attr,
962         &dev_attr_iocounterbits.attr,
963         &dev_attr_iorequest_cnt.attr,
964         &dev_attr_iodone_cnt.attr,
965         &dev_attr_ioerr_cnt.attr,
966         &dev_attr_modalias.attr,
967         &dev_attr_queue_depth.attr,
968         &dev_attr_queue_type.attr,
969         &dev_attr_queue_ramp_up_period.attr,
970         REF_EVT(media_change),
971         REF_EVT(inquiry_change_reported),
972         REF_EVT(capacity_change_reported),
973         REF_EVT(soft_threshold_reached),
974         REF_EVT(mode_parameter_change_reported),
975         REF_EVT(lun_change_reported),
976         NULL
977 };
978
979 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
980         &dev_attr_vpd_pg83,
981         &dev_attr_vpd_pg80,
982         NULL
983 };
984 static struct attribute_group scsi_sdev_attr_group = {
985         .attrs =        scsi_sdev_attrs,
986         .bin_attrs =    scsi_sdev_bin_attrs,
987         .is_visible =   scsi_sdev_attr_is_visible,
988 };
989
990 static const struct attribute_group *scsi_sdev_attr_groups[] = {
991         &scsi_sdev_attr_group,
992         NULL
993 };
994
995 static int scsi_target_add(struct scsi_target *starget)
996 {
997         int error;
998
999         if (starget->state != STARGET_CREATED)
1000                 return 0;
1001
1002         error = device_add(&starget->dev);
1003         if (error) {
1004                 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1005                 return error;
1006         }
1007         transport_add_device(&starget->dev);
1008         starget->state = STARGET_RUNNING;
1009
1010         pm_runtime_set_active(&starget->dev);
1011         pm_runtime_enable(&starget->dev);
1012         device_enable_async_suspend(&starget->dev);
1013
1014         return 0;
1015 }
1016
1017 /**
1018  * scsi_sysfs_add_sdev - add scsi device to sysfs
1019  * @sdev:       scsi_device to add
1020  *
1021  * Return value:
1022  *      0 on Success / non-zero on Failure
1023  **/
1024 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1025 {
1026         int error, i;
1027         struct request_queue *rq = sdev->request_queue;
1028         struct scsi_target *starget = sdev->sdev_target;
1029
1030         error = scsi_device_set_state(sdev, SDEV_RUNNING);
1031         if (error)
1032                 return error;
1033
1034         error = scsi_target_add(starget);
1035         if (error)
1036                 return error;
1037
1038         transport_configure_device(&starget->dev);
1039
1040         device_enable_async_suspend(&sdev->sdev_gendev);
1041         scsi_autopm_get_target(starget);
1042         pm_runtime_set_active(&sdev->sdev_gendev);
1043         pm_runtime_forbid(&sdev->sdev_gendev);
1044         pm_runtime_enable(&sdev->sdev_gendev);
1045         scsi_autopm_put_target(starget);
1046
1047         scsi_autopm_get_device(sdev);
1048
1049         error = device_add(&sdev->sdev_gendev);
1050         if (error) {
1051                 sdev_printk(KERN_INFO, sdev,
1052                                 "failed to add device: %d\n", error);
1053                 return error;
1054         }
1055         device_enable_async_suspend(&sdev->sdev_dev);
1056         error = device_add(&sdev->sdev_dev);
1057         if (error) {
1058                 sdev_printk(KERN_INFO, sdev,
1059                                 "failed to add class device: %d\n", error);
1060                 device_del(&sdev->sdev_gendev);
1061                 return error;
1062         }
1063         transport_add_device(&sdev->sdev_gendev);
1064         sdev->is_visible = 1;
1065
1066         error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
1067
1068         if (error)
1069                 /* we're treating error on bsg register as non-fatal,
1070                  * so pretend nothing went wrong */
1071                 sdev_printk(KERN_INFO, sdev,
1072                             "Failed to register bsg queue, errno=%d\n", error);
1073
1074         /* add additional host specific attributes */
1075         if (sdev->host->hostt->sdev_attrs) {
1076                 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1077                         error = device_create_file(&sdev->sdev_gendev,
1078                                         sdev->host->hostt->sdev_attrs[i]);
1079                         if (error)
1080                                 return error;
1081                 }
1082         }
1083
1084         scsi_autopm_put_device(sdev);
1085         return error;
1086 }
1087
1088 void __scsi_remove_device(struct scsi_device *sdev)
1089 {
1090         struct device *dev = &sdev->sdev_gendev;
1091
1092         if (sdev->is_visible) {
1093                 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
1094                         return;
1095
1096                 bsg_unregister_queue(sdev->request_queue);
1097                 device_unregister(&sdev->sdev_dev);
1098                 transport_remove_device(dev);
1099                 device_del(dev);
1100         } else
1101                 put_device(&sdev->sdev_dev);
1102
1103         /*
1104          * Stop accepting new requests and wait until all queuecommand() and
1105          * scsi_run_queue() invocations have finished before tearing down the
1106          * device.
1107          */
1108         scsi_device_set_state(sdev, SDEV_DEL);
1109         blk_cleanup_queue(sdev->request_queue);
1110         cancel_work_sync(&sdev->requeue_work);
1111
1112         if (sdev->host->hostt->slave_destroy)
1113                 sdev->host->hostt->slave_destroy(sdev);
1114         transport_destroy_device(dev);
1115
1116         /*
1117          * Paired with the kref_get() in scsi_sysfs_initialize().  We have
1118          * remoed sysfs visibility from the device, so make the target
1119          * invisible if this was the last device underneath it.
1120          */
1121         scsi_target_reap(scsi_target(sdev));
1122
1123         put_device(dev);
1124 }
1125
1126 /**
1127  * scsi_remove_device - unregister a device from the scsi bus
1128  * @sdev:       scsi_device to unregister
1129  **/
1130 void scsi_remove_device(struct scsi_device *sdev)
1131 {
1132         struct Scsi_Host *shost = sdev->host;
1133
1134         mutex_lock(&shost->scan_mutex);
1135         __scsi_remove_device(sdev);
1136         mutex_unlock(&shost->scan_mutex);
1137 }
1138 EXPORT_SYMBOL(scsi_remove_device);
1139
1140 static void __scsi_remove_target(struct scsi_target *starget)
1141 {
1142         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1143         unsigned long flags;
1144         struct scsi_device *sdev;
1145
1146         spin_lock_irqsave(shost->host_lock, flags);
1147  restart:
1148         list_for_each_entry(sdev, &shost->__devices, siblings) {
1149                 if (sdev->channel != starget->channel ||
1150                     sdev->id != starget->id ||
1151                     scsi_device_get(sdev))
1152                         continue;
1153                 spin_unlock_irqrestore(shost->host_lock, flags);
1154                 scsi_remove_device(sdev);
1155                 scsi_device_put(sdev);
1156                 spin_lock_irqsave(shost->host_lock, flags);
1157                 goto restart;
1158         }
1159         spin_unlock_irqrestore(shost->host_lock, flags);
1160 }
1161
1162 /**
1163  * scsi_remove_target - try to remove a target and all its devices
1164  * @dev: generic starget or parent of generic stargets to be removed
1165  *
1166  * Note: This is slightly racy.  It is possible that if the user
1167  * requests the addition of another device then the target won't be
1168  * removed.
1169  */
1170 void scsi_remove_target(struct device *dev)
1171 {
1172         struct Scsi_Host *shost = dev_to_shost(dev->parent);
1173         struct scsi_target *starget, *last = NULL;
1174         unsigned long flags;
1175
1176         /* remove targets being careful to lookup next entry before
1177          * deleting the last
1178          */
1179         spin_lock_irqsave(shost->host_lock, flags);
1180         list_for_each_entry(starget, &shost->__targets, siblings) {
1181                 if (starget->state == STARGET_DEL)
1182                         continue;
1183                 if (starget->dev.parent == dev || &starget->dev == dev) {
1184                         /* assuming new targets arrive at the end */
1185                         kref_get(&starget->reap_ref);
1186                         spin_unlock_irqrestore(shost->host_lock, flags);
1187                         if (last)
1188                                 scsi_target_reap(last);
1189                         last = starget;
1190                         __scsi_remove_target(starget);
1191                         spin_lock_irqsave(shost->host_lock, flags);
1192                 }
1193         }
1194         spin_unlock_irqrestore(shost->host_lock, flags);
1195
1196         if (last)
1197                 scsi_target_reap(last);
1198 }
1199 EXPORT_SYMBOL(scsi_remove_target);
1200
1201 int scsi_register_driver(struct device_driver *drv)
1202 {
1203         drv->bus = &scsi_bus_type;
1204
1205         return driver_register(drv);
1206 }
1207 EXPORT_SYMBOL(scsi_register_driver);
1208
1209 int scsi_register_interface(struct class_interface *intf)
1210 {
1211         intf->class = &sdev_class;
1212
1213         return class_interface_register(intf);
1214 }
1215 EXPORT_SYMBOL(scsi_register_interface);
1216
1217 /**
1218  * scsi_sysfs_add_host - add scsi host to subsystem
1219  * @shost:     scsi host struct to add to subsystem
1220  **/
1221 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1222 {
1223         int error, i;
1224
1225         /* add host specific attributes */
1226         if (shost->hostt->shost_attrs) {
1227                 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1228                         error = device_create_file(&shost->shost_dev,
1229                                         shost->hostt->shost_attrs[i]);
1230                         if (error)
1231                                 return error;
1232                 }
1233         }
1234
1235         transport_register_device(&shost->shost_gendev);
1236         transport_configure_device(&shost->shost_gendev);
1237         return 0;
1238 }
1239
1240 static struct device_type scsi_dev_type = {
1241         .name =         "scsi_device",
1242         .release =      scsi_device_dev_release,
1243         .groups =       scsi_sdev_attr_groups,
1244 };
1245
1246 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1247 {
1248         unsigned long flags;
1249         struct Scsi_Host *shost = sdev->host;
1250         struct scsi_target  *starget = sdev->sdev_target;
1251
1252         device_initialize(&sdev->sdev_gendev);
1253         sdev->sdev_gendev.bus = &scsi_bus_type;
1254         sdev->sdev_gendev.type = &scsi_dev_type;
1255         dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1256                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1257
1258         device_initialize(&sdev->sdev_dev);
1259         sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1260         sdev->sdev_dev.class = &sdev_class;
1261         dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1262                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1263         /*
1264          * Get a default scsi_level from the target (derived from sibling
1265          * devices).  This is the best we can do for guessing how to set
1266          * sdev->lun_in_cdb for the initial INQUIRY command.  For LUN 0 the
1267          * setting doesn't matter, because all the bits are zero anyway.
1268          * But it does matter for higher LUNs.
1269          */
1270         sdev->scsi_level = starget->scsi_level;
1271         if (sdev->scsi_level <= SCSI_2 &&
1272                         sdev->scsi_level != SCSI_UNKNOWN &&
1273                         !shost->no_scsi2_lun_in_cdb)
1274                 sdev->lun_in_cdb = 1;
1275
1276         transport_setup_device(&sdev->sdev_gendev);
1277         spin_lock_irqsave(shost->host_lock, flags);
1278         list_add_tail(&sdev->same_target_siblings, &starget->devices);
1279         list_add_tail(&sdev->siblings, &shost->__devices);
1280         spin_unlock_irqrestore(shost->host_lock, flags);
1281         /*
1282          * device can now only be removed via __scsi_remove_device() so hold
1283          * the target.  Target will be held in CREATED state until something
1284          * beneath it becomes visible (in which case it moves to RUNNING)
1285          */
1286         kref_get(&starget->reap_ref);
1287 }
1288
1289 int scsi_is_sdev_device(const struct device *dev)
1290 {
1291         return dev->type == &scsi_dev_type;
1292 }
1293 EXPORT_SYMBOL(scsi_is_sdev_device);
1294
1295 /* A blank transport template that is used in drivers that don't
1296  * yet implement Transport Attributes */
1297 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };