1 /**************************************************************************/
2 /* File: proc.c - proc filesystem entries for CAN driver */
4 /* LinCAN - (Not only) Linux CAN bus driver */
5 /* Copyright (C) 2002-2009 DCE FEE CTU Prague <http://dce.felk.cvut.cz> */
6 /* Copyright (C) 2002-2009 Pavel Pisa <pisa@cmp.felk.cvut.cz> */
7 /* Funded by OCERA and FRESCOR IST projects */
8 /* Based on CAN driver code by Arnaud Westenberg <arnaud@wanadoo.nl> */
10 /* LinCAN is free software; you can redistribute it and/or modify it */
11 /* under terms of the GNU General Public License as published by the */
12 /* Free Software Foundation; either version 2, or (at your option) any */
13 /* later version. LinCAN is distributed in the hope that it will be */
14 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
15 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
16 /* General Public License for more details. You should have received a */
17 /* copy of the GNU General Public License along with LinCAN; see file */
18 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, */
19 /* Cambridge, MA 02139, USA. */
21 /* To allow use of LinCAN in the compact embedded systems firmware */
22 /* and RT-executives (RTEMS for example), main authors agree with next */
23 /* special exception: */
25 /* Including LinCAN header files in a file, instantiating LinCAN generics */
26 /* or templates, or linking other files with LinCAN objects to produce */
27 /* an application image/executable, does not by itself cause the */
28 /* resulting application image/executable to be covered by */
29 /* the GNU General Public License. */
30 /* This exception does not however invalidate any other reasons */
31 /* why the executable file might be covered by the GNU Public License. */
32 /* Publication of enhanced or derived LinCAN files is required although. */
33 /**************************************************************************/
35 #include "../include/can.h"
36 #include "../include/can_sysdep.h"
37 #include "../include/main.h"
38 #include "../include/proc.h"
39 #include "../include/setup.h"
41 #define __NO_VERSION__
42 #include <linux/module.h>
44 int add_channel_to_procdir(struct candevice_t *candev);
45 int remove_channel_from_procdir(void);
46 int add_object_to_procdir(int chip_nr);
47 int remove_object_from_procdir(int chip_nr);
49 #if (LINUX_VERSION_CODE <= KERNEL_VERSION(2,3,0))
50 static int can_proc_readlink(struct proc_dir_entry *ent, char *page);
53 #if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,25)
54 #define CAN_PROC_ROOT (&proc_root)
56 #define CAN_PROC_ROOT (NULL)
57 #endif /* >= 2.6.26 */
59 static int cc=0; /* static counter for each CAN chip */
61 static struct canproc_t can_proc_base;
62 static struct canproc_t *base=&can_proc_base;
64 /* The following functions are needed only for kernel version 2.2. Kernel
65 * version 2.4 already defines them for us.
67 #if (LINUX_VERSION_CODE <= KERNEL_VERSION(2,3,0))
68 static void can_fill_inode(struct inode *inode, int fill)
76 static struct proc_dir_entry * can_create_proc_entry(const char *name, mode_t mode,
77 struct proc_dir_entry *parent)
79 struct proc_dir_entry *new_entry = NULL;
89 new_entry = (struct proc_dir_entry *)
90 can_checked_malloc(sizeof(struct proc_dir_entry)+namelen+1);
92 if (new_entry == NULL)
95 memset(new_entry, 0, sizeof(struct proc_dir_entry));
97 /* Store copy of the proc entry name */
98 namestore = ((char *) new_entry) + sizeof(struct proc_dir_entry);
99 memcpy(namestore, name, namelen + 1);
101 new_entry->low_ino = 0;
102 new_entry->namelen = namelen;
103 new_entry->name = namestore;
104 new_entry->mode = mode;
105 new_entry->nlink = 0;
106 new_entry->fill_inode = can_fill_inode;
107 new_entry->parent = parent;
109 proc_register(parent, new_entry);
114 struct proc_dir_entry *can_create_proc_read_entry(const char *name,
115 mode_t mode, struct proc_dir_entry *parent,
116 read_proc_t *read_proc, void * data)
118 return create_proc_read_entry(name, mode, parent, read_proc, data);
121 struct proc_dir_entry *can_proc_mkdir_mode(const char *name, umode_t mode,
122 struct proc_dir_entry *parent)
124 return can_create_proc_entry(name, S_IFDIR | mode, parent);
127 static int can_proc_remove(struct proc_dir_entry *del)
130 proc_unregister(del->parent, del->low_ino);
131 can_checked_free(del);
138 static int can_proc_readlink(struct proc_dir_entry *ent, char *page)
140 char *link_dest = (char*)ent->data;
142 strcpy(page, link_dest);
143 return strlen(link_dest);
148 /* This compatibility version of proc_symlink does not store local copy of destination */
149 static inline struct proc_dir_entry *can_proc_symlink(const char *name,
150 struct proc_dir_entry *parent, const char *dest)
152 struct proc_dir_entry *entry;
155 entry = can_create_proc_entry(name, S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO, parent);
158 entry->readlink_proc = can_proc_readlink;
163 #elif (LINUX_VERSION_CODE < KERNEL_VERSION(3,10,0))
165 struct proc_dir_entry *can_create_proc_read_entry(const char *name,
166 mode_t mode, struct proc_dir_entry *parent,
167 read_proc_t *read_proc, void * data)
169 return create_proc_read_entry(name, mode, parent, read_proc, data);
172 struct proc_dir_entry *can_proc_mkdir_mode(const char *name, umode_t mode,
173 struct proc_dir_entry *parent)
175 return create_proc_entry(name, S_IFDIR | mode, parent);
178 /* This does not fully follow linux 2.4 and 2.6 prototype to simplify 2.2.x compatibility */
179 /* The newer kernels use entry name instead of pointer to the entry */
180 static int can_proc_remove(struct proc_dir_entry *del)
182 if(!del) return -ENODEV;
183 remove_proc_entry(del->name, del->parent);
187 static inline struct proc_dir_entry *can_proc_symlink(const char *name,
188 struct proc_dir_entry *parent, const char *dest)
190 return proc_symlink(name, parent, dest);
193 #else /* Linux kernel 3.10+ */
195 #include <linux/seq_file.h>
197 static int can_status_proc_show(struct seq_file *m, void *v)
199 seq_printf(m, "dummy CAN can_create_proc_read_entry implementation\n");
203 static int can_status_proc_open(struct inode *inode, struct file *file)
205 return single_open(file, can_status_proc_show, PDE_DATA(inode));
208 static const struct file_operations can_status_proc_fops = {
209 .owner = THIS_MODULE,
210 .open = can_status_proc_open,
213 .release = single_release,
216 struct proc_dir_entry *can_create_proc_read_entry(const char *name,
217 mode_t mode, struct proc_dir_entry *parent,
218 void *read_proc, void * data)
220 /*return proc_read_entry(name, mode, parent, read_proc, data);*/
221 return proc_create_data(name, mode, parent, &can_status_proc_fops, data);
224 struct proc_dir_entry *can_proc_mkdir_mode(const char *name, umode_t mode,
225 struct proc_dir_entry *parent)
227 return proc_mkdir_mode(name, mode, parent);
230 static int can_proc_remove(struct proc_dir_entry *del)
232 if(!del) return -ENODEV;
237 static inline struct proc_dir_entry *can_proc_symlink(const char *name,
238 struct proc_dir_entry *parent, const char *dest)
240 return proc_symlink(name, parent, dest);
243 #endif /* Functions required for kernel 2.2 */
245 /* can_init_procdir registers the entire CAN directory tree recursively at
248 int can_init_procdir(void)
251 struct candevice_t *candev;
252 base->can_proc_entry = can_proc_mkdir_mode("can", S_IFDIR | S_IRUGO |
253 S_IXUGO, CAN_PROC_ROOT);
254 if (base->can_proc_entry == NULL)
257 for (board=0; board<hardware_p->nr_boards; board++) {
258 candev=hardware_p->candevice[board];
259 if(candev) add_channel_to_procdir(candev);
265 /* can_delete_procdir removes the entire CAN tree from the proc system */
266 int can_delete_procdir(void)
268 if (remove_channel_from_procdir())
271 if (can_proc_remove(base->can_proc_entry))
277 static int can_chip_procinfo(char *buf, char **start, off_t offset,
278 int count, int *eof, void *data)
280 struct canchip_t *chip=data;
283 /* Generic chip info */
284 len += sprintf(buf+len,"type : %s\n",chip->chip_type);
285 len += sprintf(buf+len,"index : %d\n",chip->chip_idx);
286 len += sprintf(buf+len,"irq : %d\n",chip->chip_irq);
287 len += sprintf(buf+len,"addr : %lu\n",
288 can_ioptr2ulong(chip->chip_base_addr));
289 len += sprintf(buf+len,"config : %s\n",
290 (chip->flags & CHIP_CONFIGURED) ? "yes":"no");
291 len += sprintf(buf+len,"clock : %ld Hz\n",chip->clock);
292 len += sprintf(buf+len,"baud : %ld\n",chip->baudrate);
293 len += sprintf(buf+len,"num obj : %d\n",chip->max_objects);
297 /* Chip specific info if available */
298 if(chip->chipspecops->get_info)
299 len += (chip->chipspecops->get_info)(chip,buf+len);
307 int add_channel_to_procdir(struct candevice_t *candev)
311 for (i=0; i < candev->nr_all_chips; i++) {
313 base->channel[cc] = (struct channelproc_t *)
314 can_checked_malloc(sizeof(struct channelproc_t));
315 if (base->channel[cc] == NULL)
318 sprintf(base->channel[cc]->ch_name, "channel%d",cc);
320 base->channel[cc]->ch_entry = can_proc_mkdir_mode(
321 base->channel[cc]->ch_name,
322 S_IFDIR | S_IRUGO |S_IXUGO,
323 base->can_proc_entry);
325 if (base->channel[cc]->ch_entry == NULL)
328 add_object_to_procdir(cc);
330 can_create_proc_read_entry("chip_info", /* proc entry name */
331 0, /* protection mask, 0->default */
332 base->channel[cc]->ch_entry, /* parent dir, NULL->/proc */
342 int remove_channel_from_procdir(void)
348 if(!base->channel[cc]) continue;
350 remove_proc_entry("chip_info", base->channel[cc]->ch_entry);
352 if (remove_object_from_procdir(cc))
355 /* name: base->channel[cc]->ch_name */
356 if (can_proc_remove(base->channel[cc]->ch_entry))
359 can_checked_free(base->channel[cc]);
360 base->channel[cc] = NULL;
367 int add_object_to_procdir(int chip_nr)
371 max_objects=chips_p[chip_nr]->max_objects;
373 for (i=0; i<max_objects; i++) {
374 base->channel[chip_nr]->object[i] = (struct objectproc_t *)
375 can_checked_malloc(sizeof(struct objectproc_t));
377 if (base->channel[chip_nr]->object[i] == NULL)
380 sprintf(base->channel[chip_nr]->object[i]->obj_name,"object%d",i);
381 sprintf(base->channel[chip_nr]->object[i]->lnk_name,"dev");
383 base->channel[chip_nr]->object[i]->obj_entry = can_proc_mkdir_mode(
384 base->channel[chip_nr]->object[i]->obj_name,
385 S_IFDIR | S_IRUGO | S_IXUGO,
386 base->channel[chip_nr]->ch_entry);
387 if (base->channel[chip_nr]->object[i]->obj_entry == NULL)
390 sprintf(base->channel[chip_nr]->object[i]->lnk_dev,"/dev/can%d",
391 chips_p[chip_nr]->msgobj[i]->minor);
393 base->channel[chip_nr]->object[i]->lnk = can_proc_symlink(
394 base->channel[chip_nr]->object[i]->lnk_name,
395 base->channel[chip_nr]->object[i]->obj_entry,
396 base->channel[chip_nr]->object[i]->lnk_dev);
397 if (base->channel[chip_nr]->object[i]->lnk == NULL)
404 int remove_object_from_procdir(int chip_nr)
408 obj=chips_p[chip_nr]->max_objects;
410 for (i=0; i<obj; i++) {
411 if(!base->channel[chip_nr]->object[i]) continue;
413 /* name: base->channel[chip_nr]->object[i]->lnk_name */
414 if (can_proc_remove( base->channel[chip_nr]->object[i]->lnk))
416 /* name: base->channel[chip_nr]->object[i]->obj_name */
417 if (can_proc_remove(base->channel[chip_nr]->object[i]->obj_entry))
420 can_checked_free(base->channel[chip_nr]->object[i]);
422 base->channel[chip_nr]->object[i]=NULL;