/**************************************************************************** * configs/pic32mz-starterkit/include/board.h * * Copyright (C) 2015 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * 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_SURE_PIC32MZ_INCLUDE_BOARD_H #define __CONFIGS_SURE_PIC32MZ_INCLUDE_BOARD_H /**************************************************************************** * Included Files ****************************************************************************/ #include #ifndef __ASSEMBLY__ # include #endif /**************************************************************************** * 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) */ /* 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 */ /* Ethernet MII clocking. * * The clock divider used to create the MII Management Clock (MDC). The MIIM * module uses the SYSCLK as an input clock. According to the IEEE 802.3 * Specification this should be no faster than 2.5 MHz. However, some PHYs * support clock rates up to 12.5 MHz. */ #define BOARD_EMAC_MIIM_DIV 32 /* Ideal: 80MHz/32 = 2.5MHz */ /* LED definitions **********************************************************/ /* LED Configuration ********************************************************/ /* The PIC32MZ Ethernet Starter kit has 3 user LEDs labelled LED1-3 on the * board: * * PIN LED Notes * --- ----- ------------------------- * RH0 LED1 High illuminates (RED) * RH1 LED3 High illuminates (YELLOW) * RH2 LED2 High illuminates (GREEN) */ /* LED index values for use with pic32mz_setled() */ #define PIC32MZ_STARTERKIT_LED1 0 #define PIC32MZ_STARTERKIT_LED2 1 #define PIC32MZ_STARTERKIT_LED3 2 #define PIC32MZ_STARTERKIT_NLEDS 3 /* LED bits for use with pic32mz_setleds() */ #define PIC32MZ_STARTERKIT_LED1_BIT (1 << PIC32MZ_STARTERKIT_LED1) #define PIC32MZ_STARTERKIT_LED2_BIT (1 << PIC32MZ_STARTERKIT_LED2) #define PIC32MZ_STARTERKIT_LED3_BIT (1 << PIC32MZ_STARTERKIT_LED3) /* If CONFIG_ARCH_LEDs is defined, then NuttX will control the 3 LEDs * on board the Ethernet Starter Kit. The following definitions * describe how NuttX controls the LEDs: * * 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 /* Switch definitions *******************************************************/ /* The PIC32MZ Ethernet Starter kit has 3 user push buttons labelled SW1-3 * on the board: * * PIN LED Notes * ---- ---- ------------------------- * RB12 SW1 Active-low * RB13 SW2 Active-low * RB14 SW3 Active-low * * The switches do not have any debounce circuitry and require internal pull- * up resistors. When Idle, the switches are pulled high (+3.3V), and they * are grounded when pressed. */ /**************************************************************************** * Public Types ****************************************************************************/ #ifndef __ASSEMBLY__ /**************************************************************************** * Inline Functions ****************************************************************************/ /**************************************************************************** * Public Function Prototypes ****************************************************************************/ #ifdef __cplusplus #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /**************************************************************************** * Name: pic32mz_ledinit and pic32mz_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 applications. * ****************************************************************************/ #ifndef CONFIG_ARCH_LEDS void pic32mz_ledinit(void); void pic32mz_setled(int led, bool ledon); void pic32mz_setleds(uint8_t ledset); #endif #undef EXTERN #ifdef __cplusplus } #endif #endif /* __ASSEMBLY__ */ #endif /* __CONFIGS_SURE_PIC32MZ_INCLUDE_BOARD_H */