LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
BOARD: Common board functions

Macros

#define DEBUGINIT()
 
#define DEBUGOUT(...)
 
#define DEBUGSTR(str)
 
#define DEBUGIN()   (int) EOF
 

Typedefs

typedef void(* p_msDelay_func_t )(uint32_t)
 Function prototype for a MS delay function. Board layers or example code may define this function as needed.
 

Functions

void Board_Init (void)
 Set up and initialize all required blocks and functions related to the board hardware.
 
void Board_Debug_Init (void)
 Initializes board UART for output, required for printf redirection.
 
void Board_UARTPutChar (char ch)
 Sends a single character on the UART, required for printf redirection.
 
int Board_UARTGetChar (void)
 Get a single character from the UART, required for scanf input.
 
void Board_UARTPutSTR (char *str)
 Prints a string to the UART.
 
void Board_LED_Init (void)
 Initializes board LED(s)
 
void Board_LED_Set (uint8_t LEDNumber, bool State)
 Sets the state of a board LED to on or off.
 
bool Board_LED_Test (uint8_t LEDNumber)
 Returns the current state of a board LED.
 
STATIC INLINE void Board_LED_Toggle (uint8_t LEDNumber)
 Toggles the current state of a board LED.
 
void SystemCoreClockUpdate (void)
 Update system core clock rate, should be called if the system has a clock rate change.
 
void Board_LCD_Set_Backlight (uint8_t Intensity)
 Turn on Board LCD Backlight.
 

Variables

uint32_t SystemCoreClock
 Current system clock rate, mainly used for sysTick.
 
uint16_t UDA_sys_regs_dat []
 
uint16_t UDA_interfil_regs_dat []
 
uint16_t UDA_decimator_regs_dat []
 
void Board_UART_Init (LPC_USART_Type *UARTx)
 Initialize pin muxing for a UART.
 
void Board_Buttons_Init (void)
 Initialize button(s) interface on board.
 
uint32_t Buttons_GetStatus (void)
 Returns button(s) state on board.
 
void Board_Joystick_Init (void)
 Initialize joystick interface on board.
 
uint8_t Joystick_GetStatus (void)
 Returns joystick states on board.
 
void Board_ENET_GetMacADDR (uint8_t *mcaddr)
 Returns the MAC address assigned to this board.
 
void Board_I2C_Init (LPC_I2C_Type *I2Cx)
 Sets up board specific I2C interface.
 
void GPIO0_IRQHandler (void)
 
void Board_GPIO_Int_Init ()
 Initializes board specific GPIO Interrupt.
 
void Board_SDMMC_Init (void)
 Initialize pin muxing for SDMMC interface.
 
void Board_SSP_Init (LPC_SSP_Type *SSPx)
 Initialize pin muxing for SSP interface.
 
static void delay (uint32_t i)
 
static void UDA_Reg_write (UDA1380_REG reg, unsigned short value, I2C_M_SETUP_Type *I2C_Config)
 
static uint16_t UDA_Reg_read (UDA1380_REG reg)
 
static Status UDA1380_init (I2C_M_SETUP_Type *I2C_Config, Board_Audio_Input_Sel_Type audio_in_sel)
 
void Board_Audio_Init (LPC_I2S_Type *I2Sx, Board_Audio_Input_Sel_Type audio_in_sel)
 Initialize I2S interface for the board and UDA1380.
 
void Serial_CreateStream (void *Stream)
 FIXME.
 

Detailed Description

This file contains common board definitions that are shared across boards and devices. All of these functions do not need to be impemented for a specific board, but if they are implemented, they should use this API standard.

Macro Definition Documentation

#define DEBUGIN ( )    (int) EOF

Definition at line 165 of file board_api.h.

#define DEBUGINIT ( )

Definition at line 162 of file board_api.h.

#define DEBUGOUT (   ...)

Definition at line 163 of file board_api.h.

#define DEBUGSTR (   str)

Definition at line 164 of file board_api.h.

Typedef Documentation

typedef void(* p_msDelay_func_t)(uint32_t)

Function prototype for a MS delay function. Board layers or example code may define this function as needed.

Definition at line 142 of file board_api.h.

Function Documentation

void Board_Audio_Init ( LPC_I2S_Type I2Sx,
Board_Audio_Input_Sel_Type  audio_in_sel 
)

Initialize I2S interface for the board and UDA1380.

Sets up board specific I2S interface and UDA1380.

Parameters
I2Sx: Pointer to I2S register interface used on this board
audio_in_sel: Audio input selection
Returns
Nothing

Definition at line 350 of file board_ngx_xplorer_18304330.c.

void Board_Buttons_Init ( void  )

Initialize button(s) interface on board.

Initializes board specific buttons.

Returns
Nothing

Definition at line 130 of file board_ngx_xplorer_18304330.c.

void Board_Debug_Init ( void  )

Initializes board UART for output, required for printf redirection.

Returns
None

Definition at line 501 of file board_hitex_eva_18504350.c.

void Board_ENET_GetMacADDR ( uint8_t *  mcaddr)

Returns the MAC address assigned to this board.

Parameters
mcaddr: Pointer to 6-byte character array to populate with MAC address
Returns
Nothing

Definition at line 165 of file board_ngx_xplorer_18304330.c.

void Board_GPIO_Int_Init ( void  )

Initializes board specific GPIO Interrupt.

Returns
Nothing

Definition at line 213 of file board_ngx_xplorer_18304330.c.

void Board_I2C_Init ( LPC_I2C_Type I2Cx)

Sets up board specific I2C interface.

Parameters
I2Cx: Pointer to I2C interface to initialize
Returns
Nothing

Definition at line 193 of file board_ngx_xplorer_18304330.c.

void Board_Init ( void  )

Set up and initialize all required blocks and functions related to the board hardware.

Returns
None

Definition at line 638 of file board_hitex_eva_18504350.c.

void Board_Joystick_Init ( void  )

Initialize joystick interface on board.

Initializes board specific joystick.

Returns
Nothing

Definition at line 145 of file board_ngx_xplorer_18304330.c.

void Board_LCD_Set_Backlight ( uint8_t  Intensity)

Turn on Board LCD Backlight.

Parameters
Intensity: Backlight intensity (0 = off, >=1 = on)
Returns
None On boards where a GPIO is used to control backlight on/off state, a '0' or '1' value will turn off or on the backlight. On some boards, a non-0 value will control backlight intensity via a PWN. For PWM systems, the intensity value is a percentage value between 0 and 100%.

Definition at line 802 of file board_hitex_eva_18504350.c.

void Board_LED_Init ( void  )

Initializes board LED(s)

Returns
None

Definition at line 547 of file board_hitex_eva_18504350.c.

void Board_LED_Set ( uint8_t  LEDNumber,
bool  State 
)

Sets the state of a board LED to on or off.

Parameters
LEDNumber: LED number to set state for
State: true for on, false for off
Returns
None

Definition at line 560 of file board_hitex_eva_18504350.c.

bool Board_LED_Test ( uint8_t  LEDNumber)

Returns the current state of a board LED.

Parameters
LEDNumber: LED number to set state for
Returns
true if the LED is on, otherwise false

Definition at line 573 of file board_hitex_eva_18504350.c.

STATIC INLINE void Board_LED_Toggle ( uint8_t  LEDNumber)

Toggles the current state of a board LED.

Parameters
LEDNumber: LED number to change state for
Returns
None

Definition at line 109 of file board_api.h.

void Board_SDMMC_Init ( void  )

Initialize pin muxing for SDMMC interface.

Sets up board specific SDMMC interface.

Returns
Nothing

Definition at line 223 of file board_ngx_xplorer_18304330.c.

void Board_SSP_Init ( LPC_SSP_Type SSPx)

Initialize pin muxing for SSP interface.

Sets up board specific SSP interface.

Parameters
SSPx: Pointer to SSP interface to initialize
Returns
Nothing

Definition at line 234 of file board_ngx_xplorer_18304330.c.

void Board_UART_Init ( LPC_USART_Type UARTx)

Initialize pin muxing for a UART.

Parameters
UARTx: Pointer to UART register block for UART pins to init
Returns
Nothing

Definition at line 37 of file board_ngx_xplorer_18304330.c.

int Board_UARTGetChar ( void  )

Get a single character from the UART, required for scanf input.

Returns
EOF if not character was received, or character value

Definition at line 524 of file board_hitex_eva_18504350.c.

void Board_UARTPutChar ( char  ch)

Sends a single character on the UART, required for printf redirection.

Parameters
ch: character to send
Returns
None

Definition at line 516 of file board_hitex_eva_18504350.c.

void Board_UARTPutSTR ( char *  str)

Prints a string to the UART.

Parameters
str: Terminated string to output
Returns
None

Definition at line 537 of file board_hitex_eva_18504350.c.

uint32_t Buttons_GetStatus ( void  )

Returns button(s) state on board.

Returns
Returns BUTTONS_BUTTON1 if button1 is pressed

Definition at line 136 of file board_ngx_xplorer_18304330.c.

static void delay ( uint32_t  i)
static

Definition at line 275 of file board_ngx_xplorer_18304330.c.

void GPIO0_IRQHandler ( void  )

Definition at line 202 of file board_ngx_xplorer_18304330.c.

uint8_t Joystick_GetStatus ( void  )

Returns joystick states on board.

Initialize joystick interface on board.

System Clock Frequency (Core Clock)

Definition at line 148 of file board_ngx_xplorer_18304330.c.

void Serial_CreateStream ( void *  Stream)

FIXME.

Parameters
Stream: FIXME
Returns
Nothing

Definition at line 380 of file board_ngx_xplorer_18304330.c.

void SystemCoreClockUpdate ( void  )

Update system core clock rate, should be called if the system has a clock rate change.

Returns
None

Definition at line 622 of file board_hitex_eva_18504350.c.

static Status UDA1380_init ( I2C_M_SETUP_Type I2C_Config,
Board_Audio_Input_Sel_Type  audio_in_sel 
)
static

Definition at line 294 of file board_ngx_xplorer_18304330.c.

static uint16_t UDA_Reg_read ( UDA1380_REG  reg)
static

Definition at line 288 of file board_ngx_xplorer_18304330.c.

static void UDA_Reg_write ( UDA1380_REG  reg,
unsigned short  value,
I2C_M_SETUP_Type I2C_Config 
)
static

Definition at line 279 of file board_ngx_xplorer_18304330.c.

Variable Documentation

uint32_t SystemCoreClock

Current system clock rate, mainly used for sysTick.

System Clock Frequency (Core Clock)

< System Clock Frequency (Core Clock)

Definition at line 618 of file board_hitex_eva_18504350.c.