DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

Intro(D4isdn)


Intro -- Introduction to structures and data definitions for ISDN

Description

This man page section documents the structures and data definitions that are used as parameters with Section D7isdn in Section D7isdn manual pages ISDN messages.

The message parameters in this section are defined by SCO but are based on those defined in the CAPI 2.0 specification. For more information on the CAPI Association, see their web site: http://www.capi.org/.

Some structure members are defined according to the International Telecommunication Union (ITU, formerly CCITT) Recommendation Q.931 (03/93) - Digital Subscriber Signalling System No. 1 (DSS 1); the ISDN user-network interface layer 3 specification for basic call control. For more information, contact ITU:

International Telecommunication Union (ITU)
Place des Nations
CH-1211 Geneva 20
Switzerland

http://www.itu.ch/.

Basic data types

ISDN message parameters are composed of these basic data types, which cannot be omitted:

Data type Definitions Comments
byte isdnU8_t
isdnBfU8_t
isdnByte_t
isdnOctet_t
unsigned eight bit integers, coded as one octet. The isdnBfU8_t type must support bit fields.
word isdnU16_t
isdnWord_t
unsigned sixteen bit integers, coded as two contiguous octets. They are stored with the least significant octet first.
double word isdnU32_t
isdnBfU32_t
isdnDword_t
unsigned thirty two bit integers, coded as two contiguous words. They are stored with the least significant octet first. The isdnBfU32_t type must support bit fields.
structure struct variable length structure, coded as an array of octets. The first octet must contain the length of the following data. If the first octet has the value of 255 (0xFF), it indicates an escape character for interpreting the following word as the length of the data.

 Data type     Definitions   Comments
 ------------------------------------------------------
 byte          isdnU8_t      unsigned eight bit
               isdnBfU8_t    integers, coded as one
               isdnByte_t    octet.  The isdnBfU8_t
               isdnOctet_t   type must support bit
                             fields.
 word          isdnU16_t     unsigned sixteen bit
               isdnWord_t    integers, coded as two
                             contiguous octets.  They
                             are stored with the least
                             significant octet first.
 double word   isdnU32_t     unsigned thirty two bit
               isdnBfU32_t   integers, coded as two
               isdnDword_t   contiguous words.  They
                             are stored with the least
                             significant octet first.
                             The isdnBfU32_t type must
                             support bit fields.
 structure     struct        variable length
                             structure, coded as an
                             array of octets.  The
                             first octet must contain
                             the length of the
                             following data.  If the
                             first octet has the value
                             of 255 (0xFF), it
                             indicates an escape
                             character for
                             interpreting the
                             following word as the
                             length of the data.

Multi-octet message values are stored with the least significant octet first (little endian). This is not the same as the usual network byte order. It is specified in this manner to more closely conform to the other ISDN standards. Where bit fields are specified, it is assumed that the first bit assigned by the compiler is the least significant bit of the integer.

The CAPI 2.0 specification defines many of the data structures passed as message parameters as having variable length. This convention has been retained in the SCO ISDN implementation. Each structure must therefore begin with a length byte indicating the size of the structure. An empty structure is indicated by a length byte of 0. Parameters of the structure type must be coded as an empty structure if they are not used.

References

Section D7isdn manual pages in Section D7isdn manual pages, ``SCO ISDN adapter drivers''.

Standards compliance

SCO ISDN structures and data definitions are implementations of ``message parameters'' defined in the CAPI (Common ISDN API) Version 2.0; for more information, see the CAPI Association web site.

CAPI message parameters SCO data definition
Additional info (struct) isdnAddInfo(D4isdn)
B1 Protocol (word) isdnB1proto(D4isdn)
B2 Protocol (word) isdnB2proto(D4isdn)
B3 Protocol (word) isdnB3proto(D4isdn)
B1 Configuration (struct) isdnB1config(D4isdn)
B2 Configuration (struct) isdnB2config(D4isdn)
B3 Configuration (struct) isdnB3config(D4isdn)
B Channel Information (struct)
B Protocol (struct)
isdnBproto(D4isdn)
BC (struct) isdnBC(D4isdn)
Called Party Number (struct) isdnCalledNbr(D4isdn)
Called Party Subaddress (struct) isdnCalledAdr(D4isdn)
Calling Party Number (struct) isdnCallingNbr(D4isdn)
Calling Party Subaddress (struct) isdnCallingAdr(D4isdn)
CIP value (word) isdnCIPvalue(D4isdn)
CIP mask (dword) isdnCIPmask(D4isdn)
Connected Number (struct) isdnConnNbr(D4isdn)
Connected Subaddress (struct) isdnConnAdr(D4isdn)
Controller (dword) isdnCtrlr(D4isdn)
Data (dword)
Data Length (word)
Data Handle (word)
isdnData(D4isdn)
Facility Selector (word) isdnFacility(D4isdn)
Facility Request Parameter (struct) not used
Facility Confirmation Parameter (struct) isdnFCP(D4isdn)
Facility Indication Parameter (struct) isdnFIP(D4isdn)
Facility Response Parameter (struct) isdnFRP(D4isdn)
Flags (word) isdnFlags(D4isdn)
HLC (struct) isdnHLC(D4isdn)
Info (word) isdnInfo(D4isdn)
Info Elements (struct) isdnInfoEl(D4isdn)
Info Mask (dword) isdnInfoMsk(D4isdn)
Info Number (word) isdnInfoNbr(D4isdn)
LLC (struct) isdnLLC(D4isdn)
Manu ID (dword) isdnManuID(D4isdn)
Manufacturer Specific Not used
NCCI (dword) isdnNCCI(D4isdn)
NCPI (struct) isdnNCPI(D4isdn)
PLCI (dword) isdnPLCI(D4isdn)
Reason (word) isdnReason(D4isdn)
Reason_B3 (word) isdnReason_B3(D4isdn)
Reject (word) isdnReject(D4isdn)

 CAPI message parameters                    SCO data definition
 ------------------------------------------------------------------
 Additional info (struct)                   isdnAddInfo(D4isdn)
 B1 Protocol (word)                         isdnB1proto(D4isdn)
 B2 Protocol (word)                         isdnB2proto(D4isdn)
 B3 Protocol (word)                         isdnB3proto(D4isdn)
 B1 Configuration (struct)                  isdnB1config(D4isdn)
 B2 Configuration (struct)                  isdnB2config(D4isdn)
 B3 Configuration (struct)                  isdnB3config(D4isdn)
 B Channel Information (struct)             isdnBproto(D4isdn)
 B Protocol (struct)
 BC (struct)                                isdnBC(D4isdn)
 Called Party Number (struct)               isdnCalledNbr(D4isdn)
 Called Party Subaddress (struct)           isdnCalledAdr(D4isdn)
 Calling Party Number (struct)              isdnCallingNbr(D4isdn)
 Calling Party Subaddress (struct)          isdnCallingAdr(D4isdn)
 CIP value (word)                           isdnCIPvalue(D4isdn)
 CIP mask (dword)                           isdnCIPmask(D4isdn)
 Connected Number (struct)                  isdnConnNbr(D4isdn)
 Connected Subaddress (struct)              isdnConnAdr(D4isdn)
 Controller (dword)                         isdnCtrlr(D4isdn)
 Data (dword)                               isdnData(D4isdn)
 Data Length (word)
 Data Handle (word)
 Facility Selector (word)                   isdnFacility(D4isdn)
 Facility Request Parameter (struct)        not used
 Facility Confirmation Parameter (struct)   isdnFCP(D4isdn)
 Facility Indication Parameter (struct)     isdnFIP(D4isdn)
 Facility Response Parameter (struct)       isdnFRP(D4isdn)
 Flags (word)                               isdnFlags(D4isdn)
 HLC (struct)                               isdnHLC(D4isdn)
 Info (word)                                isdnInfo(D4isdn)
 Info Elements (struct)                     isdnInfoEl(D4isdn)
 Info Mask (dword)                          isdnInfoMsk(D4isdn)
 Info Number (word)                         isdnInfoNbr(D4isdn)
 LLC (struct)                               isdnLLC(D4isdn)
 Manu ID (dword)                            isdnManuID(D4isdn)
 Manufacturer Specific                      Not used
 NCCI (dword)                               isdnNCCI(D4isdn)
 NCPI (struct)                              isdnNCPI(D4isdn)
 PLCI (dword)                               isdnPLCI(D4isdn)
 Reason (word)                              isdnReason(D4isdn)
 Reason_B3 (word)                           isdnReason_B3(D4isdn)
 Reject (word)                              isdnReject(D4isdn)

19 June 2005
© 2005 The SCO Group, Inc. All rights reserved.
OpenServer 6 and UnixWare (SVR5) HDK - June 2005