laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-remsim/+/36417?usp=email )
Change subject: README.md: Major update / meaningful content
......................................................................
README.md: Major update / meaningful content
Change-Id: Iec6a38bc34fdb0f9f0427df1c0fa53d513655a2a
---
M README.md
1 file changed, 65 insertions(+), 67 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-remsim refs/changes/17/36417/1
diff --git a/README.md b/README.md
index 8f2657f..2aa3af5 100644
--- a/README.md
+++ b/README.md
@@ -1,89 +1,78 @@
osmo-remsim - Osmocom remote SIM software suite
===============================================
-This software suite is a work in progress.
+osmo-remsim is a suite of software programs enabling physical/geographic separation of a cellular phone (or
+modem) on the one hand side and the SIM/USIM/ISIM card on the other side.
+
+Using osmo-remsim, you can operate an entire fleet of modems/phones, as well as banks of SIM cards and
+dynamically establish or remove the connections between modems/phones and cards.
+
+So in technical terms, it behaves like a proxy for the ISO 7816 smart card interface between the MS/UE and the
+UICC/SIM/USIM/ISIM.
+
+While originally designed to be used in context of cellular networks, there is nothing cellular specific in
+the system. It can therefore also be used with other systems that use contact based smart cards according to
+ISO 7816. Currently only the T=0 protocol with standard (non-extended) APDUs is supported.
+
+Homepage
+--------
+Please visit the [official homepage](https://osmocom.org/projects/osmo-remsim/wiki)
+for usage instructions, manual and examples.
-osmo-remsim-client
-------------------
+GIT Repository
+--------------
-The client interfaces with GSM phones / modems via dedicated "Card
-Emulation" devices such as the Osmocom SIMtrace2 or sysmocom sysmoQMOD
-board + firmware. This hardware implements the ISO7816-3 electrical
-interface and protocol handling and passes any TPDU headers received
-from the phone/modem to osmo-remsim-client for further processing of the
-TPDUs associated to the given APDU transfer.
+You can clone from the official osmo-remsim.git repository using
-osmo-remsim-client connects via a RSPRO control connection to
-osmo-remsim-server at startup and registers itself. It will receive
-configuration data such as the osmo-remsim-bankd IP+Port and the
-ClientId from osmo-remsim-server.
+ git clone https://gitea.osmocom.org/sim-card/osmo-remsim
-After receiving the configuration, osmo-remsim-client will establish a
-RSPRO data connection to the osmo-remsim-bankd IP:Port.
+There is a web interface at <https://gitea.osmocom.org/sim-card/osmo-remsim>.
-As the USB interface for remote SIM in simtrace2.git uses one interface
-per slot, we can implement the client in blocking mode, i.e. use
-blocking I/O on the TCP/RSPRO side. This simplifies the code compared
-to a more complex async implementation.
+Documentation
+-------------
+
+The User Manual is [optionally] built in PDF form as part of the build process.
+
+A pre-rendered PDF version of the current `master` can be found at
+[User Manual](https://downloads.osmocom.org/docs/latest/osmo-remsim-usermanual.pd….
-osmo-remsim-bankd
------------------
+Forum
+-----
-The osmo-remsim-bankd (SIM Bank Daemon) manages one given SIM bank. The
-initial implementation supports a PC/SC driver to expose any PC/SC
-compatible card readers as SIM bank.
+We welcome any osmo-remsim related discussions in the
+[SIM Card Technology](https://discourse.osmocom.org/c/sim-card-technology/)
+section of the osmocom discourse (web based Forum).
-osmo-remsim-bankd initially connects via a RSPRO control connection to
-osmo-remsim-server at startup, and will in turn receive a set of initial
-[client,slot]:[bankd,slot] mappings. These mappings determine which
-slot on the client (corresponding to a modem) is mapped to which slot on
-the SIM bank. Mappings can be updated by osmo-remsim-server at any given
-point in time.
-osmo-remsim-bankd implements a RSPRO server, where it listens to
-connections from osmo-remsim-clients.
+Mailing List
+------------
-As PC/SC only offers a blocking API, there is one thread per PC/SC slot.
-This thread will perform blocking I/O on the socket towards the client,
-and blocking API calls on PC/SC.
+There is no separate mailing list for this project. However,
+discussions related to pySim are happening on the simtrace
+<simtrace(a)lists.osmocom.org> mailing list, please see
+<https://lists.osmocom.org/mailman/listinfo/simtrace> for subscription
+options and the list archive.
-In terms of thread handling, we do:
+Please observe the [Osmocom Mailing List
+Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
+when posting.
-* accept() handling in [spare] worker threads
-** this means blocking I/O can be used, as each worker thread only has
- one TCP connection
-** client identifies itself with client:slot
-** lookup mapping based on client:slot (using mutex for protection)
-** open the reader based on the lookup result
-The worker threads initially don't have any mapping to a specific
-reader, and that mapping is only established at a later point after the
-client has identified itself. The advantage is that the entire bankd
-can live without any non-blocking I/O.
+Issue Tracker
+-------------
-The main thread handles the connection to osmo-remsim-server, where it
-can also use non-blocking I/O. However, re-connection would be
-required, to avoid stalling all banks/cards in the event of a connection
-loss to the server.
+We use the [issue tracker of the osmo-remsim project on osmocom.org](https://osmocom.org/projects/osmo-remsim/issues) for
+tracking the state of bug reports and feature requests. Feel free to submit any issues you may find, or help
+us out by resolving existing issues.
-worker threads have the following states:
-* INIT (just started)
-* ACCEPTING (they're blocking in the accept() call on the server socket fd)
-* CONNECTED_WAIT_ID (TCP established, but peer not yet identified itself)
-* CONNECTED_CLIENT (TCP established, client has identified itself, no mapping)
-* CONNECTED_CLIENT_MAPPED (TCP established, client has identified itself, mapping exists)
-* CONNECTED_CLIENT_MAPPED_CARD (TCP established, client identified, mapping exists, card opened)
-* CONNECTED_SERVER (TCP established, server has identified itself)
-Once the client disconnects, or any other error occurs (such as card I/O
-errors), the worker thread either returns to INIT state (closing client
-socket and reader), or it terminates. Termination would mean that the
-main thread would have to do non-blocking join to detect client
-termination and then re-spawn clients, so the "return to INIT state"
-approach seems to make more sense.
+Contributing
+------------
-Open topics:
-* detecting multiple connections from a server, logging this or even
- avoiding that situation
+Our coding standards are described at
+<https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards>
+
+We are using a gerrit-based patch review process explained at
+<https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit>
--
To view, visit https://gerrit.osmocom.org/c/osmo-remsim/+/36417?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-remsim
Gerrit-Branch: master
Gerrit-Change-Id: Iec6a38bc34fdb0f9f0427df1c0fa53d513655a2a
Gerrit-Change-Number: 36417
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: newchange
neels has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-pfcp/+/36347?usp=email )
Change subject: pfcp up_function_features: allow shorter lengths
......................................................................
pfcp up_function_features: allow shorter lengths
eUPF sends a short CP Function Features bitmap, which is easy to solve
by just zero padding to the minimum length specified in PFCP (3GPP TS
29.244)
Related: SYS#6590
Change-Id: I40e255fd0b4770e578aea7a10ba88f5eeba087f4
---
M src/libosmo-pfcp/pfcp_ies_custom.c
1 file changed, 18 insertions(+), 2 deletions(-)
Approvals:
Jenkins Builder: Verified
laforge: Looks good to me, but someone else must approve
pespin: Looks good to me, approved
diff --git a/src/libosmo-pfcp/pfcp_ies_custom.c b/src/libosmo-pfcp/pfcp_ies_custom.c
index e2e9f02..d3ecda5 100644
--- a/src/libosmo-pfcp/pfcp_ies_custom.c
+++ b/src/libosmo-pfcp/pfcp_ies_custom.c
@@ -431,8 +431,10 @@
int osmo_pfcp_dec_up_function_features(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv)
{
struct osmo_pfcp_ie_up_function_features *up_function_features = decode_to;
- ENSURE_LENGTH_IS_AT_LEAST(6);
- memcpy(up_function_features->bits, tlv->val, 6);
+ /* 3GPP TS 29.244 version 16.6.0 Release 16 8.2.25 UP Function Features defines at least 6 octets of bits, but
+ * if the peer sends less octets, make do with what we get. */
+ memset(up_function_features->bits, 0, sizeof(up_function_features->bits));
+ memcpy(up_function_features->bits, tlv->val, OSMO_MIN(sizeof(up_function_features->bits), tlv->len));
return 0;
}
--
To view, visit https://gerrit.osmocom.org/c/libosmo-pfcp/+/36347?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmo-pfcp
Gerrit-Branch: master
Gerrit-Change-Id: I40e255fd0b4770e578aea7a10ba88f5eeba087f4
Gerrit-Change-Number: 36347
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged
neels has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-pfcp/+/36346?usp=email )
Change subject: osmo_gtlv_cfg: fix api doc
......................................................................
osmo_gtlv_cfg: fix api doc
Change-Id: Idcbb10edf384f49bd3f685323a68cdbf8b5d009d
---
M include/osmocom/gtlv/gtlv.h
1 file changed, 11 insertions(+), 2 deletions(-)
Approvals:
Jenkins Builder: Verified
laforge: Looks good to me, approved
pespin: Looks good to me, but someone else must approve
diff --git a/include/osmocom/gtlv/gtlv.h b/include/osmocom/gtlv/gtlv.h
index d800f71..a6728a4 100644
--- a/include/osmocom/gtlv/gtlv.h
+++ b/include/osmocom/gtlv/gtlv.h
@@ -62,9 +62,9 @@
size_t tl_min_size;
/*! Read one TL from the start of src_data.
- * \param gtlv Return the T (tag) value read from src_data in gtlv->tag.
+ * \param gtlv Return the T (tag) value read from src_data in gtlv->ti.tag.
* Return the L (length) value read from src_data in gtlv->len.
- * Return the I (instance) value read from src_data in gtlv->len; ignore if there is no I.
+ * Return the I (instance) value read from src_data in gtlv->ti.instance; ignore if there is no I.
* Return the position just after the TL in gtlv->*val. If there is V data, point at the start of the
* V data in src_data. If there is no V data, point at the byte just after the TL part in src_data.
* \param src_data Part of raw message being decoded.
--
To view, visit https://gerrit.osmocom.org/c/libosmo-pfcp/+/36346?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmo-pfcp
Gerrit-Branch: master
Gerrit-Change-Id: Idcbb10edf384f49bd3f685323a68cdbf8b5d009d
Gerrit-Change-Number: 36346
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged
laforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-trx/+/36409?usp=email )
Change subject: README.md: Improve markdown formatting
......................................................................
README.md: Improve markdown formatting
Change-Id: Ic5764aab323db87015da8c461dec136e57dd9c8f
---
M README.md
1 file changed, 14 insertions(+), 5 deletions(-)
Approvals:
laforge: Looks good to me, approved
Jenkins Builder: Verified
diff --git a/README.md b/README.md
index b0e07a0..4977ad4 100644
--- a/README.md
+++ b/README.md
@@ -4,17 +4,17 @@
OsmoTRX is a software-defined radio transceiver that implements the Layer 1
physical layer of a BTS comprising the following 3GPP specifications:
-* TS 05.01 "Physical layer on the radio path"
-* TS 05.02 "Multiplexing and Multiple Access on the Radio Path"
-* TS 05.04 "Modulation"
-* TS 05.10 "Radio subsystem synchronization"
+* TS 05.01 *Physical layer on the radio path*
+* TS 05.02 *Multiplexing and Multiple Access on the Radio Path*
+* TS 05.04 *Modulation*
+* TS 05.10 *Radio subsystem synchronization*
OsmoTRX is originally based on the transceiver code from the
[OpenBTS](https://osmocom.org/projects/osmobts/wiki/OpenBTS) project, but setup
to operate independently with the purpose of using with non-OpenBTS software and
projects, specifically within the Osmocom stack. Used together with
[OsmoBTS](https://osmocom.org/projects/osmobts/wiki) you can get a pretty
-standard GSM BTS with Abis interface as per the relevant 3GPP specifications.
+standard GSM/GPRS/EGPRS BTS with Abis interface as per the relevant 3GPP specifications.
Homepage
--------
--
To view, visit https://gerrit.osmocom.org/c/osmo-trx/+/36409?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-trx
Gerrit-Branch: master
Gerrit-Change-Id: Ic5764aab323db87015da8c461dec136e57dd9c8f
Gerrit-Change-Number: 36409
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: merged
laforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-trx/+/36410?usp=email )
Change subject: README.md: Add Forum and Issue Tracker links
......................................................................
README.md: Add Forum and Issue Tracker links
Change-Id: Ib85f4e82d314cbab1c844497fb82dbda230589a5
---
M README.md
1 file changed, 23 insertions(+), 0 deletions(-)
Approvals:
laforge: Looks good to me, approved; Verified
diff --git a/README.md b/README.md
index 4977ad4..b635362 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,13 @@
can be generated during the build process, and is also available online at
<https://ftp.osmocom.org/docs/latest/osmotrx-usermanual.pdf>.
+Forum
+-----
+
+We welcome any osmo-trx related discussions in the
+[Cellular Network Infrastructure -> 2 RAN (GERAN)](https://discourse.osmocom.org/c/cni/geran)
+section of the osmocom discourse (web based Forum).
+
Mailing List
------------
@@ -50,6 +57,13 @@
Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_Li…
when posting.
+Issue Tracker
+-------------
+
+We use the [issue tracker of the osmo-trx project on osmocom.org](https://osmocom.org/projects/osmotrx/issues) for
+tracking the state of bug reports and feature requests. Feel free to submit any issues you may find, or help
+us out by resolving existing issues.
+
Contributing
------------
--
To view, visit https://gerrit.osmocom.org/c/osmo-trx/+/36410?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-trx
Gerrit-Branch: master
Gerrit-Change-Id: Ib85f4e82d314cbab1c844497fb82dbda230589a5
Gerrit-Change-Number: 36410
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-CC: Jenkins Builder
Gerrit-MessageType: merged
laforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-trx/+/36412?usp=email )
Change subject: README.md: Remove stray apostrophe
......................................................................
README.md: Remove stray apostrophe
Change-Id: I236a3aa66824759bf23b4331a22fa1d9ec25c5bf
---
M README.md
1 file changed, 10 insertions(+), 1 deletion(-)
Approvals:
laforge: Looks good to me, approved; Verified
diff --git a/README.md b/README.md
index b635362..9361631 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
You can clone from the official osmo-trx.git repository using
- git clone https://gitea.osmocom.org/cellular-infrastructure/osmo-trx`
+ git clone https://gitea.osmocom.org/cellular-infrastructure/osmo-trx
There is a web interface at <https://gitea.osmocom.org/cellular-infrastructure/osmo-trx>
--
To view, visit https://gerrit.osmocom.org/c/osmo-trx/+/36412?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-trx
Gerrit-Branch: master
Gerrit-Change-Id: I236a3aa66824759bf23b4331a22fa1d9ec25c5bf
Gerrit-Change-Number: 36412
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-CC: Jenkins Builder
Gerrit-MessageType: merged