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