HallSwitch::Hall_GPIO Class Reference

#include <hall-pal-gpio.hpp>

Inheritance diagram for HallSwitch::Hall_GPIO:

Public Types
Interrupt event
enum	IntEvent_t { INT_FALLING_EDGE = 0 , INT_RISING_EDGE = 1 }
Voltage level
enum	VLevel_t { GPIO_LOW = 0 , GPIO_HIGH = 1 }
Voltage logic
enum	VLogic_t { NEGATIVE = 1 , POSITIVE = 2 }

Public Member Functions
virtual HallSwitch::Error_t	init ()=0
	Initializes the GPIO.
virtual HallSwitch::Error_t	deinit ()=0
	Deinitializes the GPIO.
virtual HallSwitch::Error_t	enableInt (HallSwitch *ptr)=0
	Enables the hardware interrupt.
virtual HallSwitch::Error_t	disableInt ()=0
	Disables the hardware interrupt.
virtual IntEvent_t	intEvent ()=0
	Gets the latest interrupt event.
virtual VLevel_t	read ()=0
	Reads the GPIO voltage level.
virtual HallSwitch::Error_t	write (VLevel_t level)=0
	Writes the GPIO output voltage level.
virtual HallSwitch::Error_t	enable ()=0
	Enables the GPIO output according to the GPIO logic.
virtual HallSwitch::Error_t	disable ()=0
	Disables the GPIO output according to the GPIO logic.

Member Enumeration Documentation

IntEvent_t

enum HallSwitch::Hall_GPIO::IntEvent_t

Enumerator
INT_FALLING_EDGE	Interrupt on falling edge
INT_RISING_EDGE	Interrupt on rising edge

VLevel_t

enum HallSwitch::Hall_GPIO::VLevel_t

Enumerator
GPIO_LOW	Level low
GPIO_HIGH	Level high

VLogic_t

enum HallSwitch::Hall_GPIO::VLogic_t

Enumerator
NEGATIVE	Negative logic. 0 on voltage level high, 1 on voltage low
POSITIVE	Positive logic. 1 on voltage level high, 0 on voltage low

Member Function Documentation

init()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::init ( )

pure virtual

Initializes the GPIO.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if initialization error

Implemented in GPIOIno.

deinit()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::deinit ( )

pure virtual

Deinitializes the GPIO.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if deinitialization error

Implemented in GPIOIno.

enableInt()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::enableInt ( HallSwitch *  ptr )

pure virtual

Enables the hardware interrupt.

Parameters

[in]

*ptr

HallSwith object pointer which holds the interrupt

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if initialization error

Implemented in GPIOIno.

disableInt()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::disableInt ( )

pure virtual

Disables the hardware interrupt.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if disable error

Implemented in GPIOIno.

intEvent()

virtual IntEvent_t HallSwitch::Hall_GPIO::intEvent ( )

pure virtual

Gets the latest interrupt event.

Returns

GPIO interrupt event

Return values

INT_FALLING_EDGE	if falling edge event
INT_RISING_EDGE	if rising edge event

Implemented in GPIOIno.

read()

virtual VLevel_t HallSwitch::Hall_GPIO::read ( )

pure virtual

Reads the GPIO voltage level.

Returns

GPIO voltage level

Return values

GPIO_LOW	if voltage low
GPIO_HIGH	if voltage high

Implemented in GPIOIno.

write()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::write ( VLevel_t  level )

pure virtual

Writes the GPIO output voltage level.

Parameters

[in]

level

Voltage level

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if write error

Implemented in GPIOIno.

enable()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::enable ( )

pure virtual

Enables the GPIO output according to the GPIO logic.

• Low if negative
• High if positive

  Returns

  GPIO interrupt event

  Return values

  OK	if success
  INTF_ERROR	if write error

Implemented in GPIOIno.

disable()

virtual HallSwitch::Error_t HallSwitch::Hall_GPIO::disable ( )

pure virtual

Disables the GPIO output according to the GPIO logic.

• Low if positive
• High if negative

  Returns

  GPIO error code

  Return values

  OK	if success
  INTF_ERROR	if write error

Implemented in GPIOIno.

---

The documentation for this class was generated from the following file:

• hall-pal-gpio.hpp