Dialogic Open Systems Release 6.1

Dialogic Open Systems Release 6.1 Installation and Reference Manual

About This Manual

This is Edition 2, last updated 2007-06-24, of The Dialogic Open Systems Release 6.1 Installation and Reference Manual, for Version 0.9.2 release 2 of the Dialogic Open Systems Release 6.1 package.

Preface

Notice

This version of osr61 is a version of the Dialogic® Open System Release 6.1 GPL drivers, modified by The OpenSS7 Project to support the package using Linux Fast-STREAMS instead of the deprecated LiS.

This package is released and distributed under the GNU General Public License (see GNU General Public License). Please note, however, that there are different licensing terms for the manual pages and some of the documentation (derived from 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 all sections invariant.

Abstract

This manual provides a Installation and Reference Manual for Dialogic Open Systems Release 6.1.

Objective

The objective of this manual is to provide a guide for the STREAMS programmer when developing STREAMS modules, drivers and application programs for Dialogic Open Systems Release 6.1.

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 Dialogic Open Systems Release 6.1 manual pages. For a reference for writing code, the manual pages (see STREAMS(9)) provide a better reference to the programmer. Although this describes the features of the Dialogic Open Systems Release 6.1 package, OpenSS7 Corporation is under no obligation to provide any software, system or feature listed herein.

Audience

This 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.

Revisions

Take 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 Dialogic Open Systems Release 6.1 package, osr61-0.9.2.2.¹

Version Control

     
     osr61.texi,v
     Revision 0.9.2.5  2007/06/22 00:18:25  brian
     - mostly documentation updates for release, some netconfig workaround
     
     Revision 0.9.2.4  2007/03/04 10:00:31  brian
     - updates for release, do not propagate empty flags, build improvements
     
     Revision 0.9.2.3  2007/02/28 06:30:25  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.2  2007/02/27 08:38:35  brian
     - release corrections for 2.4 kernel builds
     
     Revision 0.9.2.1  2007/02/25 12:45:12  brian
     - added new files for release package
     
     

ISO 9000 Compliance

Only 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.

Disclaimer

OpenSS7 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 Rights

If 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).

Acknowledgements

As 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.

Sponsors

Funding for completion of the OpenSS7 Dialogic Open Systems Release 6.1 package was provided in part by:

Additional funding for The OpenSS7 Project was provided by:

Contributors

The primary contributor to the OpenSS7 Dialogic Open Systems Release 6.1 package is Brian F. G. Bidulock. The following is a list of significant contributors to The OpenSS7 Project:

Authors

The authors of the OpenSS7 Dialogic Open Systems Release 6.1 package include:

See Author Index, for a complete listing and cross-index of authors to sections of this manual.

Maintainer

The maintainer of this modified OpenSS7 Dialogic Open Systems Release 6.1 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 Resources

The OpenSS7 Project provides a website dedicated to the software packages released by the OpenSS7 Project.

Bug Reports

Please send bug reports to bugs@openss7.org using the send-pr script included in the Dialogic Open Systems Release 6.1 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 Lists

The OpenSS7 Project provides a number of general discussion Mailing Lists for discussion concerning the OpenSS7 Dialogic Open Systems Release 6.1 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:

openss7

The openss7 mailing list is for general enquiries, information exchange and announcements regarding the OpenSS7 Project. This is our original mailing list and takes the highest amount of traffic.

openss7-announce

The openss7-announce mailing list is for announcements related to the OpenSS7 Project. This list will accept announcements posted by subscribers. Subscribe to this list if you are interested in announcements from the OpenSS7 Project, subscribers and sponsors, related to the OpenSS7 Project or STREAMS, SS7, SIGTRAN or SCTP in general.

openss7-cvs

The openss7-cvs mailing list is for automatic CVS log reporting. You must get permission of the owner to subscribe to this list. Subscribers are not allowed to post to this list, this is merely for distributing notification of changes to the CVS repository.h

openss7-develop

The openss7-develop mailing list is for email exchange related to the development projects under the OpenSS7 Project. This includes development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the OpenSS7 Project.

openss7-test

The openss7-test mailing list is for email exchange related to the testing of code under the OpenSS7 Project. This specifically relates to conformance testing, verification testing, interoperability testing and beta testing. Subscribe to this list if you are interested in participating in and receiving ongoing details of test activities under the OpenSS7 Project.

openss7-bugs

The openss7-bugs mailing list is specifically tailored to bug tracking. The mailing list takes a feed from the OpenSS7 GNATS bug tracking system and accepts posting of responses to bug reports, tracking and resolution. Subscribe to this list if you are interested in receiving detailed OpenSS7 release code bug tracking information. This list is not archived; for historical information on problem reports, see our GNATS databases.

openss7-updates

The openss7-updates mailing list provides updates on OpenSS7 Project code releases and ongoing activities. Subscribers are not allowed to post to this list; this list is for official OpenSS7 Project announcements only. Subscribe to this list if you are interested in receiving updates concerning official releases and activities of the OpenSS7 Project.

openss7-streams

The openss7-streams mailing list is for email exchange related to the STREAMS development projects under the OpenSS7 Project. This includes development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the OpenSS7 Project STREAMS components.

linux-streams

The linux-streams mailing list is for mail exchange related to Linux Fast-STREAMS or Linux STREAMS. This includes patches, development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the STREAMS for Linux components. This is the the new (September 2006) home of the linux-streams list formerly of <gsyc.escet.urjc.es>.

Spam

To 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 Policy

It 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 Attachments

The mailing list is blocked from messages of greater than 40k. If you have attachments (patches, test programs, etc.) and you mail them to the list, it will bounce to the list administrator. If you are interested in making your patches, test programs, test results or other large attachments available to the members of the mailing list, state in the message that you would like them posted and the list administrator will place them in the mail archives.

Quick Start Guide

Dialogic Open Systems Release 6.1

Package osr61-0.9.2.2 was released under GPLv2 2007-06-24.

The Dialogic Open Systems Release 6.1 package provides STREAMS modules and drivers, libraries, programs, init scripts, and daemons that implement the Dialogic® Open System Release 6.1 drivers for Linux Fast-STREAMS.

This is an OpenSS7 Project modified relase of the GPL'ed Dialogic® OSR 6.1 Release 239 drivers modified for use with Linux Fast-STREAMS.

The Dialogic Open Systems Release 6.1 package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of Dialogic Open Systems Release 6.1 components and applications for the SVR 4.2 STREAMS environment. It provides true STREAMS-based Dialogic® OSR 6.1 drivers for Linux.

The package builds and installs the following STREAMS kernel modules and drivers:

The Springware device drivers support the ability to run the older Springware legacy platform. These are STREAMS based and use STREAMS functionality provided by Linux Fast-STREAMS. Unlike DM3 or PMAC, a common library interface to access these drivers does no exist which makes their removal difficult. All User Interfaces are provided by Linux Fast-STREAMS, based on the STREAMS protocol.

dlgn(4)

The dlgn(4) driver is a device driver that provides access to the Dialogic® SpringWare and Antares boards.

The dlgn(4) is the main driver which controls the firmware interfaces. It follows the Springware Protocol to communicate with the firmware. There is no DPC or timer in this driver and its use has not been required since SRAM access is done quickly enough in the messaging via the channel and device SRAM areas. No other processing is required in this driver. dlgn(4) will read or write a block of data from and to the host runtime library or the bulk data module.

gncfd(4)

The gncfd(4) driver is a generic configuration driver that is used by the Dialogic® runtime libraries to perform configuration for Dialogic® SpringWare and Antares boards.

The generic configuration driver interfaces with the gncfd(4) driver library (libgncf.so) and is used to setup logical devices for the Springware boards. The driver is invoked after firmware download via the voxctl application. After the logical devices are created (`dxxxB1', `dxxB1C1', etc.), the driver will start the board (enabled interrupts). voxctl will create the /usr/dialogic/cfg/.voxcfg file that contains all the logical device information given by the gncfd(4) driver.

gpio(4)

The gpio(4) driver is the generic input-output interface for downloading firmware.

The Generic Input-Output driver is used to download firmware onto the board. This driver interfaces with the gpio(4) driver library (libgpio.so) and is utilized by the genload application during the start of all the Dialogic® services. The driver locates boards in the system by providing the physical address, bus, slot and other information to genload. This is used by gpiodebug for debugging the memory and input-output devices.

mercd(4)

The mercd(4) driver is a device driver for the Dialogic® DM3 family of boards including the Mercury board (after which it is named).

The DM3 driver, mercd(4), is a STREAMS based device driver. The mercd(4) driver is based on the Dialogic® Media III (a.k.a. DM3) architecture. The driver comprises of both the SRAM protocol (used in the older products like DMVA) and the Werewolf (WW) protocol (used in the newer platforms like the DMVB/DMN160 boards) merged into one driver.

dvbm(4)

The dvbm(4) module is a device access module that is pushed over a dlgn(4) driver Stream.

The bulk data module buffers media data from and to the dlgn(4) driver. It is configured by the host runtime libraries (which can be configured by the application via setparm API). The configuration sets the flow of data between dlgn(4) and host.

sctmr(4)

The sctmr(4) module is a timer module that is pushed over a
dlgn(4) driver Stream (but may also be pushed over a null Stream such as nuls(4)).

The timer module is used by the global call libraries to keep time in kernel mode. No other functionality is performed by this driver. It has no interaction with the board or the other drivers.

pmacd(4)

The pmacd(4) driver is a non-STREAMS driver for the Dialogic® IPT family of boards.

The packet media access card driver, pmacd(4), is a straightforward driver for the IPT family of boards based on Intelligent Input-Output (I2O) technology. It provides all the driver interfaces, namely the user, driver interfaces. This driver only supports messaging based on the IPT protocol and Streaming is not supported on the IPT boards. This makes the PMAC driver simple and efficient since there is not much processing required at the driver level. The driver uses DPC and a 40 millisecond timer.

ctimod(4)

The ctimod(4) kernel module is a CTI wrapper module that provides wrappers of kernel functions for use principally by the
pmacd(4) driver.

ctimod(4) provides an interface to kernel level services through a thin layer of abstraction calls. This is available only on the PMAC driver.

The Dialogic Open Systems Release 6.1 package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of Dialogic Open Systems Release 6.1 components and applications for the SVR 4.2 STREAMS environment.

This distribution is only currently applicable to Linux 2.4 and 2.6 kernels and was targeted at ix86, x86_64, ppc and ppc64 architectures, but should build and install for other architectures as well.

Release

This is the osr61-0.9.2.2 package, released 2007-06-24. This `0.9.2.2' 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/osr61-0.9.2.2.tar.bz2

The release is available as an autoconf(1) tarball, src.rpm or dsc, or as a set of binary rpms or debs. See the download page for the autoconf(1) tarballs, src.rpms or dscs. See the osr61 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-osr61 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 2 of the GNU 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.

Prerequisites

The 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.F, instead of separately.

Prerequisites for the Dialogic Open Systems Release 6.1 package are as follows:

1. Linux distribution, somewhat Linux Standards Base compliant, with a 2.4 or 2.6 kernel and the appropriate tool chain for compiling out-of-tree kernel modules. Most recent Linux distributions are usable out of the box, but some development packages must be installed. For more information, see Compatibility.

   	− A fairly LSB compliant GNU/Linux distribution.2
   	− Linux 2.4 kernel (2.4.10 - 2.4.27), or
   	− Linux 2.6 kernel (2.6.3 - 2.6.21);
   	− glibc2 or better.
   	− GNU info (for info files).
   	− GNU groff (for man pages).3

(Note: If you acquired osr61 a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)

2. OpenSS7 Linux Fast-STREAMS, streams-0.9.2.3. ⁴
3. OpenSS7 STREAMS Compatibility Modules, strcompat-0.9.2.6.
4. OpenSS7 STREAMS XNS, strxns-0.9.2.6.
5. OpenSS7 STREAMS XTI/TLI, strxnet-0.9.2.11.

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:

     $> ../osr61-0.9.2.2/configure CC='gcc-3.4'

Installation

The following commands will download, configure, build, check, install, validate, uninstall and remove the package:

     $> wget http://www.openss7.org/tarballs/osr61-0.9.2.2.tar.bz2
     $> tar -xjvf osr61-0.9.2.2.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../osr61-0.9.2.2/configure --enable-autotest
     $> make
     $> make check
     $> sudo make install
     $> sudo make installcheck
     $> sudo make uninstall
     $> popd
     $> sudo rm -rf build
     $> rm -rf osr61-0.9.2.2
     $> rm -f osr61-0.9.2.2.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.⁵ Installation steps using the logging targets proceed as follows:

     $> wget http://www.openss7.org/tarballs/osr61-0.9.2.2.tar.bz2
     $> tar -xjvf osr61-0.9.2.2.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../osr61-0.9.2.2/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 osr61-0.9.2.2
     $> rm -f osr61-0.9.2.2.tar.bz2

See README-make for additional specialized make targets.

For custom applications, see the INSTALL and INSTALL-osr61 files or the see Installation, as listed below. If you encounter troubles, see Troubleshooting, before issuing a bug report.

Brief Installation Instructions

The Dialogic Open Systems Release 6.1 package is available from the downloads area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/osr61-0.9.2.2.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf osr61-0.9.2.2.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: osr61-0.9.2.2.

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
     $> ../osr61-0.9.2.2/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 ../osr61-0.9.2.2/INSTALL

For specific options to the configure script, see the INSTALL-osr61 file in the distribution, or simply execute the configure script with the --help option like so:

     $> ../osr61-0.9.2.2/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 osr61-0.9.2.2
     $> rm -f osr61-0.9.2.2.tar.bz2

Detailed Installation Instructions

More detailed installation instructions can be found in the Installation, contained in the distribution in `text', `info', `html' and `pdf' formats:

     $> cd ../osr61-0.9.2.2
     $> less doc/manual/osr61.txt
     $> lynx doc/manual/osr61.html
     $> info doc/manual/osr61.info
     $> xpdf doc/manual/osr61.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/osr61_manual.html

1 Introduction

This manual documents the design, implementation, installation, operation and future development schedule of the Dialogic Open Systems Release 6.1 package.

1.1 Overview

This manual documents the design, implementation, installation, operation and future development of the Dialogic Open Systems Release 6.1 package.

1.2 Organization of this Manual

This manual is organized (loosely) into several sections as follows:

1.3 Conventions and Definitions

This manual uses texinfo typographic conventions.

2 Objective

The objective for creating the Dialogic Open Systems Release 6.1 package was to provide support for Linux Fast-STREAMS to the Dialogic Open Systems Release 6.1 GPL drivers. Originally, these drivers worked with LiS, but as LiS is deprecated and buggy and does not support recent Linux distributions, it became necessary to support these drivers using Linux Fast-STREAMS.

The Dialogic Open Systems Release 6.1 package also demonstrates the ease with which former LiS drivers can be ported to the production Linux Fast-STREAMS. The entire port from concept to completed package was performed in under 5 days.

The only component for the Dialogic Open Systems Release 6.1 release that is released by Dialogic under the GPL (see GNU General Public License) are the core drivers for the release under Linux. The original driver package can be obtained from the osr61_239_GPLdrivers.tgz tarball from the Dialogic Website. The runtime libraries that make the drivers useful are released under far more restrictive terms and are, therefore, only available directly from Dialogic.

The OpenSS7 Project currently does not have any applications or STREAMS modules that depend upon the availability of the Dialogic Open Systems Release 6.1 package, and this is one of the reasons that this package is initially untested (the test-osr61(8) test suite is incomplete). Nevertheless, it has all of the components of a fully functional OSR61 driver release and can easily be tested against exiting (even binary) runtime libraries and applications. If you have applications or modules that required the Dialogic Open Systems Release 6.1 package, contact The OpenSS7 Project about advancing testing of this package.

3 Reference

This chapter provides a reference to the contents of the OSR61 package. Please note that this texinfo documentation is not updated as regularly as the manual pages. For a more up to date package reference, please begin with the osr61(5) manual page (that documents the package).

3.1 Files

OSR61 creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:⁶

modules.osr61

OSR61 installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/osr61/:⁷

streams_dlgnDriver.ko

kernel module containing the dlgn(4) STREAMS driver.

streams_dvbmDriver.ko

kernel module containing the dvbm(4) STREAMS module.

streams_gncfgDriver.ko

kernel module containing the gncfd(4) STREAMS driver.

streams_gpioDriver.ko

kernel module containing the gpio(4) STREAMS driver.

streams_sctmrDriver.ko

kernel module containing the sctmr(4) STREAMS module.

streams_mercdDriver.ko

kernel module containing the mercd(4) STREAMS driver.

pmacd.ko

kernel module containing the pmacd(4) driver.

ctimod.ko

kernel module containing the ctimod(4) kernel module.

OSR61 installs the following header files in the system include directory, /usr/include/osr61/:

sys/osr61/config.h

osr61 configuration header.

sys/osr61/version.h

osr61 module version header.

OSR61 installs the following test programs in the system libexec directory, /usr/libexec/osr61/:⁸

send-pr

send-pr.config

The send-pr stand-alone shell script can be used for the automatic generation of problem reports for the Dialogic Open Systems Release 6.1 package. The send-pr.config file provides localized definitions used by the send-pr program. For more information on problem reports, See Problem Reports, and, in particular, See Stand Alone Problem Reports.

test-osr61

test program.

testsuite

atlocal

The testsuite stand-alone shell script invokes test cases in the test programs above as compiled into a comprehensive regression, troubleshooting and validation test suite for the Dialogic Open Systems Release 6.1 drivers. The atlocal file provides localized definitions used by the testsuite program. For more information on test suites, See Test Suites, and, in particular, See Running Test Suites.

OSR61 installs the following utility programs in the system binary directory, /usr/sbin/:

osr61_mknod

This utility can be used by init scripts or administrative users to create or remove device nodes in the /dev directory for Dialogic Open Systems Release 6.1 drivers.

OSR61 installs the following init scripts in the system init directory, /etc/rc.d/init.d/ (non-Debian) or /etc/init.d/ (Debian):

osr61

This is the name of the system init script on non-Debian based systems.

osr61.sh

This is the name of the system init script on Debian based systems.

OSR61 installs the following system configuration files in the configuration directory, /etc/:

osr61.conf

This file provided configuration information for any system controls affected by the `osr61' package.

modutils/osr61

This file provides module definitions and demand loading aliases for the osr61 package. This file is really only applicable to older 2.4 kernels.

OSR61 installs the following system configuration file in the system configuration directory, /etc/sysconfig/ (non-Debian) or /etc/default/ (Debian):

osr61

This file provides system configuration information used by init scripts for the `osr61' package. Some options of init script execution can be controlled by this file.

OSR61 installs the following info files in the system info directory, /usr/share/info/:

osr61.info

osr61.info-1

osr61.info-2

These files contain this manual in GNU info format.

OSR61 installs the following mannual page macros and reference database files in the system man directory, /usr/share/man/:⁹

osr61.macros

This file contains manual page macro definitions included by the manual pages included in the package.

osr61.refs

This file contains a reference database referenced by the manual pages included in the package.

OSR61 installs the following manual pages in the system man directory, /usr/share/man/man4/:

dlgn.4

manual page for the dlgn(4) STREAMS driver.

dvbm.4

manual page for the dvbm(4) STREAMS module.

gncfd.4

manual page for the gncfd(4) STREAMS driver.

gpio.4

manual page for the gpio(4) STREAMS driver.

sctmr.4

manual page for the sctmr(4) STREAMS module.

mercd.4

manual page for the mercd(4) STREAMS driver.

pmacd.4

manual page for the pmacd(4) driver.

ctimod.4

manual page for the ctimod(4) kernel module.

OSR61 installs the following manual pages in the system man directory, /usr/share/man/man5/:

osr61.5

manual page for the osr61(5) package.

OSR61 installs the following manual pages in the system man directory, /usr/share/man/man8/:

osr61_mknod.8

Documentation for the osr61_mknod(8) utility program.

test-osr61.8

manual page for the test-osr61(8) program.

3.2 Drivers

The configuration of STREAMS drivers is performed when compiling the Dialogic Open Systems Release 6.1 subsystem. The OSR61 subsystem, core drivers are part of every Dialogic Open Systems Release 6.1 system.

Kernel modules are installed by the Dialogic Open Systems Release 6.1 package in the /lib/modules/2.4.20-28.7/osr61/ directory, with either a `.o' or `.ko' extension.¹⁰

The following lists the core drivers, STREAMS kernel tunable parameters, and STREAMS configuration information:¹¹

dlgn(4) (streams-dlgnDriver)

See dlgn(4) for more information.

gncfd(4) (streams-gncfdDriver)

See gpio(4) for more information.

gpio(4) (streams-gpioDriver)

See gpio(4) for more information.

mercd(4) (streams-mercdDriver)

See mercd(4) for more information.

pmacd(4) (pmacd)

See pmacd(4) for more information.

3.3 Modules

The configuration of STREAMS modules is performed when compiling the Dialogic Open Systems Release 6.1 subsystem. The OSR61 subsystem, core modules are part of every Dialogic Open Systems Release 6.1 system.

Kernel modules are installed by the Dialogic Open Systems Release 6.1 package in the /lib/modules/2.4.20-28.7/osr61/ directory, with either a `.o' or `.ko' extension.¹²

The following lists the core modules, STREAMS kernel tunable parameters, and STREAMS configuration information:¹³

dvbm(4) (streams-dvbmDriver)

See dvbm(4) for more information.

sctmr(4) (streams-sctmrDriver)

See sctmr(4) for more information.

ctimod(4) (ctimod)

See ctimod(4) for more information.

3.4 Libraries

Although the Dialogic® Open System Release 6.1 contains a number of runtime libraries for talking to the STREAMS drivers, these libraries carry restrictive licensing terms and are not included in this package. To compile the libraries, download the runtime library releases from the Dialogic Website and compile them yourself.

Existing binary runtime libraries and applications should not have to be recompiled to use the Linux Fast-STREAMS drivers.

3.5 Utilities

3.5.1 Init Scripts

Following are System V Init Scripts that are installed by the package:

osr61(8) (/etc/init.d/osr61)

osr61.sh(8) (/etc/init.d/osr61.sh)

System V Init Script for the OSR61 Subsystem. The osr61(8) init script provides the ability to initialize, configure and mount the OSR61 subsystem, osr61(5). The osr61(8) script provides the RedHat-style init script, whereas the osr61.sh(8) script provides the Debian-style init script.

See osr61(8) for more information.

3.5.2 User Utilities

Following are user utilities for manipulating Streams:

The OSR61 package does not currently contain any user utilities.

3.5.3 Administrative Utilities

Following are administrative utilities for manipulating and examining the OSR61 subsystem:

The OSR61 package does not currently contain any administrative utilities.

3.5.4 Performance Test Programs

Following are performance test programs:

The OSR61 package does not currently contain any performance test programs.

3.5.5 Conformance Test Programs

Following and conformance and validation testing programs:

test-osr61(8) (/usr/libexec/osr61/test-osr61)

The test-osr61(8) C-language program is a conformance and validation test program, in the OpenSS7 Project style, for the sctmr(4) STREAMS module.

See test-osr61(8) for more information.

For the proper way to execute these validation test programs in a conformance and validation test suite, see Running Test Suites.

3.6 Development

The OSR61 package contains the necessary header files, shared and static libraries, manuals and manual pages necessary for the development of kernel modules, STREAMS modules and drivers, and applications programs based on the OSR61 package.

3.6.1 Header Files

Header files are installed, typically, in the /usr/include/osr61 subdirectory.¹⁴ To use the header files from the package, `-I/usr/include/osr61' must be included in the gcc command line as a compile option. This is true regardless of whether user space or kernel space programs are being compiled.

In general, `-I' include directives on the gcc command line should be ordered in the reverse order of the dependencies between packages. So, for example, if the include files from all add-on packages are required, the order of these directives would be: `-I/usr/include/strss7 -I/usr/include/strsctp -I/usr/include/strinet -I/usr/include/strxnet -I/usr/include/strxns -I/usr/include/strcompat -I/usr/include/streams'.

3.6.1.1 User Space Programs

Typical include files for interacting with STREAMS from user space include the stropts.h header file. Additional header files for interacting with specific drivers or modules may also be required.

3.6.1.2 Kernel Space Drivers and Modules

Typical include files for writing STREAMS modules and drivers for kernel space include the sys/cmn_err.h, sys/kmem.h, sys/dki.h, sys/stream.h, sys/ddi.h, and sys/strconf.h header files. Additional header files for interacting with specific drivers or modules may also be required.

3.6.2 Libraries

Shared or static versions of the libstreams library must be linked when using the osr61-0.9.2.2 package. This library must either be specified on the gcc command line as a shared library (e.g. `-lstreams') or as a static library (e.g. `/usr/lib/libstreams.a').

If the shared library is linked, include the following options on the gcc command line:

If the static library is linked, include the following options on the gcc command line:

3.6.3 Kernel Modules

Developing STREAMS kernel modules is similar to user space programs with regard to header files. /usr/include/osr61 should be placed as an include directory to search in the gcc command line. The rules for compiling Linux kernel modules should be followed. In particular, several important intricacies should be considered:

• The gcc compiler used to compile the kernel modules must be the same version of compiler that was used to compile the kernel.
• The gcc command line must have the same compile flags that were used to compile the kernel.
• The gcc command line must define several important kernel defines including `-DLINUX', `-D__KERNEL__', as well as the base name of the module.
• The gcc command line must include several important include files directly on the command line such as `--include /lib/modules/2.4.20-28.7/build/include/linux/autoconf.h' and maybe even `--include /lib/modules/2.4.20-28.7/build/include/linux/modversions.h'.¹⁵

3.6.4 Manual Pages

The osr61-0.9.2.2 package installs the following manual pages in the /usr/share/man/ subdirectory:

4 Conformance

When modifying the Dialogic Open Systems Release 6.1 package, an attempt was made to maintain binary compatibility and conformance for all of the drivers. It should be noted that as the LiS package against which these drivers were formerly compiled is buggy and cannot support full 32-bit over 64-bit compatibility, the binary interface to, and experienced behaviour of, the drivers may differ.

It is intended that conformance to specifications for the OSR61 interface be tested using the test-osr61(8) test case executable and the package autotest test suite; however, at the time of writing these test programs are incomplete.

5 Releases

This is the OpenSS7 Release of the Dialogic Open Systems Release 6.1 tools, drivers and modules used with the Linux Fast-STREAMS or Linux STREAMS¹⁶ SVR 4.2 STREAMS releases.

The purpose of providing a separate release of this package was to separate the Dialogic Open Systems Release 6.1 tools, headers, drivers and modules from the Linux STREAMS¹⁷ package for use with both Linux STREAMS¹⁸ and Linux Fast-STREAMS in preparation for replacement of the former by the later.

The following sections provide information on Dialogic Open Systems Release 6.1 releases as well as compatibility information of OpenSS7 release to mainstream UNIX releases of the core, modules and drivers, as well as Linux kernel compatibility.

5.1 Prerequisites

The 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.F, instead of separately.

Prerequisites for the Dialogic Open Systems Release 6.1 package are as follows:

1. Linux distribution, somewhat Linux Standards Base compliant, with a 2.4 or 2.6 kernel and the appropriate tool chain for compiling out-of-tree kernel modules. Most recent Linux distributions are usable out of the box, but some development packages must be installed. For more information, see Compatibility.