ESOS32
ESOSOn32-bitProcessors
esos_hwxxx_sui.h
Go to the documentation of this file.
1 /*
2  * "Copyright (c) 2019 J. W. Bruce ("AUTHOR(S)")"
3  * All rights reserved.
4  * (J. W. Bruce, jwbruce_AT_tntech.edu, Tennessee Tech University)
5  *
6  * Permission to use, copy, modify, and distribute this software and its
7  * documentation for any purpose, without fee, and without written agreement is
8  * hereby granted, provided that the above copyright notice, the following
9  * two paragraphs and the authors appear in all copies of this software.
10  *
11  * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
12  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
13  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
14  * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15  *
16  * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
17  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
18  * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
19  * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
20  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
21  *
22  * Please maintain this header in its entirety when copying/modifying
23  * these files.
24  *
25  *
26  */
27 
33 #ifndef _ESOS_HWXXX_SUI_H
34 #define _ESOS_HWXXX_SUI_H
35 
36 /* I N C L U D E S **********************************************************/
37 #include "esos.h"
38 #include "esos_sui.h"
39 #include "esos_hwxxx.h"
40 
41 /* D E F I N I T I O N S ****************************************************/
42 
43 /* E X T E R N S ************************************************************/
44 
45 /* M A C R O S **************************************************************/
46 
47 /* P U B L I C P R O T O T Y P E S *****************************************/
48 void esos_hw_sui_configLED( ESOS_SUI_LED_HANDLE h_LED );
49 void esos_hw_sui_turnLEDOn( ESOS_SUI_LED_HANDLE h_LED ) ;
50 void esos_hw_sui_turnLEDOff( ESOS_SUI_LED_HANDLE h_LED );
51 void esos_hw_sui_configSwitch( ESOS_SUI_SWITCH_HANDLE h_Switch );
52 BOOL esos_hw_sui_isSwitchPressed(ESOS_SUI_SWITCH_HANDLE h_Switch);
53 BOOL esos_hw_sui_isSwitchReleased(ESOS_SUI_SWITCH_HANDLE h_Switch);
54 
55 // Documentation for this file. If the \file tag isn't present,
56 // this file won't be documented.
63 /* ########################################################################### */
64 
65 
66 #endif // end _ESOS_HWXXX_SUI_H
esos_hw_sui_isSwitchPressed
BOOL esos_hw_sui_isSwitchPressed(ESOS_SUI_SWITCH_HANDLE h_Switch)
Definition: esos_hwxxxx_sui.c:132
esos_hw_sui_turnLEDOff
void esos_hw_sui_turnLEDOff(ESOS_SUI_LED_HANDLE h_LED)
Definition: esos_hwxxxx_sui.c:100
esos_hw_sui_configSwitch
void esos_hw_sui_configSwitch(ESOS_SUI_SWITCH_HANDLE h_Switch)
Definition: esos_hwxxxx_sui.c:116
esos_hwxxx.h
This is the master include file template for the target hardware (hwxxxx)
esos_hw_sui_isSwitchReleased
BOOL esos_hw_sui_isSwitchReleased(ESOS_SUI_SWITCH_HANDLE h_Switch)
Definition: esos_hwxxxx_sui.c:148
esos.h
BOOL
enum _BOOL BOOL
esos_hw_sui_turnLEDOn
void esos_hw_sui_turnLEDOn(ESOS_SUI_LED_HANDLE h_LED)
Definition: esos_hwxxxx_sui.c:83
esos_hw_sui_configLED
void esos_hw_sui_configLED(ESOS_SUI_LED_HANDLE h_LED)
Definition: esos_hwxxxx_sui.c:65