[dahdi-commits] tzafrir: linux/trunk r7371 - /linux/trunk/drivers/dahdi/dahdi-base.c

[SVN commits to the DAHDI project]

Author: tzafrir
Date: Sun Oct 11 07:22:16 2009
New Revision: 7371

URL: http://svnview.digium.com/svn/dahdi?view=rev&rev=7371
Log:
Add a few kernel-doc comments

Modified:
    linux/trunk/drivers/dahdi/dahdi-base.c

Modified: linux/trunk/drivers/dahdi/dahdi-base.c
URL: http://svnview.digium.com/svn/dahdi/linux/trunk/drivers/dahdi/dahdi-base.c?view=diff&rev=7371&r1=7370&r2=7371
==============================================================================
--- linux/trunk/drivers/dahdi/dahdi-base.c (original)
+++ linux/trunk/drivers/dahdi/dahdi-base.c Sun Oct 11 07:22:16 2009
@@ -5637,6 +5637,14 @@
 	return dahdi_chan_ioctl(inode, file, cmd, data, unit);
 }
 
+
+/**
+ * dahdi_register() - Unregister a new DAHDI span
+ * @span               The DAHDI span
+ *
+ * Registers a span for usage with DAHDI. All the channel numbers in it
+ * will get the lowest available channel numbers.
+ */
 int dahdi_register(struct dahdi_span *span, int prefmaster)
 {
 	int x;
@@ -5723,6 +5731,14 @@
 	return 0;
 }
 
+
+/**
+ * dahdi_unregister() - Unregister a DAHDI span
+ * @span               The DAHDI span
+ *
+ * Unregisters a span that has been previously registered with
+ * dahdi_register().
+ */
 int dahdi_unregister(struct dahdi_span *span)
 {
 	int x;
@@ -6681,6 +6697,16 @@
 	}
 }
 
+/**
+ * dahdi_hooksig() - send a signal on a channel to userspace
+ * @chan               The DAHDI channel
+ * @rxsig              Signal (number) to send
+ *
+ * Called from a channel driver to send a DAHDI signal to userspace.
+ * The signal will be queued for delivery to userspace.
+ *
+ * If the signal is the same as previous one sent, it won't be re-sent.
+ */
 void dahdi_hooksig(struct dahdi_chan *chan, enum dahdi_rxsig rxsig)
 {
 	  /* skip if no change */
@@ -6690,6 +6716,14 @@
 	spin_unlock_irqrestore(&chan->lock, flags);
 }
 
+
+/**
+ * dahdi_rbsbits() - set Rx RBS bits on the channel
+ * @chan               The DAHDI channel
+ * @cursig              The bits to set
+ *
+ * Set the channel's rxsig and act accordingly.
+ */
 void dahdi_rbsbits(struct dahdi_chan *chan, int cursig)
 {
 	unsigned long flags;