mirror of
https://github.com/espressif/esp-protocols.git
synced 2025-07-16 20:12:13 +02:00
62cb235aa9
C++ API offers interface to register error callback. C API isn't flexible enough, so we offer conversion function between C++ and C enums.
88 lines
3.0 KiB
C++
88 lines
3.0 KiB
C++
// Copyright 2022 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// 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.
|
|
|
|
/**
|
|
* @file c_api_wrapper.hpp
|
|
* @brief Collection of C API wrappers
|
|
*
|
|
* This file is located in include/esp_private because it is not intended for users,
|
|
* but rather for esp_modem C extension developers.
|
|
*
|
|
* The C extension API must provide a 'factory function' that returns initialized pointer to esp_modem_dce_wrap.
|
|
* Helper functions provided below, can be used for conversion between C++ enum classes and standard C enums.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "cxx_include/esp_modem_dce_factory.hpp"
|
|
#include "esp_modem_c_api_types.h"
|
|
|
|
using namespace esp_modem;
|
|
|
|
struct esp_modem_dce_wrap { // need to mimic the polymorphic dispatch as CPP uses templated dispatch
|
|
enum class modem_wrap_dte_type { UART, VFS, USB } dte_type;
|
|
dce_factory::ModemType modem_type;
|
|
DCE *dce;
|
|
std::shared_ptr<DTE> dte;
|
|
esp_modem_dce_wrap() : dce(nullptr), dte(nullptr) {}
|
|
};
|
|
|
|
inline dce_factory::ModemType convert_modem_enum(esp_modem_dce_device_t module)
|
|
{
|
|
switch (module) {
|
|
case ESP_MODEM_DCE_SIM7600:
|
|
return esp_modem::dce_factory::ModemType::SIM7600;
|
|
case ESP_MODEM_DCE_SIM7070:
|
|
return esp_modem::dce_factory::ModemType::SIM7070;
|
|
case ESP_MODEM_DCE_SIM7000:
|
|
return esp_modem::dce_factory::ModemType::SIM7000;
|
|
case ESP_MODEM_DCE_BG96:
|
|
return esp_modem::dce_factory::ModemType::BG96;
|
|
case ESP_MODEM_DCE_SIM800:
|
|
return esp_modem::dce_factory::ModemType::SIM800;
|
|
default:
|
|
case ESP_MODEM_DCE_GENETIC:
|
|
return esp_modem::dce_factory::ModemType::GenericModule;
|
|
}
|
|
}
|
|
|
|
inline esp_modem_terminal_error_t convert_terminal_error_enum(terminal_error err)
|
|
{
|
|
switch (err) {
|
|
case terminal_error::BUFFER_OVERFLOW:
|
|
return ESP_MODEM_TERMINAL_BUFFER_OVERFLOW;
|
|
case terminal_error::CHECKSUM_ERROR:
|
|
return ESP_MODEM_TERMINAL_CHECKSUM_ERROR;
|
|
case terminal_error::UNEXPECTED_CONTROL_FLOW:
|
|
return ESP_MODEM_TERMINAL_UNEXPECTED_CONTROL_FLOW;
|
|
case terminal_error::DEVICE_GONE:
|
|
return ESP_MODEM_TERMINAL_DEVICE_GONE;
|
|
default:
|
|
return ESP_MODEM_TERMINAL_UNKNOWN_ERROR;
|
|
}
|
|
}
|
|
|
|
inline esp_err_t command_response_to_esp_err(command_result res)
|
|
{
|
|
switch (res) {
|
|
case command_result::OK:
|
|
return ESP_OK;
|
|
case command_result::FAIL:
|
|
return ESP_FAIL;
|
|
case command_result::TIMEOUT:
|
|
return ESP_ERR_TIMEOUT;
|
|
}
|
|
return ESP_ERR_INVALID_ARG;
|
|
}
|