Add optional "hotplug mode" to init scripts

The hotplug mode is only used in XPP_HOTPLUG_DAHDI=yes is set in
/etc/dahdi/init.conf . If it is set and the system actually has
Astribanks, most of the init script will actually be run from the
context of a udev event.

Merged revisions 6987,7014,7334-7335,7409,7476 via svnmerge from 
https://origsvn.digium.com/svn/dahdi/tools/trunk

........
  r6987 | tzafrir | 2009-08-13 18:15:49 +0300 (Thu, 13 Aug 2009) | 9 lines
  
  xpp: Add astribank_is_starting:
  
  astribank_is_running is used to tell when we may have an Astribank that
  is initializing (and may be re-enumerating and thus not listed as a
  device).
  
  It uses a semaphore as we can always write to one and we can't always
  write to a file.
........
  r7014 | tzafrir | 2009-08-16 19:05:11 +0300 (Sun, 16 Aug 2009) | 4 lines
  
  xpp: A man page for astribank_is_starting
  
  xpp rev: 7321
........
  r7334 | tzafrir | 2009-10-04 15:35:51 +0200 (Sun, 04 Oct 2009) | 7 lines
  
  dahdi.init: move module loading to a separate function
  
  Move the module loading parts of the dahdi init script to a seperate
  function - load_modules. To be used by a later commit.
  
  There is not functional change here (but the diff is confusing).
........
  r7335 | tzafrir | 2009-10-04 15:53:01 +0200 (Sun, 04 Oct 2009) | 16 lines
  
  Add XPP_HOTPLUG_DAHDI mode: cfg initiated mostly from hotplug
  
  If XPP_HOTPLUG_DAHDI=yes is set in /etc/dahdi/init.conf (which is not
  the default), the normal run of the 'start' operation of the dahdi init
  script will only be responsible for loading modules. The rest will be
  done (if there are indeed Astribanks on the system) by a second call to
  the init script once all of them have connected.
  
  The astribank_hook has also been mostly rewritten. Most of the
  functionality of twinstar_hook moved to it. The current twinstar_hook is
  a simple example script.
  
  XPP_HOTPLUG_DAHDI mode assumes that all Astribanks on the system are
  listed in /etc/dahdi/xpp_order (which can be generated using, e.g.
  'dahdi_genconf xpporder')
........
  r7409 | tzafrir | 2009-10-21 16:30:32 +0200 (Wed, 21 Oct 2009) | 21 lines
  
  Fix XPP_HOTPLUG_DAHDI: logic; end of init.d script
  
  'Hotplug mode' was introduced in r7335.
  
  * The logic in the script was broken.
    - Negative logic is not such a grand idea to start with.
  * Interactive invocation of init.d ends when expected and not sooner.
  
  This change makes waitfor_xpds wait longer. Rather than waiting for all
  the Astribanks to load, it will now wait until the initialization of
  dahdi from the Astribanks hook script is run.
  
  This allows running e.g.: /etc/init.d/dahdi start; /etc/init.d/asterisk start
  
  It also means that 'astribank_is_starting' is actually used as a
  semaphore and not only as stamp file.
   
  As before, those changes have no effect if hotplug mode is not
  explicitly enabled (setting 'XPP_HOTPLUG_DAHDI=yes' in init.conf).
........
  r7476 | tzafrir | 2009-11-04 22:12:35 +0200 (Wed, 04 Nov 2009) | 6 lines
  
  xpp: make astribank_is_starting build without warnings.
  
  autoconfig.h is needed as semtimedop() requires _GNU_SOURCE.
  
  xpp rev: 7471
........


git-svn-id: http://svn.asterisk.org/svn/dahdi/tools/branches/2.2@7477 a0bf4364-ded3-4de4-8d8a-66a801d63aff

1 files changed, 100 insertions, 0 deletions

diff --git a/xpp/astribank_is_starting.8 b/xpp/astribank_is_starting.8
new file mode 100644
index 0000000..55db6f6
--- /dev/null
+++ b/xpp/astribank_is_starting.8
@@ -0,0 +1,100 @@
+.TH "ASTRIBANK_IS_STARTING" "8" "16 August 2009" "" ""
+
+.SH NAME
+astribank_is_starting \- Mark / check is a Xorcom Astribank (xpp) is starting
+.SH SYNOPSIS
+.B astribank_is_starting [-d] [-v] [-t \fItimeout\fB] <-a|-r|-w>
+
+.B astribank_is_starting [-d] [-v]
+
+.B astribank_is_starting -h
+
+.SH DESCRIPTION
+.B astribank_is_starting
+is an internal tool used by various xpp scripts to mark that there may
+be an Astribank device currently initializing, and to check for that mark.
+
+Technically the mark is a SysV semaphore.
+
+.SH OPTIONS
+.B -a
+.RS
+.B Add.
+Set the mark. Should return 0 unless there's an error.
+.RE
+
+.B -r
+.RS
+.B Remove.
+Reset the mark. Should return 0 unless there's an error.
+.RE
+
+.BI -t timeout
+.RS
+.B Timeout.
+Set the timeout value for the \fB-w\fR option. Default is 60 seconds.
+.RE
+
+.B -w
+.RS
+.B Wait.
+Wait for mark to be reset. Should return 0 unless there's an error.
+.RE
+
+Without -a or -r: return 0 if the mark has been set, or a non-zero value
+otherwise.
+
+.B -d
+.RS
+Print debug information to stderr.
+.RE
+
+.B -v
+.RS
+Verbose execution.
+.RE
+
+.B -h
+.RS
+Displays usage message.
+.RE
+
+.SH FILES
+.B /proc/sysvipc/sem
+.RS
+If set, the astribank should appear there with the ID 11211168 (0xAB11A0).
+Naturally the ID (or rather, the usage of a semaphore in the first place)
+is an implementation detail that may change.
+.RE
+
+.SH NOTES
+.B astribank_is_starting
+is used to mark the fact that an Astribank may be currently reenumerating
+(technically: distonnecting and connecting as a new USB device) after
+loading the firmware. Thus the script that loads the firmware 
+(/usr/share/dahdi/xpp_fxloader) uses this utility to set the mark.
+
+The mark is reset by /usr/share/dahdi/waitfor_xpds , which is typically
+run by the DAHDI init script and waits for all Astribanks to finish
+loading.
+
+Q: Why do you use a semaphore?
+
+A: because, unlike the filesystem, it is writable at any given time.
+
+.SH BUGS
+Option ordering matter. The \fB-v\fR and \fB-d\fR options should preceed
+the actions (\fB-a\fR, \fB-r\fR and \fB-w\fR).
+The \fB-t\fItimeout\fR option should preceed the \fB-w\fR option.
+
+.SH SEE ALSO
+semctl(3)
+
+.SH AUTHOR
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> .
+Permission is granted to copy, distribute and/or modify this document under
+the terms of the GNU General Public License, Version 2 any 
+later version published by the Free Software Foundation.
+
+On Debian systems, the complete text of the GNU General Public
+License can be found in /usr/share/common-licenses/GPL.