The inalarm flag is not passed up from the sig_analog and sig_pri submodules.
[asterisk/asterisk.git] / channels / sig_pri.h
1 #ifndef _SIG_PRI_H
2 #define _SIG_PRI_H
3 /*
4  * Asterisk -- An open source telephony toolkit.
5  *
6  * Copyright (C) 1999 - 2009, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief Interface header for PRI signaling module
24  *
25  * \author Matthew Fredrickson <creslin@digium.com>
26  */
27
28 #include "asterisk/channel.h"
29 #include "asterisk/frame.h"
30 #include "asterisk/ccss.h"
31 #include <libpri.h>
32 #include <dahdi/user.h>
33
34 #if defined(HAVE_PRI_CCSS)
35 /*! PRI debug message flags when normal PRI debugging is turned on at the command line. */
36 #define SIG_PRI_DEBUG_NORMAL    \
37         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
38         | PRI_DEBUG_CC)
39
40 /*! PRI debug message flags when intense PRI debugging is turned on at the command line. */
41 #define SIG_PRI_DEBUG_INTENSE   \
42         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
43         | PRI_DEBUG_CC | PRI_DEBUG_Q921_RAW | PRI_DEBUG_Q921_DUMP)
44
45 #else
46
47 /*! PRI debug message flags when normal PRI debugging is turned on at the command line. */
48 #define SIG_PRI_DEBUG_NORMAL    \
49         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE)
50
51 /*! PRI debug message flags when intense PRI debugging is turned on at the command line. */
52 #define SIG_PRI_DEBUG_INTENSE   \
53         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
54         | PRI_DEBUG_Q921_RAW | PRI_DEBUG_Q921_DUMP)
55 #endif  /* !defined(HAVE_PRI_CCSS) */
56
57 #if 0
58 /*! PRI debug message flags set on initial startup. */
59 #define SIG_PRI_DEBUG_DEFAULT   SIG_PRI_DEBUG_NORMAL
60 #else
61 /*! PRI debug message flags set on initial startup. */
62 #define SIG_PRI_DEBUG_DEFAULT   0
63 #endif
64
65 enum sig_pri_tone {
66         SIG_PRI_TONE_RINGTONE = 0,
67         SIG_PRI_TONE_STUTTER,
68         SIG_PRI_TONE_CONGESTION,
69         SIG_PRI_TONE_DIALTONE,
70         SIG_PRI_TONE_DIALRECALL,
71         SIG_PRI_TONE_INFO,
72         SIG_PRI_TONE_BUSY,
73 };
74
75 enum sig_pri_law {
76         SIG_PRI_DEFLAW = 0,
77         SIG_PRI_ULAW,
78         SIG_PRI_ALAW
79 };
80
81 struct sig_pri_pri;
82
83 struct sig_pri_callback {
84         /* Unlock the private in the signalling private structure.  This is used for three way calling madness. */
85         void (* const unlock_private)(void *pvt);
86         /* Lock the private in the signalling private structure.  ... */
87         void (* const lock_private)(void *pvt);
88         /* Function which is called back to handle any other DTMF up events that are received.  Called by analog_handle_event.  Why is this
89          * important to use, instead of just directly using events received before they are passed into the library?  Because sometimes,
90          * (CWCID) the library absorbs DTMF events received. */
91         //void (* const handle_dtmfup)(void *pvt, struct ast_channel *ast, enum analog_sub analog_index, struct ast_frame **dest);
92
93         //int (* const dial_digits)(void *pvt, enum analog_sub sub, struct analog_dialoperation *dop);
94         int (* const play_tone)(void *pvt, enum sig_pri_tone tone);
95
96         int (* const set_echocanceller)(void *pvt, int enable);
97         int (* const train_echocanceller)(void *pvt);
98         int (* const dsp_reset_and_flush_digits)(void *pvt);
99
100         struct ast_channel * (* const new_ast_channel)(void *pvt, int state, int startpbx, enum sig_pri_law law, int transfercapability, char *exten, const struct ast_channel *chan);
101
102         void (* const fixup_chans)(void *old_chan, void *new_chan);
103
104         /* Note: Called with PRI lock held */
105         void (* const handle_dchan_exception)(struct sig_pri_pri *pri, int index);
106         void (* const set_alarm)(void *pvt, int in_alarm);
107         void (* const set_dialing)(void *pvt, int is_dialing);
108         void (* const set_digital)(void *pvt, int is_digital);
109         void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
110         void (* const set_dnid)(void *pvt, const char *dnid);
111         void (* const set_rdnis)(void *pvt, const char *rdnis);
112         void (* const queue_control)(void *pvt, int subclass);
113         int (* const new_nobch_intf)(struct sig_pri_pri *pri);
114         const char *(* const get_orig_dialstring)(void *pvt);
115         void (* const make_cc_dialstring)(void *pvt, char *buf, size_t buf_size);
116         void (* const update_span_devstate)(struct sig_pri_pri *pri);
117
118         /*! Reference the parent module. */
119         void (*module_ref)(void);
120         /*! Unreference the parent module. */
121         void (*module_unref)(void);
122 };
123
124 #define SIG_PRI_NUM_DCHANS              4               /*!< No more than 4 d-channels */
125 #define SIG_PRI_MAX_CHANNELS    672             /*!< No more than a DS3 per trunk group */
126
127 #define SIG_PRI         DAHDI_SIG_CLEAR
128 #define SIG_BRI         (0x2000000 | DAHDI_SIG_CLEAR)
129 #define SIG_BRI_PTMP    (0X4000000 | DAHDI_SIG_CLEAR)
130
131 /* QSIG channel mapping option types */
132 #define DAHDI_CHAN_MAPPING_PHYSICAL     0
133 #define DAHDI_CHAN_MAPPING_LOGICAL      1
134
135 /* Overlap dialing option types */
136 #define DAHDI_OVERLAPDIAL_NONE 0
137 #define DAHDI_OVERLAPDIAL_OUTGOING 1
138 #define DAHDI_OVERLAPDIAL_INCOMING 2
139 #define DAHDI_OVERLAPDIAL_BOTH (DAHDI_OVERLAPDIAL_INCOMING|DAHDI_OVERLAPDIAL_OUTGOING)
140
141 #if defined(HAVE_PRI_SERVICE_MESSAGES)
142 /*! \brief Persistent Service State */
143 #define SRVST_DBKEY "service-state"
144 /*! \brief The out-of-service SERVICE state */
145 #define SRVST_TYPE_OOS "O"
146 /*! \brief SRVST_INITIALIZED is used to indicate a channel being out-of-service
147  *  The SRVST_INITIALIZED is mostly used maintain backwards compatibility but also may
148  *  mean that the channel has not yet received a RESTART message.  If a channel is
149  *  out-of-service with this reason a RESTART message will result in the channel
150  *  being put into service. */
151 #define SRVST_INITIALIZED 0
152 /*! \brief SRVST_NEAREND is used to indicate that the near end was put out-of-service */
153 #define SRVST_NEAREND  (1 << 0)
154 /*! \brief SRVST_FAREND is used to indicate that the far end was taken out-of-service */
155 #define SRVST_FAREND   (1 << 1)
156 /*! \brief SRVST_BOTH is used to indicate that both sides of the channel are out-of-service */
157 #define SRVST_BOTH (SRVST_NEAREND | SRVST_FAREND)
158
159 /*! \brief The AstDB family */
160 static const char dahdi_db[] = "dahdi/registry";
161 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
162
163 struct sig_pri_chan {
164         /* Options to be set by user */
165         unsigned int hidecallerid:1;
166         unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
167         unsigned int immediate:1;                       /*!< Answer before getting digits? */
168         unsigned int priexclusive:1;                    /*!< Whether or not to override and use exculsive mode for channel selection */
169         unsigned int priindication_oob:1;
170         unsigned int use_callerid:1;                    /*!< Whether or not to use caller id on this channel */
171         unsigned int use_callingpres:1;                 /*!< Whether to use the callingpres the calling switch sends */
172         char context[AST_MAX_CONTEXT];
173         char mohinterpret[MAX_MUSICCLASS];
174         int stripmsd;
175         int channel;                                    /*!< Channel Number or CRV */
176
177         /* Options to be checked by user */
178         int cid_ani2;                                           /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
179         int cid_ton;                                    /*!< Type Of Number (TON) */
180         int callingpres;                                /*!< The value of calling presentation that we're going to use when placing a PRI call */
181         char cid_num[AST_MAX_EXTENSION];
182         char cid_subaddr[AST_MAX_EXTENSION];
183         char cid_name[AST_MAX_EXTENSION];
184         char cid_ani[AST_MAX_EXTENSION];
185         char exten[AST_MAX_EXTENSION];
186
187         /* Internal variables -- Don't touch */
188         /* Probably will need DS0 number, DS1 number, and a few other things */
189         char dialdest[256];                             /* Queued up digits for overlap dialing.  They will be sent out as information messages when setup ACK is received */
190 #if defined(HAVE_PRI_SETUP_KEYPAD)
191         /*! \brief Keypad digits that came in with the SETUP message. */
192         char keypad_digits[AST_MAX_EXTENSION];
193 #endif  /* defined(HAVE_PRI_SETUP_KEYPAD) */
194
195         unsigned int inalarm:1;
196         unsigned int alerting:1;                /*!< TRUE if channel is alerting/ringing */
197         unsigned int alreadyhungup:1;   /*!< TRUE if the call has already gone/hungup */
198         unsigned int isidlecall:1;              /*!< TRUE if this is an idle call */
199         unsigned int proceeding:1;              /*!< TRUE if call is in a proceeding state */
200         unsigned int progress:1;                /*!< TRUE if the call has seen progress through the network */
201         unsigned int resetting:1;               /*!< TRUE if this channel is being reset/restarted */
202         unsigned int setup_ack:1;               /*!< TRUE if this channel has received a SETUP_ACKNOWLEDGE */
203
204         unsigned int outgoing:1;
205         unsigned int digital:1;
206         /*! \brief TRUE if this interface has no B channel.  (call hold and call waiting) */
207         unsigned int no_b_channel:1;
208
209         struct ast_channel *owner;
210
211         struct sig_pri_pri *pri;
212         q931_call *call;                                /*!< opaque libpri call control structure */
213
214         int prioffset;                                  /*!< channel number in span */
215         int logicalspan;                                /*!< logical span number within trunk group */
216         int mastertrunkgroup;                   /*!< what trunk group is our master */
217 #if defined(HAVE_PRI_SERVICE_MESSAGES)
218         /*! \brief Active SRVST_DBKEY out-of-service status value. */
219         unsigned service_status;
220 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
221
222         struct sig_pri_callback *calls;
223         void *chan_pvt;                                 /*!< Private structure of the user of this module. */
224 #if defined(HAVE_PRI_REVERSE_CHARGE)
225         /*!
226          * \brief Reverse charging indication
227          * \details
228          * -1 - No reverse charging,
229          *  1 - Reverse charging,
230          * 0,2-7 - Reserved for future use
231          */
232         int reverse_charging_indication;
233 #endif
234 };
235
236 struct sig_pri_pri {
237         /* Should be set by user */
238         struct ast_cc_config_params *cc_params;                 /*!< CC config parameters for each new call. */
239         int     pritimers[PRI_MAX_TIMERS];
240         int overlapdial;                                                                /*!< In overlap dialing mode */
241         int qsigchannelmapping;                                                 /*!< QSIG channel mapping type */
242         int discardremoteholdretrieval;                                 /*!< shall remote hold or remote retrieval notifications be discarded? */
243         int facilityenable;                                                             /*!< Enable facility IEs */
244         int dchan_logical_span[SIG_PRI_NUM_DCHANS];             /*!< Logical offset the DCHAN sits in */
245         int fds[SIG_PRI_NUM_DCHANS];                                    /*!< FD's for d-channels */
246 #if defined(HAVE_PRI_SERVICE_MESSAGES)
247         unsigned int enable_service_message_support:1;  /*!< enable SERVICE message support */
248 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
249 #ifdef HAVE_PRI_INBANDDISCONNECT
250         unsigned int inbanddisconnect:1;                                /*!< Should we support inband audio after receiving DISCONNECT? */
251 #endif
252 #if defined(HAVE_PRI_CALL_HOLD)
253         /*! \brief TRUE if held calls are transferred on disconnect. */
254         unsigned int hold_disconnect_transfer:1;
255 #endif  /* defined(HAVE_PRI_CALL_HOLD) */
256         int dialplan;                                                   /*!< Dialing plan */
257         int localdialplan;                                              /*!< Local dialing plan */
258         char internationalprefix[10];                   /*!< country access code ('00' for european dialplans) */
259         char nationalprefix[10];                                /*!< area access code ('0' for european dialplans) */
260         char localprefix[20];                                   /*!< area access code + area code ('0'+area code for european dialplans) */
261         char privateprefix[20];                                 /*!< for private dialplans */
262         char unknownprefix[20];                                 /*!< for unknown dialplans */
263         long resetinterval;                                             /*!< Interval (in seconds) for resetting unused channels */
264         char msn_list[AST_MAX_EXTENSION];               /*!< Comma separated list of MSNs to handle.  Empty if disabled. */
265         char idleext[AST_MAX_EXTENSION];                /*!< Where to idle extra calls */
266         char idlecontext[AST_MAX_CONTEXT];              /*!< What context to use for idle */
267         char idledial[AST_MAX_EXTENSION];               /*!< What to dial before dumping */
268         int minunused;                                                  /*!< Min # of channels to keep empty */
269         int minidle;                                                    /*!< Min # of "idling" calls to keep active */
270         int nodetype;                                                   /*!< Node type */
271         int switchtype;                                                 /*!< Type of switch to emulate */
272         int nsf;                                                                /*!< Network-Specific Facilities */
273         int trunkgroup;                                                 /*!< What our trunkgroup is */
274 #if defined(HAVE_PRI_CCSS)
275         int cc_ptmp_recall_mode;                                /*!< CC PTMP recall mode. globalRecall(0), specificRecall(1) */
276         int cc_qsig_signaling_link_req;                 /*!< CC Q.SIG signaling link retention (Party A) release(0), retain(1), do-not-care(2) */
277         int cc_qsig_signaling_link_rsp;                 /*!< CC Q.SIG signaling link retention (Party B) release(0), retain(1) */
278 #endif  /* defined(HAVE_PRI_CCSS) */
279
280         int dchanavail[SIG_PRI_NUM_DCHANS];             /*!< Whether each channel is available */
281         int debug;                                                              /*!< set to true if to dump PRI event info (tested but never set) */
282         int span;                                                               /*!< span number put into user output messages */
283         int resetting;                                                  /*!< true if span is being reset/restarted */
284         int resetpos;                                                   /*!< current position during a reset (-1 if not started) */
285         int sig;                                                                /*!< ISDN signalling type (SIG_PRI, SIG_BRI, SIG_BRI_PTMP, etc...) */
286         int new_chan_seq;                                               /*!< New struct ast_channel sequence number */
287
288         /* Everything after here is internally set */
289         struct pri *dchans[SIG_PRI_NUM_DCHANS];         /*!< Actual d-channels */
290         struct pri *pri;                                                        /*!< Currently active D-channel */
291         /*!
292          * List of private structures of the user of this module for no B channel
293          * interfaces. (hold and call waiting interfaces)
294          */
295         void *no_b_chan_iflist;
296         /*!
297          * List of private structures of the user of this module for no B channel
298          * interfaces. (hold and call waiting interfaces)
299          */
300         void *no_b_chan_end;
301         int numchans;                                                           /*!< Num of channels we represent */
302         struct sig_pri_chan *pvts[SIG_PRI_MAX_CHANNELS];/*!< Member channel pvt structs */
303         pthread_t master;                                                       /*!< Thread of master */
304         ast_mutex_t lock;                                                       /*!< libpri access Mutex */
305         time_t lastreset;                                                       /*!< time when unused channels were last reset */
306         struct sig_pri_callback *calls;
307         /*!
308          * \brief Congestion device state of the span.
309          * \details
310          * AST_DEVICE_NOT_INUSE - Span does not have all B channels in use.
311          * AST_DEVICE_BUSY - All B channels are in use.
312          * AST_DEVICE_UNAVAILABLE - Span is in alarm.
313          * \note
314          * Device name:  DAHDI/I<span>/congestion
315          */
316         int congestion_devstate;
317 #if defined(THRESHOLD_DEVSTATE_PLACEHOLDER)
318         /*! \todo An ISDN span threshold device state could be useful in determining how often a span utilization goes over a configurable threshold. */
319         /*!
320          * \brief User threshold device state of the span.
321          * \details
322          * AST_DEVICE_NOT_INUSE - There are no B channels in use.
323          * AST_DEVICE_INUSE - The number of B channels in use is less than
324          *    the configured threshold but not zero.
325          * AST_DEVICE_BUSY - The number of B channels in use meets or exceeds
326          *    the configured threshold.
327          * AST_DEVICE_UNAVAILABLE - Span is in alarm.
328          * \note
329          * Device name:  DAHDI/I<span>/threshold
330          */
331         int threshold_devstate;
332         /*!
333          * \brief Number of B channels in use to consider the span in a busy state.
334          * \note Setting the threshold to zero is interpreted as all B channels.
335          */
336         int user_busy_threshold;
337 #endif  /* defined(THRESHOLD_DEVSTATE_PLACEHOLDER) */
338 };
339
340 void sig_pri_extract_called_num_subaddr(struct sig_pri_chan *p, const char *rdest, char *called, size_t called_buff_size);
341 int sig_pri_call(struct sig_pri_chan *p, struct ast_channel *ast, char *rdest, int timeout, int layer1);
342
343 int sig_pri_hangup(struct sig_pri_chan *p, struct ast_channel *ast);
344
345 int sig_pri_indicate(struct sig_pri_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
346
347 int sig_pri_answer(struct sig_pri_chan *p, struct ast_channel *ast);
348
349 int sig_pri_available(struct sig_pri_chan *p);
350
351 void sig_pri_init_pri(struct sig_pri_pri *pri);
352
353 /* If return 0, it means this function was able to handle it (pre setup digits).  If non zero, the user of this
354  * functions should handle it normally (generate inband DTMF) */
355 int sig_pri_digit_begin(struct sig_pri_chan *pvt, struct ast_channel *ast, char digit);
356
357 int sig_pri_start_pri(struct sig_pri_pri *pri);
358
359 void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm);
360
361 void pri_event_alarm(struct sig_pri_pri *pri, int index, int before_start_pri);
362
363 void pri_event_noalarm(struct sig_pri_pri *pri, int index, int before_start_pri);
364
365 struct ast_channel *sig_pri_request(struct sig_pri_chan *p, enum sig_pri_law law, const struct ast_channel *requestor, int transfercapability);
366
367 struct sig_pri_chan *sig_pri_chan_new(void *pvt_data, struct sig_pri_callback *callback, struct sig_pri_pri *pri, int logicalspan, int channo, int trunkgroup);
368 void sig_pri_chan_delete(struct sig_pri_chan *doomed);
369
370 int pri_is_up(struct sig_pri_pri *pri);
371
372 void sig_pri_cli_show_spans(int fd, int span, struct sig_pri_pri *pri);
373
374 void sig_pri_cli_show_span(int fd, int *dchannels, struct sig_pri_pri *pri);
375
376 int pri_send_keypad_facility_exec(struct sig_pri_chan *p, const char *digits);
377 int pri_send_callrerouting_facility_exec(struct sig_pri_chan *p, enum ast_channel_state chanstate, const char *destination, const char *original, const char *reason);
378
379 #if defined(HAVE_PRI_SERVICE_MESSAGES)
380 int pri_maintenance_bservice(struct pri *pri, struct sig_pri_chan *p, int changestatus);
381 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
382
383 void sig_pri_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_pri_chan *pchan);
384
385 int sig_pri_cc_agent_init(struct ast_cc_agent *agent, struct sig_pri_chan *pvt_chan);
386 int sig_pri_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
387 int sig_pri_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
388 void sig_pri_cc_agent_req_ack(struct ast_cc_agent *agent);
389 int sig_pri_cc_agent_status_req(struct ast_cc_agent *agent);
390 int sig_pri_cc_agent_stop_ringing(struct ast_cc_agent *agent);
391 int sig_pri_cc_agent_party_b_free(struct ast_cc_agent *agent);
392 int sig_pri_cc_agent_start_monitoring(struct ast_cc_agent *agent);
393 int sig_pri_cc_agent_callee_available(struct ast_cc_agent *agent);
394 void sig_pri_cc_agent_destructor(struct ast_cc_agent *agent);
395
396 int sig_pri_cc_monitor_req_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
397 int sig_pri_cc_monitor_suspend(struct ast_cc_monitor *monitor);
398 int sig_pri_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
399 int sig_pri_cc_monitor_status_rsp(struct ast_cc_monitor *monitor, enum ast_device_state devstate);
400 int sig_pri_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
401 void sig_pri_cc_monitor_destructor(void *monitor_pvt);
402
403 int sig_pri_load(const char *cc_type_name);
404 void sig_pri_unload(void);
405
406 #endif /* _SIG_PRI_H */