Update documentation. Mainly regarding the PRI module.

git-svn-id: http://svn.digium.com/svn/zaptel/branches/1.2@3564 5390a7c7-147a-4af0-8ec9-7488f05a26cb

1 files changed, 135 insertions, 33 deletions

diff --git a/xpp/README.Astribank b/xpp/README.Astribank
index 50c6544..c0b5a4c 100644
--- a/xpp/README.Astribank
+++ b/xpp/README.Astribank
@@ -35,6 +35,42 @@ run:
 
 Though this should be done automatically on zaptel >= 1.4.1 .
 
+PRI Port Setup
+~~~~~~~~~~~~~~
+A port in the PRI module can be either E1 (default) or T1. It can also be 
+either "TE" or "NT".
+
+TE::
+  Use the bottom port (green LED) and don't invert any wiring. Hint to
+  higher layers that this will be the TE (CPE) side of the connection. 
+  This is the default setup.
+
+NT::
+  Use the top port (orange LED) and invert wiring (this is done to allow
+  connecting an NT port and a TE port using a standard straight 8 wires 
+  "ethernet" cable). Hint to higher layers that this will be the NT (Net) 
+  side of the connection.
+
+The value XPP_PRI_SETUP in the init configuration file (see example
+below) can be used to change those defaults. This value is a
+whitelist-separated list of conditions. When a port is initialized it 
+checks those conditions and uses the firs one that matches.
+
+Match expressions may be:
+- CONNECTOR/usb..../XPD-nn	To identify by physical connector
+- NUM/XBUS-mm/XPD-nn		To identify by bus number
+
+Match expressions may contain "wildcards":
+- * matches zero or more characters.
+- ? matches one charater
+- [xyz] - any of 'x', 'y', or 'z'.
+
+For each line you should define both if it is E1 or T1 and if it is NT
+or TE.
+
+The list implicitly contains an 'NUM/*=TE,E1' catch all default, appended
+to its end.
+
 
 Sample Configurations
 ---------------------
@@ -57,7 +93,7 @@ that may be defined there:
 # A two-letter country code. genzaptelconf uses it to better guess 
 # the configuration it generates. E.g: the signalling of E1 spans, and 
 # a few other country-specific settings.
-lc_country=us
+#lc_country=us
 
 # See genzaptelconf(8) and the script itself for a longer list of 
 # variables.
@@ -65,7 +101,6 @@ lc_country=us
 # Equivalent to the parameter opermode to the module wctdm: country-specific
 # settings to the FXO lines. For a complete list of possible values, see
 # /usr/share/zaptel/init_fxo_mode .
-#opermode=FCC
 #opermode=FRANCE
 
 # xpp_sync runs with the value of 'XPP_SYNC' as its parameter to set the
@@ -82,29 +117,13 @@ lc_country=us
 # or removed.
 #ASTRIBANK_HOOK_DISABLED=yes
 
-# Setup for XPP PRI. This allows to have fixed settings:
-#   1. The variable XPP_PRI_SETUP contains a whitespace separated list of
-#      port specifications.
-#   2. Each port specification contains a match expression, a '=' and
-#      a setting string.
-#   2. Match expressions may be:
-#      - CONNECTOR/usb..../XPD-nn	To identify by physical connector
-#      - NUM/XBUS-mm/XPD-nn		To identify by bus number
-#   4. Match expressions may contain "wildcards" (which are translated
-#      internally to regular expressions):
-#        * matches zero or more characters.
-#        ? matches one charater
-#   5. The list of matches is scanned from beginning to end. First match wins.
-#   6. The list implicitly contains an 'NUM/*=TE,E1' catch all default, appended
-#      to its end.
-#   7. The setting string is composed of comma separated settings. Valid
-#      settings are:
-#      - NT or TE
-#      - E1 or T1 or J1
-#
+# Setup for the Astribank PRI module:
+# All the ports in the unit connected to the USB port 0000:00:1d.7-1
+# will be NT and E1. Ports no. 1 and 3 of all the other Astribanks will 
+# be NT and E1 (and thus ports 0 and 2 will be TE and E1).
 #XPP_PRI_SETUP='
 #	CONNECTOR/usb-0000:00:1d.7-1/XPD-01=NT,E1
-#	NUM/*/XPD-03=NT,E1
+#	NUM/*/XPD-0[13]=NT,E1
 #	'
 -----------------------------------------------------------
 
@@ -134,14 +153,32 @@ Astribank 4 BRI
     span=2,0,1,ccs,ami
     span=3,2,1,ccs,ami
     span=4,0,1,ccs,ami
-    bchan=1-2
-    dchan=3
-    bchan=4-5
-    dchan=6
-    bchan=7-8
-    dchan=9
-    bchan=10-11
-    dchan=12
+    bchan=1-2,4-5,7-8,10-11
+    dchan=3,6,9,12
+
+Astribank 4 PRI E1
+^^^^^^^^^^^^^^^^^^
+    # Assumed ports settings:
+    # Ports 1,3: TE (CPE)
+    # Ports 2,4: NT (Net)
+    span=1,1,1,ccs,hdb3,crc4
+    span=2,0,1,ccs,hdb3,crc4
+    span=3,2,1,ccs,hdb3,crc4
+    span=4,0,1,ccs,hdb3,crc4
+    bchan=1-15,17-30,31-45,47-60,61-75,77-90,91-105,107-120
+    dchan=16,46,76,106
+
+Astribank 4 PRI T1
+^^^^^^^^^^^^^^^^^^
+    # Assumed ports settings:
+    # Ports 1,3: TE (CPE)
+    # Ports 2,4: NT (Net)
+    span=1,1,1,esf,b8zs
+    span=2,0,1,esf,b8zs
+    span=3,2,1,esf,b8zs
+    span=4,0,1,esf,b8zs
+    bchan=1-23,25-47,49-71,73-95
+    dchan=24,48,72,96
   
 
 /etc/asterisk/zapata.conf
@@ -247,13 +284,69 @@ Astribank 4 BRI
     group = 2,14
     channel => 10,11
 
+Astribank 4 PRI E1
+^^^^^^^^^^^^^^^^^^ 
+    ; Assumed ports settings:
+    ; Ports 1,3: TE
+    ; Ports 2,4: NT
+    [channels]
+    switchtype = euroisdn
+    callerid = asreceived
+    
+    ; TE ports:
+    signalling = pri_cpe
+    context = from-pstn
+    group = 1,11
+    channel => 1-15,17-30
+    
+    group = 1,13
+    channel => 61-75,77-90
+    
+    ; NT ports:
+    signalling = bri_net_ptmp
+    ;signalling = bri_net
+    context = from-internal
+    group = 2,12
+    channel => 31-45,47-60
+    
+    group = 2,14
+    channel => 91-105,107-120
+
+Astribank 4 PRI T1
+^^^^^^^^^^^^^^^^^^ 
+    ; Assumed ports settings:
+    ; Ports 1,3: TE
+    ; Ports 2,4: NT
+    [channels]
+    switchtype = national
+    callerid = asreceived
+    
+    ; TE ports:
+    signalling = pri_cpe
+    context = from-pstn
+    group = 1,11
+    channel => 1-23
+    
+    group = 1,13
+    channel => 49-71
+    
+    ; NT ports:
+    signalling = bri_net_ptmp
+    ;signalling = bri_net
+    context = from-internal
+    group = 2,12
+    channel => 25-47
+    
+    group = 2,14
+    channel => 73-95
+
 
 Please check, that the mailbox and callerid parameters generated by
 genzaptelconf are good for you and change them if necessary.
 
 
-If you have Astribank device with 8 FXS and 8FXO ports connected and set up, then 
-the Zaptel channels will be allocated as the following:
+If you have Astribank device with 8 FXS and 8FXO ports connected and set
+up, then the Zaptel channels will be allocated as the following:
 
   root@rapid:~# cat /proc/zaptel/* 
  Span 1: XBUS-00/XPD-00 "Xorcom XPD #00/00: FXS"
@@ -359,6 +452,8 @@ exten => s,n,NoOp(Got signal from Zaptel Channel ${ZAP_CHAN})
 -----------------------------------------------------------
 
 
+
+
 Troubleshhoting
 ---------------
 The following commands provide useful information for debugging:
@@ -935,6 +1030,13 @@ NT::
   "ethernet" cable). Hint to higher layers that this will be the NT side 
   of the connection.
 
+LOCALOOP::
+  Set the device into local loop mode: loops the transmitted channels
+  directly into the recieved channels.
+
+NOLOCALLOOP::
+  Ends local loop mode.
+
 Normally those are set by the PRI initialization script . See the
 definition of XPP_PRI_SETUP in xref:sect-default[the sample Zaptel init
 configuration file] .