Skip to content

Commit 9e51217

Browse files
author
Teppo Järvelin
committed
Cellular: Added generic cellular modem
Generic cellular module (GENERIC_AT3GPP) can by used as a default module when porting new cellular module. It's a good starting point and eases porting of new modules. GENERIC_AT3GPP uses only standard 3GPP AT commands when communicating with the modem.
1 parent 40db17e commit 9e51217

File tree

4 files changed

+96
-4
lines changed

4 files changed

+96
-4
lines changed

features/cellular/framework/AT/AT_CellularBase.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ class AT_CellularBase {
4949
PROPERTY_AT_CGSN_WITH_TYPE, // 0 = not supported, 1 = supported. AT+CGSN without type is likely always supported similar to AT+GSN.
5050
PROPERTY_AT_CGDATA, // 0 = not supported, 1 = supported. Alternative is to support only ATD*99***<cid>#
5151
PROPERTY_AT_CGAUTH, // 0 = not supported, 1 = supported. APN authentication AT commands supported
52-
PROPERTY_IPV4_STACK, // 0 = not supported, 1 = supported
53-
PROPERTY_IPV6_STACK, // 0 = not supported, 1 = supported
54-
PROPERTY_IPV4V6_STACK, // 0 = not supported, 1 = supported
52+
PROPERTY_IPV4_STACK, // 0 = not supported, 1 = supported. Does modem support IPV4?
53+
PROPERTY_IPV6_STACK, // 0 = not supported, 1 = supported. Does modem support IPV6?
54+
PROPERTY_IPV4V6_STACK, // 0 = not supported, 1 = supported. Does modem support dual stack IPV4V6?
5555
PROPERTY_MAX
5656
};
5757

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* Copyright (c) 2018, Arm Limited and affiliates.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#include "GENERIC_AT3GPP.h"
19+
#include "AT_CellularNetwork.h"
20+
21+
using namespace mbed;
22+
23+
// by default all properties are supported
24+
static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
25+
AT_CellularNetwork::RegistrationModeLAC, // C_EREG
26+
AT_CellularNetwork::RegistrationModeLAC, // C_GREG
27+
AT_CellularNetwork::RegistrationModeLAC, // C_REG
28+
1, // AT_CGSN_WITH_TYPE
29+
1, // AT_CGDATA
30+
1, // AT_CGAUTH
31+
1, // PROPERTY_IPV4_STACK
32+
1, // PROPERTY_IPV6_STACK
33+
1, // PROPERTY_IPV4V6_STACK
34+
};
35+
36+
GENERIC_AT3GPP::GENERIC_AT3GPP(FileHandle *fh) : AT_CellularDevice(fh)
37+
{
38+
AT_CellularBase::set_cellular_properties(cellular_properties);
39+
}
40+
41+
GENERIC_AT3GPP::~GENERIC_AT3GPP()
42+
{
43+
}
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/*
2+
* Copyright (c) 2018, Arm Limited and affiliates.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#ifndef GENERIC_AT3GPP_H_
19+
#define GENERIC_AT3GPP_H_
20+
21+
#include "AT_CellularDevice.h"
22+
23+
namespace mbed {
24+
25+
/**
26+
* Generic Cellular module which can be used as a default module when porting new cellular module.
27+
* GENERIC_AT3GPP uses standard 3GPP AT commands (3GPP TS 27.007 V14.5.0 (2017-09)) to communicate with the modem.
28+
*
29+
* GENERIC_AT3GPP can be used as a shield for example on top K64F.
30+
* Cellular example can be used for testing: https://github.com/ARMmbed/mbed-os-example-cellular
31+
* Add line to mbed_app.json where you define this class as CELLULAR_DEVICE and the correct pins. In cellular example
32+
* line would be for example just above "target_overrides": {...
33+
* For example:
34+
* "macros": ["CELLULAR_DEVICE=GENERIC_AT3GPP", "MDMRXD=PTC16", "MDMTXD=PTC17","MDMRTS=NC", "MDMCTS=NC"],
35+
* You can define CELLULAR_DEVICE and pins also in ../../../common/CellularTargets.h
36+
*
37+
* If new target don't work with GENERIC_AT3GPP then it needs some customizations.
38+
* First thing to try can be checking/modifying cellular_properties array in GENERIC_AT3GPP.cpp, does the module support
39+
* these commands or not? Modify array and if that's not enough then some AT_xxx classes might need to be created and
40+
* methods overridden. Check help how other modules are done what methods they have overridden. Happy porting!
41+
*/
42+
class GENERIC_AT3GPP : public AT_CellularDevice {
43+
public:
44+
GENERIC_AT3GPP(FileHandle *fh);
45+
virtual ~GENERIC_AT3GPP();
46+
47+
};
48+
} // namespace mbed
49+
#endif // GENERIC_AT3GPP_H_

features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
3535
AT_CellularNetwork::RegistrationModeLAC, // C_GREG
3636
AT_CellularNetwork::RegistrationModeLAC, // C_REG
3737
0, // AT_CGSN_WITH_TYPE
38-
1, // AT_CGDATA
38+
0, // AT_CGDATA
3939
1, // AT_CGAUTH
4040
1, // PROPERTY_IPV4_STACK
4141
0, // PROPERTY_IPV6_STACK

0 commit comments

Comments
 (0)