blob: 79df9847edefa6537430aa1ab8e12001e48cdccb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * scsi_sysfs.c
3 *
4 * SCSI sysfs interface routines.
5 *
6 * Created to pull SCSI mid layer sysfs routines into one file.
7 */
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090010#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/init.h>
12#include <linux/blkdev.h>
13#include <linux/device.h>
Alan Sternbc4f2402010-06-17 10:41:42 -040014#include <linux/pm_runtime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
16#include <scsi/scsi.h>
17#include <scsi/scsi_device.h>
18#include <scsi/scsi_host.h>
19#include <scsi/scsi_tcq.h>
20#include <scsi/scsi_transport.h>
Adrian Bunk44818ef2007-07-09 11:59:59 -070021#include <scsi/scsi_driver.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23#include "scsi_priv.h"
24#include "scsi_logging.h"
25
Hannes Reineckeb0ed4332008-03-18 14:32:28 +010026static struct device_type scsi_dev_type;
27
Arjan van de Ven0ad78202005-11-28 16:22:25 +010028static const struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 enum scsi_device_state value;
30 char *name;
31} sdev_states[] = {
32 { SDEV_CREATED, "created" },
33 { SDEV_RUNNING, "running" },
34 { SDEV_CANCEL, "cancel" },
35 { SDEV_DEL, "deleted" },
36 { SDEV_QUIESCE, "quiesce" },
37 { SDEV_OFFLINE, "offline" },
Mike Christie1b8d2622012-05-17 23:56:56 -050038 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 { SDEV_BLOCK, "blocked" },
James Bottomley6f4267e2008-08-22 16:53:31 -050040 { SDEV_CREATED_BLOCK, "created-blocked" },
Linus Torvalds1da177e2005-04-16 15:20:36 -070041};
42
43const char *scsi_device_state_name(enum scsi_device_state state)
44{
45 int i;
46 char *name = NULL;
47
Tobias Klauser6391a112006-06-08 22:23:48 -070048 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 if (sdev_states[i].value == state) {
50 name = sdev_states[i].name;
51 break;
52 }
53 }
54 return name;
55}
56
Arjan van de Ven0ad78202005-11-28 16:22:25 +010057static const struct {
Mike Andersond3301872005-06-16 11:12:38 -070058 enum scsi_host_state value;
59 char *name;
60} shost_states[] = {
61 { SHOST_CREATED, "created" },
62 { SHOST_RUNNING, "running" },
63 { SHOST_CANCEL, "cancel" },
64 { SHOST_DEL, "deleted" },
65 { SHOST_RECOVERY, "recovery" },
James Bottomley939647e2005-09-18 15:05:20 -050066 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
67 { SHOST_DEL_RECOVERY, "deleted/recovery", },
Mike Andersond3301872005-06-16 11:12:38 -070068};
69const char *scsi_host_state_name(enum scsi_host_state state)
70{
71 int i;
72 char *name = NULL;
73
Tobias Klauser6391a112006-06-08 22:23:48 -070074 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
Mike Andersond3301872005-06-16 11:12:38 -070075 if (shost_states[i].value == state) {
76 name = shost_states[i].name;
77 break;
78 }
79 }
80 return name;
81}
82
Hannes Reinecke9cb78c12014-06-25 15:27:36 +020083static int check_set(unsigned long long *val, char *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
85 char *last;
86
87 if (strncmp(src, "-", 20) == 0) {
88 *val = SCAN_WILD_CARD;
89 } else {
90 /*
91 * Doesn't check for int overflow
92 */
Hannes Reinecke9cb78c12014-06-25 15:27:36 +020093 *val = simple_strtoull(src, &last, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 if (*last != '\0')
95 return 1;
96 }
97 return 0;
98}
99
100static int scsi_scan(struct Scsi_Host *shost, const char *str)
101{
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200102 char s1[15], s2[15], s3[17], junk;
103 unsigned long long channel, id, lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 int res;
105
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200106 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 if (res != 3)
108 return -EINVAL;
109 if (check_set(&channel, s1))
110 return -EINVAL;
111 if (check_set(&id, s2))
112 return -EINVAL;
113 if (check_set(&lun, s3))
114 return -EINVAL;
Christoph Hellwige02f3f52006-01-13 19:04:00 +0100115 if (shost->transportt->user_scan)
116 res = shost->transportt->user_scan(shost, channel, id, lun);
117 else
118 res = scsi_scan_host_selected(shost, channel, id, lun, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 return res;
120}
121
122/*
123 * shost_show_function: macro to create an attr function that can be used to
124 * show a non-bit field.
125 */
126#define shost_show_function(name, field, format_string) \
127static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100128show_##name (struct device *dev, struct device_attribute *attr, \
129 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100131 struct Scsi_Host *shost = class_to_shost(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 return snprintf (buf, 20, format_string, shost->field); \
133}
134
135/*
136 * shost_rd_attr: macro to create a function and attribute variable for a
137 * read only field.
138 */
139#define shost_rd_attr2(name, field, format_string) \
140 shost_show_function(name, field, format_string) \
Tony Jonesee959b02008-02-22 00:13:36 +0100141static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143#define shost_rd_attr(field, format_string) \
144shost_rd_attr2(field, field, format_string)
145
146/*
147 * Create the actual show/store functions and data structures.
148 */
149
Tony Jonesee959b02008-02-22 00:13:36 +0100150static ssize_t
151store_scan(struct device *dev, struct device_attribute *attr,
152 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153{
Tony Jonesee959b02008-02-22 00:13:36 +0100154 struct Scsi_Host *shost = class_to_shost(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 int res;
156
157 res = scsi_scan(shost, buf);
158 if (res == 0)
159 res = count;
160 return res;
161};
Tony Jonesee959b02008-02-22 00:13:36 +0100162static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Mike Andersond3301872005-06-16 11:12:38 -0700164static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100165store_shost_state(struct device *dev, struct device_attribute *attr,
166 const char *buf, size_t count)
Mike Andersond3301872005-06-16 11:12:38 -0700167{
168 int i;
Tony Jonesee959b02008-02-22 00:13:36 +0100169 struct Scsi_Host *shost = class_to_shost(dev);
Mike Andersond3301872005-06-16 11:12:38 -0700170 enum scsi_host_state state = 0;
171
Tobias Klauser6391a112006-06-08 22:23:48 -0700172 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
Mike Andersond3301872005-06-16 11:12:38 -0700173 const int len = strlen(shost_states[i].name);
174 if (strncmp(shost_states[i].name, buf, len) == 0 &&
175 buf[len] == '\n') {
176 state = shost_states[i].value;
177 break;
178 }
179 }
180 if (!state)
181 return -EINVAL;
182
183 if (scsi_host_set_state(shost, state))
184 return -EINVAL;
185 return count;
186}
187
188static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100189show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
Mike Andersond3301872005-06-16 11:12:38 -0700190{
Tony Jonesee959b02008-02-22 00:13:36 +0100191 struct Scsi_Host *shost = class_to_shost(dev);
Mike Andersond3301872005-06-16 11:12:38 -0700192 const char *name = scsi_host_state_name(shost->shost_state);
193
194 if (!name)
195 return -EINVAL;
196
197 return snprintf(buf, 20, "%s\n", name);
198}
199
Tony Jonesee959b02008-02-22 00:13:36 +0100200/* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
201struct device_attribute dev_attr_hstate =
202 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
Mike Andersond3301872005-06-16 11:12:38 -0700203
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900204static ssize_t
205show_shost_mode(unsigned int mode, char *buf)
206{
207 ssize_t len = 0;
208
209 if (mode & MODE_INITIATOR)
210 len = sprintf(buf, "%s", "Initiator");
211
212 if (mode & MODE_TARGET)
213 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
214
215 len += sprintf(buf + len, "\n");
216
217 return len;
218}
219
Tony Jonesee959b02008-02-22 00:13:36 +0100220static ssize_t
221show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
222 char *buf)
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900223{
Tony Jonesee959b02008-02-22 00:13:36 +0100224 struct Scsi_Host *shost = class_to_shost(dev);
James Bottomley7a39ac32007-09-25 22:45:53 -0500225 unsigned int supported_mode = shost->hostt->supported_mode;
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900226
James Bottomley7a39ac32007-09-25 22:45:53 -0500227 if (supported_mode == MODE_UNKNOWN)
228 /* by default this should be initiator */
229 supported_mode = MODE_INITIATOR;
230
231 return show_shost_mode(supported_mode, buf);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900232}
233
Tony Jonesee959b02008-02-22 00:13:36 +0100234static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900235
Tony Jonesee959b02008-02-22 00:13:36 +0100236static ssize_t
237show_shost_active_mode(struct device *dev,
238 struct device_attribute *attr, char *buf)
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900239{
Tony Jonesee959b02008-02-22 00:13:36 +0100240 struct Scsi_Host *shost = class_to_shost(dev);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900241
242 if (shost->active_mode == MODE_UNKNOWN)
243 return snprintf(buf, 20, "unknown\n");
244 else
245 return show_shost_mode(shost->active_mode, buf);
246}
247
Tony Jonesee959b02008-02-22 00:13:36 +0100248static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900249
Sasha Levin072f19b2012-11-15 15:51:46 -0500250static int check_reset_type(const char *str)
Vikas Chaudhary29443692011-08-12 02:51:28 -0700251{
Sasha Levin072f19b2012-11-15 15:51:46 -0500252 if (sysfs_streq(str, "adapter"))
Vikas Chaudhary29443692011-08-12 02:51:28 -0700253 return SCSI_ADAPTER_RESET;
Sasha Levin072f19b2012-11-15 15:51:46 -0500254 else if (sysfs_streq(str, "firmware"))
Vikas Chaudhary29443692011-08-12 02:51:28 -0700255 return SCSI_FIRMWARE_RESET;
256 else
257 return 0;
258}
259
260static ssize_t
261store_host_reset(struct device *dev, struct device_attribute *attr,
262 const char *buf, size_t count)
263{
264 struct Scsi_Host *shost = class_to_shost(dev);
265 struct scsi_host_template *sht = shost->hostt;
266 int ret = -EINVAL;
Vikas Chaudhary29443692011-08-12 02:51:28 -0700267 int type;
268
Sasha Levin072f19b2012-11-15 15:51:46 -0500269 type = check_reset_type(buf);
Vikas Chaudhary29443692011-08-12 02:51:28 -0700270 if (!type)
271 goto exit_store_host_reset;
272
273 if (sht->host_reset)
274 ret = sht->host_reset(shost, type);
275
276exit_store_host_reset:
277 if (ret == 0)
278 ret = count;
279 return ret;
280}
281
282static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
283
Hannes Reineckeb4562022013-10-23 10:51:21 +0200284static ssize_t
285show_shost_eh_deadline(struct device *dev,
286 struct device_attribute *attr, char *buf)
287{
288 struct Scsi_Host *shost = class_to_shost(dev);
289
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100290 if (shost->eh_deadline == -1)
291 return snprintf(buf, strlen("off") + 2, "off\n");
292 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
Hannes Reineckeb4562022013-10-23 10:51:21 +0200293}
294
295static ssize_t
296store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
297 const char *buf, size_t count)
298{
299 struct Scsi_Host *shost = class_to_shost(dev);
300 int ret = -EINVAL;
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100301 unsigned long deadline, flags;
Hannes Reineckeb4562022013-10-23 10:51:21 +0200302
Hannes Reineckead469a52014-01-17 16:05:38 +0100303 if (shost->transportt &&
304 (shost->transportt->eh_strategy_handler ||
305 !shost->hostt->eh_host_reset_handler))
Hannes Reineckeb4562022013-10-23 10:51:21 +0200306 return ret;
307
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100308 if (!strncmp(buf, "off", strlen("off")))
309 deadline = -1;
310 else {
311 ret = kstrtoul(buf, 10, &deadline);
312 if (ret)
313 return ret;
314 if (deadline * HZ > UINT_MAX)
315 return -EINVAL;
Hannes Reineckeb4562022013-10-23 10:51:21 +0200316 }
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100317
318 spin_lock_irqsave(shost->host_lock, flags);
319 if (scsi_host_in_recovery(shost))
320 ret = -EBUSY;
321 else {
322 if (deadline == -1)
323 shost->eh_deadline = -1;
324 else
325 shost->eh_deadline = deadline * HZ;
326
327 ret = count;
328 }
329 spin_unlock_irqrestore(shost->host_lock, flags);
330
Hannes Reineckeb4562022013-10-23 10:51:21 +0200331 return ret;
332}
333
334static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336shost_rd_attr(unique_id, "%u\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337shost_rd_attr(cmd_per_lun, "%hd\n");
James Bottomleyed632da2006-10-16 10:06:27 -0500338shost_rd_attr(can_queue, "%hd\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339shost_rd_attr(sg_tablesize, "%hu\n");
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200340shost_rd_attr(sg_prot_tablesize, "%hu\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341shost_rd_attr(unchecked_isa_dma, "%d\n");
Martin K. Petersen4469f982008-07-17 04:28:30 -0400342shost_rd_attr(prot_capabilities, "%u\n");
343shost_rd_attr(prot_guard_type, "%hd\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
345
Christoph Hellwig74665012014-01-22 15:29:29 +0100346static ssize_t
347show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
348{
349 struct Scsi_Host *shost = class_to_shost(dev);
350 return snprintf(buf, 20, "%d\n", atomic_read(&shost->host_busy));
351}
352static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
353
Hannes Reineckef7120a42008-03-18 14:32:28 +0100354static struct attribute *scsi_sysfs_shost_attrs[] = {
355 &dev_attr_unique_id.attr,
356 &dev_attr_host_busy.attr,
357 &dev_attr_cmd_per_lun.attr,
358 &dev_attr_can_queue.attr,
359 &dev_attr_sg_tablesize.attr,
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200360 &dev_attr_sg_prot_tablesize.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100361 &dev_attr_unchecked_isa_dma.attr,
362 &dev_attr_proc_name.attr,
363 &dev_attr_scan.attr,
364 &dev_attr_hstate.attr,
365 &dev_attr_supported_mode.attr,
366 &dev_attr_active_mode.attr,
Martin K. Petersen4469f982008-07-17 04:28:30 -0400367 &dev_attr_prot_capabilities.attr,
368 &dev_attr_prot_guard_type.attr,
Vikas Chaudhary29443692011-08-12 02:51:28 -0700369 &dev_attr_host_reset.attr,
Hannes Reineckeb4562022013-10-23 10:51:21 +0200370 &dev_attr_eh_deadline.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100371 NULL
372};
373
374struct attribute_group scsi_shost_attr_group = {
375 .attrs = scsi_sysfs_shost_attrs,
376};
377
David Brownella4dbd672009-06-24 10:06:31 -0700378const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
Hannes Reineckef7120a42008-03-18 14:32:28 +0100379 &scsi_shost_attr_group,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 NULL
381};
382
Tony Jonesee959b02008-02-22 00:13:36 +0100383static void scsi_device_cls_release(struct device *class_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
385 struct scsi_device *sdev;
386
387 sdev = class_to_sdev(class_dev);
388 put_device(&sdev->sdev_gendev);
389}
390
David Howells65f27f32006-11-22 14:55:48 +0000391static void scsi_device_dev_release_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392{
393 struct scsi_device *sdev;
394 struct device *parent;
Jeff Garzika341cd02007-10-29 17:15:22 -0400395 struct list_head *this, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 unsigned long flags;
397
David Howells65f27f32006-11-22 14:55:48 +0000398 sdev = container_of(work, struct scsi_device, ew.work);
399
400 parent = sdev->sdev_gendev.parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402 spin_lock_irqsave(sdev->host->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 list_del(&sdev->siblings);
404 list_del(&sdev->same_target_siblings);
405 list_del(&sdev->starved_entry);
406 spin_unlock_irqrestore(sdev->host->host_lock, flags);
407
Jeff Garzika341cd02007-10-29 17:15:22 -0400408 cancel_work_sync(&sdev->event_work);
409
410 list_for_each_safe(this, tmp, &sdev->event_list) {
411 struct scsi_event *evt;
412
413 evt = list_entry(this, struct scsi_event, node);
414 list_del(&evt->node);
415 kfree(evt);
416 }
417
James Bottomleye73e0792011-05-25 15:52:14 -0500418 blk_put_queue(sdev->request_queue);
James Bottomley86cbfb52011-04-22 10:39:59 -0500419 /* NULL queue means the device can't be used */
420 sdev->request_queue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100422 kfree(sdev->vpd_pg83);
423 kfree(sdev->vpd_pg80);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 kfree(sdev->inquiry);
425 kfree(sdev);
426
427 if (parent)
428 put_device(parent);
429}
430
James Bottomley65110b22006-02-14 10:48:46 -0600431static void scsi_device_dev_release(struct device *dev)
432{
James Bottomleyffedb452006-02-23 14:27:18 -0600433 struct scsi_device *sdp = to_scsi_device(dev);
David Howells65f27f32006-11-22 14:55:48 +0000434 execute_in_process_context(scsi_device_dev_release_usercontext,
James Bottomleyffedb452006-02-23 14:27:18 -0600435 &sdp->ew);
James Bottomley65110b22006-02-14 10:48:46 -0600436}
437
Adrian Bunk52c1da32005-06-23 22:05:33 -0700438static struct class sdev_class = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 .name = "scsi_device",
Tony Jonesee959b02008-02-22 00:13:36 +0100440 .dev_release = scsi_device_cls_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441};
442
443/* all probing is done in the individual ->probe routines */
444static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
445{
Hannes Reineckeb0ed4332008-03-18 14:32:28 +0100446 struct scsi_device *sdp;
447
448 if (dev->type != &scsi_dev_type)
449 return 0;
450
451 sdp = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 if (sdp->no_uld_attach)
453 return 0;
454 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
455}
456
Kay Sievers7eff2e72007-08-14 15:15:12 +0200457static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400458{
James Bottomley1f42ea72008-05-22 12:34:41 +0100459 struct scsi_device *sdev;
460
461 if (dev->type != &scsi_dev_type)
462 return 0;
463
464 sdev = to_scsi_device(dev);
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400465
Kay Sievers7eff2e72007-08-14 15:15:12 +0200466 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400467 return 0;
468}
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470struct bus_type scsi_bus_type = {
471 .name = "scsi",
472 .match = scsi_bus_match,
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400473 .uevent = scsi_bus_uevent,
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100474#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400475 .pm = &scsi_bus_pm_ops,
Alan Sterne6da54d2010-08-05 13:17:10 -0400476#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477};
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700478EXPORT_SYMBOL_GPL(scsi_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
480int scsi_sysfs_register(void)
481{
482 int error;
483
484 error = bus_register(&scsi_bus_type);
485 if (!error) {
486 error = class_register(&sdev_class);
487 if (error)
488 bus_unregister(&scsi_bus_type);
489 }
490
491 return error;
492}
493
494void scsi_sysfs_unregister(void)
495{
496 class_unregister(&sdev_class);
497 bus_unregister(&scsi_bus_type);
498}
499
500/*
501 * sdev_show_function: macro to create an attr function that can be used to
502 * show a non-bit field.
503 */
504#define sdev_show_function(field, format_string) \
505static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100506sdev_show_##field (struct device *dev, struct device_attribute *attr, \
507 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{ \
509 struct scsi_device *sdev; \
510 sdev = to_scsi_device(dev); \
511 return snprintf (buf, 20, format_string, sdev->field); \
512} \
513
514/*
515 * sdev_rd_attr: macro to create a function and attribute variable for a
516 * read only field.
517 */
518#define sdev_rd_attr(field, format_string) \
519 sdev_show_function(field, format_string) \
520static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
521
522
523/*
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900524 * sdev_rw_attr: create a function and attribute variable for a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 * read/write field.
526 */
527#define sdev_rw_attr(field, format_string) \
528 sdev_show_function(field, format_string) \
529 \
530static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100531sdev_store_##field (struct device *dev, struct device_attribute *attr, \
532 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{ \
534 struct scsi_device *sdev; \
535 sdev = to_scsi_device(dev); \
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900536 sscanf (buf, format_string, &sdev->field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 return count; \
538} \
539static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
540
541/* Currently we don't export bit fields, but we might in future,
542 * so leave this code in */
543#if 0
544/*
545 * sdev_rd_attr: create a function and attribute variable for a
546 * read/write bit field.
547 */
548#define sdev_rw_attr_bit(field) \
549 sdev_show_function(field, "%d\n") \
550 \
551static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100552sdev_store_##field (struct device *dev, struct device_attribute *attr, \
553 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554{ \
555 int ret; \
556 struct scsi_device *sdev; \
557 ret = scsi_sdev_check_buf_bit(buf); \
558 if (ret >= 0) { \
559 sdev = to_scsi_device(dev); \
560 sdev->field = ret; \
561 ret = count; \
562 } \
563 return ret; \
564} \
565static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
566
567/*
568 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
569 * else return -EINVAL.
570 */
571static int scsi_sdev_check_buf_bit(const char *buf)
572{
573 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
574 if (buf[0] == '1')
575 return 1;
576 else if (buf[0] == '0')
577 return 0;
578 else
579 return -EINVAL;
580 } else
581 return -EINVAL;
582}
583#endif
584/*
585 * Create the actual show/store functions and data structures.
586 */
587sdev_rd_attr (device_blocked, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588sdev_rd_attr (type, "%d\n");
589sdev_rd_attr (scsi_level, "%d\n");
590sdev_rd_attr (vendor, "%.8s\n");
591sdev_rd_attr (model, "%.16s\n");
592sdev_rd_attr (rev, "%.4s\n");
593
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200594static ssize_t
595sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
596 char *buf)
597{
598 struct scsi_device *sdev = to_scsi_device(dev);
599 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
600}
601static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
602
Jens Axboe242f9dc2008-09-14 05:55:09 -0700603/*
604 * TODO: can we make these symlinks to the block layer ones?
605 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400607sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
609 struct scsi_device *sdev;
610 sdev = to_scsi_device(dev);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700611 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
613
614static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100615sdev_store_timeout (struct device *dev, struct device_attribute *attr,
616 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
618 struct scsi_device *sdev;
619 int timeout;
620 sdev = to_scsi_device(dev);
621 sscanf (buf, "%d\n", &timeout);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700622 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 return count;
624}
625static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
626
627static ssize_t
Martin K. Petersen0816c922013-05-10 10:36:04 -0400628sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
629{
630 struct scsi_device *sdev;
631 sdev = to_scsi_device(dev);
632 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
633}
634
635static ssize_t
636sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
637 const char *buf, size_t count)
638{
639 struct scsi_device *sdev;
640 unsigned int eh_timeout;
641 int err;
642
643 if (!capable(CAP_SYS_ADMIN))
644 return -EACCES;
645
646 sdev = to_scsi_device(dev);
647 err = kstrtouint(buf, 10, &eh_timeout);
648 if (err)
649 return err;
650 sdev->eh_timeout = eh_timeout * HZ;
651
652 return count;
653}
654static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
655
656static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100657store_rescan_field (struct device *dev, struct device_attribute *attr,
658 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
660 scsi_rescan_device(dev);
661 return count;
662}
663static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
664
Tony Jonesee959b02008-02-22 00:13:36 +0100665static ssize_t
666sdev_store_delete(struct device *dev, struct device_attribute *attr,
667 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
Tejun Heoac0ece92014-02-03 14:03:03 -0500669 if (device_remove_file_self(dev, attr))
670 scsi_remove_device(to_scsi_device(dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 return count;
672};
673static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
674
675static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100676store_state_field(struct device *dev, struct device_attribute *attr,
677 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
679 int i;
680 struct scsi_device *sdev = to_scsi_device(dev);
681 enum scsi_device_state state = 0;
682
Tobias Klauser6391a112006-06-08 22:23:48 -0700683 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 const int len = strlen(sdev_states[i].name);
685 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
686 buf[len] == '\n') {
687 state = sdev_states[i].value;
688 break;
689 }
690 }
691 if (!state)
692 return -EINVAL;
693
694 if (scsi_device_set_state(sdev, state))
695 return -EINVAL;
696 return count;
697}
698
699static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400700show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701{
702 struct scsi_device *sdev = to_scsi_device(dev);
703 const char *name = scsi_device_state_name(sdev->sdev_state);
704
705 if (!name)
706 return -EINVAL;
707
708 return snprintf(buf, 20, "%s\n", name);
709}
710
711static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
712
713static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100714show_queue_type_field(struct device *dev, struct device_attribute *attr,
715 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716{
717 struct scsi_device *sdev = to_scsi_device(dev);
718 const char *name = "none";
719
720 if (sdev->ordered_tags)
721 name = "ordered";
722 else if (sdev->simple_tags)
723 name = "simple";
724
725 return snprintf(buf, 20, "%s\n", name);
726}
727
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100728static ssize_t
729store_queue_type_field(struct device *dev, struct device_attribute *attr,
730 const char *buf, size_t count)
731{
732 struct scsi_device *sdev = to_scsi_device(dev);
733 struct scsi_host_template *sht = sdev->host->hostt;
734 int tag_type = 0, retval;
735 int prev_tag_type = scsi_get_tag_type(sdev);
736
737 if (!sdev->tagged_supported || !sht->change_queue_type)
738 return -EINVAL;
739
740 if (strncmp(buf, "ordered", 7) == 0)
741 tag_type = MSG_ORDERED_TAG;
742 else if (strncmp(buf, "simple", 6) == 0)
743 tag_type = MSG_SIMPLE_TAG;
744 else if (strncmp(buf, "none", 4) != 0)
745 return -EINVAL;
746
747 if (tag_type == prev_tag_type)
748 return count;
749
750 retval = sht->change_queue_type(sdev, tag_type);
751 if (retval < 0)
752 return retval;
753
754 return count;
755}
756
757static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
758 store_queue_type_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100760#define sdev_vpd_pg_attr(_page) \
761static ssize_t \
762show_vpd_##_page(struct file *filp, struct kobject *kobj, \
763 struct bin_attribute *bin_attr, \
764 char *buf, loff_t off, size_t count) \
765{ \
766 struct device *dev = container_of(kobj, struct device, kobj); \
767 struct scsi_device *sdev = to_scsi_device(dev); \
768 if (!sdev->vpd_##_page) \
769 return -EINVAL; \
770 return memory_read_from_buffer(buf, count, &off, \
771 sdev->vpd_##_page, \
772 sdev->vpd_##_page##_len); \
773} \
774static struct bin_attribute dev_attr_vpd_##_page = { \
775 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
776 .size = 0, \
777 .read = show_vpd_##_page, \
778};
779
780sdev_vpd_pg_attr(pg83);
781sdev_vpd_pg_attr(pg80);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783static ssize_t
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100784show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
785 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
787 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
788}
789
790static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
791
792#define show_sdev_iostat(field) \
793static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100794show_iostat_##field(struct device *dev, struct device_attribute *attr, \
795 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796{ \
797 struct scsi_device *sdev = to_scsi_device(dev); \
798 unsigned long long count = atomic_read(&sdev->field); \
799 return snprintf(buf, 20, "0x%llx\n", count); \
800} \
801static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
802
803show_sdev_iostat(iorequest_cnt);
804show_sdev_iostat(iodone_cnt);
805show_sdev_iostat(ioerr_cnt);
806
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400807static ssize_t
808sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
809{
810 struct scsi_device *sdev;
811 sdev = to_scsi_device(dev);
812 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
813}
814static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
Jeff Garzika341cd02007-10-29 17:15:22 -0400816#define DECLARE_EVT_SHOW(name, Cap_name) \
817static ssize_t \
818sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
Tony Jonesee959b02008-02-22 00:13:36 +0100819 char *buf) \
Jeff Garzika341cd02007-10-29 17:15:22 -0400820{ \
821 struct scsi_device *sdev = to_scsi_device(dev); \
822 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
823 return snprintf(buf, 20, "%d\n", val); \
824}
825
826#define DECLARE_EVT_STORE(name, Cap_name) \
827static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100828sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
Jeff Garzika341cd02007-10-29 17:15:22 -0400829 const char *buf, size_t count) \
830{ \
831 struct scsi_device *sdev = to_scsi_device(dev); \
832 int val = simple_strtoul(buf, NULL, 0); \
833 if (val == 0) \
834 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
835 else if (val == 1) \
836 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
837 else \
838 return -EINVAL; \
839 return count; \
840}
841
842#define DECLARE_EVT(name, Cap_name) \
843 DECLARE_EVT_SHOW(name, Cap_name) \
844 DECLARE_EVT_STORE(name, Cap_name) \
845 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
846 sdev_store_evt_##name);
847#define REF_EVT(name) &dev_attr_evt_##name.attr
848
849DECLARE_EVT(media_change, MEDIA_CHANGE)
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400850DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
851DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
852DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
853DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
854DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
Jeff Garzika341cd02007-10-29 17:15:22 -0400855
Tony Jonesee959b02008-02-22 00:13:36 +0100856static ssize_t
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100857sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
858 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859{
860 int depth, retval;
861 struct scsi_device *sdev = to_scsi_device(dev);
862 struct scsi_host_template *sht = sdev->host->hostt;
863
864 if (!sht->change_queue_depth)
865 return -EINVAL;
866
867 depth = simple_strtoul(buf, NULL, 0);
868
869 if (depth < 1)
870 return -EINVAL;
871
Mike Christiee881a172009-10-15 17:46:39 -0700872 retval = sht->change_queue_depth(sdev, depth,
873 SCSI_QDEPTH_DEFAULT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 if (retval < 0)
875 return retval;
876
Vasu Dev4a840672009-10-22 15:46:33 -0700877 sdev->max_queue_depth = sdev->queue_depth;
878
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 return count;
880}
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100881sdev_show_function(queue_depth, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100883static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
884 sdev_store_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Tony Jonesee959b02008-02-22 00:13:36 +0100886static ssize_t
Vasu Dev4a840672009-10-22 15:46:33 -0700887sdev_show_queue_ramp_up_period(struct device *dev,
888 struct device_attribute *attr,
889 char *buf)
890{
891 struct scsi_device *sdev;
892 sdev = to_scsi_device(dev);
893 return snprintf(buf, 20, "%u\n",
894 jiffies_to_msecs(sdev->queue_ramp_up_period));
895}
896
897static ssize_t
898sdev_store_queue_ramp_up_period(struct device *dev,
899 struct device_attribute *attr,
900 const char *buf, size_t count)
901{
902 struct scsi_device *sdev = to_scsi_device(dev);
903 unsigned long period;
904
905 if (strict_strtoul(buf, 10, &period))
906 return -EINVAL;
907
908 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
909 return period;
910}
911
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100912static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
913 sdev_show_queue_ramp_up_period,
914 sdev_store_queue_ramp_up_period);
Vasu Dev4a840672009-10-22 15:46:33 -0700915
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100916static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
917 struct attribute *attr, int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918{
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100919 struct device *dev = container_of(kobj, struct device, kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 struct scsi_device *sdev = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100923 if (attr == &dev_attr_queue_depth.attr &&
924 !sdev->host->hostt->change_queue_depth)
925 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100927 if (attr == &dev_attr_queue_ramp_up_period.attr &&
928 !sdev->host->hostt->change_queue_depth)
929 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100931 if (attr == &dev_attr_queue_type.attr &&
932 !sdev->host->hostt->change_queue_type)
933 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100935 return attr->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936}
937
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100938/* Default template for device attributes. May NOT be modified */
939static struct attribute *scsi_sdev_attrs[] = {
940 &dev_attr_device_blocked.attr,
941 &dev_attr_type.attr,
942 &dev_attr_scsi_level.attr,
943 &dev_attr_device_busy.attr,
944 &dev_attr_vendor.attr,
945 &dev_attr_model.attr,
946 &dev_attr_rev.attr,
947 &dev_attr_rescan.attr,
948 &dev_attr_delete.attr,
949 &dev_attr_state.attr,
950 &dev_attr_timeout.attr,
951 &dev_attr_eh_timeout.attr,
952 &dev_attr_iocounterbits.attr,
953 &dev_attr_iorequest_cnt.attr,
954 &dev_attr_iodone_cnt.attr,
955 &dev_attr_ioerr_cnt.attr,
956 &dev_attr_modalias.attr,
957 &dev_attr_queue_depth.attr,
958 &dev_attr_queue_type.attr,
959 &dev_attr_queue_ramp_up_period.attr,
960 REF_EVT(media_change),
961 REF_EVT(inquiry_change_reported),
962 REF_EVT(capacity_change_reported),
963 REF_EVT(soft_threshold_reached),
964 REF_EVT(mode_parameter_change_reported),
965 REF_EVT(lun_change_reported),
966 NULL
967};
968
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100969static struct bin_attribute *scsi_sdev_bin_attrs[] = {
970 &dev_attr_vpd_pg83,
971 &dev_attr_vpd_pg80,
972 NULL
973};
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100974static struct attribute_group scsi_sdev_attr_group = {
975 .attrs = scsi_sdev_attrs,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100976 .bin_attrs = scsi_sdev_bin_attrs,
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100977 .is_visible = scsi_sdev_attr_is_visible,
978};
979
980static const struct attribute_group *scsi_sdev_attr_groups[] = {
981 &scsi_sdev_attr_group,
982 NULL
983};
984
James Bottomley643eb2d2008-03-22 22:42:27 -0500985static int scsi_target_add(struct scsi_target *starget)
986{
987 int error;
988
989 if (starget->state != STARGET_CREATED)
990 return 0;
991
992 error = device_add(&starget->dev);
993 if (error) {
994 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
James Bottomley643eb2d2008-03-22 22:42:27 -0500995 return error;
996 }
997 transport_add_device(&starget->dev);
998 starget->state = STARGET_RUNNING;
999
Alan Sternbc4f2402010-06-17 10:41:42 -04001000 pm_runtime_set_active(&starget->dev);
1001 pm_runtime_enable(&starget->dev);
1002 device_enable_async_suspend(&starget->dev);
1003
James Bottomley643eb2d2008-03-22 22:42:27 -05001004 return 0;
1005}
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007/**
1008 * scsi_sysfs_add_sdev - add scsi device to sysfs
1009 * @sdev: scsi_device to add
1010 *
1011 * Return value:
1012 * 0 on Success / non-zero on Failure
1013 **/
1014int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1015{
1016 int error, i;
James Bottomley80ed71c2007-07-19 10:15:10 -05001017 struct request_queue *rq = sdev->request_queue;
James Bottomley643eb2d2008-03-22 22:42:27 -05001018 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Alan Sternee37e092010-02-12 12:13:55 -05001020 error = scsi_device_set_state(sdev, SDEV_RUNNING);
1021 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 return error;
1023
James Bottomley643eb2d2008-03-22 22:42:27 -05001024 error = scsi_target_add(starget);
1025 if (error)
1026 return error;
1027
1028 transport_configure_device(&starget->dev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001029
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001030 device_enable_async_suspend(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001031 scsi_autopm_get_target(starget);
1032 pm_runtime_set_active(&sdev->sdev_gendev);
1033 pm_runtime_forbid(&sdev->sdev_gendev);
1034 pm_runtime_enable(&sdev->sdev_gendev);
1035 scsi_autopm_put_target(starget);
1036
1037 /* The following call will keep sdev active indefinitely, until
1038 * its driver does a corresponding scsi_autopm_pm_device(). Only
1039 * drivers supporting autosuspend will do this.
1040 */
1041 scsi_autopm_get_device(sdev);
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 error = device_add(&sdev->sdev_gendev);
1044 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001045 sdev_printk(KERN_INFO, sdev,
1046 "failed to add device: %d\n", error);
Alan Sternee37e092010-02-12 12:13:55 -05001047 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 }
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001049 device_enable_async_suspend(&sdev->sdev_dev);
Tony Jonesee959b02008-02-22 00:13:36 +01001050 error = device_add(&sdev->sdev_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001052 sdev_printk(KERN_INFO, sdev,
1053 "failed to add class device: %d\n", error);
James Bottomley860dc732009-11-19 17:48:29 -05001054 device_del(&sdev->sdev_gendev);
Alan Sternee37e092010-02-12 12:13:55 -05001055 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
James Bottomley860dc732009-11-19 17:48:29 -05001057 transport_add_device(&sdev->sdev_gendev);
1058 sdev->is_visible = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +09001060 error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
James Bottomley80ed71c2007-07-19 10:15:10 -05001061
1062 if (error)
James Bottomley860dc732009-11-19 17:48:29 -05001063 /* we're treating error on bsg register as non-fatal,
1064 * so pretend nothing went wrong */
James Bottomley80ed71c2007-07-19 10:15:10 -05001065 sdev_printk(KERN_INFO, sdev,
1066 "Failed to register bsg queue, errno=%d\n", error);
1067
Kay Sieversbfd12942007-09-11 17:00:14 +02001068 /* add additional host specific attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 if (sdev->host->hostt->sdev_attrs) {
1070 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
Kay Sieversbfd12942007-09-11 17:00:14 +02001071 error = device_create_file(&sdev->sdev_gendev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 sdev->host->hostt->sdev_attrs[i]);
James Bottomley860dc732009-11-19 17:48:29 -05001073 if (error)
Alan Sternee37e092010-02-12 12:13:55 -05001074 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 }
1076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079}
1080
Alan Stern903f4fe2005-07-26 10:20:53 -04001081void __scsi_remove_device(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082{
James Bottomleydf133c22005-11-06 11:47:08 -06001083 struct device *dev = &sdev->sdev_gendev;
1084
James Bottomley860dc732009-11-19 17:48:29 -05001085 if (sdev->is_visible) {
1086 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
1087 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
James Bottomley860dc732009-11-19 17:48:29 -05001089 bsg_unregister_queue(sdev->request_queue);
1090 device_unregister(&sdev->sdev_dev);
1091 transport_remove_device(dev);
1092 device_del(dev);
1093 } else
1094 put_device(&sdev->sdev_dev);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001095
1096 /*
1097 * Stop accepting new requests and wait until all queuecommand() and
1098 * scsi_run_queue() invocations have finished before tearing down the
1099 * device.
1100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 scsi_device_set_state(sdev, SDEV_DEL);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001102 blk_cleanup_queue(sdev->request_queue);
1103 cancel_work_sync(&sdev->requeue_work);
1104
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 if (sdev->host->hostt->slave_destroy)
1106 sdev->host->hostt->slave_destroy(sdev);
James Bottomleydf133c22005-11-06 11:47:08 -06001107 transport_destroy_device(dev);
James Bottomley86cbfb52011-04-22 10:39:59 -05001108
James Bottomleye63ed0d2014-01-21 07:00:50 -08001109 /*
1110 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1111 * remoed sysfs visibility from the device, so make the target
1112 * invisible if this was the last device underneath it.
1113 */
1114 scsi_target_reap(scsi_target(sdev));
1115
James Bottomleydf133c22005-11-06 11:47:08 -06001116 put_device(dev);
Alan Stern903f4fe2005-07-26 10:20:53 -04001117}
1118
1119/**
1120 * scsi_remove_device - unregister a device from the scsi bus
1121 * @sdev: scsi_device to unregister
1122 **/
1123void scsi_remove_device(struct scsi_device *sdev)
1124{
Alan Stern54195002005-09-15 21:52:51 -04001125 struct Scsi_Host *shost = sdev->host;
1126
Arjan van de Ven0b950672006-01-11 13:16:10 +01001127 mutex_lock(&shost->scan_mutex);
Alan Stern903f4fe2005-07-26 10:20:53 -04001128 __scsi_remove_device(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01001129 mutex_unlock(&shost->scan_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130}
1131EXPORT_SYMBOL(scsi_remove_device);
1132
Adrian Bunk44818ef2007-07-09 11:59:59 -07001133static void __scsi_remove_target(struct scsi_target *starget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134{
1135 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1136 unsigned long flags;
Alan Sterna64358d2005-07-26 10:27:10 -04001137 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138
1139 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001140 restart:
1141 list_for_each_entry(sdev, &shost->__devices, siblings) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 if (sdev->channel != starget->channel ||
Alan Sterna64358d2005-07-26 10:27:10 -04001143 sdev->id != starget->id ||
Christof Schmitt546ae792010-10-06 13:19:44 +02001144 scsi_device_get(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 continue;
1146 spin_unlock_irqrestore(shost->host_lock, flags);
1147 scsi_remove_device(sdev);
Christof Schmitt546ae792010-10-06 13:19:44 +02001148 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001150 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 }
1152 spin_unlock_irqrestore(shost->host_lock, flags);
mochel@digitalimplant.org20b1e672005-03-24 19:03:59 -08001153}
1154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155/**
1156 * scsi_remove_target - try to remove a target and all its devices
1157 * @dev: generic starget or parent of generic stargets to be removed
1158 *
1159 * Note: This is slightly racy. It is possible that if the user
1160 * requests the addition of another device then the target won't be
1161 * removed.
1162 */
1163void scsi_remove_target(struct device *dev)
1164{
Dan Williams3b661a92012-06-21 23:47:28 -07001165 struct Scsi_Host *shost = dev_to_shost(dev->parent);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001166 struct scsi_target *starget, *last = NULL;
Dan Williams3b661a92012-06-21 23:47:28 -07001167 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001169 /* remove targets being careful to lookup next entry before
1170 * deleting the last
1171 */
Dan Williams3b661a92012-06-21 23:47:28 -07001172 spin_lock_irqsave(shost->host_lock, flags);
1173 list_for_each_entry(starget, &shost->__targets, siblings) {
1174 if (starget->state == STARGET_DEL)
1175 continue;
1176 if (starget->dev.parent == dev || &starget->dev == dev) {
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001177 /* assuming new targets arrive at the end */
James Bottomleye63ed0d2014-01-21 07:00:50 -08001178 kref_get(&starget->reap_ref);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001179 spin_unlock_irqrestore(shost->host_lock, flags);
1180 if (last)
1181 scsi_target_reap(last);
1182 last = starget;
1183 __scsi_remove_target(starget);
1184 spin_lock_irqsave(shost->host_lock, flags);
Dan Williams3b661a92012-06-21 23:47:28 -07001185 }
1186 }
1187 spin_unlock_irqrestore(shost->host_lock, flags);
1188
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001189 if (last)
1190 scsi_target_reap(last);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191}
1192EXPORT_SYMBOL(scsi_remove_target);
1193
1194int scsi_register_driver(struct device_driver *drv)
1195{
1196 drv->bus = &scsi_bus_type;
1197
1198 return driver_register(drv);
1199}
1200EXPORT_SYMBOL(scsi_register_driver);
1201
1202int scsi_register_interface(struct class_interface *intf)
1203{
1204 intf->class = &sdev_class;
1205
1206 return class_interface_register(intf);
1207}
1208EXPORT_SYMBOL(scsi_register_interface);
1209
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210/**
1211 * scsi_sysfs_add_host - add scsi host to subsystem
1212 * @shost: scsi host struct to add to subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 **/
1214int scsi_sysfs_add_host(struct Scsi_Host *shost)
1215{
1216 int error, i;
1217
Hannes Reineckef7120a42008-03-18 14:32:28 +01001218 /* add host specific attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 if (shost->hostt->shost_attrs) {
1220 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
Tony Jonesee959b02008-02-22 00:13:36 +01001221 error = device_create_file(&shost->shost_dev,
Hannes Reineckef7120a42008-03-18 14:32:28 +01001222 shost->hostt->shost_attrs[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 if (error)
1224 return error;
1225 }
1226 }
1227
1228 transport_register_device(&shost->shost_gendev);
James Bottomleyd52b3812008-01-05 09:38:30 -06001229 transport_configure_device(&shost->shost_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 return 0;
1231}
1232
Kay Sieversbfd12942007-09-11 17:00:14 +02001233static struct device_type scsi_dev_type = {
1234 .name = "scsi_device",
1235 .release = scsi_device_dev_release,
1236 .groups = scsi_sdev_attr_groups,
1237};
1238
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1240{
1241 unsigned long flags;
1242 struct Scsi_Host *shost = sdev->host;
1243 struct scsi_target *starget = sdev->sdev_target;
1244
1245 device_initialize(&sdev->sdev_gendev);
1246 sdev->sdev_gendev.bus = &scsi_bus_type;
Kay Sieversbfd12942007-09-11 17:00:14 +02001247 sdev->sdev_gendev.type = &scsi_dev_type;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001248 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001249 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1250
Tony Jonesee959b02008-02-22 00:13:36 +01001251 device_initialize(&sdev->sdev_dev);
James Bottomley37e6ba02009-10-02 13:30:08 -05001252 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
Tony Jonesee959b02008-02-22 00:13:36 +01001253 sdev->sdev_dev.class = &sdev_class;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001254 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001255 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Alan Stern7c9d6f12007-01-08 11:12:32 -05001256 sdev->scsi_level = starget->scsi_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 transport_setup_device(&sdev->sdev_gendev);
1258 spin_lock_irqsave(shost->host_lock, flags);
1259 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1260 list_add_tail(&sdev->siblings, &shost->__devices);
1261 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomleye63ed0d2014-01-21 07:00:50 -08001262 /*
1263 * device can now only be removed via __scsi_remove_device() so hold
1264 * the target. Target will be held in CREATED state until something
1265 * beneath it becomes visible (in which case it moves to RUNNING)
1266 */
1267 kref_get(&starget->reap_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268}
1269
1270int scsi_is_sdev_device(const struct device *dev)
1271{
Kay Sievers13ba9bc2007-09-26 19:54:49 +02001272 return dev->type == &scsi_dev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273}
1274EXPORT_SYMBOL(scsi_is_sdev_device);
1275
1276/* A blank transport template that is used in drivers that don't
1277 * yet implement Transport Attributes */
1278struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };