cs_Boards.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: 2 Feb., 2017
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 *
 * NOTE 1: This file is written in C so that it can be used in the bootloader as well.
 *
 * NOTE 2: If you add a new BOARD, also update the function get_hardware_version in cs_HardwareVersions.h.
 *
 * NOTE 3: If you add a new BOARD that has a different pin layout or other board changes, define a new function and
 * add it as a switch case to the configure_board function
 *
 * NOTE 4: This is the only place where the versions are maintained. There is a separate cmake module that knows
 * how to extract the BOARD_VERSION from this header file. It uses a particular regular expression. If you add
 * weird define statements, this module might choke on that.
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <protocol/cs_Typedefs.h>
#include <protocol/cs_UicrPacket.h>
#include <stdbool.h>
#include <stdint.h>
 
// Nordic dev board, but with some hardware bugs.
#define PCA10036 40
// Nordic dev board in active use.
#define PCA10040 41
// Nordic dev board for the nRF52833
#define PCA10100 42
// Nordic dev board for the nRF52840
#define PCA10056 43
 
// Rectangular beacons from China.
#define GUIDESTONE 100
 
// Crownstone USB dongle
#define CS_USB_DONGLE 200
 
// CROWNSTONE BUILTINS
 
// Prototype builtin. Not in production.
#define ACR01B1A 1000
// Prototype builtin. Not in production.
#define ACR01B1B 1001
// Prototype builtin. Not in production.
#define ACR01B1C 1002
#define ACR01B1D 1003   // released
#define ACR01B1E 1004   // same as ACR01B1D, but with patch
#define ACR01B10B 1007  // Builtin One v20
#define ACR01B10D 1008  // Builtin One v25
 
#define ACR01B13B 1009  // Builtin Two development version
#define ACR01B15A 1010  // Builtin Two (V3-ACR01B15A-rev7)
 
// CROWNSTONE PLUGS
 
// Prototype plug.
#define ACR01B2A 1500
 
// Prototype plug. Replace caps before and after LDO with electrolytic caps due to DC bias.
#define ACR01B2B 1501
 
// Production release plug. Replace primary supply registor with MELF type and increase value to 100 Ohm.
#define ACR01B2C 1502
 
// Prototype plug. Remove MELF. Add compensation cap. Remove C7. Add pull-down resistor to LGBT driver input.
// Move thermal fuse to cover both power paths. Alter offset and gain of power measurement service. Add measurement
// offset to ADC.
#define ACR01B2E 1503
 
// Production release plug. Schematic change. Change power measurement resistor values.
#define ACR01B2G 1504
 
// Prototype Crownstone Plug One (first prototype of second edition of the plug)
#define ACR01B11A 1505
 
// CROWNSTONE OUTLETS
 
// Prototype outlet
#define CR01R02v4 1100
 
#define PIN_NONE 0xFF
 
enum GainIndex {
    GAIN_LOW    = 0,
    GAIN_MIDDLE = 1,
    GAIN_HIGH   = 2,
    GAIN_COUNT  = 3,
    GAIN_SINGLE = 0,  // If there is only a single gain, use the low gain.
};
 
enum ButtonIndex {
    BUTTON0      = 0,
    BUTTON1      = 1,
    BUTTON2      = 2,
    BUTTON3      = 3,
    BUTTON_COUNT = 4,
};
 
enum GpioIndex {
    GPIO_INDEX0      = 0,
    GPIO_INDEX1      = 1,
    GPIO_INDEX2      = 2,
    GPIO_INDEX3      = 3,
    GPIO_INDEX4      = 4,
    GPIO_INDEX5      = 5,
    GPIO_INDEX6      = 6,
    GPIO_INDEX7      = 7,
    GPIO_INDEX8      = 8,
    GPIO_INDEX9      = 9,
    GPIO_INDEX_COUNT = 10,
};
 
enum LedIndex {
    LED0      = 0,
    LED1      = 1,
    LED2      = 2,
    LED3      = 3,
    LED_COUNT = 4,
    LED_RED   = 0,
    LED_GREEN = 1,
};
 
enum Chipset {
    CHIPSET_NRF52832 = 0,
    CHIPSET_NRF52833 = 1,
    CHIPSET_NRF52840 = 2,
};
 
uint8_t GpioToAinOnChipset(uint8_t gpio, uint8_t chipset);
 
// For now mapping is always the same, so this simplified function can be used.
uint8_t GpioToAin(uint8_t gpio);
 
// Maps P1.01 to uint8 pin number.
uint8_t GetGpioPin(uint8_t major, uint8_t minor);
 
typedef struct {
    uint32_t hardwareBoard;
 
    uint8_t pinDimmer;
 
    uint8_t pinEnableDimmer;
 
    uint8_t pinRelayDebug;
 
    uint8_t pinRelayOn;
 
    uint8_t pinRelayOff;
 
    uint8_t pinAinCurrent[GAIN_COUNT];
 
    uint8_t pinAinVoltage[GAIN_COUNT];
 
    uint8_t pinAinVoltageAfterLoad[GAIN_COUNT];
 
    uint8_t pinAinZeroRef;
 
    uint8_t pinAinDimmerTemp;
 
    uint8_t pinAinEarth;
 
    uint8_t pinCurrentZeroCrossing;
 
    uint8_t pinVoltageZeroCrossing;
 
    uint8_t pinRx;
 
    uint8_t pinTx;
 
    uint8_t pinGpio[GPIO_INDEX_COUNT];
 
    uint8_t pinButton[BUTTON_COUNT];
 
    uint8_t pinLed[LED_COUNT];
 
    struct __attribute__((__packed__)) {
        uint8_t cs;
        uint8_t clk;
        uint8_t dio[4];
    } pinFlash;
 
    struct __attribute__((__packed__)) {
        bool dimmerInverted : 1;
 
        bool enableUart : 1;
 
        bool enableLeds : 1;
 
        bool ledInverted : 1;
 
        bool dimmerTempInverted : 1;
 
        bool usesNfcPins : 1;
 
        bool hasAccuratePowerMeasurement : 1;
 
        bool canTryDimmingOnBoot : 1;
 
        bool canDimOnWarmBoot : 1;
 
        bool dimmerOnWhenPinsFloat : 1;
    } flags;
 
    uint8_t deviceType;
 
    float voltageMultiplier[GAIN_COUNT];
 
    float voltageAfterLoadMultiplier[GAIN_COUNT];
 
    float currentMultiplier[GAIN_COUNT];
 
    int32_t voltageOffset[GAIN_COUNT];
 
    int32_t voltageAfterLoadOffset[GAIN_COUNT];
 
    int32_t currentOffset[GAIN_COUNT];
 
    int32_t powerOffsetMilliWatt;
 
    uint32_t voltageAdcRangeMilliVolt;
 
    uint32_t currentAdcRangeMilliVolt;
 
    int8_t minTxPower;
 
    float pwmTempVoltageThreshold;
 
    float pwmTempVoltageThresholdDown;
 
    uint32_t scanIntervalUs;
 
    uint32_t scanWindowUs;
 
    int8_t tapToToggleDefaultRssiThreshold;
 
} boards_config_t;
 
void init(boards_config_t* config);
 
cs_ret_code_t configure_board(boards_config_t* p_config);
 
cs_ret_code_t configure_board_from_hardware_board(uint32_t hardwareBoard, boards_config_t* config);
cs_ret_code_t configure_board_from_uicr(const cs_uicr_data_t* uicrData, boards_config_t* config);
 
#ifdef __cplusplus
}
#endif