/**************************************************************************** * boards/arm/kinetis/freedom-k64f/include/board.h * * Copyright (C) 2016-2017 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 __BOARDS_ARM_KINETIS_FREEDOM_K64F_INCLUDE_BOARD_H #define __BOARDS_ARM_KINETIS_FREEDOM_K64F_INCLUDE_BOARD_H /**************************************************************************** * Included Files ****************************************************************************/ #include #ifndef __ASSEMBLY__ # include #endif /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* Clocking *****************************************************************/ /* The Freedom K64F uses a 50MHz external clock from the Micrel Ethernet PHY. * The Kinetis MCU startup from an internal digitally-controlled oscillator * (DCO). Nuttx will enable the main external oscillator (EXTAL0/XTAL0). * The external oscillator/resonator can range from 32.768 KHz up to 50 MHz. * The default external source for the MCG oscillator inputs (EXTAL) is * 50 MHz clock source from Micrel Ethernet PHY. */ #define BOARD_EXTCLOCK 1 /* External clock */ #define BOARD_EXTAL_FREQ 50000000 /* 50MHz Oscillator from Micrel PHY */ #define BOARD_XTAL32_FREQ 32768 /* 32KHz RTC Oscillator */ /* PLL Configuration. Either the external clock or crystal frequency is used * to select the PRDIV value. * Only reference clock frequencies are supported that will produce * a KINETIS_MCG_PLL_REF_MIN >= PLLIN <= KINETIS_MCG_PLL_REF_MIN reference * clock to the PLL. * * PLL Input frequency: PLLIN = REFCLK / PRDIV = 50 MHz / 20 = 2.5 MHz * PLL Output frequency: PLLOUT = PLLIN * VDIV = 2.5 MHz * 48 = 120 MHz * MCG Frequency: PLLOUT = 120 MHz * * PRDIV register value is the divider minus KINETIS_MCG_C5_PRDIV_BASE. * VDIV register value is offset by KINETIS_MCG_C6_VDIV_BASE. */ #define BOARD_PRDIV 20 /* PLL External Reference Divider */ #define BOARD_VDIV 48 /* PLL VCO Divider (frequency multiplier) */ #define BOARD_PLLIN_FREQ (BOARD_EXTAL_FREQ / BOARD_PRDIV) #define BOARD_PLLOUT_FREQ (BOARD_PLLIN_FREQ * BOARD_VDIV) #define BOARD_MCG_FREQ BOARD_PLLOUT_FREQ /* Define additional MCG_C2 Setting */ #define BOARD_MCG_C2_FCFTRIM 0 /* Do not enable FCFTRIM */ #define BOARD_MCG_C2_LOCRE0 MCG_C2_LOCRE0 /* Enable reset on loss of clock */ /* SIM CLKDIV1 dividers */ #define BOARD_OUTDIV1 1 /* Core = MCG, 120 MHz */ #define BOARD_OUTDIV2 2 /* Bus = MCG / 2, 60 MHz */ #define BOARD_OUTDIV3 2 /* FlexBus = MCG / 2, 60 MHz */ #define BOARD_OUTDIV4 5 /* Flash clock = MCG / 5, 24 MHz */ #define BOARD_CORECLK_FREQ (BOARD_MCG_FREQ / BOARD_OUTDIV1) #define BOARD_BUS_FREQ (BOARD_MCG_FREQ / BOARD_OUTDIV2) #define BOARD_FLEXBUS_FREQ (BOARD_MCG_FREQ / BOARD_OUTDIV3) #define BOARD_FLASHCLK_FREQ (BOARD_MCG_FREQ / BOARD_OUTDIV4) /* SDHC clocking ************************************************************/ /* SDCLK configurations corresponding to various modes of operation. * Formula is: * * SDCLK frequency = (base clock) / (prescaler * divisor) * * The SDHC module is always configure configured so that the core clock is * the base clock. * Possible values for presscaler and divisor are: * * SDCLKFS: {2, 4, 8, 16, 32, 63, 128, 256} * DVS: {1..16} */ /* Identification mode: * Optimal 400KHz, Actual 120MHz / (32 * 10) = 375 Khz */ #define BOARD_SDHC_IDMODE_PRESCALER SDHC_SYSCTL_SDCLKFS_DIV32 #define BOARD_SDHC_IDMODE_DIVISOR SDHC_SYSCTL_DVS_DIV(10) /* MMC normal mode: * Optimal 20MHz, Actual 120MHz / (2 * 3) = 20 MHz */ #define BOARD_SDHC_MMCMODE_PRESCALER SDHC_SYSCTL_SDCLKFS_DIV2 #define BOARD_SDHC_MMCMODE_DIVISOR SDHC_SYSCTL_DVS_DIV(3) /* SD normal mode (1-bit): * Optimal 20MHz, Actual 120MHz / (2 * 3) = 20 MHz */ #define BOARD_SDHC_SD1MODE_PRESCALER SDHC_SYSCTL_SDCLKFS_DIV2 #define BOARD_SDHC_SD1MODE_DIVISOR SDHC_SYSCTL_DVS_DIV(3) /* SD normal mode (4-bit): * Optimal 25MHz, Actual 120MHz / (2 * 3) = 20 MHz (with DMA) * SD normal mode (4-bit): * Optimal 20MHz, Actual 120MHz / (2 * 3) = 20 MHz (no DMA) */ #ifdef CONFIG_SDIO_DMA # define BOARD_SDHC_SD4MODE_PRESCALER SDHC_SYSCTL_SDCLKFS_DIV2 # define BOARD_SDHC_SD4MODE_DIVISOR SDHC_SYSCTL_DVS_DIV(3) #else # define BOARD_SDHC_SD4MODE_PRESCALER SDHC_SYSCTL_SDCLKFS_DIV2 # define BOARD_SDHC_SD4MODE_DIVISOR SDHC_SYSCTL_DVS_DIV(3) #endif /* PWM Configuration */ /* FTM0 Channels */ /* Channels can be modified using kinetis_k64pinmux.h */ #define GPIO_FTM0_CH0OUT PIN_FTM0_CH0_1 #define GPIO_FTM0_CH1OUT PIN_FTM0_CH1_1 #define GPIO_FTM0_CH2OUT PIN_FTM0_CH2_2 #define GPIO_FTM0_CH3OUT PIN_FTM0_CH3_1 #define GPIO_FTM0_CH4OUT PIN_FTM0_CH4_1 #define GPIO_FTM0_CH5OUT PIN_FTM0_CH5_1 /* LED definitions **********************************************************/ /* The Freedom K64F has a single RGB LED driven by the K64F as follows: * * LED K64 * ------ ------------------------------------------------------- * RED PTB22/SPI2_SOUT/FB_AD29/CMP2_OUT * BLUE PTB21/SPI2_SCK/FB_AD30/CMP1_OUT * GREEN PTE26/ENET_1588_CLKIN/UART4_CTS_b/RTC_CLKOUT/USB0_CLKIN * * If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs * in any way. * The following definitions are used to access individual LEDs. */ /* LED index values for use with board_userled() */ #define BOARD_LED_R 0 #define BOARD_LED_G 1 #define BOARD_LED_B 2 #define BOARD_NLEDS 3 /* LED bits for use with board_userled_all() */ #define BOARD_LED_R_BIT (1 << BOARD_LED_R) #define BOARD_LED_G_BIT (1 << BOARD_LED_G) #define BOARD_LED_B_BIT (1 << BOARD_LED_B) /* If CONFIG_ARCH_LEDs is defined, then NuttX will control the LED on board * the Freedom K64F. The following definitions describe how NuttX controls * the LEDs: * * SYMBOL Meaning LED state * RED GREEN BLUE * ------------------- ---------------------------- ----------------- */ #define LED_STARTED 1 /* NuttX has been started OFF OFF OFF */ #define LED_HEAPALLOCATE 2 /* Heap has been allocated OFF OFF ON */ #define LED_IRQSENABLED 0 /* Interrupts enabled OFF OFF ON */ #define LED_STACKCREATED 3 /* Idle stack created OFF 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 4 /* The system has crashed FLASH OFF OFF */ #undef LED_IDLE /* K64 is in sleep mode (Not used) */ /* Button definitions *******************************************************/ /* Two push buttons, SW2 and SW3, are available on FRDM-K64F board, * where SW2 is connected to PTC6 and SW3 is connected to PTA4. * Besides the general purpose input/output functions, SW2 and SW3 can be * low-power wake up signal. Also, only SW3 can be a non-maskable interrupt. * * Switch GPIO Function * --------- --------------------------------------------------------------- * SW2 PTC6/SPI0_SOUT/PD0_EXTRG/I2S0_RX_BCLK/FB_AD9/I2S0_MCLK/LLWU_P10 * SW3 PTA4/FTM0_CH1/NMI_b/LLWU_P3 */ #define BUTTON_SW2 0 #define BUTTON_SW3 1 #define BUTTON_SW2_BIT (1 << BUTTON_SW2) #define BUTTON_SW3_BIT (1 << BUTTON_SW3) /* Alternative pin resolution ***********************************************/ /* If there are alternative configurations for various pins in the * kinetis_k64pinmux.h header file, those alternative pins will be labeled * with a suffix like _1, _2, etc. The logic in this file must select the * correct pin configuration for the board by defining a pin configuration * (with no suffix) that maps to the correct alternative. */ /* The primary serial port interface signals are PTB16 UART0_RX and * PTB17 UART0_TX. * These signals are connected to the OpenSDAv2 circuit. */ #define PIN_UART0_RX PIN_UART0_RX_3 #define PIN_UART0_TX PIN_UART0_TX_3 /* An alternative serial port might use a standard serial shield mounted * on the Freedom Board. In this case, Arduino pin D1 provides UART TX and * pin D0 provides UART RX. * * The I/O headers on the FRDM-K64F board are arranged to enable * compatibility with Arduino shield. The outer rows of pins (even numbered * pins) on the headers, share the same mechanical spacing and placement with * the I/O headers on the Arduino Revision 3 (R3) standard. * * The Arduino D0 and D1 pins then correspond to pins 2 and 4 on the J1 I/O * connector: * * Arduino Pin FRDM-K64F J1 Connector * ------------------------ ----------------------- * UART TX, Arduino D1 pin Pin 4, PTC17, UART3_TX * UART RX, Arduino D0 pin Pin 2, PTC16, UART3_RX */ #define PIN_UART3_RX PIN_UART3_RX_2 #define PIN_UART3_TX PIN_UART3_TX_2 #endif /* __BOARDS_ARM_FREEDOM_K64F_INCLUDE_BOARD_H */