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