2 * linux/drivers/scsi/scsi_proc.c
4 * The functions in this file provide an interface between
5 * the PROC file system and the SCSI device drivers
6 * It is mainly used for debugging, statistics and to pass
7 * information directly to the lowlevel driver.
9 * (c) 1995 Michael Neuffer neuffer@goofy.zdv.uni-mainz.de
10 * Version: 0.99.8 last change: 95/09/13
12 * generic command parser provided by:
13 * Andreas Heilwagen <crashcar@informatik.uni-koblenz.de>
15 * generic_proc_info() support of xxxx_info() by:
16 * Michael A. Griffith <grif@acm.org>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/string.h>
23 #include <linux/proc_fs.h>
24 #include <linux/errno.h>
25 #include <linux/blkdev.h>
26 #include <linux/seq_file.h>
27 #include <linux/mutex.h>
28 #include <linux/gfp.h>
29 #include <asm/uaccess.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_device.h>
33 #include <scsi/scsi_host.h>
34 #include <scsi/scsi_transport.h>
36 #include "scsi_priv.h"
37 #include "scsi_logging.h"
40 /* 4K page size, but our output routines, use some slack for overruns */
41 #define PROC_BLOCK_SIZE (3*1024)
43 static struct proc_dir_entry
*proc_scsi
;
45 /* Protect sht->present and sht->proc_dir */
46 static DEFINE_MUTEX(global_host_template_mutex
);
49 * proc_scsi_read - handle read from /proc by calling host's proc_info() command
50 * @buffer: passed to proc_info
51 * @start: passed to proc_info
52 * @offset: passed to proc_info
53 * @length: passed to proc_info
54 * @eof: returns whether length read was less than requested
55 * @data: pointer to a &struct Scsi_Host
58 static int proc_scsi_read(char *buffer
, char **start
, off_t offset
,
59 int length
, int *eof
, void *data
)
61 struct Scsi_Host
*shost
= data
;
64 n
= shost
->hostt
->proc_info(shost
, buffer
, start
, offset
, length
, 0);
71 * proc_scsi_write_proc - Handle write to /proc by calling host's proc_info()
73 * @buf: source of data to write.
74 * @count: number of bytes (at most PROC_BLOCK_SIZE) to write.
75 * @data: pointer to &struct Scsi_Host
77 static int proc_scsi_write_proc(struct file
*file
, const char __user
*buf
,
78 unsigned long count
, void *data
)
80 struct Scsi_Host
*shost
= data
;
81 ssize_t ret
= -ENOMEM
;
85 if (count
> PROC_BLOCK_SIZE
)
88 page
= (char *)__get_free_page(GFP_KERNEL
);
91 if (copy_from_user(page
, buf
, count
))
93 ret
= shost
->hostt
->proc_info(shost
, page
, &start
, 0, count
, 1);
96 free_page((unsigned long)page
);
100 static ssize_t
proc_scsi_host_write(struct file
*file
, const char __user
*buf
,
101 size_t count
, loff_t
*ppos
)
103 struct Scsi_Host
*shost
= PDE(file_inode(file
))->data
;
104 ssize_t ret
= -ENOMEM
;
107 if (count
> PROC_BLOCK_SIZE
)
110 if (!shost
->hostt
->write_info
)
113 page
= (char *)__get_free_page(GFP_KERNEL
);
116 if (copy_from_user(page
, buf
, count
))
118 ret
= shost
->hostt
->write_info(shost
, page
, count
);
121 free_page((unsigned long)page
);
125 static int proc_scsi_show(struct seq_file
*m
, void *v
)
127 struct Scsi_Host
*shost
= m
->private;
128 return shost
->hostt
->show_info(m
, shost
);
131 static int proc_scsi_host_open(struct inode
*inode
, struct file
*file
)
133 return single_open(file
, proc_scsi_show
, PDE(inode
)->data
);
136 static const struct file_operations proc_scsi_fops
= {
137 .open
= proc_scsi_host_open
,
140 .write
= proc_scsi_host_write
144 * scsi_proc_hostdir_add - Create directory in /proc for a scsi host
145 * @sht: owner of this directory
147 * Sets sht->proc_dir to the new directory.
150 void scsi_proc_hostdir_add(struct scsi_host_template
*sht
)
152 if (!sht
->proc_info
&& !sht
->show_info
)
155 mutex_lock(&global_host_template_mutex
);
156 if (!sht
->present
++) {
157 sht
->proc_dir
= proc_mkdir(sht
->proc_name
, proc_scsi
);
159 printk(KERN_ERR
"%s: proc_mkdir failed for %s\n",
160 __func__
, sht
->proc_name
);
162 mutex_unlock(&global_host_template_mutex
);
166 * scsi_proc_hostdir_rm - remove directory in /proc for a scsi host
167 * @sht: owner of directory
169 void scsi_proc_hostdir_rm(struct scsi_host_template
*sht
)
171 if (!sht
->proc_info
&& !sht
->show_info
)
174 mutex_lock(&global_host_template_mutex
);
175 if (!--sht
->present
&& sht
->proc_dir
) {
176 remove_proc_entry(sht
->proc_name
, proc_scsi
);
177 sht
->proc_dir
= NULL
;
179 mutex_unlock(&global_host_template_mutex
);
184 * scsi_proc_host_add - Add entry for this host to appropriate /proc dir
185 * @shost: host to add
187 void scsi_proc_host_add(struct Scsi_Host
*shost
)
189 struct scsi_host_template
*sht
= shost
->hostt
;
190 struct proc_dir_entry
*p
;
196 sprintf(name
,"%d", shost
->host_no
);
197 if (sht
->show_info
) {
198 p
= proc_create_data(name
, S_IRUGO
| S_IWUSR
,
199 sht
->proc_dir
, &proc_scsi_fops
, shost
);
204 p
= create_proc_read_entry(name
, S_IFREG
| S_IRUGO
| S_IWUSR
,
205 sht
->proc_dir
, proc_scsi_read
, shost
);
207 p
->write_proc
= proc_scsi_write_proc
;
211 printk(KERN_ERR
"%s: Failed to register host %d in"
212 "%s\n", __func__
, shost
->host_no
,
217 * scsi_proc_host_rm - remove this host's entry from /proc
220 void scsi_proc_host_rm(struct Scsi_Host
*shost
)
224 if (!shost
->hostt
->proc_dir
)
227 sprintf(name
,"%d", shost
->host_no
);
228 remove_proc_entry(name
, shost
->hostt
->proc_dir
);
231 * proc_print_scsidevice - return data about this host
232 * @dev: A scsi device
233 * @data: &struct seq_file to output to.
235 * Description: prints Host, Channel, Id, Lun, Vendor, Model, Rev, Type,
238 static int proc_print_scsidevice(struct device
*dev
, void *data
)
240 struct scsi_device
*sdev
;
241 struct seq_file
*s
= data
;
244 if (!scsi_is_sdev_device(dev
))
247 sdev
= to_scsi_device(dev
);
249 "Host: scsi%d Channel: %02d Id: %02d Lun: %02d\n Vendor: ",
250 sdev
->host
->host_no
, sdev
->channel
, sdev
->id
, sdev
->lun
);
251 for (i
= 0; i
< 8; i
++) {
252 if (sdev
->vendor
[i
] >= 0x20)
253 seq_printf(s
, "%c", sdev
->vendor
[i
]);
258 seq_printf(s
, " Model: ");
259 for (i
= 0; i
< 16; i
++) {
260 if (sdev
->model
[i
] >= 0x20)
261 seq_printf(s
, "%c", sdev
->model
[i
]);
266 seq_printf(s
, " Rev: ");
267 for (i
= 0; i
< 4; i
++) {
268 if (sdev
->rev
[i
] >= 0x20)
269 seq_printf(s
, "%c", sdev
->rev
[i
]);
276 seq_printf(s
, " Type: %s ", scsi_device_type(sdev
->type
));
277 seq_printf(s
, " ANSI SCSI revision: %02x",
278 sdev
->scsi_level
- (sdev
->scsi_level
> 1));
279 if (sdev
->scsi_level
== 2)
280 seq_printf(s
, " CCS\n");
289 * scsi_add_single_device - Respond to user request to probe for/add device
290 * @host: user-supplied decimal integer
291 * @channel: user-supplied decimal integer
292 * @id: user-supplied decimal integer
293 * @lun: user-supplied decimal integer
295 * Description: called by writing "scsi add-single-device" to /proc/scsi/scsi.
297 * does scsi_host_lookup() and either user_scan() if that transport
298 * type supports it, or else scsi_scan_host_selected()
300 * Note: this seems to be aimed exclusively at SCSI parallel busses.
303 static int scsi_add_single_device(uint host
, uint channel
, uint id
, uint lun
)
305 struct Scsi_Host
*shost
;
308 shost
= scsi_host_lookup(host
);
312 if (shost
->transportt
->user_scan
)
313 error
= shost
->transportt
->user_scan(shost
, channel
, id
, lun
);
315 error
= scsi_scan_host_selected(shost
, channel
, id
, lun
, 1);
316 scsi_host_put(shost
);
321 * scsi_remove_single_device - Respond to user request to remove a device
322 * @host: user-supplied decimal integer
323 * @channel: user-supplied decimal integer
324 * @id: user-supplied decimal integer
325 * @lun: user-supplied decimal integer
327 * Description: called by writing "scsi remove-single-device" to
328 * /proc/scsi/scsi. Does a scsi_device_lookup() and scsi_remove_device()
330 static int scsi_remove_single_device(uint host
, uint channel
, uint id
, uint lun
)
332 struct scsi_device
*sdev
;
333 struct Scsi_Host
*shost
;
336 shost
= scsi_host_lookup(host
);
339 sdev
= scsi_device_lookup(shost
, channel
, id
, lun
);
341 scsi_remove_device(sdev
);
342 scsi_device_put(sdev
);
346 scsi_host_put(shost
);
351 * proc_scsi_write - handle writes to /proc/scsi/scsi
353 * @buf: buffer to write
354 * @length: length of buf, at most PAGE_SIZE
357 * Description: this provides a legacy mechanism to add or remove devices by
358 * Host, Channel, ID, and Lun. To use,
359 * "echo 'scsi add-single-device 0 1 2 3' > /proc/scsi/scsi" or
360 * "echo 'scsi remove-single-device 0 1 2 3' > /proc/scsi/scsi" with
361 * "0 1 2 3" replaced by the Host, Channel, Id, and Lun.
363 * Note: this seems to be aimed at parallel SCSI. Most modern busses (USB,
364 * SATA, Firewire, Fibre Channel, etc) dynamically assign these values to
365 * provide a unique identifier and nothing more.
369 static ssize_t
proc_scsi_write(struct file
*file
, const char __user
*buf
,
370 size_t length
, loff_t
*ppos
)
372 int host
, channel
, id
, lun
;
376 if (!buf
|| length
> PAGE_SIZE
)
379 buffer
= (char *)__get_free_page(GFP_KERNEL
);
384 if (copy_from_user(buffer
, buf
, length
))
388 if (length
< PAGE_SIZE
)
389 buffer
[length
] = '\0';
390 else if (buffer
[PAGE_SIZE
-1])
394 * Usage: echo "scsi add-single-device 0 1 2 3" >/proc/scsi/scsi
395 * with "0 1 2 3" replaced by your "Host Channel Id Lun".
397 if (!strncmp("scsi add-single-device", buffer
, 22)) {
400 host
= simple_strtoul(p
, &p
, 0);
401 channel
= simple_strtoul(p
+ 1, &p
, 0);
402 id
= simple_strtoul(p
+ 1, &p
, 0);
403 lun
= simple_strtoul(p
+ 1, &p
, 0);
405 err
= scsi_add_single_device(host
, channel
, id
, lun
);
408 * Usage: echo "scsi remove-single-device 0 1 2 3" >/proc/scsi/scsi
409 * with "0 1 2 3" replaced by your "Host Channel Id Lun".
411 } else if (!strncmp("scsi remove-single-device", buffer
, 25)) {
414 host
= simple_strtoul(p
, &p
, 0);
415 channel
= simple_strtoul(p
+ 1, &p
, 0);
416 id
= simple_strtoul(p
+ 1, &p
, 0);
417 lun
= simple_strtoul(p
+ 1, &p
, 0);
419 err
= scsi_remove_single_device(host
, channel
, id
, lun
);
423 * convert success returns so that we return the
424 * number of bytes consumed.
430 free_page((unsigned long)buffer
);
434 static int always_match(struct device
*dev
, void *data
)
439 static inline struct device
*next_scsi_device(struct device
*start
)
441 struct device
*next
= bus_find_device(&scsi_bus_type
, start
, NULL
,
447 static void *scsi_seq_start(struct seq_file
*sfile
, loff_t
*pos
)
449 struct device
*dev
= NULL
;
452 while ((dev
= next_scsi_device(dev
))) {
460 static void *scsi_seq_next(struct seq_file
*sfile
, void *v
, loff_t
*pos
)
464 return next_scsi_device(v
);
467 static void scsi_seq_stop(struct seq_file
*sfile
, void *v
)
472 static int scsi_seq_show(struct seq_file
*sfile
, void *dev
)
475 seq_puts(sfile
, "Attached devices:\n");
477 return proc_print_scsidevice(dev
, sfile
);
480 static const struct seq_operations scsi_seq_ops
= {
481 .start
= scsi_seq_start
,
482 .next
= scsi_seq_next
,
483 .stop
= scsi_seq_stop
,
484 .show
= scsi_seq_show
488 * proc_scsi_open - glue function
490 * @file: passed to single_open()
492 * Associates proc_scsi_show with this file
494 static int proc_scsi_open(struct inode
*inode
, struct file
*file
)
497 * We don't really need this for the write case but it doesn't
500 return seq_open(file
, &scsi_seq_ops
);
503 static const struct file_operations proc_scsi_operations
= {
504 .owner
= THIS_MODULE
,
505 .open
= proc_scsi_open
,
507 .write
= proc_scsi_write
,
509 .release
= seq_release
,
513 * scsi_init_procfs - create scsi and scsi/scsi in procfs
515 int __init
scsi_init_procfs(void)
517 struct proc_dir_entry
*pde
;
519 proc_scsi
= proc_mkdir("scsi", NULL
);
523 pde
= proc_create("scsi/scsi", 0, NULL
, &proc_scsi_operations
);
530 remove_proc_entry("scsi", NULL
);
536 * scsi_exit_procfs - Remove scsi/scsi and scsi from procfs
538 void scsi_exit_procfs(void)
540 remove_proc_entry("scsi/scsi", NULL
);
541 remove_proc_entry("scsi", NULL
);