Hal.h File Reference

Detailed Description

This file defines a hardware abstraction layer (HAL) for accessing a digital Input that is being used for a button.

NOTE: The HAL layer is defined 'just-in-time', i.e. when adding a new driver/functionality and new HAL supported is needed - then this interface is updated.

NOTE: NO 'Initialization' method is provided/defined in this interface - this is intentional! The initialization left to the target's platform specific code and/or BSP. The application is RESPONSIBLE for making sure that the platform specific initialization happens BEFORE any of the drivers are started/used.

#include "colony_map.h"

Include dependency graph for Hal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	Driver_Button_Hal_T   Driver_Button_Pin_Hal_T_MAP
	This data type defines the platform specific 'handle' to a pin.
#define	Driver_Button_Hal_getRawPressedState   Driver_Button_Hal_getRawPressedState_MAP
	This method returns the current/raw state of pin.

Macro Definition Documentation

Driver_Button_Hal_getRawPressedState

#define Driver_Button_Hal_getRawPressedState   Driver_Button_Hal_getRawPressedState_MAP

This method returns the current/raw state of pin.

A true value indicates the button is in its 'Pressed' state; else it is in the 'Un-Pressed' state.

Prototype: bool Driver_Button_Hal_getRawPressedState( Driver_Button_Hal_T hdl );

Driver_Button_Hal_T

#define Driver_Button_Hal_T   Driver_Button_Pin_Hal_T_MAP

This data type defines the platform specific 'handle' to a pin.