LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
board_api.h
Go to the documentation of this file.
1 /*
2  * @brief Common board API functions
3  *
4  * @note
5  * Copyright(C) NXP Semiconductors, 2012
6  * All rights reserved.
7  *
8  * @par
9  * Software that is described herein is for illustrative purposes only
10  * which provides customers with programming information regarding the
11  * LPC products. This software is supplied "AS IS" without any warranties of
12  * any kind, and NXP Semiconductors and its licensor disclaim any and
13  * all warranties, express or implied, including all implied warranties of
14  * merchantability, fitness for a particular purpose and non-infringement of
15  * intellectual property rights. NXP Semiconductors assumes no responsibility
16  * or liability for the use of the software, conveys no license or rights under any
17  * patent, copyright, mask work right, or any other intellectual property rights in
18  * or to any products. NXP Semiconductors reserves the right to make changes
19  * in the software without notification. NXP Semiconductors also makes no
20  * representation or warranty that such application will be suitable for the
21  * specified use without further testing or modification.
22  *
23  * @par
24  * Permission to use, copy, modify, and distribute this software and its
25  * documentation is hereby granted, under NXP Semiconductors' and its
26  * licensor's relevant copyrights in the software, without fee, provided that it
27  * is used in conjunction with NXP Semiconductors microcontrollers. This
28  * copyright, permission, and disclaimer notice must appear in all copies of
29  * this code.
30  */
31 
32 #ifndef __BOARD_API_H_
33 #define __BOARD_API_H_
34 
35 #include "lpc_types.h"
36 #include <stdio.h>
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
55 void Board_Init(void);
56 
61 void Board_Debug_Init(void);
62 
68 void Board_UARTPutChar(char ch);
69 
74 int Board_UARTGetChar(void);
75 
81 void Board_UARTPutSTR(char *str);
82 
87 void Board_LED_Init(void);
88 
95 void Board_LED_Set(uint8_t LEDNumber, bool State);
96 
102 bool Board_LED_Test(uint8_t LEDNumber);
103 
109 STATIC INLINE void Board_LED_Toggle(uint8_t LEDNumber)
110 {
111  Board_LED_Set(LEDNumber, !Board_LED_Test(LEDNumber));
112 }
113 
114 
119 
125 void SystemCoreClockUpdate(void);
126 
136 void Board_LCD_Set_Backlight(uint8_t Intensity);
137 
142 typedef void (*p_msDelay_func_t)(uint32_t);
143 
144 /* The DEBUG* functions are selected based on system configuration.
145  Code that uses the DEBUG* functions will have their I/O routed to
146  the UART, semihosting, or nowhere. */
147 #if defined(DEBUG)
148 #if defined(DEBUG_SEMIHOSTING)
149 #define DEBUGINIT()
150 #define DEBUGOUT(...) printf(__VA_ARGS__)
151 #define DEBUGSTR(str) printf(str)
152 #define DEBUGIN() (int) EOF
153 
154 #else
155 #define DEBUGINIT() Board_Debug_Init()
156 #define DEBUGOUT(...) printf(__VA_ARGS__)
157 #define DEBUGSTR(str) Board_UARTPutSTR(str)
158 #define DEBUGIN() Board_UARTGetChar()
159 #endif /* defined(DEBUG_SEMIHOSTING) */
160 
161 #else
162 #define DEBUGINIT()
163 #define DEBUGOUT(...)
164 #define DEBUGSTR(str)
165 #define DEBUGIN() (int) EOF
166 #endif /* defined(DEBUG) */
167 
172 #ifdef __cplusplus
173 }
174 #endif
175 
176 #endif /* __BOARD_API_H_ */