Skip to content

Commit bee31ad

Browse files
author
Teppo Järvelin
committed
Added deprecation notes to old cellular interfaces.
1 parent fe2e4a3 commit bee31ad

File tree

7 files changed

+17
-0
lines changed

7 files changed

+17
-0
lines changed

features/netsocket/CellularInterface.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
*
2525
* Common interface that is shared between ethernet hardware
2626
* @addtogroup netsocket
27+
*
28+
* @attention CellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
2729
*/
2830
class CellularInterface : public NetworkInterface
2931
{

features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424
/**
2525
* OnboardCellularInterface is an on-board specific implementation.
26+
*
27+
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
2628
*/
2729
OnboardCellularInterface::OnboardCellularInterface(bool debug) :
2830
UARTCellularInterface(MDMTXD, MDMRXD, MDMDCD, MDMRTS,

features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ typedef mbed::EasyCellularConnection OnboardCellularInterface;
3131
* Depending on the type of on-board modem, OnboardCellularInterface
3232
* could be derived from different implementation classes.
3333
* Portable applications should only rely on it being a CellularBase.
34+
*
35+
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
3436
*/
3537
class OnboardCellularInterface : public UARTCellularInterface {
3638

features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.cpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
*/
1515
#include "PPPCellularInterface.h"
1616

17+
/**
18+
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
19+
*/
20+
1721
#if NSAPI_PPP_AVAILABLE
1822

1923
#include <string.h>

features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ typedef struct {
9898
* The driver will work with any generic FileHandle, and can be
9999
* derived from in order to provide forms for specific interfaces, as well as
100100
* adding extra power and reset controls alongside the FileHandle.
101+
*
102+
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
101103
*/
102104
class PPPCellularInterface : public CellularBase {
103105

features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
*/
1515
#include "UARTCellularInterface.h"
1616

17+
/**
18+
* @attention UARTCellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
19+
*/
1720
#if NSAPI_PPP_AVAILABLE
1821

1922
UARTCellularInterface::UARTCellularInterface(PinName txd, PinName rxd, PinName dcd, PinName rts, PinName cts, PinName ri,

features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
*
2929
* It constructs a FileHandle and passes it back to its base class as well as overrides
3030
* enable_hup() in the base class.
31+
*
32+
* @attention UARTCellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
3133
*/
3234
class UARTCellularInterface : public PPPCellularInterface {
3335

0 commit comments

Comments
 (0)