blob: 5f36788705bab2c83c8e1b01130dc34fe6130485 [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");
337shost_rd_attr(host_busy, "%hu\n");
338shost_rd_attr(cmd_per_lun, "%hd\n");
James Bottomleyed632da2006-10-16 10:06:27 -0500339shost_rd_attr(can_queue, "%hd\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340shost_rd_attr(sg_tablesize, "%hu\n");
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200341shost_rd_attr(sg_prot_tablesize, "%hu\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342shost_rd_attr(unchecked_isa_dma, "%d\n");
Martin K. Petersen4469f982008-07-17 04:28:30 -0400343shost_rd_attr(prot_capabilities, "%u\n");
344shost_rd_attr(prot_guard_type, "%hd\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
346
Hannes Reineckef7120a42008-03-18 14:32:28 +0100347static struct attribute *scsi_sysfs_shost_attrs[] = {
348 &dev_attr_unique_id.attr,
349 &dev_attr_host_busy.attr,
350 &dev_attr_cmd_per_lun.attr,
351 &dev_attr_can_queue.attr,
352 &dev_attr_sg_tablesize.attr,
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200353 &dev_attr_sg_prot_tablesize.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100354 &dev_attr_unchecked_isa_dma.attr,
355 &dev_attr_proc_name.attr,
356 &dev_attr_scan.attr,
357 &dev_attr_hstate.attr,
358 &dev_attr_supported_mode.attr,
359 &dev_attr_active_mode.attr,
Martin K. Petersen4469f982008-07-17 04:28:30 -0400360 &dev_attr_prot_capabilities.attr,
361 &dev_attr_prot_guard_type.attr,
Vikas Chaudhary29443692011-08-12 02:51:28 -0700362 &dev_attr_host_reset.attr,
Hannes Reineckeb4562022013-10-23 10:51:21 +0200363 &dev_attr_eh_deadline.attr,
Hannes Reineckef7120a42008-03-18 14:32:28 +0100364 NULL
365};
366
367struct attribute_group scsi_shost_attr_group = {
368 .attrs = scsi_sysfs_shost_attrs,
369};
370
David Brownella4dbd672009-06-24 10:06:31 -0700371const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
Hannes Reineckef7120a42008-03-18 14:32:28 +0100372 &scsi_shost_attr_group,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 NULL
374};
375
Tony Jonesee959b02008-02-22 00:13:36 +0100376static void scsi_device_cls_release(struct device *class_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
378 struct scsi_device *sdev;
379
380 sdev = class_to_sdev(class_dev);
381 put_device(&sdev->sdev_gendev);
382}
383
David Howells65f27f32006-11-22 14:55:48 +0000384static void scsi_device_dev_release_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
386 struct scsi_device *sdev;
387 struct device *parent;
Jeff Garzika341cd02007-10-29 17:15:22 -0400388 struct list_head *this, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 unsigned long flags;
390
David Howells65f27f32006-11-22 14:55:48 +0000391 sdev = container_of(work, struct scsi_device, ew.work);
392
393 parent = sdev->sdev_gendev.parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 spin_lock_irqsave(sdev->host->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 list_del(&sdev->siblings);
397 list_del(&sdev->same_target_siblings);
398 list_del(&sdev->starved_entry);
399 spin_unlock_irqrestore(sdev->host->host_lock, flags);
400
Jeff Garzika341cd02007-10-29 17:15:22 -0400401 cancel_work_sync(&sdev->event_work);
402
403 list_for_each_safe(this, tmp, &sdev->event_list) {
404 struct scsi_event *evt;
405
406 evt = list_entry(this, struct scsi_event, node);
407 list_del(&evt->node);
408 kfree(evt);
409 }
410
James Bottomleye73e0792011-05-25 15:52:14 -0500411 blk_put_queue(sdev->request_queue);
James Bottomley86cbfb52011-04-22 10:39:59 -0500412 /* NULL queue means the device can't be used */
413 sdev->request_queue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100415 kfree(sdev->vpd_pg83);
416 kfree(sdev->vpd_pg80);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 kfree(sdev->inquiry);
418 kfree(sdev);
419
420 if (parent)
421 put_device(parent);
422}
423
James Bottomley65110b22006-02-14 10:48:46 -0600424static void scsi_device_dev_release(struct device *dev)
425{
James Bottomleyffedb452006-02-23 14:27:18 -0600426 struct scsi_device *sdp = to_scsi_device(dev);
David Howells65f27f32006-11-22 14:55:48 +0000427 execute_in_process_context(scsi_device_dev_release_usercontext,
James Bottomleyffedb452006-02-23 14:27:18 -0600428 &sdp->ew);
James Bottomley65110b22006-02-14 10:48:46 -0600429}
430
Adrian Bunk52c1da32005-06-23 22:05:33 -0700431static struct class sdev_class = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 .name = "scsi_device",
Tony Jonesee959b02008-02-22 00:13:36 +0100433 .dev_release = scsi_device_cls_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434};
435
436/* all probing is done in the individual ->probe routines */
437static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
438{
Hannes Reineckeb0ed4332008-03-18 14:32:28 +0100439 struct scsi_device *sdp;
440
441 if (dev->type != &scsi_dev_type)
442 return 0;
443
444 sdp = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 if (sdp->no_uld_attach)
446 return 0;
447 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
448}
449
Kay Sievers7eff2e72007-08-14 15:15:12 +0200450static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400451{
James Bottomley1f42ea72008-05-22 12:34:41 +0100452 struct scsi_device *sdev;
453
454 if (dev->type != &scsi_dev_type)
455 return 0;
456
457 sdev = to_scsi_device(dev);
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400458
Kay Sievers7eff2e72007-08-14 15:15:12 +0200459 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400460 return 0;
461}
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463struct bus_type scsi_bus_type = {
464 .name = "scsi",
465 .match = scsi_bus_match,
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400466 .uevent = scsi_bus_uevent,
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100467#ifdef CONFIG_PM
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400468 .pm = &scsi_bus_pm_ops,
Alan Sterne6da54d2010-08-05 13:17:10 -0400469#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470};
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700471EXPORT_SYMBOL_GPL(scsi_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473int scsi_sysfs_register(void)
474{
475 int error;
476
477 error = bus_register(&scsi_bus_type);
478 if (!error) {
479 error = class_register(&sdev_class);
480 if (error)
481 bus_unregister(&scsi_bus_type);
482 }
483
484 return error;
485}
486
487void scsi_sysfs_unregister(void)
488{
489 class_unregister(&sdev_class);
490 bus_unregister(&scsi_bus_type);
491}
492
493/*
494 * sdev_show_function: macro to create an attr function that can be used to
495 * show a non-bit field.
496 */
497#define sdev_show_function(field, format_string) \
498static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100499sdev_show_##field (struct device *dev, struct device_attribute *attr, \
500 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501{ \
502 struct scsi_device *sdev; \
503 sdev = to_scsi_device(dev); \
504 return snprintf (buf, 20, format_string, sdev->field); \
505} \
506
507/*
508 * sdev_rd_attr: macro to create a function and attribute variable for a
509 * read only field.
510 */
511#define sdev_rd_attr(field, format_string) \
512 sdev_show_function(field, format_string) \
513static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
514
515
516/*
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900517 * sdev_rw_attr: create a function and attribute variable for a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 * read/write field.
519 */
520#define sdev_rw_attr(field, format_string) \
521 sdev_show_function(field, format_string) \
522 \
523static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100524sdev_store_##field (struct device *dev, struct device_attribute *attr, \
525 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{ \
527 struct scsi_device *sdev; \
528 sdev = to_scsi_device(dev); \
Tomohiro Kusumi160e7f62010-04-14 15:15:14 +0900529 sscanf (buf, format_string, &sdev->field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 return count; \
531} \
532static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
533
534/* Currently we don't export bit fields, but we might in future,
535 * so leave this code in */
536#if 0
537/*
538 * sdev_rd_attr: create a function and attribute variable for a
539 * read/write bit field.
540 */
541#define sdev_rw_attr_bit(field) \
542 sdev_show_function(field, "%d\n") \
543 \
544static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100545sdev_store_##field (struct device *dev, struct device_attribute *attr, \
546 const char *buf, size_t count) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{ \
548 int ret; \
549 struct scsi_device *sdev; \
550 ret = scsi_sdev_check_buf_bit(buf); \
551 if (ret >= 0) { \
552 sdev = to_scsi_device(dev); \
553 sdev->field = ret; \
554 ret = count; \
555 } \
556 return ret; \
557} \
558static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
559
560/*
561 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
562 * else return -EINVAL.
563 */
564static int scsi_sdev_check_buf_bit(const char *buf)
565{
566 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
567 if (buf[0] == '1')
568 return 1;
569 else if (buf[0] == '0')
570 return 0;
571 else
572 return -EINVAL;
573 } else
574 return -EINVAL;
575}
576#endif
577/*
578 * Create the actual show/store functions and data structures.
579 */
580sdev_rd_attr (device_blocked, "%d\n");
Jack Wang522db3c2013-09-12 17:29:52 +0200581sdev_rd_attr (device_busy, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582sdev_rd_attr (type, "%d\n");
583sdev_rd_attr (scsi_level, "%d\n");
584sdev_rd_attr (vendor, "%.8s\n");
585sdev_rd_attr (model, "%.16s\n");
586sdev_rd_attr (rev, "%.4s\n");
587
Jens Axboe242f9dc2008-09-14 05:55:09 -0700588/*
589 * TODO: can we make these symlinks to the block layer ones?
590 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400592sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593{
594 struct scsi_device *sdev;
595 sdev = to_scsi_device(dev);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700596 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
598
599static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100600sdev_store_timeout (struct device *dev, struct device_attribute *attr,
601 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602{
603 struct scsi_device *sdev;
604 int timeout;
605 sdev = to_scsi_device(dev);
606 sscanf (buf, "%d\n", &timeout);
Jens Axboe242f9dc2008-09-14 05:55:09 -0700607 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 return count;
609}
610static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
611
612static ssize_t
Martin K. Petersen0816c922013-05-10 10:36:04 -0400613sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
614{
615 struct scsi_device *sdev;
616 sdev = to_scsi_device(dev);
617 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
618}
619
620static ssize_t
621sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
622 const char *buf, size_t count)
623{
624 struct scsi_device *sdev;
625 unsigned int eh_timeout;
626 int err;
627
628 if (!capable(CAP_SYS_ADMIN))
629 return -EACCES;
630
631 sdev = to_scsi_device(dev);
632 err = kstrtouint(buf, 10, &eh_timeout);
633 if (err)
634 return err;
635 sdev->eh_timeout = eh_timeout * HZ;
636
637 return count;
638}
639static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
640
641static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100642store_rescan_field (struct device *dev, struct device_attribute *attr,
643 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
645 scsi_rescan_device(dev);
646 return count;
647}
648static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
649
Tony Jonesee959b02008-02-22 00:13:36 +0100650static ssize_t
651sdev_store_delete(struct device *dev, struct device_attribute *attr,
652 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653{
Tejun Heoac0ece92014-02-03 14:03:03 -0500654 if (device_remove_file_self(dev, attr))
655 scsi_remove_device(to_scsi_device(dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 return count;
657};
658static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
659
660static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100661store_state_field(struct device *dev, struct device_attribute *attr,
662 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
664 int i;
665 struct scsi_device *sdev = to_scsi_device(dev);
666 enum scsi_device_state state = 0;
667
Tobias Klauser6391a112006-06-08 22:23:48 -0700668 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 const int len = strlen(sdev_states[i].name);
670 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
671 buf[len] == '\n') {
672 state = sdev_states[i].value;
673 break;
674 }
675 }
676 if (!state)
677 return -EINVAL;
678
679 if (scsi_device_set_state(sdev, state))
680 return -EINVAL;
681 return count;
682}
683
684static ssize_t
Yani Ioannou10523b32005-05-17 06:43:37 -0400685show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686{
687 struct scsi_device *sdev = to_scsi_device(dev);
688 const char *name = scsi_device_state_name(sdev->sdev_state);
689
690 if (!name)
691 return -EINVAL;
692
693 return snprintf(buf, 20, "%s\n", name);
694}
695
696static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
697
698static ssize_t
Tony Jonesee959b02008-02-22 00:13:36 +0100699show_queue_type_field(struct device *dev, struct device_attribute *attr,
700 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701{
702 struct scsi_device *sdev = to_scsi_device(dev);
703 const char *name = "none";
704
705 if (sdev->ordered_tags)
706 name = "ordered";
707 else if (sdev->simple_tags)
708 name = "simple";
709
710 return snprintf(buf, 20, "%s\n", name);
711}
712
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100713static ssize_t
714store_queue_type_field(struct device *dev, struct device_attribute *attr,
715 const char *buf, size_t count)
716{
717 struct scsi_device *sdev = to_scsi_device(dev);
718 struct scsi_host_template *sht = sdev->host->hostt;
719 int tag_type = 0, retval;
720 int prev_tag_type = scsi_get_tag_type(sdev);
721
722 if (!sdev->tagged_supported || !sht->change_queue_type)
723 return -EINVAL;
724
725 if (strncmp(buf, "ordered", 7) == 0)
726 tag_type = MSG_ORDERED_TAG;
727 else if (strncmp(buf, "simple", 6) == 0)
728 tag_type = MSG_SIMPLE_TAG;
729 else if (strncmp(buf, "none", 4) != 0)
730 return -EINVAL;
731
732 if (tag_type == prev_tag_type)
733 return count;
734
735 retval = sht->change_queue_type(sdev, tag_type);
736 if (retval < 0)
737 return retval;
738
739 return count;
740}
741
742static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
743 store_queue_type_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100745#define sdev_vpd_pg_attr(_page) \
746static ssize_t \
747show_vpd_##_page(struct file *filp, struct kobject *kobj, \
748 struct bin_attribute *bin_attr, \
749 char *buf, loff_t off, size_t count) \
750{ \
751 struct device *dev = container_of(kobj, struct device, kobj); \
752 struct scsi_device *sdev = to_scsi_device(dev); \
753 if (!sdev->vpd_##_page) \
754 return -EINVAL; \
755 return memory_read_from_buffer(buf, count, &off, \
756 sdev->vpd_##_page, \
757 sdev->vpd_##_page##_len); \
758} \
759static struct bin_attribute dev_attr_vpd_##_page = { \
760 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
761 .size = 0, \
762 .read = show_vpd_##_page, \
763};
764
765sdev_vpd_pg_attr(pg83);
766sdev_vpd_pg_attr(pg80);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768static ssize_t
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100769show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
770 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
772 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
773}
774
775static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
776
777#define show_sdev_iostat(field) \
778static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100779show_iostat_##field(struct device *dev, struct device_attribute *attr, \
780 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781{ \
782 struct scsi_device *sdev = to_scsi_device(dev); \
783 unsigned long long count = atomic_read(&sdev->field); \
784 return snprintf(buf, 20, "0x%llx\n", count); \
785} \
786static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
787
788show_sdev_iostat(iorequest_cnt);
789show_sdev_iostat(iodone_cnt);
790show_sdev_iostat(ioerr_cnt);
791
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400792static ssize_t
793sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
794{
795 struct scsi_device *sdev;
796 sdev = to_scsi_device(dev);
797 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
798}
799static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Jeff Garzika341cd02007-10-29 17:15:22 -0400801#define DECLARE_EVT_SHOW(name, Cap_name) \
802static ssize_t \
803sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
Tony Jonesee959b02008-02-22 00:13:36 +0100804 char *buf) \
Jeff Garzika341cd02007-10-29 17:15:22 -0400805{ \
806 struct scsi_device *sdev = to_scsi_device(dev); \
807 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
808 return snprintf(buf, 20, "%d\n", val); \
809}
810
811#define DECLARE_EVT_STORE(name, Cap_name) \
812static ssize_t \
Tony Jonesee959b02008-02-22 00:13:36 +0100813sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
Jeff Garzika341cd02007-10-29 17:15:22 -0400814 const char *buf, size_t count) \
815{ \
816 struct scsi_device *sdev = to_scsi_device(dev); \
817 int val = simple_strtoul(buf, NULL, 0); \
818 if (val == 0) \
819 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
820 else if (val == 1) \
821 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
822 else \
823 return -EINVAL; \
824 return count; \
825}
826
827#define DECLARE_EVT(name, Cap_name) \
828 DECLARE_EVT_SHOW(name, Cap_name) \
829 DECLARE_EVT_STORE(name, Cap_name) \
830 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
831 sdev_store_evt_##name);
832#define REF_EVT(name) &dev_attr_evt_##name.attr
833
834DECLARE_EVT(media_change, MEDIA_CHANGE)
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400835DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
836DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
837DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
838DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
839DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
Jeff Garzika341cd02007-10-29 17:15:22 -0400840
Tony Jonesee959b02008-02-22 00:13:36 +0100841static ssize_t
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100842sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
843 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844{
845 int depth, retval;
846 struct scsi_device *sdev = to_scsi_device(dev);
847 struct scsi_host_template *sht = sdev->host->hostt;
848
849 if (!sht->change_queue_depth)
850 return -EINVAL;
851
852 depth = simple_strtoul(buf, NULL, 0);
853
854 if (depth < 1)
855 return -EINVAL;
856
Mike Christiee881a172009-10-15 17:46:39 -0700857 retval = sht->change_queue_depth(sdev, depth,
858 SCSI_QDEPTH_DEFAULT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 if (retval < 0)
860 return retval;
861
Vasu Dev4a840672009-10-22 15:46:33 -0700862 sdev->max_queue_depth = sdev->queue_depth;
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 return count;
865}
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100866sdev_show_function(queue_depth, "%d\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100868static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
869 sdev_store_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Tony Jonesee959b02008-02-22 00:13:36 +0100871static ssize_t
Vasu Dev4a840672009-10-22 15:46:33 -0700872sdev_show_queue_ramp_up_period(struct device *dev,
873 struct device_attribute *attr,
874 char *buf)
875{
876 struct scsi_device *sdev;
877 sdev = to_scsi_device(dev);
878 return snprintf(buf, 20, "%u\n",
879 jiffies_to_msecs(sdev->queue_ramp_up_period));
880}
881
882static ssize_t
883sdev_store_queue_ramp_up_period(struct device *dev,
884 struct device_attribute *attr,
885 const char *buf, size_t count)
886{
887 struct scsi_device *sdev = to_scsi_device(dev);
888 unsigned long period;
889
890 if (strict_strtoul(buf, 10, &period))
891 return -EINVAL;
892
893 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
894 return period;
895}
896
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100897static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
898 sdev_show_queue_ramp_up_period,
899 sdev_store_queue_ramp_up_period);
Vasu Dev4a840672009-10-22 15:46:33 -0700900
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100901static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
902 struct attribute *attr, int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100904 struct device *dev = container_of(kobj, struct device, kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 struct scsi_device *sdev = to_scsi_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100908 if (attr == &dev_attr_queue_depth.attr &&
909 !sdev->host->hostt->change_queue_depth)
910 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100912 if (attr == &dev_attr_queue_ramp_up_period.attr &&
913 !sdev->host->hostt->change_queue_depth)
914 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100916 if (attr == &dev_attr_queue_type.attr &&
917 !sdev->host->hostt->change_queue_type)
918 return S_IRUGO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100920 return attr->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921}
922
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100923/* Default template for device attributes. May NOT be modified */
924static struct attribute *scsi_sdev_attrs[] = {
925 &dev_attr_device_blocked.attr,
926 &dev_attr_type.attr,
927 &dev_attr_scsi_level.attr,
928 &dev_attr_device_busy.attr,
929 &dev_attr_vendor.attr,
930 &dev_attr_model.attr,
931 &dev_attr_rev.attr,
932 &dev_attr_rescan.attr,
933 &dev_attr_delete.attr,
934 &dev_attr_state.attr,
935 &dev_attr_timeout.attr,
936 &dev_attr_eh_timeout.attr,
937 &dev_attr_iocounterbits.attr,
938 &dev_attr_iorequest_cnt.attr,
939 &dev_attr_iodone_cnt.attr,
940 &dev_attr_ioerr_cnt.attr,
941 &dev_attr_modalias.attr,
942 &dev_attr_queue_depth.attr,
943 &dev_attr_queue_type.attr,
944 &dev_attr_queue_ramp_up_period.attr,
945 REF_EVT(media_change),
946 REF_EVT(inquiry_change_reported),
947 REF_EVT(capacity_change_reported),
948 REF_EVT(soft_threshold_reached),
949 REF_EVT(mode_parameter_change_reported),
950 REF_EVT(lun_change_reported),
951 NULL
952};
953
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100954static struct bin_attribute *scsi_sdev_bin_attrs[] = {
955 &dev_attr_vpd_pg83,
956 &dev_attr_vpd_pg80,
957 NULL
958};
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100959static struct attribute_group scsi_sdev_attr_group = {
960 .attrs = scsi_sdev_attrs,
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100961 .bin_attrs = scsi_sdev_bin_attrs,
Hannes Reinecke276b20d2014-03-15 09:51:47 +0100962 .is_visible = scsi_sdev_attr_is_visible,
963};
964
965static const struct attribute_group *scsi_sdev_attr_groups[] = {
966 &scsi_sdev_attr_group,
967 NULL
968};
969
James Bottomley643eb2d2008-03-22 22:42:27 -0500970static int scsi_target_add(struct scsi_target *starget)
971{
972 int error;
973
974 if (starget->state != STARGET_CREATED)
975 return 0;
976
977 error = device_add(&starget->dev);
978 if (error) {
979 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
James Bottomley643eb2d2008-03-22 22:42:27 -0500980 return error;
981 }
982 transport_add_device(&starget->dev);
983 starget->state = STARGET_RUNNING;
984
Alan Sternbc4f2402010-06-17 10:41:42 -0400985 pm_runtime_set_active(&starget->dev);
986 pm_runtime_enable(&starget->dev);
987 device_enable_async_suspend(&starget->dev);
988
James Bottomley643eb2d2008-03-22 22:42:27 -0500989 return 0;
990}
991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992/**
993 * scsi_sysfs_add_sdev - add scsi device to sysfs
994 * @sdev: scsi_device to add
995 *
996 * Return value:
997 * 0 on Success / non-zero on Failure
998 **/
999int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1000{
1001 int error, i;
James Bottomley80ed71c2007-07-19 10:15:10 -05001002 struct request_queue *rq = sdev->request_queue;
James Bottomley643eb2d2008-03-22 22:42:27 -05001003 struct scsi_target *starget = sdev->sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
Alan Sternee37e092010-02-12 12:13:55 -05001005 error = scsi_device_set_state(sdev, SDEV_RUNNING);
1006 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 return error;
1008
James Bottomley643eb2d2008-03-22 22:42:27 -05001009 error = scsi_target_add(starget);
1010 if (error)
1011 return error;
1012
1013 transport_configure_device(&starget->dev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001014
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001015 device_enable_async_suspend(&sdev->sdev_gendev);
Alan Sternbc4f2402010-06-17 10:41:42 -04001016 scsi_autopm_get_target(starget);
1017 pm_runtime_set_active(&sdev->sdev_gendev);
1018 pm_runtime_forbid(&sdev->sdev_gendev);
1019 pm_runtime_enable(&sdev->sdev_gendev);
1020 scsi_autopm_put_target(starget);
1021
1022 /* The following call will keep sdev active indefinitely, until
1023 * its driver does a corresponding scsi_autopm_pm_device(). Only
1024 * drivers supporting autosuspend will do this.
1025 */
1026 scsi_autopm_get_device(sdev);
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 error = device_add(&sdev->sdev_gendev);
1029 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001030 sdev_printk(KERN_INFO, sdev,
1031 "failed to add device: %d\n", error);
Alan Sternee37e092010-02-12 12:13:55 -05001032 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 }
Rafael J. Wysocki4cb077d2010-02-08 19:18:26 +01001034 device_enable_async_suspend(&sdev->sdev_dev);
Tony Jonesee959b02008-02-22 00:13:36 +01001035 error = device_add(&sdev->sdev_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 if (error) {
Alan Stern73d8c342010-11-15 16:03:04 -05001037 sdev_printk(KERN_INFO, sdev,
1038 "failed to add class device: %d\n", error);
James Bottomley860dc732009-11-19 17:48:29 -05001039 device_del(&sdev->sdev_gendev);
Alan Sternee37e092010-02-12 12:13:55 -05001040 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 }
James Bottomley860dc732009-11-19 17:48:29 -05001042 transport_add_device(&sdev->sdev_gendev);
1043 sdev->is_visible = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +09001045 error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
James Bottomley80ed71c2007-07-19 10:15:10 -05001046
1047 if (error)
James Bottomley860dc732009-11-19 17:48:29 -05001048 /* we're treating error on bsg register as non-fatal,
1049 * so pretend nothing went wrong */
James Bottomley80ed71c2007-07-19 10:15:10 -05001050 sdev_printk(KERN_INFO, sdev,
1051 "Failed to register bsg queue, errno=%d\n", error);
1052
Kay Sieversbfd12942007-09-11 17:00:14 +02001053 /* add additional host specific attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 if (sdev->host->hostt->sdev_attrs) {
1055 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
Kay Sieversbfd12942007-09-11 17:00:14 +02001056 error = device_create_file(&sdev->sdev_gendev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 sdev->host->hostt->sdev_attrs[i]);
James Bottomley860dc732009-11-19 17:48:29 -05001058 if (error)
Alan Sternee37e092010-02-12 12:13:55 -05001059 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 }
1061 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064}
1065
Alan Stern903f4fe2005-07-26 10:20:53 -04001066void __scsi_remove_device(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067{
James Bottomleydf133c22005-11-06 11:47:08 -06001068 struct device *dev = &sdev->sdev_gendev;
1069
James Bottomley860dc732009-11-19 17:48:29 -05001070 if (sdev->is_visible) {
1071 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
1072 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
James Bottomley860dc732009-11-19 17:48:29 -05001074 bsg_unregister_queue(sdev->request_queue);
1075 device_unregister(&sdev->sdev_dev);
1076 transport_remove_device(dev);
1077 device_del(dev);
1078 } else
1079 put_device(&sdev->sdev_dev);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001080
1081 /*
1082 * Stop accepting new requests and wait until all queuecommand() and
1083 * scsi_run_queue() invocations have finished before tearing down the
1084 * device.
1085 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 scsi_device_set_state(sdev, SDEV_DEL);
Bart Van Asscheb4854622012-06-29 15:36:07 +00001087 blk_cleanup_queue(sdev->request_queue);
1088 cancel_work_sync(&sdev->requeue_work);
1089
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 if (sdev->host->hostt->slave_destroy)
1091 sdev->host->hostt->slave_destroy(sdev);
James Bottomleydf133c22005-11-06 11:47:08 -06001092 transport_destroy_device(dev);
James Bottomley86cbfb52011-04-22 10:39:59 -05001093
James Bottomleye63ed0d2014-01-21 07:00:50 -08001094 /*
1095 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1096 * remoed sysfs visibility from the device, so make the target
1097 * invisible if this was the last device underneath it.
1098 */
1099 scsi_target_reap(scsi_target(sdev));
1100
James Bottomleydf133c22005-11-06 11:47:08 -06001101 put_device(dev);
Alan Stern903f4fe2005-07-26 10:20:53 -04001102}
1103
1104/**
1105 * scsi_remove_device - unregister a device from the scsi bus
1106 * @sdev: scsi_device to unregister
1107 **/
1108void scsi_remove_device(struct scsi_device *sdev)
1109{
Alan Stern54195002005-09-15 21:52:51 -04001110 struct Scsi_Host *shost = sdev->host;
1111
Arjan van de Ven0b950672006-01-11 13:16:10 +01001112 mutex_lock(&shost->scan_mutex);
Alan Stern903f4fe2005-07-26 10:20:53 -04001113 __scsi_remove_device(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01001114 mutex_unlock(&shost->scan_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115}
1116EXPORT_SYMBOL(scsi_remove_device);
1117
Adrian Bunk44818ef2007-07-09 11:59:59 -07001118static void __scsi_remove_target(struct scsi_target *starget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119{
1120 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1121 unsigned long flags;
Alan Sterna64358d2005-07-26 10:27:10 -04001122 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
1124 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001125 restart:
1126 list_for_each_entry(sdev, &shost->__devices, siblings) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 if (sdev->channel != starget->channel ||
Alan Sterna64358d2005-07-26 10:27:10 -04001128 sdev->id != starget->id ||
Christof Schmitt546ae792010-10-06 13:19:44 +02001129 scsi_device_get(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 continue;
1131 spin_unlock_irqrestore(shost->host_lock, flags);
1132 scsi_remove_device(sdev);
Christof Schmitt546ae792010-10-06 13:19:44 +02001133 scsi_device_put(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 spin_lock_irqsave(shost->host_lock, flags);
Alan Sterna64358d2005-07-26 10:27:10 -04001135 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 }
1137 spin_unlock_irqrestore(shost->host_lock, flags);
mochel@digitalimplant.org20b1e672005-03-24 19:03:59 -08001138}
1139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140/**
1141 * scsi_remove_target - try to remove a target and all its devices
1142 * @dev: generic starget or parent of generic stargets to be removed
1143 *
1144 * Note: This is slightly racy. It is possible that if the user
1145 * requests the addition of another device then the target won't be
1146 * removed.
1147 */
1148void scsi_remove_target(struct device *dev)
1149{
Dan Williams3b661a92012-06-21 23:47:28 -07001150 struct Scsi_Host *shost = dev_to_shost(dev->parent);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001151 struct scsi_target *starget, *last = NULL;
Dan Williams3b661a92012-06-21 23:47:28 -07001152 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001154 /* remove targets being careful to lookup next entry before
1155 * deleting the last
1156 */
Dan Williams3b661a92012-06-21 23:47:28 -07001157 spin_lock_irqsave(shost->host_lock, flags);
1158 list_for_each_entry(starget, &shost->__targets, siblings) {
1159 if (starget->state == STARGET_DEL)
1160 continue;
1161 if (starget->dev.parent == dev || &starget->dev == dev) {
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001162 /* assuming new targets arrive at the end */
James Bottomleye63ed0d2014-01-21 07:00:50 -08001163 kref_get(&starget->reap_ref);
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001164 spin_unlock_irqrestore(shost->host_lock, flags);
1165 if (last)
1166 scsi_target_reap(last);
1167 last = starget;
1168 __scsi_remove_target(starget);
1169 spin_lock_irqsave(shost->host_lock, flags);
Dan Williams3b661a92012-06-21 23:47:28 -07001170 }
1171 }
1172 spin_unlock_irqrestore(shost->host_lock, flags);
1173
Dan Williamsbc3f02a2012-08-28 22:12:10 -07001174 if (last)
1175 scsi_target_reap(last);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176}
1177EXPORT_SYMBOL(scsi_remove_target);
1178
1179int scsi_register_driver(struct device_driver *drv)
1180{
1181 drv->bus = &scsi_bus_type;
1182
1183 return driver_register(drv);
1184}
1185EXPORT_SYMBOL(scsi_register_driver);
1186
1187int scsi_register_interface(struct class_interface *intf)
1188{
1189 intf->class = &sdev_class;
1190
1191 return class_interface_register(intf);
1192}
1193EXPORT_SYMBOL(scsi_register_interface);
1194
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195/**
1196 * scsi_sysfs_add_host - add scsi host to subsystem
1197 * @shost: scsi host struct to add to subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 **/
1199int scsi_sysfs_add_host(struct Scsi_Host *shost)
1200{
1201 int error, i;
1202
Hannes Reineckef7120a42008-03-18 14:32:28 +01001203 /* add host specific attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 if (shost->hostt->shost_attrs) {
1205 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
Tony Jonesee959b02008-02-22 00:13:36 +01001206 error = device_create_file(&shost->shost_dev,
Hannes Reineckef7120a42008-03-18 14:32:28 +01001207 shost->hostt->shost_attrs[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 if (error)
1209 return error;
1210 }
1211 }
1212
1213 transport_register_device(&shost->shost_gendev);
James Bottomleyd52b3812008-01-05 09:38:30 -06001214 transport_configure_device(&shost->shost_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 return 0;
1216}
1217
Kay Sieversbfd12942007-09-11 17:00:14 +02001218static struct device_type scsi_dev_type = {
1219 .name = "scsi_device",
1220 .release = scsi_device_dev_release,
1221 .groups = scsi_sdev_attr_groups,
1222};
1223
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1225{
1226 unsigned long flags;
1227 struct Scsi_Host *shost = sdev->host;
1228 struct scsi_target *starget = sdev->sdev_target;
1229
1230 device_initialize(&sdev->sdev_gendev);
1231 sdev->sdev_gendev.bus = &scsi_bus_type;
Kay Sieversbfd12942007-09-11 17:00:14 +02001232 sdev->sdev_gendev.type = &scsi_dev_type;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001233 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001234 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1235
Tony Jonesee959b02008-02-22 00:13:36 +01001236 device_initialize(&sdev->sdev_dev);
James Bottomley37e6ba02009-10-02 13:30:08 -05001237 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
Tony Jonesee959b02008-02-22 00:13:36 +01001238 sdev->sdev_dev.class = &sdev_class;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001239 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
Kay Sievers71610f52008-12-03 22:41:36 +01001240 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
Alan Stern7c9d6f12007-01-08 11:12:32 -05001241 sdev->scsi_level = starget->scsi_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 transport_setup_device(&sdev->sdev_gendev);
1243 spin_lock_irqsave(shost->host_lock, flags);
1244 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1245 list_add_tail(&sdev->siblings, &shost->__devices);
1246 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomleye63ed0d2014-01-21 07:00:50 -08001247 /*
1248 * device can now only be removed via __scsi_remove_device() so hold
1249 * the target. Target will be held in CREATED state until something
1250 * beneath it becomes visible (in which case it moves to RUNNING)
1251 */
1252 kref_get(&starget->reap_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253}
1254
1255int scsi_is_sdev_device(const struct device *dev)
1256{
Kay Sievers13ba9bc2007-09-26 19:54:49 +02001257 return dev->type == &scsi_dev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258}
1259EXPORT_SYMBOL(scsi_is_sdev_device);
1260
1261/* A blank transport template that is used in drivers that don't
1262 * yet implement Transport Attributes */
1263struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };