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 
scsi_device_state_name(enum scsi_device_state state)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 };
scsi_host_state_name(enum scsi_host_state state)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 
scsi_access_state_name(unsigned char state)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 
check_set(unsigned long long * val,char * src)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 
scsi_scan(struct Scsi_Host * shost,const char * str)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
store_scan(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)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
store_shost_state(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)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
show_shost_state(struct device * dev,struct device_attribute * attr,char * buf)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
show_shost_mode(unsigned int mode,char * buf)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
show_shost_supported_mode(struct device * dev,struct device_attribute * attr,char * buf)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
show_shost_active_mode(struct device * dev,struct device_attribute * attr,char * buf)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 
check_reset_type(const char * str)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
store_host_reset(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)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
show_shost_eh_deadline(struct device * dev,struct device_attribute * attr,char * buf)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
store_shost_eh_deadline(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)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
show_host_busy(struct device * dev,struct device_attribute * attr,char * buf)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
show_use_blk_mq(struct device * dev,struct device_attribute * attr,char * buf)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
show_nr_hw_queues(struct device * dev,struct device_attribute * attr,char * buf)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 const struct attribute_group scsi_shost_attr_group = {
428 	.attrs =	scsi_sysfs_shost_attrs,
429 };
430 
scsi_device_cls_release(struct device * class_dev)431 static void scsi_device_cls_release(struct device *class_dev)
432 {
433 	struct scsi_device *sdev;
434 
435 	sdev = class_to_sdev(class_dev);
436 	put_device(&sdev->sdev_gendev);
437 }
438 
scsi_device_dev_release_usercontext(struct work_struct * work)439 static void scsi_device_dev_release_usercontext(struct work_struct *work)
440 {
441 	struct scsi_device *sdev;
442 	struct device *parent;
443 	struct list_head *this, *tmp;
444 	struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
445 	struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
446 	unsigned long flags;
447 	struct module *mod;
448 
449 	sdev = container_of(work, struct scsi_device, ew.work);
450 
451 	mod = sdev->host->hostt->module;
452 
453 	scsi_dh_release_device(sdev);
454 
455 	parent = sdev->sdev_gendev.parent;
456 
457 	spin_lock_irqsave(sdev->host->host_lock, flags);
458 	list_del(&sdev->siblings);
459 	list_del(&sdev->same_target_siblings);
460 	list_del(&sdev->starved_entry);
461 	spin_unlock_irqrestore(sdev->host->host_lock, flags);
462 
463 	cancel_work_sync(&sdev->event_work);
464 
465 	list_for_each_safe(this, tmp, &sdev->event_list) {
466 		struct scsi_event *evt;
467 
468 		evt = list_entry(this, struct scsi_event, node);
469 		list_del(&evt->node);
470 		kfree(evt);
471 	}
472 
473 	blk_put_queue(sdev->request_queue);
474 	/* NULL queue means the device can't be used */
475 	sdev->request_queue = NULL;
476 
477 	sbitmap_free(&sdev->budget_map);
478 
479 	mutex_lock(&sdev->inquiry_mutex);
480 	vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
481 				       lockdep_is_held(&sdev->inquiry_mutex));
482 	vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
483 				       lockdep_is_held(&sdev->inquiry_mutex));
484 	vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
485 				       lockdep_is_held(&sdev->inquiry_mutex));
486 	vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
487 				       lockdep_is_held(&sdev->inquiry_mutex));
488 	mutex_unlock(&sdev->inquiry_mutex);
489 
490 	if (vpd_pg0)
491 		kfree_rcu(vpd_pg0, rcu);
492 	if (vpd_pg83)
493 		kfree_rcu(vpd_pg83, rcu);
494 	if (vpd_pg80)
495 		kfree_rcu(vpd_pg80, rcu);
496 	if (vpd_pg89)
497 		kfree_rcu(vpd_pg89, rcu);
498 	kfree(sdev->inquiry);
499 	kfree(sdev);
500 
501 	if (parent)
502 		put_device(parent);
503 	module_put(mod);
504 }
505 
scsi_device_dev_release(struct device * dev)506 static void scsi_device_dev_release(struct device *dev)
507 {
508 	struct scsi_device *sdp = to_scsi_device(dev);
509 
510 	/* Set module pointer as NULL in case of module unloading */
511 	if (!try_module_get(sdp->host->hostt->module))
512 		sdp->host->hostt->module = NULL;
513 
514 	execute_in_process_context(scsi_device_dev_release_usercontext,
515 				   &sdp->ew);
516 }
517 
518 static struct class sdev_class = {
519 	.name		= "scsi_device",
520 	.dev_release	= scsi_device_cls_release,
521 };
522 
523 /* all probing is done in the individual ->probe routines */
scsi_bus_match(struct device * dev,struct device_driver * gendrv)524 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
525 {
526 	struct scsi_device *sdp;
527 
528 	if (dev->type != &scsi_dev_type)
529 		return 0;
530 
531 	sdp = to_scsi_device(dev);
532 	if (sdp->no_uld_attach)
533 		return 0;
534 	return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
535 }
536 
scsi_bus_uevent(struct device * dev,struct kobj_uevent_env * env)537 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
538 {
539 	struct scsi_device *sdev;
540 
541 	if (dev->type != &scsi_dev_type)
542 		return 0;
543 
544 	sdev = to_scsi_device(dev);
545 
546 	add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
547 	return 0;
548 }
549 
550 struct bus_type scsi_bus_type = {
551         .name		= "scsi",
552         .match		= scsi_bus_match,
553 	.uevent		= scsi_bus_uevent,
554 #ifdef CONFIG_PM
555 	.pm		= &scsi_bus_pm_ops,
556 #endif
557 };
558 EXPORT_SYMBOL_GPL(scsi_bus_type);
559 
scsi_sysfs_register(void)560 int scsi_sysfs_register(void)
561 {
562 	int error;
563 
564 	error = bus_register(&scsi_bus_type);
565 	if (!error) {
566 		error = class_register(&sdev_class);
567 		if (error)
568 			bus_unregister(&scsi_bus_type);
569 	}
570 
571 	return error;
572 }
573 
scsi_sysfs_unregister(void)574 void scsi_sysfs_unregister(void)
575 {
576 	class_unregister(&sdev_class);
577 	bus_unregister(&scsi_bus_type);
578 }
579 
580 /*
581  * sdev_show_function: macro to create an attr function that can be used to
582  * show a non-bit field.
583  */
584 #define sdev_show_function(field, format_string)				\
585 static ssize_t								\
586 sdev_show_##field (struct device *dev, struct device_attribute *attr,	\
587 		   char *buf)						\
588 {									\
589 	struct scsi_device *sdev;					\
590 	sdev = to_scsi_device(dev);					\
591 	return snprintf (buf, 20, format_string, sdev->field);		\
592 }									\
593 
594 /*
595  * sdev_rd_attr: macro to create a function and attribute variable for a
596  * read only field.
597  */
598 #define sdev_rd_attr(field, format_string)				\
599 	sdev_show_function(field, format_string)			\
600 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
601 
602 
603 /*
604  * sdev_rw_attr: create a function and attribute variable for a
605  * read/write field.
606  */
607 #define sdev_rw_attr(field, format_string)				\
608 	sdev_show_function(field, format_string)				\
609 									\
610 static ssize_t								\
611 sdev_store_##field (struct device *dev, struct device_attribute *attr,	\
612 		    const char *buf, size_t count)			\
613 {									\
614 	struct scsi_device *sdev;					\
615 	sdev = to_scsi_device(dev);					\
616 	sscanf (buf, format_string, &sdev->field);			\
617 	return count;							\
618 }									\
619 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
620 
621 /* Currently we don't export bit fields, but we might in future,
622  * so leave this code in */
623 #if 0
624 /*
625  * sdev_rd_attr: create a function and attribute variable for a
626  * read/write bit field.
627  */
628 #define sdev_rw_attr_bit(field)						\
629 	sdev_show_function(field, "%d\n")					\
630 									\
631 static ssize_t								\
632 sdev_store_##field (struct device *dev, struct device_attribute *attr,	\
633 		    const char *buf, size_t count)			\
634 {									\
635 	int ret;							\
636 	struct scsi_device *sdev;					\
637 	ret = scsi_sdev_check_buf_bit(buf);				\
638 	if (ret >= 0)	{						\
639 		sdev = to_scsi_device(dev);				\
640 		sdev->field = ret;					\
641 		ret = count;						\
642 	}								\
643 	return ret;							\
644 }									\
645 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
646 
647 /*
648  * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
649  * else return -EINVAL.
650  */
651 static int scsi_sdev_check_buf_bit(const char *buf)
652 {
653 	if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
654 		if (buf[0] == '1')
655 			return 1;
656 		else if (buf[0] == '0')
657 			return 0;
658 		else
659 			return -EINVAL;
660 	} else
661 		return -EINVAL;
662 }
663 #endif
664 /*
665  * Create the actual show/store functions and data structures.
666  */
667 sdev_rd_attr (type, "%d\n");
668 sdev_rd_attr (scsi_level, "%d\n");
669 sdev_rd_attr (vendor, "%.8s\n");
670 sdev_rd_attr (model, "%.16s\n");
671 sdev_rd_attr (rev, "%.4s\n");
672 
673 static ssize_t
sdev_show_device_busy(struct device * dev,struct device_attribute * attr,char * buf)674 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
675 		char *buf)
676 {
677 	struct scsi_device *sdev = to_scsi_device(dev);
678 	return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
679 }
680 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
681 
682 static ssize_t
sdev_show_device_blocked(struct device * dev,struct device_attribute * attr,char * buf)683 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
684 		char *buf)
685 {
686 	struct scsi_device *sdev = to_scsi_device(dev);
687 	return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
688 }
689 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
690 
691 /*
692  * TODO: can we make these symlinks to the block layer ones?
693  */
694 static ssize_t
sdev_show_timeout(struct device * dev,struct device_attribute * attr,char * buf)695 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
696 {
697 	struct scsi_device *sdev;
698 	sdev = to_scsi_device(dev);
699 	return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
700 }
701 
702 static ssize_t
sdev_store_timeout(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)703 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
704 		    const char *buf, size_t count)
705 {
706 	struct scsi_device *sdev;
707 	int timeout;
708 	sdev = to_scsi_device(dev);
709 	sscanf (buf, "%d\n", &timeout);
710 	blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
711 	return count;
712 }
713 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
714 
715 static ssize_t
sdev_show_eh_timeout(struct device * dev,struct device_attribute * attr,char * buf)716 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
717 {
718 	struct scsi_device *sdev;
719 	sdev = to_scsi_device(dev);
720 	return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
721 }
722 
723 static ssize_t
sdev_store_eh_timeout(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)724 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
725 		    const char *buf, size_t count)
726 {
727 	struct scsi_device *sdev;
728 	unsigned int eh_timeout;
729 	int err;
730 
731 	if (!capable(CAP_SYS_ADMIN))
732 		return -EACCES;
733 
734 	sdev = to_scsi_device(dev);
735 	err = kstrtouint(buf, 10, &eh_timeout);
736 	if (err)
737 		return err;
738 	sdev->eh_timeout = eh_timeout * HZ;
739 
740 	return count;
741 }
742 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
743 
744 static ssize_t
store_rescan_field(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)745 store_rescan_field (struct device *dev, struct device_attribute *attr,
746 		    const char *buf, size_t count)
747 {
748 	scsi_rescan_device(dev);
749 	return count;
750 }
751 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
752 
753 static ssize_t
sdev_store_delete(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)754 sdev_store_delete(struct device *dev, struct device_attribute *attr,
755 		  const char *buf, size_t count)
756 {
757 	struct kernfs_node *kn;
758 	struct scsi_device *sdev = to_scsi_device(dev);
759 
760 	/*
761 	 * We need to try to get module, avoiding the module been removed
762 	 * during delete.
763 	 */
764 	if (scsi_device_get(sdev))
765 		return -ENODEV;
766 
767 	kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
768 	WARN_ON_ONCE(!kn);
769 	/*
770 	 * Concurrent writes into the "delete" sysfs attribute may trigger
771 	 * concurrent calls to device_remove_file() and scsi_remove_device().
772 	 * device_remove_file() handles concurrent removal calls by
773 	 * serializing these and by ignoring the second and later removal
774 	 * attempts.  Concurrent calls of scsi_remove_device() are
775 	 * serialized. The second and later calls of scsi_remove_device() are
776 	 * ignored because the first call of that function changes the device
777 	 * state into SDEV_DEL.
778 	 */
779 	device_remove_file(dev, attr);
780 	scsi_remove_device(sdev);
781 	if (kn)
782 		sysfs_unbreak_active_protection(kn);
783 	scsi_device_put(sdev);
784 	return count;
785 };
786 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
787 
788 static ssize_t
store_state_field(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)789 store_state_field(struct device *dev, struct device_attribute *attr,
790 		  const char *buf, size_t count)
791 {
792 	int i, ret;
793 	struct scsi_device *sdev = to_scsi_device(dev);
794 	enum scsi_device_state state = 0;
795 	bool rescan_dev = false;
796 
797 	for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
798 		const int len = strlen(sdev_states[i].name);
799 		if (strncmp(sdev_states[i].name, buf, len) == 0 &&
800 		   buf[len] == '\n') {
801 			state = sdev_states[i].value;
802 			break;
803 		}
804 	}
805 	switch (state) {
806 	case SDEV_RUNNING:
807 	case SDEV_OFFLINE:
808 		break;
809 	default:
810 		return -EINVAL;
811 	}
812 
813 	mutex_lock(&sdev->state_mutex);
814 	if (sdev->sdev_state == SDEV_RUNNING && state == SDEV_RUNNING) {
815 		ret = 0;
816 	} else {
817 		ret = scsi_device_set_state(sdev, state);
818 		if (ret == 0 && state == SDEV_RUNNING)
819 			rescan_dev = true;
820 	}
821 	mutex_unlock(&sdev->state_mutex);
822 
823 	if (rescan_dev) {
824 		/*
825 		 * If the device state changes to SDEV_RUNNING, we need to
826 		 * run the queue to avoid I/O hang, and rescan the device
827 		 * to revalidate it. Running the queue first is necessary
828 		 * because another thread may be waiting inside
829 		 * blk_mq_freeze_queue_wait() and because that call may be
830 		 * waiting for pending I/O to finish.
831 		 */
832 		blk_mq_run_hw_queues(sdev->request_queue, true);
833 		scsi_rescan_device(dev);
834 	}
835 
836 	return ret == 0 ? count : -EINVAL;
837 }
838 
839 static ssize_t
show_state_field(struct device * dev,struct device_attribute * attr,char * buf)840 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
841 {
842 	struct scsi_device *sdev = to_scsi_device(dev);
843 	const char *name = scsi_device_state_name(sdev->sdev_state);
844 
845 	if (!name)
846 		return -EINVAL;
847 
848 	return snprintf(buf, 20, "%s\n", name);
849 }
850 
851 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
852 
853 static ssize_t
show_queue_type_field(struct device * dev,struct device_attribute * attr,char * buf)854 show_queue_type_field(struct device *dev, struct device_attribute *attr,
855 		      char *buf)
856 {
857 	struct scsi_device *sdev = to_scsi_device(dev);
858 	const char *name = "none";
859 
860 	if (sdev->simple_tags)
861 		name = "simple";
862 
863 	return snprintf(buf, 20, "%s\n", name);
864 }
865 
866 static ssize_t
store_queue_type_field(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)867 store_queue_type_field(struct device *dev, struct device_attribute *attr,
868 		       const char *buf, size_t count)
869 {
870 	struct scsi_device *sdev = to_scsi_device(dev);
871 
872 	if (!sdev->tagged_supported)
873 		return -EINVAL;
874 
875 	sdev_printk(KERN_INFO, sdev,
876 		    "ignoring write to deprecated queue_type attribute");
877 	return count;
878 }
879 
880 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
881 		   store_queue_type_field);
882 
883 #define sdev_vpd_pg_attr(_page)						\
884 static ssize_t							\
885 show_vpd_##_page(struct file *filp, struct kobject *kobj,	\
886 		 struct bin_attribute *bin_attr,			\
887 		 char *buf, loff_t off, size_t count)			\
888 {									\
889 	struct device *dev = kobj_to_dev(kobj);				\
890 	struct scsi_device *sdev = to_scsi_device(dev);			\
891 	struct scsi_vpd *vpd_page;					\
892 	int ret = -EINVAL;						\
893 									\
894 	rcu_read_lock();						\
895 	vpd_page = rcu_dereference(sdev->vpd_##_page);			\
896 	if (vpd_page)							\
897 		ret = memory_read_from_buffer(buf, count, &off,		\
898 				vpd_page->data, vpd_page->len);		\
899 	rcu_read_unlock();						\
900 	return ret;							\
901 }									\
902 static struct bin_attribute dev_attr_vpd_##_page = {		\
903 	.attr =	{.name = __stringify(vpd_##_page), .mode = S_IRUGO },	\
904 	.size = 0,							\
905 	.read = show_vpd_##_page,					\
906 };
907 
908 sdev_vpd_pg_attr(pg83);
909 sdev_vpd_pg_attr(pg80);
910 sdev_vpd_pg_attr(pg89);
911 sdev_vpd_pg_attr(pg0);
912 
show_inquiry(struct file * filep,struct kobject * kobj,struct bin_attribute * bin_attr,char * buf,loff_t off,size_t count)913 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
914 			    struct bin_attribute *bin_attr,
915 			    char *buf, loff_t off, size_t count)
916 {
917 	struct device *dev = kobj_to_dev(kobj);
918 	struct scsi_device *sdev = to_scsi_device(dev);
919 
920 	if (!sdev->inquiry)
921 		return -EINVAL;
922 
923 	return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
924 				       sdev->inquiry_len);
925 }
926 
927 static struct bin_attribute dev_attr_inquiry = {
928 	.attr = {
929 		.name = "inquiry",
930 		.mode = S_IRUGO,
931 	},
932 	.size = 0,
933 	.read = show_inquiry,
934 };
935 
936 static ssize_t
show_iostat_counterbits(struct device * dev,struct device_attribute * attr,char * buf)937 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
938 			char *buf)
939 {
940 	return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
941 }
942 
943 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
944 
945 #define show_sdev_iostat(field)						\
946 static ssize_t								\
947 show_iostat_##field(struct device *dev, struct device_attribute *attr,	\
948 		    char *buf)						\
949 {									\
950 	struct scsi_device *sdev = to_scsi_device(dev);			\
951 	unsigned long long count = atomic_read(&sdev->field);		\
952 	return snprintf(buf, 20, "0x%llx\n", count);			\
953 }									\
954 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
955 
956 show_sdev_iostat(iorequest_cnt);
957 show_sdev_iostat(iodone_cnt);
958 show_sdev_iostat(ioerr_cnt);
959 
960 static ssize_t
sdev_show_modalias(struct device * dev,struct device_attribute * attr,char * buf)961 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
962 {
963 	struct scsi_device *sdev;
964 	sdev = to_scsi_device(dev);
965 	return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
966 }
967 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
968 
969 #define DECLARE_EVT_SHOW(name, Cap_name)				\
970 static ssize_t								\
971 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr,	\
972 		     char *buf)						\
973 {									\
974 	struct scsi_device *sdev = to_scsi_device(dev);			\
975 	int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
976 	return snprintf(buf, 20, "%d\n", val);				\
977 }
978 
979 #define DECLARE_EVT_STORE(name, Cap_name)				\
980 static ssize_t								\
981 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
982 		      const char *buf, size_t count)			\
983 {									\
984 	struct scsi_device *sdev = to_scsi_device(dev);			\
985 	int val = simple_strtoul(buf, NULL, 0);				\
986 	if (val == 0)							\
987 		clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events);	\
988 	else if (val == 1)						\
989 		set_bit(SDEV_EVT_##Cap_name, sdev->supported_events);	\
990 	else								\
991 		return -EINVAL;						\
992 	return count;							\
993 }
994 
995 #define DECLARE_EVT(name, Cap_name)					\
996 	DECLARE_EVT_SHOW(name, Cap_name)				\
997 	DECLARE_EVT_STORE(name, Cap_name)				\
998 	static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name,	\
999 			   sdev_store_evt_##name);
1000 #define REF_EVT(name) &dev_attr_evt_##name.attr
1001 
DECLARE_EVT(media_change,MEDIA_CHANGE)1002 DECLARE_EVT(media_change, MEDIA_CHANGE)
1003 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1004 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1005 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1006 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1007 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
1008 
1009 static ssize_t
1010 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1011 		       const char *buf, size_t count)
1012 {
1013 	int depth, retval;
1014 	struct scsi_device *sdev = to_scsi_device(dev);
1015 	struct scsi_host_template *sht = sdev->host->hostt;
1016 
1017 	if (!sht->change_queue_depth)
1018 		return -EINVAL;
1019 
1020 	depth = simple_strtoul(buf, NULL, 0);
1021 
1022 	if (depth < 1 || depth > sdev->host->can_queue)
1023 		return -EINVAL;
1024 
1025 	retval = sht->change_queue_depth(sdev, depth);
1026 	if (retval < 0)
1027 		return retval;
1028 
1029 	sdev->max_queue_depth = sdev->queue_depth;
1030 
1031 	return count;
1032 }
1033 sdev_show_function(queue_depth, "%d\n");
1034 
1035 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1036 		   sdev_store_queue_depth);
1037 
1038 static ssize_t
sdev_show_wwid(struct device * dev,struct device_attribute * attr,char * buf)1039 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1040 		    char *buf)
1041 {
1042 	struct scsi_device *sdev = to_scsi_device(dev);
1043 	ssize_t count;
1044 
1045 	count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1046 	if (count > 0) {
1047 		buf[count] = '\n';
1048 		count++;
1049 	}
1050 	return count;
1051 }
1052 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1053 
1054 #define BLIST_FLAG_NAME(name)					\
1055 	[const_ilog2((__force __u64)BLIST_##name)] = #name
1056 static const char *const sdev_bflags_name[] = {
1057 #include "scsi_devinfo_tbl.c"
1058 };
1059 #undef BLIST_FLAG_NAME
1060 
1061 static ssize_t
sdev_show_blacklist(struct device * dev,struct device_attribute * attr,char * buf)1062 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1063 		    char *buf)
1064 {
1065 	struct scsi_device *sdev = to_scsi_device(dev);
1066 	int i;
1067 	ssize_t len = 0;
1068 
1069 	for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1070 		const char *name = NULL;
1071 
1072 		if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1073 			continue;
1074 		if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1075 			name = sdev_bflags_name[i];
1076 
1077 		if (name)
1078 			len += scnprintf(buf + len, PAGE_SIZE - len,
1079 					 "%s%s", len ? " " : "", name);
1080 		else
1081 			len += scnprintf(buf + len, PAGE_SIZE - len,
1082 					 "%sINVALID_BIT(%d)", len ? " " : "", i);
1083 	}
1084 	if (len)
1085 		len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
1086 	return len;
1087 }
1088 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1089 
1090 #ifdef CONFIG_SCSI_DH
1091 static ssize_t
sdev_show_dh_state(struct device * dev,struct device_attribute * attr,char * buf)1092 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1093 		   char *buf)
1094 {
1095 	struct scsi_device *sdev = to_scsi_device(dev);
1096 
1097 	if (!sdev->handler)
1098 		return snprintf(buf, 20, "detached\n");
1099 
1100 	return snprintf(buf, 20, "%s\n", sdev->handler->name);
1101 }
1102 
1103 static ssize_t
sdev_store_dh_state(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)1104 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1105 		    const char *buf, size_t count)
1106 {
1107 	struct scsi_device *sdev = to_scsi_device(dev);
1108 	int err = -EINVAL;
1109 
1110 	if (sdev->sdev_state == SDEV_CANCEL ||
1111 	    sdev->sdev_state == SDEV_DEL)
1112 		return -ENODEV;
1113 
1114 	if (!sdev->handler) {
1115 		/*
1116 		 * Attach to a device handler
1117 		 */
1118 		err = scsi_dh_attach(sdev->request_queue, buf);
1119 	} else if (!strncmp(buf, "activate", 8)) {
1120 		/*
1121 		 * Activate a device handler
1122 		 */
1123 		if (sdev->handler->activate)
1124 			err = sdev->handler->activate(sdev, NULL, NULL);
1125 		else
1126 			err = 0;
1127 	} else if (!strncmp(buf, "detach", 6)) {
1128 		/*
1129 		 * Detach from a device handler
1130 		 */
1131 		sdev_printk(KERN_WARNING, sdev,
1132 			    "can't detach handler %s.\n",
1133 			    sdev->handler->name);
1134 		err = -EINVAL;
1135 	}
1136 
1137 	return err < 0 ? err : count;
1138 }
1139 
1140 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1141 		   sdev_store_dh_state);
1142 
1143 static ssize_t
sdev_show_access_state(struct device * dev,struct device_attribute * attr,char * buf)1144 sdev_show_access_state(struct device *dev,
1145 		       struct device_attribute *attr,
1146 		       char *buf)
1147 {
1148 	struct scsi_device *sdev = to_scsi_device(dev);
1149 	unsigned char access_state;
1150 	const char *access_state_name;
1151 
1152 	if (!sdev->handler)
1153 		return -EINVAL;
1154 
1155 	access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1156 	access_state_name = scsi_access_state_name(access_state);
1157 
1158 	return sprintf(buf, "%s\n",
1159 		       access_state_name ? access_state_name : "unknown");
1160 }
1161 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1162 
1163 static ssize_t
sdev_show_preferred_path(struct device * dev,struct device_attribute * attr,char * buf)1164 sdev_show_preferred_path(struct device *dev,
1165 			 struct device_attribute *attr,
1166 			 char *buf)
1167 {
1168 	struct scsi_device *sdev = to_scsi_device(dev);
1169 
1170 	if (!sdev->handler)
1171 		return -EINVAL;
1172 
1173 	if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1174 		return sprintf(buf, "1\n");
1175 	else
1176 		return sprintf(buf, "0\n");
1177 }
1178 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1179 #endif
1180 
1181 static ssize_t
sdev_show_queue_ramp_up_period(struct device * dev,struct device_attribute * attr,char * buf)1182 sdev_show_queue_ramp_up_period(struct device *dev,
1183 			       struct device_attribute *attr,
1184 			       char *buf)
1185 {
1186 	struct scsi_device *sdev;
1187 	sdev = to_scsi_device(dev);
1188 	return snprintf(buf, 20, "%u\n",
1189 			jiffies_to_msecs(sdev->queue_ramp_up_period));
1190 }
1191 
1192 static ssize_t
sdev_store_queue_ramp_up_period(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)1193 sdev_store_queue_ramp_up_period(struct device *dev,
1194 				struct device_attribute *attr,
1195 				const char *buf, size_t count)
1196 {
1197 	struct scsi_device *sdev = to_scsi_device(dev);
1198 	unsigned int period;
1199 
1200 	if (kstrtouint(buf, 10, &period))
1201 		return -EINVAL;
1202 
1203 	sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1204 	return count;
1205 }
1206 
1207 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1208 		   sdev_show_queue_ramp_up_period,
1209 		   sdev_store_queue_ramp_up_period);
1210 
scsi_sdev_attr_is_visible(struct kobject * kobj,struct attribute * attr,int i)1211 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1212 					 struct attribute *attr, int i)
1213 {
1214 	struct device *dev = kobj_to_dev(kobj);
1215 	struct scsi_device *sdev = to_scsi_device(dev);
1216 
1217 
1218 	if (attr == &dev_attr_queue_depth.attr &&
1219 	    !sdev->host->hostt->change_queue_depth)
1220 		return S_IRUGO;
1221 
1222 	if (attr == &dev_attr_queue_ramp_up_period.attr &&
1223 	    !sdev->host->hostt->change_queue_depth)
1224 		return 0;
1225 
1226 #ifdef CONFIG_SCSI_DH
1227 	if (attr == &dev_attr_access_state.attr &&
1228 	    !sdev->handler)
1229 		return 0;
1230 	if (attr == &dev_attr_preferred_path.attr &&
1231 	    !sdev->handler)
1232 		return 0;
1233 #endif
1234 	return attr->mode;
1235 }
1236 
scsi_sdev_bin_attr_is_visible(struct kobject * kobj,struct bin_attribute * attr,int i)1237 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1238 					     struct bin_attribute *attr, int i)
1239 {
1240 	struct device *dev = kobj_to_dev(kobj);
1241 	struct scsi_device *sdev = to_scsi_device(dev);
1242 
1243 
1244 	if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1245 		return 0;
1246 
1247 	if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1248 		return 0;
1249 
1250 	if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1251 		return 0;
1252 
1253 	if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1254 		return 0;
1255 
1256 	return S_IRUGO;
1257 }
1258 
1259 /* Default template for device attributes.  May NOT be modified */
1260 static struct attribute *scsi_sdev_attrs[] = {
1261 	&dev_attr_device_blocked.attr,
1262 	&dev_attr_type.attr,
1263 	&dev_attr_scsi_level.attr,
1264 	&dev_attr_device_busy.attr,
1265 	&dev_attr_vendor.attr,
1266 	&dev_attr_model.attr,
1267 	&dev_attr_rev.attr,
1268 	&dev_attr_rescan.attr,
1269 	&dev_attr_delete.attr,
1270 	&dev_attr_state.attr,
1271 	&dev_attr_timeout.attr,
1272 	&dev_attr_eh_timeout.attr,
1273 	&dev_attr_iocounterbits.attr,
1274 	&dev_attr_iorequest_cnt.attr,
1275 	&dev_attr_iodone_cnt.attr,
1276 	&dev_attr_ioerr_cnt.attr,
1277 	&dev_attr_modalias.attr,
1278 	&dev_attr_queue_depth.attr,
1279 	&dev_attr_queue_type.attr,
1280 	&dev_attr_wwid.attr,
1281 	&dev_attr_blacklist.attr,
1282 #ifdef CONFIG_SCSI_DH
1283 	&dev_attr_dh_state.attr,
1284 	&dev_attr_access_state.attr,
1285 	&dev_attr_preferred_path.attr,
1286 #endif
1287 	&dev_attr_queue_ramp_up_period.attr,
1288 	REF_EVT(media_change),
1289 	REF_EVT(inquiry_change_reported),
1290 	REF_EVT(capacity_change_reported),
1291 	REF_EVT(soft_threshold_reached),
1292 	REF_EVT(mode_parameter_change_reported),
1293 	REF_EVT(lun_change_reported),
1294 	NULL
1295 };
1296 
1297 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1298 	&dev_attr_vpd_pg0,
1299 	&dev_attr_vpd_pg83,
1300 	&dev_attr_vpd_pg80,
1301 	&dev_attr_vpd_pg89,
1302 	&dev_attr_inquiry,
1303 	NULL
1304 };
1305 static struct attribute_group scsi_sdev_attr_group = {
1306 	.attrs =	scsi_sdev_attrs,
1307 	.bin_attrs =	scsi_sdev_bin_attrs,
1308 	.is_visible =	scsi_sdev_attr_is_visible,
1309 	.is_bin_visible = scsi_sdev_bin_attr_is_visible,
1310 };
1311 
1312 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1313 	&scsi_sdev_attr_group,
1314 	NULL
1315 };
1316 
scsi_target_add(struct scsi_target * starget)1317 static int scsi_target_add(struct scsi_target *starget)
1318 {
1319 	int error;
1320 
1321 	if (starget->state != STARGET_CREATED)
1322 		return 0;
1323 
1324 	error = device_add(&starget->dev);
1325 	if (error) {
1326 		dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1327 		return error;
1328 	}
1329 	transport_add_device(&starget->dev);
1330 	starget->state = STARGET_RUNNING;
1331 
1332 	pm_runtime_set_active(&starget->dev);
1333 	pm_runtime_enable(&starget->dev);
1334 	device_enable_async_suspend(&starget->dev);
1335 
1336 	return 0;
1337 }
1338 
1339 /**
1340  * scsi_sysfs_add_sdev - add scsi device to sysfs
1341  * @sdev:	scsi_device to add
1342  *
1343  * Return value:
1344  * 	0 on Success / non-zero on Failure
1345  **/
scsi_sysfs_add_sdev(struct scsi_device * sdev)1346 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1347 {
1348 	int error;
1349 	struct scsi_target *starget = sdev->sdev_target;
1350 
1351 	error = scsi_target_add(starget);
1352 	if (error)
1353 		return error;
1354 
1355 	transport_configure_device(&starget->dev);
1356 
1357 	device_enable_async_suspend(&sdev->sdev_gendev);
1358 	scsi_autopm_get_target(starget);
1359 	pm_runtime_set_active(&sdev->sdev_gendev);
1360 	if (!sdev->rpm_autosuspend)
1361 		pm_runtime_forbid(&sdev->sdev_gendev);
1362 	pm_runtime_enable(&sdev->sdev_gendev);
1363 	scsi_autopm_put_target(starget);
1364 
1365 	scsi_autopm_get_device(sdev);
1366 
1367 	scsi_dh_add_device(sdev);
1368 
1369 	error = device_add(&sdev->sdev_gendev);
1370 	if (error) {
1371 		sdev_printk(KERN_INFO, sdev,
1372 				"failed to add device: %d\n", error);
1373 		return error;
1374 	}
1375 
1376 	device_enable_async_suspend(&sdev->sdev_dev);
1377 	error = device_add(&sdev->sdev_dev);
1378 	if (error) {
1379 		sdev_printk(KERN_INFO, sdev,
1380 				"failed to add class device: %d\n", error);
1381 		device_del(&sdev->sdev_gendev);
1382 		return error;
1383 	}
1384 	transport_add_device(&sdev->sdev_gendev);
1385 	sdev->is_visible = 1;
1386 
1387 	if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1388 		sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1389 		if (IS_ERR(sdev->bsg_dev)) {
1390 			/*
1391 			 * We're treating error on bsg register as non-fatal, so
1392 			 * pretend nothing went wrong.
1393 			 */
1394 			error = PTR_ERR(sdev->bsg_dev);
1395 			sdev_printk(KERN_INFO, sdev,
1396 				    "Failed to register bsg queue, errno=%d\n",
1397 				    error);
1398 			sdev->bsg_dev = NULL;
1399 		}
1400 	}
1401 
1402 	scsi_autopm_put_device(sdev);
1403 	return error;
1404 }
1405 
__scsi_remove_device(struct scsi_device * sdev)1406 void __scsi_remove_device(struct scsi_device *sdev)
1407 {
1408 	struct device *dev = &sdev->sdev_gendev;
1409 	int res;
1410 
1411 	/*
1412 	 * This cleanup path is not reentrant and while it is impossible
1413 	 * to get a new reference with scsi_device_get() someone can still
1414 	 * hold a previously acquired one.
1415 	 */
1416 	if (sdev->sdev_state == SDEV_DEL)
1417 		return;
1418 
1419 	if (sdev->is_visible) {
1420 		/*
1421 		 * If scsi_internal_target_block() is running concurrently,
1422 		 * wait until it has finished before changing the device state.
1423 		 */
1424 		mutex_lock(&sdev->state_mutex);
1425 		/*
1426 		 * If blocked, we go straight to DEL and restart the queue so
1427 		 * any commands issued during driver shutdown (like sync
1428 		 * cache) are errored immediately.
1429 		 */
1430 		res = scsi_device_set_state(sdev, SDEV_CANCEL);
1431 		if (res != 0) {
1432 			res = scsi_device_set_state(sdev, SDEV_DEL);
1433 			if (res == 0)
1434 				scsi_start_queue(sdev);
1435 		}
1436 		mutex_unlock(&sdev->state_mutex);
1437 
1438 		if (res != 0)
1439 			return;
1440 
1441 		if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1442 			bsg_unregister_queue(sdev->bsg_dev);
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  **/
scsi_remove_device(struct scsi_device * sdev)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 
__scsi_remove_target(struct scsi_target * starget)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  */
scsi_remove_target(struct device * dev)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 
scsi_register_driver(struct device_driver * drv)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 
scsi_register_interface(struct class_interface * intf)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  **/
scsi_sysfs_add_host(struct Scsi_Host * shost)1577 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1578 {
1579 	transport_register_device(&shost->shost_gendev);
1580 	transport_configure_device(&shost->shost_gendev);
1581 	return 0;
1582 }
1583 
1584 static struct device_type scsi_dev_type = {
1585 	.name =		"scsi_device",
1586 	.release =	scsi_device_dev_release,
1587 	.groups =	scsi_sdev_attr_groups,
1588 };
1589 
scsi_sysfs_device_initialize(struct scsi_device * sdev)1590 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1591 {
1592 	unsigned long flags;
1593 	struct Scsi_Host *shost = sdev->host;
1594 	struct scsi_host_template *hostt = shost->hostt;
1595 	struct scsi_target  *starget = sdev->sdev_target;
1596 
1597 	device_initialize(&sdev->sdev_gendev);
1598 	sdev->sdev_gendev.bus = &scsi_bus_type;
1599 	sdev->sdev_gendev.type = &scsi_dev_type;
1600 	scsi_enable_async_suspend(&sdev->sdev_gendev);
1601 	dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1602 		     sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1603 	sdev->sdev_gendev.groups = hostt->sdev_groups;
1604 
1605 	device_initialize(&sdev->sdev_dev);
1606 	sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1607 	sdev->sdev_dev.class = &sdev_class;
1608 	dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1609 		     sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1610 	/*
1611 	 * Get a default scsi_level from the target (derived from sibling
1612 	 * devices).  This is the best we can do for guessing how to set
1613 	 * sdev->lun_in_cdb for the initial INQUIRY command.  For LUN 0 the
1614 	 * setting doesn't matter, because all the bits are zero anyway.
1615 	 * But it does matter for higher LUNs.
1616 	 */
1617 	sdev->scsi_level = starget->scsi_level;
1618 	if (sdev->scsi_level <= SCSI_2 &&
1619 			sdev->scsi_level != SCSI_UNKNOWN &&
1620 			!shost->no_scsi2_lun_in_cdb)
1621 		sdev->lun_in_cdb = 1;
1622 
1623 	transport_setup_device(&sdev->sdev_gendev);
1624 	spin_lock_irqsave(shost->host_lock, flags);
1625 	list_add_tail(&sdev->same_target_siblings, &starget->devices);
1626 	list_add_tail(&sdev->siblings, &shost->__devices);
1627 	spin_unlock_irqrestore(shost->host_lock, flags);
1628 	/*
1629 	 * device can now only be removed via __scsi_remove_device() so hold
1630 	 * the target.  Target will be held in CREATED state until something
1631 	 * beneath it becomes visible (in which case it moves to RUNNING)
1632 	 */
1633 	kref_get(&starget->reap_ref);
1634 }
1635 
scsi_is_sdev_device(const struct device * dev)1636 int scsi_is_sdev_device(const struct device *dev)
1637 {
1638 	return dev->type == &scsi_dev_type;
1639 }
1640 EXPORT_SYMBOL(scsi_is_sdev_device);
1641 
1642 /* A blank transport template that is used in drivers that don't
1643  * yet implement Transport Attributes */
1644 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };
1645