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
);
48 static ssize_t
proc_scsi_host_write(struct file
*file
, const char __user
*buf
,
49 size_t count
, loff_t
*ppos
)
51 struct Scsi_Host
*shost
= PDE_DATA(file_inode(file
));
52 ssize_t ret
= -ENOMEM
;
55 if (count
> PROC_BLOCK_SIZE
)
58 if (!shost
->hostt
->write_info
)
61 page
= (char *)__get_free_page(GFP_KERNEL
);
64 if (copy_from_user(page
, buf
, count
))
66 ret
= shost
->hostt
->write_info(shost
, page
, count
);
69 free_page((unsigned long)page
);
73 static int proc_scsi_show(struct seq_file
*m
, void *v
)
75 struct Scsi_Host
*shost
= m
->private;
76 return shost
->hostt
->show_info(m
, shost
);
79 static int proc_scsi_host_open(struct inode
*inode
, struct file
*file
)
81 return single_open_size(file
, proc_scsi_show
, PDE_DATA(inode
),
85 static const struct file_operations proc_scsi_fops
= {
86 .open
= proc_scsi_host_open
,
89 .write
= proc_scsi_host_write
93 * scsi_proc_hostdir_add - Create directory in /proc for a scsi host
94 * @sht: owner of this directory
96 * Sets sht->proc_dir to the new directory.
99 void scsi_proc_hostdir_add(struct scsi_host_template
*sht
)
104 mutex_lock(&global_host_template_mutex
);
105 if (!sht
->present
++) {
106 sht
->proc_dir
= proc_mkdir(sht
->proc_name
, proc_scsi
);
108 printk(KERN_ERR
"%s: proc_mkdir failed for %s\n",
109 __func__
, sht
->proc_name
);
111 mutex_unlock(&global_host_template_mutex
);
115 * scsi_proc_hostdir_rm - remove directory in /proc for a scsi host
116 * @sht: owner of directory
118 void scsi_proc_hostdir_rm(struct scsi_host_template
*sht
)
123 mutex_lock(&global_host_template_mutex
);
124 if (!--sht
->present
&& sht
->proc_dir
) {
125 remove_proc_entry(sht
->proc_name
, proc_scsi
);
126 sht
->proc_dir
= NULL
;
128 mutex_unlock(&global_host_template_mutex
);
133 * scsi_proc_host_add - Add entry for this host to appropriate /proc dir
134 * @shost: host to add
136 void scsi_proc_host_add(struct Scsi_Host
*shost
)
138 struct scsi_host_template
*sht
= shost
->hostt
;
139 struct proc_dir_entry
*p
;
145 sprintf(name
,"%d", shost
->host_no
);
146 p
= proc_create_data(name
, S_IRUGO
| S_IWUSR
,
147 sht
->proc_dir
, &proc_scsi_fops
, shost
);
149 printk(KERN_ERR
"%s: Failed to register host %d in"
150 "%s\n", __func__
, shost
->host_no
,
155 * scsi_proc_host_rm - remove this host's entry from /proc
158 void scsi_proc_host_rm(struct Scsi_Host
*shost
)
162 if (!shost
->hostt
->proc_dir
)
165 sprintf(name
,"%d", shost
->host_no
);
166 remove_proc_entry(name
, shost
->hostt
->proc_dir
);
169 * proc_print_scsidevice - return data about this host
170 * @dev: A scsi device
171 * @data: &struct seq_file to output to.
173 * Description: prints Host, Channel, Id, Lun, Vendor, Model, Rev, Type,
176 static int proc_print_scsidevice(struct device
*dev
, void *data
)
178 struct scsi_device
*sdev
;
179 struct seq_file
*s
= data
;
182 if (!scsi_is_sdev_device(dev
))
185 sdev
= to_scsi_device(dev
);
187 "Host: scsi%d Channel: %02d Id: %02d Lun: %02d\n Vendor: ",
188 sdev
->host
->host_no
, sdev
->channel
, sdev
->id
, sdev
->lun
);
189 for (i
= 0; i
< 8; i
++) {
190 if (sdev
->vendor
[i
] >= 0x20)
191 seq_printf(s
, "%c", sdev
->vendor
[i
]);
196 seq_printf(s
, " Model: ");
197 for (i
= 0; i
< 16; i
++) {
198 if (sdev
->model
[i
] >= 0x20)
199 seq_printf(s
, "%c", sdev
->model
[i
]);
204 seq_printf(s
, " Rev: ");
205 for (i
= 0; i
< 4; i
++) {
206 if (sdev
->rev
[i
] >= 0x20)
207 seq_printf(s
, "%c", sdev
->rev
[i
]);
214 seq_printf(s
, " Type: %s ", scsi_device_type(sdev
->type
));
215 seq_printf(s
, " ANSI SCSI revision: %02x",
216 sdev
->scsi_level
- (sdev
->scsi_level
> 1));
217 if (sdev
->scsi_level
== 2)
218 seq_printf(s
, " CCS\n");
227 * scsi_add_single_device - Respond to user request to probe for/add device
228 * @host: user-supplied decimal integer
229 * @channel: user-supplied decimal integer
230 * @id: user-supplied decimal integer
231 * @lun: user-supplied decimal integer
233 * Description: called by writing "scsi add-single-device" to /proc/scsi/scsi.
235 * does scsi_host_lookup() and either user_scan() if that transport
236 * type supports it, or else scsi_scan_host_selected()
238 * Note: this seems to be aimed exclusively at SCSI parallel busses.
241 static int scsi_add_single_device(uint host
, uint channel
, uint id
, uint lun
)
243 struct Scsi_Host
*shost
;
246 shost
= scsi_host_lookup(host
);
250 if (shost
->transportt
->user_scan
)
251 error
= shost
->transportt
->user_scan(shost
, channel
, id
, lun
);
253 error
= scsi_scan_host_selected(shost
, channel
, id
, lun
, 1);
254 scsi_host_put(shost
);
259 * scsi_remove_single_device - Respond to user request to remove a device
260 * @host: user-supplied decimal integer
261 * @channel: user-supplied decimal integer
262 * @id: user-supplied decimal integer
263 * @lun: user-supplied decimal integer
265 * Description: called by writing "scsi remove-single-device" to
266 * /proc/scsi/scsi. Does a scsi_device_lookup() and scsi_remove_device()
268 static int scsi_remove_single_device(uint host
, uint channel
, uint id
, uint lun
)
270 struct scsi_device
*sdev
;
271 struct Scsi_Host
*shost
;
274 shost
= scsi_host_lookup(host
);
277 sdev
= scsi_device_lookup(shost
, channel
, id
, lun
);
279 scsi_remove_device(sdev
);
280 scsi_device_put(sdev
);
284 scsi_host_put(shost
);
289 * proc_scsi_write - handle writes to /proc/scsi/scsi
291 * @buf: buffer to write
292 * @length: length of buf, at most PAGE_SIZE
295 * Description: this provides a legacy mechanism to add or remove devices by
296 * Host, Channel, ID, and Lun. To use,
297 * "echo 'scsi add-single-device 0 1 2 3' > /proc/scsi/scsi" or
298 * "echo 'scsi remove-single-device 0 1 2 3' > /proc/scsi/scsi" with
299 * "0 1 2 3" replaced by the Host, Channel, Id, and Lun.
301 * Note: this seems to be aimed at parallel SCSI. Most modern busses (USB,
302 * SATA, Firewire, Fibre Channel, etc) dynamically assign these values to
303 * provide a unique identifier and nothing more.
307 static ssize_t
proc_scsi_write(struct file
*file
, const char __user
*buf
,
308 size_t length
, loff_t
*ppos
)
310 int host
, channel
, id
, lun
;
314 if (!buf
|| length
> PAGE_SIZE
)
317 buffer
= (char *)__get_free_page(GFP_KERNEL
);
322 if (copy_from_user(buffer
, buf
, length
))
326 if (length
< PAGE_SIZE
)
327 buffer
[length
] = '\0';
328 else if (buffer
[PAGE_SIZE
-1])
332 * Usage: echo "scsi add-single-device 0 1 2 3" >/proc/scsi/scsi
333 * with "0 1 2 3" replaced by your "Host Channel Id Lun".
335 if (!strncmp("scsi add-single-device", buffer
, 22)) {
338 host
= simple_strtoul(p
, &p
, 0);
339 channel
= simple_strtoul(p
+ 1, &p
, 0);
340 id
= simple_strtoul(p
+ 1, &p
, 0);
341 lun
= simple_strtoul(p
+ 1, &p
, 0);
343 err
= scsi_add_single_device(host
, channel
, id
, lun
);
346 * Usage: echo "scsi remove-single-device 0 1 2 3" >/proc/scsi/scsi
347 * with "0 1 2 3" replaced by your "Host Channel Id Lun".
349 } else if (!strncmp("scsi remove-single-device", buffer
, 25)) {
352 host
= simple_strtoul(p
, &p
, 0);
353 channel
= simple_strtoul(p
+ 1, &p
, 0);
354 id
= simple_strtoul(p
+ 1, &p
, 0);
355 lun
= simple_strtoul(p
+ 1, &p
, 0);
357 err
= scsi_remove_single_device(host
, channel
, id
, lun
);
361 * convert success returns so that we return the
362 * number of bytes consumed.
368 free_page((unsigned long)buffer
);
372 static int always_match(struct device
*dev
, void *data
)
377 static inline struct device
*next_scsi_device(struct device
*start
)
379 struct device
*next
= bus_find_device(&scsi_bus_type
, start
, NULL
,
385 static void *scsi_seq_start(struct seq_file
*sfile
, loff_t
*pos
)
387 struct device
*dev
= NULL
;
390 while ((dev
= next_scsi_device(dev
))) {
398 static void *scsi_seq_next(struct seq_file
*sfile
, void *v
, loff_t
*pos
)
402 return next_scsi_device(v
);
405 static void scsi_seq_stop(struct seq_file
*sfile
, void *v
)
410 static int scsi_seq_show(struct seq_file
*sfile
, void *dev
)
413 seq_puts(sfile
, "Attached devices:\n");
415 return proc_print_scsidevice(dev
, sfile
);
418 static const struct seq_operations scsi_seq_ops
= {
419 .start
= scsi_seq_start
,
420 .next
= scsi_seq_next
,
421 .stop
= scsi_seq_stop
,
422 .show
= scsi_seq_show
426 * proc_scsi_open - glue function
428 * @file: passed to single_open()
430 * Associates proc_scsi_show with this file
432 static int proc_scsi_open(struct inode
*inode
, struct file
*file
)
435 * We don't really need this for the write case but it doesn't
438 return seq_open(file
, &scsi_seq_ops
);
441 static const struct file_operations proc_scsi_operations
= {
442 .owner
= THIS_MODULE
,
443 .open
= proc_scsi_open
,
445 .write
= proc_scsi_write
,
447 .release
= seq_release
,
451 * scsi_init_procfs - create scsi and scsi/scsi in procfs
453 int __init
scsi_init_procfs(void)
455 struct proc_dir_entry
*pde
;
457 proc_scsi
= proc_mkdir("scsi", NULL
);
461 pde
= proc_create("scsi/scsi", 0, NULL
, &proc_scsi_operations
);
468 remove_proc_entry("scsi", NULL
);
474 * scsi_exit_procfs - Remove scsi/scsi and scsi from procfs
476 void scsi_exit_procfs(void)
478 remove_proc_entry("scsi/scsi", NULL
);
479 remove_proc_entry("scsi", NULL
);