LXR linux/drivers/isdn/hysdn/hysdn

   1/* $Id: hysdn_procconf.c,v 1.8.6.4 2001/09/23 22:24:54 kai Exp $
   2 *
   3 * Linux driver for HYSDN cards, /proc/net filesystem dir and conf functions.
   4 *
   5 * written by Werner Cornelius (werner@titro.de) for Hypercope GmbH
   6 *
   7 * Copyright 1999  by Werner Cornelius (werner@titro.de)
   8 *
   9 * This software may be used and distributed according to the terms
  10 * of the GNU General Public License, incorporated herein by reference.
  11 *
  12 */
  13
  14#include <linux/cred.h>
  15#include <linux/module.h>
  16#include <linux/poll.h>
  17#include <linux/proc_fs.h>
  18#include <linux/pci.h>
  19#include <linux/slab.h>
  20#include <linux/mutex.h>
  21#include <net/net_namespace.h>
  22
  23#include "hysdn_defs.h"
  24
  25static DEFINE_MUTEX(hysdn_conf_mutex);
  26
  27#define INFO_OUT_LEN 80         /* length of info line including lf */
  28
  29/********************************************************/
  30/* defines and data structure for conf write operations */
  31/********************************************************/
  32#define CONF_STATE_DETECT 0     /* waiting for detect */
  33#define CONF_STATE_CONF   1     /* writing config data */
  34#define CONF_STATE_POF    2     /* writing pof data */
  35#define CONF_LINE_LEN   255     /* 255 chars max */
  36
  37struct conf_writedata {
  38        hysdn_card *card;       /* card the device is connected to */
  39        int buf_size;           /* actual number of bytes in the buffer */
  40        int needed_size;        /* needed size when reading pof */
  41        int state;              /* actual interface states from above constants */
  42        unsigned char conf_line[CONF_LINE_LEN]; /* buffered conf line */
  43        unsigned short channel;         /* active channel number */
  44        unsigned char *pof_buffer;      /* buffer when writing pof */
  45};
  46
  47/***********************************************************************/
  48/* process_line parses one config line and transfers it to the card if */
  49/* necessary.                                                          */
  50/* if the return value is negative an error occurred.                   */
  51/***********************************************************************/
  52static int
  53process_line(struct conf_writedata *cnf)
  54{
  55        unsigned char *cp = cnf->conf_line;
  56        int i;
  57
  58        if (cnf->card->debug_flags & LOG_CNF_LINE)
  59                hysdn_addlog(cnf->card, "conf line: %s", cp);
  60
  61        if (*cp == '-') {       /* option */
  62                cp++;           /* point to option char */
  63
  64                if (*cp++ != 'c')
  65                        return (0);     /* option unknown or used */
  66                i = 0;          /* start value for channel */
  67                while ((*cp <= '9') && (*cp >= '0'))
  68                        i = i * 10 + *cp++ - '0';       /* get decimal number */
  69                if (i > 65535) {
  70                        if (cnf->card->debug_flags & LOG_CNF_MISC)
  71                                hysdn_addlog(cnf->card, "conf channel invalid  %d", i);
  72                        return (-ERR_INV_CHAN);         /* invalid channel */
  73                }
  74                cnf->channel = i & 0xFFFF;      /* set new channel number */
  75                return (0);     /* success */
  76        }                       /* option */
  77        if (*cp == '*') {       /* line to send */
  78                if (cnf->card->debug_flags & LOG_CNF_DATA)
  79                        hysdn_addlog(cnf->card, "conf chan=%d %s", cnf->channel, cp);
  80                return (hysdn_tx_cfgline(cnf->card, cnf->conf_line + 1,
  81                                         cnf->channel));        /* send the line without * */
  82        }                       /* line to send */
  83        return (0);
  84}                               /* process_line */
  85
  86/***********************************/
  87/* conf file operations and tables */
  88/***********************************/
  89
  90/****************************************************/
  91/* write conf file -> boot or send cfg line to card */
  92/****************************************************/
  93static ssize_t
  94hysdn_conf_write(struct file *file, const char __user *buf, size_t count, loff_t * off)
  95{
  96        struct conf_writedata *cnf;
  97        int i;
  98        unsigned char ch, *cp;
  99
 100        if (!count)
 101                return (0);     /* nothing to handle */
 102
 103        if (!(cnf = file->private_data))
 104                return (-EFAULT);       /* should never happen */
 105
 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 */
 108                        return (-EFAULT);
 109
 110                if (ch == 0x1A) {
 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 */
 116                } else {
 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 */
 124                }
 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 */
 128                if (i <= 0)
 129                        return (-EINVAL);       /* size error handling pof */
 130
 131                if (i < count)
 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;
 136
 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 */
 142                        }
 143                        cnf->buf_size = 0;      /* buffer is empty again */
 144                }
 145        }
 146        /* pof write active */
 147        else {                  /* conf write active */
 148
 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);
 153                }
 154                i = (CONF_LINE_LEN - 1) - cnf->buf_size;        /* bytes available in buffer */
 155                if (i > 0) {
 156                        /* copy remaining bytes into buffer */
 157
 158                        if (count > i)
 159                                count = i;      /* limit transfer */
 160                        if (copy_from_user(cnf->conf_line + cnf->buf_size, buf, count))
 161                                return (-EFAULT);       /* error while copying */
 162
 163                        i = count;      /* number of chars in buffer */
 164                        cp = cnf->conf_line + cnf->buf_size;
 165                        while (i) {
 166                                /* search for end of line */
 167                                if ((*cp < ' ') && (*cp != 9))
 168                                        break;  /* end of line found */
 169                                cp++;
 170                                i--;
 171                        }       /* search for end of line */
 172
 173                        if (i) {
 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 */
 181                                }
 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 */
 185                        }
 186                        /* delimiter found */
 187                        else {
 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);
 193                                }
 194                        }       /* not delimited */
 195
 196                }
 197                /* copy remaining bytes into buffer */
 198                else {
 199                        if (cnf->card->debug_flags & LOG_CNF_MISC)
 200                                hysdn_addlog(cnf->card, "cnf line too long");
 201                        return (-ERR_CONF_LONG);
 202                }
 203        }                       /* conf write active */
 204
 205        return (count);
 206}                               /* hysdn_conf_write */
 207
 208/*******************************************/
 209/* read conf file -> output card info data */
 210/*******************************************/
 211static ssize_t
 212hysdn_conf_read(struct file *file, char __user *buf, size_t count, loff_t *off)
 213{
 214        char *cp;
 215
 216        if (!(file->f_mode & FMODE_READ))
 217                return -EPERM;  /* no permission to read */
 218
 219        if (!(cp = file->private_data))
 220                return -EFAULT; /* should never happen */
 221
 222        return simple_read_from_buffer(buf, count, off, cp, strlen(cp));
 223}                               /* hysdn_conf_read */
 224
 225/******************/
 226/* open conf file */
 227/******************/
 228static int
 229hysdn_conf_open(struct inode *ino, struct file *filep)
 230{
 231        hysdn_card *card;
 232        struct proc_dir_entry *pd;
 233        struct conf_writedata *cnf;
 234        char *cp, *tmp;
 235
 236        /* now search the addressed card */
 237        mutex_lock(&hysdn_conf_mutex);
 238        card = card_root;
 239        while (card) {
 240                pd = card->procconf;
 241                if (pd == PDE(ino))
 242                        break;
 243                card = card->next;      /* search next entry */
 244        }
 245        if (!card) {
 246                mutex_unlock(&hysdn_conf_mutex);
 247                return (-ENODEV);       /* device is unknown/invalid */
 248        }
 249        if (card->debug_flags & (LOG_PROC_OPEN | LOG_PROC_ALL))
 250                hysdn_addlog(card, "config open for uid=%d gid=%d mode=0x%x",
 251                             filep->f_cred->fsuid, filep->f_cred->fsgid,
 252                             filep->f_mode);
 253
 254        if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
 255                /* write only access -> write boot file or conf line */
 256
 257                if (!(cnf = kmalloc(sizeof(struct conf_writedata), GFP_KERNEL))) {
 258                        mutex_unlock(&hysdn_conf_mutex);
 259                        return (-EFAULT);
 260                }
 261                cnf->card = card;
 262                cnf->buf_size = 0;      /* nothing buffered */
 263                cnf->state = CONF_STATE_DETECT;         /* start auto detect */
 264                filep->private_data = cnf;
 265
 266        } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
 267                /* read access -> output card info data */
 268
 269                if (!(tmp = kmalloc(INFO_OUT_LEN * 2 + 2, GFP_KERNEL))) {
 270                        mutex_unlock(&hysdn_conf_mutex);
 271                        return (-EFAULT);       /* out of memory */
 272                }
 273                filep->private_data = tmp;      /* start of string */
 274
 275                /* first output a headline */
 276                sprintf(tmp, "id bus slot type irq iobase dp-mem     b-chans fax-chans state device");
 277                cp = tmp;       /* start of string */
 278                while (*cp)
 279                        cp++;
 280                while (((cp - tmp) % (INFO_OUT_LEN + 1)) != INFO_OUT_LEN)
 281                        *cp++ = ' ';
 282                *cp++ = '\n';
 283
 284                /* and now the data */
 285                sprintf(cp, "%d  %3d %4d %4d %3d 0x%04x 0x%08lx %7d %9d %3d   %s",
 286                        card->myid,
 287                        card->bus,
 288                        PCI_SLOT(card->devfn),
 289                        card->brdtype,
 290                        card->irq,
 291                        card->iobase,
 292                        card->membase,
 293                        card->bchans,
 294                        card->faxchans,
 295                        card->state,
 296                        hysdn_net_getname(card));
 297                while (*cp)
 298                        cp++;
 299                while (((cp - tmp) % (INFO_OUT_LEN + 1)) != INFO_OUT_LEN)
 300                        *cp++ = ' ';
 301                *cp++ = '\n';
 302                *cp = 0;        /* end of string */
 303        } else {                /* simultaneous read/write access forbidden ! */
 304                mutex_unlock(&hysdn_conf_mutex);
 305                return (-EPERM);        /* no permission this time */
 306        }
 307        mutex_unlock(&hysdn_conf_mutex);
 308        return nonseekable_open(ino, filep);
 309}                               /* hysdn_conf_open */
 310
 311/***************************/
 312/* close a config file.    */
 313/***************************/
 314static int
 315hysdn_conf_close(struct inode *ino, struct file *filep)
 316{
 317        hysdn_card *card;
 318        struct conf_writedata *cnf;
 319        int retval = 0;
 320        struct proc_dir_entry *pd;
 321
 322        mutex_lock(&hysdn_conf_mutex);
 323        /* search the addressed card */
 324        card = card_root;
 325        while (card) {
 326                pd = card->procconf;
 327                if (pd == PDE(ino))
 328                        break;
 329                card = card->next;      /* search next entry */
 330        }
 331        if (!card) {
 332                mutex_unlock(&hysdn_conf_mutex);
 333                return (-ENODEV);       /* device is unknown/invalid */
 334        }
 335        if (card->debug_flags & (LOG_PROC_OPEN | LOG_PROC_ALL))
 336                hysdn_addlog(card, "config close for uid=%d gid=%d mode=0x%x",
 337                             filep->f_cred->fsuid, filep->f_cred->fsgid,
 338                             filep->f_mode);
 339
 340        if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
 341                /* write only access -> write boot file or conf line */
 342                if (filep->private_data) {
 343                        cnf = filep->private_data;
 344
 345                        if (cnf->state == CONF_STATE_POF)
 346                                retval = pof_write_close(cnf->card);    /* close the pof write */
 347                        kfree(filep->private_data);     /* free allocated memory for buffer */
 348
 349                }               /* handle write private data */
 350        } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
 351                /* read access -> output card info data */
 352
 353                kfree(filep->private_data);     /* release memory */
 354        }
 355        mutex_unlock(&hysdn_conf_mutex);
 356        return (retval);
 357}                               /* hysdn_conf_close */
 358
 359/******************************************************/
 360/* table for conf filesystem functions defined above. */
 361/******************************************************/
 362static const struct file_operations conf_fops =
 363{
 364        .owner          = THIS_MODULE,
 365        .llseek         = no_llseek,
 366        .read           = hysdn_conf_read,
 367        .write          = hysdn_conf_write,
 368        .open           = hysdn_conf_open,
 369        .release        = hysdn_conf_close,                                       
 370};
 371
 372/*****************************/
 373/* hysdn subdir in /proc/net */
 374/*****************************/
 375struct proc_dir_entry *hysdn_proc_entry = NULL;
 376
 377/*******************************************************************************/
 378/* hysdn_procconf_init is called when the module is loaded and after the cards */
 379/* have been detected. The needed proc dir and card config files are created.  */
 380/* The log init is called at last.                                             */
 381/*******************************************************************************/
 382int
 383hysdn_procconf_init(void)
 384{
 385        hysdn_card *card;
 386        unsigned char conf_name[20];
 387
 388        hysdn_proc_entry = proc_mkdir(PROC_SUBDIR_NAME, init_net.proc_net);
 389        if (!hysdn_proc_entry) {
 390                printk(KERN_ERR "HYSDN: unable to create hysdn subdir\n");
 391                return (-1);
 392        }
 393        card = card_root;       /* point to first card */
 394        while (card) {
 395
 396                sprintf(conf_name, "%s%d", PROC_CONF_BASENAME, card->myid);
 397                if ((card->procconf = (void *) proc_create(conf_name,
 398                                                S_IFREG | S_IRUGO | S_IWUSR,
 399                                                hysdn_proc_entry,
 400                                                &conf_fops)) != NULL) {
 401                        hysdn_proclog_init(card);       /* init the log file entry */
 402                }
 403                card = card->next;      /* next entry */
 404        }
 405
 406        printk(KERN_NOTICE "HYSDN: procfs initialised\n");
 407        return (0);
 408}                               /* hysdn_procconf_init */
 409
 410/*************************************************************************************/
 411/* hysdn_procconf_release is called when the module is unloaded and before the cards */
 412/* resources are released. The module counter is assumed to be 0 !                   */
 413/*************************************************************************************/
 414void
 415hysdn_procconf_release(void)
 416{
 417        hysdn_card *card;
 418        unsigned char conf_name[20];
 419
 420        card = card_root;       /* start with first card */
 421        while (card) {
 422
 423                sprintf(conf_name, "%s%d", PROC_CONF_BASENAME, card->myid);
 424                if (card->procconf)
 425                        remove_proc_entry(conf_name, hysdn_proc_entry);
 426
 427                hysdn_proclog_release(card);    /* init the log file entry */
 428
 429                card = card->next;      /* point to next card */
 430        }
 431
 432        remove_proc_entry(PROC_SUBDIR_NAME, init_net.proc_net);
 433}
 434