Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove target dependency in ublox cellular APIs #11580

Merged
merged 2 commits into from
Nov 15, 2019
Merged

Remove target dependency in ublox cellular APIs #11580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5015c2
Remove target dependency in ublox cellular APIs
Oct 21, 2019
98f3baa
Removed error directives
Oct 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions features/cellular/framework/targets/UBLOX/AT/UBLOX_AT.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,36 @@
using namespace mbed;
using namespace events;

#ifdef TARGET_UBLOX_C030_R41XM
#ifdef UBX_MDM_SARA_R41XM
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
AT_CellularNetwork::RegistrationModeDisable,// C_EREG
AT_CellularNetwork::RegistrationModeLAC, // C_GREG
AT_CellularNetwork::RegistrationModeLAC, // C_REG
0, // AT_CGSN_WITH_TYPE
1, // AT_CGDATA
1, // AT_CGAUTH
0, // AT_CGDATA
0, // AT_CGAUTH
1, // AT_CNMI
1, // AT_CSMP
1, // AT_CMGF
1, // AT_CSDH
0, // AT_CSDH
1, // PROPERTY_IPV4_STACK
0, // PROPERTY_IPV6_STACK
0, // PROPERTY_IPV4V6_STACK
0, // PROPERTY_NON_IP_PDP_TYPE
1, // PROPERTY_AT_CGEREP
};
#else
#elif defined(UBX_MDM_SARA_U2XX) || defined(UBX_MDM_SARA_G3XX)
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
AT_CellularNetwork::RegistrationModeDisable,// C_EREG
AT_CellularNetwork::RegistrationModeLAC, // C_GREG
AT_CellularNetwork::RegistrationModeLAC, // C_REG
#ifdef UBX_MDM_SARA_G3XX
0, // AT_CGSN_WITH_TYPE
#else
1, // AT_CGSN_WITH_TYPE
#endif
1, // AT_CGDATA
1, // AT_CGAUTH
0, // AT_CGAUTH
1, // AT_CNMI
1, // AT_CSMP
1, // AT_CMGF
Expand All @@ -56,6 +60,24 @@ static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
0, // PROPERTY_NON_IP_PDP_TYPE
1, // PROPERTY_AT_CGEREP
};
#else
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
0, // C_EREG
0, // C_GREG
0, // C_REG
0, // AT_CGSN_WITH_TYPE
0, // AT_CGDATA
0, // AT_CGAUTH
0, // AT_CNMI
0, // AT_CSMP
0, // AT_CMGF
0, // AT_CSDH
0, // PROPERTY_IPV4_STACK
0, // PROPERTY_IPV6_STACK
0, // PROPERTY_IPV4V6_STACK
0, // PROPERTY_NON_IP_PDP_TYPE
0, // PROPERTY_AT_CGEREP
};
#endif

UBLOX_AT::UBLOX_AT(FileHandle *fh) : AT_CellularDevice(fh)
Expand Down Expand Up @@ -98,7 +120,7 @@ nsapi_error_t UBLOX_AT::init()

nsapi_error_t err = NSAPI_ERROR_OK;

#ifdef TARGET_UBLOX_C027
#ifdef UBX_MDM_SARA_G3XX
err = _at->at_cmd_discard("+CFUN", "=0");

if (err == NSAPI_ERROR_OK) {
Expand All @@ -107,14 +129,17 @@ nsapi_error_t UBLOX_AT::init()
config_authentication_parameters();
err = _at->at_cmd_discard("+CFUN", "=1"); // set full functionality
}
#else
#elif defined(UBX_MDM_SARA_U2XX) || defined(UBX_MDM_SARA_R41XM)
err = _at->at_cmd_discard("+CFUN", "=4");
if (err == NSAPI_ERROR_OK) {
_at->at_cmd_discard("E0", ""); // echo off
_at->at_cmd_discard("+CMEE", "=1"); // verbose responses
config_authentication_parameters();
err = _at->at_cmd_discard("+CFUN", "=1"); // set full functionality
}
#else
_at->unlock();
return NSAPI_ERROR_UNSUPPORTED;
#endif

return _at->unlock_return_error();
Expand Down Expand Up @@ -155,7 +180,7 @@ nsapi_error_t UBLOX_AT::set_authentication_parameters(const char *apn,
nsapi_error_t err = _at->at_cmd_discard("+CGDCONT", "=", "%d%s%s", 1, "IP", apn);

if (err == NSAPI_ERROR_OK) {
#ifdef TARGET_UBLOX_C030_R41XM
#ifdef UBX_MDM_SARA_R41XM
if (modem_security == CellularContext::CHAP) {
err = _at->at_cmd_discard("+UAUTHREQ", "=", "%d%d%s%s", 1, modem_security, password, username);
} else if (modem_security == CellularContext::NOAUTH) {
Expand Down
15 changes: 7 additions & 8 deletions features/cellular/framework/targets/UBLOX/AT/UBLOX_AT_CellularContext.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
#include "UBLOX_AT_CellularStack.h"
#include "APN_db.h"
#include "CellularLog.h"

#include "rtos/ThisThread.h"

namespace mbed {
Expand Down Expand Up @@ -53,9 +52,9 @@ void UBLOX_AT_CellularContext::do_connect()
_cb_data.error = NSAPI_ERROR_NO_CONNECTION;

// Attempt to establish a connection
#ifndef TARGET_UBLOX_C030_R41XM
#ifndef UBX_MDM_SARA_R41XM
_cb_data.error = define_context();
#elif TARGET_UBLOX_C030_R410M
#elif UBX_MDM_SARA_R410M
_at.cmd_start_stop("+CGACT", "?");
_at.resp_start("+CGACT:");
_cid = _at.read_int();
Expand All @@ -66,7 +65,7 @@ void UBLOX_AT_CellularContext::do_connect()
_is_context_active = true;
_is_context_activated = true;
_cb_data.error = NSAPI_ERROR_OK;
#elif TARGET_UBLOX_C030_R412M
#elif UBX_MDM_SARA_R412M
CellularNetwork::RadioAccessTechnology rat = read_radio_technology();
if (rat == CellularNetwork::RadioAccessTechnology::RAT_EGPRS) {
if (!_is_context_active) {
Expand Down Expand Up @@ -115,7 +114,7 @@ void UBLOX_AT_CellularContext::do_connect()
}
}

#ifndef TARGET_UBLOX_C030_R41XM
#ifndef UBX_MDM_SARA_R41XM
nsapi_error_t UBLOX_AT_CellularContext::define_context()
{
bool success = false;
Expand Down Expand Up @@ -249,7 +248,7 @@ int UBLOX_AT_CellularContext::nsapi_security_to_modem_security(AuthenticationTyp
case CHAP:
modem_security = 2;
break;
#ifndef TARGET_UBLOX_C030_R41XM
#ifndef UBX_MDM_SARA_R41XM
case AUTOMATIC:
modem_security = 3;
break;
Expand Down Expand Up @@ -324,7 +323,7 @@ CellularContext::AuthenticationType UBLOX_AT_CellularContext::get_auth()
return _authentication_type;
}

#ifdef TARGET_UBLOX_C030_R412M
#ifdef UBX_MDM_SARA_R412M
CellularNetwork::RadioAccessTechnology UBLOX_AT_CellularContext::read_radio_technology()
{
int act;
Expand Down Expand Up @@ -358,6 +357,6 @@ CellularNetwork::RadioAccessTechnology UBLOX_AT_CellularContext::read_radio_tech

return rat;
}
#endif // #ifdef TARGET_UBLOX_C030_R412M
#endif // #ifdef UBX_MDM_SARA_R412M

} /* namespace mbed */
6 changes: 3 additions & 3 deletions features/cellular/framework/targets/UBLOX/AT/UBLOX_AT_CellularContext.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class UBLOX_AT_CellularContext: public AT_CellularContext {
/** Get the next set of credentials from the database.
*/
void get_next_credentials(char **config);
#ifdef TARGET_UBLOX_C030_R412M
#ifdef UBX_MDM_SARA_R412M
CellularNetwork::RadioAccessTechnology read_radio_technology(void);
#endif
protected:
Expand All @@ -55,7 +55,7 @@ class UBLOX_AT_CellularContext: public AT_CellularContext {
*
* @return True if successful, otherwise false.
*/
#ifndef TARGET_UBLOX_C030_R41XM
#ifndef UBX_MDM_SARA_R41XM
nsapi_error_t define_context();
#endif

Expand All @@ -79,7 +79,7 @@ class UBLOX_AT_CellularContext: public AT_CellularContext {
* CHAP or AUTOMATIC).
* @return True if successful, otherwise false.
*/
#ifndef TARGET_UBLOX_C030_R41XM
#ifndef UBX_MDM_SARA_R41XM
bool activate_profile(const char *apn, const char *username, const char *password, AuthenticationType auth);
#endif

Expand Down
7 changes: 3 additions & 4 deletions features/cellular/framework/targets/UBLOX/AT/UBLOX_AT_CellularNetwork.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
*/

#include "UBLOX_AT_CellularNetwork.h"

#include "rtos/ThisThread.h"

using namespace mbed;
Expand Down Expand Up @@ -47,11 +46,11 @@ nsapi_error_t UBLOX_AT_CellularNetwork::set_access_technology_impl(RadioAccessTe
_at.lock();
switch (opRat) {
case RAT_EGPRS:
#if defined (TARGET_UBLOX_C030_R412M)
#if defined (UBX_MDM_SARA_R412M)
_at.at_cmd_discard("+URAT", "=", "%d%d", 9, 8);
break;
#endif
#if defined(TARGET_UBLOX_C030_U201)
#if defined(UBX_MDM_SARA_U201)
case RAT_GSM:
_at.at_cmd_discard("+URAT", "=", "%d%d", 0, 0);
break;
Expand All @@ -61,7 +60,7 @@ nsapi_error_t UBLOX_AT_CellularNetwork::set_access_technology_impl(RadioAccessTe
case RAT_HSDPA_HSUPA:
_at.at_cmd_discard("+URAT", "=", "%d%d", 2, 2);
break;
#elif defined(TARGET_UBLOX_C030_R41XM)
#elif defined(UBX_MDM_SARA_R41XM)
case RAT_CATM1:
_at.at_cmd_discard("+URAT", "=", "%d%d", 7, 8);
break;
Expand Down
2 changes: 1 addition & 1 deletion features/cellular/framework/targets/UBLOX/AT/UBLOX_AT_CellularStack.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ nsapi_error_t UBLOX_AT_CellularStack::gethostbyname(const char *host, SocketAddr
if (address->set_ip_address(host)) {
err = NSAPI_ERROR_OK;
} else {
#ifdef TARGET_UBLOX_C030_R41XM
#ifdef UBX_MDM_SARA_R41XM
_at.set_at_timeout(70000);
#else
_at.set_at_timeout(120000);
Expand Down
34 changes: 28 additions & 6 deletions features/cellular/framework/targets/UBLOX/PPP/UBLOX_PPP.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,36 @@
using namespace mbed;
using namespace events;

#ifdef TARGET_UBLOX_C027
#ifdef UBX_MDM_SARA_R41XM
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
AT_CellularNetwork::RegistrationModeDisable,// C_EREG
AT_CellularNetwork::RegistrationModeLAC, // C_GREG
AT_CellularNetwork::RegistrationModeLAC, // C_REG
0, // AT_CGSN_WITH_TYPE
1, // AT_CGDATA
1, // AT_CGAUTH
0, // AT_CGDATA
0, // AT_CGAUTH
1, // AT_CNMI
1, // AT_CSMP
1, // AT_CMGF
1, // AT_CSDH
0, // AT_CSDH
1, // PROPERTY_IPV4_STACK
0, // PROPERTY_IPV6_STACK
0, // PROPERTY_IPV4V6_STACK
0, // PROPERTY_NON_IP_PDP_TYPE
1, // PROPERTY_AT_CGEREP
};
#else
#elif defined(UBX_MDM_SARA_U2XX) || defined(UBX_MDM_SARA_G3XX)
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
AT_CellularNetwork::RegistrationModeDisable,// C_EREG
AT_CellularNetwork::RegistrationModeLAC, // C_GREG
AT_CellularNetwork::RegistrationModeLAC, // C_REG
#ifdef UBX_MDM_SARA_G3XX
0, // AT_CGSN_WITH_TYPE
#else
1, // AT_CGSN_WITH_TYPE
#endif
1, // AT_CGDATA
1, // AT_CGAUTH
0, // AT_CGAUTH
1, // AT_CNMI
1, // AT_CSMP
1, // AT_CMGF
Expand All @@ -57,6 +61,24 @@ static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
0, // PROPERTY_NON_IP_PDP_TYPE
1, // PROPERTY_AT_CGEREP
};
#else
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AnttiKauppila Is this approach fine ?

@wajahat-ublox Do we need to have this cellular_properties defined always?

Copy link
Member Author

@wajahat-abbas wajahat-abbas Nov 6, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0xc0170 The else condition is there for a cellular program using UBLOX APIs with an unsupported modem. Yes in case of non cellular programs, it should not be part of final binary (optimized out).

0, // C_EREG
0, // C_GREG
0, // C_REG
0, // AT_CGSN_WITH_TYPE
0, // AT_CGDATA
0, // AT_CGAUTH
0, // AT_CNMI
0, // AT_CSMP
0, // AT_CMGF
0, // AT_CSDH
0, // PROPERTY_IPV4_STACK
0, // PROPERTY_IPV6_STACK
0, // PROPERTY_IPV4V6_STACK
0, // PROPERTY_NON_IP_PDP_TYPE
0, // PROPERTY_AT_CGEREP
};
#endif

UBLOX_PPP::UBLOX_PPP(FileHandle *fh) : AT_CellularDevice(fh)
Expand Down
27 changes: 27 additions & 0 deletions features/cellular/framework/targets/UBLOX/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Configuring Ublox Cellular Modems for custom targets

In order to use cellular APIs with custom targets, user needs to define ublox modem macros in `mbed_app.json` configuration file:
```
"target_overrides": {
"*": {
"mbed-trace.enable": true,
"platform.stdio-convert-newlines": true,
"platform.stdio-baud-rate": 115200,
"platform.default-serial-baud-rate": 115200
},
"K64F": {
"target.macros_add": ["UBX_MDM_SARA_R41XM", "UBX_MDM_SARA_R412M"]
}
}
```


List of supported ublox modems and their respective macros are as follow:

| Ublox mbed board | Modem Name | Family Macro | Modem Macro |
| ----------- | :-----------: | :-------------: | :-------------: |
| UBLOX_C027 | SARA-G350 | `UBX_MDM_SARA_G3XX` | `UBX_MDM_SARA_G350` |
| UBLOX_C030_N211 | SARA-N211 | `UBX_MDM_SARA_N2XX` | `UBX_MDM_SARA_N211` |
| UBLOX_C030_U201 | SARA-U201 | `UBX_MDM_SARA_U2XX` | `UBX_MDM_SARA_U201` |
| UBLOX_C030_R410M | SARA-R410M | `UBX_MDM_SARA_R41XM` | `UBX_MDM_SARA_R410M` |
| UBLOX_C030_R412M | SARA-R412M | `UBX_MDM_SARA_R41XM` | `UBX_MDM_SARA_R412M` |
17 changes: 11 additions & 6 deletions targets/targets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,7 +707,7 @@
"macro_name": "MODEM_ON_BOARD_UART"
}
},
"macros": ["TARGET_LPC1768"],
"macros": ["TARGET_LPC1768", "UBX_MDM_SARA_G3XX", "UBX_MDM_SARA_G350"],
"inherits": ["LPCTarget"],
"device_has": [
"USTICKER",
Expand Down Expand Up @@ -4997,23 +4997,28 @@
"UBLOX_C030_U201": {
"inherits": ["UBLOX_C030"],
"components_add": ["SD", "FLASHIAP"],
"release_versions": ["5"]
"release_versions": ["5"],
"macros_add": ["UBX_MDM_SARA_U2XX", "UBX_MDM_SARA_U201"]
},
"UBLOX_C030_N211": {
"inherits": ["UBLOX_C030"],
"release_versions": ["5"]
"release_versions": ["5"],
"macros_add": ["UBX_MDM_SARA_N2XX", "UBX_MDM_SARA_N211"]
},
"UBLOX_C030_R41XM": {
"inherits": ["UBLOX_C030"],
"release_versions": ["5"]
"release_versions": ["5"],
"public": false
},
"UBLOX_C030_R410M": {
"inherits": ["UBLOX_C030_R41XM"],
"release_versions": ["5"]
"release_versions": ["5"],
"macros_add": ["UBX_MDM_SARA_R41XM", "UBX_MDM_SARA_R410M"]
},
"UBLOX_C030_R412M": {
"inherits": ["UBLOX_C030_R41XM"],
"release_versions": ["5"]
"release_versions": ["5"],
"macros_add": ["UBX_MDM_SARA_R41XM", "UBX_MDM_SARA_R412M"]
},
"NZ32_SC151": {
"inherits": ["FAMILY_STM32"],
Expand Down