]> Pileus Git - ~andy/linux/blob - drivers/scsi/scsi_sysfs.c
[SCSI] prevent stack buffer overflow in host_reset
[~andy/linux] / 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 int *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_strtoul(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[15], junk;
103         unsigned int channel, id, lun;
104         int res;
105
106         res = sscanf(str, "%10s %10s %10s %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 shost_rd_attr(unique_id, "%u\n");
285 shost_rd_attr(host_busy, "%hu\n");
286 shost_rd_attr(cmd_per_lun, "%hd\n");
287 shost_rd_attr(can_queue, "%hd\n");
288 shost_rd_attr(sg_tablesize, "%hu\n");
289 shost_rd_attr(sg_prot_tablesize, "%hu\n");
290 shost_rd_attr(unchecked_isa_dma, "%d\n");
291 shost_rd_attr(prot_capabilities, "%u\n");
292 shost_rd_attr(prot_guard_type, "%hd\n");
293 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
294
295 static struct attribute *scsi_sysfs_shost_attrs[] = {
296         &dev_attr_unique_id.attr,
297         &dev_attr_host_busy.attr,
298         &dev_attr_cmd_per_lun.attr,
299         &dev_attr_can_queue.attr,
300         &dev_attr_sg_tablesize.attr,
301         &dev_attr_sg_prot_tablesize.attr,
302         &dev_attr_unchecked_isa_dma.attr,
303         &dev_attr_proc_name.attr,
304         &dev_attr_scan.attr,
305         &dev_attr_hstate.attr,
306         &dev_attr_supported_mode.attr,
307         &dev_attr_active_mode.attr,
308         &dev_attr_prot_capabilities.attr,
309         &dev_attr_prot_guard_type.attr,
310         &dev_attr_host_reset.attr,
311         NULL
312 };
313
314 struct attribute_group scsi_shost_attr_group = {
315         .attrs =        scsi_sysfs_shost_attrs,
316 };
317
318 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
319         &scsi_shost_attr_group,
320         NULL
321 };
322
323 static void scsi_device_cls_release(struct device *class_dev)
324 {
325         struct scsi_device *sdev;
326
327         sdev = class_to_sdev(class_dev);
328         put_device(&sdev->sdev_gendev);
329 }
330
331 static void scsi_device_dev_release_usercontext(struct work_struct *work)
332 {
333         struct scsi_device *sdev;
334         struct device *parent;
335         struct scsi_target *starget;
336         struct list_head *this, *tmp;
337         unsigned long flags;
338
339         sdev = container_of(work, struct scsi_device, ew.work);
340
341         parent = sdev->sdev_gendev.parent;
342         starget = to_scsi_target(parent);
343
344         spin_lock_irqsave(sdev->host->host_lock, flags);
345         starget->reap_ref++;
346         list_del(&sdev->siblings);
347         list_del(&sdev->same_target_siblings);
348         list_del(&sdev->starved_entry);
349         spin_unlock_irqrestore(sdev->host->host_lock, flags);
350
351         cancel_work_sync(&sdev->event_work);
352
353         list_for_each_safe(this, tmp, &sdev->event_list) {
354                 struct scsi_event *evt;
355
356                 evt = list_entry(this, struct scsi_event, node);
357                 list_del(&evt->node);
358                 kfree(evt);
359         }
360
361         blk_put_queue(sdev->request_queue);
362         /* NULL queue means the device can't be used */
363         sdev->request_queue = NULL;
364
365         scsi_target_reap(scsi_target(sdev));
366
367         kfree(sdev->inquiry);
368         kfree(sdev);
369
370         if (parent)
371                 put_device(parent);
372 }
373
374 static void scsi_device_dev_release(struct device *dev)
375 {
376         struct scsi_device *sdp = to_scsi_device(dev);
377         execute_in_process_context(scsi_device_dev_release_usercontext,
378                                    &sdp->ew);
379 }
380
381 static struct class sdev_class = {
382         .name           = "scsi_device",
383         .dev_release    = scsi_device_cls_release,
384 };
385
386 /* all probing is done in the individual ->probe routines */
387 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
388 {
389         struct scsi_device *sdp;
390
391         if (dev->type != &scsi_dev_type)
392                 return 0;
393
394         sdp = to_scsi_device(dev);
395         if (sdp->no_uld_attach)
396                 return 0;
397         return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
398 }
399
400 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
401 {
402         struct scsi_device *sdev;
403
404         if (dev->type != &scsi_dev_type)
405                 return 0;
406
407         sdev = to_scsi_device(dev);
408
409         add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
410         return 0;
411 }
412
413 struct bus_type scsi_bus_type = {
414         .name           = "scsi",
415         .match          = scsi_bus_match,
416         .uevent         = scsi_bus_uevent,
417 #ifdef CONFIG_PM
418         .pm             = &scsi_bus_pm_ops,
419 #endif
420 };
421 EXPORT_SYMBOL_GPL(scsi_bus_type);
422
423 int scsi_sysfs_register(void)
424 {
425         int error;
426
427         error = bus_register(&scsi_bus_type);
428         if (!error) {
429                 error = class_register(&sdev_class);
430                 if (error)
431                         bus_unregister(&scsi_bus_type);
432         }
433
434         return error;
435 }
436
437 void scsi_sysfs_unregister(void)
438 {
439         class_unregister(&sdev_class);
440         bus_unregister(&scsi_bus_type);
441 }
442
443 /*
444  * sdev_show_function: macro to create an attr function that can be used to
445  * show a non-bit field.
446  */
447 #define sdev_show_function(field, format_string)                                \
448 static ssize_t                                                          \
449 sdev_show_##field (struct device *dev, struct device_attribute *attr,   \
450                    char *buf)                                           \
451 {                                                                       \
452         struct scsi_device *sdev;                                       \
453         sdev = to_scsi_device(dev);                                     \
454         return snprintf (buf, 20, format_string, sdev->field);          \
455 }                                                                       \
456
457 /*
458  * sdev_rd_attr: macro to create a function and attribute variable for a
459  * read only field.
460  */
461 #define sdev_rd_attr(field, format_string)                              \
462         sdev_show_function(field, format_string)                        \
463 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
464
465
466 /*
467  * sdev_rw_attr: create a function and attribute variable for a
468  * read/write field.
469  */
470 #define sdev_rw_attr(field, format_string)                              \
471         sdev_show_function(field, format_string)                                \
472                                                                         \
473 static ssize_t                                                          \
474 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
475                     const char *buf, size_t count)                      \
476 {                                                                       \
477         struct scsi_device *sdev;                                       \
478         sdev = to_scsi_device(dev);                                     \
479         sscanf (buf, format_string, &sdev->field);                      \
480         return count;                                                   \
481 }                                                                       \
482 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
483
484 /* Currently we don't export bit fields, but we might in future,
485  * so leave this code in */
486 #if 0
487 /*
488  * sdev_rd_attr: create a function and attribute variable for a
489  * read/write bit field.
490  */
491 #define sdev_rw_attr_bit(field)                                         \
492         sdev_show_function(field, "%d\n")                                       \
493                                                                         \
494 static ssize_t                                                          \
495 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
496                     const char *buf, size_t count)                      \
497 {                                                                       \
498         int ret;                                                        \
499         struct scsi_device *sdev;                                       \
500         ret = scsi_sdev_check_buf_bit(buf);                             \
501         if (ret >= 0)   {                                               \
502                 sdev = to_scsi_device(dev);                             \
503                 sdev->field = ret;                                      \
504                 ret = count;                                            \
505         }                                                               \
506         return ret;                                                     \
507 }                                                                       \
508 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
509
510 /*
511  * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
512  * else return -EINVAL.
513  */
514 static int scsi_sdev_check_buf_bit(const char *buf)
515 {
516         if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
517                 if (buf[0] == '1')
518                         return 1;
519                 else if (buf[0] == '0')
520                         return 0;
521                 else 
522                         return -EINVAL;
523         } else
524                 return -EINVAL;
525 }
526 #endif
527 /*
528  * Create the actual show/store functions and data structures.
529  */
530 sdev_rd_attr (device_blocked, "%d\n");
531 sdev_rd_attr (queue_depth, "%d\n");
532 sdev_rd_attr (type, "%d\n");
533 sdev_rd_attr (scsi_level, "%d\n");
534 sdev_rd_attr (vendor, "%.8s\n");
535 sdev_rd_attr (model, "%.16s\n");
536 sdev_rd_attr (rev, "%.4s\n");
537
538 /*
539  * TODO: can we make these symlinks to the block layer ones?
540  */
541 static ssize_t
542 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
543 {
544         struct scsi_device *sdev;
545         sdev = to_scsi_device(dev);
546         return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
547 }
548
549 static ssize_t
550 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
551                     const char *buf, size_t count)
552 {
553         struct scsi_device *sdev;
554         int timeout;
555         sdev = to_scsi_device(dev);
556         sscanf (buf, "%d\n", &timeout);
557         blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
558         return count;
559 }
560 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
561
562 static ssize_t
563 store_rescan_field (struct device *dev, struct device_attribute *attr,
564                     const char *buf, size_t count)
565 {
566         scsi_rescan_device(dev);
567         return count;
568 }
569 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
570
571 static void sdev_store_delete_callback(struct device *dev)
572 {
573         scsi_remove_device(to_scsi_device(dev));
574 }
575
576 static ssize_t
577 sdev_store_delete(struct device *dev, struct device_attribute *attr,
578                   const char *buf, size_t count)
579 {
580         int rc;
581
582         /* An attribute cannot be unregistered by one of its own methods,
583          * so we have to use this roundabout approach.
584          */
585         rc = device_schedule_callback(dev, sdev_store_delete_callback);
586         if (rc)
587                 count = rc;
588         return count;
589 };
590 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
591
592 static ssize_t
593 store_state_field(struct device *dev, struct device_attribute *attr,
594                   const char *buf, size_t count)
595 {
596         int i;
597         struct scsi_device *sdev = to_scsi_device(dev);
598         enum scsi_device_state state = 0;
599
600         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
601                 const int len = strlen(sdev_states[i].name);
602                 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
603                    buf[len] == '\n') {
604                         state = sdev_states[i].value;
605                         break;
606                 }
607         }
608         if (!state)
609                 return -EINVAL;
610
611         if (scsi_device_set_state(sdev, state))
612                 return -EINVAL;
613         return count;
614 }
615
616 static ssize_t
617 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
618 {
619         struct scsi_device *sdev = to_scsi_device(dev);
620         const char *name = scsi_device_state_name(sdev->sdev_state);
621
622         if (!name)
623                 return -EINVAL;
624
625         return snprintf(buf, 20, "%s\n", name);
626 }
627
628 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
629
630 static ssize_t
631 show_queue_type_field(struct device *dev, struct device_attribute *attr,
632                       char *buf)
633 {
634         struct scsi_device *sdev = to_scsi_device(dev);
635         const char *name = "none";
636
637         if (sdev->ordered_tags)
638                 name = "ordered";
639         else if (sdev->simple_tags)
640                 name = "simple";
641
642         return snprintf(buf, 20, "%s\n", name);
643 }
644
645 static DEVICE_ATTR(queue_type, S_IRUGO, show_queue_type_field, NULL);
646
647 static ssize_t
648 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,                              char *buf)
649 {
650         return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
651 }
652
653 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
654
655 #define show_sdev_iostat(field)                                         \
656 static ssize_t                                                          \
657 show_iostat_##field(struct device *dev, struct device_attribute *attr,  \
658                     char *buf)                                          \
659 {                                                                       \
660         struct scsi_device *sdev = to_scsi_device(dev);                 \
661         unsigned long long count = atomic_read(&sdev->field);           \
662         return snprintf(buf, 20, "0x%llx\n", count);                    \
663 }                                                                       \
664 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
665
666 show_sdev_iostat(iorequest_cnt);
667 show_sdev_iostat(iodone_cnt);
668 show_sdev_iostat(ioerr_cnt);
669
670 static ssize_t
671 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
672 {
673         struct scsi_device *sdev;
674         sdev = to_scsi_device(dev);
675         return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
676 }
677 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
678
679 #define DECLARE_EVT_SHOW(name, Cap_name)                                \
680 static ssize_t                                                          \
681 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
682                      char *buf)                                         \
683 {                                                                       \
684         struct scsi_device *sdev = to_scsi_device(dev);                 \
685         int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
686         return snprintf(buf, 20, "%d\n", val);                          \
687 }
688
689 #define DECLARE_EVT_STORE(name, Cap_name)                               \
690 static ssize_t                                                          \
691 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
692                       const char *buf, size_t count)                    \
693 {                                                                       \
694         struct scsi_device *sdev = to_scsi_device(dev);                 \
695         int val = simple_strtoul(buf, NULL, 0);                         \
696         if (val == 0)                                                   \
697                 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
698         else if (val == 1)                                              \
699                 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events);   \
700         else                                                            \
701                 return -EINVAL;                                         \
702         return count;                                                   \
703 }
704
705 #define DECLARE_EVT(name, Cap_name)                                     \
706         DECLARE_EVT_SHOW(name, Cap_name)                                \
707         DECLARE_EVT_STORE(name, Cap_name)                               \
708         static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name,   \
709                            sdev_store_evt_##name);
710 #define REF_EVT(name) &dev_attr_evt_##name.attr
711
712 DECLARE_EVT(media_change, MEDIA_CHANGE)
713
714 /* Default template for device attributes.  May NOT be modified */
715 static struct attribute *scsi_sdev_attrs[] = {
716         &dev_attr_device_blocked.attr,
717         &dev_attr_type.attr,
718         &dev_attr_scsi_level.attr,
719         &dev_attr_vendor.attr,
720         &dev_attr_model.attr,
721         &dev_attr_rev.attr,
722         &dev_attr_rescan.attr,
723         &dev_attr_delete.attr,
724         &dev_attr_state.attr,
725         &dev_attr_timeout.attr,
726         &dev_attr_iocounterbits.attr,
727         &dev_attr_iorequest_cnt.attr,
728         &dev_attr_iodone_cnt.attr,
729         &dev_attr_ioerr_cnt.attr,
730         &dev_attr_modalias.attr,
731         REF_EVT(media_change),
732         NULL
733 };
734
735 static struct attribute_group scsi_sdev_attr_group = {
736         .attrs =        scsi_sdev_attrs,
737 };
738
739 static const struct attribute_group *scsi_sdev_attr_groups[] = {
740         &scsi_sdev_attr_group,
741         NULL
742 };
743
744 static ssize_t
745 sdev_store_queue_depth_rw(struct device *dev, struct device_attribute *attr,
746                           const char *buf, size_t count)
747 {
748         int depth, retval;
749         struct scsi_device *sdev = to_scsi_device(dev);
750         struct scsi_host_template *sht = sdev->host->hostt;
751
752         if (!sht->change_queue_depth)
753                 return -EINVAL;
754
755         depth = simple_strtoul(buf, NULL, 0);
756
757         if (depth < 1)
758                 return -EINVAL;
759
760         retval = sht->change_queue_depth(sdev, depth,
761                                          SCSI_QDEPTH_DEFAULT);
762         if (retval < 0)
763                 return retval;
764
765         sdev->max_queue_depth = sdev->queue_depth;
766
767         return count;
768 }
769
770 static struct device_attribute sdev_attr_queue_depth_rw =
771         __ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
772                sdev_store_queue_depth_rw);
773
774 static ssize_t
775 sdev_show_queue_ramp_up_period(struct device *dev,
776                                struct device_attribute *attr,
777                                char *buf)
778 {
779         struct scsi_device *sdev;
780         sdev = to_scsi_device(dev);
781         return snprintf(buf, 20, "%u\n",
782                         jiffies_to_msecs(sdev->queue_ramp_up_period));
783 }
784
785 static ssize_t
786 sdev_store_queue_ramp_up_period(struct device *dev,
787                                 struct device_attribute *attr,
788                                 const char *buf, size_t count)
789 {
790         struct scsi_device *sdev = to_scsi_device(dev);
791         unsigned long period;
792
793         if (strict_strtoul(buf, 10, &period))
794                 return -EINVAL;
795
796         sdev->queue_ramp_up_period = msecs_to_jiffies(period);
797         return period;
798 }
799
800 static struct device_attribute sdev_attr_queue_ramp_up_period =
801         __ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
802                sdev_show_queue_ramp_up_period,
803                sdev_store_queue_ramp_up_period);
804
805 static ssize_t
806 sdev_store_queue_type_rw(struct device *dev, struct device_attribute *attr,
807                          const char *buf, size_t count)
808 {
809         struct scsi_device *sdev = to_scsi_device(dev);
810         struct scsi_host_template *sht = sdev->host->hostt;
811         int tag_type = 0, retval;
812         int prev_tag_type = scsi_get_tag_type(sdev);
813
814         if (!sdev->tagged_supported || !sht->change_queue_type)
815                 return -EINVAL;
816
817         if (strncmp(buf, "ordered", 7) == 0)
818                 tag_type = MSG_ORDERED_TAG;
819         else if (strncmp(buf, "simple", 6) == 0)
820                 tag_type = MSG_SIMPLE_TAG;
821         else if (strncmp(buf, "none", 4) != 0)
822                 return -EINVAL;
823
824         if (tag_type == prev_tag_type)
825                 return count;
826
827         retval = sht->change_queue_type(sdev, tag_type);
828         if (retval < 0)
829                 return retval;
830
831         return count;
832 }
833
834 static int scsi_target_add(struct scsi_target *starget)
835 {
836         int error;
837
838         if (starget->state != STARGET_CREATED)
839                 return 0;
840
841         error = device_add(&starget->dev);
842         if (error) {
843                 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
844                 return error;
845         }
846         transport_add_device(&starget->dev);
847         starget->state = STARGET_RUNNING;
848
849         pm_runtime_set_active(&starget->dev);
850         pm_runtime_enable(&starget->dev);
851         device_enable_async_suspend(&starget->dev);
852
853         return 0;
854 }
855
856 static struct device_attribute sdev_attr_queue_type_rw =
857         __ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
858                sdev_store_queue_type_rw);
859
860 /**
861  * scsi_sysfs_add_sdev - add scsi device to sysfs
862  * @sdev:       scsi_device to add
863  *
864  * Return value:
865  *      0 on Success / non-zero on Failure
866  **/
867 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
868 {
869         int error, i;
870         struct request_queue *rq = sdev->request_queue;
871         struct scsi_target *starget = sdev->sdev_target;
872
873         error = scsi_device_set_state(sdev, SDEV_RUNNING);
874         if (error)
875                 return error;
876
877         error = scsi_target_add(starget);
878         if (error)
879                 return error;
880
881         transport_configure_device(&starget->dev);
882
883         device_enable_async_suspend(&sdev->sdev_gendev);
884         scsi_autopm_get_target(starget);
885         pm_runtime_set_active(&sdev->sdev_gendev);
886         pm_runtime_forbid(&sdev->sdev_gendev);
887         pm_runtime_enable(&sdev->sdev_gendev);
888         scsi_autopm_put_target(starget);
889
890         /* The following call will keep sdev active indefinitely, until
891          * its driver does a corresponding scsi_autopm_pm_device().  Only
892          * drivers supporting autosuspend will do this.
893          */
894         scsi_autopm_get_device(sdev);
895
896         error = device_add(&sdev->sdev_gendev);
897         if (error) {
898                 sdev_printk(KERN_INFO, sdev,
899                                 "failed to add device: %d\n", error);
900                 return error;
901         }
902         device_enable_async_suspend(&sdev->sdev_dev);
903         error = device_add(&sdev->sdev_dev);
904         if (error) {
905                 sdev_printk(KERN_INFO, sdev,
906                                 "failed to add class device: %d\n", error);
907                 device_del(&sdev->sdev_gendev);
908                 return error;
909         }
910         transport_add_device(&sdev->sdev_gendev);
911         sdev->is_visible = 1;
912
913         /* create queue files, which may be writable, depending on the host */
914         if (sdev->host->hostt->change_queue_depth) {
915                 error = device_create_file(&sdev->sdev_gendev,
916                                            &sdev_attr_queue_depth_rw);
917                 error = device_create_file(&sdev->sdev_gendev,
918                                            &sdev_attr_queue_ramp_up_period);
919         }
920         else
921                 error = device_create_file(&sdev->sdev_gendev, &dev_attr_queue_depth);
922         if (error)
923                 return error;
924
925         if (sdev->host->hostt->change_queue_type)
926                 error = device_create_file(&sdev->sdev_gendev, &sdev_attr_queue_type_rw);
927         else
928                 error = device_create_file(&sdev->sdev_gendev, &dev_attr_queue_type);
929         if (error)
930                 return error;
931
932         error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
933
934         if (error)
935                 /* we're treating error on bsg register as non-fatal,
936                  * so pretend nothing went wrong */
937                 sdev_printk(KERN_INFO, sdev,
938                             "Failed to register bsg queue, errno=%d\n", error);
939
940         /* add additional host specific attributes */
941         if (sdev->host->hostt->sdev_attrs) {
942                 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
943                         error = device_create_file(&sdev->sdev_gendev,
944                                         sdev->host->hostt->sdev_attrs[i]);
945                         if (error)
946                                 return error;
947                 }
948         }
949
950         return error;
951 }
952
953 void __scsi_remove_device(struct scsi_device *sdev)
954 {
955         struct device *dev = &sdev->sdev_gendev;
956
957         if (sdev->is_visible) {
958                 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
959                         return;
960
961                 bsg_unregister_queue(sdev->request_queue);
962                 device_unregister(&sdev->sdev_dev);
963                 transport_remove_device(dev);
964                 device_del(dev);
965         } else
966                 put_device(&sdev->sdev_dev);
967
968         /*
969          * Stop accepting new requests and wait until all queuecommand() and
970          * scsi_run_queue() invocations have finished before tearing down the
971          * device.
972          */
973         scsi_device_set_state(sdev, SDEV_DEL);
974         blk_cleanup_queue(sdev->request_queue);
975         cancel_work_sync(&sdev->requeue_work);
976
977         if (sdev->host->hostt->slave_destroy)
978                 sdev->host->hostt->slave_destroy(sdev);
979         transport_destroy_device(dev);
980
981         put_device(dev);
982 }
983
984 /**
985  * scsi_remove_device - unregister a device from the scsi bus
986  * @sdev:       scsi_device to unregister
987  **/
988 void scsi_remove_device(struct scsi_device *sdev)
989 {
990         struct Scsi_Host *shost = sdev->host;
991
992         mutex_lock(&shost->scan_mutex);
993         __scsi_remove_device(sdev);
994         mutex_unlock(&shost->scan_mutex);
995 }
996 EXPORT_SYMBOL(scsi_remove_device);
997
998 static void __scsi_remove_target(struct scsi_target *starget)
999 {
1000         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1001         unsigned long flags;
1002         struct scsi_device *sdev;
1003
1004         spin_lock_irqsave(shost->host_lock, flags);
1005  restart:
1006         list_for_each_entry(sdev, &shost->__devices, siblings) {
1007                 if (sdev->channel != starget->channel ||
1008                     sdev->id != starget->id ||
1009                     scsi_device_get(sdev))
1010                         continue;
1011                 spin_unlock_irqrestore(shost->host_lock, flags);
1012                 scsi_remove_device(sdev);
1013                 scsi_device_put(sdev);
1014                 spin_lock_irqsave(shost->host_lock, flags);
1015                 goto restart;
1016         }
1017         spin_unlock_irqrestore(shost->host_lock, flags);
1018 }
1019
1020 /**
1021  * scsi_remove_target - try to remove a target and all its devices
1022  * @dev: generic starget or parent of generic stargets to be removed
1023  *
1024  * Note: This is slightly racy.  It is possible that if the user
1025  * requests the addition of another device then the target won't be
1026  * removed.
1027  */
1028 void scsi_remove_target(struct device *dev)
1029 {
1030         struct Scsi_Host *shost = dev_to_shost(dev->parent);
1031         struct scsi_target *starget, *last = NULL;
1032         unsigned long flags;
1033
1034         /* remove targets being careful to lookup next entry before
1035          * deleting the last
1036          */
1037         spin_lock_irqsave(shost->host_lock, flags);
1038         list_for_each_entry(starget, &shost->__targets, siblings) {
1039                 if (starget->state == STARGET_DEL)
1040                         continue;
1041                 if (starget->dev.parent == dev || &starget->dev == dev) {
1042                         /* assuming new targets arrive at the end */
1043                         starget->reap_ref++;
1044                         spin_unlock_irqrestore(shost->host_lock, flags);
1045                         if (last)
1046                                 scsi_target_reap(last);
1047                         last = starget;
1048                         __scsi_remove_target(starget);
1049                         spin_lock_irqsave(shost->host_lock, flags);
1050                 }
1051         }
1052         spin_unlock_irqrestore(shost->host_lock, flags);
1053
1054         if (last)
1055                 scsi_target_reap(last);
1056 }
1057 EXPORT_SYMBOL(scsi_remove_target);
1058
1059 int scsi_register_driver(struct device_driver *drv)
1060 {
1061         drv->bus = &scsi_bus_type;
1062
1063         return driver_register(drv);
1064 }
1065 EXPORT_SYMBOL(scsi_register_driver);
1066
1067 int scsi_register_interface(struct class_interface *intf)
1068 {
1069         intf->class = &sdev_class;
1070
1071         return class_interface_register(intf);
1072 }
1073 EXPORT_SYMBOL(scsi_register_interface);
1074
1075 /**
1076  * scsi_sysfs_add_host - add scsi host to subsystem
1077  * @shost:     scsi host struct to add to subsystem
1078  **/
1079 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1080 {
1081         int error, i;
1082
1083         /* add host specific attributes */
1084         if (shost->hostt->shost_attrs) {
1085                 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1086                         error = device_create_file(&shost->shost_dev,
1087                                         shost->hostt->shost_attrs[i]);
1088                         if (error)
1089                                 return error;
1090                 }
1091         }
1092
1093         transport_register_device(&shost->shost_gendev);
1094         transport_configure_device(&shost->shost_gendev);
1095         return 0;
1096 }
1097
1098 static struct device_type scsi_dev_type = {
1099         .name =         "scsi_device",
1100         .release =      scsi_device_dev_release,
1101         .groups =       scsi_sdev_attr_groups,
1102 };
1103
1104 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1105 {
1106         unsigned long flags;
1107         struct Scsi_Host *shost = sdev->host;
1108         struct scsi_target  *starget = sdev->sdev_target;
1109
1110         device_initialize(&sdev->sdev_gendev);
1111         sdev->sdev_gendev.bus = &scsi_bus_type;
1112         sdev->sdev_gendev.type = &scsi_dev_type;
1113         dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%d",
1114                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1115
1116         device_initialize(&sdev->sdev_dev);
1117         sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1118         sdev->sdev_dev.class = &sdev_class;
1119         dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%d",
1120                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1121         sdev->scsi_level = starget->scsi_level;
1122         transport_setup_device(&sdev->sdev_gendev);
1123         spin_lock_irqsave(shost->host_lock, flags);
1124         list_add_tail(&sdev->same_target_siblings, &starget->devices);
1125         list_add_tail(&sdev->siblings, &shost->__devices);
1126         spin_unlock_irqrestore(shost->host_lock, flags);
1127 }
1128
1129 int scsi_is_sdev_device(const struct device *dev)
1130 {
1131         return dev->type == &scsi_dev_type;
1132 }
1133 EXPORT_SYMBOL(scsi_is_sdev_device);
1134
1135 /* A blank transport template that is used in drivers that don't
1136  * yet implement Transport Attributes */
1137 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };