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