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/slab.h>
24 #include <linux/proc_fs.h>
25 #include <linux/errno.h>
26 #include <linux/blkdev.h>
27 #include <linux/seq_file.h>
28 #include <linux/mutex.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);
101 * scsi_proc_hostdir_add - Create directory in /proc for a scsi host
102 * @sht: owner of this directory
104 * Sets sht->proc_dir to the new directory.
107 void scsi_proc_hostdir_add(struct scsi_host_template *sht)
112 mutex_lock(&global_host_template_mutex);
113 if (!sht->present++) {
114 sht->proc_dir = proc_mkdir(sht->proc_name, proc_scsi);
116 printk(KERN_ERR "%s: proc_mkdir failed for %s\n",
117 __func__, sht->proc_name);
119 mutex_unlock(&global_host_template_mutex);
123 * scsi_proc_hostdir_rm - remove directory in /proc for a scsi host
124 * @sht: owner of directory
126 void scsi_proc_hostdir_rm(struct scsi_host_template *sht)
131 mutex_lock(&global_host_template_mutex);
132 if (!--sht->present && sht->proc_dir) {
133 remove_proc_entry(sht->proc_name, proc_scsi);
134 sht->proc_dir = NULL;
136 mutex_unlock(&global_host_template_mutex);
141 * scsi_proc_host_add - Add entry for this host to appropriate /proc dir
142 * @shost: host to add
144 void scsi_proc_host_add(struct Scsi_Host *shost)
146 struct scsi_host_template *sht = shost->hostt;
147 struct proc_dir_entry *p;
153 sprintf(name,"%d", shost->host_no);
154 p = create_proc_read_entry(name, S_IFREG | S_IRUGO | S_IWUSR,
155 sht->proc_dir, proc_scsi_read, shost);
157 printk(KERN_ERR "%s: Failed to register host %d in"
158 "%s\n", __func__, shost->host_no,
163 p->write_proc = proc_scsi_write_proc;
167 * scsi_proc_host_rm - remove this host's entry from /proc
170 void scsi_proc_host_rm(struct Scsi_Host *shost)
174 if (!shost->hostt->proc_dir)
177 sprintf(name,"%d", shost->host_no);
178 remove_proc_entry(name, shost->hostt->proc_dir);
181 * proc_print_scsidevice - return data about this host
182 * @dev: A scsi device
183 * @data: &struct seq_file to output to.
185 * Description: prints Host, Channel, Id, Lun, Vendor, Model, Rev, Type,
188 static int proc_print_scsidevice(struct device *dev, void *data)
190 struct scsi_device *sdev;
191 struct seq_file *s = data;
194 if (!scsi_is_sdev_device(dev))
197 sdev = to_scsi_device(dev);
199 "Host: scsi%d Channel: %02d Id: %02d Lun: %02d\n Vendor: ",
200 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
201 for (i = 0; i < 8; i++) {
202 if (sdev->vendor[i] >= 0x20)
203 seq_printf(s, "%c", sdev->vendor[i]);
208 seq_printf(s, " Model: ");
209 for (i = 0; i < 16; i++) {
210 if (sdev->model[i] >= 0x20)
211 seq_printf(s, "%c", sdev->model[i]);
216 seq_printf(s, " Rev: ");
217 for (i = 0; i < 4; i++) {
218 if (sdev->rev[i] >= 0x20)
219 seq_printf(s, "%c", sdev->rev[i]);
226 seq_printf(s, " Type: %s ", scsi_device_type(sdev->type));
227 seq_printf(s, " ANSI SCSI revision: %02x",
228 sdev->scsi_level - (sdev->scsi_level > 1));
229 if (sdev->scsi_level == 2)
230 seq_printf(s, " CCS\n");
239 * scsi_add_single_device - Respond to user request to probe for/add device
240 * @host: user-supplied decimal integer
241 * @channel: user-supplied decimal integer
242 * @id: user-supplied decimal integer
243 * @lun: user-supplied decimal integer
245 * Description: called by writing "scsi add-single-device" to /proc/scsi/scsi.
247 * does scsi_host_lookup() and either user_scan() if that transport
248 * type supports it, or else scsi_scan_host_selected()
250 * Note: this seems to be aimed exclusively at SCSI parallel busses.
253 static int scsi_add_single_device(uint host, uint channel, uint id, uint lun)
255 struct Scsi_Host *shost;
258 shost = scsi_host_lookup(host);
262 if (shost->transportt->user_scan)
263 error = shost->transportt->user_scan(shost, channel, id, lun);
265 error = scsi_scan_host_selected(shost, channel, id, lun, 1);
266 scsi_host_put(shost);
271 * scsi_remove_single_device - Respond to user request to remove a device
272 * @host: user-supplied decimal integer
273 * @channel: user-supplied decimal integer
274 * @id: user-supplied decimal integer
275 * @lun: user-supplied decimal integer
277 * Description: called by writing "scsi remove-single-device" to
278 * /proc/scsi/scsi. Does a scsi_device_lookup() and scsi_remove_device()
280 static int scsi_remove_single_device(uint host, uint channel, uint id, uint lun)
282 struct scsi_device *sdev;
283 struct Scsi_Host *shost;
286 shost = scsi_host_lookup(host);
289 sdev = scsi_device_lookup(shost, channel, id, lun);
291 scsi_remove_device(sdev);
292 scsi_device_put(sdev);
296 scsi_host_put(shost);
301 * proc_scsi_write - handle writes to /proc/scsi/scsi
303 * @buf: buffer to write
304 * @length: length of buf, at most PAGE_SIZE
307 * Description: this provides a legacy mechanism to add or remove devices by
308 * Host, Channel, ID, and Lun. To use,
309 * "echo 'scsi add-single-device 0 1 2 3' > /proc/scsi/scsi" or
310 * "echo 'scsi remove-single-device 0 1 2 3' > /proc/scsi/scsi" with
311 * "0 1 2 3" replaced by the Host, Channel, Id, and Lun.
313 * Note: this seems to be aimed at parallel SCSI. Most modern busses (USB,
314 * SATA, Firewire, Fibre Channel, etc) dynamically assign these values to
315 * provide a unique identifier and nothing more.
319 static ssize_t proc_scsi_write(struct file *file, const char __user *buf,
320 size_t length, loff_t *ppos)
322 int host, channel, id, lun;
326 if (!buf || length > PAGE_SIZE)
329 buffer = (char *)__get_free_page(GFP_KERNEL);
334 if (copy_from_user(buffer, buf, length))
338 if (length < PAGE_SIZE)
339 buffer[length] = '\0';
340 else if (buffer[PAGE_SIZE-1])
344 * Usage: echo "scsi add-single-device 0 1 2 3" >/proc/scsi/scsi
345 * with "0 1 2 3" replaced by your "Host Channel Id Lun".
347 if (!strncmp("scsi add-single-device", buffer, 22)) {
350 host = simple_strtoul(p, &p, 0);
351 channel = simple_strtoul(p + 1, &p, 0);
352 id = simple_strtoul(p + 1, &p, 0);
353 lun = simple_strtoul(p + 1, &p, 0);
355 err = scsi_add_single_device(host, channel, id, lun);
358 * Usage: echo "scsi remove-single-device 0 1 2 3" >/proc/scsi/scsi
359 * with "0 1 2 3" replaced by your "Host Channel Id Lun".
361 } else if (!strncmp("scsi remove-single-device", buffer, 25)) {
364 host = simple_strtoul(p, &p, 0);
365 channel = simple_strtoul(p + 1, &p, 0);
366 id = simple_strtoul(p + 1, &p, 0);
367 lun = simple_strtoul(p + 1, &p, 0);
369 err = scsi_remove_single_device(host, channel, id, lun);
373 * convert success returns so that we return the
374 * number of bytes consumed.
380 free_page((unsigned long)buffer);
385 * proc_scsi_show - show contents of /proc/scsi/scsi (attached devices)
386 * @s: output goes here
389 static int proc_scsi_show(struct seq_file *s, void *p)
391 seq_printf(s, "Attached devices:\n");
392 bus_for_each_dev(&scsi_bus_type, NULL, s, proc_print_scsidevice);
397 * proc_scsi_open - glue function
399 * @file: passed to single_open()
401 * Associates proc_scsi_show with this file
403 static int proc_scsi_open(struct inode *inode, struct file *file)
406 * We don't really need this for the write case but it doesn't
409 return single_open(file, proc_scsi_show, NULL);
412 static const struct file_operations proc_scsi_operations = {
413 .owner = THIS_MODULE,
414 .open = proc_scsi_open,
416 .write = proc_scsi_write,
418 .release = single_release,
422 * scsi_init_procfs - create scsi and scsi/scsi in procfs
424 int __init scsi_init_procfs(void)
426 struct proc_dir_entry *pde;
428 proc_scsi = proc_mkdir("scsi", NULL);
432 pde = proc_create("scsi/scsi", 0, NULL, &proc_scsi_operations);
439 remove_proc_entry("scsi", NULL);
445 * scsi_exit_procfs - Remove scsi/scsi and scsi from procfs
447 void scsi_exit_procfs(void)
449 remove_proc_entry("scsi/scsi", NULL);
450 remove_proc_entry("scsi", NULL);