UARTCellularInterface.h

00001 /* Copyright (c) 2017 ARM Limited
00002  *
00003  * Licensed under the Apache License, Version 2.0 (the "License");
00004  * you may not use this file except in compliance with the License.
00005  * You may obtain a copy of the License at
00006  *
00007  *     http://www.apache.org/licenses/LICENSE-2.0
00008  *
00009  * Unless required by applicable law or agreed to in writing, software
00010  * distributed under the License is distributed on an "AS IS" BASIS,
00011  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00012  * See the License for the specific language governing permissions and
00013  * limitations under the License.
00014  */
00015 
00016 #ifndef UART_CELLULAR_INTERFACE_
00017 #define UART_CELLULAR_INTERFACE_
00018 
00019 #include "PPPCellularInterface.h"
00020 #include "UARTSerial.h"
00021 
00022 #if NSAPI_PPP_AVAILABLE
00023 
00024 /** UARTCellularInterface class
00025  *
00026  *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
00027  *
00028  *  This interface serves as the controller/driver for Cellular
00029  *  modems attached via a UART (tested with UBLOX_C027 and MTS_DRAGONFLY_F411RE).
00030  *
00031  *  It constructs a FileHandle and passes it back to its base class as well as overrides
00032  *  enable_hup() in the base class.
00033  */
00034 
00035 class UARTCellularInterface : public PPPCellularInterface {
00036 
00037 public:
00038 
00039     /** Constructor
00040      *
00041      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
00042      */
00043     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
00044     UARTCellularInterface(PinName tx, PinName rx, PinName dcd = NC, PinName rts = NC, PinName cts = NC, PinName ri = NC,
00045                              PinName dtr = NC, PinName dsr = NC, int baud = MBED_CONF_PPP_CELL_IFACE_BAUD_RATE,
00046                              bool active_high = false,
00047                              bool debug = false);
00048 
00049     /** Destructor
00050      *
00051      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
00052      */
00053     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
00054     virtual ~UARTCellularInterface();
00055 
00056 private:
00057     UARTSerial _serial;
00058     PinName _dcd_pin;
00059     bool _active_high;
00060 
00061 protected:
00062     /** Enable or disable hang-up detection
00063      *
00064      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
00065      *
00066      *  When in PPP data pump mode, it is helpful if the FileHandle will signal hang-up via
00067      *  POLLHUP, e.g., if the DCD line is deasserted on a UART. During command mode, this
00068      *  signaling is not desired. enable_hup() controls whether this function should be
00069      *  active.
00070      */
00071     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
00072     virtual void enable_hup(bool enable);
00073 };
00074 
00075 #endif //NSAPI_PPP_AVAILABLE
00076 
00077 #endif //UART_CELLULAR_INTERFACE_