From bee31ad1b3676d82bb5e5a5d086b91a68116ef7e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Teppo=20J=C3=A4rvelin?= <teppo.jarvelin@arm.com>
Date: Tue, 27 Feb 2018 14:19:09 +0200
Subject: [PATCH] Added deprecation notes to old cellular interfaces.

---
 features/netsocket/CellularInterface.h                        | 2 ++
 .../generic_modem_driver/OnboardCellularInterface.cpp         | 2 ++
 .../cellular/generic_modem_driver/OnboardCellularInterface.h  | 2 ++
 .../cellular/generic_modem_driver/PPPCellularInterface.cpp    | 4 ++++
 .../cellular/generic_modem_driver/PPPCellularInterface.h      | 2 ++
 .../cellular/generic_modem_driver/UARTCellularInterface.cpp   | 3 +++
 .../cellular/generic_modem_driver/UARTCellularInterface.h     | 2 ++
 7 files changed, 17 insertions(+)

diff --git a/features/netsocket/CellularInterface.h b/features/netsocket/CellularInterface.h
index 8851a2ac6c..de0a0e533d 100644
--- a/features/netsocket/CellularInterface.h
+++ b/features/netsocket/CellularInterface.h
@@ -24,6 +24,8 @@
  *
  *  Common interface that is shared between ethernet hardware
  *  @addtogroup netsocket
+ *
+ *  @attention CellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
  */
 class CellularInterface : public NetworkInterface
 {
diff --git a/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.cpp b/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.cpp
index fbd111eff7..8aca57c76b 100644
--- a/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.cpp
+++ b/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.cpp
@@ -23,6 +23,8 @@
 
 /**
  * OnboardCellularInterface is an on-board specific implementation.
+ *
+ * @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
  */
 OnboardCellularInterface::OnboardCellularInterface(bool debug) :
                                                       UARTCellularInterface(MDMTXD, MDMRXD, MDMDCD, MDMRTS,
diff --git a/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.h b/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.h
index 379ece87ec..482ccb5bbf 100644
--- a/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.h
+++ b/features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.h
@@ -31,6 +31,8 @@ typedef mbed::EasyCellularConnection OnboardCellularInterface;
  *  Depending on the type of on-board modem, OnboardCellularInterface
  *  could be derived from different implementation classes.
  *  Portable applications should only rely on it being a CellularBase.
+ *
+ *  @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
  */
 class OnboardCellularInterface : public UARTCellularInterface {
 
diff --git a/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.cpp b/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.cpp
index 4d22eb2b8b..b07199e360 100644
--- a/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.cpp
+++ b/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.cpp
@@ -14,6 +14,10 @@
  */
 #include "PPPCellularInterface.h"
 
+/**
+ * @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
+ */
+
 #if NSAPI_PPP_AVAILABLE
 
 #include <string.h>
diff --git a/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h b/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h
index 80cee234b3..e1bca0f1b3 100644
--- a/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h
+++ b/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h
@@ -98,6 +98,8 @@ typedef struct {
  *  The driver will work with any generic FileHandle, and can be
  *  derived from in order to provide forms for specific interfaces, as well as
  *  adding extra power and reset controls alongside the FileHandle.
+ *
+ *  @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
  */
 class PPPCellularInterface : public CellularBase {
 
diff --git a/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.cpp b/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.cpp
index e1ee638876..eace5a8d96 100644
--- a/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.cpp
+++ b/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.cpp
@@ -14,6 +14,9 @@
  */
 #include "UARTCellularInterface.h"
 
+/**
+ * @attention UARTCellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
+ */
 #if NSAPI_PPP_AVAILABLE
 
 UARTCellularInterface::UARTCellularInterface(PinName txd, PinName rxd, PinName dcd, PinName rts, PinName cts, PinName ri,
diff --git a/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.h b/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.h
index e86d5862c6..ea6b8dc346 100644
--- a/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.h
+++ b/features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.h
@@ -28,6 +28,8 @@
  *
  *  It constructs a FileHandle and passes it back to its base class as well as overrides
  *  enable_hup() in the base class.
+ *
+ *  @attention UARTCellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
  */
 class UARTCellularInterface : public PPPCellularInterface {