/****************************************************************************** * The MIT License * * Copyright (c) 2010 Bryan Newbold. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without * restriction, including without limitation the rights to use, copy, * modify, merge, publish, distribute, sublicense, and/or sell copies * of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. *****************************************************************************/ /** * @file wirish/include/wirish/boards.h * @author Bryan Newbold , * Marti Bolivar * @brief init() and board-specific pin information. */ #ifndef _WIRISH_BOARDS_H_ #define _WIRISH_BOARDS_H_ #include #include #include /* Set of all possible pin names; not all boards have all these (note * that we use the Dx convention since all of the Maple's pins are * "digital" pins (e.g. can be used with digitalRead() and * digitalWrite()), but not all of them are connected to ADCs. */ enum { D0, D1, D2, D3, D4, D5, D6, D7, D8, D9, D10, D11, D12, D13, D14, D15, D16, D17, D18, D19, D20, D21, D22, D23, D24, D25, D26, D27, D28, D29, D30, D31, D32, D33, D34, D35, D36, D37, D38, D39, D40, D41, D42, D43, D44, D45, D46, D47, D48, D49, D50, D51, D52, D53, D54, D55, D56, D57, D58, D59, D60, D61, D62, D63, D64, D65, D66, D67, D68, D69, D70, D71, D72, D73, D74, D75, D76, D77, D78, D79, D80, D81, D82, D83, D84, D85, D86, D87, D88, D89, D90, D91, D92, D93, D94, D95, D96, D97, D98, D99, D100, D101, D102, D103, D104, D105, D106, D107, D108, D109, D110, D111, }; /** * @brief Maps each Maple pin to a corresponding stm32_pin_info. * @see stm32_pin_info */ extern const stm32_pin_info PIN_MAP[]; /** * @brief Pins capable of PWM output. * * Its length is BOARD_NR_PWM_PINS. */ extern const uint8 boardPWMPins[]; /** * @brief Array of pins capable of analog input. * * Its length is BOARD_NR_ADC_PINS. */ extern const uint8 boardADCPins[]; /** * @brief Pins which are connected to external hardware. * * For example, on Maple boards, it always at least includes * BOARD_LED_PIN. Its length is BOARD_NR_USED_PINS. */ extern const uint8 boardUsedPins[]; /** * @brief Generic board initialization function. * * This function is called before main(). It ensures that the clocks * and peripherals are configured properly for use with wirish, then * calls boardInit(). * * @see boardInit() */ void init(void); /** * @brief Board-specific initialization function. * * This function is called from init() after all generic board * initialization has been performed. Each board is required to * define its own. * * @see init() */ extern void boardInit(void); /** * @brief Test if a pin is used for a special purpose on your board. * @param pin Pin to test * @return true if the given pin is in boardUsedPins, and false otherwise. * @see boardUsedPins */ bool boardUsesPin(uint8 pin); /* * Derived and default board definitions */ #define CLOCK_SPEED_MHZ CYCLES_PER_MICROSECOND #define CLOCK_SPEED_HZ (CLOCK_SPEED_MHZ * 1000000UL) #ifndef SYSTICK_RELOAD_VAL #define SYSTICK_RELOAD_VAL (1000 * CYCLES_PER_MICROSECOND - 1) #endif #ifndef BOARD_BUTTON_PRESSED_LEVEL #define BOARD_BUTTON_PRESSED_LEVEL HIGH #endif /** * @brief Does the board break out a USART/UART's RX and TX pins? * * BOARD_HAVE_USART(n) is nonzero iff USARTn is available (n must be * an integer literal, 1 through 6). Also see BOARD_HAVE_USART1, ..., * BOARD_HAVE_UART4 (sic), etc. */ #define BOARD_HAVE_USART(n) (defined(BOARD_USART##n##_TX_PIN) && \ defined(BOARD_USART##n##_RX_PIN)) /** Feature test: nonzero iff the board has USART1. */ #define BOARD_HAVE_USART1 BOARD_HAVE_USART(1) /** Feature test: nonzero iff the board has USART2, 0 otherwise. */ #define BOARD_HAVE_USART2 BOARD_HAVE_USART(2) /** Feature test: nonzero iff the board has USART3, 0 otherwise. */ #define BOARD_HAVE_USART3 BOARD_HAVE_USART(3) /** Feature test: nonzero iff the board has UART4, 0 otherwise. */ #define BOARD_HAVE_UART4 BOARD_HAVE_USART(4) /** Feature test: nonzero iff the board has UART5, 0 otherwise. */ #define BOARD_HAVE_UART5 BOARD_HAVE_USART(5) /** Feature test: nonzero iff the board has USART6, 0 otherwise. */ #define BOARD_HAVE_USART6 BOARD_HAVE_USART(6) /** * @brief Does the board break out a SPI peripheral's pins? * * BOARD_HAVE_SPI(n) is nonzero iff SPIn is available (n must be an * integer literal: 1, 2, or 3). Also see BOARD_HAVE_SPI1, * BOARD_HAVE_SPI2, BOARD_HAVE_SPI3. */ #define BOARD_HAVE_SPI(n) (defined(BOARD_SPI##n##_NSS_PIN) && \ defined(BOARD_SPI##n##_SCK_PIN) && \ defined(BOARD_SPI##n##_MISO_PIN) && \ defined(BOARD_SPI##n##_MOSI_PIN)) /** Feature test: nonzero iff the board has SPI1. */ #define BOARD_HAVE_SPI1 BOARD_HAVE_SPI(1) /** Feature test: nonzero iff the board has SPI2. */ #define BOARD_HAVE_SPI2 BOARD_HAVE_SPI(2) /** Feature test: nonzero iff the board has SPI3. */ #define BOARD_HAVE_SPI3 BOARD_HAVE_SPI(3) /** * @brief Feature test: nonzero iff the board has SerialUSB. */ #define BOARD_HAVE_SERIALUSB (defined(BOARD_USB_DISC_DEV) && \ defined(BOARD_USB_DISC_BIT)) #endif