board.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Inria
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once
 
#include "cpu.h"
#include "board_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef DOXYGEN
#define PARTICLE_MONOFIRMWARE
#endif
 
#ifdef DOXYGEN
#define PARTICLE_MONOFIRMWARE_CHECKSUMLIMIT
#endif
 
#ifdef DOXYGEN
#define PARTICLE_PLATFORM_ID
#endif
 
#define LED0_PIN            GPIO_PIN(0, 13)
#define LED1_PIN            GPIO_PIN(0, 14)
#define LED2_PIN            GPIO_PIN(0, 15)
 
#define LED_PORT            (NRF_P0)
#define LED0_MASK           (1 << 13)
#define LED1_MASK           (1 << 14)
#define LED2_MASK           (1 << 15)
#define LED_MASK            (LED0_MASK | LED1_MASK | LED2_MASK)
 
/* The typical SAUL setup for this board uses PWM to make the LEDs (really a
 * single RGB LED) into a PWM controlled RGB LED entry. As a consequence of the
 * PWM configuration, toggling the GPIO has no effect any more, and thus we do
 * not define the macros so that no LEDs get picked up for LEDn_IS_PROVIDED.
 * (The LEDn_ON etc macros will still be present and no-op as usual, but those
 * explicitly checking for IS_PROVIDED will get an accurate picture).
 *
 * Both conditions are typically true when saul_default is on, but strictly, it
 * is those two that in combination make LEDs effectively unavailable to users.
 * */
#if !(IS_USED(MODULE_AUTO_INIT_SAUL) && IS_USED(MODULE_SAUL_PWM))
 
#define LED0_ON             (LED_PORT->OUTCLR = LED0_MASK)
#define LED0_OFF            (LED_PORT->OUTSET = LED0_MASK)
#define LED0_TOGGLE         (LED_PORT->OUT   ^= LED0_MASK)
 
#define LED1_ON             (LED_PORT->OUTCLR = LED1_MASK)
#define LED1_OFF            (LED_PORT->OUTSET = LED1_MASK)
#define LED1_TOGGLE         (LED_PORT->OUT   ^= LED1_MASK)
 
#define LED2_ON             (LED_PORT->OUTCLR = LED2_MASK)
#define LED2_OFF            (LED_PORT->OUTSET = LED2_MASK)
#define LED2_TOGGLE         (LED_PORT->OUT   ^= LED2_MASK)
 
#endif /* !(IS_USED(MODULE_AUTO_INIT_SAUL) && IS_USED(MODULE_SAUL_PWM)) */
 
#define BTN0_PIN            GPIO_PIN(0, 11)
#define BTN0_MODE           GPIO_IN_PU
enum board_nrfantenna_selection {
    BOARD_NRFANTENNA_BUILTIN,
    BOARD_NRFANTENNA_EXTERNAL,
};
 
void board_nrfantenna_select(enum board_nrfantenna_selection choice);
 
#if defined(BOARD_PARTICLE_XENON) || defined(DOXYGEN)
#define VCTL1_PIN           GPIO_PIN(0, 24)
#define VCTL2_PIN           GPIO_PIN(0, 25)
#endif
 
#ifdef BOARD_PARTICLE_ARGON
#define VCTL1_PIN           GPIO_PIN(0, 25)
#define VCTL2_PIN           GPIO_PIN(0, 2)
#endif
 
#ifdef BOARD_PARTICLE_BORON
#define VCTL1_PIN           GPIO_PIN(0, 7)
#endif
 
#ifdef __cplusplus
}
#endif