bbf517d3de34900301d0c7450211b0aee787ea80
[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/event.h"
31 #include "asterisk/ccss.h"
32 #include <libpri.h>
33 #include <dahdi/user.h>
34
35 #if defined(HAVE_PRI_CCSS)
36 /*! PRI debug message flags when normal PRI debugging is turned on at the command line. */
37 #define SIG_PRI_DEBUG_NORMAL    \
38         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
39         | PRI_DEBUG_CC)
40
41 /*! PRI debug message flags when intense PRI debugging is turned on at the command line. */
42 #define SIG_PRI_DEBUG_INTENSE   \
43         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
44         | PRI_DEBUG_CC | PRI_DEBUG_Q921_RAW | PRI_DEBUG_Q921_DUMP)
45
46 #else
47
48 /*! PRI debug message flags when normal PRI debugging is turned on at the command line. */
49 #define SIG_PRI_DEBUG_NORMAL    \
50         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE)
51
52 /*! PRI debug message flags when intense PRI debugging is turned on at the command line. */
53 #define SIG_PRI_DEBUG_INTENSE   \
54         (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
55         | PRI_DEBUG_Q921_RAW | PRI_DEBUG_Q921_DUMP)
56 #endif  /* !defined(HAVE_PRI_CCSS) */
57
58 #if 0
59 /*! PRI debug message flags set on initial startup. */
60 #define SIG_PRI_DEBUG_DEFAULT   SIG_PRI_DEBUG_NORMAL
61 #else
62 /*! PRI debug message flags set on initial startup. */
63 #define SIG_PRI_DEBUG_DEFAULT   0
64 #endif
65
66 #define SIG_PRI_AOC_GRANT_S    (1 << 0)
67 #define SIG_PRI_AOC_GRANT_D    (1 << 1)
68 #define SIG_PRI_AOC_GRANT_E    (1 << 2)
69
70 enum sig_pri_tone {
71         SIG_PRI_TONE_RINGTONE = 0,
72         SIG_PRI_TONE_STUTTER,
73         SIG_PRI_TONE_CONGESTION,
74         SIG_PRI_TONE_DIALTONE,
75         SIG_PRI_TONE_DIALRECALL,
76         SIG_PRI_TONE_INFO,
77         SIG_PRI_TONE_BUSY,
78 };
79
80 enum sig_pri_law {
81         SIG_PRI_DEFLAW = 0,
82         SIG_PRI_ULAW,
83         SIG_PRI_ALAW
84 };
85
86 enum sig_pri_moh_signaling {
87         /*! Generate MOH to the remote party. */
88         SIG_PRI_MOH_SIGNALING_MOH,
89         /*! Send hold notification signaling to the remote party. */
90         SIG_PRI_MOH_SIGNALING_NOTIFY,
91 #if defined(HAVE_PRI_CALL_HOLD)
92         /*! Use HOLD/RETRIEVE signaling to release the B channel while on hold. */
93         SIG_PRI_MOH_SIGNALING_HOLD,
94 #endif  /* defined(HAVE_PRI_CALL_HOLD) */
95 };
96
97 enum sig_pri_moh_state {
98         /*! Bridged peer has not put us on hold. */
99         SIG_PRI_MOH_STATE_IDLE,
100         /*! Bridged peer has put us on hold and we were to notify the remote party. */
101         SIG_PRI_MOH_STATE_NOTIFY,
102         /*! Bridged peer has put us on hold and we were to play MOH or HOLD/RETRIEVE fallback. */
103         SIG_PRI_MOH_STATE_MOH,
104 #if defined(HAVE_PRI_CALL_HOLD)
105         /*! Requesting to put channel on hold. */
106         SIG_PRI_MOH_STATE_HOLD_REQ,
107         /*! Trying to go on hold when bridged peer requested to unhold. */
108         SIG_PRI_MOH_STATE_PEND_UNHOLD,
109         /*! Channel is held. */
110         SIG_PRI_MOH_STATE_HOLD,
111         /*! Requesting to take channel out of hold. */
112         SIG_PRI_MOH_STATE_RETRIEVE_REQ,
113         /*! Trying to take channel out of hold when bridged peer requested to hold. */
114         SIG_PRI_MOH_STATE_PEND_HOLD,
115         /*! Failed to take the channel out of hold. No B channels were available? */
116         SIG_PRI_MOH_STATE_RETRIEVE_FAIL,
117 #endif  /* defined(HAVE_PRI_CALL_HOLD) */
118
119         /*! Number of MOH states.  Must be last in enum. */
120         SIG_PRI_MOH_STATE_NUM
121 };
122
123 enum sig_pri_moh_event {
124         /*! Reset the MOH state machine. (Because of hangup.) */
125         SIG_PRI_MOH_EVENT_RESET,
126         /*! Bridged peer placed this channel on hold. */
127         SIG_PRI_MOH_EVENT_HOLD,
128         /*! Bridged peer took this channel off hold. */
129         SIG_PRI_MOH_EVENT_UNHOLD,
130 #if defined(HAVE_PRI_CALL_HOLD)
131         /*! The hold request was successfully acknowledged. */
132         SIG_PRI_MOH_EVENT_HOLD_ACK,
133         /*! The hold request was rejected. */
134         SIG_PRI_MOH_EVENT_HOLD_REJ,
135         /*! The unhold request was successfully acknowledged. */
136         SIG_PRI_MOH_EVENT_RETRIEVE_ACK,
137         /*! The unhold request was rejected. */
138         SIG_PRI_MOH_EVENT_RETRIEVE_REJ,
139         /*! The remote party took this channel off hold. */
140         SIG_PRI_MOH_EVENT_REMOTE_RETRIEVE_ACK,
141 #endif  /* defined(HAVE_PRI_CALL_HOLD) */
142
143         /*! Number of MOH events.  Must be last in enum. */
144         SIG_PRI_MOH_EVENT_NUM
145 };
146
147 /*! Call establishment life cycle level for simple comparisons. */
148 enum sig_pri_call_level {
149         /*! Call does not exist. */
150         SIG_PRI_CALL_LEVEL_IDLE,
151         /*! Call is present but has no response yet. (SETUP) */
152         SIG_PRI_CALL_LEVEL_SETUP,
153         /*! Call is collecting digits for overlap dialing. (SETUP ACKNOWLEDGE) */
154         SIG_PRI_CALL_LEVEL_OVERLAP,
155         /*! Call routing is happening. (PROCEEDING) */
156         SIG_PRI_CALL_LEVEL_PROCEEDING,
157         /*! Called party is being alerted of the call. (ALERTING) */
158         SIG_PRI_CALL_LEVEL_ALERTING,
159         /*! Call is connected/answered. (CONNECT) */
160         SIG_PRI_CALL_LEVEL_CONNECT,
161 };
162
163 struct sig_pri_span;
164
165 struct sig_pri_callback {
166         /* Unlock the private in the signalling private structure.  This is used for three way calling madness. */
167         void (* const unlock_private)(void *pvt);
168         /* Lock the private in the signalling private structure.  ... */
169         void (* const lock_private)(void *pvt);
170         /* Function which is called back to handle any other DTMF events that are received.  Called by analog_handle_event.  Why is this
171          * important to use, instead of just directly using events received before they are passed into the library?  Because sometimes,
172          * (CWCID) the library absorbs DTMF events received. */
173         //void (* const handle_dtmf)(void *pvt, struct ast_channel *ast, enum analog_sub analog_index, struct ast_frame **dest);
174
175         //int (* const dial_digits)(void *pvt, enum analog_sub sub, struct analog_dialoperation *dop);
176         int (* const play_tone)(void *pvt, enum sig_pri_tone tone);
177
178         int (* const set_echocanceller)(void *pvt, int enable);
179         int (* const train_echocanceller)(void *pvt);
180         int (* const dsp_reset_and_flush_digits)(void *pvt);
181
182         struct ast_channel * (* const new_ast_channel)(void *pvt, int state, enum sig_pri_law law, char *exten, const struct ast_channel *chan);
183
184         void (* const fixup_chans)(void *old_chan, void *new_chan);
185
186         /* Note: Called with PRI lock held */
187         void (* const handle_dchan_exception)(struct sig_pri_span *pri, int index);
188         void (* const set_alarm)(void *pvt, int in_alarm);
189         void (* const set_dialing)(void *pvt, int is_dialing);
190         void (* const set_digital)(void *pvt, int is_digital);
191         void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
192         void (* const set_dnid)(void *pvt, const char *dnid);
193         void (* const set_rdnis)(void *pvt, const char *rdnis);
194         void (* const queue_control)(void *pvt, int subclass);
195         int (* const new_nobch_intf)(struct sig_pri_span *pri);
196         void (* const init_config)(void *pvt, struct sig_pri_span *pri);
197         const char *(* const get_orig_dialstring)(void *pvt);
198         void (* const make_cc_dialstring)(void *pvt, char *buf, size_t buf_size);
199         void (* const update_span_devstate)(struct sig_pri_span *pri);
200
201         void (* const open_media)(void *pvt);
202
203         /*! Reference the parent module. */
204         void (*module_ref)(void);
205         /*! Unreference the parent module. */
206         void (*module_unref)(void);
207 };
208
209 #define SIG_PRI_NUM_DCHANS              4               /*!< No more than 4 d-channels */
210 #define SIG_PRI_MAX_CHANNELS    672             /*!< No more than a DS3 per trunk group */
211
212 #define SIG_PRI         DAHDI_SIG_CLEAR
213 #define SIG_BRI         (0x2000000 | DAHDI_SIG_CLEAR)
214 #define SIG_BRI_PTMP    (0X4000000 | DAHDI_SIG_CLEAR)
215
216 /* QSIG channel mapping option types */
217 #define DAHDI_CHAN_MAPPING_PHYSICAL     0
218 #define DAHDI_CHAN_MAPPING_LOGICAL      1
219
220 /* Overlap dialing option types */
221 #define DAHDI_OVERLAPDIAL_NONE 0
222 #define DAHDI_OVERLAPDIAL_OUTGOING 1
223 #define DAHDI_OVERLAPDIAL_INCOMING 2
224 #define DAHDI_OVERLAPDIAL_BOTH (DAHDI_OVERLAPDIAL_INCOMING|DAHDI_OVERLAPDIAL_OUTGOING)
225
226 #if defined(HAVE_PRI_SERVICE_MESSAGES)
227 /*! \brief Persistent Service State */
228 #define SRVST_DBKEY "service-state"
229 /*! \brief The out-of-service SERVICE state */
230 #define SRVST_TYPE_OOS "O"
231 /*! \brief SRVST_INITIALIZED is used to indicate a channel being out-of-service
232  *  The SRVST_INITIALIZED is mostly used maintain backwards compatibility but also may
233  *  mean that the channel has not yet received a RESTART message.  If a channel is
234  *  out-of-service with this reason a RESTART message will result in the channel
235  *  being put into service. */
236 #define SRVST_INITIALIZED 0
237 /*! \brief SRVST_NEAREND is used to indicate that the near end was put out-of-service */
238 #define SRVST_NEAREND  (1 << 0)
239 /*! \brief SRVST_FAREND is used to indicate that the far end was taken out-of-service */
240 #define SRVST_FAREND   (1 << 1)
241 /*! \brief SRVST_BOTH is used to indicate that both sides of the channel are out-of-service */
242 #define SRVST_BOTH (SRVST_NEAREND | SRVST_FAREND)
243
244 /*! \brief The AstDB family */
245 static const char dahdi_db[] = "dahdi/registry";
246 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
247
248 struct sig_pri_chan {
249         /* Options to be set by user */
250         unsigned int hidecallerid:1;
251         unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
252         unsigned int immediate:1;                       /*!< Answer before getting digits? */
253         unsigned int priexclusive:1;                    /*!< Whether or not to override and use exculsive mode for channel selection */
254         unsigned int priindication_oob:1;
255         unsigned int use_callerid:1;                    /*!< Whether or not to use caller id on this channel */
256         unsigned int use_callingpres:1;                 /*!< Whether to use the callingpres the calling switch sends */
257         char context[AST_MAX_CONTEXT];
258         char mohinterpret[MAX_MUSICCLASS];
259         int stripmsd;
260         int channel;                                    /*!< Channel Number or CRV */
261
262         /* Options to be checked by user */
263         int cid_ani2;                                           /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
264         int cid_ton;                                    /*!< Type Of Number (TON) */
265         int callingpres;                                /*!< The value of calling presentation that we're going to use when placing a PRI call */
266         char cid_num[AST_MAX_EXTENSION];
267         char cid_subaddr[AST_MAX_EXTENSION];
268         char cid_name[AST_MAX_EXTENSION];
269         char cid_ani[AST_MAX_EXTENSION];
270         /*! \brief User tag for party id's sent from this device driver. */
271         char user_tag[AST_MAX_EXTENSION];
272         char exten[AST_MAX_EXTENSION];
273
274         /* Internal variables -- Don't touch */
275         /* Probably will need DS0 number, DS1 number, and a few other things */
276         char dialdest[256];                             /* Queued up digits for overlap dialing.  They will be sent out as information messages when setup ACK is received */
277 #if defined(HAVE_PRI_SETUP_KEYPAD)
278         /*! \brief Keypad digits that came in with the SETUP message. */
279         char keypad_digits[AST_MAX_EXTENSION];
280 #endif  /* defined(HAVE_PRI_SETUP_KEYPAD) */
281         /*! Music class suggested with AST_CONTROL_HOLD. */
282         char moh_suggested[MAX_MUSICCLASS];
283         enum sig_pri_moh_state moh_state;
284
285 #if defined(HAVE_PRI_AOC_EVENTS)
286         struct pri_subcmd_aoc_e aoc_e;
287         int aoc_s_request_invoke_id;     /*!< If an AOC-S request was present for the call, this is the invoke_id to use for the response */
288         unsigned int aoc_s_request_invoke_id_valid:1; /*!< This is set when the AOC-S invoke id is present */
289         unsigned int waiting_for_aoce:1; /*!< Delaying hangup for AOC-E msg. If this is set and AOC-E is received, continue with hangup before timeout period. */
290         unsigned int holding_aoce:1;     /*!< received AOC-E msg from asterisk. holding for disconnect/release */
291 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
292         unsigned int inalarm:1;
293         unsigned int alreadyhungup:1;   /*!< TRUE if the call has already gone/hungup */
294         unsigned int isidlecall:1;              /*!< TRUE if this is an idle call */
295         unsigned int progress:1;                /*!< TRUE if the call has seen inband-information progress through the network */
296         unsigned int resetting:1;               /*!< TRUE if this channel is being reset/restarted */
297
298         unsigned int outgoing:1;
299         unsigned int digital:1;
300         /*! \brief TRUE if this interface has no B channel.  (call hold and call waiting) */
301         unsigned int no_b_channel:1;
302 #if defined(HAVE_PRI_CALL_WAITING)
303         /*! \brief TRUE if this is a call waiting call */
304         unsigned int is_call_waiting:1;
305 #endif  /* defined(HAVE_PRI_CALL_WAITING) */
306
307         struct ast_channel *owner;
308
309         struct sig_pri_span *pri;
310         q931_call *call;                                /*!< opaque libpri call control structure */
311
312         /*! Call establishment life cycle level for simple comparisons. */
313         enum sig_pri_call_level call_level;
314         int prioffset;                                  /*!< channel number in span */
315         int logicalspan;                                /*!< logical span number within trunk group */
316         int mastertrunkgroup;                   /*!< what trunk group is our master */
317 #if defined(HAVE_PRI_SERVICE_MESSAGES)
318         /*! \brief Active SRVST_DBKEY out-of-service status value. */
319         unsigned service_status;
320 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
321
322         struct sig_pri_callback *calls;
323         void *chan_pvt;                                 /*!< Private structure of the user of this module. */
324 #if defined(HAVE_PRI_REVERSE_CHARGE)
325         /*!
326          * \brief Reverse charging indication
327          * \details
328          * -1 - No reverse charging,
329          *  1 - Reverse charging,
330          * 0,2-7 - Reserved for future use
331          */
332         int reverse_charging_indication;
333 #endif
334 };
335
336 #if defined(HAVE_PRI_MWI)
337 /*! Maximum number of mailboxes per span. */
338 #define SIG_PRI_MAX_MWI_MAILBOXES                       8
339 /*! Typical maximum length of mwi mailbox number */
340 #define SIG_PRI_MAX_MWI_MBOX_NUMBER_LEN         10      /* digits in number */
341 /*! Typical maximum length of mwi mailbox context */
342 #define SIG_PRI_MAX_MWI_CONTEXT_LEN                     10
343 /*!
344  * \brief Maximum mwi_mailbox string length.
345  * \details
346  * max_length = #mailboxes * (mbox_number + '@' + context + ',')
347  * The last ',' is a null terminator instead.
348  */
349 #define SIG_PRI_MAX_MWI_MAILBOX_STR             (SIG_PRI_MAX_MWI_MAILBOXES      \
350         * (SIG_PRI_MAX_MWI_MBOX_NUMBER_LEN + 1 + SIG_PRI_MAX_MWI_CONTEXT_LEN + 1))
351
352 struct sig_pri_mbox {
353         /*!
354          * \brief MWI mailbox event subscription.
355          * \note NULL if mailbox not configured.
356          */
357         struct ast_event_sub *sub;
358         /*! \brief Mailbox number */
359         const char *number;
360         /*! \brief Mailbox context. */
361         const char *context;
362 };
363 #endif  /* defined(HAVE_PRI_MWI) */
364
365 struct sig_pri_span {
366         /* Should be set by user */
367         struct ast_cc_config_params *cc_params;                 /*!< CC config parameters for each new call. */
368         int     pritimers[PRI_MAX_TIMERS];
369         int overlapdial;                                                                /*!< In overlap dialing mode */
370         int qsigchannelmapping;                                                 /*!< QSIG channel mapping type */
371         int discardremoteholdretrieval;                                 /*!< shall remote hold or remote retrieval notifications be discarded? */
372         int facilityenable;                                                             /*!< Enable facility IEs */
373         int dchan_logical_span[SIG_PRI_NUM_DCHANS];             /*!< Logical offset the DCHAN sits in */
374         int fds[SIG_PRI_NUM_DCHANS];                                    /*!< FD's for d-channels */
375
376 #if defined(HAVE_PRI_AOC_EVENTS)
377         int aoc_passthrough_flag;                                               /*!< Represents what AOC messages (S,D,E) are allowed to pass-through */
378         unsigned int aoce_delayhangup:1;                                /*!< defines whether the aoce_delayhangup option is enabled or not */
379 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
380
381 #if defined(HAVE_PRI_SERVICE_MESSAGES)
382         unsigned int enable_service_message_support:1;  /*!< enable SERVICE message support */
383 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
384 #ifdef HAVE_PRI_INBANDDISCONNECT
385         unsigned int inbanddisconnect:1;                                /*!< Should we support inband audio after receiving DISCONNECT? */
386 #endif
387 #if defined(HAVE_PRI_CALL_HOLD)
388         /*! \brief TRUE if held calls are transferred on disconnect. */
389         unsigned int hold_disconnect_transfer:1;
390 #endif  /* defined(HAVE_PRI_CALL_HOLD) */
391         /*!
392          * \brief TRUE if call transfer is enabled for the span.
393          * \note Support switch-side transfer (called 2BCT, RLT or other names)
394          */
395         unsigned int transfer:1;
396 #if defined(HAVE_PRI_CALL_WAITING)
397         /*! \brief TRUE if we will allow incoming ISDN call waiting calls. */
398         unsigned int allow_call_waiting_calls:1;
399 #endif  /* defined(HAVE_PRI_CALL_WAITING) */
400         /*!
401          * TRUE if a new call's sig_pri_chan.user_tag[] has the MSN
402          * appended to the initial_user_tag[].
403          */
404         unsigned int append_msn_to_user_tag:1;
405         int dialplan;                                                   /*!< Dialing plan */
406         int localdialplan;                                              /*!< Local dialing plan */
407         int cpndialplan;                                                /*!< Connected party dialing plan */
408         char internationalprefix[10];                   /*!< country access code ('00' for european dialplans) */
409         char nationalprefix[10];                                /*!< area access code ('0' for european dialplans) */
410         char localprefix[20];                                   /*!< area access code + area code ('0'+area code for european dialplans) */
411         char privateprefix[20];                                 /*!< for private dialplans */
412         char unknownprefix[20];                                 /*!< for unknown dialplans */
413         enum sig_pri_moh_signaling moh_signaling;
414         long resetinterval;                                             /*!< Interval (in seconds) for resetting unused channels */
415 #if defined(HAVE_PRI_DISPLAY_TEXT)
416         unsigned long display_flags_send;               /*!< PRI_DISPLAY_OPTION_xxx flags for display text sending */
417         unsigned long display_flags_receive;    /*!< PRI_DISPLAY_OPTION_xxx flags for display text receiving */
418 #endif  /* defined(HAVE_PRI_DISPLAY_TEXT) */
419 #if defined(HAVE_PRI_MWI)
420         /*! \brief Active MWI mailboxes */
421         struct sig_pri_mbox mbox[SIG_PRI_MAX_MWI_MAILBOXES];
422         /*!
423          * \brief Comma separated list of mailboxes to indicate MWI.
424          * \note Empty if disabled.
425          * \note Format: mailbox_number[@context]{,mailbox_number[@context]}
426          * \note String is split apart when span is started.
427          */
428         char mwi_mailboxes[SIG_PRI_MAX_MWI_MAILBOX_STR];
429 #endif  /* defined(HAVE_PRI_MWI) */
430         /*!
431          * \brief Initial user tag for party id's sent from this device driver.
432          * \note String set by config file.
433          */
434         char initial_user_tag[AST_MAX_EXTENSION];
435         char msn_list[AST_MAX_EXTENSION];               /*!< Comma separated list of MSNs to handle.  Empty if disabled. */
436         char idleext[AST_MAX_EXTENSION];                /*!< Where to idle extra calls */
437         char idlecontext[AST_MAX_CONTEXT];              /*!< What context to use for idle */
438         char idledial[AST_MAX_EXTENSION];               /*!< What to dial before dumping */
439         int minunused;                                                  /*!< Min # of channels to keep empty */
440         int minidle;                                                    /*!< Min # of "idling" calls to keep active */
441         int nodetype;                                                   /*!< Node type */
442         int switchtype;                                                 /*!< Type of switch to emulate */
443         int nsf;                                                                /*!< Network-Specific Facilities */
444         int trunkgroup;                                                 /*!< What our trunkgroup is */
445 #if defined(HAVE_PRI_CCSS)
446         int cc_ptmp_recall_mode;                                /*!< CC PTMP recall mode. globalRecall(0), specificRecall(1) */
447         int cc_qsig_signaling_link_req;                 /*!< CC Q.SIG signaling link retention (Party A) release(0), retain(1), do-not-care(2) */
448         int cc_qsig_signaling_link_rsp;                 /*!< CC Q.SIG signaling link retention (Party B) release(0), retain(1) */
449 #endif  /* defined(HAVE_PRI_CCSS) */
450 #if defined(HAVE_PRI_CALL_WAITING)
451         /*!
452          * \brief Number of extra outgoing calls to allow on a span before
453          * considering that span congested.
454          */
455         int max_call_waiting_calls;
456         struct {
457                 int stripmsd;
458                 unsigned int hidecallerid:1;
459                 unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
460                 unsigned int immediate:1;                       /*!< Answer before getting digits? */
461                 unsigned int priexclusive:1;                    /*!< Whether or not to override and use exculsive mode for channel selection */
462                 unsigned int priindication_oob:1;
463                 unsigned int use_callerid:1;                    /*!< Whether or not to use caller id on this channel */
464                 unsigned int use_callingpres:1;                 /*!< Whether to use the callingpres the calling switch sends */
465                 char context[AST_MAX_CONTEXT];
466                 char mohinterpret[MAX_MUSICCLASS];
467         } ch_cfg;
468
469         /*!
470          * \brief Number of outstanding call waiting calls.
471          * \note Must be zero to allow new calls from asterisk to
472          * immediately allocate a B channel.
473          */
474         int num_call_waiting_calls;
475 #endif  /* defined(HAVE_PRI_CALL_WAITING) */
476         int dchanavail[SIG_PRI_NUM_DCHANS];             /*!< Whether each channel is available */
477         int debug;                                                              /*!< set to true if to dump PRI event info */
478         int span;                                                               /*!< span number put into user output messages */
479         int resetting;                                                  /*!< true if span is being reset/restarted */
480         int resetpos;                                                   /*!< current position during a reset (-1 if not started) */
481         int sig;                                                                /*!< ISDN signalling type (SIG_PRI, SIG_BRI, SIG_BRI_PTMP, etc...) */
482         int new_chan_seq;                                               /*!< New struct ast_channel sequence number */
483         /*! TRUE if we have already whined about no D channels available. */
484         unsigned int no_d_channels:1;
485
486         /* Everything after here is internally set */
487         struct pri *dchans[SIG_PRI_NUM_DCHANS];         /*!< Actual d-channels */
488         struct pri *pri;                                                        /*!< Currently active D-channel */
489         /*!
490          * List of private structures of the user of this module for no B channel
491          * interfaces. (hold and call waiting interfaces)
492          */
493         void *no_b_chan_iflist;
494         /*!
495          * List of private structures of the user of this module for no B channel
496          * interfaces. (hold and call waiting interfaces)
497          */
498         void *no_b_chan_end;
499         int numchans;                                                           /*!< Num of channels we represent */
500         struct sig_pri_chan *pvts[SIG_PRI_MAX_CHANNELS];/*!< Member channel pvt structs */
501         pthread_t master;                                                       /*!< Thread of master */
502         ast_mutex_t lock;                                                       /*!< libpri access Mutex */
503         time_t lastreset;                                                       /*!< time when unused channels were last reset */
504         struct sig_pri_callback *calls;
505         /*!
506          * \brief Congestion device state of the span.
507          * \details
508          * AST_DEVICE_NOT_INUSE - Span does not have all B channels in use.
509          * AST_DEVICE_BUSY - All B channels are in use.
510          * AST_DEVICE_UNAVAILABLE - Span is in alarm.
511          * \note
512          * Device name: \startverbatim DAHDI/I<span>/congestion. \endverbatim
513          */
514         int congestion_devstate;
515 #if defined(THRESHOLD_DEVSTATE_PLACEHOLDER)
516         /*! \todo An ISDN span threshold device state could be useful in determining how often a span utilization goes over a configurable threshold. */
517         /*!
518          * \brief User threshold device state of the span.
519          * \details
520          * AST_DEVICE_NOT_INUSE - There are no B channels in use.
521          * AST_DEVICE_INUSE - The number of B channels in use is less than
522          *    the configured threshold but not zero.
523          * AST_DEVICE_BUSY - The number of B channels in use meets or exceeds
524          *    the configured threshold.
525          * AST_DEVICE_UNAVAILABLE - Span is in alarm.
526          * \note
527          * Device name:  DAHDI/I<span>/threshold
528          */
529         int threshold_devstate;
530         /*!
531          * \brief Number of B channels in use to consider the span in a busy state.
532          * \note Setting the threshold to zero is interpreted as all B channels.
533          */
534         int user_busy_threshold;
535 #endif  /* defined(THRESHOLD_DEVSTATE_PLACEHOLDER) */
536 };
537
538 void sig_pri_extract_called_num_subaddr(struct sig_pri_chan *p, const char *rdest, char *called, size_t called_buff_size);
539 int sig_pri_call(struct sig_pri_chan *p, struct ast_channel *ast, char *rdest, int timeout, int layer1);
540
541 int sig_pri_hangup(struct sig_pri_chan *p, struct ast_channel *ast);
542
543 int sig_pri_indicate(struct sig_pri_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
544
545 int sig_pri_answer(struct sig_pri_chan *p, struct ast_channel *ast);
546
547 int sig_pri_available(struct sig_pri_chan **pvt, int is_specific_channel);
548
549 void sig_pri_init_pri(struct sig_pri_span *pri);
550
551 /* If return 0, it means this function was able to handle it (pre setup digits).  If non zero, the user of this
552  * functions should handle it normally (generate inband DTMF) */
553 int sig_pri_digit_begin(struct sig_pri_chan *pvt, struct ast_channel *ast, char digit);
554
555 void sig_pri_stop_pri(struct sig_pri_span *pri);
556 int sig_pri_start_pri(struct sig_pri_span *pri);
557
558 void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm);
559
560 void pri_event_alarm(struct sig_pri_span *pri, int index, int before_start_pri);
561
562 void pri_event_noalarm(struct sig_pri_span *pri, int index, int before_start_pri);
563
564 struct ast_channel *sig_pri_request(struct sig_pri_chan *p, enum sig_pri_law law, const struct ast_channel *requestor, int transfercapability);
565
566 struct sig_pri_chan *sig_pri_chan_new(void *pvt_data, struct sig_pri_callback *callback, struct sig_pri_span *pri, int logicalspan, int channo, int trunkgroup);
567 void sig_pri_chan_delete(struct sig_pri_chan *doomed);
568
569 int pri_is_up(struct sig_pri_span *pri);
570
571 void sig_pri_cli_show_spans(int fd, int span, struct sig_pri_span *pri);
572
573 void sig_pri_cli_show_span(int fd, int *dchannels, struct sig_pri_span *pri);
574
575 int pri_send_keypad_facility_exec(struct sig_pri_chan *p, const char *digits);
576 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);
577
578 #if defined(HAVE_PRI_SERVICE_MESSAGES)
579 int pri_maintenance_bservice(struct pri *pri, struct sig_pri_chan *p, int changestatus);
580 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
581
582 void sig_pri_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_pri_chan *pchan);
583 #if defined(HAVE_PRI_DISPLAY_TEXT)
584 void sig_pri_sendtext(struct sig_pri_chan *pchan, const char *text);
585 #endif  /* defined(HAVE_PRI_DISPLAY_TEXT) */
586
587 int sig_pri_cc_agent_init(struct ast_cc_agent *agent, struct sig_pri_chan *pvt_chan);
588 int sig_pri_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
589 int sig_pri_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
590 void sig_pri_cc_agent_req_ack(struct ast_cc_agent *agent);
591 int sig_pri_cc_agent_status_req(struct ast_cc_agent *agent);
592 int sig_pri_cc_agent_stop_ringing(struct ast_cc_agent *agent);
593 int sig_pri_cc_agent_party_b_free(struct ast_cc_agent *agent);
594 int sig_pri_cc_agent_start_monitoring(struct ast_cc_agent *agent);
595 int sig_pri_cc_agent_callee_available(struct ast_cc_agent *agent);
596 void sig_pri_cc_agent_destructor(struct ast_cc_agent *agent);
597
598 int sig_pri_cc_monitor_req_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
599 int sig_pri_cc_monitor_suspend(struct ast_cc_monitor *monitor);
600 int sig_pri_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
601 int sig_pri_cc_monitor_status_rsp(struct ast_cc_monitor *monitor, enum ast_device_state devstate);
602 int sig_pri_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
603 void sig_pri_cc_monitor_destructor(void *monitor_pvt);
604
605 int sig_pri_load(const char *cc_type_name);
606 void sig_pri_unload(void);
607
608 #endif /* _SIG_PRI_H */