mirror of https://github.com/ARMmbed/mbed-os.git
89 lines
2.6 KiB
C
89 lines
2.6 KiB
C
/* mbed Microcontroller Library
|
|
* Copyright (c) 2017 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
|
|
#ifndef MODEM_API_H_
|
|
#define MODEM_API_H_
|
|
|
|
/** modem_api is a standardizing API for Modem type devices under mbed-os.
|
|
* It provides a simple hardware abstraction layer on top of the modem drivers
|
|
* written for mbed-os.
|
|
*
|
|
* It is required from the engineers porting any modem type device (e.g., Cellular or Wifi)
|
|
* to provide an implementation of this API in their respective target folder as well as
|
|
* usage of standard PinNames (in PinNames.h) is highly encouraged. For example,
|
|
*
|
|
* MDMTXD = P0_15, // Transmit Data
|
|
* MDMRXD = P0_16, // Receive Data
|
|
* MDMCTS = P0_17, // Clear to Send
|
|
* MDMDCD = P0_18, // Data Carrier Detect
|
|
* MDMDSR = P0_19, // Data Set Ready
|
|
* MDMDTR = P0_20, // Data Terminal Ready (set high or use handshake)
|
|
* MDMRI = P0_21, // Ring Indicator
|
|
* MDMRTS = P0_22, // Request to Send (set high or use handshake)
|
|
*
|
|
*/
|
|
|
|
#ifdef DEVICE_MODEM
|
|
|
|
typedef enum {
|
|
POWER_READY=1,
|
|
POWERED_ON,
|
|
POWERED_OFF,
|
|
LOWEST_POWER_STATE
|
|
} modem_state;
|
|
|
|
/**
|
|
* modem_s is defined in objects.h inside the TARGET folder
|
|
*/
|
|
typedef struct modem_s modem_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Sets the modem up for powering on
|
|
* modem_init() will be equivalent to plugging in the device, i.e.,
|
|
* attaching power and serial port.
|
|
*/
|
|
void modem_init(modem_t *obj);
|
|
|
|
/** Sets the modem in unplugged state
|
|
* modem_deinit() will be equivalent to pulling the plug off of the device, i.e.,
|
|
* detaching power and serial port.
|
|
* This puts the modem in lowest power state.
|
|
*/
|
|
void modem_deinit(modem_t *obj);
|
|
|
|
/** Powers up the modem
|
|
* modem_power_up() will be equivalent to pressing the soft power button.
|
|
* The driver may repeat this if the modem is not responsive to AT commands.
|
|
|
|
*/
|
|
void modem_power_up(modem_t *obj);
|
|
|
|
/** Powers down the modem
|
|
* modem_power_down() will be equivalent to turning off the modem by button press.
|
|
*/
|
|
void modem_power_down(modem_t *obj);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* DEVICE_MODEM*/
|
|
#endif /* MODEM_API_H_ */
|