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