OpenSS7 SS7 for the Common Man | © Copyright 1997-2007 OpenSS7 Corporation All Rights Reserved. Last modified: Sat, 01 Nov 2008 14:12:37 GMT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SLI Technical SpecificationDescription: OpenSS7 Resources Library.A PDF version of this document is available here. Signalling Link Interface (SLI)Signalling Link InterfacePrefaceSecurity WarningPermission to use, copy and distribute this documentation without modification, for any purpose and without fee or royalty is hereby granted, provided that both the above copyright notice and this permission notice appears in all copies and that the name of OpenSS7 Corporation not be used in advertising or publicity pertaining to distribution of this documentation or its contents without specific, written prior permission. OpenSS7 Corporation makes no representation about the suitability of this documentation for any purpose. It is provided “as is” without express or implied warranty. 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 document 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 document or the performance or implementation of the contents thereof. OpenSS7 Corporation is making this documentation available as a reference point for the industry. While OpenSS7 Corporation believes that these interfaces are well defined in this release of the document, minor changes may be made prior to products conforming to the interfaces being made available. AbstractThis document is a Specification containing technical details concerning the implementation of the Signalling Link Interface (SLI) for OpenSS7. It contains recommendations on software architecture as well as platform and system applicability of the Signalling Link Interface (SLI). This document specifies a Signalling Link Interface (SLI) Specification in support of the OpenSS7 Signalling Link (SL) protocol stacks. It provides abstraction of the signalling link interface to these components as well as providing a basis for signalling link control for other link control protocols. PurposeThe purpose of this document is to provide technical documentation of the Signalling Link Interface (SLI). This document is intended to be included with the OpenSS7 STREAMS software package released by OpenSS7 Corporation. It is intended to assist software developers, maintainers and users of the Signalling Link Interface (SLI) with understanding the software architecture and technical interfaces that are made available in the software package. IntentIt is the intent of this document that it act as the primary source of information concerning the Signalling Link Interface (SLI). This document is intended to provide information for writers of OpenSS7 Signalling Link Interface (SLI) applications as well as writers of OpenSS7 Signalling Link Interface (SLI) Users. AudienceThe audience for this document is software developers, maintainers and users and integrators of the Signalling Link Interface (SLI). The target audience is developers and users of the OpenSS7 SS7 stack. DisclaimerAlthough the author has attempted to ensure that the information in this document is complete and correct, neither the Author nor OpenSS7 Corporation will take any responsibility in it. Revision HistoryTake care that you are working with a current version of this documentation: you will not be notified of updates. To ensure that you are working with a current version, check the OpenSS7 Project website for a current version. Only the texinfo or roff source is controlled. A printed (or postscript) version of this document is an UNCONTROLLED VERSION. sli.texi,v Revision 0.9.2.9 2008-09-20 11:04:31 brian - added package patchlevel Revision 0.9.2.8 2008-08-03 06:03:32 brian - protected agains texinfo commands in log entries Revision 0.9.2.7 2008-08-03 05:05:17 brian - conditional @syncodeindex frags out automake, fails distcheck Revision 0.9.2.6 2008-07-11 09:36:13 brian - updated documentation Revision 0.9.2.5 2008-04-29 07:10:40 brian - updating headers for release Revision 0.9.2.4 2007/08/14 12:17:05 brian - GPLv3 header updates Revision 0.9.2.3 2007/08/03 13:34:54 brian - manual updates, put ss7 modules in public release Revision 0.9.2.2 2007/07/09 09:04:51 brian - working up SLI specification Revision 0.9.2.1 2007/07/04 08:24:58 brian - added new files 1 IntroductionThis document specifies a STREAMS-based kernel-level instantiation of the ITU-T Signalling Link Interface (SLI) definition. The Signalling Link Interface (SLI) enables the user of a a signalling link service to access and use any of a variety of conforming signalling link providers without specific knowledge of the provider's protocol. The service interface is designed to support any network signalling link protocol and user signalling link protocol. This interface only specifies access to signalling link service providers, and does not address issues concerning signalling link management, protocol performance, and performance analysis tools. This specification assumes that the reader is familiar with ITU-T state machines and signalling link interfaces (e.g. Q.703, Q.2210), and STREAMS. 1.1 Related Documentation
1.1.1 RoleThis document specifies an interface that supports the services provided by the Signalling System No. 7 (SS7) for ITU-T, ANSI and ETSI applications as described in ITU-T Recommendation Q.703, ITU-T Recommendation Q.2210, ANSI T1.111.3, ETSI ETS 300 008-1. These specifications are targeted for use by developers and testers of protocol modules that require signalling link service. 1.2 Definitions, Acronyms, Abbreviations
2 The Signalling Link LayerThe Signalling Link Layer provides the means to manage the association of SL-Users into connections. It is responsible for the routing and management of data to and from signalling link connections between SL-user entities. 2.1 Model of the SLIThe SLI defines the services provided by the signalling link layer to the signalling link user at the boundary between the signalling link provider and the signalling link user entity. The interface consists of a set of primitives defined as STREAMS messages that provide access to the signalling link layer services, and are transferred between the SLS user entity and the SLS provider. These primitives are of two types; ones that originate from the SLS user, and other that originate from the SLS provider. The primitives that originate from the SLS user make requests to the SLS provider, or respond to an indication of an event of the SLS provider. The primitives that originate from the SLS provider are either confirmations of a request or are indications to the CCS user that an event has occurred. Figure 1 shows the model of the SLI. Figure 1. Model of the SLI
The SLI allows the SLS provider to be configured with any signalling link layer user (such as a
signalling link application) that also conforms to the SLI. A signalling link layer user can also
be a user program that conforms to the SLI and accesses the SLS provider via 2.2 SLI ServicesThe features of the SLI are defined in terms of the services provided by the SLS provider, and the individual primitives that may flow between the SLS user and the SLS provider. The SDLI Services are broken into two groups: local management services and protocol services. Local management services are responsible for the local management of streams, assignment of streams to physical points of attachment, enabling and disabling of streams, management of options associated with a stream, and general acknowledgement and event reporting for the stream. Protocol services consist of . 2.2.1 Local ManagementLocal management services are listed in Table 1. Table 1. Local Management Services
The local management services interface is described in Local Management Services, and the primitives are detailed in Local Management Service Primitives. The local management services interface is defined by the ss7/lmi.h header file (see LMI Header File Listing). 2.2.2 ProtocolProtocol services are listed in Table 2. Table 2. Protocol Services
The protocol services interface is described in Protocol Services, and the primitives are detailed in Protocol Service Primitives. The protocol services interface is defined by the ss7/sli.h header file (see SLI Header File Listing). 2.3 Purpose of the SLIThe SLI is typically implemented as a device driver controlling an intelligent protocol controller device that provides access to channels. The purpose behind exposing this low level interface is that almost all communications channel devices can be placed into a SS7 HDLC mode, where a data stream can be exchanged between the driver and the medium. The SLI provides and inteface that, once implemented as a driver for a new device, can provide complete and verified SS7 signalling link capabilities by linking under a generic MTP (Message Transfer Part) multiplex driver an open device stream. This allows MTP drivers to be verified independently for correct operation and then simply used for all manner of new device drivers that can implement the SLI interface. 3 SLI Services Definition3.1 Local Management Services3.1.1 Acknowledgement ServiceThe acknowledgement service provides the LMS user with the ability to receive positive and negative acknowledgements regarding the successful or unsuccessful completion of services.
A successful invocation of the acknowledgement service is illustrated in Figure 15. Figure 15. Message Flow: Successful Acknowledgement Service
As illustrated in Figure 15, the
service primitives for which a positive acknowledgement may be returned are the
An unsuccessful invocation of the acknowledgement service is illustrated in Figure 16. Figure 16. Message Flow: Unsuccessful Acknowledgement Service
As illustrated in Figure 16, the
service primitives for which a negative acknowledgement may be returned are the
3.1.2 Information Reporting ServiceThe information reporting service provides the LMS user with the ability to elicit information from the LMS provider.
A successful invocation of the information reporting service is illustrated in Figure 2. Figure 2. Message Flow: Successful Information Reporting Service
3.1.3 Physical Point of Attachment ServiceThe local management interface provides the LMS user with the ability to associate a stream to a physical point of appearance (PPA) or to disassociate a stream from a PPA. The local management interface provides for two styles of LMS provider: Style 1 LMS ProviderA Style 1 LMS provider is a provider that associates a stream with a PPA at the time of the
first Physical points of attachment (PPA) are assigned to major and minor device number combinations. When the major and minor device number combination is opened, the opened stream is automatically associated with the PPA for the major and minor device number combination. The last close of the device disassociates the PPA from the stream. Freshly opened Style 1 LMS provider streams start life in the This approach is suitable for LMS providers implemented as real or pseudo-device drivers and is applicable when the number of minor devices is small and static. Style 2 LMS ProviderA Style 2 LMS provider is a provider that associates a stream with a PPA at the time that the
LMS user issues the Freshly opened Style 2 LMS provider streams start life in the This approach is suitable for LMS providers implemented as clone real or pseudo-device drivers and is applicable when the number of minor devices is large or dynamic. 3.1.3.1 PPA Attachment ServiceThe PPA attachment service provides the LMS user with the ability to attach a Style 2 LMS provider stream to a physical point of appearance (PPA).
A successful invocation of the attachment service is illustrated in Figure 3. Figure 3. Message Flow: Successful Attachment Service
3.1.3.2 PPA Detachment ServiceThe PPA detachment service provides the LMS user with the ability to detach a Style 2 LMS provider stream from a physical point of attachment (PPA).
A successful invocation of the detachment service is illustrated in Figure 4. Figure 4. Message Flow: Successful Detachment Service
3.1.4 Initialization ServiceThe initialization service provides the LMS user with the abilty to enable and disable the stream for the associated PPA. 3.1.4.1 Interface Enable ServiceThe interface enable service provides the LMS user with the ability to enable an LMS provider stream that is associated with a PPA. Enabling the interface permits the LMS user to exchange protocol service interface messages with the LMS provider.
A successful invocation of the enable service is illustrated in Figure 5. Figure 5. Message Flow: Successful Enable Service
3.1.4.2 Interface Disable ServiceThe interface disable service provides the LMS user with the ability to disable an LMS provider stream that is associated with a PPA. Disabling the interface withdraws the LMS user's ability to exchange protocol service interface messages with the LMS provider.
A successful invocation of the disable service is illustrated in Figure 6. Figure 6. Message Flow: Successful Disable Service
3.1.5 Options Management ServiceThe options management service provides the LMS user with the ability to control and affect various generic and provider-specific options associated with the LMS provider.
A successful invocation of the options management service is illustrated in Figure 7. Figure 7. Message Flow: Successful Options Management Service
3.1.6 Error Reporting ServiceThe error reporting service provides the LMS provider with the ability to indicate asynchronous errors to the LMS user.
A successful invocation of the error reporting service is illustrated in Figure 8. Figure 8. Message Flow: Successful Error Reporting Service
3.1.7 Statistics Reporting Service
A successful invocation of the statistics reporting service is illustrated in Figure 9. Figure 9. Message Flow: Successful Statistics Reporting Service
3.1.8 Event Reporting ServiceThe event reporting service provides the LMS provider with the ability to indicate specific asynchronous management events to the LMS user.
A successful invocation of the event reporting service is illustrated in Figure 10. Figure 10. Message Flow: Successful Event Reporting Service
3.2 Protocol ServicesProtocol services are specific to the Signalling Link interface. These services consist of initialization of the link and preparation for the transfer of signal units, the transfer of signal units, transmit and receive congestion control, BSNT retrieval, buffer updating, buffer clearing, local processor outage, remote processor outage, link options management and management event notification. The service primitives that implement the protocol services are described in detail in Protocol Service Primitives. 3.2.1 Link Initialization ServicesThe link initialization services provide the SLS user with the ability to power on the terminal, set emergency status, start the signalling link and stop the signalling link. The service primitives that implement the link initialization services are described in detail in Link Initialization Service Primitives. 3.2.1.1 Power On ServiceThe power on service provides the SLS user with the ability to power on the signalling data terminal. The signalling data terminal must be powered on at least once before the link can be started.
A successful invocation of the power on service is illustrated in Figure 17. Figure 17. Message Flow: Successful Power On Service
3.2.1.2 Emergency ServiceThe emergency service provides the SLS user with the ability to specify whether normal or emergency alignment procedures should take effect on the current or next alignment procedure. Emergency alignment procedures have a shorter duration (short proving period) than normal alignment procedures. Some SS7 protocol variants (TTC) always use emergency alignment procedures and are not affected by this service.
A successful invocation of the emergency service is illustrated in Figure 18. Figure 18. Message Flow: Successful Emergency Service
3.2.1.3 Start ServiceThe start service provides the SLS user with the ability to align the signalling link and have it placed into service. The start service must be successfully invoked on both sides of the signalling link before the signalling link is able to exchange message signal units.
A successful invocation of the start service is illustrated in Figure 19. Figure 19. Message Flow: Successful Start Service
A unsuccessful invocation of the start service is illustrated in Figure 20. Figure 20. Message Flow: Unsuccessful Start Service
3.2.1.4 Stop ServiceThe stop service provides the SLS user and provider with the ability to take a signalling link out of service. Once the stop service has successfully completed, the signalling link is no longer able to exchange message signal units.
A successful invocation of the stop service is illustrated in Figure 21. Figure 21. Message Flow: Successful Stop Service
3.2.2 Data Transfer ServiceThe data transfer service provides the SLS user with the ability to exchange message signal units on the signalling link. The service primitives that implement the data transfer service are described in detail in Data Transfer Service Primitives.
A successful invocation of the data transfer service is illustrated in Figure 22. Figure 22. Message Flow: Successful Data Transfer Service
3.2.3 Congestion ServicesThe congestion services provide the SLS user with the ability to invoke a receive congestion policy. They also provide the SLS provider with the ability to indicate transmit congestion levels. The service primitives that implement the congestion services are described in detail in Congestion Service Primitives. 3.2.3.1 Transmit Congestion ServiceThe transmit congestion service provides the SLS provider with the ability to indicate transmit congestion (and corresponding levels) to the SLS user. There are 4 levels of congestion, 0, 1, 2 and 3. Each congestion level has an onset threshold and an abatement threshold. When the transmit buffer occupancy exceeds the onset threshold for the level, congestion is indicated at that level. When the transmit buffer occupancy falls below the abatement threshold for the level, congestion abatement is indicated. Some SS7 protocol variants do not have congestion levels and only signal the presence or lack of congestion. When congestion is indicated at a level, the SLS user should discard messages that have a message priority that is less than the level at which congestion has been indicated.
A successful indication of the transmit congestion service is illustrated in Figure 23. Figure 23. Message Flow: Successful Transmit Congestion Service
3.2.3.2 Receive Congestion ServiceThe receive congestion service provides the SLS user with the ability to specify that receive congestion is in effect or has abated and the policy to use for received message signal units under congestion. A discard policy indicates that received message signal units should be discarded (and not acknowledged); receive congestion is signalled to the sending side of the signalling link. An accept policy indicates that received message signal units should not be discarded and should be acknowledged; receive congestion is signalled to the sending side of the signalling link. When receive congestion abates, the abatement of receive congestion is signalled to the sending side of the signalling link. The SLS provider may also perform its own receive congestion onset, abatement and policy. The SLS provider does not indicate its current receive congestion level or policy to the SLS user.
A successful invocation of the receive congestion service is illustrated in Figure 24. Figure 24. Message Flow: Successful Receive Congestion Service
3.2.4 Restoration ServicesRestoration services consist of the services necessary to change over a link, update its buffers, and clearing any unnecessarily old MSUs from the receive buffer or retransmission buffer. The service primitives that implement the restoration services are detailed in Restoration Service Primitives. 3.2.4.1 BSNT Retrieval ServiceThe BSNT retrieval service is a somewhat optional service in support of the sequenced changeover procedure of the Message Transfer Part. It is ‘somewhat’ optional due to the possibility that time-controlled changeover is always used, per ETSI ETS 300 008-1.
A successful invocation of the BSNT retrieval service is illustrated in Figure 25. Figure 25. Message Flow: Successful BSNT Retreival Service
An unsuccessful invocation of the BSNT retrieval service is illustrated in Figure 26. Figure 26. Message Flow: Unsuccessful BSNT Retrieval Service
3.2.4.2 Buffer Updating ServiceThe buffer updating service provides the SLS user with the ability to update the retransmission buffer and collect messages that have not been successfully received by the remote side of the signalling link during a sequenced changeover procedure. The SLS user specifies the FSNC (the forward sequence number confirmed received by the remote end of the signalling link). The SLS provider uses the FSNC to purge successfully received messages from the retransmission buffer and then indicates the remaining contents of the retransmission buffer and the transmission buffer to the SLS user. The SLS user may also clear the retransmission buffer using the buffer clearing service before retrieving messages. This this case, the messages retrieved by the SLS provider will be the contents of the transmission buffer. The combination of the two services are used to perform the time controlled changeover procedure.
A successful invocation of the buffer updating service is illustrated in Figure 27. Figure 27. Message Flow: Successful Buffer Updating Service
An unsuccessful invocation of the buffer updating service is illustrated in Figure 28. Figure 28. Message Flow: Unsuccessful Buffer Updating Service
3.2.4.3 Buffer Clearing ServiceThe buffer clearing service provides the SLS user with the ability to request that all message buffers be cleared (receive buffer, retransmission buffer, transmission buffer) and that the SLS provider indicate when the receive and retransmission buffer are cleared. It also provides the SLS user with the ability to clear only the retransmission buffer and receive and indication when the buffer is cleared. Clearing of all buffers is performed when the signalling link has been blocked (local or remote processor outage) for a long duration and messages contained in the buffer are too old to be processed. Clearing of the retransmission buffer is performed as part of the time-controlled changeover procedure, when the value of the FSNC has not been received in a sequenced changeover message from the adjacent signalling point.
A successful invocation of the buffer clearing service is illustrated in Figure 29 and Figure 32. Figure 29. Message Flow: Successful Buffer Clearing Service
Figure 32. Message Flow: Successful Buffer Clearing Service
3.2.5 Processor Outage ServicesThe processor outage services provide the SLS user with the ability to request a local processor outage as well as being informed of a local or remote processor outage. The service primitives that implement the processor outage services are described in detail in Processor Outage Service Primitives. 3.2.5.1 Local Processor Outage ServiceThe local processor outage service provides the SLS user with the ability to both request a local processor outage as well as be informed of a local processor outage. Local processor outage occurs when the SLS user is unable to pass message signal units for transmission or accept received message signal units, or the SLS provider is unable to deliver received message signal units or accept message signal units for transmission. Local processor outage conditions can exist independently within the SLS user and within the SLS provider.
A successful invocation of the local processor outage service is illustrated in Figure 30. Figure 30. Message Flow: Successful Processor Outage Service
3.2.5.2 Remote Processor Outage ServiceThe remote processor outage service provides the SLS user with the ability to be informed of remote processor outage conditions. Remote processor outage occurs when the remote SLS user is experiencing a local processor outage. Remote processor outage conditions can exist independent of local processor outage conditions.
A successful indication of the remote processor outage service is illustrated in Figure 31. Figure 31. Message Flow: Successful Processor Outage Service
3.2.6 Link Option Management ServiceThe link option management service provides the SLS user with the ability to alter signalling link options. The service primitives that implement the link option management services are described in detail in Link Option Management Service Primitives.
A successful invocation of the link options management service is illustrated in Figure 33. Figure 33. Message Flow: Successful Link Options Management Service
3.2.7 Event Notification ServiceThe event notification service provides the SLS user with the ability to register with the SLS provider to receive provider-specific event notifications. Event notifications normally correspond to management indications on the SS7 signalling link. The service primitives that implement the event notification services are described in detail in Event Notification Service Primitives.
A successful invocation of the event notification service is illustrated in Figure 34. Figure 34. Message Flow: Successful Event Notification Service
4 SLI Primitives4.1 Local Management Service PrimitivesThese service primitives implement the local management services (see Local Management Services). 4.1.1 Acknowledgement Service PrimitivesThese service primitives implement the acknowledgement service (see Acknowledgement Service). 4.1.1.1 LMI_OK_ACKDescriptionThis primitive is used to acknowledge receipt and successful service completion for primitives requiring acknowledgement that have no confirmation primitive. Format
This primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_long lmi_correct_primitive; lmi_ulong lmi_state; } lmi_ok_ack_t; ParametersThe service primitive contains the following parameters:
StateThis primitive is issued by the LMS provider in the New StateThe new state is 4.1.1.2 LMI_ERROR_ACKDescriptionThe error acknowledgement primitive is used to acknowledge receipt and unsuccessful service completion for primitives requiring acknowledgement. Format
The error acknowledgement primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_errno; lmi_ulong lmi_reason; lmi_long lmi_error_primitive; lmi_ulong lmi_state; } lmi_error_ack_t; ParametersThe error acknowledgement primitive contains the following parameters:
StateThis primitive can be issued in any state for which a local acknowledgement is not pending. The LMS provider state at the time that the primitive was issued is indicated in the primitive. New StateThe new state remains unchanged. 4.1.2 Information Reporting Service PrimitivesThese service primitives implement the information reporting service (see Information Reporting Service). 4.1.2.1 LMI_INFO_REQDescriptionThis LMS user originated primitive is issued by the LMS user to request that the LMS provider return information concerning the capabilities and state of the LMS provider. Format
The primitive consists of one typedef struct { lmi_ulong lmi_primitive; } lmi_info_req_t; ParametersThis primitive contains the following parameters:
StateThis primitive may be issued in any state but only when a local acknowledgement is not pending. New StateThe new state remains unchanged. ResponseThis primitive requires the LMS provider to acknowledge receipt of the primitive as follows:
Reasons for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.1.2.2 LMI_INFO_ACKDescriptionThis LMS provider originated primitive acknowledges receipt and successful processing of the
Format
This message is formatted a one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_version; lmi_ulong lmi_state; lmi_ulong lmi_max_sdu; lmi_ulong lmi_min_sdu; lmi_ulong lmi_header_len; lmi_ulong lmi_ppa_style; lmi_uchar lmi_ppa_addr[0]; } lmi_info_ack_t; ParametersThe information acknowledgement service primitive has the following parameters:
StateThis primitive can be issued in any state where a local acknowledgement is not pending. New StateThe new state remains unchanged. 4.1.3 Physical Point of Attachment Service PrimitivesThese service primitives implement the physical point of attachment service (see Physical Point of Attachment Service). 4.1.3.1 LMI_ATTACH_REQDescriptionThis LMS user originated primitive requests that the stream upon which the primitive is issued by
associated with the specified Physical Point of Attachment (PPA). This primitive is only applicable
to Style 2 LMS provider streams, that is, streams that return Format
This primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_uchar lmi_ppa[0]; } lmi_attach_req_t; ParametersThe attach request primitive contains the following parameters:
StateThis primitive is only valid in state New StateUpon success, the new state is ResponseThe attach request service primitive requires that the LMS provider respond as follows:
Reasons for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.1.3.2 LMI_DETACH_REQDescriptionThis LMS user originated primitive request that the stream upon which the primitive is issued be
disassociated from the Physical Point of Appearance (PPA) to which it is currently attached. This
primitive is only applicable to Style 2 LMS provider streams, that is, streams that return
Format
The detach request service primitive consists of one typedef struct { lmi_long lmi_primitive; } lmi_detach_req_t; ParametersThe detach request service primitive contains the following parameters:
StateThis primitive is valid in the New StateUpon success, the new state is ResponseThe detach request service primitive requires that the LMS provider respond as follows:
Reasons for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.1.4 Initialization Service PrimitivesInitialization service primitives allow the LMS user to enable or disable the protocol service interface. Enabling the protocol service interface may require that some action be taken to prepare the protocol service interface for use or to remove it from use. For example, where the PPA corresponds to a signalling data link identifier as defined in Q.704, it may be necessary to perform switching to connect or disconnect the circuit identification code associated with the signalling data link identifier. These service primitives implement the initialization service (see Initialization Service). 4.1.4.1 LMI_ENABLE_REQDescriptionThis LMS user originated primitive request that the LMS provider perform the actions necessary to enable the protocol service interface and confirm that it is enabled. This primitive is applicable to both styles of PPA. Format
The enable request service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_uchar lmi_rem[0]; } lmi_enable_req_t; ParametersThe enable request service primitive contains the following parameters:
StateThis primitive is valid in the New StateUpon success the new state is ResponseThe enable request service primitive requires that the LMS provider acknowledge receipt of the primitive as follows:
Reasons for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.1.4.2 LMI_ENABLE_CONDescriptionThis LMS provider originated primitive is issued by the LMS provider to confirm the successful completion of the enable service. Format
The enable confirmation service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_state; } lmi_enable_con_t; ParametersThe enable confirmation service primitive contains the following parameters:
StateThis primitive is issued by the LMS provider in the New StateThe new state is 4.1.4.3 LMI_DISABLE_REQDescriptionThis LMS user originated primitive requests that the LMS provider perform the actions necessary to disable the protocol service interface and confirm that it is disabled. The primitive is applicable to both styles of PPA. Format
The disable request service primitive consists of one typedef struct { lmi_long lmi_primitive; } lmi_disable_req_t; ParametersThe disable request service primitive contains the following parameters:
StateThe disable request service primitive is valid in the New StateUpon success, the new state is ResponseThe disable request service primitive requires the LMS provider to acknowledge receipt of the primitive as follows:
Reasons for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.1.4.4 LMI_DISABLE_CONDescriptionThis LMS provider originated primitive is issued by the LMS provider to confirm the successful completion of the disable service. Format
The disable confirmation service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_state; } lmi_disable_con_t; ParametersThe disable confirmation service primitive contains the following parameters:
StateThis primitive is issued by the LMS provider in the New StateThe new state is 4.1.5 Options Management Service PrimitivesThe options management service primitives allow the LMS user to negotiate options with the LMS provider, retrieve the current and default values of options, and check that values specified for options are correct. The options management service primitive implement the options management service (see Options Management Service). 4.1.5.1 LMI_OPTMGMT_REQDescriptionThis LMS user originated primitive requests that LMS provider options be managed. Format
The option management request service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_opt_length; lmi_ulong lmi_opt_offset; lmi_ulong lmi_mgmt_flags; } lmi_optmgmt_req_t; ParametersThe option management request service primitive contains the following parameters:
StateThis primitive is valid in any state where a local acknowledgement is not pending. New StateThe new state remains unchanged. ResponseThe option management request service primitive requires the LMS provider to acknowledge receipt of the primitive as follows:
Reasons for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.1.5.2 LMI_OPTMGMT_ACKDescriptionThis LMS provider originated primitive is issued by the LMS provider upon successful completion of
the options management service. It indicates the outcome of the options management operation
requested by the LMS user in a Format
The option management acknowledgement service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_opt_length; lmi_ulong lmi_opt_offset; lmi_ulong lmi_mgmt_flags; } lmi_optmgmt_ack_t; ParametersThe option management acknowledgement service primitive contains the following parameters:
StateThis primitive is issued by the LMS provider in direct response to an New StateThe new state remains unchanged. RulesThe LMS provider follows the following rules when processing option management service requests:
4.1.6 Event Reporting Service PrimitivesThe event reporting service primitives allow the LMS provider to indicate asynchronous errors, events and statistics collection to the LMS user. These service primitives implement the event reporting service (see Event Reporting Service). 4.1.6.1 LMI_ERROR_INDDescriptionThis LMS provider originated service primitive is issued by the LMS provider when it detects and asynchronous error event. The service primitive is applicable to all styles of PPA. Format
The error indication service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_errno; lmi_ulong lmi_reason; lmi_ulong lmi_state; } lmi_error_ind_t; ParametersThe error indication service primitive contains the following parameters:
StateThis primitive can be issued in any state for which a local acknowledgement is not pending. The LMS provider state at the time that the primitive was issued is indicated in the primitive. New StateThe new state remains unchanged. 4.1.6.2 LMI_STATS_INDDescriptionThis LMS provider originated primitive is issued by the LMS provider to indicate a periodic statistics collection event. The service primitive is applicable to all styles of PPA. Format
The statistics indication service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_interval; lmi_ulong lmi_timestamp; } lmi_stats_ind_t; Following this structure within the ParametersThe statistics indication service primitive contains the following parameters:
StateThis service primitive may be issued by the LMS provider in any state in which a local acknowledgement is not pending. New StateThe new state remains unchanged. 4.1.6.3 LMI_EVENT_INDDescriptionThis LMS provider originated primitive is issued by the LMS provider to indicate an asynchronous event. The service primitive is applicable to all styles of PPA. Format
The event indication service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_objectid; lmi_ulong lmi_timestamp; lmi_ulong lmi_severity; } lmi_event_ind_t; Following this structure within the ParametersTHe event indication service primitive contains the following parameters:
StateThis service primitive can be issued by the LMS provider in any state where a local
acknowledgement is not pending. Normally the LMS provider must be in the New StateThe new state remains unchanged. 4.2 Protocol Service PrimitivesProtocol service primitives implement the Signalling Link interface protocol. Protocol service primitives provide the SLS user with the ability to initialize the link, transfer data on the link, request and receive reports of receive and transmit congestion, restore failed signalling links, handle processor outage conditions, manage options and register for and receive event notifications. These service primitives implement the protocol services (see Protocol Services). 4.2.1 Link Initialization Service PrimitivesThe link initialization primitives permit the SLS user to power on the signalling data terminal, specify emergency or normal alignment, start the signalling link and bring it into service, and stop the signalling link or be informed of link failures. These service primitives implement the link initialization services (see Link Initialization Services). 4.2.1.1 SL_POWER_ON_REQDescriptionThe SLS user originated service primitive request that the SLS provider power on the signalling data terminal. Not all signalling data terminals can be powered on independent of the existence of the signalling link interface. Software signalling data terminals will mark idle on signalling links until they are powered on, after which they will idle FISUs. Format
The power on service primitive consists of one typedef struct { sl_long sl_primitive; } sl_power_on_req_t; ParametersThe power on service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe new link state is RulesResponseThe power on service primitive does not require receipt acknowledgement from the SLS provider.
Note that the SLS provider should ignore this primitive, and not generate a non-fatal error, when
the management interface is in the Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.1.2 SL_EMERGENCY_REQDescriptionThe emergency request service primitive provides the SLS user with the ability to specify that emergency alignment procedures should be used on the current or next alignment of the signalling link. Emergency alignment procedures a shorter in duration (shorter proving period) than normal alignment procedures. Format
The emergency request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_emergency_req_t; ParametersThe emergency request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe management and link state remains unchanged. ResponseThe emergency request service primitive does not require receipt acknowledgement.
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.1.3 SL_EMERGENCY_CEASES_REQDescriptionThe emergency ceases request service primitive provides the SLS user with the ability to specify that normal alignment procedures should be used on the current or next alignment of the signalling link. Normal alignment procedures are longer in duration (longer proving period) than emergency alignment procedures. Format
The emergency ceases request primitive consists of one typedef struct { sl_long sl_primitive; } sl_emergency_ceases_req_t; ParametersThe emergency ceases request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe management and link state remains unchanged. ResponseThe emergency ceases request service primitive does not require receipt acknowledgement.
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.1.4 SL_START_REQDescriptionThe start request service primitive allows the SLS user to request that a signalling link be aligned and brought into service by the SLS provider. Format
The start request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_start_req_t; ParametersThe start request service primitive contains the following parameters:
StateThis primitive is only valid in management state New StateThe new link state is ResponseThe start request service primitive requires a response from the SLS provider indicating the success or failure of the start request.
When the management state is Reason for FailureApplicable reasons for unsuccessful link start are as follows:
Applicable non-fatal errors are as follows:
4.2.1.5 SL_IN_SERVICE_INDDescriptionThe in-service indication service primitive is issued by the SLS provider to indicate to the SLS user that a previously invoked link start has successfully aligned and brought the signalling link into service. Format
The in-service indication service primitive consists of one typedef struct { sl_long sl_primitive; } sl_in_service_ind_t; ParametersThe in-service indication service primitive contains the following parameters:
StateThis primitive is only issued in the New StateThe new link state is RulesThe following rules are observed by the SLS provider when issuing the in-service indication primitive:
4.2.1.6 SL_OUT_OF_SERVICE_INDDescriptionThe out-of-service indication service primitive is issued by the SLS provider to indicate to the SLS user that a previously invoked link start has been unsuccessful, or that a previously in-service signalling link has failed. Format
The out-of-service indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; sl_ulong sl_reason; } sl_out_of_service_ind_t; ParametersThe out-of-service indication service primitive contains the following parameters:
StateThis primitive is only issued in the New StateThe new link state is RulesThe following rules are observed by the SLS provider when issuing the out-of-service indication primitive:
4.2.1.7 SL_STOP_REQDescriptionThe stop request primitive allows the SLS user to request that a signalling link be brought out of service by the SLS provider. Format
The stop request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_stop_req_t; ParametersThe stop request service primitive contains the following parameters:
StateThis primitive is only valid in management state New StateThe new link state is ResponseThe stop request service primitive does not require receipt acknowledgement from the SLS provider.
When the management state is Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.2 Data Transfer Service PrimitivesData transfer service primitives provider the SLS user with the ability to send and receive message signal units on an in-service signalling link. These service primitives implement the data transfer service (see Data Transfer Service). 4.2.2.1 SL_PDU_REQDescriptionThe PDU request service primitive provides the SLS user with the ability to request that a message signal unit be transmitted on an in-service signalling link. Format
The PDU request service primitive consists of zero or one typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_pdu_req_t; ParametersThe PDU request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe management and link state remains unchanged. RulesThe following rules are observed when issuing the PDU request service primitive:
ResponseThe PDU request service primitive is not acknowledged. 4.2.2.2 SL_PDU_INDDescriptionThe PDU indication service primitive provides the SLS user with the ability to receive message signal units from a signalling link. Format
The PDU indication service primitive consists of zero or more typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_pdu_ind_t; ParametersThe PDU indication service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe management and link states remain unchanged. RulesThe following rules are observed when issuing the PDU indication service primitive:
4.2.3 Congestion Service PrimitivesThese service primitives implement the congestion services (see Congestion Services). 4.2.3.1 SL_LINK_CONGESTED_INDDescriptionThe link congested indication service primitive provides the SLS provider with the ability to inidicate link transmit congestion onset at a congestion level to the SLS user. Format
The link congested indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; sl_ulong sl_cong_status; /* congestion status */ sl_ulong sl_disc_status; /* discard status */ } sl_link_cong_ind_t; ParametersThe link congested indication service primitive contains the following parameters:
StateThis primitive is only issued in the New StateThe management and link state remain unchanged. RulesThe SLS provider observes the following rules when issuing the link congested indication service primitive:
ResponseThe SLS user upon receiving this primitive should avoid sending messages of message priority less than the transmit congestion status, and must not send messages of message priority less than the discard status. The SLS provider does not actually discard messages with message priority less than the discard status: it is the responsibility of the SLS user to discard lower priority messages. Typically the SLS user is the SS7 Message Transfer Part. The SS7 MTP issues congestion indications to local MTP-Users and issues transfer-controlled messages to sending signalling points when transmit congestion onset occurs. When transmit congestion discard occurs, the SS7 MTP continues to issue congestion indications to local MTP-User and transfer-controlled message to sending signalling points, but also discards messages with insufficient priority for the discard level. 4.2.3.2 SL_LINK_CONGESTION_CEASED_INDDescriptionThe link congestion ceased indication service primitive allows the SLS provider to indicate to the SLS user when transmit congestion abates. Format
The link congestion ceased service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; sl_ulong sl_cong_status; /* congestion status */ sl_ulong sl_disc_status; /* discard status */ } sl_link_cong_ceased_ind_t; ParametersThe link congestion ceased service primitive contains the following parameters:
StateThis primitive is only issued in the New StateThe management and link state remain unchanged. RulesThe SLS provider observes the following rules when issuing the link congestion ceased indication service primitive:
ResponseThe SLS user upon receiving this primitive should cease discarding or sending congestion indications or transfer-controlled messages for the congestion level which has abated. 4.2.3.3 SL_CONGESTION_DISCARD_REQDescriptionThe congestion discard request service primitive is used by the SLS user to specify receive congestion discard. Normally an SLS user will first signal receive congestion onset with the
Format
The congestion discard request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_cong_discard_req_t; ParametersThe congestion discard request service primitive contains the following parameters:
StateThis primitive is valid only in New StateThe link and management state remains the same. RulesThe SLS user should observe the following rules when issuing the congestion discard request service primitive:
ResponseThe congestion discard request service primitive does not require receipt acknowledgement.
Note that if the SLS provider is in the Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.3.4 SL_CONGESTION_ACCEPT_REQDescriptionThe congestion accept request service primitive is used by the SLS user to specify receive congestion onset. Format
The congestion accept request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_cong_accept_req_t; ParametersThe congestion accept request service primitive contains the following parameters:
StateThis primitive is valid only in New StateThe link and management state remains the same. ResponseThe congestion accept request service primitive does not require receipt acknowledgement.
Note that if the SLS provider is in the Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.3.5 SL_NO_CONGESTION_REQDescriptionThe no congestion request service primitive is used by the SLS user to specify receive congestion abatement. Format
The no congestion request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_no_cong_req_t; ParametersThe no congestion request service primitive contains the following parameters:
StateThis primitive is valid only in New StateThe link and management state remains the same. ResponseThe no congestion request service primitive does not require receipt acknowledgement.
Note that if the SLS provider is in the Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.4 Restoration Service PrimitivesThe restoration service primitives permit the SLS user to perform functions necessary for BSNT retrieval to initiate or respond to sequenced changeover, buffer updating to respond to sequenced or time-controlled changeover, and buffer clearing to respond to time-controlled changeover or processor outage related failures. These service primitives implement the restoration services (see Restoration Services). 4.2.4.1 SL_RETRIEVE_BSNT_REQDescriptionThe retrieve BSNT request service primitive allows the SLS user to request retrieval of the BSNT (backward sequence number transmitted) which indicates the sequence number of the remove message signal unit sent that was last acknowledged. This function is necessary to properly generate or respond to a sequenced changeover procedure by the SLS user. Format
The retrieve BSNT request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_retrieve_bsnt_req_t; ParametersThe retrieve BSNT request service primitive contains the following parameters:
StateThis primitive is valid only in the New StateThe new state is unchanged. RulesThe SLS user should observe the following rules when issuing the retrieve BSNT request service primitive:
ResponseThis service primitive requires the SLS provider to acknowledge success of failure of the retrieval operation.
When the management state is Reason for FailureMost SLS providers are always successful in retrieving the BSNT value. Applicable reasons for failing to retrieve the BSNT value are as follows:
Applicable non-fatal errors are as follows:
4.2.4.2 SL_BSNT_INDDescriptionThe BSNT indication service primitive is originated by the SLS provider to indicate the retrieved
BSNT value in response to a Format
The BSNT indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_bsnt; } sl_bsnt_ind_t; ParametersThe BSNT indication service primitive contains the following parameters:
StateThis primitive is valid in management state New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing a BSNT indication service primitive:
ResponseThe primitive does not require a response from the SLS user. 4.2.4.3 SL_BSNT_NOT_RETRIEVABLE_INDDescriptionThe BSNT not retrievable indication service primitive is originated by the SLS provider to indicate
that the BSNT value cannot be retrieved in response to a Format
The BSNT not retrievable indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_bsnt; } sl_bsnt_not_retr_ind_t; ParametersThe BSNT not retrievable indication service primitive contains the following parameters:
StateThis primitive is valid in management state New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing the BSNT not retrievable indication service primitive:
ResponseThe primitive does not require a response from the SLS user. 4.2.4.4 SL_RETRIEVAL_REQUEST_AND_FSNC_REQDescriptionThe retrieval request and FSNC request service primitive is originated by the SLS user when it wishes to update the retransmission buffer with the last known acknowledged message (FSNC). The last known acknowledged message is acquired by the SLS user with the sequence changeover procedure of the message transfer part. The primitive requests that the SLS provider update the retransmission buffer and then deliver the contents of the updated retransmission buffer and transmit buffers to the SLS user. Format
The retrieval request and FSNC request service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_fsnc; } sl_retrieval_req_and_fsnc_t; ParametersThe retrieval request and FSNC request service primitive contains the following parameters:
StateThis primitive is only valid in management state New StateThe new state remains unchanged. RulesResponseThe retrieval request and FSNC request service primitive request the SLS provider to acknowledge the result of the retrieval action as follows:
When the management stat is Reason for FailureMost SLS providers are always successful in retrieving the updated contents of the retransmission buffer and transmission buffer. Applicable reasons for failing to retrieve the updated buffer contents are as follows:
Non-Fatal Errors: applicable non-fatal errors are as follows:
4.2.4.5 SL_RETRIEVED_MESSAGE_INDDescriptionThe retrieved message indication service primitive is originated by the SLS provider to transfer the contents of the updated retransmission buffer and transmission buffer to the SLS user. One primitive is used for each message retrieved. The oldest message in the buffers is indicated first. Format
The retrieved message indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_retrieved_msg_ind_t; ParametersThe retrieve message indication service primitive contains the following parameters:
StateThis primitive is only issued in management state New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing a retrieved message indication service primitive:
ResponseThis primitive does not require response from the SLS user. 4.2.4.6 SL_RETRIEVAL_COMPLETE_INDDescriptionThe retrieval complete indication service primitive is originated by the SLS provider to indicate
the completion of transfer of the contents of the updated retransmission buffer and transmission
buffer to the SLS user. The primitive is issued in response to a
Format
The retrieval complete indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_retrieval_comp_ind_t; ParametersThe retrieval complete indication service primitive contains the following parameters:
StateThis primitive is only issued in management state New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing a retrieval complete indication service primitive:
ResponseThis primitive does not require a response from the SLS user. Reason for Failure4.2.4.7 SL_RETRIEVAL_NOT_POSSIBLE_INDDescriptionThe retrieval not possible indication service primitive is originated by the SLS provider to
indicate that the updated contents of the retransmission and transmission buffers is not possible.
The primitive is issued in response to a Format
The retrieval not possible indication service primitive consists of one typedef struct { sl_long sl_primitive; } sl_retrieval_not_poss_ind_t; ParametersThe retrieval not possible indication service primitive contains the following parameters:
StateThis primitive is only issued from the New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing the retrieval not possible indication service primitive:
ResponseThe primitive does not require a response from the SLS user. 4.2.4.8 SL_CLEAR_BUFFERS_REQDescriptionThe clear buffers request service primitive is originated by the SLS user to request that all message buffers be cleared by the SLS provider. This includes receive buffer, retransmission buffer and transmission buffers. Format
The clear buffers request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_clear_buffers_req_t; ParametersThe clear buffers request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe new state remains unchanged. ResponseThe clear buffers request service primitive requires the SLS provider to indicate when the receive buffer and retransmission buffers are cleared, as follows:
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.4.9 SL_CLEAR_RTB_REQDescriptionThe clear RTB request service primitive is originated by the SLS user to request that only the retransmission buffer be cleared by the SLS provider. This primitive is used in conjunction with the time-controlled changeover procedure of the message transfer part. Format
The clear RTB request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_clear_rtb_req_t; ParametersThe clear RTB request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe new state remains unchanged. ResponseThe clear RTB request service primitive requires the SLS provider to indicate when the retransmission buffer has been cleared, as follows:
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.4.10 SL_RB_CLEARED_INDDescriptionThe RB cleared indication service primitive is originated by the SLS provider whenever the receive
buffer has been cleared; either in response to a Format
The RB cleared indication service primitive consists of one typedef struct { sl_long sl_primitive; } sl_rb_cleared_ind_t; ParametersThe RB cleared indication service primitive contains the following parameters:
StateThis primitive is only issued by the SLS provider in the New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing the RB cleared indication service primitive:
ResponseThis primitive does not require a response from the SLS user. 4.2.4.11 SL_RTB_CLEARED_INDDescriptionThe RTB cleared indication service primitive is originated by the SLS provider whenever the
retransmission buffer has been cleared; either in response to a Format
The RTB cleared indication service primitive consists of one typedef struct { sl_long sl_primitive; } sl_rtb_cleared_ind_t; ParametersThe RTB cleared indication service primitive contains the following parameters:
StateThe primitive is only issued by the SLS provider from the New StateThe new state remains unchanged. RulesThe SLS provider observes the following rules when issuing the RTB cleared indication service primitive:
ResponseThis primitive does not require a response from the SLS user. 4.2.5 Processor Outage Service PrimitivesThe processor outage service primitive permit the SLS user the ability to assert and resume from a local processor outage condition as well as being informed by the SLS provider when a local or remote processor outage condition is in effect or has cleared. The SLS user is also able, using these and other primitives, to recover from a local or remote processor outage condition. These service primitives implement the processor outage services (see Processor Outage Services). 4.2.5.1 SL_LOCAL_PROCESSOR_OUTAGE_REQDescriptionThe local processor outage request service primitive allows the SLS user to specify that a local processor outage condition exists. Format
The local processor outage request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_local_proc_outage_req_t; ParametersThe local processor outage request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe new state is ResponseThis primitive does not request a response from the SLS provider.
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.5.2 SL_LOCAL_PROCESSOR_OUTAGE_INDDescriptionThe local processor outage indication service primitive is originated by the SLS provider when it detects a local processor outage condition internal to the SLS provider. Format
The local processor outage indication service primitive consists of on typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_loc_proc_out_ind_t; ParametersThe local processor outage indication service primitive contains the following parameters:
StateThis primitive is only issued by the SLS provider in the New StateThe new state is RulesThe SLS provider observes the following rules when issuing the local processor outage indication service primitive:
ResponseThis primitive does not require a response from the SLS user. 4.2.5.3 SL_RESUME_REQDescriptionThe resume request service primitive allows the SLS user to specify that a local processor outage condition is no longer in effect. That is, that the local processor has recovered. Format
The resume request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_resume_req_t; ParametersThe resume request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe new state is ResponseThis primitive does not request a response from the SLS provider.
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.5.4 SL_LOCAL_PROCESSOR_RECOVERED_INDDescriptionThe local processor recovered indication service primitive is originated by the SLS provider when it detects a remote processor recovery condition. Format
The local processor recovered indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_loc_proc_recovered_ind_t; ParametersThe local processor recovered indication service primitive contains the following parameters:
StateThis primitive is only issued by the SLS provider in the New StateThe new state is RulesThe SLS provider observes the following rules when issuing a local processor recovered indication service primitive:
ResponseThis primitive does not require a respnose from the SLS user, nevertheless, the SLS user will typically attempt to continue on the link or restore it using restoration service primitives. 4.2.5.5 SL_REMOTE_PROCESSOR_OUTAGE_INDDescriptionThe remote processour outage indication service primitive is originated by the SLS provider when it detects a remote processor outage condition. Format
The remove processor outage indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_rem_proc_out_ind_t; ParametersThe remove processor outage indication service primitive contains the following parameters:
StateThis primitive is only issued by the SLS provider in the New StateThe new state is RulesThe SLS provider observes the following rules when issuing the remote processor outage indication service primitive:
ResponseThis primitive does not require a response from the SLS user. 4.2.5.6 SL_REMOTE_PROCESSOR_RECOVERED_INDDescriptionThe remote processor recovered indication service primitive is originated by the SLS provider when it detects a remote processor recovery condition. Format
The remote processor recovered indication service primitive consists of one typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_rem_proc_recovered_ind_t; ParametersThe remote processor recovered indication service primitive contains the following parameters:
StateThis primitive is only issued by the SLS provider in the New StateThe new state is unchanged. RulesThe SLS provider observes the following rules when issuing a remote processor recovered indication service primitive:
ResponseThis primitive does not require a response from the SLS user, nevertheless, the SLS user will typically attempt to continue on the link or restore it using restoration service primitives. 4.2.5.7 SL_CONTINUE_REQDescriptionThe continue request service primitive is originated by the SLS user to request that a link previously in a remote processor outage condition, or a SLS provider detected local process outage condition, be continued. This action is normally performed where processor outage has not been of a long duration and it is not necessary to fail or otherwise restore the signalling link. Format
The continue request service primitive consists of one typedef struct { sl_long sl_primitive; } sl_continue_req_t; ParametersThe continue request service primitive contains the following parameters:
StateThis primitive is only valid in the New StateThe new state is ResponseThis primitive does not require receipt acknowledgement by the SLS provider.
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.6 Link Option Management Service PrimitivesThe link option management service primitives provide another mechanism for options management
separate from the local management interface (i.e. the These service primitives implement the link option management service (see Link Option Management Service). 4.2.6.1 SL_OPTMGMT_REQDescriptionThis SLS user originated primitive requests that the SLS provider options be managed. Format
The link option management request service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_opt_length; lmi_ulong lmi_opt_offset; lmi_ulong lmi_mgmt_flags; } lmi_optmgmt_req_t; ParametersThe link option management request service primitive contains the following parameters:
StateThis primitive is valid in any state where a local acknowledgement is not pending. New StateThe new state remains unchanged. RulesResponseThe link option management request service primitive requires the LMS provider to acknowledge receipt of the primitive as follows:
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
4.2.6.2 SL_OPTMGMT_ACKDescriptionThis LMS provider originated primitive is issued by the LMS provider upon successful completion of
the link options management service. It indicates the outcome of the link options management operation
requested by the LMS user in a Format
The link option management acknowledgement service primitive consists of one typedef struct { lmi_long lmi_primitive; lmi_ulong lmi_opt_length; lmi_ulong lmi_opt_offset; lmi_ulong lmi_mgmt_flags; } lmi_optmgmt_ack_t; ParametersThe link option management acknowledgement service primitive contains the following parameters:
StateThis primitive is issued by the LMS provider in direct response to an New StateThe new state remains unchanged. RulesThe LMS provider follows the following rules when processing link option management service requests:
4.2.7 Event Notification Service PrimitivesThe event notification service primitives provide another mechanism for event notification separate
from the local management interface (i.e. the These service primitives implement the event notification service (see Event Notification Service). 4.2.7.1 SL_NOTIFY_REQDescriptionThis SLS user originated primitives requests that the SLS provider register the SLS user for various events. FormatNot documented. Parameters
StateAny state. New StateUnchanged. ResponseThis primitive does not require receipt acknolwedgement from the SLS provider.
Reason for FailureNon-Fatal Errors: applicable non-fatal errors are as follows:
NotesThis primitive is deprecated and has been replaced by the local management inteface event reporting service discussed in Event Reporting Service. 4.2.7.2 SL_NOTIFY_INDDescriptionThis SLS provider originated primitive indicates that an event for which the SLS provider has registered has occurred. FormatNot documented. Parameters
StateAny state. New StateUnchanged. RulesThe SLS provider observes the following rules when issuing the event notification indication service primtiive:
NotesThis primitive is deprecated and has been replaced by the local management inteface event reporting service discussed in Event Reporting Service. 5 Diagnostics RequirementsTwo error handling facilities should be provided to the SLS user: one to handle non-fatal errors, and the other to handle fatal errors. 5.1 Non-Fatal Error Handling FacilityThese are errors that do not change the state of the SLS interface as seen by the SLS user and
provide the user with the option of reissuing the SL primitive with the corrected options
specification. The non-fatal error handling is provided only to those primitives that require
acknowledgements, and uses the 5.2 Fatal Error Handling FacilityThese errors are issued by the SL provider when it detects errors that are not correctable by the
SL user, or if it is unable to report a correctible error to the SLS user. Fatal errors are
indicated via the STREAMS message type Appendix A LMI Header File Listing
#define LMI_PROTO_BASE 16L #define LMI_DSTR_FIRST ( 1L + LMI_PROTO_BASE ) #define LMI_INFO_REQ ( 1L + LMI_PROTO_BASE ) #define LMI_ATTACH_REQ ( 2L + LMI_PROTO_BASE ) #define LMI_DETACH_REQ ( 3L + LMI_PROTO_BASE ) #define LMI_ENABLE_REQ ( 4L + LMI_PROTO_BASE ) #define LMI_DISABLE_REQ ( 5L + LMI_PROTO_BASE ) #define LMI_OPTMGMT_REQ ( 6L + LMI_PROTO_BASE ) #define LMI_DSTR_LAST ( 6L + LMI_PROTO_BASE ) #define LMI_USTR_LAST (-1L - LMI_PROTO_BASE ) #define LMI_INFO_ACK (-1L - LMI_PROTO_BASE ) #define LMI_OK_ACK (-2L - LMI_PROTO_BASE ) #define LMI_ERROR_ACK (-3L - LMI_PROTO_BASE ) #define LMI_ENABLE_CON (-4L - LMI_PROTO_BASE ) #define LMI_DISABLE_CON (-5L - LMI_PROTO_BASE ) #define LMI_OPTMGMT_ACK (-6L - LMI_PROTO_BASE ) #define LMI_ERROR_IND (-7L - LMI_PROTO_BASE ) #define LMI_STATS_IND (-8L - LMI_PROTO_BASE ) #define LMI_EVENT_IND (-9L - LMI_PROTO_BASE ) #define LMI_USTR_FIRST (-9L - LMI_PROTO_BASE ) #define LMI_UNATTACHED 1L /* No PPA attached, awating LMI_ATTACH_REQ */ #define LMI_ATTACH_PENDING 2L /* Waiting for attach */ #define LMI_UNUSABLE 3L /* Device cannot be used, STREAM in hung state */ #define LMI_DISABLED 4L /* PPA attached, awaiting LMI_ENABLE_REQ */ #define LMI_ENABLE_PENDING 5L /* Waiting to send LMI_ENABLE_CON */ #define LMI_ENABLED 6L /* Ready for use, awaiting primtiive exchange */ #define LMI_DISABLE_PENDING 7L /* Waiting to send LMI_DISABLE_CON */ #define LMI_DETACH_PENDING 8L /* Waiting for detach */ /* * LMI_ERROR_ACK and LMI_ERROR_IND reason codes */ #define LMI_UNSPEC 0x00000000 /* Unknown or unspecified */ #define LMI_BADADDRESS 0x00010000 /* Address was invalid */ #define LMI_BADADDRTYPE 0x00020000 /* Invalid address type */ #define LMI_BADDIAL 0x00030000 /* (not used) */ #define LMI_BADDIALTYPE 0x00040000 /* (not used) */ #define LMI_BADDISPOSAL 0x00050000 /* Invalid disposal parameter */ #define LMI_BADFRAME 0x00060000 /* Defective SDU received */ #define LMI_BADPPA 0x00070000 /* Invalid PPA identifier */ #define LMI_BADPRIM 0x00080000 /* Unregognized primitive */ #define LMI_DISC 0x00090000 /* Disconnected */ #define LMI_EVENT 0x000a0000 /* Protocol-specific event ocurred */ #define LMI_FATALERR 0x000b0000 /* Device has become unusable */ #define LMI_INITFAILED 0x000c0000 /* Link initialization failed */ #define LMI_NOTSUPP 0x000d0000 /* Primitive not supported by this device */ #define LMI_OUTSTATE 0x000e0000 /* Primitive was issued from invalid state */ #define LMI_PROTOSHORT 0x000f0000 /* M_PROTO block too short */ #define LMI_SYSERR 0x00100000 /* UNIX system error */ #define LMI_WRITEFAIL 0x00110000 /* Unitdata request failed */ #define LMI_CRCERR 0x00120000 /* CRC or FCS error */ #define LMI_DLE_EOT 0x00130000 /* DLE EOT detected */ #define LMI_FORMAT 0x00140000 /* Format error detected */ #define LMI_HDLC_ABORT 0x00150000 /* Aborted frame detected */ #define LMI_OVERRUN 0x00160000 /* Input overrun */ #define LMI_TOOSHORT 0x00170000 /* Frame too short */ #define LMI_INCOMPLETE 0x00180000 /* Partial frame received */ #define LMI_BUSY 0x00190000 /* Telephone was busy */ #define LMI_NOANSWER 0x001a0000 /* Connection went unanswered */ #define LMI_CALLREJECT 0x001b0000 /* Connection rejected */ #define LMI_HDLC_IDLE 0x001c0000 /* HDLC line went idle */ #define LMI_HDLC_NOTIDLE 0x001d0000 /* HDLC link no longer idle */ #define LMI_QUIESCENT 0x001e0000 /* Line being reassigned */ #define LMI_RESUMED 0x001f0000 /* Line has been reassigned */ #define LMI_DSRTIMEOUT 0x00200000 /* Did not see DSR in time */ #define LMI_LAN_COLLISIONS 0x00210000 /* LAN excessive collisions */ #define LMI_LAN_REFUSED 0x00220000 /* LAN message refused */ #define LMI_LAN_NOSTATION 0x00230000 /* LAN no such station */ #define LMI_LOSTCTS 0x00240000 /* Lost Clear to Send signal */ #define LMI_DEVERR 0x00250000 /* Start of device-specific error codes */ typedef signed int lmi_long; typedef unsigned int lmi_ulong; typedef unsigned short lmi_ushort; typedef unsigned char lmi_uchar; /* * LOCAL MANAGEMENT PRIMITIVES */ /* LMI_INFO_REQ, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_INFO_REQ */ } lmi_info_req_t; /* LMI_INFO_ACK, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_INFO_ACK */ lmi_ulong lmi_version; lmi_ulong lmi_state; lmi_ulong lmi_max_sdu; lmi_ulong lmi_min_sdu; lmi_ulong lmi_header_len; lmi_ulong lmi_ppa_style; lmi_ulong lmi_ppa_length; lmi_ulong lmi_ppa_offset; lmi_ulong lmi_prov_flags; /* provider specific flags */ lmi_ulong lmi_prov_state; /* provider specific state */ lmi_uchar lmi_ppa_addr[0]; } lmi_info_ack_t; #define LMI_VERSION_1 1 #define LMI_VERSION_2 2 #define LMI_CURRENT_VERSION LMI_VERSION_2 /* * LMI provider style. * * The LMI provider style which determines whether a provider requires an * LMI_ATTACH_REQ to inform the provider which PPA user messages should be * sent/received on. */ #define LMI_STYLE1 0x00 /* PPA is implicitly bound by open(2) */ #define LMI_STYLE2 0x01 /* PPA must be explicitly bound via STD_ATTACH_REQ */ /* LMI_ATTACH_REQ, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_ATTACH_REQ */ lmi_ulong lmi_ppa_length; lmi_ulong lmi_ppa_offset; lmi_uchar lmi_ppa[0]; } lmi_attach_req_t; /* LMI_DETACH_REQ, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_DETACH_REQ */ } lmi_detach_req_t; /* LMI_ENABLE_REQ, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_ENABLE_REQ */ lmi_ulong lmi_rem_length; lmi_ulong lmi_rem_offset; lmi_uchar lmi_rem[0]; } lmi_enable_req_t; /* LMI_DISABLE_REQ, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_DISABLE_REQ */ } lmi_disable_req_t; /* LMI_OK_ACK, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_OK_ACK */ lmi_long lmi_correct_primitive; lmi_ulong lmi_state; } lmi_ok_ack_t; /* LMI_ERROR_ACK, M_CTL */ typedef struct { lmi_long lmi_primitive; /* LMI_ERROR_ACK */ lmi_ulong lmi_errno; lmi_ulong lmi_reason; lmi_long lmi_error_primitive; lmi_ulong lmi_state; } lmi_error_ack_t; /* LMI_ENABLE_CON, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_ENABLE_CON */ lmi_ulong lmi_state; } lmi_enable_con_t; /* LMI_DISABLE_CON, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_DISABLE_CON */ lmi_ulong lmi_state; } lmi_disable_con_t; /* LMI_OPTMGMT_REQ, M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_OPTMGMT_REQ */ lmi_ulong lmi_opt_length; lmi_ulong lmi_opt_offset; lmi_ulong lmi_mgmt_flags; } lmi_optmgmt_req_t; /* LMI_OPTMGMT_ACK, M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_OPMGMT_ACK */ lmi_ulong lmi_opt_length; lmi_ulong lmi_opt_offset; lmi_ulong lmi_mgmt_flags; } lmi_optmgmt_ack_t; #undef LMI_DEFAULT #define LMI_NEGOTIATE 0x0004 #define LMI_CHECK 0x0008 #define LMI_DEFAULT 0x0010 #define LMI_SUCCESS 0x0020 #define LMI_FAILURE 0x0040 #define LMI_CURRENT 0x0080 #define LMI_PARTSUCCESS 0x0100 #define LMI_READONLY 0x0200 #define LMI_NOTSUPPORT 0x0400 /* LMI_ERROR_IND, M_PROTO or M_PCPROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_ERROR_IND */ lmi_ulong lmi_errno; lmi_ulong lmi_reason; lmi_ulong lmi_state; } lmi_error_ind_t; /* LMI_STATS_IND, M_PROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_STATS_IND */ lmi_ulong lmi_interval; lmi_ulong lmi_timestamp; } lmi_stats_ind_t; /* LMI_EVENT_IND, M_PROTO */ typedef struct { lmi_long lmi_primitive; /* LMI_EVENT_IND */ lmi_ulong lmi_objectid; lmi_ulong lmi_timestamp; lmi_ulong lmi_severity; } lmi_event_ind_t; union LMI_primitive { lmi_long lmi_primitive; lmi_ok_ack_t ok_ack; lmi_error_ack_t error_ack; lmi_error_ind_t error_ind; lmi_stats_ind_t stats_ind; lmi_event_ind_t event_ind; }; union LMI_primitives { lmi_long lmi_primitive; lmi_info_req_t info_req; lmi_info_ack_t info_ack; lmi_attach_req_t attach_req; lmi_detach_req_t detach_req; lmi_enable_req_t enable_req; lmi_disable_req_t disable_req; lmi_ok_ack_t ok_ack; lmi_error_ack_t error_ack; lmi_enable_con_t enable_con; lmi_disable_con_t disable_con; lmi_error_ind_t error_ind; lmi_stats_ind_t stats_ind; lmi_event_ind_t event_ind; }; #define LMI_INFO_REQ_SIZE sizeof(lmi_info_req_t) #define LMI_INFO_ACK_SIZE sizeof(lmi_info_ack_t) #define LMI_ATTACH_REQ_SIZE sizeof(lmi_attach_req_t) #define LMI_DETACH_REQ_SIZE sizeof(lmi_detach_req_t) #define LMI_ENABLE_REQ_SIZE sizeof(lmi_enable_req_t) #define LMI_DISABLE_REQ_SIZE sizeof(lmi_disable_req_t) #define LMI_OK_ACK_SIZE sizeof(lmi_ok_ack_t) #define LMI_ERROR_ACK_SIZE sizeof(lmi_error_ack_t) #define LMI_ENABLE_CON_SIZE sizeof(lmi_enable_con_t) #define LMI_DISABLE_CON_SIZE sizeof(lmi_disable_con_t) #define LMI_ERROR_IND_SIZE sizeof(lmi_error_ind_t) #define LMI_STATS_IND_SIZE sizeof(lmi_stats_ind_t) #define LMI_EVENT_IND_SIZE sizeof(lmi_event_ind_t) typedef struct lmi_opthdr { lmi_ulong level; lmi_ulong name; lmi_ulong length; lmi_ulong status; lmi_uchar value[0]; /* followed by option value */ } lmi_opthdr_t; #define LMI_LEVEL_COMMON '\0' #define LMI_LEVEL_SDL 'd' #define LMI_LEVEL_SDT 't' #define LMI_LEVEL_SL 'l' #define LMI_LEVEL_SLS 's' #define LMI_LEVEL_MTP 'M' #define LMI_LEVEL_SCCP 'S' #define LMI_LEVEL_ISUP 'I' #define LMI_LEVEL_TCAP 'T' #define LMI_OPT_PROTOCOL 1 /* use struct lmi_option */ #define LMI_OPT_STATISTICS 2 /* use struct lmi_sta */ Appendix B SLI Header File Listing
typedef lmi_long sl_long; typedef lmi_ulong sl_ulong; typedef lmi_ushort sl_ushort; typedef lmi_uchar sl_uchar; #define SL_PROTO_BASE 64 #define SL_DSTR_FIRST ( 1 + SL_PROTO_BASE) #define SL_PDU_REQ ( 1 + SL_PROTO_BASE) #define SL_EMERGENCY_REQ ( 2 + SL_PROTO_BASE) #define SL_EMERGENCY_CEASES_REQ ( 3 + SL_PROTO_BASE) #define SL_START_REQ ( 4 + SL_PROTO_BASE) #define SL_STOP_REQ ( 5 + SL_PROTO_BASE) #define SL_RETRIEVE_BSNT_REQ ( 6 + SL_PROTO_BASE) #define SL_RETRIEVAL_REQUEST_AND_FSNC_REQ ( 7 + SL_PROTO_BASE) #define SL_CLEAR_BUFFERS_REQ ( 8 + SL_PROTO_BASE) #define SL_CLEAR_RTB_REQ ( 9 + SL_PROTO_BASE) #define SL_CONTINUE_REQ ( 10 + SL_PROTO_BASE) #define SL_LOCAL_PROCESSOR_OUTAGE_REQ ( 11 + SL_PROTO_BASE) #define SL_RESUME_REQ ( 12 + SL_PROTO_BASE) #define SL_CONGESTION_DISCARD_REQ ( 13 + SL_PROTO_BASE) #define SL_CONGESTION_ACCEPT_REQ ( 14 + SL_PROTO_BASE) #define SL_NO_CONGESTION_REQ ( 15 + SL_PROTO_BASE) #define SL_POWER_ON_REQ ( 16 + SL_PROTO_BASE) #define SL_OPTMGMT_REQ ( 17 + SL_PROTO_BASE) #define SL_NOTIFY_REQ ( 18 + SL_PROTO_BASE) #define SL_DSTR_LAST ( 18 + SL_PROTO_BASE) #define SL_USTR_LAST ( -1 - SL_PROTO_BASE) #define SL_PDU_IND ( -1 - SL_PROTO_BASE) #define SL_LINK_CONGESTED_IND ( -2 - SL_PROTO_BASE) #define SL_LINK_CONGESTION_CEASED_IND ( -3 - SL_PROTO_BASE) #define SL_RETRIEVED_MESSAGE_IND ( -4 - SL_PROTO_BASE) #define SL_RETRIEVAL_COMPLETE_IND ( -5 - SL_PROTO_BASE) #define SL_RB_CLEARED_IND ( -6 - SL_PROTO_BASE) #define SL_BSNT_IND ( -7 - SL_PROTO_BASE) #define SL_IN_SERVICE_IND ( -8 - SL_PROTO_BASE) #define SL_OUT_OF_SERVICE_IND ( -9 - SL_PROTO_BASE) #define SL_REMOTE_PROCESSOR_OUTAGE_IND (-10 - SL_PROTO_BASE) #define SL_REMOTE_PROCESSOR_RECOVERED_IND (-11 - SL_PROTO_BASE) #define SL_RTB_CLEARED_IND (-12 - SL_PROTO_BASE) #define SL_RETRIEVAL_NOT_POSSIBLE_IND (-13 - SL_PROTO_BASE) #define SL_BSNT_NOT_RETRIEVABLE_IND (-14 - SL_PROTO_BASE) #define SL_OPTMGMT_ACK (-15 - SL_PROTO_BASE) #define SL_NOTIFY_IND (-16 - SL_PROTO_BASE) #define SL_LOCAL_PROCESSOR_OUTAGE_IND (-17 - SL_PROTO_BASE) #define SL_LOCAL_PROCESSOR_RECOVERED_IND (-18 - SL_PROTO_BASE) #define SL_USTR_FIRST (-18 - SL_PROTO_BASE) /* * SLI PROVIDER STATE */ #define SLS_POWER_OFF 0 #define SLS_OUT_OF_SERVICE 1 #define SLS_NOT_ALIGNED 2 #define SLS_INITIAL_ALIGNMENT 3 #define SLS_PROVING 4 #define SLS_ALIGNED_READY 5 #define SLS_ALIGNED_NOT_READY 6 #define SLS_IN_SERVICE 7 #define SLS_PROCESSOR_OUTAGE 8 /* * SLI PROVIDER FLAGS */ #define SLF_LOC_PROC_OUT (1<< 0) #define SLF_REM_PROC_OUT (1<< 1) #define SLF_LOC_IN_SERV (1<< 2) #define SLF_REM_IN_SERV (1<< 3) #define SLF_LOC_BUSY (1<< 4) #define SLF_REM_BUSY (1<< 5) #define SLF_LOC_EMERG (1<< 6) #define SLF_EMERGENCY SLF_LOC_EMERG #define SLF_REM_EMERG (1<< 7) #define SLF_RECV_MSU (1<< 8) #define SLF_SEND_MSU (1<< 9) #define SLF_CONG_ACCEPT (1<<10) #define SLF_CONG_DISCARD (1<<11) #define SLF_RTB_FULL (1<<12) #define SLF_L3_CONG_DETECT (1<<13) #define SLF_L2_CONG_DETECT (1<<14) #define SLF_LINK_CONGESTED SLF_L2_CONG_DETECT #define SLF_CONTINUE (1<<15) #define SLF_LEVEL_3_IND SLF_CONTINUE #define SLF_CLEAR_RTB (1<<16) #define SLF_NEED_FLUSH (1<<17) #define SLF_WAIT_SYNC (1<<18) #define SLF_REM_ALIGN (1<<19) /* * SLI PROTOCOL PRIMITIVES */ /* * SL_PDU_REQ, optional M_PROTO type, with M_DATA block(s) */ typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_pdu_req_t; /* * SL_PDU_IND, optional M_PROTO type, with M_DATA block(s) */ typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_pdu_ind_t; /* * PROTOCOL CONTROL PRIMITIVES */ /* * SL_EMERGENCY_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_emergency_req_t; /* * SL_EMERGENCY_CEASES_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_emergency_ceases_req_t; /* * SL_START_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_start_req_t; /* * SL_STOP_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_stop_req_t; /* * SL_RETRIEVE_BSNT_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_retrieve_bsnt_req_t; /* * SL_RETRIEVAL_REQUEST_AND_FSNC_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_fsnc; } sl_retrieval_req_and_fsnc_t; /* * SL_CLEAR_BUFFERS_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_clear_buffers_req_t; /* * SL_CLEAR_RTB_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_clear_rtb_req_t; /* * SL_CONTINUE_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_continue_req_t; /* * SL_LOCAL_PROCESSOR_OUTAGE_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_local_proc_outage_req_t; /* * SL_RESUME_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_resume_req_t; /* * SL_CONGESTION_DISCARD_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_cong_discard_req_t; /* * SL_CONGESTION_ACCEPT_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_cong_accept_req_t; /* * SL_NO_CONGESTION_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_no_cong_req_t; /* * SL_POWER_ON_REQ, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_power_on_req_t; /* * SL_LINK_CONGESTED_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; sl_ulong sl_cong_status; /* congestion status */ sl_ulong sl_disc_status; /* discard status */ } sl_link_cong_ind_t; /* * SL_LINK_CONGESTION_CEASED_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; sl_ulong sl_cong_status; /* congestion status */ sl_ulong sl_disc_status; /* discard status */ } sl_link_cong_ceased_ind_t; /* * SL_RETRIEVED_MESSAGE_IND, M_PROTO or M_PCPROTO type with M_DATA block(s) */ typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_retrieved_msg_ind_t; /* * SL_RETRIEVAL_COMPLETE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_mp; } sl_retrieval_comp_ind_t; /* * SL_RETRIEVAL_NOT_POSSIBLE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_retrieval_not_poss_ind_t; /* * SL_RB_CLEARED_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_rb_cleared_ind_t; /* * SL_BSNT_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_bsnt; } sl_bsnt_ind_t; /* * SL_BSNT_NOT_RETRIEVABLE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_bsnt; } sl_bsnt_not_retr_ind_t; /* * SL_IN_SERVICE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_in_service_ind_t; /* * SL_OUT_OF_SERVICE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; sl_ulong sl_reason; } sl_out_of_service_ind_t; /* * These reasons for failure as so that upstream module can * collect statistics per link per ITU-T Q.752 Table 1 * requirements. */ #define SL_FAIL_UNSPECIFIED 0x0001 #define SL_FAIL_CONG_TIMEOUT 0x0002 #define SL_FAIL_ACK_TIMEOUT 0x0004 #define SL_FAIL_ABNORMAL_BSNR 0x0008 #define SL_FAIL_ABNORMAL_FIBR 0x0010 #define SL_FAIL_SUERM_EIM 0x0020 #define SL_FAIL_ALIGNMENT_NOT_POSSIBLE 0x0040 #define SL_FAIL_RECEIVED_SIO 0x0080 #define SL_FAIL_RECEIVED_SIN 0x0100 #define SL_FAIL_RECEIVED_SIE 0x0200 #define SL_FAIL_RECEIVED_SIOS 0x0400 #define SL_FAIL_T1_TIMEOUT 0x0800 /* * SL_REMOTE_PROCESSOR_OUTAGE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_rem_proc_out_ind_t; /* * SL_REMOTE_PROCESSOR_RECOVERED_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_rem_proc_recovered_ind_t; /* * SL_RTB_CLEARED_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; } sl_rtb_cleared_ind_t; /* * SL_LOCAL_PROCESSOR_OUTAGE_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_loc_proc_out_ind_t; /* * SL_LOCAL_PROCESSOR_RECOVERED_IND, M_PROTO or M_PCPROTO type */ typedef struct { sl_long sl_primitive; sl_ulong sl_timestamp; } sl_loc_proc_recovered_ind_t; /* * Generic single argument type */ typedef struct { sl_ulong sl_cmd; sl_ulong sl_arg; } sl_cmd_arg_t; /* * Generic double argument type */ typedef struct { sl_ulong sl_cmd; sl_ulong sl_arg1; sl_ulong sl_arg2; } sl_cmd_2arg_t; /* * Generic triple argument type */ typedef struct { sl_ulong sl_cmd; sl_ulong sl_arg1; sl_ulong sl_arg2; sl_ulong sl_arg3; } sl_cmd_3arg_t; union SL_primitives { sl_long sl_primitive; sl_cmd_arg_t cmd_arg; sl_cmd_2arg_t cmd_2arg; sl_cmd_3arg_t cmd_3arg; sl_pdu_req_t pdu_req; sl_pdu_ind_t pdu_ind; sl_emergency_req_t emergency_req; sl_emergency_ceases_req_t emergency_ceases_req; sl_start_req_t start_req; sl_stop_req_t stop_req; sl_retrieve_bsnt_req_t retrieve_bsnt_req; sl_retrieval_req_and_fsnc_t retrieval_req_and_fsnc; sl_resume_req_t resume_req; sl_continue_req_t continue_req; sl_clear_buffers_req_t clear_buffers_req; sl_clear_rtb_req_t clear_rtb_req; sl_local_proc_outage_req_t local_proc_outage_req; sl_cong_discard_req_t cong_discard_req; sl_cong_accept_req_t cong_accept_req; sl_no_cong_req_t no_cong_req; sl_power_on_req_t power_on_req; sl_link_cong_ind_t link_cong_ind; sl_link_cong_ceased_ind_t link_cong_ceased_ind; sl_retrieved_msg_ind_t retrieved_msg_ind; sl_retrieval_comp_ind_t retrieval_comp_ind; sl_retrieval_not_poss_ind_t retrieval_not_poss_ind; sl_rb_cleared_ind_t rb_cleared_ind; sl_bsnt_ind_t bsnt_ind; sl_bsnt_not_retr_ind_t bsnt_not_retr_ind; sl_in_service_ind_t in_service_ind; sl_out_of_service_ind_t out_of_service_ind; sl_rem_proc_out_ind_t rem_proc_out_ind; sl_rem_proc_recovered_ind_t rem_proc_recovered_ind; sl_rtb_cleared_ind_t rtb_cleared_ind; sl_loc_proc_out_ind_t loc_proc_out_ind; sl_loc_proc_recovered_ind_t loc_proc_recovered_ind; }; typedef union SL_primitives sl_prim_t; #define SL_CMD_ARG_SIZE sizeof(sl_cmd_arg_t) #define SL_CMD_2ARG_SIZE sizeof(sl_cmd_2arg_t) #define SL_CMD_3ARG_SIZE sizeof(sl_cmd_3arg_t) #define SL_PDU_REQ_SIZE sizeof(sl_pdu_req_t) #define SL_PDU_IND_SIZE sizeof(sl_pdu_ind_t) #define SL_EMERGENCY_REQ_SIZE sizeof(sl_emergency_req_t) #define SL_EMERGENCY_CEASES_REQ_SIZE sizeof(sl_emergency_ceases_req_t) #define SL_START_REQ_SIZE sizeof(sl_start_req_t) #define SL_STOP_REQ_SIZE sizeof(sl_stop_req_t) #define SL_RETRIEVE_BSNT_REQ_SIZE sizeof(sl_retrieve_bsnt_req_t) #define SL_RETRIEVAL_REQ_AND_FSNC_SIZE sizeof(sl_retrieval_req_and_fsnc_t) #define SL_RESUME_REQ_SIZE sizeof(sl_resume_req_t) #define SL_CONTINUE_REQ_SIZE sizeof(sl_continue_req_t) #define SL_CLEAR_BUFFERS_REQ_SIZE sizeof(sl_clear_buffers_req_t) #define SL_CLEAR_RTB_REQ_SIZE sizeof(sl_clear_rtb_req_t) #define SL_LOCAL_PROC_OUTAGE_REQ_SIZE sizeof(sl_local_proc_outage_req_t) #define SL_CONG_DISCARD_REQ_SIZE sizeof(sl_cong_discard_req_t) #define SL_CONG_ACCEPT_REQ_SIZE sizeof(sl_cong_accept_req_t) #define SL_NO_CONG_REQ_SIZE sizeof(sl_no_cong_req_t) #define SL_POWER_ON_REQ_SIZE sizeof(sl_power_on_req_t) #define SL_LINK_CONG_IND_SIZE sizeof(sl_link_cong_ind_t) #define SL_LINK_CONG_CEASED_IND_SIZE sizeof(sl_link_cong_ceased_ind_t) #define SL_RETRIEVED_MSG_IND_SIZE sizeof(sl_retrieved_msg_ind_t) #define SL_RETRIEVAL_COMP_IND_SIZE sizeof(sl_retrieval_comp_ind_t) #define SL_RETRIEVAL_NOT_POSS_IND_SIZE sizeof(sl_retrieval_not_poss_ind_t) #define SL_RB_CLEARED_IND_SIZE sizeof(sl_rb_cleared_ind_t) #define SL_BSNT_IND_SIZE sizeof(sl_bsnt_ind_t) #define SL_BSNT_NOT_RETR_IND_SIZE sizeof(sl_bsnt_not_retr_ind_t) #define SL_IN_SERVICE_IND_SIZE sizeof(sl_in_service_ind_t) #define SL_OUT_OF_SERVICE_SIZE sizeof(sl_out_of_service_ind_t) #define SL_REM_PROC_OUT_IND_SIZE sizeof(sl_rem_proc_out_ind_t) #define SL_REM_PROC_RECOVERED_IND_SIZE sizeof(sl_rem_proc_recovered_ind_t) #define SL_RTB_CLEARED_IND_SIZE sizeof(sl_rtb_cleared_ind_t) #define SL_LOC_PROC_OUT_IND_SIZE sizeof(sl_loc_proc_out_ind_t) #define SL_LOC_PROC_RECOVERED_IND_SIZE sizeof(sl_loc_proc_recovered_ind_t) #define SL_OPT_PROTOCOL LMI_OPT_PROTOCOL #define SL_OPT_STATISTICS LMI_OPT_STATISTICS #define SL_OPT_CONFIG 3 /* use struct sl_config */ #define SL_OPT_STATEM 4 /* use struct sl_statem */ #define SL_OPT_STATS 5 /* use struct sl_stats */ LicenseGNU Free Documentation LicenseGNU FREE DOCUMENTATION LICENSE
Version 1.1, March 2000
Copyright © 2000 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. PreambleThe purpose of this License is to make a manual, textbook, or other written document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
END OF TERMS AND CONDITIONS
How to use this License for your documentsTo use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being list their titles, with the Front-Cover Texts being list, and with the Back-Cover Texts being list. A copy of the license is included in the section entitled ``GNU Free Documentation License''. If you have no Invariant Sections, write “with no Invariant Sections” instead of saying which ones are invariant. If you have no Front-Cover Texts, write “no Front-Cover Texts” instead of “Front-Cover Texts being list”; likewise for Back-Cover Texts. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. Glossary
Acronyms
References
Index
Short ContentsTable of Contents
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSS7 SS7 for the Common Man |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Last modified: Sat, 01 Nov 2008 14:12:37 GMT © Copyright 1997-2007 OpenSS7 Corporation All Rights Reserved. |