<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/osmo-pcu/+/21699">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
pespin: Looks good to me, but someone else must approve
laforge: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">manuals/gb/ns.adoc: Update documentation regarding SNS capability<br><br>The SNS capability was added to our Gb stack quite some time ago,<br>but it seems the manual was not updated. Let's update the document<br>accordingly.<br><br>The individual sub-sections about the SNS-* messages are empty as<br>I think lynxis is currently most qualified to fill them in, I'll<br>ask him to submit a follow-up patch.<br><br>Related: SYS#5212<br>Change-Id: I21e891fc7662b582681cd9bd7568e4b65d357751<br>---<br>M doc/manuals/gb/ns.adoc<br>1 file changed, 67 insertions(+), 16 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/gb/ns.adoc b/doc/manuals/gb/ns.adoc</span><br><span>index fbcd380..8224e16 100644</span><br><span>--- a/doc/manuals/gb/ns.adoc</span><br><span>+++ b/doc/manuals/gb/ns.adoc</span><br><span>@@ -2,8 +2,8 @@</span><br><span> </span><br><span> === List of Messages</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-The following tables list the NS messages used by OsmoPCU, grouped by their</span><br><span style="color: hsl(0, 100%, 40%);">-level of compliance with 3GPP TS 48.016.</span><br><span style="color: hsl(120, 100%, 40%);">+The following tables list the NS messages used by osmo-pcu and osmo-gbproxy, grouped by their level of</span><br><span style="color: hsl(120, 100%, 40%);">+compliance with 3GPP TS 48.016.</span><br><span> </span><br><span> ==== Messages Compliant With 3GPP TS 48.016</span><br><span> </span><br><span>@@ -15,16 +15,24 @@</span><br><span> [options="header",cols="10%,10%,20%,35%,5%,20%"]</span><br><span> |===</span><br><span> | TS 48.016 § | type code (hex) | This document § | Message | <-/-> | Received/Sent by OsmoPCU</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.10 | 0x00 | <<ns_unit_data>> | NS-UNITDATA | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.5 | 0x02 | <<ns_reset>> | NS-RESET | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.6 | 0x03 | <<ns_reset_ack>> | NS-RESET-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.3 | 0x04 | <<ns_block>> | NS-BLOCK | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.4 | 0x05 | <<ns_block_ack>> | NS-BLOCK-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.8 | 0x06 | <<ns_unblock>> | NS-UNBLOCK | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.9 | 0x07 | <<ns_unblock_ack>> | NS-UNBLOCK-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 9.2.7 | 0x08 | <<ns_status>> | NS-STATUS | <-/-> | Received/Sent</span><br><span> | 9.2.1 | 0x0a | <<ns_alive>> | NS-ALIVE | <-/-> | Received/Sent</span><br><span> | 9.2.2 | 0x0b | <<ns_alive_ack>> | NS-ALIVE-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.3 | 0x04 | <<ns_block>> | NS-BLOCK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.4 | 0x05 | <<ns_block_ack>> | NS-BLOCK-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.5 | 0x02 | <<ns_reset>> | NS-RESET | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.6 | 0x03 | <<ns_reset_ack>> | NS-RESET-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.7 | 0x08 | <<ns_status>> | NS-STATUS | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.8 | 0x06 | <<ns_unblock>> | NS-UNBLOCK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.9 | 0x07 | <<ns_unblock_ack>> | NS-UNBLOCK-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.2.10 | 0x00 | <<ns_unit_data>> | NS-UNITDATA | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.1 | 0x0c | <<sns_ack>> | SNS-ACK | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.2 | 0x0d | <<sns_add>> | SNS-ADD | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.3 | 0x0e | <<sns_changeweight>> | SNS-CHANGEWEIGHT | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.4 | 0x0f | <<sns_config>> | SNS-CONFIG | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.5 | 0x10 | <<sns_config_ack>> | SNS-CONFIG | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.6 | 0x11 | <<sns_delete>> | SNS-DELETE | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.7 | 0x12 | <<sns_size>> | SNS-SIZE | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 9.3.8 | 0x13 | <<sns_size_ack>> | SNS-SIZE-ACK | <-/-> | Received/Sent</span><br><span> |===</span><br><span> </span><br><span> ==== Messages Specific to OsmoPCU</span><br><span>@@ -152,6 +160,31 @@</span><br><span> </span><br><span> The message conforms to 3GPP TS 48.016 § 9.2.2 specification.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_ack]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-ACK</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_add]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-ADD</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_changeweight]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-CHANGEWEIGHT</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_config]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-CONFIG</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_config_ack]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-CONFIG-ACK</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_delete]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-DELETE</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[ssn_size]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-SIZE</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[sns_size_ack]]</span><br><span style="color: hsl(120, 100%, 40%);">+==== SNS-SIZE-ACK</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> === Information Elements Overview</span><br><span> </span><br><span> All of the IEs handled by OsmoPCU are listed below, with limitations and</span><br><span>@@ -165,16 +198,34 @@</span><br><span> [options="header",cols="5%,10%,40%,5%,40%"]</span><br><span> |===</span><br><span> | tag (hex) | TS 48.016 § | IE name | <-/-> | Received/Sent by OsmoPCU</span><br><span style="color: hsl(0, 100%, 40%);">-| 0x00 | 10.3.2 | Cause | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 0x01 | 10.3.5 | NSVCI | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 0x02 | 10.3.3 | NS PDU | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 0x03 | 10.3.1 | BVCI | <-/-> | Received/Sent</span><br><span style="color: hsl(0, 100%, 40%);">-| 0x04 | 10.3.6 | NSEI | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x03 | 10.3.1 | BVCI | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x00 | 10.3.2 | Cause | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| - | 10.3.2a | End Flag | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x0b | 10.3.2b | IP Address | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x05 | 10.3.2c | List of IP4 Elements | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x06 | 10.3.2d | List of IP6 Elements | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x07 | 10.3.2e | Maximum Number of NS-VCs | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x08 | 10.3.2f | Number of IP4 Endpoints | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x09 | 10.3.2g | Number of IP6 Endpoints | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x02 | 10.3.3 | NS PDU | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x01 | 10.3.5 | NSVCI | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x04 | 10.3.6 | NSEI | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| - | 10.3.7 | PDU Type | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| 0x0a | 10.3.7a | Reset Flag | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| - | 10.3.8 | Spare Octet | <-/-> | Received/Sent</span><br><span style="color: hsl(120, 100%, 40%);">+| - | 10.3.10 | Transaction ID | <-/-> | Received/Sent</span><br><span> |===</span><br><span> </span><br><span> ==== IEs Not Conforming to 3GPP TS 48.016</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-All IEs defined in 3GPP TS 48.016 § 10.3 are supported by OsmoPCU.</span><br><span style="color: hsl(120, 100%, 40%);">+.IEs conforming to 3GPP TS 48.016</span><br><span style="color: hsl(120, 100%, 40%);">+[options="header",cols="5%,10%,40%,5%,40%"]</span><br><span style="color: hsl(120, 100%, 40%);">+|===</span><br><span style="color: hsl(120, 100%, 40%);">+| tag (hex) | TS 48.016 § | IE name | <-/-> | Notice</span><br><span style="color: hsl(120, 100%, 40%);">+| - | 10.3.9 | NS-SDU Control Bits | <-/-> | Not implemented yet</span><br><span style="color: hsl(120, 100%, 40%);">+|===</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+All other IEs defined in 3GPP TS 48.016 § 10.3 are supported by OsmoPCU.</span><br><span> </span><br><span> ==== Additional Attributes and Parameters</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-pcu/+/21699">change 21699</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-pcu/+/21699"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-pcu </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I21e891fc7662b582681cd9bd7568e4b65d357751 </div>
<div style="display:none"> Gerrit-Change-Number: 21699 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: dexter <pmaier@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: lynxis lazus <lynxis@fe80.eu> </div>
<div style="display:none"> Gerrit-Reviewer: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>