245 lines
9.3 KiB
C
245 lines
9.3 KiB
C
/****************************************************************************
|
|
* configs/ubw32/include/board.h
|
|
* include/arch/board/board.h
|
|
*
|
|
* Copyright (C) 2012 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __CONFIGS_UBW32_INCLUDE_BOARD_H
|
|
#define __CONFIGS_UBW32_INCLUDE_BOARD_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-Processor Definitions
|
|
****************************************************************************/
|
|
/* Configuration ************************************************************/
|
|
|
|
/* Clocking *****************************************************************/
|
|
/* Crystal frequencies */
|
|
|
|
#define BOARD_POSC_FREQ 8000000 /* Primary OSC XTAL frequency (8MHz) */
|
|
#define BOARD_SOSC_FREQ 32768 /* Secondary OSC XTAL frequency (32.768KHz)
|
|
* (Not present on my board) */
|
|
|
|
/* Oscillator modes */
|
|
|
|
#define BOARD_FNOSC_POSCPLL 1 /* Use primary oscillator w/PLL */
|
|
#define BOARD_POSC_HSMODE 1 /* High-speed crystal (HS) mode */
|
|
|
|
/* PLL configuration and resulting CPU clock.
|
|
* CPU_CLOCK = ((POSC_FREQ / IDIV) * MULT) / ODIV
|
|
*/
|
|
|
|
#define BOARD_PLL_INPUT BOARD_POSC_FREQ
|
|
#define BOARD_PLL_IDIV 2 /* PLL input divider */
|
|
#define BOARD_PLL_MULT 20 /* PLL multiplier */
|
|
#define BOARD_PLL_ODIV 1 /* PLL output divider */
|
|
|
|
#define BOARD_CPU_CLOCK 80000000 /* CPU clock (80MHz = 8MHz * 20 / 2) */
|
|
|
|
/* USB PLL configuration.
|
|
* USB_CLOCK = ((POSC_XTAL / IDIV) * 24) / 2
|
|
*/
|
|
|
|
#define BOARD_UPLL_IDIV 2 /* USB PLL divider (revisit) */
|
|
#define BOARD_USB_CLOCK 48000000 /* USB clock (8MHz / 2) * 24 / 2) */
|
|
|
|
/* Peripheral clock is divided down from CPU clock.
|
|
* PBCLOCK = CPU_CLOCK / PBDIV
|
|
*/
|
|
|
|
#define BOARD_PBDIV 2 /* Peripheral clock divisor (PBDIV) */
|
|
#define BOARD_PBCLOCK 40000000 /* Peripheral clock (PBCLK = 80MHz/2) */
|
|
|
|
/* Watchdog pre-scaler (re-visit) */
|
|
|
|
#define BOARD_WD_ENABLE 0 /* Watchdog is disabled */
|
|
#define BOARD_WD_PRESCALER 8 /* Watchdog pre-scaler */
|
|
|
|
/* LED definitions **********************************************************/
|
|
/* ----- ----- -------------------------------------------------------------
|
|
* LABEL COLOR CONTROL
|
|
* ----- ----- -------------------------------------------------------------
|
|
* USB Green RF3. This could be used by software if USB is not used.
|
|
* Otherwise, RF3 is used as the USBID signal.
|
|
* LED1 While RE2, Pulled up. Low value illuminates
|
|
* LED2 Red RE1, Pulled up. Low value illuminates
|
|
* LED3 Yellow RE0, Pulled up. Low value illuminates
|
|
* PWR Blue Illuminated when 5V is present, not controlled by software
|
|
*/
|
|
|
|
/* LED index values for use with pic32mx_setled() */
|
|
|
|
#define PIC32MX_UBW32_LED1 0
|
|
#define PIC32MX_UBW32_LED2 1
|
|
#define PIC32MX_UBW32_LED3 2
|
|
#define PIC32MX_UBW32_NLEDS 3
|
|
|
|
/* LED bits for use with pic32mx_setleds() */
|
|
|
|
#define PIC32MX_UBW32_LED1_BIT (1 << PIC32MX_UBW32_LED1)
|
|
#define PIC32MX_UBW32_LED2_BIT (1 << PIC32MX_UBW32_LED2)
|
|
#define PIC32MX_UBW32_LED3_BIT (1 << PIC32MX_UBW32_LED3)
|
|
|
|
/* If CONFIG_ARCH_LEDS is defined, then NuttX will control these LEDs as follows:
|
|
*
|
|
* ON OFF
|
|
* ------------------------- ---- ---- ---- ---- ---- ----
|
|
* LED1 LED2 LED3 LED1 LED2 LED3
|
|
* ------------------------- ---- ---- ---- ---- ---- ----
|
|
* LED_STARTED 0 OFF OFF OFF --- --- ---
|
|
* LED_HEAPALLOCATE 1 ON OFF N/C --- --- ---
|
|
* LED_IRQSENABLED 2 OFF ON N/C --- --- ---
|
|
* LED_STACKCREATED 3 ON ON N/C --- --- ---
|
|
* LED_INIRQ 4 N/C N/C ON N/C N/C OFF
|
|
* LED_SIGNAL 4 N/C N/C ON N/C N/C OFF
|
|
* LED_ASSERTION 4 N/C N/C ON N/C N/C OFF
|
|
* LED_PANIC 5 ON N/C N/C OFF N/C N/C
|
|
*/
|
|
|
|
#define LED_STARTED 0
|
|
#define LED_HEAPALLOCATE 1
|
|
#define LED_IRQSENABLED 2
|
|
#define LED_STACKCREATED 3
|
|
#define LED_INIRQ 4
|
|
#define LED_SIGNAL 4
|
|
#define LED_ASSERTION 4
|
|
#define LED_PANIC 5
|
|
|
|
#define LED_NVALUES 6
|
|
|
|
/* The UBW32 board has three buttons.
|
|
*
|
|
* PROGRAM RE7 Pulled high, Grounded/low when depressed
|
|
* USER RE6 Pulled high, Grounded/low when depressed
|
|
* RESET Not software accessible
|
|
*/
|
|
|
|
#define BUTTON_PROGRAM 0
|
|
#define BUTTON_USER 1
|
|
#define NUM_BUTTONS 2
|
|
|
|
#define BUTTON_PROGRAM_BIT (1 << BUTTON_PROGRAM)
|
|
#define BUTTON_USER_BIT (1 << BUTTON_USER)
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
/****************************************************************************
|
|
* Inline Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C" {
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: pic32mx_ledinit and pic32mx_setled
|
|
*
|
|
* Description:
|
|
* If CONFIG_ARCH_LEDS is defined, then NuttX will control the on-board
|
|
* LEDs. If CONFIG_ARCH_LEDS is not defined, then the following interfaces
|
|
* are available to control the LEDs from user applicaitons.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_ARCH_LEDS
|
|
EXTERN void pic32mx_ledinit(void);
|
|
#endif
|
|
|
|
#ifndef CONFIG_ARCH_LEDS
|
|
EXTERN void pic32mx_setled(int led, bool ledon);
|
|
#endif
|
|
|
|
#ifndef CONFIG_ARCH_LEDS
|
|
EXTERN void pic32mx_setleds(uint8_t ledset);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Button support.
|
|
*
|
|
* Description:
|
|
* up_buttoninit() must be called to initialize button resources. After
|
|
* that, up_buttons() may be called to collect the current state of all
|
|
* buttons or up_irqbutton() may be called to register button interrupt
|
|
* handlers.
|
|
*
|
|
* After up_buttoninit() has been called, up_buttons() may be called to
|
|
* collect the state of all buttons. up_buttons() returns an 8-bit bit set
|
|
* with each bit associated with a button. See the BUTTON_*_BIT
|
|
* definitions in board.h for the meaning of each bit.
|
|
*
|
|
* up_irqbutton() may be called to register an interrupt handler that will
|
|
* be called when a button is depressed or released. The ID value is a
|
|
* button enumeration value that uniquely identifies a button resource.
|
|
* See the BUTTON_* definitions in board.h for the meaning of enumeration
|
|
* value. The previous interrupt handler address is returned (so that it
|
|
* may restored, if so desired).
|
|
*
|
|
* When an interrupt occurs, it is due to a change on the GPIO input pin
|
|
* associated with the button. In that case, all attached change
|
|
* notification handlers will be called. Each handler must maintain state
|
|
* and determine if the unlying GPIO button input value changed.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ARCH_BUTTONS
|
|
EXTERN void up_buttoninit(void);
|
|
EXTERN uint8_t up_buttons(void);
|
|
#ifdef CONFIG_ARCH_IRQBUTTONS
|
|
EXTERN xcpt_t up_irqbutton(int id, xcpt_t irqhandler);
|
|
#endif
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* __CONFIGS_UBW32_INCLUDE_BOARD_H */
|