Add two-digit mnc diagnostic flag #1804

zfields · 2019-06-03T00:24:30Z

The two-digit `mnc` diagnostic allows the original `mnc` to be reconstructed accurately.

Problem

Currently, the mnc is translated to and stored as a decimal value. According to the specification, 40 and 040 are not equal values. Currently when using the mcc and mnc tuple, there does not appear to be a clash. However, maintaining this distinction is important is important to ensure future bugs do not appear in the system.

Solution

By sending an indicator as to the original form of the information, we are able to reconstruct the original value in a lossless manner.

Steps to Test

user/tests/accept/hal-api-test-plan.md

Example App

user/tests/app/cellular_global_identity/cellular_global_identity.cpp

Tickets

ch33501

Completeness

User is totes amazing for contributing!
Contributor has signed CLA (Info here)
Problem and Solution clearly stated
Run unit/integration/application tests on device
Added documentation
Added to CHANGELOG.md after merging (add links to docs and issues)

[bugfix] Add two-digit mnc diagnostic flag #1804

hal/inc/cellular_hal_cellular_global_identity.h

system/src/system_network_diagnostics.cpp

avtolstoy · 2019-06-04T06:18:32Z

hal/src/boron/network/sara_ncp_client.cpp

@@ -412,6 +412,15 @@ int SaraNcpClient::queryAndParseAtCops(CellularSignalQuality* qual) {
    r = CHECK_PARSER(resp.readResult());
    CHECK_TRUE(r == AtResponse::OK, SYSTEM_ERROR_AT_NOT_OK);

+    // Preserve digit format data
+    const int mnc_digits = ::strnlen(mobileNetworkCode, 4);


Magic number, let's use sizeof(mobileNetworkCode) here.

Same here https://github.com/particle-iot/device-os/pull/1804/files#diff-13c08dca4df073df121b6a68266e0105R1520

hal/src/boron/network/sara_ncp_client.cpp

avtolstoy · 2019-06-04T06:21:46Z

system/src/system_network_diagnostics.cpp

@@ -302,7 +302,14 @@ class NetworkCellularCellGlobalIdentityMobileNetworkCodeDiagnosticData
    {
        CellularGlobalIdentity cgi;


I've just noticed this. Why aren't we zeroing out this struct and not setting neither size nor version?

Great catch! Thank you!

avtolstoy · 2019-06-04T13:57:04Z

hal/src/boron/network/sara_ncp_client.h

@@ -77,7 +77,7 @@ class SaraNcpClient: public CellularNcpClient {
    gsm0710::Muxer<particle::Stream, StaticRecursiveMutex> muxer_;
    std::unique_ptr<particle::MuxerChannelStream<decltype(muxer_)> > muxerAtStream_;
    CellularNetworkConfig netConf_;
-    CellularGlobalIdentity cgi_;
+    CellularGlobalIdentity cgi_ = {0};


Nitpicking: = {}; in C++.

avtolstoy · 2019-06-04T13:57:48Z

system/src/system_network_diagnostics.cpp

@@ -321,7 +328,7 @@ class NetworkCellularCellGlobalIdentityLocationAreaCodeDiagnosticData

    virtual int get(IntType& val)
    {
-        CellularGlobalIdentity cgi;
+        CellularGlobalIdentity cgi{sizeof(CellularGlobalIdentity),CGI_VERSION_LATEST};


Nitpicking: spaces.
Same here https://github.com/particle-iot/device-os/pull/1804/files#diff-027356106780d045bc6ae658497e6c92R350

Also perhaps prefer designated initializers:

Suggested change

CellularGlobalIdentity cgi{sizeof(CellularGlobalIdentity),CGI_VERSION_LATEST};

CellularGlobalIdentity cgi {.size = sizeof(CellularGlobalIdentity), .version = CGI_VERSION_LATEST};

I actually prefer those, but I thought that was only a C thing. I will switch over.

AFAIK it's in C++20 officially, but GCC supported trivial cases since long ago.

I just did a cursory check and I cannot find where designated initialization has made it into the c++ standard.
@avtolstoy Can you please confirm when it was added to the standard and if our compile flags -std=c++14 support it?

See message above. Yes, it'll work as long as the designators are specified in the same order as the fields during the declaration.

While I truly like the clarity of the syntax, I would prefer to maintain standard compliance and not become compiler dependent.

In that case you should consider removing __attribute__ or any other GNU Extensions as well.

I simply want to improve readability, so you could also consider:

Suggested change

CellularGlobalIdentity cgi{sizeof(CellularGlobalIdentity),CGI_VERSION_LATEST};

CellularGlobalIdentity cgi = {};

cgi.size = sizeof(cgi);

cgi.version = CGI_VERSION_LATEST;

You make a good point about __attribute__, seems like we are well committed to GNU at this point. I will follow your first suggestion, and use the designated initializers so we can keep it on one line.

avtolstoy · 2019-06-04T14:05:25Z

@zfields Please also set the appropriate milestone for this PR.

avtolstoy · 2019-06-05T05:39:00Z

hal/inc/cellular_hal_cellular_global_identity.h

@@ -33,6 +35,8 @@ enum __attribute__((__packed__)) CgiFlags
    CGI_FLAG_TWO_DIGIT_MNC = 0b00000001, /*!< Indicates two-digit format of Mobile Network Code */
 };

+PARTICLE_STATIC_ASSERT(CgiFlags_size, sizeof(enum CgiFlags) == 1);


Prefer typedef enum XXX {} XXX

zfields requested review from avtolstoy and sergeuz June 3, 2019 00:33

zfields force-pushed the mnc2d branch 2 times, most recently from 35b4030 to f739317 Compare June 3, 2019 02:29

avtolstoy reviewed Jun 3, 2019

View reviewed changes

hal/inc/cellular_hal_cellular_global_identity.h Outdated Show resolved Hide resolved

system/src/system_network_diagnostics.cpp Outdated Show resolved Hide resolved

zfields changed the title ~~Add two-digit mnc diagnostic~~ Add two-digit mnc diagnostic flag Jun 3, 2019

zfields force-pushed the mnc2d branch 4 times, most recently from bf0dda4 to 83b509e Compare June 3, 2019 19:44

zfields requested a review from avtolstoy June 3, 2019 19:48

zfields force-pushed the mnc2d branch from 83b509e to 716a7b9 Compare June 3, 2019 21:04

avtolstoy requested changes Jun 4, 2019

View reviewed changes

zfields requested review from avtolstoy and m-mcgowan June 4, 2019 12:01

avtolstoy approved these changes Jun 4, 2019

View reviewed changes

avtolstoy added the ready to merge PR has been reviewed and tested label Jun 4, 2019

zfields added this to the 1.2.1 milestone Jun 4, 2019

zfields force-pushed the mnc2d branch from 44748c6 to 8c80389 Compare June 4, 2019 16:49

zfields added 2 commits June 4, 2019 13:47

Add two-digit mnc diagnostic flag

bea1f62

Address code review comments

6ac46bc

zfields force-pushed the mnc2d branch from 8c80389 to fccbff6 Compare June 4, 2019 19:07

zfields changed the base branch from develop to release/v1.2.1 June 4, 2019 19:07

zfields force-pushed the mnc2d branch from fccbff6 to 5c34025 Compare June 4, 2019 21:36

zfields added 2 commits June 4, 2019 17:23

Add assert to ensure size

fe346e4

Update documentation

e565d22

zfields force-pushed the mnc2d branch from 5c34025 to e565d22 Compare June 4, 2019 22:23

avtolstoy reviewed Jun 5, 2019

View reviewed changes

technobly added the bug label Jun 5, 2019

zfields added 2 commits June 5, 2019 13:06

Fix logic for Gen2

c133bef

Fix version/size checking logic

eb4a426

zfields merged commit 12d45eb into release/v1.2.1 Jun 6, 2019

zfields deleted the mnc2d branch June 6, 2019 00:26

zfields mentioned this pull request Jun 6, 2019

Add two-digit mnc diagnostic flag #1807

Merged

technobly modified the milestones: 1.2.1, 1.2.1-rc.3 Jun 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add two-digit mnc diagnostic flag #1804

Add two-digit mnc diagnostic flag #1804

zfields commented Jun 3, 2019 •

edited by technobly

avtolstoy Jun 4, 2019

avtolstoy Jun 4, 2019

zfields Jun 4, 2019

avtolstoy Jun 4, 2019

avtolstoy Jun 4, 2019

zfields Jun 4, 2019

avtolstoy Jun 4, 2019

zfields Jun 4, 2019

avtolstoy Jun 4, 2019

zfields Jun 4, 2019 •

edited

avtolstoy Jun 5, 2019

zfields Jun 5, 2019

avtolstoy commented Jun 4, 2019

avtolstoy Jun 5, 2019

zfields Jun 5, 2019

		@@ -302,7 +302,14 @@ class NetworkCellularCellGlobalIdentityMobileNetworkCodeDiagnosticData
		{
		CellularGlobalIdentity cgi;

	CellularGlobalIdentity cgi{sizeof(CellularGlobalIdentity),CGI_VERSION_LATEST};
	CellularGlobalIdentity cgi {.size = sizeof(CellularGlobalIdentity), .version = CGI_VERSION_LATEST};

-        CellularGlobalIdentity cgi{sizeof(CellularGlobalIdentity),CGI_VERSION_LATEST};
+        CellularGlobalIdentity cgi = {};
+        cgi.size = sizeof(cgi);
+        cgi.version = CGI_VERSION_LATEST;

Add two-digit mnc diagnostic flag #1804

Add two-digit mnc diagnostic flag #1804

Conversation

zfields commented Jun 3, 2019 • edited by technobly

Problem

Solution

Steps to Test

Example App

Tickets

Completeness

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zfields Jun 4, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avtolstoy commented Jun 4, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zfields commented Jun 3, 2019 •

edited by technobly

zfields Jun 4, 2019 •

edited