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