1 /* $Id: hysdn_proclog.c,v 1.9.6.3 2001/09/23 22:24:54 kai Exp $
3 * Linux driver for HYSDN cards, /proc/net filesystem log functions.
5 * Author Werner Cornelius (werner@titro.de) for Hypercope GmbH
6 * Copyright 1999 by Werner Cornelius (werner@titro.de)
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
13 #include <linux/module.h>
14 #include <linux/version.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 /* the proc subdir for the interface is defined in the procconf module */
23 extern struct proc_dir_entry *hysdn_proc_entry;
25 /*************************************************/
26 /* structure keeping ascii log for device output */
27 /*************************************************/
29 struct log_data *next;
30 ulong usage_cnt; /* number of files still to work */
31 void *proc_ctrl; /* pointer to own control procdata structure */
32 char log_start[2]; /* log string start (final len aligned by size) */
35 /**********************************************/
36 /* structure holding proc entrys for one card */
37 /**********************************************/
39 struct proc_dir_entry *log; /* log entry */
40 char log_name[15]; /* log filename */
41 struct log_data *log_head, *log_tail; /* head and tail for queue */
42 int if_used; /* open count for interface */
43 int volatile del_lock; /* lock for delete operations */
44 uchar logtmp[LOG_MAX_LINELEN];
45 wait_queue_head_t rd_queue;
49 /**********************************************/
50 /* log function for cards error log interface */
51 /**********************************************/
53 hysdn_card_errlog(hysdn_card * card, tErrLogEntry * logp, int maxsize)
55 char buf[ERRLOG_TEXT_SIZE + 40];
57 sprintf(buf, "LOG 0x%08lX 0x%08lX : %s\n", logp->ulErrType, logp->ulErrSubtype, logp->ucText);
58 put_log_buffer(card, buf); /* output the string */
59 } /* hysdn_card_errlog */
61 /***************************************************/
62 /* Log function using format specifiers for output */
63 /***************************************************/
65 hysdn_addlog(hysdn_card * card, char *fmt,...)
67 struct procdata *pd = card->proclog;
72 return; /* log structure non existent */
75 cp += sprintf(cp, "HYSDN: card %d ", card->myid);
78 cp += vsprintf(cp, fmt, args);
83 if (card->debug_flags & DEB_OUT_SYSLOG)
84 printk(KERN_INFO "%s", pd->logtmp);
86 put_log_buffer(card, pd->logtmp);
90 /********************************************/
91 /* put an log buffer into the log queue. */
92 /* This buffer will be kept until all files */
93 /* opened for read got the contents. */
94 /* Flushes buffers not longer in use. */
95 /********************************************/
97 put_log_buffer(hysdn_card * card, char *cp)
100 struct procdata *pd = card->proclog;
110 if (pd->if_used <= 0)
111 return; /* no open file for read */
113 if (!(ib = (struct log_data *) kmalloc(sizeof(struct log_data) + strlen(cp), GFP_ATOMIC)))
114 return; /* no memory */
115 strcpy(ib->log_start, cp); /* set output string */
117 ib->proc_ctrl = pd; /* point to own control structure */
120 ib->usage_cnt = pd->if_used;
122 pd->log_head = ib; /* new head */
124 pd->log_tail->next = ib; /* follows existing messages */
125 pd->log_tail = ib; /* new tail */
126 i = pd->del_lock++; /* get lock state */
127 restore_flags(flags);
129 /* delete old entrys */
131 while (pd->log_head->next) {
132 if ((pd->log_head->usage_cnt <= 0) &&
133 (pd->log_head->next->usage_cnt <= 0)) {
135 pd->log_head = pd->log_head->next;
139 } /* pd->log_head->next */
140 pd->del_lock--; /* release lock level */
141 wake_up_interruptible(&(pd->rd_queue)); /* announce new entry */
142 } /* put_log_buffer */
145 /******************************/
146 /* file operations and tables */
147 /******************************/
149 /****************************************/
150 /* write log file -> set log level bits */
151 /****************************************/
153 hysdn_log_write(struct file *file, const char __user *buf, size_t count, loff_t * off)
157 uchar *cp, valbuf[128];
159 hysdn_card *card = (hysdn_card *) file->private_data;
161 if (count > (sizeof(valbuf) - 1))
162 count = sizeof(valbuf) - 1; /* limit length */
163 if (copy_from_user(valbuf, buf, count))
164 return (-EFAULT); /* copy failed */
166 valbuf[count] = 0; /* terminating 0 */
168 if ((count > 2) && (valbuf[0] == '0') && (valbuf[1] == 'x')) {
169 cp += 2; /* pointer after hex modifier */
172 /* scan the input for debug flags */
174 if ((*cp >= '0') && (*cp <= '9')) {
176 u *= base; /* adjust to next digit */
181 break; /* end of number */
183 if ((*cp >= 'a') && (*cp <= 'f')) {
185 u *= base; /* adjust to next digit */
186 u += *cp++ - 'a' + 10;
189 break; /* terminated */
193 card->debug_flags = u; /* remember debug flags */
194 hysdn_addlog(card, "debug set to 0x%lx", card->debug_flags);
197 } /* hysdn_log_write */
203 hysdn_log_read(struct file *file, char __user *buf, size_t count, loff_t * off)
205 struct log_data *inf;
207 struct proc_dir_entry *pde = PDE(file->f_dentry->d_inode);
208 struct procdata *pd = NULL;
211 if (!*((struct log_data **) file->private_data)) {
212 if (file->f_flags & O_NONBLOCK)
215 /* sorry, but we need to search the card */
221 card = card->next; /* search next entry */
224 interruptible_sleep_on(&(pd->rd_queue));
229 if (!(inf = *((struct log_data **) file->private_data)))
232 inf->usage_cnt--; /* new usage count */
233 file->private_data = &inf->next; /* next structure */
234 if ((len = strlen(inf->log_start)) <= count) {
235 if (copy_to_user(buf, inf->log_start, len))
241 } /* hysdn_log_read */
247 hysdn_log_open(struct inode *ino, struct file *filep)
250 struct procdata *pd = NULL;
257 if (pd->log == PDE(ino))
259 card = card->next; /* search next entry */
263 return (-ENODEV); /* device is unknown/invalid */
265 filep->private_data = card; /* remember our own card */
267 if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
268 /* write only access -> write log level only */
269 } else if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
271 /* read access -> log/debug read */
276 filep->private_data = &pd->log_tail->next;
278 filep->private_data = &pd->log_head;
279 restore_flags(flags);
280 } else { /* simultaneous read/write access forbidden ! */
282 return (-EPERM); /* no permission this time */
285 return nonseekable_open(ino, filep);
286 } /* hysdn_log_open */
288 /*******************************************************************************/
289 /* close a cardlog file. If the file has been opened for exclusive write it is */
290 /* assumed as pof data input and the pof loader is noticed about. */
291 /* Otherwise file is handled as log output. In this case the interface usage */
292 /* count is decremented and all buffers are noticed of closing. If this file */
293 /* was the last one to be closed, all buffers are freed. */
294 /*******************************************************************************/
296 hysdn_log_close(struct inode *ino, struct file *filep)
298 struct log_data *inf;
306 if ((filep->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE) {
307 /* write only access -> write debug level written */
308 retval = 0; /* success */
310 /* read access -> log/debug read, mark one further file as closed */
315 inf = *((struct log_data **) filep->private_data); /* get first log entry */
317 pd = (struct procdata *) inf->proc_ctrl; /* still entries there */
319 /* no info available -> search card */
323 if (pd->log == PDE(ino))
325 card = card->next; /* search next entry */
328 pd = card->proclog; /* pointer to procfs log */
331 pd->if_used--; /* decrement interface usage count by one */
334 inf->usage_cnt--; /* decrement usage count for buffers */
337 restore_flags(flags);
340 if (pd->if_used <= 0) /* delete buffers if last file closed */
341 while (pd->log_head) {
343 pd->log_head = pd->log_head->next;
350 } /* hysdn_log_close */
352 /*************************************************/
353 /* select/poll routine to be able using select() */
354 /*************************************************/
356 hysdn_log_poll(struct file *file, poll_table * wait)
358 unsigned int mask = 0;
359 struct proc_dir_entry *pde = PDE(file->f_dentry->d_inode);
361 struct procdata *pd = NULL;
363 if ((file->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_WRITE)
364 return (mask); /* no polling for write supported */
366 /* we need to search the card */
372 card = card->next; /* search next entry */
375 return (mask); /* card not found */
377 poll_wait(file, &(pd->rd_queue), wait);
379 if (*((struct log_data **) file->private_data))
380 mask |= POLLIN | POLLRDNORM;
383 } /* hysdn_log_poll */
385 /**************************************************/
386 /* table for log filesystem functions defined above. */
387 /**************************************************/
388 static struct file_operations log_fops =
391 .read = hysdn_log_read,
392 .write = hysdn_log_write,
393 .poll = hysdn_log_poll,
394 .open = hysdn_log_open,
395 .release = hysdn_log_close,
399 /***********************************************************************************/
400 /* hysdn_proclog_init is called when the module is loaded after creating the cards */
402 /***********************************************************************************/
404 hysdn_proclog_init(hysdn_card * card)
408 /* create a cardlog proc entry */
410 if ((pd = (struct procdata *) kmalloc(sizeof(struct procdata), GFP_KERNEL)) != NULL) {
411 memset(pd, 0, sizeof(struct procdata));
412 sprintf(pd->log_name, "%s%d", PROC_LOG_BASENAME, card->myid);
413 if ((pd->log = create_proc_entry(pd->log_name, S_IFREG | S_IRUGO | S_IWUSR, hysdn_proc_entry)) != NULL) {
414 pd->log->proc_fops = &log_fops;
415 pd->log->owner = THIS_MODULE;
418 init_waitqueue_head(&(pd->rd_queue));
420 card->proclog = (void *) pd; /* remember procfs structure */
423 } /* hysdn_proclog_init */
425 /************************************************************************************/
426 /* hysdn_proclog_release is called when the module is unloaded and before the cards */
427 /* conf file is released */
428 /* The module counter is assumed to be 0 ! */
429 /************************************************************************************/
431 hysdn_proclog_release(hysdn_card * card)
435 if ((pd = (struct procdata *) card->proclog) != NULL) {
437 remove_proc_entry(pd->log_name, hysdn_proc_entry);
438 kfree(pd); /* release memory */
439 card->proclog = NULL;
441 } /* hysdn_proclog_release */