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