configure.h

Go to the documentation of this file.

/*
 *  This file is part of the Home2L project.
 *
 *  (C) 2015-2024 Gundolf Kiefer
 *
 *  Home2L is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Home2L is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Home2L. If not, see <https://www.gnu.org/licenses/>.
 *
 */
 
 
/* The purpose of this file is configure the compilation of the remaining source
 * by setting a bunch of preprocessor definitions and make plausibility checks.
 *
 * It depends on the individual Brownie configuration as set in 'Family.mk'.
 * Options that can be set there are documented below in section 1.
 *
 * This file may be edited and extend for the following purposes:
 * - adding support for a new MCU model (-> section 3),
 * - adding a new feature module (-> all sections),
 * - changing pin assignments for some features on some MCU model(s).
 *
 * This file is arranged in the following sections:
 *
 * 1. Features: User Parameters
 *    - any user parameters settable in 'Family.mk' are predefined and documented here.
 *
 * 2. Features: Auto-Completion
 *    - auto-completion of feature-related parameters ('WITH_*' macros)
 *    - auto-enable "timer" and "notify" features
 *
 * 3. MCU: Pin Assignments
 *    - pin assignments of supported MCU types
 *
 *    -> EDIT this section to add a new MCU model.
 *
 * 4. Pins: Auto-Completion and Interrupt Configuration
 *    - auto-generate pin-related macros (P_*, RESET_DDR_IN_*, RESET_DDR_OUT_*, RESET_DDR_STATE_*)
 *    - feature-specific interrupt settings (PCINT_*)
 *
 * 5. Pins: Checks
 *    - sanity checks
 *
 * 6. MCU: Main Macros
 *    - define INIT_PINS() macro
 *    - define macros for ping change interrupts: PCINT_ALL_PINS, PCINT_CALL_SUBISRS(P)
 */
 
 
#ifndef _BROWNIE_CONFIG_
#define _BROWNIE_CONFIG_
 
 
#include "base.h"
 
 
 
 
 
// ************************ 1. Features: User Parameters ***********************
 
 
// This section lists and documents the user-definable feature settings and
// sets defaults.
 
 
 
 
#ifndef IS_MAINTENANCE
#define IS_MAINTENANCE 0          
#endif
 
#ifndef TWI_SL_NOTIFY
#define TWI_SL_NOTIFY (!IS_MAINTENANCE)
#endif
 
#ifndef TWI_SL_NOTIFY_US
#define TWI_SL_NOTIFY_US 10000.0
#endif
 
 
 
 
#ifndef WITH_TIMER
#define WITH_TIMER 0              
#endif
 
 
 
 
#ifndef GPIO_IN_PRESENCE
#define GPIO_IN_PRESENCE  0       
#endif
 
#ifndef GPIO_IN_PULLUP
#define GPIO_IN_PULLUP    0       
#endif
 
#ifndef GPIO_OUT_PRESENCE
#define GPIO_OUT_PRESENCE 0       
#endif
 
#ifndef GPIO_OUT_PRESET
#define GPIO_OUT_PRESET   0       
#endif
 
 
 
 
#ifndef WITH_TWIHUB
#define WITH_TWIHUB 0             
#endif
#ifndef TWIHUB_PORT
#define TWIHUB_PORT 0             
#endif
 
#ifndef TWI_MA_PORTS
#define TWI_MA_PORTS (WITH_TWIHUB ? 1 : 0)  
#endif
#ifndef TWI_MA_INTERNAL_PULLUP
#define TWI_MA_INTERNAL_PULLUP 0  
#endif
 
 
 
 
#ifndef MATRIX_ROWS
#define MATRIX_ROWS       0       
#endif
 
#ifndef MATRIX_COLS
#define MATRIX_COLS       0       
#endif
 
#ifndef MATRIX_ROWS_GSHIFT
#if MATRIX_ROWS >= 2
#define MATRIX_ROWS_GSHIFT (GPIO_PINS_MAX - MATRIX_ROWS)
#else
#define MATRIX_ROWS_GSHIFT GPIO_PINS_MAX    // no stimulating lines at all ...
#endif
#endif
 
#ifndef MATRIX_COLS_GSHIFT
#define MATRIX_COLS_GSHIFT (MATRIX_ROWS_GSHIFT - MATRIX_COLS)
#endif
 
#ifndef MATRIX_T_SAMPLE
#define MATRIX_T_SAMPLE   4       
#endif
 
#ifndef MATRIX_T_PERIOD
#define MATRIX_T_PERIOD  16       
#endif
 
#ifndef MATRIX_BUFSIZE
#define MATRIX_BUFSIZE    8       
#endif
 
 
 
 
#ifndef ADC_PORTS
#define ADC_PORTS           0   
#endif
 
#ifndef ADC_PERIOD
#define ADC_PERIOD       1024   
#endif
 
#ifndef P_ADC_0_STROBE
#define P_ADC_0_STROBE      0   
#endif
 
#ifndef ADC_0_STROBE_VALUE
#define ADC_0_STROBE_VALUE  1   
#endif
 
#ifndef ADC_0_STROBE_TICKS
#define ADC_0_STROBE_TICKS  0   
#endif
 
#ifndef P_ADC_1_STROBE
#define P_ADC_1_STROBE      0
#endif
 
#ifndef ADC_1_STROBE_VALUE
#define ADC_1_STROBE_VALUE  1
#endif
 
#ifndef ADC_1_STROBE_TICKS
#define ADC_1_STROBE_TICKS  0
#endif
 
 
 
 
#ifndef WITH_UART
#define WITH_UART           0     
#endif
 
#ifndef UART_WITH_DRIVE
#define UART_WITH_DRIVE     1     
#endif
 
#ifndef UART_TX_LISTEN
#define UART_TX_LISTEN     10     
#endif
 
#ifndef UART_TX_INV
#define UART_TX_INV         1     
#endif
 
#ifndef UART_RX_INV
#define UART_RX_INV         1     
#endif
 
#ifndef UART_BAUDRATE
#define UART_BAUDRATE    9600     
#endif
 
#ifndef UART_STOPBITS
#define UART_STOPBITS       1     
#endif
 
#ifndef UART_PARITY
#define UART_PARITY         0     
#endif
 
#ifndef UART_TX_BUFSIZE
#define UART_TX_BUFSIZE    16     
#endif
 
#ifndef UART_RX_BUFSIZE
#define UART_RX_BUFSIZE    16     
#endif
 
#ifndef UART_MULTI_BYTE_ISR
#define UART_MULTI_BYTE_ISR 1     
#endif
 
 
 
 
#ifndef WITH_TEMP_ZACWIRE
#define WITH_TEMP_ZACWIRE   0     
#endif
 
#ifndef TEMP_NOTIFY
#define TEMP_NOTIFY         0     
#endif
 
 
 
 
#ifndef SHADES_PORTS
#define SHADES_PORTS        0     
#endif
 
#ifndef SHADES_TIMEOUT
#define SHADES_TIMEOUT  30000
#endif
 
#ifndef SHADES_REVERSE_DELAY
#define SHADES_REVERSE_DELAY 1000
#endif
 
#ifndef SHADES_0_RINT_FAILSAFE
#define SHADES_0_RINT_FAILSAFE 0xff
#endif
#ifndef SHADES_1_RINT_FAILSAFE
#define SHADES_1_RINT_FAILSAFE 0xff
#endif
 
#ifndef SHADES_PERSISTENCE
#define SHADES_PERSISTENCE    1
#endif
 
#ifndef SHADES_TOLERANCE
#define SHADES_TOLERANCE      2
#endif
 
 
 
 
 
 
 
// ************************ 2. Features: Auto-Completion ***********************
 
 
#if !DOXYGEN
 
 
// GPIO ...
#define WITH_GPIO ((GPIO_IN_PRESENCE) || (GPIO_OUT_PRESENCE))
 
 
// TWI Master...
#define WITH_TWI_MASTER ((TWI_MA_PORTS) > 0)
 
 
// Matrix...
#define WITH_MATRIX ((MATRIX_ROWS) * (MATRIX_COLS) != 0)
 
#if !WITH_MATRIX    // Make sure that 'matDim' becomes 0 if there is no matrix ...
#undef MATRIX_COLS
#undef MATRIX_ROWS
#define MATRIX_COLS 0
#define MATRIX_ROWS 0
#endif
 
 
// Analog (ADC) ...
#define WITH_ADC ((ADC_PORTS) > 0)
 
 
// UART ...
#if !UART_WITH_DRIVE
#undef UART_TX_LISTEN
#define UART_TX_LISTEN 0
#endif
 
 
// Shades ...
#define WITH_SHADES ((SHADES_PORTS) > 0)
 
 
// Timer ...
#if WITH_MATRIX || WITH_ADC || WITH_UART || WITH_SHADES || WITH_TEMP_ZACWIRE
  // The above features require the timer: Auto-enable it
#undef WITH_TIMER
#define WITH_TIMER 1
#endif
 
 
// Notifications ...
#if !WITH_GPIO && !WITH_TWIHUB && !WITH_MATRIX && !WITH_SHADES
  // Without any of these features, notifications make no sense:
  // We disable notification at all.
#undef TWI_SL_NOTIFY
#define TWI_SL_NOTIFY 0
#endif
 
 
#endif // !DOXYGEN
 
 
 
 
 
// ******************* 3. MCU: Pin Assignments *********************************
 
 
#if DOXYGEN
 
 
// Note: All Doxygen documentation for the MCU port assignemts is done here at
//       the beginning of this section to deal with the alternative sections
//       defining the constants of the same names.
 
 
#define ISR_PCINT0          
#define ISR_PCINT1          
#define ISR_USI_STARTCOND   
#define ISR_USI_OVERFLOW    
 
// USI ...
#define P_USI_SCL           
#define P_USI_SDA           
 
// GPIOs ...
#define GPIO_PINS_MAX       
#define GPIO_TO_PMASK(GMASK)
#define GPIO_FROM_PMASK(PMASK)
 
// TWI Master ...
#define P_TWI_MA_0_SCL      
#define P_TWI_MA_0_SDA      
 
// ADC(s) ...
#define P_ADC_0             
#define P_ADC_1             
 
// UART ...
#define P_UART_RX           
#define P_UART_TX           
#define P_UART_DRIVE        
 
// Temperature ...
#define P_TEMP_ZACWIRE      
 
// Shades ...
#define P_SHADES_0_BTN_UP   
#define P_SHADES_0_BTN_DN   
#define P_SHADES_0_ACT_UP   
#define P_SHADES_0_ACT_DN   
#define P_SHADES_1_BTN_UP   
#define P_SHADES_1_BTN_DN   
#define P_SHADES_1_ACT_UP   
#define P_SHADES_1_ACT_DN   
 
#else // DOXYGEN
 
 
 
 
 
// ***** ATtiny85 *****
 
 
#if MCU_TYPE == BR_MCU_ATTINY85
 
 
// Interrupts ...
//   Interrupt vector names vary with the MCU model. A translation list can be found at:
//   https://www.nongnu.org/avr-libc/user-manual/group__avr__interrupts.html
#define ISR_PCINT0          PCINT0_vect
#define ISR_USI_STARTCOND   USI_START_vect
#define ISR_USI_OVERFLOW    USI_OVF_vect
 
// USI ...
#define P_USI_SCL           P_B2
#define P_USI_SDA           P_B0
 
// GPIOs ...
#define GPIO_PINS_MAX 3
 
#define GPIO_TO_PMASK(GMASK) ((((GMASK) & 0x06) << 10) | (((GMASK) & 0x01) << 9))
#define GPIO_FROM_PMASK(PMASK) ((((PMASK) & 0x18) >> 10) | (((PMASK) & 0x02) >> 9))
  // Macros to map logical GPIO pins to port A and port B bits.
  // Unused bits should be masked out, so that 'GPIO_TO_PMASK(0xffff)' identifies
  // all ports usable as GPIOs and GPIO_FROM_MASK(0xffff) identifies all logically
  // usable GPIOs, respectively.
 
// TWI Master ...
#define P_TWI_MA_0_SCL      P_B3
#define P_TWI_MA_0_SDA      P_B4
 
// UART ...
#define P_UART_RX           P_B1
#define P_UART_TX           P_B3
#define P_UART_DRIVE        P_B4
 
 
 
 
 
// ***** ATtiny84 *****
 
 
#elif MCU_TYPE == BR_MCU_ATTINY84
 
 
// Interrupts ...
//   Interrupt vector names vary with the MCU model. A translation list can be found at:
//   https://www.nongnu.org/avr-libc/user-manual/group__avr__interrupts.html
#define ISR_PCINT0          PCINT0_vect
#define ISR_PCINT1          PCINT1_vect
#define ISR_USI_STARTCOND   USI_STR_vect
#define ISR_USI_OVERFLOW    USI_OVF_vect
 
// USI ...
#define P_USI_SCL           P_A4
#define P_USI_SDA           P_A6
 
// GPIOs ...
#define GPIO_PINS_MAX 8
 
#define GPIO_TO_PMASK(GMASK) (((GMASK) & 0x8f) | (((GMASK) & 0x70) << 4))
#define GPIO_FROM_PMASK(PMASK) (((PMASK) & 0x8f) | ((((PMASK) >> 4)) & 0x70))
  // Macros to map logical GPIO pins to port A and port B bits.
  // Unused bits should be masked out, so that 'GPIO_TO_PMASK(0xffff)' identifies
  // all ports usable as GPIOs and GPIO_FROM_MASK(0xffff) identifies all logically
  // usable GPIOs, respectively.
 
// TWI Master ...
#define P_TWI_MA_0_SCL      P_B0
#define P_TWI_MA_0_SDA      P_B1
 
// ADC(s) ...
#define P_ADC_0             P_A5
#define P_ADC_1             P_A7
 
// UART ...
#define P_UART_RX           P_B0
#define P_UART_TX           P_B1
#define P_UART_DRIVE        P_B2
 
// Temperature ...
#define P_TEMP_ZACWIRE      P_A0
 
// Shades ...
#define P_SHADES_0_BTN_UP   P_A2
#define P_SHADES_0_BTN_DN   P_A1
#define P_SHADES_0_ACT_UP   P_B1
#define P_SHADES_0_ACT_DN   P_B0
 
#define P_SHADES_1_BTN_UP   P_A3
#define P_SHADES_1_BTN_DN   P_A5
#define P_SHADES_1_ACT_UP   P_B2
#define P_SHADES_1_ACT_DN   P_A7
 
 
 
 
 
// ***** ATtiny861 *****
 
 
#elif MCU_TYPE == BR_MCU_ATTINY861
 
 
// Interrupts ...
//   Interrupt vector names vary with the MCU model. A translation list can be found at:
//   https://www.nongnu.org/avr-libc/user-manual/group__avr__interrupts.html
#define ISR_PCINT         PCINT_vect      // one vector for PCINT0 and PCINT1 (different from t84/t85)
#define ISR_USI_STARTCOND USI_START_vect
#define ISR_USI_OVERFLOW  USI_OVF_vect
 
// USI ...
#define P_USI_SCL         P_B2
#define P_USI_SDA         P_B0
 
// GPIOs ...
#define GPIO_PINS_MAX 12
 
#define GPIO_TO_PMASK(GMASK) (((GMASK) & 0x0ff) | (((GMASK) & 0xf00) << 3))
#define GPIO_FROM_PMASK(PMASK) (((PMASK) & 0x0ff) | ((((PMASK) >> 3)) & 0xf00))
  // Macros to map logical GPIO pins to port A and port B bits.
  // Unused bits should be masked out, so that 'GPIO_TO_PMASK(0xffff)' identifies
  // all ports usable as GPIOs and GPIO_FROM_MASK(0xffff) identifies all logically
  // usable GPIOs, respectively.
 
// ADC(s) ...
#define P_ADC_0           P_B5
#define P_ADC_1           P_B6
 
// Temperature ...
#define P_TEMP_ZACWIRE    P_B1
 
 
 
#else   // MCU_TYPE == ...
#error "Unknown MCU"
#endif  // MCU_TYPE == ...
 
 
#endif // !DOXYGEN
 
 
 
 
 
// ************ 4. Pins: Auto-Completion and Interrupt Configuration ***********
 
 
#if !DOXYGEN
 
 
// TWI Slave ...
//   The TWI slave is always present and always uses the USI.
#define TWI_SL_SCL P_USI_SCL
#define TWI_SL_SDA P_USI_SDA
 
#define RESET_DDR_IN_TWI_SL   ((TWI_SL_SCL) | (TWI_SL_SDA))
#define RESET_DDR_OUT_TWI_SL  0
#define RESET_STATE_TWI_SL    0
 
 
// GPIOs ...
#define GPIO_HAVE_UPPER (((GPIO_IN_PRESENCE) >= 0x100 || (GPIO_OUT_PRESENCE) >= 0x100))
 
#define RESET_DDR_IN_GPIO   GPIO_TO_PMASK (GPIO_IN_PRESENCE)
#define RESET_DDR_OUT_GPIO  GPIO_TO_PMASK (GPIO_OUT_PRESENCE)
#define RESET_STATE_GPIO    GPIO_TO_PMASK ((GPIO_IN_PULLUP & GPIO_IN_PRESENCE) | (GPIO_OUT_PRESET & GPIO_OUT_PRESENCE))
 
 
// TWI Master ...
#if !WITH_TWI_MASTER || TWI_MA_PORTS < 1 || !defined(P_TWI_MA_0_SCL) || !defined(P_TWI_MA_0_SDA)
#undef P_TWI_MA_0_SCL
#undef P_TWI_MA_0_SDA
#define P_TWI_MA_0_SCL        0
#define P_TWI_MA_0_SDA        0
#endif
 
#if !WITH_TWI_MASTER || TWI_MA_PORTS < 2 || !defined(P_TWI_MA_1_SCL) || !defined(P_TWI_MA_1_SDA)
#undef P_TWI_MA_1_SCL
#undef P_TWI_MA_1_SDA
#define P_TWI_MA_1_SCL        0
#define P_TWI_MA_1_SDA        0
#endif
 
#if !WITH_TWI_MASTER || TWI_MA_PORTS < 3 || !defined(P_TWI_MA_2_SCL) || !defined(P_TWI_MA_2_SDA)
#undef P_TWI_MA_2_SCL
#undef P_TWI_MA_2_SDA
#define P_TWI_MA_2_SCL        0
#define P_TWI_MA_2_SDA        0
#endif
 
#if !WITH_TWI_MASTER || TWI_MA_PORTS < 4 || !defined(P_TWI_MA_3_SCL) || !defined(P_TWI_MA_3_SDA)
#undef P_TWI_MA_3_SCL
#undef P_TWI_MA_3_SDA
#define P_TWI_MA_3_SCL        0
#define P_TWI_MA_3_SDA        0
#endif
 
#define RESET_DDR_IN_TWI_MA ((P_TWI_MA_0_SCL) | (P_TWI_MA_0_SDA) | (P_TWI_MA_1_SCL) | (P_TWI_MA_1_SDA) \
                           | (P_TWI_MA_2_SCL) | (P_TWI_MA_2_SDA) | (P_TWI_MA_3_SCL) | (P_TWI_MA_3_SDA))
#define RESET_DDR_OUT_TWI_MA  0
#define RESET_STATE_TWI_MA    0
 
 
// Matrix...
#if MATRIX_ROWS > 1
#define MATRIX_ROWS_GMASK (((1 << MATRIX_ROWS) - 1) << MATRIX_ROWS_GSHIFT) // GPIO mask of the stimulating lines
#else
#define MATRIX_ROWS_GMASK  0    // no stimulating lines at all ...
#endif
#define MATRIX_COLS_GMASK (((1 << MATRIX_COLS) - 1) << MATRIX_COLS_GSHIFT) // GPIO mask of the sensing lines
 
#define RESET_DDR_IN_MATRIX   GPIO_TO_PMASK (MATRIX_COLS_GMASK)
#define RESET_DDR_OUT_MATRIX  GPIO_TO_PMASK (MATRIX_ROWS_GMASK)
#define RESET_STATE_MATRIX    0     // drive '0' on row lines, keep column lines at high-impedance state
 
 
// ADC(s) ...
#if !WITH_ADC || ADC_PORTS < 1 || !defined(P_ADC_0)
#undef P_ADC_0
#define P_ADC_0         0
#undef P_ADC_0_STROBE
#define P_ADC_0_STROBE  0
#endif
 
#if !WITH_ADC || ADC_PORTS < 2 || !defined(P_ADC_1)
#undef P_ADC_1
#define P_ADC_1         0
#undef P_ADC_1_STROBE
#define P_ADC_1_STROBE  0
#endif
 
#define RESET_DDR_IN_ADC    (P_ADC_0 | P_ADC_1)
#define RESET_DDR_OUT_ADC   (P_ADC_0_STROBE | P_ADC_1_STROBE)
#define RESET_STATE_ADC     ((ADC_0_STROBE_VALUE == 0 ? P_ADC_0_STROBE : 0) | (ADC_1_STROBE_VALUE == 0 ? P_ADC_1_STROBE : 0))
 
 
// UART ...
#if !WITH_UART
#undef P_UART_RX
#undef P_UART_TX
#undef P_UART_DRIVE
#define P_UART_RX           0
#define P_UART_TX           0
#define P_UART_DRIVE        0
#else
#if !UART_WITH_DRIVE
#undef P_UART_DRIVE
#define P_UART_DRIVE        0
#endif
#endif // !WITH_UART
 
#define RESET_DDR_IN_UART   (P_UART_RX)
#define RESET_DDR_OUT_UART  (P_UART_TX | P_UART_DRIVE)
#define RESET_STATE_UART    (P_UART_TX)
 
#define PCINT_PIN_UART      P_UART_RX
#define PCINT_ISR_UART      UartISR
 
 
 
// Temperature ...
#if !WITH_TEMP_ZACWIRE || !defined(P_TEMP_ZACWIRE)
#undef P_TEMP_ZACWIRE
#define P_TEMP_ZACWIRE      0
#endif
 
#define RESET_DDR_IN_TEMP   P_TEMP_ZACWIRE
#define RESET_DDR_OUT_TEMP  0
#define RESET_STATE_TEMP    0
 
#define PCINT_PIN_TEMP      P_TEMP_ZACWIRE
#define PCINT_ISR_TEMP      TemperatureISR
 
 
 
// Shades ...
#if !WITH_SHADES || SHADES_PORTS < 1 || \
    !defined(P_SHADES_0_BTN_UP) || !defined(P_SHADES_0_BTN_DN) || !defined(P_SHADES_0_ACT_UP) || !defined(P_SHADES_0_ACT_DN)
#undef P_SHADES_0_BTN_UP
#undef P_SHADES_0_BTN_DN
#undef P_SHADES_0_ACT_UP
#undef P_SHADES_0_ACT_DN
#define P_SHADES_0_BTN_UP     0
#define P_SHADES_0_BTN_DN     0
#define P_SHADES_0_ACT_UP     0
#define P_SHADES_0_ACT_DN     0
#endif
 
#if !WITH_SHADES || SHADES_PORTS < 2 || \
    !defined(P_SHADES_1_BTN_UP) || !defined(P_SHADES_1_BTN_DN) || !defined(P_SHADES_1_ACT_UP) || !defined(P_SHADES_1_ACT_DN)
#undef P_SHADES_1_BTN_UP
#undef P_SHADES_1_BTN_DN
#undef P_SHADES_1_ACT_UP
#undef P_SHADES_1_ACT_DN
#define P_SHADES_1_BTN_UP     0
#define P_SHADES_1_BTN_DN     0
#define P_SHADES_1_ACT_UP     0
#define P_SHADES_1_ACT_DN     0
#endif
 
#define RESET_DDR_IN_SHADES    (P_SHADES_0_BTN_UP | P_SHADES_0_BTN_DN | P_SHADES_1_BTN_UP | P_SHADES_1_BTN_DN)
#define RESET_DDR_OUT_SHADES   (P_SHADES_0_ACT_UP | P_SHADES_0_ACT_DN | P_SHADES_1_ACT_UP | P_SHADES_1_ACT_DN)
#define RESET_STATE_SHADES     RESET_DDR_IN_SHADES    // activate internal pullups for shades buttons
 
 
#endif // !DOXYGEN
 
 
 
 
 
// ************************ 5. Pins: Checks ************************************
 
 
#if !DOXYGEN    // The doxygen preprocessor may have some problems with the following macros.
 
 
// ***** Check for pin conflicts *****
 
// Use masks per feature ...
#define USEMASK_TWI_SL  (TWI_SL_SCL | TWI_SL_SDA)
#define USEMASK_GPIO    (RESET_DDR_IN_GPIO    | RESET_DDR_OUT_GPIO    )
#define USEMASK_TWI_MA  (RESET_DDR_IN_TWI_MA  | RESET_DDR_OUT_TWI_MA  )
#define USEMASK_ADC     (RESET_DDR_IN_ADC     | RESET_DDR_OUT_ADC     )
#define USEMASK_UART    (RESET_DDR_IN_UART    | RESET_DDR_OUT_UART    )
#define USEMASK_MATRIX  (RESET_DDR_IN_MATRIX  | RESET_DDR_OUT_MATRIX  )
#define USEMASK_TEMP    (RESET_DDR_IN_TEMP    | RESET_DDR_OUT_TEMP    )
#define USEMASK_SHADES  (RESET_DDR_IN_SHADES  | RESET_DDR_OUT_SHADES  )
 
// Compute XOR and and arithmetic sum of all use masks ...
//   If and only if two or more feature use masks have same bits set, these two numbers differ.
#define USEXOR (USEMASK_TWI_SL ^ USEMASK_GPIO ^ USEMASK_TWI_MA ^ USEMASK_MATRIX ^ USEMASK_ADC ^ USEMASK_UART ^ USEMASK_TEMP ^ USEMASK_SHADES)
#define USESUM (USEMASK_TWI_SL + USEMASK_GPIO + USEMASK_TWI_MA + USEMASK_MATRIX + USEMASK_ADC + USEMASK_UART + USEMASK_TEMP + USEMASK_SHADES)
 
// Check for errors ...
#if USEXOR != USESUM
 
// We have a conflict: Try to print the cause(s) as warnings ...
#if (USEXOR ^ USEMASK_TWI_SL) == (USESUM - USEMASK_TWI_SL)
#warning "TWI slave pins conflict with others!"
#endif
 
#if (USEXOR ^ USEMASK_GPIO) == (USESUM - USEMASK_GPIO)
#warning "GPIO pins conflict with others!"
#endif
 
#if (USEXOR ^ USEMASK_TWI_MA) == (USESUM - USEMASK_TWI_MA)
#warning "TWI master pins conflict with others!"
#endif
 
#if (USEXOR ^ USEMASK_MATRIX) == (USESUM - USEMASK_MATRIX)
#warning "Matrix pins conflict with others!"
#endif
 
#if (USEXOR ^ USEMASK_ADC) == (USESUM - USEMASK_ADC)
#warning "ADC pin(s) conflict with others!"
#endif
 
#if (USEXOR ^ USEMASK_UART) == (USESUM - USEMASK_UART)
#warning "UART pin(s) conflict with others!"
#endif
 
#if (USEXOR ^ USEMASK_TEMP) == (USESUM - USEMASK_TEMP)
#warning "Temperature pin conflicts with others!"
#endif
 
#if (USEXOR ^ USEMASK_SHADES) == (USESUM - USEMASK_SHADES)
#warning "Shades pin(s) conflict with others!"
#endif
 
#error "There are pin conflicts!"
 
#endif // USEMASK != USESUM
 
 
 
// ***** Feature-specific checks *****
 
 
// GPIO ...
#if (GPIO_IN_PRESENCE & GPIO_OUT_PRESENCE) \
    || (GPIO_IN_PRESENCE) >= (1 << GPIO_PINS_MAX) \
    || (GPIO_OUT_PRESENCE) >= (1 << GPIO_PINS_MAX)
#error "GPIOs misconfigured: Too many or concliction GPIOs defined!"
#endif
 
 
// TWI Master...
#if TWI_MA_PORTS > 0 && (!P_TWI_MA_0_SCL || !P_TWI_MA_0_SDA)
#error "TWI master port #0 enabled by configuration, but no MCU pins available!"
#endif
#if TWI_MA_PORTS > 1 && (!P_TWI_MA_1_SCL || !P_TWI_MA_1_SDA)
#error "TWI master port #1 enabled by configuration, but no MCU pins available!"
#endif
#if TWI_MA_PORTS > 2 && (!P_TWI_MA_2_SCL || !P_TWI_MA_2_SDA)
#error "TWI master port #2 enabled by configuration, but no MCU pins available!"
#endif
#if TWI_MA_PORTS > 3 && (!P_TWI_MA_3_SCL || !P_TWI_MA_3_SDA)
#error "TWI master port #3 enabled by configuration, but no MCU pins available!"
#endif
#if TWI_MA_PORTS > 4
#error "At most 4 TWI master ports supported!"
#endif
 
 
// TWI Hub...
#if TWIHUB_PORT > TWI_MA_PORTS
#error "TWI hub: non-existing master port selected"
#endif
 
 
// Matrix...
#if !WITH_MATRIX && (MATRIX_ROWS || MATRIX_COLS)
#warning "Matrix appears to be partly configured - disabled."
#endif
#if MATRIX_ROWS > 8
#error "Matrix: too many rows!"
#endif
#if MATRIX_COLS > 8
#error "Matrix: too many columns!"
#endif
#if (MATRIX_ROWS > 1) && ((MATRIX_ROWS_GSHIFT < 0) || ((MATRIX_ROWS_GSHIFT + MATRIX_ROWS) > GPIO_PINS_MAX))
#error "Matrix: some row lines assigned to non-existing GPIO pins!"
#endif
#if (MATRIX_COLS_GSHIFT < 0) || ((MATRIX_COLS_GSHIFT + MATRIX_COLS) > GPIO_PINS_MAX)
#error "Matrix: some column lines assigned to non-existing GPIO pins!"
#endif
#if (MATRIX_ROWS_GMASK & MATRIX_COLS_GMASK) != 0
#error "Matrix: row and column pins overlap!"
#endif
 
 
// ADCs ...
#if ADC_PORTS > 0 && !P_ADC_0
#error "ADC #0 enabled by configuration, but no MCU pin available!"
#endif
#if ADC_PORTS > 1 && !P_ADC_1
#error "ADC #1 enabled by configuration, but no MCU pin available!"
#endif
#if ADC_PORTS > 2
#error "At most 2 ADC ports supported!"
#endif
 
 
// UART ...
#if WITH_UART && (!P_UART_RX || !P_UART_TX)
#error "UART enabled by configuration, but no MCU pins available!"
#endif
 
 
// Temperature ...
#if WITH_TEMP_ZACWIRE && (!P_TEMP_ZACWIRE)
#error "Temperature ZACwire port enabled by configuration, but no MCU pin available!"
#endif
 
 
// Shades ...
#if SHADES_PORTS > 0 && (!P_SHADES_0_BTN_DN || !P_SHADES_0_BTN_UP || !P_SHADES_0_ACT_DN || !P_SHADES_0_ACT_UP)
#error "Shades #0 enabled by configuration, but no MCU pins available!"
#endif
#if SHADES_PORTS > 1 && (!P_SHADES_1_BTN_DN || !P_SHADES_1_BTN_UP || !P_SHADES_1_ACT_DN || !P_SHADES_1_ACT_UP)
#error "Shades #1 enabled by configuration, but no MCU pins available!"
#endif
#if SHADES_PORTS > 2
#error "At most 2 shades supported!"
#endif
 
 
#endif // !DOXYGEN
 
 
 
 
 
// *************************** 6. MCU: Main Macros *****************************
 
 
// Reset configuration for all used pins ...
#define RESET_DDR_IN_USED (RESET_DDR_IN_TWI_SL | RESET_DDR_IN_GPIO | RESET_DDR_IN_TWI_MA | RESET_DDR_IN_MATRIX | RESET_DDR_IN_ADC | RESET_DDR_IN_UART | RESET_DDR_IN_TEMP | RESET_DDR_IN_SHADES)
#define RESET_DDR_OUT_USED (RESET_DDR_OUT_TWI_SL | RESET_DDR_OUT_GPIO | RESET_DDR_OUT_TWI_MA | RESET_DDR_OUT_MATRIX | RESET_DDR_OUT_ADC | RESET_DDR_OUT_UART | RESET_DDR_OUT_TEMP | RESET_DDR_OUT_SHADES)
#define RESET_STATE_USED (RESET_STATE_TWI_SL | RESET_STATE_GPIO | RESET_STATE_TWI_MA | RESET_STATE_MATRIX | RESET_STATE_ADC | RESET_STATE_UART | RESET_STATE_TEMP | RESET_STATE_SHADES)
 
// Interrupts: All PCINT pins ...
#define PCINT_ALL_PINS (PCINT_PIN_UART | PCINT_PIN_TEMP)
 
// Interrupts: PCINT ISR template ...
#define PCINT_CALL_SUBISRS(P)                   \
  if ((P) & PCINT_PIN_UART) PCINT_ISR_UART();   \
  if ((P) & PCINT_PIN_TEMP) PCINT_ISR_TEMP();
 
 
 
// Explicitly define the mask for all unused pins ...
//    The TWI slave pins, Reset, VCC and GND are excluded here.
//    We assume that all other pins are generally usable as GPIOs.
#define UNUSED_PINS (GPIO_TO_PMASK(0xffff) & ~(RESET_DDR_IN_USED | RESET_DDR_OUT_USED))
 
// Reset configuration for all pins ...
#define RESET_DDR_IN  (RESET_DDR_IN_USED | UNUSED_PINS)
#define RESET_DDR_OUT RESET_DDR_OUT_USED
 
#if !IS_MAINTENANCE
#define RESET_STATE   (RESET_STATE_USED | UNUSED_PINS)
  // Following the Atmel/Microchip recommendations, unused pins are configured as
  // inputs with their internal pullups activated in operational mode.
  // This allows to omit external circuitry for them.
#else
#define RESET_STATE   (RESET_STATE_USED)
  // In maintenance mode, all ports are set into a high-impedance state. This may cause inputs to float.
  // However, we avoid to pull up outputs (in operational mode) in a way that undesired behavior results.
#endif
 
 
 
// Initialization macro for the main program ...
#define INIT_PINS() do {                                      \
  P_DDR_IN(RESET_DDR_IN | RESET_DDR_OUT);                     \
  P_OUT_0((RESET_DDR_IN | RESET_DDR_OUT) & ~RESET_STATE);     \
  P_OUT_1((RESET_DDR_IN | RESET_DDR_OUT) & RESET_STATE);      \
  P_DDR_OUT(RESET_DDR_OUT);                                   \
} while(false);
 
 
 
 
 
#endif // _BROWNIE_CONFIG_