| strisdn ManualDescription: OpenSS7 Online ManualsA PDF version of this document is available here. OpenSS7 STREAMS ISDNOpenSS7 STREAMS ISDN Installation and Reference ManualAbout This ManualThis is Edition 4, last updated 2008-10-31, of The OpenSS7 STREAMS ISDN Installation and Reference Manual, for Version 0.9.2 release 4 of the OpenSS7 STREAMS ISDN package. PrefaceNoticeThis package is released and distributed under the GNU Affero General Public License (see AGPL). Please note, however, that there are different licensing terms for the manual pages and some of the documentation (derived from OpenGroup1 publications and other sources). Consult the permission notices contained in the documentation for more information. This manual is released under the FDL (see GNU Free Documentation License) with no sections invariant. AbstractThis manual provides a Installation and Reference Manual for OpenSS7 STREAMS ISDN. ObjectiveThe objective of this manual is to provide a guide for the STREAMS programmer when developing STREAMS modules, drivers and application programs for OpenSS7 STREAMS ISDN. This guide provides information to developers on the use of the STREAMS mechanism at user and kernel levels. STREAMS was incorporated in UNIX System V Release 3 to augment the character input/output (I/O) mechanism and to support development of communication services. STREAMS provides developers with integral functions, a set of utility routines, and facilities that expedite software design and implementation. Intent
The intent of this manual is to act as an introductory guide to the STREAMS programmer. It
is intended to be read alone and is not intended to replace or supplement the
OpenSS7 STREAMS ISDN manual pages. For a reference for writing code, the manual pages
(see AudienceThis manual is intended for a highly technical audience. The reader should already be familiar with Linux kernel programming, the Linux file system, character devices, driver input and output, interrupts, software interrupt handling, scheduling, process contexts, multiprocessor locks, etc. The guide is intended for network and systems programmers, who use the STREAMS mechanism at user and kernel levels for Linux and UNIX system communication services. Readers of the guide are expected to possess prior knowledge of the Linux and UNIX system, programming, networking, and data communication. RevisionsTake care that you are working with a current version of this manual: you will not be notified of updates. To ensure that you are working with a current version, contact the Author, or check The OpenSS7 Project website for a current version. A current version of this manual is normally distributed with the OpenSS7 STREAMS ISDN package. Version ControlISO 9000 ComplianceOnly the TeX, texinfo, or roff source for this manual is controlled. An opaque (printed, postscript or portable document format) version of this manual is an UNCONTROLLED VERSION. DisclaimerOpenSS7 Corporation disclaims all warranties with regard to this documentation including all implied warranties of merchantability, fitness for a particular purpose, non-infringement, or title; that the contents of the manual are suitable for any purpose, or that the implementation of such contents will not infringe on any third party patents, copyrights, trademarks or other rights. In no event shall OpenSS7 Corporation be liable for any direct, indirect, special or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with any use of this manual or the performance or implementation of the contents thereof. OpenSS7 Corporation reserves the right to revise this software and documentation for any reason, including but not limited to, conformity with standards promulgated by various agencies, utilization of advances in the state of the technical arts, or the reflection of changes in the design of any techniques, or procedures embodied, described, or referred to herein. OpenSS7 Corporation is under no obligation to provide any feature listed herein. U.S. Government Restricted RightsIf you are licensing this Software on behalf of the U.S. Government ("Government"), the following provisions apply to you. If the Software is supplied by the Department of Defense ("DoD"), it is classified as "Commercial Computer Software" under paragraph 252.227-7014 of the DoD Supplement to the Federal Acquisition Regulations ("DFARS") (or any successor regulations) and the Government is acquiring only the license rights granted herein (the license rights customarily provided to non-Government users). If the Software is supplied to any unit or agency of the Government other than DoD, it is classified as "Restricted Computer Software" and the Government's rights in the Software are defined in paragraph 52.227-19 of the Federal Acquisition Regulations ("FAR") (or any successor regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the NASA Supplement to the FAR (or any successor regulations). AcknowledgementsAs with most open source projects, this project would not have been possible without the valiant efforts and productive software of the Free Software Foundation and the Linux Kernel Community. SponsorsFunding for completion of the OpenSS7 OpenSS7 STREAMS ISDN package was provided in part by:
Additional funding for The OpenSS7 Project was provided by: ContributorsThe primary contributor to the OpenSS7 OpenSS7 STREAMS ISDN package is Brian F. G. Bidulock. The following is a list of significant contributors to The OpenSS7 Project:
AuthorsThe authors of the OpenSS7 OpenSS7 STREAMS ISDN package include:
See Author Index, for a complete listing and cross-index of authors to sections of this manual. MaintainerThe maintainer of the OpenSS7 OpenSS7 STREAMS ISDN package is:
Please send bug reports to bugs@openss7.org using the send-pr script included in the package, only after reading the BUGS file in the release, or See Problem Reports. Web ResourcesThe OpenSS7 Project provides a website dedicated to the software packages released by the OpenSS7 Project. Bug ReportsPlease send bug reports to bugs@openss7.org using the send-pr script included in the OpenSS7 STREAMS ISDN package, only after reading the BUGS file in the release, or See Problem Reports. You can access the OpenSS7 GNATS database directly via the web, however, the preferred method for sending new bug reports is via mail with the send-pr script. Mailing ListsThe OpenSS7 Project provides a number of general discussion Mailing Lists for discussion concerning the OpenSS7 OpenSS7 STREAMS ISDN package as well as other packages released by The OpenSS7 Project. These are mailman mailing lists and so have convenient web interfaces for subscribers to control their settings. See http://www.openss7.org/mailinglist.html. The mailing lists are as follows:
SpamTo avoid spam being sent to the members of the OpenSS7 mailing list(s), we have blocked mail from non-subscribers. Please subscribe to the mailing list before attempting to post to them. (Attempts to post when not subscribed get bounced.) As an additional measure against spam, subscriber lists for all OpenSS7 mailing lists are not accessible to non-subscribers; for most lists subscriber lists are only accessible to the list administrator. This keeps your mailing address from being picked off our website by bulk mailers. Acceptable Use PolicyIt is acceptable to post professional and courteous messages regarding the OpenSS7 package or any general information or questions concerning STREAMS, SS7, SIGTRAN, SCTP or telecommunications applications in general. Large AttachmentsThe mailing list is blocked from messages of greater than Quick Start GuideOpenSS7 STREAMS ISDNPackage strisdn-0.9.2.4 was released under AGPLv3 2008-10-31. OpenSS7 STREAMS ISDN (strisdn) is an OpenSS7 Project implementation of a number of ISDN related components, including Q.920, Q.921, Q.931, GR-303, V5.2, DPNSS/DASS. The package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of OpenSS7 STREAMS ISDN applications for the SVR 4.2 STREAMS environment. This release is the first separate release of the OpenSS7 STREAMS ISDN package. Some of the components in this package were formerly present in the strss7 package. Various networking drivers are provided as well as CDI, DLPI, NPI, TPI and CCI header files for ISDN operation. The package contains the necessary manual pages and other documentation for ISDN components in a separate autoconf tarball. The OpenSS7 STREAMS ISDN package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of OpenSS7 STREAMS ISDN applications for the SVR 4.2 STREAMS environment. This package is currently incomplete. It is being released as a reference point for the community. If you are interested in completion of this package, sponsor the OpenSS7 Project. To sponsor the project, contact info@openss7.com. This distribution is only currently applicable to Linux 2.4 and 2.6 kernels and was targeted
at ReleaseThis is the strisdn-0.9.2.4 package, released 2008-10-31. This ‘0.9.2.4’ release, and the latest version, can be obtained from the download area of The OpenSS7 Project website using a command such as: $> wget http://www.openss7.org/tarballs/strisdn-0.9.2.4.tar.bz2 The release is available as an autoconf(1) tarball, src.rpm or dsc, as a set of binary rpms or debs, or as a yum(8) or apt(8) repository. See the download page for the autoconf(1) tarballs, src.rpms, dscs, or repository access instructions. See the strisdn package page for tarballs, source and binary packages. Please see the NEWS file for release notes and history of user visible changes for the current version, and the ChangeLog file for a more detailed history of implementation changes. The TODO file lists features not yet implemented and other outstanding items. Please see the INSTALL, INSTALL-strisdn and README-make, files (or see Installation) for installation instructions. When working from cvs(1) or git(1), please see the README-cvs, file (or see Downloading from CVS). An abbreviated installation procedure that works for most applications appears below. This release of the package is published strictly under Version 3 of the GNU Affero Public License which can be found in the file COPYING. Package specific licensing terms (if any) can be found in the file LICENSES. Please respect these licensing arrangements. If you are interested in different licensing terms, please contact the copyright holder, or OpenSS7 Corporation <sales@openss7.com>. See README-alpha (if it exists) for alpha release information. PrerequisitesThe quickest and easiest way to ensure that all prerequisites are met is to download and install this package from within the OpenSS7 Master Package, openss7-0.9.2.G, instead of separately. Prerequisites for the OpenSS7 STREAMS ISDN package are as follows:
(Note: If you acquired strisdn a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)
When configuring and building multiple OpenSS7 Project release packages, place all of the source packages (unpacked tarballs) at the same directory level and all build directories at the same directory level (e.g. all source packages under /usr/src). When installing packages that install as kernel modules, it is necessary to have the correct kernel development package installed. For the following distributions, use the following commands: Ubuntu: $> apt-get install linux-headers
Debian: $> apt-get install kernel-headers
Fedora: $> yum install kernel-devel
You also need the same version of gcc(1) compiler with which the kernel was built. If it is not the default, add ‘CC=kgcc’ on the line after ‘./configure’, for example: $> ../strisdn-0.9.2.4/configure CC='gcc-3.4' InstallationThe following commands will download, configure, build, check, install, validate, uninstall and remove the package: $> wget http://www.openss7.org/tarballs/strisdn-0.9.2.4.tar.bz2
$> tar -xjvf strisdn-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strisdn-0.9.2.4/configure --enable-autotest
$> make
$> make check
$> sudo make install
$> sudo make installcheck
$> sudo make uninstall
$> popd
$> sudo rm -rf build
$> rm -rf strisdn-0.9.2.4
$> rm -f strisdn-0.9.2.4.tar.bz2
If you have problems, try building with the logging targets instead. If the make of a logging target fails, an automatic problem report will be generated that can be mailed to The OpenSS7 Project.6 Installation steps using the logging targets proceed as follows: $> wget http://www.openss7.org/tarballs/strisdn-0.9.2.4.tar.bz2
$> tar -xjvf strisdn-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strisdn-0.9.2.4/configure --enable-autotest
$> make compile.log
$> make check.log
$> sudo make install.log
$> sudo make installcheck.log
$> sudo make uninstall.log
$> popd
$> sudo rm -rf build
$> rm -rf strisdn-0.9.2.4
$> rm -f strisdn-0.9.2.4.tar.bz2
See README-make for additional specialized make targets. For custom applications, see the INSTALL and INSTALL-strisdn files or the see Installation, as listed below. If you encounter troubles, see Troubleshooting, before issuing a bug report. Brief Installation InstructionsThe OpenSS7 STREAMS ISDN package is available from the downloads area of The OpenSS7 Project website using a command such as: $> wget http://www.openss7.org/tarballs/strisdn-0.9.2.4.tar.bz2 Unpack the tarball using a command such as: $> tar -xjvf strisdn-0.9.2.4.tar.bz2 The tarball will unpack into the relative subdirectory named after the package name: strisdn-0.9.2.4. The package builds using the GNU autoconf utilities and the configure script. To build the package, we recommend using a separate build directory as follows: $> mkdir build
$> cd build
$> ../strisdn-0.9.2.4/configure
In general, the package configures and builds without adding any special options to the configure script. For general options to the configure script, see the GNU INSTALL file in the distribution: $> less ../strisdn-0.9.2.4/INSTALL For specific options to the configure script, see the INSTALL-strisdn file in the distribution, or simply execute the configure script with the --help option like so: $> ../strisdn-0.9.2.4/configure --help After configuring the package, the package can be compiled simply by issuing the ‘make’ command: $> make Some specialized makefile targets exists, see the README-make file in the distribution or simply invoke the ‘help’ target like so: $> make help | less After successfully building the package, the package can be checked by invoking the ‘check’ make target like so: $> make check After successfully checking the package, the package can be installed by invoking the ‘install’ make target (as root) like so: $> sudo make install The test suites that ship with the package can be invoked after the package has been installed by invoking the ‘installcheck’ target. This target can either be invoked as root, or as a normal user, like so: $> make installcheck (Note: you must add the --enable-autotest flag to configure, above for the test suites to be invoked with ‘make installcheck’.) The package can be cleanly removed by invoking the ‘uninstall’ target (as root): $> sudo make uninstall Then the build directory and tarball can be simply removed: $> cd ..
$> rm -rf build
$> rm -rf strisdn-0.9.2.4
$> rm -f strisdn-0.9.2.4.tar.bz2
Detailed Installation InstructionsMore detailed installation instructions can be found in the Installation, contained in the distribution in ‘text’, ‘info’, ‘html’ and ‘pdf’ formats: $> cd ../strisdn-0.9.2.4
$> less doc/manual/strisdn.txt
$> lynx doc/manual/strisdn.html
$> info doc/manual/strisdn.info
$> xpdf doc/manual/strisdn.pdf
The ‘text’ version of the manual is always available in the MANUAL file in the release. The current manual is also always available online from The OpenSS7 Project website at: $> lynx http://www.openss7.org/strisdn_manual.html 1 IntroductionThis manual documents the design, implementation, installation, operation and future development schedule of the OpenSS7 STREAMS ISDN package. 1.1 OverviewThis manual documents the design, implementation, installation, operation and future development of the OpenSS7 STREAMS ISDN package. 1.2 Organization of this ManualThis manual is organized (loosely) into several sections as follows:
1.3 Conventions and DefinitionsThis manual uses texinfo typographic conventions. 2 Objective3 Reference3.1 FilesSTRISDN creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:7
STRISDN installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/strisdn/:8 STRISDN installs the following header files in the system include directory, /usr/include/strisdn/:
STRISDN installs the following test programs in the system libexec directory, /usr/libexec/strisdn/:9
STRISDN installs the following utility programs in the system binary directory, /usr/sbin/:
STRISDN installs the following init scripts in the system init directory, /etc/rc.d/init.d/ (non-Debian) or /etc/init.d/ (Debian):
STRISDN installs the following system configuration files in the configuration directory, /etc/:
STRISDN installs the following system configuration file in the system configuration directory, /etc/sysconfig/ (non-Debian) or /etc/default/ (Debian):
STRISDN installs the following info files in the system info directory, /usr/share/info/:
STRISDN installs the following manual page macros and reference database files in the system man directory, /usr/share/man/:10
STRISDN installs the following manual pages in the system man directory, /usr/share/man/man4/:
STRISDN installs the following manual pages in the system man directory, /usr/share/man/man5/:
STRISDN installs the following manual pages in the system man directory, /usr/share/man/man7/:
|