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