ESOS32
ESOSOn32-bitProcessors
esos_hwxxxx_sui.c
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 
28 
34 // Documentation for this file. If the \file tag isn't present,
35 // this file won't be documented.
42 /*** I N C L U D E S *************************************************/
43 #include "esos_hwxxx_sui.h"
44 
45 /*** G L O B A L S *************************************************/
46 
47 /*** T H E C O D E *************************************************/
48 
49 /*********************************************************
50  * Public functions intended to be called by other files *
51  *********************************************************/
52 
65 void esos_hw_sui_configLED( ESOS_SUI_LED_HANDLE h_led ) {
66  // HW Code goes here
67 }
68 
69 
83 void esos_hw_sui_turnLEDOn( ESOS_SUI_LED_HANDLE h_led ) {
84  // HW code to turn on LED denoted by handle u8_i goes here
85 }
86 
87 
100 void esos_hw_sui_turnLEDOff( ESOS_SUI_LED_HANDLE h_led ) {
101  // HW code to turn off LED denoted by handle u8_i goes here
102 }
103 
116 void esos_hw_sui_configSwitch( ESOS_SUI_SWITCH_HANDLE h_sw ) {
117  // HW code goes here
118 }
119 
132 BOOL esos_hw_sui_isSwitchPressed(ESOS_SUI_SWITCH_HANDLE h_sw) {
133  // HW code goes here
134 }
135 
148 BOOL esos_hw_sui_isSwitchReleased(ESOS_SUI_SWITCH_HANDLE h_sw){
149  // HW code goes here
150 }
151 
152 
esos_hw_sui_isSwitchPressed
BOOL esos_hw_sui_isSwitchPressed(ESOS_SUI_SWITCH_HANDLE h_sw)
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_sw)
Definition: esos_hwxxxx_sui.c:116
esos_hwxxx_sui.h
This file contains macros, prototypes, and definitions for the HWXXX architecture specific simple use...
esos_hw_sui_isSwitchReleased
BOOL esos_hw_sui_isSwitchReleased(ESOS_SUI_SWITCH_HANDLE h_sw)
Definition: esos_hwxxxx_sui.c:148
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