/************************************************************************************ * configs/sam4s-xplained/include/board.h * * Copyright (C) 2013 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_SAM4L_XPLAINED_INCLUDE_BOARD_H #define __CONFIGS_SAM4L_XPLAINED_INCLUDE_BOARD_H /************************************************************************************ * Included Files ************************************************************************************/ #include #ifndef __ASSEMBLY__ # include # ifdef CONFIG_GPIO_IRQ # include # endif #endif /************************************************************************************ * Definitions ************************************************************************************/ /************************************************************************************ * Included Files ************************************************************************************/ #include #ifndef __ASSEMBLY__ # include # ifdef CONFIG_GPIO_IRQ # include # endif #endif /************************************************************************************ * Definitions ************************************************************************************/ /* Clocking *************************************************************************/ /* After power-on reset, the sam3u device is running on a 4MHz internal RC. These * definitions will configure clocking with MCK = 48MHz, PLLA = 96, and CPU=48MHz. */ /* Main oscillator register settings */ #define BOARD_CKGR_MOR_MOSCXTST (63 << PMC_CKGR_MOR_MOSCXTST_SHIFT) /* Start-up Time */ /* PLLA configuration */ #define BOARD_CKGR_PLLAR_MUL (7 << PMC_CKGR_PLLAR_MUL_SHIFT) #define BOARD_CKGR_PLLAR_STMODE PMC_CKGR_PLLAR_STMODE_FAST #define BOARD_CKGR_PLLAR_COUNT (63 << PMC_CKGR_PLLAR_COUNT_SHIFT) #define BOARD_CKGR_PLLAR_DIV PMC_CKGR_PLLAR_DIV_BYPASS /* PMC master clock register settings */ #define BOARD_PMC_MCKR_CSS PMC_MCKR_CSS_PLLA #define BOARD_PMC_MCKR_PRES PMC_MCKR_PRES_DIV2 /* USB UTMI PLL start-up time */ #define BOARD_CKGR_UCKR_UPLLCOUNT (3 << PMC_CKGR_UCKR_UPLLCOUNT_SHIFT) /* Resulting frequencies */ #define SAM_MAINOSC_FREQUENCY (12000000) #define SAM_MCK_FREQUENCY (48000000) #define SAM_PLLA_FREQUENCY (96000000) #define SAM_CPU_FREQUENCY (48000000) /* HSMCI clocking * * Multimedia Card Interface clock (MCCK or MCI_CK) is Master Clock (MCK) * divided by (2*(CLKDIV+1)). * * MCI_SPEED = MCK / (2*(CLKDIV+1)) * CLKDIV = MCI / MCI_SPEED / 2 - 1 */ /* MCK = 48MHz, CLKDIV = 59, MCI_SPEED = 48MHz / 2 * (59+1) = 400 KHz */ #define HSMCI_INIT_CLKDIV (59 << HSMCI_MR_CLKDIV_SHIFT) /* MCK = 48MHz, CLKDIV = 1, MCI_SPEED = 48MHz / 2 * (1+1) = 12 MHz */ #define HSMCI_MMCXFR_CLKDIV (3 << HSMCI_MR_CLKDIV_SHIFT) /* MCK = 48MHz, CLKDIV = 0, MCI_SPEED = 48MHz / 2 * (0+1) = 24 MHz */ #define HSMCI_SDXFR_CLKDIV (0 << HSMCI_MR_CLKDIV_SHIFT) #define HSMCI_SDWIDEXFR_CLKDIV HSMCI_SDXFR_CLKDIV /* LED definitions ******************************************************************/ /* There are four LEDs on board the SAM4S Xplained board, two of these can be * controlled by software in the SAM4S: * * LED GPIO * ---------------- ----- * D9 Yellow LED PC10 * D10 Yellow LED PC17 * * Both can be illuminated by driving the GPIO output to ground (low). */ /* LED index values for use with sam_setled() */ #define BOARD_D9 0 #define BOARD_D10 1 #define BOARD_NLEDS 2 /* LED bits for use with sam_setleds() */ #define BOARD_D9_BIT (1 << BOARD_D9) #define BOARD_D10_BIT (1 << BOARD_D10) /* These LEDs are not used by the board port unless CONFIG_ARCH_LEDS is * defined. In that case, the usage by the board port is defined in * include/board.h and src/up_leds.c. The LEDs are used to encode OS-related * events as follows: * * SYMBOL Val Meaning LED state * D9 D10 * ----------------------- --- ----------------------- -------- -------- */ #define LED_STARTED 0 /* NuttX has been started OFF OFF */ #define LED_HEAPALLOCATE 0 /* Heap has been allocated OFF OFF */ #define LED_IRQSENABLED 0 /* Interrupts enabled OFF OFF */ #define LED_STACKCREATED 0 /* Idle stack created ON OFF */ #define LED_INIRQ 0 /* In an interrupt No change */ #define LED_SIGNAL 0 /* In a signal handler No change */ #define LED_ASSERTION 0 /* An assertion failed No change */ #define LED_PANIC 0 /* The system has crashed OFF Blinking */ #define LED_IDLE 0 /* MCU is is sleep mode Not used */ /* Thus if D9 is statically on, NuttX has successfully booted and is, * apparently, running normmally. If D10 is flashing at approximately * 2Hz, then a fatal error has been detected and the system has halted. */ /* Button definitions ***************************************************************/ /* Mechanical buttons: * * The SAM4S Xplained has two mechanical buttons. One button is the RESET button * connected to the SAM4S reset line and the other is a generic user configurable * button labeled BP2. When a button is pressed it will drive the I/O line to GND. * * PA5 BP2 */ #define BUTTON_BP2 0 #define NUM_BUTTONS 1 #define BUTTON_BP2_BIT (1 << BUTTON_BP2) /************************************************************************************ * Public Data ************************************************************************************/ #ifndef __ASSEMBLY__ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /************************************************************************************ * Public Function Prototypes ************************************************************************************/ /************************************************************************************ * Name: sam_boardinitialize * * Description: * All SAM3U architectures must provide the following entry point. This entry point * is called early in the intitialization -- after all memory has been configured * and mapped but before any devices have been initialized. * ************************************************************************************/ void sam_boardinitialize(void); /************************************************************************************ * Name: sam_ledinit, sam_setled, and sam_setleds * * 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 sam_ledinit(void); void sam_setled(int led, bool ledon); void sam_setleds(uint8_t ledset); #endif /************************************************************************************ * Name: up_buttoninit * * 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. * ************************************************************************************/ #ifdef CONFIG_ARCH_BUTTONS void up_buttoninit(void); /************************************************************************************ * Name: up_buttons * * Description: * 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* definitions above for the meaning of * each bit in the returned value. * ************************************************************************************/ uint8_t up_buttons(void); /************************************************************************************ * Name: up_irqbutton * * Description: * This function may be called to register an interrupt handler that will be * called when a button is depressed or released. The ID value is one of the * BUTTON* definitions provided above. The previous interrupt handler address is * returned (so that it may restored, if so desired). * ************************************************************************************/ #ifdef CONFIG_GPIOA_IRQ xcpt_t up_irqbutton(int id, xcpt_t irqhandler); #endif #endif /* CONFIG_ARCH_BUTTONS */ #undef EXTERN #if defined(__cplusplus) } #endif #endif /* __ASSEMBLY__ */ #endif /* __CONFIGS_SAM4L_XPLAINED_INCLUDE_BOARD_H */