1 /* $Id: hysdn_procconf.c,v 1.8.6.4 2001/09/23 22:24:54 kai Exp $
3 * Linux driver for HYSDN cards, /proc/net filesystem dir and conf functions.
5 * written by Werner Cornelius (werner@titro.de) for Hypercope GmbH
7 * Copyright 1999 by Werner Cornelius (werner@titro.de)
9 * This software may be used and distributed according to the terms
10 * of the GNU General Public License, incorporated herein by reference.
14 #include <linux/module.h>
15 #include <linux/version.h>
16 #include <linux/poll.h>
17 #include <linux/proc_fs.h>
18 #include <linux/pci.h>
19 #include <linux/smp_lock.h>
21 #include "hysdn_defs.h"
23 static char *hysdn_procconf_revision = "$Revision: 1.8.6.4 $";
25 #define INFO_OUT_LEN 80 /* length of info line including lf */
27 /********************************************************/
28 /* defines and data structure for conf write operations */
29 /********************************************************/
30 #define CONF_STATE_DETECT 0 /* waiting for detect */
31 #define CONF_STATE_CONF 1 /* writing config data */
32 #define CONF_STATE_POF 2 /* writing pof data */
33 #define CONF_LINE_LEN 255 /* 255 chars max */
35 struct conf_writedata {
36 hysdn_card *card; /* card the device is connected to */
37 int buf_size; /* actual number of bytes in the buffer */
38 int needed_size; /* needed size when reading pof */
39 int state; /* actual interface states from above constants */
40 uchar conf_line[CONF_LINE_LEN]; /* buffered conf line */
41 word channel; /* active channel number */
42 uchar *pof_buffer; /* buffer when writing pof */
45 /***********************************************************************/
46 /* process_line parses one config line and transfers it to the card if */
48 /* if the return value is negative an error occurred. */
49 /***********************************************************************/
51 process_line(struct conf_writedata *cnf)
53 uchar *cp = cnf->conf_line;
56 if (cnf->card->debug_flags & LOG_CNF_LINE)
57 hysdn_addlog(cnf->card, "conf line: %s", cp);
59 if (*cp == '-') { /* option */
60 cp++; /* point to option char */
63 return (0); /* option unknown or used */
64 i = 0; /* start value for channel */
65 while ((*cp <= '9') && (*cp >= '0'))
66 i = i * 10 + *cp++ - '0'; /* get decimal number */
68 if (cnf->card->debug_flags & LOG_CNF_MISC)
69 hysdn_addlog(cnf->card, "conf channel invalid %d", i);
70 return (-ERR_INV_CHAN); /* invalid channel */
72 cnf->channel = i & 0xFFFF; /* set new channel number */
73 return (0); /* success */
75 if (*cp == '*') { /* line to send */
76 if (cnf->card->debug_flags & LOG_CNF_DATA)
77 hysdn_addlog(cnf->card, "conf chan=%d %s", cnf->channel, cp);
78 return (hysdn_tx_cfgline(cnf->card, cnf->conf_line + 1,
79 cnf->channel)); /* send the line without * */
84 /***********************************/
85 /* conf file operations and tables */
86 /***********************************/
88 /****************************************************/
89 /* write conf file -> boot or send cfg line to card */
90 /****************************************************/
92 hysdn_conf_write(struct file *file, const char *buf, size_t count, loff_t * off)
94 struct conf_writedata *cnf;
98 if (&file->f_pos != off) /* fs error check */
101 return (0); /* nothing to handle */
103 if (!(cnf = file->private_data))
104 return (-EFAULT); /* should never happen */
106 if (cnf->state == CONF_STATE_DETECT) { /* auto detect cnf or pof data */
107 if (copy_from_user(&ch, buf, 1)) /* get first char for detect */
111 /* we detected a pof file */
112 if ((cnf->needed_size = pof_write_open(cnf->card, &cnf->pof_buffer)) <= 0)
113 return (cnf->needed_size); /* an error occurred -> exit */
114 cnf->buf_size = 0; /* buffer is empty */
115 cnf->state = CONF_STATE_POF; /* new state */
117 /* conf data has been detected */
118 cnf->buf_size = 0; /* buffer is empty */
119 cnf->state = CONF_STATE_CONF; /* requested conf data write */
120 if (cnf->card->state != CARD_STATE_RUN)
121 return (-ERR_NOT_BOOTED);
122 cnf->conf_line[CONF_LINE_LEN - 1] = 0; /* limit string length */
123 cnf->channel = 4098; /* default channel for output */
125 } /* state was auto detect */
126 if (cnf->state == CONF_STATE_POF) { /* pof write active */
127 i = cnf->needed_size - cnf->buf_size; /* bytes still missing for write */
129 return (-EINVAL); /* size error handling pof */
132 count = i; /* limit requested number of bytes */
133 if (copy_from_user(cnf->pof_buffer + cnf->buf_size, buf, count))
134 return (-EFAULT); /* error while copying */
135 cnf->buf_size += count;
137 if (cnf->needed_size == cnf->buf_size) {
138 cnf->needed_size = pof_write_buffer(cnf->card, cnf->buf_size); /* write data */
139 if (cnf->needed_size <= 0) {
140 cnf->card->state = CARD_STATE_BOOTERR; /* show boot error */
141 return (cnf->needed_size); /* an error occurred */
143 cnf->buf_size = 0; /* buffer is empty again */
146 /* pof write active */
147 else { /* conf write active */
149 if (cnf->card->state != CARD_STATE_RUN) {
150 if (cnf->card->debug_flags & LOG_CNF_MISC)
151 hysdn_addlog(cnf->card, "cnf write denied -> not booted");
152 return (-ERR_NOT_BOOTED);
154 i = (CONF_LINE_LEN - 1) - cnf->buf_size; /* bytes available in buffer */
156 /* copy remaining bytes into buffer */
159 count = i; /* limit transfer */
160 if (copy_from_user(cnf->conf_line + cnf->buf_size, buf, count))
161 return (-EFAULT); /* error while copying */
163 i = count; /* number of chars in buffer */
164 cp = cnf->conf_line + cnf->buf_size;
166 /* search for end of line */
167 if ((*cp < ' ') && (*cp != 9))
168 break; /* end of line found */
171 } /* search for end of line */
174 /* delimiter found */
175 *cp++ = 0; /* string termination */
176 count -= (i - 1); /* subtract remaining bytes from count */
177 while ((i) && (*cp < ' ') && (*cp != 9)) {
178 i--; /* discard next char */
179 count++; /* mark as read */
180 cp++; /* next char */
182 cnf->buf_size = 0; /* buffer is empty after transfer */
183 if ((i = process_line(cnf)) < 0) /* handle the line */
184 count = i; /* return the error */
186 /* delimiter found */
188 cnf->buf_size += count; /* add chars to string */
189 if (cnf->buf_size >= CONF_LINE_LEN - 1) {
190 if (cnf->card->debug_flags & LOG_CNF_MISC)
191 hysdn_addlog(cnf->card, "cnf line too long %d chars pos %d", cnf->buf_size, count);
192 return (-ERR_CONF_LONG);
194 } /* not delimited */
197 /* copy remaining bytes into buffer */
199 if (cnf->card->debug_flags & LOG_CNF_MISC)
200 hysdn_addlog(cnf->card, "cnf line too long");
201 return (-ERR_CONF_LONG);
203 } /* conf write active */
206 } /* hysdn_conf_write */
208 /*******************************************/
209 /* read conf file -> output card info data */
210 /*******************************************/
212 hysdn_conf_read(struct file *file, char *buf, size_t count, loff_t * off)
217 if (off != &file->f_pos) /* fs error check */
220 if (file->f_mode & FMODE_READ) {
221 if (!(cp = file->private_data))
222 return (-EFAULT); /* should never happen */
223 i = strlen(cp); /* get total string length */
225 /* still bytes to transfer */
226 cp += *off; /* point to desired data offset */
227 i -= *off; /* remaining length */
229 i = count; /* limit length to transfer */
230 if (copy_to_user(buf, cp, i))
231 return (-EFAULT); /* copy error */
232 *off += i; /* adjust offset */
236 return (-EPERM); /* no permission to read */
239 } /* hysdn_conf_read */
245 hysdn_conf_open(struct inode *ino, struct file *filep)
248 struct proc_dir_entry *pd;
249 struct conf_writedata *cnf;
252 /* now search the addressed card */
259 card = card->next; /* search next entry */
263 return (-ENODEV); /* device is unknown/invalid */
265 if (card->debug_flags & (LOG_PROC_OPEN | LOG_PROC_ALL))
266 hysdn_addlog(card, "config open for uid=%d gid=%d mode=0x%x",
267 filep->f_uid, filep->f_gid, filep->f_mode);
269 if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
270 /* write only access -> write boot file or conf line */
272 if (!(cnf = kmalloc(sizeof(struct conf_writedata), GFP_KERNEL))) {
277 cnf->buf_size = 0; /* nothing buffered */
278 cnf->state = CONF_STATE_DETECT; /* start auto detect */
279 filep->private_data = cnf;
281 } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
282 /* read access -> output card info data */
284 if (!(tmp = (char *) kmalloc(INFO_OUT_LEN * 2 + 2, GFP_KERNEL))) {
286 return (-EFAULT); /* out of memory */
288 filep->private_data = tmp; /* start of string */
290 /* first output a headline */
291 sprintf(tmp, "id bus slot type irq iobase dp-mem b-chans fax-chans state device");
292 cp = tmp; /* start of string */
295 while (((cp - tmp) % (INFO_OUT_LEN + 1)) != INFO_OUT_LEN)
299 /* and now the data */
300 sprintf(cp, "%d %3d %4d %4d %3d 0x%04x 0x%08lx %7d %9d %3d %s",
303 PCI_SLOT(card->devfn),
311 hysdn_net_getname(card));
314 while (((cp - tmp) % (INFO_OUT_LEN + 1)) != INFO_OUT_LEN)
317 *cp = 0; /* end of string */
318 } else { /* simultaneous read/write access forbidden ! */
320 return (-EPERM); /* no permission this time */
324 } /* hysdn_conf_open */
326 /***************************/
327 /* close a config file. */
328 /***************************/
330 hysdn_conf_close(struct inode *ino, struct file *filep)
333 struct conf_writedata *cnf;
335 struct proc_dir_entry *pd;
338 /* search the addressed card */
344 card = card->next; /* search next entry */
348 return (-ENODEV); /* device is unknown/invalid */
350 if (card->debug_flags & (LOG_PROC_OPEN | LOG_PROC_ALL))
351 hysdn_addlog(card, "config close for uid=%d gid=%d mode=0x%x",
352 filep->f_uid, filep->f_gid, filep->f_mode);
354 if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
355 /* write only access -> write boot file or conf line */
356 if (filep->private_data) {
357 cnf = filep->private_data;
359 if (cnf->state == CONF_STATE_POF)
360 retval = pof_write_close(cnf->card); /* close the pof write */
361 kfree(filep->private_data); /* free allocated memory for buffer */
363 } /* handle write private data */
364 } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
365 /* read access -> output card info data */
367 if (filep->private_data)
368 kfree(filep->private_data); /* release memory */
372 } /* hysdn_conf_close */
374 /******************************************************/
375 /* table for conf filesystem functions defined above. */
376 /******************************************************/
377 static struct file_operations conf_fops =
380 .read = hysdn_conf_read,
381 .write = hysdn_conf_write,
382 .open = hysdn_conf_open,
383 .release = hysdn_conf_close,
386 /*****************************/
387 /* hysdn subdir in /proc/net */
388 /*****************************/
389 struct proc_dir_entry *hysdn_proc_entry = NULL;
391 /*******************************************************************************/
392 /* hysdn_procconf_init is called when the module is loaded and after the cards */
393 /* have been detected. The needed proc dir and card config files are created. */
394 /* The log init is called at last. */
395 /*******************************************************************************/
397 hysdn_procconf_init(void)
402 hysdn_proc_entry = create_proc_entry(PROC_SUBDIR_NAME, S_IFDIR | S_IRUGO | S_IXUGO, proc_net);
403 if (!hysdn_proc_entry) {
404 printk(KERN_ERR "HYSDN: unable to create hysdn subdir\n");
407 card = card_root; /* point to first card */
410 sprintf(conf_name, "%s%d", PROC_CONF_BASENAME, card->myid);
411 if ((card->procconf = (void *) create_proc_entry(conf_name,
412 S_IFREG | S_IRUGO | S_IWUSR,
413 hysdn_proc_entry)) != NULL) {
414 ((struct proc_dir_entry *) card->procconf)->proc_fops = &conf_fops;
415 ((struct proc_dir_entry *) card->procconf)->owner = THIS_MODULE;
416 hysdn_proclog_init(card); /* init the log file entry */
418 card = card->next; /* next entry */
421 printk(KERN_NOTICE "HYSDN: procfs Rev. %s initialised\n", hysdn_getrev(hysdn_procconf_revision));
423 } /* hysdn_procconf_init */
425 /*************************************************************************************/
426 /* hysdn_procconf_release is called when the module is unloaded and before the cards */
427 /* resources are released. The module counter is assumed to be 0 ! */
428 /*************************************************************************************/
430 hysdn_procconf_release(void)
435 card = card_root; /* start with first card */
438 sprintf(conf_name, "%s%d", PROC_CONF_BASENAME, card->myid);
440 remove_proc_entry(conf_name, hysdn_proc_entry);
442 hysdn_proclog_release(card); /* init the log file entry */
444 card = card->next; /* point to next card */
447 remove_proc_entry(PROC_SUBDIR_NAME, proc_net);