* XppUtils.pm renamed Zaptel::Utils.pm .

* Some more documentation.


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

1 files changed, 20 insertions, 4 deletions

diff --git a/xpp/README.Astribank b/xpp/README.Astribank
index 6e7cdb2..50c6544 100644
--- a/xpp/README.Astribank
+++ b/xpp/README.Astribank
@@ -10,7 +10,7 @@ It is generally a more technical document than the
 http://www.xorcom.com/documentation/manuals/[Astribank User Manual]
 
 An HTML version of the latest version of this document could be found at 
-http://rapid.tzafrir.org.il/docs/README.Astribank.html[]
+http://zaptel.tzafrir.org.il/README.Astribank.html[]
 
 Building and Installation
 -------------------------
@@ -365,7 +365,7 @@ The following commands provide useful information for debugging:
 
 * Check USB level status. You can use one of the following utilities for it:
 
-  zaptel_hardware 
+  zaptel_hardware -v
        or
   lsusb | grep e4e4
 
@@ -376,7 +376,7 @@ The following commands provide useful information for debugging:
     is loaded while the lsusb will just list the device.
   - If it shows something as product ID *11x0* - the USB firmware is not
     loaded. Maybe you need to run fxload. Or maybe just unplug and plug again
-    the device.
+    the device. Also make sure that you have fxload installed.
   - If lsusb shows the Product ID as *11x1* - only the USB firmware is loaded 
     and not the FPGA firmware is loaded. If this is still the case after 
     a while - either the firmware loading has failed or you don't have
@@ -495,7 +495,7 @@ is up. A slower single blinking indicates that layer 2 is up as well
 (which means that Asterisk is driving the port).
 
 
-DEVICE STARTUP
+Device Startup
 ~~~~~~~~~~~~~~
 This section describes in great depth the initialization of the Xorcom
 Astribank. Normally it would not be really needed, as the standard
@@ -716,6 +716,20 @@ faster "blinking" when the XPDs register as Zaptel spans. The initializaton
 of an FXS XPD may take a few seconds.
 
 
+Astribank in Sysfs
+^^^^^^^^^^^^^^^^^^
+When an Astribank device loads it generates a device node in the bus 
+'astribanks' in sysfs. You can see a directory for each device under 
+/sys/bus/astribanks/devices/ and under it there are several attributes
+for each Astribank (such as its connector string).
+
+On each time an Astribank is initialized or destroyed a udev event is
+generated. The rules from our sample udev rules file (xpp/utils/xpp.rules) 
+make that event run the script /usr/share/zaptel/astribank_hook with the
+parameter 'add' or 'remove'. Currently this script will just adjust the
+Astribank sync settings (by running xpp_sync). 
+
+
 Registering in Zaptel
 ^^^^^^^^^^^^^^^^^^^^^
 The XPDs will not automatically register as zaptel spans. This is
@@ -788,6 +802,7 @@ The Astribank drivers provide their own /proc interface under /proc/xpp.
 (Note that the details of this interface are still potentially subject to 
 changes)
 
+
 /proc/xpp/xbuses
 ^^^^^^^^^^^^^^^^
 File /proc/xpp/xbuses lists the connected Astribank devices (one line 
@@ -797,6 +812,7 @@ A device is normally has status "connected". The status "missing" means that
 the device has been disconnected, but Asterisk still holds channels from it
 open.
 
+
 /proc/xpp/sync
 ^^^^^^^^^^^^^^
 A read/write file. It contains information about current synchronization