|
| 1 | +/* |
| 2 | + Copyright (c) 2016 Arduino LLC. All right reserved. |
| 3 | +
|
| 4 | + This library is free software; you can redistribute it and/or |
| 5 | + modify it under the terms of the GNU Lesser General Public |
| 6 | + License as published by the Free Software Foundation; either |
| 7 | + version 2.1 of the License, or (at your option) any later version. |
| 8 | +
|
| 9 | + This library is distributed in the hope that it will be useful, |
| 10 | + but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| 12 | + See the GNU Lesser General Public License for more details. |
| 13 | +
|
| 14 | + You should have received a copy of the GNU Lesser General Public |
| 15 | + License along with this library; if not, write to the Free Software |
| 16 | + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 17 | +*/ |
| 18 | + |
| 19 | +#ifndef _BOARD_DEFINITIONS_H_ |
| 20 | +#define _BOARD_DEFINITIONS_H_ |
| 21 | + |
| 22 | +#include <sam.h> |
| 23 | + |
| 24 | +/* The SAM-BA interface, which is used with both USB CDC and UART (TTL |
| 25 | + * serial), can operate in either binary (default) or terminal mode. If |
| 26 | + * TERMINAL_MODE_ENABLED is defined, additional terminal handling code |
| 27 | + * (add prompt, add \n\r to EOL, number formatting, etc.) will be compiled |
| 28 | + * in. To switch to terminal mode, type 'T#' (you should then see a prompt). |
| 29 | + * Then, type 'V#' to show version information. See README.md for more commands. |
| 30 | + * Size: ~228B. Enabled by default. Disable with 4KB bootloader. |
| 31 | + */ |
| 32 | +#define TERMINAL_MODE_ENABLED |
| 33 | + |
| 34 | +/* If SDCARD_ENABLED is defined, SD card bootloader support is compiled in. |
| 35 | + * See "SD Card Bootloader" section. This define can also be set from the |
| 36 | + * makefile (so it can be used with the build_all_bootloaders.sh script). |
| 37 | + * Size: ~2788B. Disabled by default. Available with 4KB bootloader. |
| 38 | + */ |
| 39 | +#ifndef SDCARD_ENABLED |
| 40 | +//#define SDCARD_ENABLED |
| 41 | +#endif |
| 42 | + |
| 43 | +/* If SDCARD_ENABLED is defined, then all SDCARD_SPI_* defines must also be set. |
| 44 | + * When setting SDCARD_SPI_PADx defines, consult the appropriate header file |
| 45 | + * from CMSIS-Atmel (ie: ~/arduino15/packages/MattairTech_Arduino/tools/CMSIS- |
| 46 | + * Atmel/1.0.0-mattairtech-1/CMSIS/Device/ATMEL/sam<d21|c21|l21|d11>/include/ |
| 47 | + * <YOUR_CHIP>.h). SDCARD_SPI_PAD_SETTINGS values are in SDCard/diskio.h. |
| 48 | + * When using SDCARD_USE_PIN1 or SDCARD_USE_PIN2, the SPI peripheral and |
| 49 | + * associated pins are only initialized if either pin is active. |
| 50 | + */ |
| 51 | +#define SDCARD_SPI_SERCOM_INSTANCE 4 |
| 52 | +#define SDCARD_SPI_PAD_SETTINGS SPI_RX_PAD0_TX_PAD2_SCK_PAD3 |
| 53 | +#define SDCARD_SPI_PAD0 PINMUX_PA12D_SERCOM4_PAD0 |
| 54 | +#define SDCARD_SPI_PAD1 PINMUX_UNUSED |
| 55 | +#define SDCARD_SPI_PAD2 PINMUX_PB10D_SERCOM4_PAD2 |
| 56 | +#define SDCARD_SPI_PAD3 PINMUX_PB11D_SERCOM4_PAD3 |
| 57 | + |
| 58 | +/* If SDCARD_ENABLED is defined, then SDCARD_SPI_CS_PORT and SDCARD_SPI_CS_PIN |
| 59 | + * must also be defined. PORT can be 0 (Port A) or 1 (Port B). |
| 60 | + */ |
| 61 | +#define SDCARD_SPI_CS_PORT (0) |
| 62 | +#define SDCARD_SPI_CS_PIN (18) |
| 63 | + |
| 64 | +/* If SDCARD_ENABLED is defined, then SDCARD_USE_PIN1 and SDCARD_USE_PIN2 can |
| 65 | + * optionally be defined. When SDCARD_USE_PIN2 is defined, SDCARD_USE_PIN1 must |
| 66 | + * also be defined. See "SD Card External Pins" section for more information. PORT |
| 67 | + * can be 0 (Port A) or 1 (Port B). Polarity can be PIN_POLARITY_ACTIVE_LOW or |
| 68 | + * PIN_POLARITY_ACTIVE_HIGH. Config can be INPUT, INPUT_PULLUP, or INPUT_PULLDOWN. |
| 69 | + * Size: ~60B for SDCARD_USE_PIN1, ~92B for both pins. By default, only pin1 used. |
| 70 | + */ |
| 71 | +#define SDCARD_USE_PIN1 |
| 72 | +#define SDCARD_PIN1_POLARITY PIN_POLARITY_ACTIVE_LOW |
| 73 | +#define SDCARD_PIN1_PORT (0) |
| 74 | +#define SDCARD_PIN1_PIN (6) |
| 75 | +#define SDCARD_PIN1_CONFIG INPUT_PULLUP |
| 76 | + |
| 77 | +//#define SDCARD_USE_PIN2 |
| 78 | +#define SDCARD_PIN2_POLARITY PIN_POLARITY_ACTIVE_LOW |
| 79 | +#define SDCARD_PIN2_PORT (0) |
| 80 | +#define SDCARD_PIN2_PIN (7) |
| 81 | +#define SDCARD_PIN2_CONFIG INPUT_PULLUP |
| 82 | + |
| 83 | +/* If SDCARD_VERIFICATION_DISABLED is defined, then verification of the FLASH |
| 84 | + * after programming will not occur, nor will the initial check to see if the |
| 85 | + * FLASH contents are already the same as the file. |
| 86 | + * Size: ~284B. By default, this is not defined, so verification will be enabled. |
| 87 | + */ |
| 88 | +//#define SDCARD_VERIFICATION_DISABLED |
| 89 | + |
| 90 | +/* If SDCARD_AUTORUN_DISABLED is defined, then the SD card bootloader will not |
| 91 | + * automatically run the firmware that was just installed. Instead, the LED will |
| 92 | + * blink with status code LED_STATUS_SUCCESS. This option also applies when the |
| 93 | + * binary file on the SD card already matches the installed firmware. In this |
| 94 | + * case, the LED will blink with status code LED_STATUS_FILE_ALREADY_MATCHES. |
| 95 | + * By default, SDCARD_AUTORUN_DISABLED is defined. |
| 96 | + */ |
| 97 | +#define SDCARD_AUTORUN_DISABLED |
| 98 | + |
| 99 | +/* Two different binary files can be loaded, depending on external pin settings. |
| 100 | + * By default, the filenames are UPDATE.BIN and UPDATE2.BIN, but these can be |
| 101 | + * overridden by defining SDCARD_FILENAME_PRIMARY and SDCARD_FILENAME_SECONDARY. |
| 102 | + * If both pins are configured, SDCARD_FILENAME_PRIMARY (UPDATE.BIN) will be |
| 103 | + * loaded when PIN1 is enabled, and SDCARD_FILENAME_PRIMARY (UPDATE2.BIN) is |
| 104 | + * loaded when PIN2 is enabled. If only one pin or no pin is configured, only |
| 105 | + * SDCARD_FILENAME_PRIMARY is loaded. |
| 106 | + */ |
| 107 | +//#define SDCARD_FILENAME_PRIMARY "UPDATE.BIN" |
| 108 | +//#define SDCARD_FILENAME_SECONDARY "UPDATE2.BIN" |
| 109 | + |
| 110 | +/* Set SAM_BA_INTERFACE to SAM_BA_USBCDC_ONLY, SAM_BA_UART_ONLY, SAM_BA_NONE, or |
| 111 | + * SAM_BA_BOTH_INTERFACES. With 4KB bootloaders, select only one interface (except |
| 112 | + * when using SDCARD_ENABLED, then set SAM_BA_INTERFACE to SAM_BA_NONE). The C21 |
| 113 | + * lacks USB, so set to SAM_BA_UART_ONLY in this case. By default, |
| 114 | + * SAM_BA_USBCDC_ONLY is set (SAM_BA_UART_ONLY with the C21). |
| 115 | + */ |
| 116 | +#if defined(SDCARD_ENABLED) |
| 117 | + #define SAM_BA_INTERFACE SAM_BA_USBCDC_ONLY |
| 118 | +#else |
| 119 | + #define SAM_BA_INTERFACE SAM_BA_BOTH_INTERFACES |
| 120 | +#endif |
| 121 | + |
| 122 | +/* If SAM_BA_INTERFACE_USE_PIN is defined, then the associated pin controls which |
| 123 | + * SAM-BA interface is used (if SAM_BA_BOTH_INTERFACES is defined). If only one |
| 124 | + * interface is used, then the pin acts as an enable. In both cases, the value of |
| 125 | + * SAM_BA_INTERFACE_PIN_POLARITY controls the polarity, with values of |
| 126 | + * PIN_POLARITY_ACTIVE_LOW or PIN_POLARITY_ACTIVE_HIGH for a single interface, and |
| 127 | + * PIN_POLARITY_USBCDC_LOW or PIN_POLARITY_USBCDC_HIGH when both interfaces are |
| 128 | + * enabled. PORT can be 0 (Port A) or 1 (Port B). Config can be INPUT, INPUT_PULLUP, |
| 129 | + * or INPUT_PULLDOWN.The USB/UART peripheral and pins will not be setup if the |
| 130 | + * device is not selected/enabled. If no interface is selected by the pin, the LED |
| 131 | + * will blink with status code LED_STATUS_NO_SAM_BA_INTERFACE. |
| 132 | + * Size: ~100B. By default, SAM_BA_INTERFACE_USE_PIN is not defined. |
| 133 | + */ |
| 134 | +//#define SAM_BA_INTERFACE_USE_PIN |
| 135 | +#define SAM_BA_INTERFACE_PIN_POLARITY PIN_POLARITY_ACTIVE_LOW |
| 136 | +#define SAM_BA_INTERFACE_PIN_PORT (0) |
| 137 | +#define SAM_BA_INTERFACE_PIN_PIN (21) |
| 138 | +#define SAM_BA_INTERFACE_PIN_CONFIG INPUT_PULLUP |
| 139 | + |
| 140 | +/* If ARDUINO_EXTENDED_CAPABILITIES is defined and set to 1, 3 additional commands |
| 141 | + * will become available which will speed up programming when using the Arduino |
| 142 | + * IDE or the bossac tool standalone. Set to 0 with 4KB bootloaders. |
| 143 | + * Size: ~904B. This is defined and set to 1 by default (except with 4KB). |
| 144 | + */ |
| 145 | +#define ARDUINO_EXTENDED_CAPABILITIES 1 |
| 146 | + |
| 147 | +/* The clock source must be chosen by setting CLOCKCONFIG_CLOCK_SOURCE to |
| 148 | + * CLOCKCONFIG_32768HZ_CRYSTAL, CLOCKCONFIG_HS_CRYSTAL, CLOCKCONFIG_INTERNAL, |
| 149 | + * or CLOCKCONFIG_INTERNAL_USB. If CLOCKCONFIG_32768HZ_CRYSTAL or |
| 150 | + * CLOCKCONFIG_HS_CRYSTAL is defined, then the PLL will be used. If |
| 151 | + * CLOCKCONFIG_HS_CRYSTAL is defined, then HS_CRYSTAL_FREQUENCY_HERTZ must |
| 152 | + * also be defined with the crystal frequency in Hertz. CLOCKCONFIG_INTERNAL |
| 153 | + * uses the DFLL in open-loop mode, except with the C21 which lacks a DFLL, so |
| 154 | + * the internal 48MHz RC oscillator is used instead. CLOCKCONFIG_INTERNAL_USB |
| 155 | + * can be defined for the D21, D11, or L21. It will also use the DFLL in |
| 156 | + * open-loop mode, except when connected to a USB port with data lines (and |
| 157 | + * not suspended), where it will calibrate against the USB SOF signal. |
| 158 | + */ |
| 159 | +#ifndef CLOCKCONFIG_CLOCK_SOURCE |
| 160 | +#define CLOCKCONFIG_CLOCK_SOURCE CLOCKCONFIG_32768HZ_CRYSTAL |
| 161 | +#endif |
| 162 | + |
| 163 | +/* If CLOCKCONFIG_HS_CRYSTAL is defined, then HS_CRYSTAL_FREQUENCY_HERTZ |
| 164 | + * must also be defined with the external crystal frequency in Hertz. |
| 165 | + */ |
| 166 | +//#define HS_CRYSTAL_FREQUENCY_HERTZ 16000000UL |
| 167 | + |
| 168 | +/* If the PLL is used (CLOCKCONFIG_32768HZ_CRYSTAL, or CLOCKCONFIG_HS_CRYSTAL |
| 169 | + * defined), then PLL_FRACTIONAL_ENABLED can be defined, which will result in |
| 170 | + * a more accurate 48MHz output frequency at the expense of increased jitter. |
| 171 | + */ |
| 172 | +//#define PLL_FRACTIONAL_ENABLED |
| 173 | + |
| 174 | +/* If both PLL_FAST_STARTUP and CLOCKCONFIG_HS_CRYSTAL are defined, the crystal |
| 175 | + * will be divided down to 1MHz - 2MHz, rather than 32KHz - 64KHz, before being |
| 176 | + * multiplied by the PLL. This will result in a faster lock time for the PLL, |
| 177 | + * however, it will also result in a less accurate PLL output frequency if the |
| 178 | + * crystal is not divisible (without remainder) by 1MHz. In this case, define |
| 179 | + * PLL_FRACTIONAL_ENABLED as well. |
| 180 | + */ |
| 181 | +//#define PLL_FAST_STARTUP |
| 182 | + |
| 183 | +/* Master clock frequency (also Fcpu frequency) */ |
| 184 | +#define VARIANT_MCK (48000000ul) |
| 185 | + |
| 186 | +/* The fine calibration value for DFLL open-loop mode is defined here. |
| 187 | + * The coarse calibration value is loaded from NVM OTP (factory calibration values). |
| 188 | + */ |
| 189 | +#define NVM_SW_CALIB_DFLL48M_FINE_VAL (512) |
| 190 | + |
| 191 | +/* If USB_VENDOR_STRINGS_ENABLED is defined, then STRING_MANUFACTURER and |
| 192 | + * STRING_PRODUCT will be sent to the host. |
| 193 | + * Size: ~228B. By default, USB_VENDOR_STRINGS_ENABLED is defined (including 4KB). |
| 194 | + */ |
| 195 | +#define USB_VENDOR_STRINGS_ENABLED |
| 196 | +#define STRING_PRODUCT "Arduino MKRFox1200" |
| 197 | + |
| 198 | +/* If USB CDC is used, then the USB vendor ID (VID) and product ID (PID) must be set. */ |
| 199 | +#define USB_VID_HIGH 0x23 |
| 200 | +#define USB_VID_LOW 0x41 |
| 201 | +#define USB_PID_HIGH 0x00 |
| 202 | +#define USB_PID_LOW 0x50 |
| 203 | + |
| 204 | +/* BOOT_USART_SERCOM_INSTANCE must be a single digit representing the SERCOM number. |
| 205 | + * See board_driver_serial.h for BOOT_USART_PAD_SETTINGS values. When setting |
| 206 | + * BOOT_USART_PADx defines, consult the appropriate header file from CMSIS-Atmel (ie: |
| 207 | + * ~/arduino15/packages/MattairTech_Arduino/tools/CMSIS-Atmel/1.0.0-mattairtech-1/ |
| 208 | + * CMSIS/Device/ATMEL/sam<d21|c21|l21|d11>/include/<YOUR_CHIP>.h). Use PINMUX_UNUSED |
| 209 | + * if not used. By default, this interface is not enabled (except with the C21). |
| 210 | + */ |
| 211 | +#define BOOT_USART_SERCOM_INSTANCE 5 |
| 212 | +#define BOOT_USART_PAD_SETTINGS UART_RX_PAD3_TX_PAD2 |
| 213 | +#define BOOT_USART_PAD3 PINMUX_PB23D_SERCOM5_PAD3 |
| 214 | +#define BOOT_USART_PAD2 PINMUX_PB22D_SERCOM5_PAD2 |
| 215 | +#define BOOT_USART_PAD1 PINMUX_UNUSED |
| 216 | +#define BOOT_USART_PAD0 PINMUX_UNUSED |
| 217 | + |
| 218 | +/* |
| 219 | + * If BOOT_DOUBLE_TAP_ENABLED is defined the bootloader is started by quickly |
| 220 | + * tapping two times on the reset button (within 1/2 second). |
| 221 | + * Size: ~96B. Enabled by default. |
| 222 | + */ |
| 223 | +#define BOOT_DOUBLE_TAP_ENABLED |
| 224 | + |
| 225 | +/* |
| 226 | + * If BOOT_LOAD_PIN_ENABLED is defined, the bootloader is started if the selected |
| 227 | + * pin is active after reset. There is a 10ms delay before testing the pin to |
| 228 | + * allow time for debouncing capacitors to charge (ie: button use). PORT can be 0 |
| 229 | + * (Port A) or 1 (Port B). Polarity can be PIN_POLARITY_ACTIVE_LOW or |
| 230 | + * PIN_POLARITY_ACTIVE_HIGH. Config can be INPUT, INPUT_PULLUP, or INPUT_PULLDOWN. |
| 231 | + * Size: ~84B. Disabled by default. |
| 232 | + */ |
| 233 | +//#define BOOT_LOAD_PIN_ENABLED |
| 234 | +#define BOOT_LOAD_PIN_POLARITY PIN_POLARITY_ACTIVE_LOW |
| 235 | +#define BOOT_LOAD_PIN_PORT (0) |
| 236 | +#define BOOT_LOAD_PIN (21) |
| 237 | +#define BOOT_LOAD_PIN_CONFIG INPUT_PULLUP |
| 238 | + |
| 239 | +/* |
| 240 | + * If BOARD_LED_FADE_ENABLED is defined, then the main LED produces a PWM fade in an |
| 241 | + * "M-wave" pattern, otherwise, it simply turns on (if enabled). When the SD bootloader |
| 242 | + * is running, the fading will be twice as fast as the SAM-BA interface (USB CDC or UART). |
| 243 | + * Size: ~160B. Enabled by default. |
| 244 | + */ |
| 245 | +#define BOARD_LED_FADE_ENABLED |
| 246 | + |
| 247 | +/* |
| 248 | + * If the LED PORT is defined, then the LED on the associated pin is enabled. |
| 249 | + * Polarity can be either LED_POLARITY_HIGH_ON or LED_POLARITY_LOW_ON. |
| 250 | + * By default, only BOARD_LED is enabled. |
| 251 | + */ |
| 252 | +// PA20 (digital pin 6) |
| 253 | +#define BOARD_LED_PORT (0) |
| 254 | +#define BOARD_LED_PIN (20) |
| 255 | +#define BOARD_LED_POLARITY LED_POLARITY_HIGH_ON |
| 256 | + |
| 257 | +// No RX/TX led |
| 258 | +//#define BOARD_LEDRX_PORT |
| 259 | +//#define BOARD_LEDRX_PIN |
| 260 | +//#define BOARD_LEDRX_POLARITY LED_POLARITY_LOW_ON |
| 261 | + |
| 262 | +//#define BOARD_LEDTX_PORT |
| 263 | +//#define BOARD_LEDTX_PIN |
| 264 | +//#define BOARD_LEDRX_POLARITY LED_POLARITY_LOW_ON |
| 265 | + |
| 266 | +#endif // _BOARD_DEFINITIONS_H_ |
0 commit comments