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/poll.h>
16 #include <linux/proc_fs.h>
17 #include <linux/pci.h>
18 #include <linux/smp_lock.h>
20 #include "hysdn_defs.h"
22 static char *hysdn_procconf_revision = "$Revision: 1.8.6.4 $";
24 #define INFO_OUT_LEN 80 /* length of info line including lf */
26 /********************************************************/
27 /* defines and data structure for conf write operations */
28 /********************************************************/
29 #define CONF_STATE_DETECT 0 /* waiting for detect */
30 #define CONF_STATE_CONF 1 /* writing config data */
31 #define CONF_STATE_POF 2 /* writing pof data */
32 #define CONF_LINE_LEN 255 /* 255 chars max */
34 struct conf_writedata {
35 hysdn_card *card; /* card the device is connected to */
36 int buf_size; /* actual number of bytes in the buffer */
37 int needed_size; /* needed size when reading pof */
38 int state; /* actual interface states from above constants */
39 unsigned char conf_line[CONF_LINE_LEN]; /* buffered conf line */
40 unsigned short channel; /* active channel number */
41 unsigned char *pof_buffer; /* buffer when writing pof */
44 /***********************************************************************/
45 /* process_line parses one config line and transfers it to the card if */
47 /* if the return value is negative an error occurred. */
48 /***********************************************************************/
50 process_line(struct conf_writedata *cnf)
52 unsigned char *cp = cnf->conf_line;
55 if (cnf->card->debug_flags & LOG_CNF_LINE)
56 hysdn_addlog(cnf->card, "conf line: %s", cp);
58 if (*cp == '-') { /* option */
59 cp++; /* point to option char */
62 return (0); /* option unknown or used */
63 i = 0; /* start value for channel */
64 while ((*cp <= '9') && (*cp >= '0'))
65 i = i * 10 + *cp++ - '0'; /* get decimal number */
67 if (cnf->card->debug_flags & LOG_CNF_MISC)
68 hysdn_addlog(cnf->card, "conf channel invalid %d", i);
69 return (-ERR_INV_CHAN); /* invalid channel */
71 cnf->channel = i & 0xFFFF; /* set new channel number */
72 return (0); /* success */
74 if (*cp == '*') { /* line to send */
75 if (cnf->card->debug_flags & LOG_CNF_DATA)
76 hysdn_addlog(cnf->card, "conf chan=%d %s", cnf->channel, cp);
77 return (hysdn_tx_cfgline(cnf->card, cnf->conf_line + 1,
78 cnf->channel)); /* send the line without * */
83 /***********************************/
84 /* conf file operations and tables */
85 /***********************************/
87 /****************************************************/
88 /* write conf file -> boot or send cfg line to card */
89 /****************************************************/
91 hysdn_conf_write(struct file *file, const char __user *buf, size_t count, loff_t * off)
93 struct conf_writedata *cnf;
95 unsigned char ch, *cp;
98 return (0); /* nothing to handle */
100 if (!(cnf = file->private_data))
101 return (-EFAULT); /* should never happen */
103 if (cnf->state == CONF_STATE_DETECT) { /* auto detect cnf or pof data */
104 if (copy_from_user(&ch, buf, 1)) /* get first char for detect */
108 /* we detected a pof file */
109 if ((cnf->needed_size = pof_write_open(cnf->card, &cnf->pof_buffer)) <= 0)
110 return (cnf->needed_size); /* an error occurred -> exit */
111 cnf->buf_size = 0; /* buffer is empty */
112 cnf->state = CONF_STATE_POF; /* new state */
114 /* conf data has been detected */
115 cnf->buf_size = 0; /* buffer is empty */
116 cnf->state = CONF_STATE_CONF; /* requested conf data write */
117 if (cnf->card->state != CARD_STATE_RUN)
118 return (-ERR_NOT_BOOTED);
119 cnf->conf_line[CONF_LINE_LEN - 1] = 0; /* limit string length */
120 cnf->channel = 4098; /* default channel for output */
122 } /* state was auto detect */
123 if (cnf->state == CONF_STATE_POF) { /* pof write active */
124 i = cnf->needed_size - cnf->buf_size; /* bytes still missing for write */
126 return (-EINVAL); /* size error handling pof */
129 count = i; /* limit requested number of bytes */
130 if (copy_from_user(cnf->pof_buffer + cnf->buf_size, buf, count))
131 return (-EFAULT); /* error while copying */
132 cnf->buf_size += count;
134 if (cnf->needed_size == cnf->buf_size) {
135 cnf->needed_size = pof_write_buffer(cnf->card, cnf->buf_size); /* write data */
136 if (cnf->needed_size <= 0) {
137 cnf->card->state = CARD_STATE_BOOTERR; /* show boot error */
138 return (cnf->needed_size); /* an error occurred */
140 cnf->buf_size = 0; /* buffer is empty again */
143 /* pof write active */
144 else { /* conf write active */
146 if (cnf->card->state != CARD_STATE_RUN) {
147 if (cnf->card->debug_flags & LOG_CNF_MISC)
148 hysdn_addlog(cnf->card, "cnf write denied -> not booted");
149 return (-ERR_NOT_BOOTED);
151 i = (CONF_LINE_LEN - 1) - cnf->buf_size; /* bytes available in buffer */
153 /* copy remaining bytes into buffer */
156 count = i; /* limit transfer */
157 if (copy_from_user(cnf->conf_line + cnf->buf_size, buf, count))
158 return (-EFAULT); /* error while copying */
160 i = count; /* number of chars in buffer */
161 cp = cnf->conf_line + cnf->buf_size;
163 /* search for end of line */
164 if ((*cp < ' ') && (*cp != 9))
165 break; /* end of line found */
168 } /* search for end of line */
171 /* delimiter found */
172 *cp++ = 0; /* string termination */
173 count -= (i - 1); /* subtract remaining bytes from count */
174 while ((i) && (*cp < ' ') && (*cp != 9)) {
175 i--; /* discard next char */
176 count++; /* mark as read */
177 cp++; /* next char */
179 cnf->buf_size = 0; /* buffer is empty after transfer */
180 if ((i = process_line(cnf)) < 0) /* handle the line */
181 count = i; /* return the error */
183 /* delimiter found */
185 cnf->buf_size += count; /* add chars to string */
186 if (cnf->buf_size >= CONF_LINE_LEN - 1) {
187 if (cnf->card->debug_flags & LOG_CNF_MISC)
188 hysdn_addlog(cnf->card, "cnf line too long %d chars pos %d", cnf->buf_size, count);
189 return (-ERR_CONF_LONG);
191 } /* not delimited */
194 /* copy remaining bytes into buffer */
196 if (cnf->card->debug_flags & LOG_CNF_MISC)
197 hysdn_addlog(cnf->card, "cnf line too long");
198 return (-ERR_CONF_LONG);
200 } /* conf write active */
203 } /* hysdn_conf_write */
205 /*******************************************/
206 /* read conf file -> output card info data */
207 /*******************************************/
209 hysdn_conf_read(struct file *file, char __user *buf, size_t count, loff_t * off)
214 if (file->f_mode & FMODE_READ) {
215 if (!(cp = file->private_data))
216 return (-EFAULT); /* should never happen */
217 i = strlen(cp); /* get total string length */
219 /* still bytes to transfer */
220 cp += *off; /* point to desired data offset */
221 i -= *off; /* remaining length */
223 i = count; /* limit length to transfer */
224 if (copy_to_user(buf, cp, i))
225 return (-EFAULT); /* copy error */
226 *off += i; /* adjust offset */
230 return (-EPERM); /* no permission to read */
233 } /* hysdn_conf_read */
239 hysdn_conf_open(struct inode *ino, struct file *filep)
242 struct proc_dir_entry *pd;
243 struct conf_writedata *cnf;
246 /* now search the addressed card */
253 card = card->next; /* search next entry */
257 return (-ENODEV); /* device is unknown/invalid */
259 if (card->debug_flags & (LOG_PROC_OPEN | LOG_PROC_ALL))
260 hysdn_addlog(card, "config open for uid=%d gid=%d mode=0x%x",
261 filep->f_uid, filep->f_gid, filep->f_mode);
263 if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
264 /* write only access -> write boot file or conf line */
266 if (!(cnf = kmalloc(sizeof(struct conf_writedata), GFP_KERNEL))) {
271 cnf->buf_size = 0; /* nothing buffered */
272 cnf->state = CONF_STATE_DETECT; /* start auto detect */
273 filep->private_data = cnf;
275 } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
276 /* read access -> output card info data */
278 if (!(tmp = kmalloc(INFO_OUT_LEN * 2 + 2, GFP_KERNEL))) {
280 return (-EFAULT); /* out of memory */
282 filep->private_data = tmp; /* start of string */
284 /* first output a headline */
285 sprintf(tmp, "id bus slot type irq iobase dp-mem b-chans fax-chans state device");
286 cp = tmp; /* start of string */
289 while (((cp - tmp) % (INFO_OUT_LEN + 1)) != INFO_OUT_LEN)
293 /* and now the data */
294 sprintf(cp, "%d %3d %4d %4d %3d 0x%04x 0x%08lx %7d %9d %3d %s",
297 PCI_SLOT(card->devfn),
305 hysdn_net_getname(card));
308 while (((cp - tmp) % (INFO_OUT_LEN + 1)) != INFO_OUT_LEN)
311 *cp = 0; /* end of string */
312 } else { /* simultaneous read/write access forbidden ! */
314 return (-EPERM); /* no permission this time */
317 return nonseekable_open(ino, filep);
318 } /* hysdn_conf_open */
320 /***************************/
321 /* close a config file. */
322 /***************************/
324 hysdn_conf_close(struct inode *ino, struct file *filep)
327 struct conf_writedata *cnf;
329 struct proc_dir_entry *pd;
332 /* search the addressed card */
338 card = card->next; /* search next entry */
342 return (-ENODEV); /* device is unknown/invalid */
344 if (card->debug_flags & (LOG_PROC_OPEN | LOG_PROC_ALL))
345 hysdn_addlog(card, "config close for uid=%d gid=%d mode=0x%x",
346 filep->f_uid, filep->f_gid, filep->f_mode);
348 if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
349 /* write only access -> write boot file or conf line */
350 if (filep->private_data) {
351 cnf = filep->private_data;
353 if (cnf->state == CONF_STATE_POF)
354 retval = pof_write_close(cnf->card); /* close the pof write */
355 kfree(filep->private_data); /* free allocated memory for buffer */
357 } /* handle write private data */
358 } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
359 /* read access -> output card info data */
361 kfree(filep->private_data); /* release memory */
365 } /* hysdn_conf_close */
367 /******************************************************/
368 /* table for conf filesystem functions defined above. */
369 /******************************************************/
370 static const struct file_operations conf_fops =
373 .read = hysdn_conf_read,
374 .write = hysdn_conf_write,
375 .open = hysdn_conf_open,
376 .release = hysdn_conf_close,
379 /*****************************/
380 /* hysdn subdir in /proc/net */
381 /*****************************/
382 struct proc_dir_entry *hysdn_proc_entry = NULL;
384 /*******************************************************************************/
385 /* hysdn_procconf_init is called when the module is loaded and after the cards */
386 /* have been detected. The needed proc dir and card config files are created. */
387 /* The log init is called at last. */
388 /*******************************************************************************/
390 hysdn_procconf_init(void)
393 unsigned char conf_name[20];
395 hysdn_proc_entry = proc_mkdir(PROC_SUBDIR_NAME, proc_net);
396 if (!hysdn_proc_entry) {
397 printk(KERN_ERR "HYSDN: unable to create hysdn subdir\n");
400 card = card_root; /* point to first card */
403 sprintf(conf_name, "%s%d", PROC_CONF_BASENAME, card->myid);
404 if ((card->procconf = (void *) create_proc_entry(conf_name,
405 S_IFREG | S_IRUGO | S_IWUSR,
406 hysdn_proc_entry)) != NULL) {
407 ((struct proc_dir_entry *) card->procconf)->proc_fops = &conf_fops;
408 ((struct proc_dir_entry *) card->procconf)->owner = THIS_MODULE;
409 hysdn_proclog_init(card); /* init the log file entry */
411 card = card->next; /* next entry */
414 printk(KERN_NOTICE "HYSDN: procfs Rev. %s initialised\n", hysdn_getrev(hysdn_procconf_revision));
416 } /* hysdn_procconf_init */
418 /*************************************************************************************/
419 /* hysdn_procconf_release is called when the module is unloaded and before the cards */
420 /* resources are released. The module counter is assumed to be 0 ! */
421 /*************************************************************************************/
423 hysdn_procconf_release(void)
426 unsigned char conf_name[20];
428 card = card_root; /* start with first card */
431 sprintf(conf_name, "%s%d", PROC_CONF_BASENAME, card->myid);
433 remove_proc_entry(conf_name, hysdn_proc_entry);
435 hysdn_proclog_release(card); /* init the log file entry */
437 card = card->next; /* point to next card */
440 remove_proc_entry(PROC_SUBDIR_NAME, proc_net);