Merge pull request #1 from Davang/feature/gpioClass

esp gpio class

Author: Davang

.gitignore

@@ -30,3 +30,9 @@
 *.exe
 *.out
 *.app
+
+# build
+build/
+
+# config
+sdkconfig*

README.md

@@ -1,2 +1,27 @@
 # esp-davang
-custom esp libraries
+
+Custom classes to wrap around esp-idf. The main idea is not make it faster neither lighter but try to use `c++` features to ease future implementations.
+For example compile checking validity of peripherals configurations. Improve memory safety like using `std::string` instead of `char*`.
+
+As with esp-idf an export script is given to ease its use. It exports two variables, `DAVANG_ESP` and `DAVANG_COMPONENT_DIRS`.
+
+* `DAVANG_ESP` : the path to the esp-davang directory base of the repository.
+* `DAVANG_COMPONENT_DIRS` : the path to the components directory base of the.
+
+I know writting a warp over an already HAL/BSP libary makes no sense, as for that reason you may use the existing one already.
+My classes remove some funciontality, will ad some overhead to the code, and not be as tested as esp-idf.
+So why did I do it? beacuase I do not use all the functionlay mos of the time, and run time errors are a pain in the ass.
+I used this classes for a few time, and they are helpfull to me, I hope they to you too.
+
+## Components
+
+This directory has all componets, each have a unique folder with _dvng_ as prefix this way they may nor result in conflict with any other component.
+Add `list(APPEND EXTRA_COMPONENT_DIRS "${DAVANG_COMPONENT_DIRS}")` to your project.
+
+## Examples
+
+Just what the name says it is, examples.
+
+---
+
+Davang

components/dvng_gpio/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(	SRCS "src/davang_gpio.cpp" 
+						INCLUDE_DIRS "inc"
+						REQUIRES driver )

components/dvng_gpio/inc/davang_gpio.hpp

@@ -0,0 +1,195 @@
+/*!
+ * \file	davang_gpio.hpp
+ * \details GPIO abstraction class declaration for ESP-IDF.
+ * \author	Davang
+ * \version	1.0.0
+ * \date	2023/09/25
+ * \copyright MIT License
+ */
+
+#ifndef ESP_DAVANG_COMPONENTS_DVNG_GPIO_DAVANG_GPIO_H
+#define ESP_DAVANG_COMPONENTS_DVNG_GPIO_DAVANG_GPIO_H
+
+/* C includes */
+#include <cstdint>
+
+/* C++ includes */
+#include <utility>
+
+/* 3rd party includes */
+#include "driver/gpio.h"
+#include "esp_err.h"
+
+/* custom includes*/
+
+
+
+/*! Specific davang namespace for gpio data types related. */
+namespace  dvng::gpio
+{
+
+/* data types */
+
+using pin_t = uint32_t;		/*! \brief data type representing   */
+using isr_t = gpio_isr_t;	/*! \brief data type representing   */
+
+/* isr_t functions are : static void IRAM_ATTR gpio_isr_handler(void* arg); */
+
+/* enumerators */
+
+enum class MODE : uint64_t
+{
+	INPUT = GPIO_MODE_INPUT,
+	OUTPUT = GPIO_MODE_OUTPUT,
+	OUTPUT_OPEN_DRAIN = GPIO_MODE_OUTPUT_OD,
+	TOTAL,
+};
+
+
+enum class PULL_UP : uint32_t
+{
+	NONE = GPIO_PULLUP_DISABLE,
+	ACTIVE = GPIO_PULLUP_ENABLE,
+	TOTAL,
+};
+
+enum class PULL_DOWN : uint32_t
+{
+	NONE = GPIO_PULLDOWN_DISABLE,
+	ACTIVE = GPIO_PULLDOWN_ENABLE,
+	TOTAL,
+};
+
+enum class GPIO_INTERRUPT : uint32_t
+{
+	NONE = GPIO_INTR_DISABLE,
+	RAISE = GPIO_INTR_POSEDGE,
+	FALL = GPIO_INTR_NEGEDGE,
+	EDGE = GPIO_INTR_ANYEDGE,
+	TOTAL,
+};
+
+enum class LEVEL : uint32_t
+{
+	LOW = 0,
+	HIGH = 1,
+};
+
+/* constants */
+
+/*!< Specific davang namespace for gpio data types related. */
+constexpr pin_t MAX_PIN = GPIO_PIN_COUNT;
+
+/* asssertion structures */
+template< gpio::pin_t T_PIN, gpio::MODE T_MODE, 
+	gpio::PULL_UP T_PULL_UP = gpio::PULL_UP::NONE,
+	gpio::PULL_DOWN T_PULL_DOWN = gpio::PULL_DOWN::NONE, 
+	gpio::GPIO_INTERRUPT T_INTERRUPT = gpio::GPIO_INTERRUPT::NONE >
+struct s_asserter
+{
+
+static constexpr uint64_t OUTPUT_MASK = SOC_GPIO_VALID_OUTPUT_GPIO_MASK;
+static constexpr uint64_t GPIO_MASK = SOC_GPIO_VALID_GPIO_MASK;
+
+static constexpr bool IS_OUTPUT_SUPPORTED = ( 0 != ( ( 1ULL << T_PIN ) & OUTPUT_MASK ) );
+static constexpr bool IS_MODE_OUTPUT = ( T_MODE == gpio::MODE::OUTPUT );
+static constexpr bool IS_MODE_INPUT = ( T_MODE == gpio::MODE::INPUT );
+
+static_assert( ( ( 0 <= T_PIN ) && ( 0 != ( ( 1ULL << T_PIN) & GPIO_MASK ) ) ), "Not a valid gpio pin number, gpio pin should be less than dvng::gpio::MAX_PIN" );
+
+static_assert( ( T_MODE < gpio::MODE::TOTAL ), "Gpio mode not supported" );
+
+static_assert( ( true == IS_MODE_INPUT ) || ( ( true == IS_MODE_OUTPUT ) && ( true == IS_OUTPUT_SUPPORTED ) ) , "Output mode not supported, this pin may only be an input" ); 
+
+static_assert( ( T_MODE < gpio::MODE::TOTAL ), "Gpio mode not supported" );
+static_assert( ( T_PULL_UP < gpio::PULL_UP::TOTAL ), "Gpio pull up not supported" );
+static_assert( ( T_PULL_DOWN < gpio::PULL_DOWN::TOTAL ), "Gpio pulldown not supported" );
+static_assert( ( T_INTERRUPT < gpio::GPIO_INTERRUPT::TOTAL ), "Gpio interrupt not supported" );
+
+
+
+};
+
+
+} /* namespace dvng::gpio */
+
+/*!< Generic davang namespace */
+namespace dvng
+{
+
+
+class c_gpio
+{
+/* constants */
+private:
+	const gpio_config_t m_gpio_config;
+
+/* data members */
+private:
+	gpio::LEVEL m_level;
+	gpio::pin_t m_pin;
+	const gpio::MODE m_mode;
+	const gpio::GPIO_INTERRUPT m_interrupt;
+
+/* constructors and destructor */
+public:
+
+c_gpio( ) = delete;
+
+c_gpio( const c_gpio & ) = delete;
+
+c_gpio( const c_gpio && ) = delete;
+
+/*!
+ * \ brief c_gpio constructor 
+ */
+template< gpio::pin_t T_PIN, gpio::MODE T_MODE, 
+	gpio::PULL_UP T_PULL_UP = gpio::PULL_UP::NONE,
+	gpio::PULL_DOWN T_PULL_DOWN = gpio::PULL_DOWN::NONE, 
+	gpio::GPIO_INTERRUPT T_INTERRUPT = gpio::GPIO_INTERRUPT::NONE >
+c_gpio( const gpio::s_asserter< T_PIN, T_MODE, T_PULL_UP, T_PULL_DOWN, T_INTERRUPT > ) :  m_gpio_config ( /* pin_bit_mask */ 1ULL << T_PIN,
+	/* mode */ static_cast< gpio_mode_t >( T_MODE ),
+	/* pull_up_en */ static_cast< gpio_pullup_t  >( T_PULL_UP ),
+	/* pull_down_en */ static_cast< gpio_pulldown_t  >( T_PULL_DOWN ),
+	/* intr_type */ static_cast< gpio_int_type_t  >( T_INTERRUPT ) ),
+	m_level ( gpio::LEVEL::LOW ),
+	m_pin ( T_PIN ),
+	m_mode ( T_MODE ),
+	m_interrupt ( T_INTERRUPT )	
+{
+
+}
+
+
+virtual ~c_gpio( );
+
+
+/* methods */
+public:	
+	
+	[[nodiscard("Always ensure valid pin initialization")]]
+	int init( );
+
+	int deinit( );
+
+	[[nodiscard("Why get the level of a pin if not using it?")]]
+	gpio::LEVEL get_level( );
+
+	int set_level( const gpio::LEVEL & t_level );
+	
+	int set_high( ) ;
+	
+	int set_low( );
+	
+	int toggle( );
+	
+	[[nodiscard("Always ensure correct isr registration ")]]
+	int register_isr( gpio::isr_t t_isr, void * t_arguments );
+
+
+};
+
+
+} /* namespace dvng */
+
+#endif /* ESP_DAVANG_COMPONENTS_DVNG_GPIO_DAVANG_GPIO_H */

components/dvng_gpio/src/davang_gpio.cpp

@@ -0,0 +1,110 @@
+/*!
+ * \file	davang_gpio.cpp
+ * \details GPIO abstraction class declaration for ESP-IDF, adds c++ checks at compile time.
+ * \author	Davang
+ * \version	1.0.0
+ * \date	09/06/2024
+ * \copyright MIT License
+ */
+
+/* custom includes*/
+#include "davang_gpio.hpp"
+
+
+namespace dvng
+{
+
+c_gpio::~c_gpio( )
+{
+	// do nothing you are responsible of deinitialize the pin
+}
+
+int c_gpio::deinit( )
+{
+	return  gpio_reset_pin( static_cast< gpio_num_t >( m_pin ) );
+}
+
+int c_gpio::init( )
+{
+	return  gpio_config( &m_gpio_config );
+}
+
+gpio::LEVEL c_gpio::get_level( )
+{
+	return  static_cast< gpio::LEVEL >( gpio_get_level( static_cast< gpio_num_t >( m_pin ) ) );
+}
+
+int c_gpio::set_level( const gpio::LEVEL & t_level )
+{
+	int error = ESP_OK;
+	
+	if ( gpio::MODE::OUTPUT == m_mode )
+	{
+		error = gpio_set_level( static_cast< gpio_num_t >( m_pin ), std::to_underlying( m_level ) );
+		if( ESP_OK == error )
+		{
+			m_level = t_level;
+		}
+	}
+	else
+	{
+		error = ESP_ERR_NOT_SUPPORTED;
+	}
+
+	return error;
+}
+
+int c_gpio::set_high( )
+{
+	return set_level( gpio::LEVEL::HIGH );
+}
+
+int c_gpio::set_low( )
+{
+	return set_level( gpio::LEVEL::LOW );
+}
+
+int c_gpio::toggle( )
+{
+	if( gpio::LEVEL::LOW == m_level )
+	{
+		return set_high( );
+	}
+	else
+	{
+		return set_low( );	
+	}
+}
+
+int c_gpio::register_isr( gpio::isr_t t_isr, void * t_arguments )
+{
+	if ( gpio::GPIO_INTERRUPT::NONE == m_interrupt )
+	{
+		return ESP_ERR_NOT_SUPPORTED;
+	}
+	else
+	{			
+		esp_err_t error = gpio_set_intr_type(static_cast< gpio_num_t >( m_pin ), static_cast< gpio_int_type_t >( m_interrupt ));
+		
+		if( ESP_OK == error )
+		{
+			error = gpio_install_isr_service( ESP_INTR_FLAG_EDGE | ESP_INTR_FLAG_IRAM | ESP_INTR_FLAG_LOWMED );
+		}
+		
+		if( ESP_OK == error )
+		{
+			error = gpio_isr_handler_add( static_cast< gpio_num_t >( m_pin ), t_isr, t_arguments );
+		}
+
+		if( ESP_OK != error )
+		{
+			error = gpio_isr_handler_remove( static_cast< gpio_num_t >( m_pin ) );
+			gpio_uninstall_isr_service( );
+		}
+
+		
+		return error;
+	}
+}
+
+}

examples/dvng_gpio/CMakeLists.txt

@@ -0,0 +1,9 @@
+cmake_minimum_required(VERSION 3.16)
+
+set(EXTRA_COMPONENT_DIRS $ENV{DAVANG_COMPONENT_DIRS})
+
+set(COMPONENTS main)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+project( davang_blink )

examples/dvng_gpio/main/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "davang_blink.cpp"
+                       INCLUDE_DIRS "."
+                       REQUIRES dvng_gpio freertos )