chan_dahdi: Add config support for hwgain settings.
[asterisk/asterisk.git] / channels / chan_dahdi.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013 Digium, Inc.
5  *
6  * Richard Mudgett <rmudgett@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief DAHDI internal API definitions.
22  *
23  * \author Richard Mudgett <rmudgett@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  */
28
29 #ifndef _ASTERISK_CHAN_DAHDI_H
30 #define _ASTERISK_CHAN_DAHDI_H
31
32 #if defined(HAVE_OPENR2)
33 #include <openr2.h>
34 #endif  /* defined(HAVE_OPENR2) */
35
36 #include <dahdi/user.h>
37 #include <dahdi/tonezone.h>
38
39 #include "asterisk/channel.h"
40 #include "asterisk/dsp.h"
41
42 #if defined(__cplusplus) || defined(c_plusplus)
43 extern "C" {
44 #endif
45
46 /* ------------------------------------------------------------------- */
47
48 #if defined(HAVE_PRI)
49 struct sig_pri_span;
50 #endif  /* defined(HAVE_PRI) */
51 #if defined(HAVE_SS7)
52 struct sig_ss7_linkset;
53 #endif  /* defined(HAVE_SS7) */
54
55 #define SUB_REAL                0                       /*!< Active call */
56 #define SUB_CALLWAIT    1                       /*!< Call-Waiting call on hold */
57 #define SUB_THREEWAY    2                       /*!< Three-way call */
58
59
60 struct distRingData {
61         int ring[3];
62         int range;
63 };
64 struct ringContextData {
65         char contextData[AST_MAX_CONTEXT];
66 };
67 struct dahdi_distRings {
68         struct distRingData ringnum[3];
69         struct ringContextData ringContext[3];
70 };
71
72
73 extern const char * const subnames[];
74
75 struct dahdi_subchannel {
76         int dfd;
77         struct ast_channel *owner;
78         int chan;
79         short buffer[AST_FRIENDLY_OFFSET/2 + READ_SIZE];
80         struct ast_frame f;             /*!< One frame for each channel.  How did this ever work before? */
81         unsigned int needringing:1;
82         unsigned int needbusy:1;
83         unsigned int needcongestion:1;
84         unsigned int needanswer:1;
85         unsigned int needflash:1;
86         unsigned int needhold:1;
87         unsigned int needunhold:1;
88         unsigned int linear:1;
89         unsigned int inthreeway:1;
90         struct dahdi_confinfo curconf;
91 };
92
93 #define MAX_SLAVES      4
94
95 /* States for sending MWI message
96  * First three states are required for send Ring Pulse Alert Signal
97  */
98 typedef enum {
99         MWI_SEND_NULL = 0,
100         MWI_SEND_SA,
101         MWI_SEND_SA_WAIT,
102         MWI_SEND_PAUSE,
103         MWI_SEND_SPILL,
104         MWI_SEND_CLEANUP,
105         MWI_SEND_DONE,
106 } mwisend_states;
107
108 struct mwisend_info {
109         struct timeval pause;
110         mwisend_states mwisend_current;
111 };
112
113 /*! Specify the lists dahdi_pvt can be put in. */
114 enum DAHDI_IFLIST {
115         DAHDI_IFLIST_NONE,      /*!< The dahdi_pvt is not in any list. */
116         DAHDI_IFLIST_MAIN,      /*!< The dahdi_pvt is in the main interface list */
117 #if defined(HAVE_PRI)
118         DAHDI_IFLIST_NO_B_CHAN, /*!< The dahdi_pvt is in a no B channel interface list */
119 #endif  /* defined(HAVE_PRI) */
120 };
121
122 struct dahdi_pvt {
123         ast_mutex_t lock;                                       /*!< Channel private lock. */
124         struct callerid_state *cs;
125         struct ast_channel *owner;                      /*!< Our current active owner (if applicable) */
126                                                         /*!< Up to three channels can be associated with this call */
127
128         struct dahdi_subchannel sub_unused;             /*!< Just a safety precaution */
129         struct dahdi_subchannel subs[3];                        /*!< Sub-channels */
130         struct dahdi_confinfo saveconf;                 /*!< Saved conference info */
131
132         struct dahdi_pvt *slaves[MAX_SLAVES];           /*!< Slave to us (follows our conferencing) */
133         struct dahdi_pvt *master;                               /*!< Master to us (we follow their conferencing) */
134         int inconference;                               /*!< If our real should be in the conference */
135
136         int bufsize;                /*!< Size of the buffers */
137         int buf_no;                                     /*!< Number of buffers */
138         int buf_policy;                         /*!< Buffer policy */
139         int faxbuf_no;              /*!< Number of Fax buffers */
140         int faxbuf_policy;          /*!< Fax buffer policy */
141         int sig;                                        /*!< Signalling style */
142         /*!
143          * \brief Nonzero if the signaling type is sent over a radio.
144          * \note Set to a couple of nonzero values but it is only tested like a boolean.
145          */
146         int radio;
147         int outsigmod;                                  /*!< Outbound Signalling style (modifier) */
148         int oprmode;                                    /*!< "Operator Services" mode */
149         struct dahdi_pvt *oprpeer;                              /*!< "Operator Services" peer tech_pvt ptr */
150         /*! \brief Hardware Rx gain set by chan_dahdi.conf */
151         float hwrxgain;
152         /*! \brief Hardware Tx gain set by chan_dahdi.conf */
153         float hwtxgain;
154         /*! \brief Amount of gain to increase during caller id */
155         float cid_rxgain;
156         /*! \brief Software Rx gain set by chan_dahdi.conf */
157         float rxgain;
158         /*! \brief Software Tx gain set by chan_dahdi.conf */
159         float txgain;
160
161         float txdrc; /*!< Dynamic Range Compression factor. a number between 1 and 6ish */
162         float rxdrc;
163
164         int tonezone;                                   /*!< tone zone for this chan, or -1 for default */
165         enum DAHDI_IFLIST which_iflist; /*!< Which interface list is this structure listed? */
166         struct dahdi_pvt *next;                         /*!< Next channel in list */
167         struct dahdi_pvt *prev;                         /*!< Prev channel in list */
168
169         /* flags */
170
171         /*!
172          * \brief TRUE if ADSI (Analog Display Services Interface) available
173          * \note Set from the "adsi" value read in from chan_dahdi.conf
174          */
175         unsigned int adsi:1;
176         /*!
177          * \brief TRUE if we can use a polarity reversal to mark when an outgoing
178          * call is answered by the remote party.
179          * \note Set from the "answeronpolarityswitch" value read in from chan_dahdi.conf
180          */
181         unsigned int answeronpolarityswitch:1;
182         /*!
183          * \brief TRUE if busy detection is enabled.
184          * (Listens for the beep-beep busy pattern.)
185          * \note Set from the "busydetect" value read in from chan_dahdi.conf
186          */
187         unsigned int busydetect:1;
188         /*!
189          * \brief TRUE if call return is enabled.
190          * (*69, if your dialplan doesn't catch this first)
191          * \note Set from the "callreturn" value read in from chan_dahdi.conf
192          */
193         unsigned int callreturn:1;
194         /*!
195          * \brief TRUE if busy extensions will hear the call-waiting tone
196          * and can use hook-flash to switch between callers.
197          * \note Can be disabled by dialing *70.
198          * \note Initialized with the "callwaiting" value read in from chan_dahdi.conf
199          */
200         unsigned int callwaiting:1;
201         /*!
202          * \brief TRUE if send caller ID for Call Waiting
203          * \note Set from the "callwaitingcallerid" value read in from chan_dahdi.conf
204          */
205         unsigned int callwaitingcallerid:1;
206         /*!
207          * \brief TRUE if support for call forwarding enabled.
208          * Dial *72 to enable call forwarding.
209          * Dial *73 to disable call forwarding.
210          * \note Set from the "cancallforward" value read in from chan_dahdi.conf
211          */
212         unsigned int cancallforward:1;
213         /*!
214          * \brief TRUE if support for call parking is enabled.
215          * \note Set from the "canpark" value read in from chan_dahdi.conf
216          */
217         unsigned int canpark:1;
218         /*! \brief TRUE if to wait for a DTMF digit to confirm answer */
219         unsigned int confirmanswer:1;
220         /*!
221          * \brief TRUE if the channel is to be destroyed on hangup.
222          * (Used by pseudo channels.)
223          */
224         unsigned int destroy:1;
225         unsigned int didtdd:1;                          /*!< flag to say its done it once */
226         /*! \brief TRUE if analog type line dialed no digits in Dial() */
227         unsigned int dialednone:1;
228         /*!
229          * \brief TRUE if in the process of dialing digits or sending something.
230          * \note This is used as a receive squelch for ISDN until connected.
231          */
232         unsigned int dialing:1;
233         /*! \brief TRUE if the transfer capability of the call is digital. */
234         unsigned int digital:1;
235         /*! \brief TRUE if Do-Not-Disturb is enabled, present only for non sig_analog */
236         unsigned int dnd:1;
237         /*! \brief XXX BOOLEAN Purpose??? */
238         unsigned int echobreak:1;
239         /*!
240          * \brief TRUE if echo cancellation enabled when bridged.
241          * \note Initialized with the "echocancelwhenbridged" value read in from chan_dahdi.conf
242          * \note Disabled if the echo canceller is not setup.
243          */
244         unsigned int echocanbridged:1;
245         /*! \brief TRUE if echo cancellation is turned on. */
246         unsigned int echocanon:1;
247         /*! \brief TRUE if a fax tone has already been handled. */
248         unsigned int faxhandled:1;
249         /*! TRUE if dynamic faxbuffers are configured for use, default is OFF */
250         unsigned int usefaxbuffers:1;
251         /*! TRUE while buffer configuration override is in use */
252         unsigned int bufferoverrideinuse:1;
253         /*! \brief TRUE if over a radio and dahdi_read() has been called. */
254         unsigned int firstradio:1;
255         /*!
256          * \brief TRUE if the call will be considered "hung up" on a polarity reversal.
257          * \note Set from the "hanguponpolarityswitch" value read in from chan_dahdi.conf
258          */
259         unsigned int hanguponpolarityswitch:1;
260         /*! \brief TRUE if DTMF detection needs to be done by hardware. */
261         unsigned int hardwaredtmf:1;
262         /*!
263          * \brief TRUE if the outgoing caller ID is blocked/hidden.
264          * \note Caller ID can be disabled by dialing *67.
265          * \note Caller ID can be enabled by dialing *82.
266          * \note Initialized with the "hidecallerid" value read in from chan_dahdi.conf
267          */
268         unsigned int hidecallerid:1;
269         /*!
270          * \brief TRUE if hide just the name not the number for legacy PBX use.
271          * \note Only applies to PRI channels.
272          * \note Set from the "hidecalleridname" value read in from chan_dahdi.conf
273          */
274         unsigned int hidecalleridname:1;
275         /*! \brief TRUE if DTMF detection is disabled. */
276         unsigned int ignoredtmf:1;
277         /*!
278          * \brief TRUE if the channel should be answered immediately
279          * without attempting to gather any digits.
280          * \note Set from the "immediate" value read in from chan_dahdi.conf
281          */
282         unsigned int immediate:1;
283         /*! \brief TRUE if in an alarm condition. */
284         unsigned int inalarm:1;
285         /*! \brief TRUE if TDD in MATE mode */
286         unsigned int mate:1;
287         /*! \brief TRUE if we originated the call leg. */
288         unsigned int outgoing:1;
289         /*!
290          * \brief TRUE if busy extensions will hear the call-waiting tone
291          * and can use hook-flash to switch between callers.
292          * \note Set from the "callwaiting" value read in from chan_dahdi.conf
293          */
294         unsigned int permcallwaiting:1;
295         /*!
296          * \brief TRUE if the outgoing caller ID is blocked/restricted/hidden.
297          * \note Set from the "hidecallerid" value read in from chan_dahdi.conf
298          */
299         unsigned int permhidecallerid:1;
300         /*!
301          * \brief TRUE if PRI congestion/busy indications are sent out-of-band.
302          * \note Set from the "priindication" value read in from chan_dahdi.conf
303          */
304         unsigned int priindication_oob:1;
305         /*!
306          * \brief TRUE if PRI B channels are always exclusively selected.
307          * \note Set from the "priexclusive" value read in from chan_dahdi.conf
308          */
309         unsigned int priexclusive:1;
310         /*!
311          * \brief TRUE if we will pulse dial.
312          * \note Set from the "pulsedial" value read in from chan_dahdi.conf
313          */
314         unsigned int pulse:1;
315         /*! \brief TRUE if a pulsed digit was detected. (Pulse dial phone detected) */
316         unsigned int pulsedial:1;
317         unsigned int restartpending:1;          /*!< flag to ensure counted only once for restart */
318         /*!
319          * \brief TRUE if caller ID is restricted.
320          * \note Set but not used.  Should be deleted.  Redundant with permhidecallerid.
321          * \note Set from the "restrictcid" value read in from chan_dahdi.conf
322          */
323         unsigned int restrictcid:1;
324         /*!
325          * \brief TRUE if three way calling is enabled
326          * \note Set from the "threewaycalling" value read in from chan_dahdi.conf
327          */
328         unsigned int threewaycalling:1;
329         /*!
330          * \brief TRUE if call transfer is enabled
331          * \note For FXS ports (either direct analog or over T1/E1):
332          *   Support flash-hook call transfer
333          * \note For digital ports using ISDN PRI protocols:
334          *   Support switch-side transfer (called 2BCT, RLT or other names)
335          * \note Set from the "transfer" value read in from chan_dahdi.conf
336          */
337         unsigned int transfer:1;
338         /*!
339          * \brief TRUE if caller ID is used on this channel.
340          * \note PRI and SS7 spans will save caller ID from the networking peer.
341          * \note FXS ports will generate the caller ID spill.
342          * \note FXO ports will listen for the caller ID spill.
343          * \note Set from the "usecallerid" value read in from chan_dahdi.conf
344          */
345         unsigned int use_callerid:1;
346         /*!
347          * \brief TRUE if we will use the calling presentation setting
348          * from the Asterisk channel for outgoing calls.
349          * \note Only applies to PRI and SS7 channels.
350          * \note Set from the "usecallingpres" value read in from chan_dahdi.conf
351          */
352         unsigned int use_callingpres:1;
353         /*!
354          * \brief TRUE if distinctive rings are to be detected.
355          * \note For FXO lines
356          * \note Set indirectly from the "usedistinctiveringdetection" value read in from chan_dahdi.conf
357          */
358         unsigned int usedistinctiveringdetection:1;
359         /*!
360          * \brief TRUE if we should use the callerid from incoming call on dahdi transfer.
361          * \note Set from the "useincomingcalleridondahditransfer" value read in from chan_dahdi.conf
362          */
363         unsigned int dahditrcallerid:1;
364         /*!
365          * \brief TRUE if allowed to flash-transfer to busy channels.
366          * \note Set from the "transfertobusy" value read in from chan_dahdi.conf
367          */
368         unsigned int transfertobusy:1;
369         /*!
370          * \brief TRUE if the FXO port monitors for neon type MWI indications from the other end.
371          * \note Set if the "mwimonitor" value read in contains "neon" from chan_dahdi.conf
372          */
373         unsigned int mwimonitor_neon:1;
374         /*!
375          * \brief TRUE if the FXO port monitors for fsk type MWI indications from the other end.
376          * \note Set if the "mwimonitor" value read in contains "fsk" from chan_dahdi.conf
377          */
378         unsigned int mwimonitor_fsk:1;
379         /*!
380          * \brief TRUE if the FXO port monitors for rpas precursor to fsk MWI indications from the other end.
381          * \note RPAS - Ring Pulse Alert Signal
382          * \note Set if the "mwimonitor" value read in contains "rpas" from chan_dahdi.conf
383          */
384         unsigned int mwimonitor_rpas:1;
385         /*! \brief TRUE if an MWI monitor thread is currently active */
386         unsigned int mwimonitoractive:1;
387         /*! \brief TRUE if a MWI message sending thread is active */
388         unsigned int mwisendactive:1;
389         /*!
390          * \brief TRUE if channel is out of reset and ready
391          * \note Set but not used.
392          */
393         unsigned int inservice:1;
394         /*!
395          * \brief TRUE if the channel is locally blocked.
396          * \note Applies to SS7 and MFCR2 channels.
397          */
398         unsigned int locallyblocked:1;
399         /*!
400          * \brief TRUE if the channel is remotely blocked.
401          * \note Applies to SS7 and MFCR2 channels.
402          */
403         unsigned int remotelyblocked:1;
404         /*!
405          * \brief TRUE if the channel alarms will be managed also as Span ones
406          * \note Applies to all channels
407          */
408         unsigned int manages_span_alarms:1;
409         /*! \brief TRUE if hardware Rx gain set by Asterisk */
410         unsigned int hwrxgain_enabled;
411         /*! \brief TRUE if hardware Tx gain set by Asterisk */
412         unsigned int hwtxgain_enabled;
413
414 #if defined(HAVE_PRI)
415         struct sig_pri_span *pri;
416         int logicalspan;
417 #endif  /* defined(HAVE_PRI) */
418         /*!
419          * \brief TRUE if SMDI (Simplified Message Desk Interface) is enabled
420          * \note Set from the "usesmdi" value read in from chan_dahdi.conf
421          */
422         unsigned int use_smdi:1;
423         struct mwisend_info mwisend_data;
424         /*! \brief The SMDI interface to get SMDI messages from. */
425         struct ast_smdi_interface *smdi_iface;
426
427         /*! \brief Distinctive Ring data */
428         struct dahdi_distRings drings;
429
430         /*!
431          * \brief The configured context for incoming calls.
432          * \note The "context" string read in from chan_dahdi.conf
433          */
434         char context[AST_MAX_CONTEXT];
435         /*!
436          * \brief A description for the channel configuration
437          * \note The "description" string read in from chan_dahdi.conf
438          */
439         char description[32];
440         /*!
441          * \brief Saved context string.
442          */
443         char defcontext[AST_MAX_CONTEXT];
444         /*! \brief Extension to use in the dialplan. */
445         char exten[AST_MAX_EXTENSION];
446         /*!
447          * \brief Language configured for calls.
448          * \note The "language" string read in from chan_dahdi.conf
449          */
450         char language[MAX_LANGUAGE];
451         /*!
452          * \brief The configured music-on-hold class to use for calls.
453          * \note The "musicclass" or "mohinterpret" or "musiconhold" string read in from chan_dahdi.conf
454          */
455         char mohinterpret[MAX_MUSICCLASS];
456         /*!
457          * \brief Suggested music-on-hold class for peer channel to use for calls.
458          * \note The "mohsuggest" string read in from chan_dahdi.conf
459          */
460         char mohsuggest[MAX_MUSICCLASS];
461         char parkinglot[AST_MAX_EXTENSION]; /*!< Parking lot for this channel */
462 #if defined(HAVE_PRI) || defined(HAVE_SS7)
463         /*! \brief Automatic Number Identification number (Alternate PRI caller ID number) */
464         char cid_ani[AST_MAX_EXTENSION];
465 #endif  /* defined(HAVE_PRI) || defined(HAVE_SS7) */
466         /*! \brief Automatic Number Identification code from PRI */
467         int cid_ani2;
468         /*! \brief Caller ID number from an incoming call. */
469         char cid_num[AST_MAX_EXTENSION];
470         /*!
471          * \brief Caller ID tag from incoming call
472          * \note the "cid_tag" string read in from chan_dahdi.conf
473          */
474         char cid_tag[AST_MAX_EXTENSION];
475         /*! \brief Caller ID Q.931 TON/NPI field values.  Set by PRI. Zero otherwise. */
476         int cid_ton;
477         /*! \brief Caller ID name from an incoming call. */
478         char cid_name[AST_MAX_EXTENSION];
479         /*! \brief Caller ID subaddress from an incoming call. */
480         char cid_subaddr[AST_MAX_EXTENSION];
481         char *origcid_num;                              /*!< malloced original callerid */
482         char *origcid_name;                             /*!< malloced original callerid */
483         /*! \brief Call waiting number. */
484         char callwait_num[AST_MAX_EXTENSION];
485         /*! \brief Call waiting name. */
486         char callwait_name[AST_MAX_EXTENSION];
487         /*! \brief Redirecting Directory Number Information Service (RDNIS) number */
488         char rdnis[AST_MAX_EXTENSION];
489         /*! \brief Dialed Number Identifier */
490         char dnid[AST_MAX_EXTENSION];
491         /*!
492          * \brief Bitmapped groups this belongs to.
493          * \note The "group" bitmapped group string read in from chan_dahdi.conf
494          */
495         ast_group_t group;
496         /*! \brief Default call PCM encoding format: DAHDI_LAW_ALAW or DAHDI_LAW_MULAW. */
497         int law_default;
498         /*! \brief Active PCM encoding format: DAHDI_LAW_ALAW or DAHDI_LAW_MULAW */
499         int law;
500         int confno;                                     /*!< Our conference */
501         int confusers;                                  /*!< Who is using our conference */
502         int propconfno;                                 /*!< Propagated conference number */
503         /*!
504          * \brief Bitmapped call groups this belongs to.
505          * \note The "callgroup" bitmapped group string read in from chan_dahdi.conf
506          */
507         ast_group_t callgroup;
508         /*!
509          * \brief Bitmapped pickup groups this belongs to.
510          * \note The "pickupgroup" bitmapped group string read in from chan_dahdi.conf
511          */
512         ast_group_t pickupgroup;
513         /*!
514          * \brief Named call groups this belongs to.
515          * \note The "namedcallgroup" string read in from chan_dahdi.conf
516          */
517         struct ast_namedgroups *named_callgroups;
518         /*!
519          * \brief Named pickup groups this belongs to.
520          * \note The "namedpickupgroup" string read in from chan_dahdi.conf
521          */
522         struct ast_namedgroups *named_pickupgroups;
523         /*!
524          * \brief Channel variable list with associated values to set when a channel is created.
525          * \note The "setvar" strings read in from chan_dahdi.conf
526          */
527         struct ast_variable *vars;
528         int channel;                                    /*!< Channel Number */
529         int span;                                       /*!< Span number */
530         time_t guardtime;                               /*!< Must wait this much time before using for new call */
531         int cid_signalling;                             /*!< CID signalling type bell202 or v23 */
532         int cid_start;                                  /*!< CID start indicator, polarity or ring or DTMF without warning event */
533         int dtmfcid_holdoff_state;              /*!< State indicator that allows for line to settle before checking for dtmf energy */
534         struct timeval  dtmfcid_delay;  /*!< Time value used for allow line to settle */
535         int callingpres;                                /*!< The value of calling presentation that we're going to use when placing a PRI call */
536         int callwaitingrepeat;                          /*!< How many samples to wait before repeating call waiting */
537         int cidcwexpire;                                /*!< When to stop waiting for CID/CW CAS response (In samples) */
538         int cid_suppress_expire;                /*!< How many samples to suppress after a CID spill. */
539         /*! \brief Analog caller ID waveform sample buffer */
540         unsigned char *cidspill;
541         /*! \brief Position in the cidspill buffer to send out next. */
542         int cidpos;
543         /*! \brief Length of the cidspill buffer containing samples. */
544         int cidlen;
545         /*! \brief Ring timeout timer?? */
546         int ringt;
547         /*!
548          * \brief Ring timeout base.
549          * \note Value computed indirectly from "ringtimeout" read in from chan_dahdi.conf
550          */
551         int ringt_base;
552         /*!
553          * \brief Number of most significant digits/characters to strip from the dialed number.
554          * \note Feature is deprecated.  Use dialplan logic.
555          * \note The characters are stripped before the PRI TON/NPI prefix
556          * characters are processed.
557          */
558         int stripmsd;
559         /*!
560          * \brief TRUE if Call Waiting (CW) CPE Alert Signal (CAS) is being sent.
561          * \note
562          * After CAS is sent, the call waiting caller id will be sent if the phone
563          * gives a positive reply.
564          */
565         int callwaitcas;
566         /*! \brief Number of call waiting rings. */
567         int callwaitrings;
568         /*! \brief Echo cancel parameters. */
569         struct {
570                 struct dahdi_echocanparams head;
571                 struct dahdi_echocanparam params[DAHDI_MAX_ECHOCANPARAMS];
572         } echocancel;
573         /*!
574          * \brief Echo training time. 0 = disabled
575          * \note Set from the "echotraining" value read in from chan_dahdi.conf
576          */
577         int echotraining;
578         /*! \brief Filled with 'w'.  XXX Purpose?? */
579         char echorest[20];
580         /*!
581          * \brief Number of times to see "busy" tone before hanging up.
582          * \note Set from the "busycount" value read in from chan_dahdi.conf
583          */
584         int busycount;
585         /*!
586          * \brief Busy cadence pattern description.
587          * \note Set from the "busypattern" value read from chan_dahdi.conf
588          */
589         struct ast_dsp_busy_pattern busy_cadence;
590         /*!
591          * \brief Bitmapped call progress detection flags. CALLPROGRESS_xxx values.
592          * \note Bits set from the "callprogress" and "faxdetect" values read in from chan_dahdi.conf
593          */
594         int callprogress;
595         /*!
596          * \brief Number of milliseconds to wait for dialtone.
597          * \note Set from the "waitfordialtone" value read in from chan_dahdi.conf
598          */
599         int waitfordialtone;
600         /*!
601          * \brief Number of frames to watch for dialtone in incoming calls
602          * \note Set from the "dialtone_detect" value read in from chan_dahdi.conf
603          */
604         int dialtone_detect;
605         int dialtone_scanning_time_elapsed;     /*!< Amount of audio scanned for dialtone, in frames */
606         struct timeval waitingfordt;                    /*!< Time we started waiting for dialtone */
607         struct timeval flashtime;                       /*!< Last flash-hook time */
608         /*! \brief Opaque DSP configuration structure. */
609         struct ast_dsp *dsp;
610         /*! \brief DAHDI dial operation command struct for ioctl() call. */
611         struct dahdi_dialoperation dop;
612         int whichwink;                                  /*!< SIG_FEATDMF_TA Which wink are we on? */
613         /*! \brief Second part of SIG_FEATDMF_TA wink operation. */
614         char finaldial[64];
615         char accountcode[AST_MAX_ACCOUNT_CODE];         /*!< Account code */
616         int amaflags;                                   /*!< AMA Flags */
617         struct tdd_state *tdd;                          /*!< TDD flag */
618         /*! \brief Accumulated call forwarding number. */
619         char call_forward[AST_MAX_EXTENSION];
620         /*!
621          * \brief Voice mailbox location.
622          * \note Set from the "mailbox" string read in from chan_dahdi.conf
623          */
624         char mailbox[AST_MAX_EXTENSION];
625         /*! \brief Opaque event subscription parameters for message waiting indication support. */
626         struct stasis_subscription *mwi_event_sub;
627         /*! \brief Delayed dialing for E911.  Overlap digits for ISDN. */
628         char dialdest[256];
629 #ifdef HAVE_DAHDI_LINEREVERSE_VMWI
630         struct dahdi_vmwi_info mwisend_setting;                         /*!< Which VMWI methods to use */
631         unsigned int mwisend_fsk: 1;            /*! Variable for enabling FSK MWI handling in chan_dahdi */
632         unsigned int mwisend_rpas:1;            /*! Variable for enabling Ring Pulse Alert before MWI FSK Spill */
633 #endif
634         int distinctivering;                            /*!< Which distinctivering to use */
635         int dtmfrelax;                                  /*!< whether to run in relaxed DTMF mode */
636         /*! \brief Holding place for event injected from outside normal operation. */
637         int fake_event;
638         /*!
639          * \brief Minimal time period (ms) between the answer polarity
640          * switch and hangup polarity switch.
641          */
642         int polarityonanswerdelay;
643         /*! \brief Start delay time if polarityonanswerdelay is nonzero. */
644         struct timeval polaritydelaytv;
645         /*!
646          * \brief Send caller ID on FXS after this many rings. Set to 1 for US.
647          * \note Set from the "sendcalleridafter" value read in from chan_dahdi.conf
648          */
649         int sendcalleridafter;
650         /*! \brief Current line interface polarity. POLARITY_IDLE, POLARITY_REV */
651         int polarity;
652         /*! \brief DSP feature flags: DSP_FEATURE_xxx */
653         int dsp_features;
654 #if defined(HAVE_SS7)
655         /*! \brief SS7 control parameters */
656         struct sig_ss7_linkset *ss7;
657 #endif  /* defined(HAVE_SS7) */
658 #if defined(HAVE_OPENR2)
659         struct dahdi_mfcr2 *mfcr2;
660         openr2_chan_t *r2chan;
661         openr2_calling_party_category_t mfcr2_recvd_category;
662         openr2_calling_party_category_t mfcr2_category;
663         int mfcr2_dnis_index;
664         int mfcr2_ani_index;
665         int mfcr2call:1;
666         int mfcr2_answer_pending:1;
667         int mfcr2_charge_calls:1;
668         int mfcr2_allow_collect_calls:1;
669         int mfcr2_forced_release:1;
670         int mfcr2_dnis_matched:1;
671         int mfcr2_call_accepted:1;
672         int mfcr2_accept_on_offer:1;
673         int mfcr2_progress_sent:1;
674 #endif  /* defined(HAVE_OPENR2) */
675         /*! \brief DTMF digit in progress.  0 when no digit in progress. */
676         char begindigit;
677         /*! \brief TRUE if confrence is muted. */
678         int muting;
679         void *sig_pvt;
680         struct ast_cc_config_params *cc_params;
681         /* DAHDI channel names may differ greatly from the
682          * string that was provided to an app such as Dial. We
683          * need to save the original string passed to dahdi_request
684          * for call completion purposes. This way, we can replicate
685          * the original dialed string later.
686          */
687         char dialstring[AST_CHANNEL_NAME];
688 };
689
690
691 /* Analog signaling */
692 #define SIG_EM          DAHDI_SIG_EM
693 #define SIG_EMWINK      (0x0100000 | DAHDI_SIG_EM)
694 #define SIG_FEATD       (0x0200000 | DAHDI_SIG_EM)
695 #define SIG_FEATDMF     (0x0400000 | DAHDI_SIG_EM)
696 #define SIG_FEATB       (0x0800000 | DAHDI_SIG_EM)
697 #define SIG_E911        (0x1000000 | DAHDI_SIG_EM)
698 #define SIG_FEATDMF_TA  (0x2000000 | DAHDI_SIG_EM)
699 #define SIG_FGC_CAMA    (0x4000000 | DAHDI_SIG_EM)
700 #define SIG_FGC_CAMAMF  (0x8000000 | DAHDI_SIG_EM)
701 #define SIG_FXSLS       DAHDI_SIG_FXSLS
702 #define SIG_FXSGS       DAHDI_SIG_FXSGS
703 #define SIG_FXSKS       DAHDI_SIG_FXSKS
704 #define SIG_FXOLS       DAHDI_SIG_FXOLS
705 #define SIG_FXOGS       DAHDI_SIG_FXOGS
706 #define SIG_FXOKS       DAHDI_SIG_FXOKS
707 #define SIG_SF          DAHDI_SIG_SF
708 #define SIG_SFWINK      (0x0100000 | DAHDI_SIG_SF)
709 #define SIG_SF_FEATD    (0x0200000 | DAHDI_SIG_SF)
710 #define SIG_SF_FEATDMF  (0x0400000 | DAHDI_SIG_SF)
711 #define SIG_SF_FEATB    (0x0800000 | DAHDI_SIG_SF)
712 #define SIG_EM_E1       DAHDI_SIG_EM_E1
713
714 /* PRI signaling */
715 #define SIG_PRI         DAHDI_SIG_CLEAR
716 #define SIG_BRI         (0x2000000 | DAHDI_SIG_CLEAR)
717 #define SIG_BRI_PTMP    (0X4000000 | DAHDI_SIG_CLEAR)
718
719 /* SS7 signaling */
720 #define SIG_SS7         (0x1000000 | DAHDI_SIG_CLEAR)
721
722 /* MFC/R2 signaling */
723 #define SIG_MFCR2       DAHDI_SIG_CAS
724
725
726 #define SIG_PRI_LIB_HANDLE_CASES        \
727         SIG_PRI:                                                \
728         case SIG_BRI:                                   \
729         case SIG_BRI_PTMP
730
731 /*!
732  * \internal
733  * \brief Determine if sig_pri handles the signaling.
734  * \since 1.8
735  *
736  * \param signaling Signaling to determine if is for sig_pri.
737  *
738  * \return TRUE if the signaling is for sig_pri.
739  */
740 static inline int dahdi_sig_pri_lib_handles(int signaling)
741 {
742         int handles;
743
744         switch (signaling) {
745         case SIG_PRI_LIB_HANDLE_CASES:
746                 handles = 1;
747                 break;
748         default:
749                 handles = 0;
750                 break;
751         }
752
753         return handles;
754 }
755
756 static inline int dahdi_analog_lib_handles(int signalling, int radio, int oprmode)
757 {
758         switch (signalling) {
759         case SIG_FXOLS:
760         case SIG_FXOGS:
761         case SIG_FXOKS:
762         case SIG_FXSLS:
763         case SIG_FXSGS:
764         case SIG_FXSKS:
765         case SIG_EMWINK:
766         case SIG_EM:
767         case SIG_EM_E1:
768         case SIG_FEATD:
769         case SIG_FEATDMF:
770         case SIG_E911:
771         case SIG_FGC_CAMA:
772         case SIG_FGC_CAMAMF:
773         case SIG_FEATB:
774         case SIG_SFWINK:
775         case SIG_SF:
776         case SIG_SF_FEATD:
777         case SIG_SF_FEATDMF:
778         case SIG_FEATDMF_TA:
779         case SIG_SF_FEATB:
780                 break;
781         default:
782                 /* The rest of the function should cover the remainder of signalling types */
783                 return 0;
784         }
785
786         if (radio) {
787                 return 0;
788         }
789
790         if (oprmode) {
791                 return 0;
792         }
793
794         return 1;
795 }
796
797 #define dahdi_get_index(ast, p, nullok) _dahdi_get_index(ast, p, nullok, __PRETTY_FUNCTION__, __LINE__)
798 int _dahdi_get_index(struct ast_channel *ast, struct dahdi_pvt *p, int nullok, const char *fname, unsigned long line);
799
800 void dahdi_dtmf_detect_disable(struct dahdi_pvt *p);
801 void dahdi_dtmf_detect_enable(struct dahdi_pvt *p);
802
803 void dahdi_ec_enable(struct dahdi_pvt *p);
804 void dahdi_ec_disable(struct dahdi_pvt *p);
805
806 void dahdi_conf_update(struct dahdi_pvt *p);
807 void dahdi_master_slave_link(struct dahdi_pvt *slave, struct dahdi_pvt *master);
808 void dahdi_master_slave_unlink(struct dahdi_pvt *slave, struct dahdi_pvt *master, int needlock);
809
810 /* ------------------------------------------------------------------- */
811
812 #if defined(__cplusplus) || defined(c_plusplus)
813 }
814 #endif
815
816 #endif  /* _ASTERISK_CHAN_DAHDI_H */