<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/osmo-mgw/+/21386">View Change</a></p><div style="white-space:pre-wrap">Approvals:
laforge: Looks good to me, approved
pespin: Looks good to me, but someone else must approve
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">usermanual: add chapter about mgcp endpoints<br><br>The manual does not say much about the endpoint naming, even though<br>osmo-mgw is oriented at RFC 3435 the endpoint names are specific to<br>osmo-mgw. In particular the E1/T1 endpoints and their overlapping need<br>some explaination<br><br>Change-Id: I16265eb667221959a69f33701d024bd8d9b22040<br>---<br>A doc/manuals/chapters/mgcp_endpoints.adoc<br>M doc/manuals/osmomgw-usermanual.adoc<br>2 files changed, 96 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/chapters/mgcp_endpoints.adoc b/doc/manuals/chapters/mgcp_endpoints.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..797fdea</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/chapters/mgcp_endpoints.adoc</span><br><span>@@ -0,0 +1,94 @@</span><br><span style="color: hsl(120, 100%, 40%);">+== MGCP Endpoints</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+MGCP organizes the switching resources in so called endpoints. Each endpoint is</span><br><span style="color: hsl(120, 100%, 40%);">+referenced by its unique identifier. While RFC 3435 specifies a naming scheme, the</span><br><span style="color: hsl(120, 100%, 40%);">+actual identifier naming is subject to the implementation and configuration.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== RTP proxy / RTP bridge endpoints</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMGW implements a freely configurable number of `rtpbridge` endpoints. Those</span><br><span style="color: hsl(120, 100%, 40%);">+endpoints are able to host two connections at a time to model the functionality</span><br><span style="color: hsl(120, 100%, 40%);">+of a tandem switch.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+RTP bridge endpoint identifiers are referenced by the string `rtpbridge/`, a</span><br><span style="color: hsl(120, 100%, 40%);">+hexadecimal number without leading zeros and a domain name (configurable).</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%);">+rtpbridge/<number>@<domain></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%);">+.Example: List of virtual endpoints</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/1@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/2@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/3@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/4@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/5@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/6@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/7@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/8@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/9@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/a@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/b@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/c@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/d@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/e@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/f@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+rtpbridge/10@mgw</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%);">+=== E1/T1 endpoints</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoMGW supports E1 subslot multiplexing as specified by I.460. All possible</span><br><span style="color: hsl(120, 100%, 40%);">+subslot combinations are mapped on individual endpoints. The endpoint names</span><br><span style="color: hsl(120, 100%, 40%);">+are prefixed with `ds/e1-` followed by the trunk number and the E1 timeslot.</span><br><span style="color: hsl(120, 100%, 40%);">+The subslot is defined by a bit rate and a bit offset.</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%);">+ds/e1-<trunk>/s-<timeslot>/su<bitrate>-<bitoffset>@<domain></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%);">+.Example: List of endpoints on E1 trunk 0 at E1 timeslot 2</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su64-0@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su32-0@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su32-4@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su16-0@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su16-2@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su16-4@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su16-6@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-0@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-1@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-2@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-3@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-4@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-5@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-6@mgw</span><br><span style="color: hsl(120, 100%, 40%);">+ds/e1-0/s-2/su8-7@mgw</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%);">+When creating connections on endpoints that reside in one E1 timeslot the call</span><br><span style="color: hsl(120, 100%, 40%);">+agent must make sure that no overlapping endpoints are used. It is for example</span><br><span style="color: hsl(120, 100%, 40%);">+not possible to use `ds/e1-0/s-2/su16-2@mgw` and `ds/e1-0/s-2/su8-3@mgw` at the</span><br><span style="color: hsl(120, 100%, 40%);">+same time because they overlap.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Subslot overlapping</span><br><span style="color: hsl(120, 100%, 40%);">+[options="header"]</span><br><span style="color: hsl(120, 100%, 40%);">+|===</span><br><span style="color: hsl(120, 100%, 40%);">+| Bit offset 4+| Subslots</span><br><span style="color: hsl(120, 100%, 40%);">+| 0 | 8k .2+| 16k .4+| 32k .8+| 64k</span><br><span style="color: hsl(120, 100%, 40%);">+| 1 | 8k</span><br><span style="color: hsl(120, 100%, 40%);">+| 2 | 8k .2+| 16k</span><br><span style="color: hsl(120, 100%, 40%);">+| 3 | 8k</span><br><span style="color: hsl(120, 100%, 40%);">+| 4 | 8k .2+| 16k .4+| 32k</span><br><span style="color: hsl(120, 100%, 40%);">+| 5 | 8k</span><br><span style="color: hsl(120, 100%, 40%);">+| 6 | 8k .2+| 16k</span><br><span style="color: hsl(120, 100%, 40%);">+| 7 | 8k</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%);">+NOTE: The current implementation (December 2020) only implements TRAU frame</span><br><span style="color: hsl(120, 100%, 40%);">+encoding/decoding for 16K and 8K subslots. Endpoints with other bitrates are</span><br><span style="color: hsl(120, 100%, 40%);">+not yet useable.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+NOTE: the VTY command "show mgcp" can be used to get a list of all available</span><br><span style="color: hsl(120, 100%, 40%);">+endpoints (including identifiers)</span><br><span>\ No newline at end of file</span><br><span>diff --git a/doc/manuals/osmomgw-usermanual.adoc b/doc/manuals/osmomgw-usermanual.adoc</span><br><span>index 36d4049..c4660f5 100644</span><br><span>--- a/doc/manuals/osmomgw-usermanual.adoc</span><br><span>+++ b/doc/manuals/osmomgw-usermanual.adoc</span><br><span>@@ -18,6 +18,8 @@</span><br><span> </span><br><span> include::{srcdir}/chapters/configuration.adoc[]</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/mgcp_endpoints.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> include::{srcdir}/chapters/mgcp_extensions.adoc[]</span><br><span> </span><br><span> include::./common/chapters/osmux/osmux.adoc[]</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-mgw/+/21386">change 21386</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-mgw/+/21386"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-mgw </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I16265eb667221959a69f33701d024bd8d9b22040 </div>
<div style="display:none"> Gerrit-Change-Number: 21386 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: dexter <pmaier@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>