Merge ../linux-2.6
[linux-2.6] / drivers / scsi / scsi_proc.c
1 /*
2  * linux/drivers/scsi/scsi_proc.c
3  *
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.
8  *
9  * (c) 1995 Michael Neuffer neuffer@goofy.zdv.uni-mainz.de 
10  * Version: 0.99.8   last change: 95/09/13
11  * 
12  * generic command parser provided by: 
13  * Andreas Heilwagen <crashcar@informatik.uni-koblenz.de>
14  *
15  * generic_proc_info() support of xxxx_info() by:
16  * Michael A. Griffith <grif@acm.org>
17  */
18
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/string.h>
22 #include <linux/mm.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>
30
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_device.h>
33 #include <scsi/scsi_host.h>
34 #include <scsi/scsi_transport.h>
35
36 #include "scsi_priv.h"
37 #include "scsi_logging.h"
38
39
40 /* 4K page size, but our output routines, use some slack for overruns */
41 #define PROC_BLOCK_SIZE (3*1024)
42
43 static struct proc_dir_entry *proc_scsi;
44
45 /* Protect sht->present and sht->proc_dir */
46 static DEFINE_MUTEX(global_host_template_mutex);
47
48 static int proc_scsi_read(char *buffer, char **start, off_t offset,
49                           int length, int *eof, void *data)
50 {
51         struct Scsi_Host *shost = data;
52         int n;
53
54         n = shost->hostt->proc_info(shost, buffer, start, offset, length, 0);
55         *eof = (n < length);
56
57         return n;
58 }
59
60 static int proc_scsi_write_proc(struct file *file, const char __user *buf,
61                            unsigned long count, void *data)
62 {
63         struct Scsi_Host *shost = data;
64         ssize_t ret = -ENOMEM;
65         char *page;
66         char *start;
67     
68         if (count > PROC_BLOCK_SIZE)
69                 return -EOVERFLOW;
70
71         page = (char *)__get_free_page(GFP_KERNEL);
72         if (page) {
73                 ret = -EFAULT;
74                 if (copy_from_user(page, buf, count))
75                         goto out;
76                 ret = shost->hostt->proc_info(shost, page, &start, 0, count, 1);
77         }
78 out:
79         free_page((unsigned long)page);
80         return ret;
81 }
82
83 void scsi_proc_hostdir_add(struct scsi_host_template *sht)
84 {
85         if (!sht->proc_info)
86                 return;
87
88         mutex_lock(&global_host_template_mutex);
89         if (!sht->present++) {
90                 sht->proc_dir = proc_mkdir(sht->proc_name, proc_scsi);
91                 if (!sht->proc_dir)
92                         printk(KERN_ERR "%s: proc_mkdir failed for %s\n",
93                                __FUNCTION__, sht->proc_name);
94                 else
95                         sht->proc_dir->owner = sht->module;
96         }
97         mutex_unlock(&global_host_template_mutex);
98 }
99
100 void scsi_proc_hostdir_rm(struct scsi_host_template *sht)
101 {
102         if (!sht->proc_info)
103                 return;
104
105         mutex_lock(&global_host_template_mutex);
106         if (!--sht->present && sht->proc_dir) {
107                 remove_proc_entry(sht->proc_name, proc_scsi);
108                 sht->proc_dir = NULL;
109         }
110         mutex_unlock(&global_host_template_mutex);
111 }
112
113 void scsi_proc_host_add(struct Scsi_Host *shost)
114 {
115         struct scsi_host_template *sht = shost->hostt;
116         struct proc_dir_entry *p;
117         char name[10];
118
119         if (!sht->proc_dir)
120                 return;
121
122         sprintf(name,"%d", shost->host_no);
123         p = create_proc_read_entry(name, S_IFREG | S_IRUGO | S_IWUSR,
124                         sht->proc_dir, proc_scsi_read, shost);
125         if (!p) {
126                 printk(KERN_ERR "%s: Failed to register host %d in"
127                        "%s\n", __FUNCTION__, shost->host_no,
128                        sht->proc_name);
129                 return;
130         } 
131
132         p->write_proc = proc_scsi_write_proc;
133         p->owner = sht->module;
134 }
135
136 void scsi_proc_host_rm(struct Scsi_Host *shost)
137 {
138         char name[10];
139
140         if (!shost->hostt->proc_dir)
141                 return;
142
143         sprintf(name,"%d", shost->host_no);
144         remove_proc_entry(name, shost->hostt->proc_dir);
145 }
146
147 static int proc_print_scsidevice(struct device *dev, void *data)
148 {
149         struct scsi_device *sdev = to_scsi_device(dev);
150         struct seq_file *s = data;
151         int i;
152
153         seq_printf(s,
154                 "Host: scsi%d Channel: %02d Id: %02d Lun: %02d\n  Vendor: ",
155                 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
156         for (i = 0; i < 8; i++) {
157                 if (sdev->vendor[i] >= 0x20)
158                         seq_printf(s, "%c", sdev->vendor[i]);
159                 else
160                         seq_printf(s, " ");
161         }
162
163         seq_printf(s, " Model: ");
164         for (i = 0; i < 16; i++) {
165                 if (sdev->model[i] >= 0x20)
166                         seq_printf(s, "%c", sdev->model[i]);
167                 else
168                         seq_printf(s, " ");
169         }
170
171         seq_printf(s, " Rev: ");
172         for (i = 0; i < 4; i++) {
173                 if (sdev->rev[i] >= 0x20)
174                         seq_printf(s, "%c", sdev->rev[i]);
175                 else
176                         seq_printf(s, " ");
177         }
178
179         seq_printf(s, "\n");
180
181         seq_printf(s, "  Type:   %s ",
182                      sdev->type < MAX_SCSI_DEVICE_CODE ?
183                scsi_device_types[(int) sdev->type] : "Unknown          ");
184         seq_printf(s, "               ANSI"
185                      " SCSI revision: %02x", (sdev->scsi_level - 1) ?
186                      sdev->scsi_level - 1 : 1);
187         if (sdev->scsi_level == 2)
188                 seq_printf(s, " CCS\n");
189         else
190                 seq_printf(s, "\n");
191
192         return 0;
193 }
194
195 static int scsi_add_single_device(uint host, uint channel, uint id, uint lun)
196 {
197         struct Scsi_Host *shost;
198         int error = -ENXIO;
199
200         shost = scsi_host_lookup(host);
201         if (IS_ERR(shost))
202                 return PTR_ERR(shost);
203
204         if (shost->transportt->user_scan)
205                 error = shost->transportt->user_scan(shost, channel, id, lun);
206         else
207                 error = scsi_scan_host_selected(shost, channel, id, lun, 1);
208         scsi_host_put(shost);
209         return error;
210 }
211
212 static int scsi_remove_single_device(uint host, uint channel, uint id, uint lun)
213 {
214         struct scsi_device *sdev;
215         struct Scsi_Host *shost;
216         int error = -ENXIO;
217
218         shost = scsi_host_lookup(host);
219         if (IS_ERR(shost))
220                 return PTR_ERR(shost);
221         sdev = scsi_device_lookup(shost, channel, id, lun);
222         if (sdev) {
223                 scsi_remove_device(sdev);
224                 scsi_device_put(sdev);
225                 error = 0;
226         }
227
228         scsi_host_put(shost);
229         return error;
230 }
231
232 static ssize_t proc_scsi_write(struct file *file, const char __user *buf,
233                                size_t length, loff_t *ppos)
234 {
235         int host, channel, id, lun;
236         char *buffer, *p;
237         int err;
238
239         if (!buf || length > PAGE_SIZE)
240                 return -EINVAL;
241
242         buffer = (char *)__get_free_page(GFP_KERNEL);
243         if (!buffer)
244                 return -ENOMEM;
245
246         err = -EFAULT;
247         if (copy_from_user(buffer, buf, length))
248                 goto out;
249
250         err = -EINVAL;
251         if (length < PAGE_SIZE)
252                 buffer[length] = '\0';
253         else if (buffer[PAGE_SIZE-1])
254                 goto out;
255
256         /*
257          * Usage: echo "scsi add-single-device 0 1 2 3" >/proc/scsi/scsi
258          * with  "0 1 2 3" replaced by your "Host Channel Id Lun".
259          */
260         if (!strncmp("scsi add-single-device", buffer, 22)) {
261                 p = buffer + 23;
262
263                 host = simple_strtoul(p, &p, 0);
264                 channel = simple_strtoul(p + 1, &p, 0);
265                 id = simple_strtoul(p + 1, &p, 0);
266                 lun = simple_strtoul(p + 1, &p, 0);
267
268                 err = scsi_add_single_device(host, channel, id, lun);
269
270         /*
271          * Usage: echo "scsi remove-single-device 0 1 2 3" >/proc/scsi/scsi
272          * with  "0 1 2 3" replaced by your "Host Channel Id Lun".
273          */
274         } else if (!strncmp("scsi remove-single-device", buffer, 25)) {
275                 p = buffer + 26;
276
277                 host = simple_strtoul(p, &p, 0);
278                 channel = simple_strtoul(p + 1, &p, 0);
279                 id = simple_strtoul(p + 1, &p, 0);
280                 lun = simple_strtoul(p + 1, &p, 0);
281
282                 err = scsi_remove_single_device(host, channel, id, lun);
283         }
284
285         /*
286          * convert success returns so that we return the 
287          * number of bytes consumed.
288          */
289         if (!err)
290                 err = length;
291
292  out:
293         free_page((unsigned long)buffer);
294         return err;
295 }
296
297 static int proc_scsi_show(struct seq_file *s, void *p)
298 {
299         seq_printf(s, "Attached devices:\n");
300         bus_for_each_dev(&scsi_bus_type, NULL, s, proc_print_scsidevice);
301         return 0;
302 }
303
304 static int proc_scsi_open(struct inode *inode, struct file *file)
305 {
306         /*
307          * We don't really needs this for the write case but it doesn't
308          * harm either.
309          */
310         return single_open(file, proc_scsi_show, NULL);
311 }
312
313 static struct file_operations proc_scsi_operations = {
314         .open           = proc_scsi_open,
315         .read           = seq_read,
316         .write          = proc_scsi_write,
317         .llseek         = seq_lseek,
318         .release        = single_release,
319 };
320
321 int __init scsi_init_procfs(void)
322 {
323         struct proc_dir_entry *pde;
324
325         proc_scsi = proc_mkdir("scsi", NULL);
326         if (!proc_scsi)
327                 goto err1;
328
329         pde = create_proc_entry("scsi/scsi", 0, NULL);
330         if (!pde)
331                 goto err2;
332         pde->proc_fops = &proc_scsi_operations;
333
334         return 0;
335
336 err2:
337         remove_proc_entry("scsi", NULL);
338 err1:
339         return -ENOMEM;
340 }
341
342 void scsi_exit_procfs(void)
343 {
344         remove_proc_entry("scsi/scsi", NULL);
345         remove_proc_entry("scsi", NULL);
346 }