channels/chan_misdn.c

*  Made bearer2str() use allowed_bearers_array[]
*  Made use the causes.h defines instead of hardcoded numbers.
*  Made use Asterisk presentation indicator values if either of the
mISDN presentation or screen options are negative.
*  Updated the misdn_set_opt application option descriptions.
*  Renamed the awkward Caller ID presentation misdn_set_opt
application option value not_screened to restricted.
Deprecated the not_screened option value.

channels/misdn/isdn_lib.c
*  Made use the causes.h defines instead of hardcoded numbers.
*  Fixed some spelling errors and typos.
*  Added all defined facility code strings to fac2str().

channels/misdn/isdn_lib.h
*  Added doxygen comments to struct misdn_bchannel.

channels/misdn/isdn_lib_intern.h
*  Added doxygen comments to struct misdn_stack.

channels/misdn_config.c
configs/misdn.conf.sample
*  Updated the mISDN presentation and screen parameter descriptions.

doc/tex/misdn.tex
*  Updated the misdn_set_opt application option descriptions.
*  Fixed some spelling errors and typos.



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@138738 65c4cc65-6c06-0410-ace0-fbb531ad65f3

1 files changed, 48 insertions, 28 deletions

diff --git a/channels/misdn/isdn_lib_intern.h b/channels/misdn/isdn_lib_intern.h
index 725ef963f..498c73935 100644
--- a/channels/misdn/isdn_lib_intern.h
+++ b/channels/misdn/isdn_lib_intern.h
@@ -28,8 +28,8 @@
 #endif
 
 
-ibuffer_t *astbuf;
-ibuffer_t *misdnbuf;
+ibuffer_t *astbuf;		/* Not used */
+ibuffer_t *misdnbuf;	/* Not used */
 
 struct send_lock {
 	pthread_mutex_t lock;
@@ -38,15 +38,14 @@ struct send_lock {
 
 struct isdn_msg {
 	unsigned long misdn_msg;
-  
+
 	enum layer_e layer;
 	enum event_e event;
-  
+
 	void (*msg_parser)(struct isdn_msg *msgs, msg_t *msg, struct misdn_bchannel *bc, int nt);
 	msg_t *(*msg_builder)(struct isdn_msg *msgs, struct misdn_bchannel *bc, int nt);
 	char *info;
-  
-} ; 
+} ;
 
 /* for isdn_msg_parser.c */
 msg_t *create_l3msg(int prim, int mt, int dinfo , int size, int nt);
@@ -57,57 +56,78 @@ struct misdn_stack {
 	/** is first element because &nst equals &mISDNlist **/
 	net_stack_t nst;
 	manager_t mgr;
-  
+
+	/*! \brief D Channel mISDN driver stack ID (Parent stack ID) */
 	int d_stid;
-  
+
+	/*! /brief Number of B channels supported by this port */
 	int b_num;
-  
+
+	/*! \brief B Channel mISDN driver stack IDs (Child stack IDs) */
 	int b_stids[MAX_BCHANS + 1];
-  
+
+	/*! \brief TRUE if Point-To-Point(PTP) (Point-To-Multipoint(PTMP) otherwise) */
 	int ptp;
 
+	/*! \brief Number of consecutive times PTP Layer 2 declared down */
 	int l2upcnt;
 
-	int l2_id;
+	int l2_id;	/* Not used */
+
+	/*! \brief Lower layer mISDN ID (addr) (Layer 1/3) */
 	int lower_id;
+
+	/*! \brief Upper layer mISDN ID (addr) (Layer 2/4) */
 	int upper_id;
-  
 
+	/*! \brief TRUE if port is blocked */
   	int blocked;
 
+	/*! \brief TRUE if Layer 2 is UP */
 	int l2link;
-  
-	time_t l2establish;
-  
+
+	time_t l2establish;	/* Not used */
+
+	/*! \brief TRUE if Layer 1 is UP */
 	int l1link;
 
+	/*! \brief TRUE if restart has been sent to the other side after stack startup */
 	int restart_sent;
 
+	/*! \brief mISDN device handle returned by mISDN_open() */
 	int midev;
-  
+
+	/*! \brief TRUE if NT side of protocol (TE otherwise) */
 	int nt;
-	
+
+	/*! \brief TRUE if ISDN-PRI (ISDN-BRI otherwise) */
 	int pri;
-  
 
+	/*! \brief CR Process ID allocation table.  TRUE if ID allocated */
 	int procids[0x100+1];
 
+	/*! \brief Queue of Event messages to send to mISDN */
 	msg_queue_t downqueue;
-	msg_queue_t upqueue;
-	int busy;
-  
+	msg_queue_t upqueue;	/* No code puts anything on this queue */
+	int busy;	/* Not used */
+
+	/*! \brief Logical Layer 1 port associated with this stack */
 	int port;
+
+	/*! \brief B Channel record pool array */
 	struct misdn_bchannel bc[MAX_BCHANS + 1];
-  
-	struct misdn_bchannel* bc_list; 
-  
+
+	struct misdn_bchannel* bc_list;	/* Not used */
+
+	/*! \brief Array of B channels in use (a[0] = B1).  TRUE if B channel in use */
 	int channels[MAX_BCHANS + 1];
 
-  
-	struct misdn_bchannel *holding; /* Queue which holds holded channels :) */
-  
+	/*! \brief List of holded channels */
+	struct misdn_bchannel *holding;
+
+	/*! \brief Next stack in the list of stacks */
 	struct misdn_stack *next;
-}; 
+};
 
 
 struct misdn_stack* get_stack_by_bc(struct misdn_bchannel *bc);