mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-08 12:10:59 +00:00
[cxx]: GPIO CXX wrappers, experiemental CI rule
* Wrapper class for simple GPIO interaction like read/write without ISRs. * Added rule to provoke builds after changes in the experimental C++ component.
This commit is contained in:
@@ -0,0 +1,208 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2021 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#if __cpp_exceptions
|
||||
|
||||
#include <array>
|
||||
#include "driver/gpio.h"
|
||||
#include "gpio_cxx.hpp"
|
||||
|
||||
namespace idf {
|
||||
|
||||
#define GPIO_CHECK_THROW(err) CHECK_THROW_SPECIFIC((err), GPIOException)
|
||||
|
||||
namespace {
|
||||
#if CONFIG_IDF_TARGET_LINUX
|
||||
constexpr std::array<uint32_t, 1> INVALID_GPIOS = {24};
|
||||
#elif CONFIG_IDF_TARGET_ESP32
|
||||
constexpr std::array<uint32_t, 1> INVALID_GPIOS = {24};
|
||||
#elif CONFIG_IDF_TARGET_ESP32S2
|
||||
constexpr std::array<uint32_t, 4> INVALID_GPIOS = {22, 23, 24, 25};
|
||||
#elif CONFIG_IDF_TARGET_ESP32S3
|
||||
constexpr std::array<uint32_t, 4> INVALID_GPIOS = {22, 23, 24, 25};
|
||||
#elif CONFIG_IDF_TARGET_ESP32C3
|
||||
constexpr std::array<uint32_t, 0> INVALID_GPIOS = {};
|
||||
#else
|
||||
#error "No GPIOs defined for the current target"
|
||||
#endif
|
||||
|
||||
gpio_num_t gpio_to_driver_type(const GPIONum &gpio_num)
|
||||
{
|
||||
return static_cast<gpio_num_t>(gpio_num.get_num());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
GPIOException::GPIOException(esp_err_t error) : ESPException(error) { }
|
||||
|
||||
esp_err_t check_gpio_pin_num(uint32_t pin_num) noexcept
|
||||
{
|
||||
if (pin_num >= GPIO_NUM_MAX) {
|
||||
return ESP_ERR_INVALID_ARG;
|
||||
}
|
||||
|
||||
for (auto num: INVALID_GPIOS)
|
||||
{
|
||||
if (pin_num == num) {
|
||||
return ESP_ERR_INVALID_ARG;
|
||||
}
|
||||
}
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t check_gpio_drive_strength(uint32_t strength) noexcept
|
||||
{
|
||||
if (strength >= GPIO_DRIVE_CAP_MAX) {
|
||||
return ESP_ERR_INVALID_ARG;
|
||||
}
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
GPIOPullMode GPIOPullMode::FLOATING()
|
||||
{
|
||||
return GPIOPullMode(GPIO_FLOATING);
|
||||
}
|
||||
|
||||
GPIOPullMode GPIOPullMode::PULLUP()
|
||||
{
|
||||
return GPIOPullMode(GPIO_PULLUP_ONLY);
|
||||
}
|
||||
|
||||
GPIOPullMode GPIOPullMode::PULLDOWN()
|
||||
{
|
||||
return GPIOPullMode(GPIO_PULLDOWN_ONLY);
|
||||
}
|
||||
|
||||
GPIOWakeupIntrType GPIOWakeupIntrType::LOW_LEVEL()
|
||||
{
|
||||
return GPIOWakeupIntrType(GPIO_INTR_LOW_LEVEL);
|
||||
}
|
||||
|
||||
GPIOWakeupIntrType GPIOWakeupIntrType::HIGH_LEVEL()
|
||||
{
|
||||
return GPIOWakeupIntrType(GPIO_INTR_HIGH_LEVEL);
|
||||
}
|
||||
|
||||
GPIODriveStrength GPIODriveStrength::DEFAULT()
|
||||
{
|
||||
return MEDIUM();
|
||||
}
|
||||
|
||||
GPIODriveStrength GPIODriveStrength::WEAK()
|
||||
{
|
||||
return GPIODriveStrength(GPIO_DRIVE_CAP_0);
|
||||
}
|
||||
|
||||
GPIODriveStrength GPIODriveStrength::LESS_WEAK()
|
||||
{
|
||||
return GPIODriveStrength(GPIO_DRIVE_CAP_1);
|
||||
}
|
||||
|
||||
GPIODriveStrength GPIODriveStrength::MEDIUM()
|
||||
{
|
||||
return GPIODriveStrength(GPIO_DRIVE_CAP_2);
|
||||
}
|
||||
|
||||
GPIODriveStrength GPIODriveStrength::STRONGEST()
|
||||
{
|
||||
return GPIODriveStrength(GPIO_DRIVE_CAP_3);
|
||||
}
|
||||
|
||||
GPIOBase::GPIOBase(GPIONum num) : gpio_num(num)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_reset_pin(gpio_to_driver_type(gpio_num)));
|
||||
}
|
||||
|
||||
void GPIOBase::hold_en()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_hold_en(gpio_to_driver_type(gpio_num)));
|
||||
}
|
||||
|
||||
void GPIOBase::hold_dis()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_hold_dis(gpio_to_driver_type(gpio_num)));
|
||||
}
|
||||
|
||||
void GPIOBase::set_drive_strength(GPIODriveStrength strength)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_drive_capability(gpio_to_driver_type(gpio_num),
|
||||
static_cast<gpio_drive_cap_t>(strength.get_strength())));
|
||||
}
|
||||
|
||||
GPIO_Output::GPIO_Output(GPIONum num) : GPIOBase(num)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_direction(gpio_to_driver_type(gpio_num), GPIO_MODE_OUTPUT));
|
||||
}
|
||||
|
||||
void GPIO_Output::set_high()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_level(gpio_to_driver_type(gpio_num), 1));
|
||||
}
|
||||
|
||||
void GPIO_Output::set_low()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_level(gpio_to_driver_type(gpio_num), 0));
|
||||
}
|
||||
|
||||
GPIODriveStrength GPIOBase::get_drive_strength()
|
||||
{
|
||||
gpio_drive_cap_t strength;
|
||||
GPIO_CHECK_THROW(gpio_get_drive_capability(gpio_to_driver_type(gpio_num), &strength));
|
||||
return GPIODriveStrength(static_cast<uint32_t>(strength));
|
||||
}
|
||||
|
||||
GPIOInput::GPIOInput(GPIONum num) : GPIOBase(num)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_direction(gpio_to_driver_type(gpio_num), GPIO_MODE_INPUT));
|
||||
}
|
||||
|
||||
GPIOLevel GPIOInput::get_level() const noexcept
|
||||
{
|
||||
int level = gpio_get_level(gpio_to_driver_type(gpio_num));
|
||||
if (level) {
|
||||
return GPIOLevel::HIGH;
|
||||
} else {
|
||||
return GPIOLevel::LOW;
|
||||
}
|
||||
}
|
||||
|
||||
void GPIOInput::set_pull_mode(GPIOPullMode mode)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_pull_mode(gpio_to_driver_type(gpio_num),
|
||||
static_cast<gpio_pull_mode_t>(mode.get_pull_mode())));
|
||||
}
|
||||
|
||||
void GPIOInput::wakeup_enable(GPIOWakeupIntrType interrupt_type)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_wakeup_enable(gpio_to_driver_type(gpio_num),
|
||||
static_cast<gpio_int_type_t>(interrupt_type.get_level())));
|
||||
}
|
||||
|
||||
void GPIOInput::wakeup_disable()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_wakeup_disable(gpio_to_driver_type(gpio_num)));
|
||||
}
|
||||
|
||||
GPIO_OpenDrain::GPIO_OpenDrain(GPIONum num) : GPIOInput(num)
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_direction(gpio_to_driver_type(gpio_num), GPIO_MODE_INPUT_OUTPUT_OD));
|
||||
}
|
||||
|
||||
void GPIO_OpenDrain::set_floating()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_level(gpio_to_driver_type(gpio_num), 1));
|
||||
}
|
||||
|
||||
void GPIO_OpenDrain::set_low()
|
||||
{
|
||||
GPIO_CHECK_THROW(gpio_set_level(gpio_to_driver_type(gpio_num), 0));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
#endif
|
Reference in New Issue
Block a user