GPIO_in.h

/*!\file GPIO_in.h
** \author SMFSW
** \copyright MIT (c) 2017-2024, SMFSW
** \brief GPIO input handling
**/
/****************************************************************/
#ifndef __GPIO_IN_H
	#define __GPIO_IN_H

#ifdef __cplusplus
	extern "C" {
#endif

#include "sarmfsw.h"
#include "Logic_in.h"

#if defined(HAL_GPIO_MODULE_ENABLED)
/****************************************************************/


// *****************************************************************************
// Section: Types
// *****************************************************************************
typedef Logic_in	GPIO_in;	//!< GPIO_in typedef alias of \ref Logic_in


// *****************************************************************************
// Section: Interface Routines
// *****************************************************************************
/*!\brief Get GPIO_in input value
** \param[in] in - GPIO_in instance
** \return Input value
**/
__INLINE bool NONNULL_INLINE__ get_GPIO_in(const GPIO_in * const in) {
	return get_Logic_in(in); }


/*!\brief Get GPIO_in input edge
** \param[in] in - GPIO_in instance
** \return Input edge
**/
__INLINE eEdge NONNULL_INLINE__ get_GPIO_in_edge(const GPIO_in * const in) {
	return get_Logic_in_edge(in); }


/*!\brief Initialize GPIO_in instance
** \param[in,out] in - GPIO_in instance to initialize
** \param[in] GPIOx - port to read from
** \param[in] GPIO_Pin - pin to read from
** \param[in] polarity - set to \ref GPIO_PIN_RESET if active state is GND, \ref GPIO_PIN_SET if Vdd
** \param[in] filter - input filtering time
** \param[in] onSet - Pointer to callback ON function
** \param[in] onReset - Pointer to callback OFF function
** \param[in] repeat - To repeat callback ON as long as input is set
**/
void NONNULLX__(1, 2) GPIO_in_init(	GPIO_in * const in,
									GPIO_TypeDef * const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState polarity, const uint16_t filter,
									void (*onSet)(const GPIO_in * const), void (*onReset)(const GPIO_in * const), const bool repeat);


/*!\brief Handles GPIO_in read and treatment
** \param[in,out] in - GPIO_in instance to handle
**/
__INLINE void NONNULL_INLINE__ GPIO_in_handler(GPIO_in * const in) {
	Logic_in_handler(in); }


/****************************************************************/
#ifdef __cplusplus
	}
#endif

#endif	/* defined(HAL_GPIO_MODULE_ENABLED) */
#endif	/* __GPIO_IN_H */
/****************************************************************/