dahdi-perl: fix xpp driver in dahdi_hardware
[dahdi/tools.git] / system.conf.sample
1 #
2 # DAHDI Configuration File
3 #
4 # This file is parsed by the DAHDI Configurator, dahdi_cfg
5 #
6 # Span Configuration
7 # ^^^^^^^^^^^^^^^^^^
8 # First come the span definitions, in the format
9
10 #   span=<span num>,<timing source>,<line build out (LBO)>,<framing>,<coding>[,yellow]
11 #
12 # All T1/E1/BRI spans generate a clock signal on their transmit side. The
13 # <timing source> parameter determines whether the clock signal from the far
14 # end of the T1/E1/BRI is used as the master source of clock timing. If it is, our
15 # own clock will synchronise to it. T1/E1/BRI connected directly or indirectly to
16 # a PSTN provider (telco) should generally be the first choice to sync to. The
17 # PSTN will never be a slave to you. You must be a slave to it.
18 #
19 # Choose 1 to make the equipment at the far end of the E1/T1/BRI link the preferred
20 # source of the master clock. Choose 2 to make it the second choice for the master
21 # clock, if the first choice port fails (the far end dies, a cable breaks, or
22 # whatever). Choose 3 to make a port the third choice, and so on. If you have, say,
23 # 2 ports connected to the PSTN, mark those as 1 and 2. The number used for each
24 # port should be different.
25 #
26 # If you choose 0, the port will never be used as a source of timing. This is
27 # appropriate when you know the far end should always be a slave to you. If
28 # the port is connected to a channel bank, for example, you should always be
29 # its master. Likewise, BRI TE ports should always be configured as a slave.
30 # Any number of ports can be marked as 0.
31 #
32 # Incorrect timing sync may cause clicks/noise in the audio, poor quality or failed
33 # faxes, unreliable modem operation, and is a general all round bad thing.
34 #
35 # The line build-out (or LBO) is an integer, from the following table:
36 #
37 #  0: 0 db (CSU) / 0-133 feet (DSX-1)
38 #  1: 133-266 feet (DSX-1)
39 #  2: 266-399 feet (DSX-1)
40 #  3: 399-533 feet (DSX-1)
41 #  4: 533-655 feet (DSX-1)
42 #  5: -7.5db (CSU)
43 #  6: -15db (CSU)
44 #  7: -22.5db (CSU)
45 #
46 # If the span is a BRI port the line build-out is not used and should be set
47 # to 0.
48 #
49 # framing:: 
50 #   one of 'd4' or 'esf' for T1 or 'cas' or 'ccs' for E1. Use 'ccs' for BRI.
51 #  'd4' could be referred to as 'sf' or 'superframe'
52 #
53 # coding:: 
54 #   one of 'ami' or 'b8zs' for T1 or 'ami' or 'hdb3' for E1. Use 'ami' for
55 #   BRI.
56 #
57 #   * For E1 there is the optional keyword 'crc4' to enable CRC4 checking.
58 #   * If the keyword 'yellow' follows, yellow alarm is transmitted when no
59 #     channels are open.
60 #
61 #span=1,0,0,esf,b8zs
62 #span=2,1,0,esf,b8zs
63 #span=3,0,0,ccs,hdb3,crc4
64 #
65 # Dynamic Spans
66 # ^^^^^^^^^^^^^
67 # Next come the dynamic span definitions, in the form:
68
69 #   dynamic=<driver>,<address>,<numchans>,<timing>
70 #
71 # Where <driver> is the name of the driver (e.g. eth), <address> is the
72 # driver specific address (like a MAC for eth), <numchans> is the number
73 # of channels, and <timing> is a timing priority, like for a normal span.
74 # use "0" to not use this as a timing source, or prioritize them as
75 # primary, secondard, etc.  Note that you MUST have a REAL DAHDI device
76 # if you are not using external timing.
77 #
78 #   dynamic=eth,eth0/00:02:b3:35:43:9c,24,0
79 #
80 # If a non-zero timing value is used, as above, only the last span should
81 # have the non-zero value. 
82 #
83 # Channel Configuration
84 # ^^^^^^^^^^^^^^^^^^^^^
85 # Next come the definitions for using the channels.  The format is:
86 # <device>=<channel list>
87 #
88 # Valid devices are:
89 #
90 # e&m::
91 #   Channel(s) are signalled using E&M signalling on a T1 line.
92 #   Specific implementation, such as Immediate, Wink, or Feature
93 #   Group D are handled by the userspace library.
94 # e&me1::
95 #   Channel(s) are signalled using E&M signalling on an E1 line.
96 # fxsls:: 
97 #   Channel(s) are signalled using FXS Loopstart protocol.
98 # fxsgs:: 
99 #   Channel(s) are signalled using FXS Groundstart protocol.
100 # fxsks:: 
101 #   Channel(s) are signalled using FXS Koolstart protocol.
102 # fxols:: 
103 #   Channel(s) are signalled using FXO Loopstart protocol.
104 # fxogs:: 
105 #   Channel(s) are signalled using FXO Groundstart protocol.
106 # fxoks:: 
107 #   Channel(s) are signalled using FXO Koolstart protocol.
108 # sf:: 
109 #   Channel(s) are signalled using in-band single freq tone. 
110 #   Syntax as follows: 
111 #    
112 #     channel# => sf:<rxfreq>,<rxbw>,<rxflag>,<txfreq>,<txlevel>,<txflag>
113 #   
114 #   rxfreq is rx tone freq in Hz, rxbw is rx notch (and decode)
115 #   bandwith in hz (typically 10.0), rxflag is either 'normal' or
116 #   'inverted', txfreq is tx tone freq in hz, txlevel is tx tone 
117 #   level in dbm, txflag is either 'normal' or 'inverted'. Set 
118 #   rxfreq or txfreq to 0.0 if that tone is not desired.
119 #
120 # unused:: 
121 #   No signalling is performed, each channel in the list remains idle
122 # clear::
123 #   Channel(s) are bundled into a single span.  No conversion or
124 #   signalling is performed, and raw data is available on the master.
125 # bchan:: 
126 #   Like 'clear' except all channels are treated individually and
127 #   are not bundled.  'inclear' is an alias for this.
128 # rawhdlc::
129 #   The DAHDI driver performs HDLC encoding and decoding on the 
130 #   bundle, and the resulting data is communicated via the master
131 #   device.
132 # dchan::
133 #   The DAHDI driver performs HDLC encoding and decoding on the
134 #   bundle and also performs incoming and outgoing FCS insertion
135 #   and verification.  'fcshdlc' is an alias for this. 
136 # hardhdlc::
137 #   The hardware driver performs HDLC encoding and decoding on the
138 #   bundle and also performs incoming and outgoing FCS insertion
139 #   and verification.  Is subject to limitations and support of underlying
140 #   hardware. BRI spans serviced by the wcb4xxp driver must use hardhdlc
141 #   channels for the signalling channels. 
142 # nethdlc::
143 #   The DAHDI driver bundles the channels together into an
144 #   hdlc network device, which in turn can be configured with
145 #   sethdlc (available separately). In 2.6.x kernels you can also optionally
146 #   pass the name for the network interface after the channel list.
147 #   Syntax:
148 #   
149 #     nethdlc=<channel list>[:interface name]
150 #   Use original names, don't use the names which have been already registered 
151 #   in system e.g eth.
152 #
153 # dacs::
154 #   The DAHDI driver cross connects the channels starting at
155 #   the channel number listed at the end, after a colon
156 # dacsrbs::
157 #   The DAHDI driver cross connects the channels starting at
158 #   the channel number listed at the end, after a colon and 
159 #   also performs the DACSing of RBS bits
160 #
161 # The channel list is a comma-separated list of channels or ranges, for
162 # example:
163 #
164 #   1,3,5 (channels one, three, and five)
165 #   16-23, 29 (channels 16 through 23, as well as channel 29)
166 #
167 # So, some complete examples are:
168 #
169 #   e&m=1-12
170 #   nethdlc=13-24
171 #   fxsls=25,26,27,28
172 #   fxols=29-32
173 #
174 # An example of BRI port:
175
176 #   span=1,1,0,ccs,ami
177 #   bchan=1,2
178 #   hardhdlc=3
179 #
180 # NOTE: When using BRI channels in asterisk, use the bri_cpe, bri_net, or
181 # bri_cpe_ptmp (for point to multipoint mode). libpri does not currently
182 # support point to multipoint when in NT mode. Otherwise, the bearer channel
183 # are configured identically to other DAHDI channels.
184 #
185 #fxoks=1-24
186 #bchan=25-47
187 #dchan=48
188 #fxols=1-12
189 #fxols=13-24
190 #e&m=25-29
191 #nethdlc=30-33
192 #clear=44
193 #clear=45
194 #clear=46
195 #clear=47
196 #fcshdlc=48
197 #dacs=1-24:48
198 #dacsrbs=1-24:48
199 #
200 # Tone Zone Data
201 # ^^^^^^^^^^^^^^
202 # Finally, you can preload some tone zones, to prevent them from getting
203 # overwritten by other users (if you allow non-root users to open /dev/dahdi/*
204 # interfaces anyway.  Also this means they won't have to be loaded at runtime.
205 # The format is "loadzone=<zone>" where the zone is a two letter country code.
206
207 # You may also specify a default zone with "defaultzone=<zone>" where zone
208 # is a two letter country code.
209 #
210 # An up-to-date list of the zones can be found in the file zonedata.c
211 #
212 loadzone = us
213 #loadzone = us-old
214 #loadzone=gr
215 #loadzone=it
216 #loadzone=fr
217 #loadzone=de
218 #loadzone=uk
219 #loadzone=fi
220 #loadzone=jp
221 #loadzone=sp
222 #loadzone=no
223 #loadzone=hu
224 #loadzone=lt
225 #loadzone=pl
226 defaultzone=us
227 #
228 # PCI Radio Interface
229 # ^^^^^^^^^^^^^^^^^^^
230 # (see http://www.zapatatelephony.org/app_rpt.html)
231 #
232 # The PCI Radio Interface card interfaces up to 4 two-way radios (either
233 # a base/mobile radio or repeater system) to DAHDI channels. The driver
234 # may work either independent of an application, or with it, through
235 # the driver;s ioctl() interface. This file gives you access to specify
236 # load-time parameters for Radio channels, so that the driver may run
237 # by itself, and just act like a generic DAHDI radio interface.
238 #
239 # Unlike the rest of this file, you specify a block of parameters, and
240 # then the channel(s) to which they apply. CTCSS is specified as a frequency
241 # in tenths of hertz, for example 131.8 HZ is specified as 1318. DCS
242 # for receive is specified as the code directly, for example 223. DCS for
243 # transmit is specified as D and then the code, for example D223.
244 #
245 # The hardware supports a "community" CTCSS decoder system that has
246 # arbitrary transmit CTCSS or DCS codes associated with them, unlike
247 # traditional "community" systems that encode the same tone they decode.
248
249 # this example is a single tone DCS transmit and receive
250 #
251 # specify the transmit tone (in DCS mode this stays constant):
252 #tx=D371
253 #
254 # specify the receive DCS code:
255 #dcsrx=223
256 #
257 # this example is a "community" CTCSS (if you only want a single tone, then
258 # only specify 1 in the ctcss list)
259 #
260 # specify the default transmit tone (when not receiving):
261 #tx=1000
262 #
263 # Specify the receive freq, the tag (use 0 if none), and the transmit code.
264 # The tag may be used by applications to determine classification of tones.
265 # The tones are to be specified in order of presedence, most important first.
266 # Currently, 15 tones may be specified..
267 #
268 #ctcss=1318,1,1318
269 #ctcss=1862,1,1862
270 #
271 # The following parameters may be omitted if their default value is acceptible
272 #
273 # Set the receive debounce time in milliseconds:
274 #debouncetime=123
275 #
276 # set the transmit quiet dropoff burst time in milliseconds:
277 #bursttime=234
278 #
279 # set the COR level threshold (specified in tenths of millivolts)
280 # valid values are {3125,6250,9375,12500,15625,18750,21875,25000}
281 #corthresh=12500
282 #
283 # Invert COR signal {y,n}
284 #invertcor=y
285 # Set the external tone mode; yes, no, internal {y,n,i}
286 #exttone=y
287 #
288 # Now apply the configuration to the specified channels:
289 #
290 # We are all done with our channel parameters, so now we specify what
291 # channels they apply to
292 #channels=1-4
293 #
294 # Overiding PCM encoding
295 # ^^^^^^^^^^^^^^^^^^^^^^
296 # Usually the channel driver sets the encoding of the PCM for the
297 # channel (mulaw / alaw. That is: g711u or g711a). However there are
298 # some cases where you would like to override that. 'mulaw' and 'alaw'
299 # set different such encoding. Use them for channels you have already
300 # defined with e.g. 'bchan' or 'fxoks'.
301 #mulaw=1-4
302 #alaw=1-4
303 #
304 # 'deflaw' is similar, but resets the encoding to the channel driver's
305 # default. It must be useful for something, I guess.
306 #mulaw=1-10
307 #deflaw=5
308 #
309 # Echo Cancellers
310 # ^^^^^^^^^^^^^^^
311 # DAHDI uses modular echo cancellers that are configured per channel. The echo
312 # cancellers are compiled and installed as part of the dahdi-linux package.
313 # You can specify in this file the echo canceller to be used for each
314 # channel. The default behavior is for there to be NO echo canceller on any
315 # channel, so it is very important that you specify one here.
316 #
317 # Valid echo cancellers are: hwec, mg2, kb1, sec2, and sec.
318 # 'hwec' is a special echo canceller that should be used if hardware echo
319 # cancellation is desired on and available on the specified channels.
320 # If compiled, 'hpec' is also a valid echo canceller.
321
322 # To configure the default echo cancellers, use the format:
323 # echocanceller=<echocanceller name>,<channel(s)>
324 #
325 # Example:
326 # Configure channels 1 through 8 to use the mg2 echo canceller
327 #echocanceller=mg2,1-8 
328 #
329 # And change channel 2 to use the kb1 echo canceller.
330 #echocanceller=kb1,2
331 #