wirish.h

Go to the documentation of this file.

#ifndef _wirish_h
#define _wirish_h
 
#if defined(STM32F030x6)
#include <stm32f030x6.h>
#include "stm32f0xx_hal.h"
#define LED_BUILTIN (PA2)
 
#elif defined(STM32F070x6)
#include <stm32f070x6.h>
#include "stm32f0xx_hal.h"
 
#elif defined(STM32F070xB)
#include <stm32f070xb.h>
#include "stm32f0xx_hal.h"
 
#elif defined(STM32F031x6)
#include <stm32f031x6.h>
#include "stm32f0xx_hal.h"
 
#elif defined(STM32F103xB)
#include <stm32f103xb.h>
#include "stm32f1xx_hal.h"
#define LED_BUILTIN (PC13)
 
#elif defined(STM32L031xx)
#include <stm32l031xx.h>
#include "stm32l0xx_hal.h"
#define LED_BUILTIN (PB3)
 
//Nucleo L031 pin mapping
#define D0  PA10
#define D1  PA9
#define D2  PA12
#define D3  PB0
#define D4  PB7
#define D5  PB6
#define D6  PB1
#define D9  PA8
#define D10 PA11
#define D11 PB5
#define D12 PB4
#define D13 PB3
#define A0  PA0
#define A1  PA1
#define A2  PA3
#define A3  PA4
#define A4  PA5
#define A5  PA6
#define A6  PA7
#define A7  PA2
 
#elif defined(STM32L432xx)
#include <stm32l432xx.h>
#include "stm32l4xx_hal.h"
#define LED_BUILTIN (PB3)
 
//Nucleo L432 pin mapping
#define D0  PA10
#define D1  PA9
#define D2  PA12
#define D3  PB0
#define D4  PB7
#define D5  PB6
#define D6  PB1
#define D9  PA8
#define D10 PA11
#define D11 PB5
#define D12 PB4
#define D13 PB3
#define A0  PA0
#define A1  PA1
#define A2  PA3
#define A3  PA4
#define A4  PA5
#define A5  PA6
#define A6  PA7
#define A7  PA2
 
#else
#error "Library for your chip is not included"
#endif
 
#if defined(USE_HAL_DRIVER) && !defined(STM32)
#define STM32
#endif
 
#if !defined(HAL_GPIO_MODULE_ENABLED)
#error "GPIO is disabled in .ioc file, modify at least one pin to use wirish file"
#endif
 
 
#ifndef W_INT_HANDLING_MODE
 
#define W_INT_HANDLING_MODE 2
#endif
 
 
#include "interrupt.h"
#include <functional>
 
#define W_OK 1
 
#define W_BAD_ARG -1
 
#define W_ERR 0
 
// Pin name definitions - BEGIN
#if defined(GPIOA)
#define PA0 0x00
#define PA1 0x01
#define PA2 0x02
#define PA3 0x03
#define PA4 0x04
#define PA5 0x05
#define PA6 0x06
#define PA7 0x07
#define PA8 0x08
#define PA9 0x09
#define PA10 0x0A
#define PA11 0x0B
#define PA12 0x0C
#define PA13 0x0D
#define PA14 0x0E
#define PA15 0x0F
 
#define PA00 PA0
#define PA01 PA1
#define PA02 PA2
#define PA03 PA3
#define PA04 PA4
#define PA05 PA5
#define PA06 PA6
#define PA07 PA7
#define PA08 PA8
#define PA09 PA9
#endif
 
#if defined(GPIOB)
#define PB0 0x10
#define PB1 0x11
#define PB2 0x12
#define PB3 0x13
#define PB4 0x14
#define PB5 0x15
#define PB6 0x16
#define PB7 0x17
#define PB8 0x18
#define PB9 0x19
#define PB10 0x1A
#define PB11 0x1B
#define PB12 0x1C
#define PB13 0x1D
#define PB14 0x1E
#define PB15 0x1F
 
#define PB00 PB0
#define PB01 PB1
#define PB02 PB2
#define PB03 PB3
#define PB04 PB4
#define PB05 PB5
#define PB06 PB6
#define PB07 PB7
#define PB08 PB8
#define PB09 PB9
#endif
 
#if defined(GPIOC)
#define PC0 0x20
#define PC1 0x21
#define PC2 0x22
#define PC3 0x23
#define PC4 0x24
#define PC5 0x25
#define PC6 0x26
#define PC7 0x27
#define PC8 0x28
#define PC9 0x29
#define PC10 0x2A
#define PC11 0x2B
#define PC12 0x2C
#define PC13 0x2D
#define PC14 0x2E
#define PC15 0x2F
 
#define PC00 PC0
#define PC01 PC1
#define PC02 PC2
#define PC03 PC3
#define PC04 PC4
#define PC05 PC5
#define PC06 PC6
#define PC07 PC7
#define PC08 PC8
#define PC09 PC9
#endif
 
#if defined(GPIOD)
#define PD0 0x30
#define PD1 0x31
#define PD2 0x32
#define PD3 0x33
#define PD4 0x34
#define PD5 0x35
#define PD6 0x36
#define PD7 0x37
#define PD8 0x38
#define PD9 0x39
#define PD10 0x3A
#define PD11 0x3B
#define PD12 0x3C
#define PD13 0x3D
#define PD14 0x3E
#define PD15 0x3F
 
#define PD00 PD0
#define PD01 PD1
#define PD02 PD2
#define PD03 PD3
#define PD04 PD4
#define PD05 PD5
#define PD06 PD6
#define PD07 PD7
#define PD08 PD8
#define PD09 PD9
#endif
 
#if defined(GPIOE)
#define PE0 0x40
#define PE1 0x41
#define PE2 0x42
#define PE3 0x43
#define PE4 0x44
#define PE5 0x45
#define PE6 0x46
#define PE7 0x47
#define PE8 0x48
#define PE9 0x49
#define PE10 0x4A
#define PE11 0x4B
#define PE12 0x4C
#define PE13 0x4D
#define PE14 0x4E
#define PE15 0x4F
 
#define PE00 PE0
#define PE01 PE1
#define PE02 PE2
#define PE03 PE3
#define PE04 PE4
#define PE05 PE5
#define PE06 PE6
#define PE07 PE7
#define PE08 PE8
#define PE09 PE9
#endif
 
#if defined(GPIOF)
#define PF0 0x50
#define PF1 0x51
#define PF2 0x52
#define PF3 0x53
#define PF4 0x54
#define PF5 0x55
#define PF6 0x56
#define PF7 0x57
#define PF8 0x58
#define PF9 0x59
#define PF10 0x5A
#define PF11 0x5B
#define PF12 0x5C
#define PF13 0x5D
#define PF14 0x5E
#define PF15 0x5F
 
#define PF00 PF0
#define PF01 PF1
#define PF02 PF2
#define PF03 PF3
#define PF04 PF4
#define PF05 PF5
#define PF06 PF6
#define PF07 PF7
#define PF08 PF8
#define PF09 PF9
#endif
 
#if defined(GPIOG)
#define PG0 0x60
#define PG1 0x61
#define PG2 0x62
#define PG3 0x63
#define PG4 0x64
#define PG5 0x65
#define PG6 0x66
#define PG7 0x67
#define PG8 0x68
#define PG9 0x69
#define PG10 0x6A
#define PG11 0x6B
#define PG12 0x6C
#define PG13 0x6D
#define PG14 0x6E
#define PG15 0x6F
 
#define PG00 PG0
#define PG01 PG1
#define PG02 PG2
#define PG03 PG3
#define PG04 PG4
#define PG05 PG5
#define PG06 PG6
#define PG07 PG7
#define PG08 PG8
#define PG09 PG9
#endif
 
#if defined(GPIOH)
#define PH0 0x70
#define PH1 0x71
#define PH2 0x72
#define PH3 0x73
#define PH4 0x74
#define PH5 0x75
#define PH6 0x76
#define PH7 0x77
#define PH8 0x78
#define PH9 0x79
#define PH10 0x7A
#define PH11 0x7B
#define PH12 0x7C
#define PH13 0x7D
#define PH14 0x7E
#define PH15 0x7F
 
#define PH00 PH0
#define PH01 PH1
#define PH02 PH2
#define PH03 PH3
#define PH04 PH4
#define PH05 PH5
#define PH06 PH6
#define PH07 PH7
#define PH08 PH8
#define PH09 PH9
#endif
 
#if defined(GPIOI)
#define PI0 0x80
#define PI1 0x81
#define PI2 0x82
#define PI3 0x83
#define PI4 0x84
#define PI5 0x85
#define PI6 0x86
#define PI7 0x87
#define PI8 0x88
#define PI9 0x89
#define PI10 0x8A
#define PI11 0x8B
#define PI12 0x8C
#define PI13 0x8D
#define PI14 0x8E
#define PI15 0x8F
 
#define PI00 PI0
#define PI01 PI1
#define PI02 PI2
#define PI03 PI3
#define PI04 PI4
#define PI05 PI5
#define PI06 PI6
#define PI07 PI7
#define PI08 PI8
#define PI09 PI9
#endif
 
#if defined(GPIOJ)
#define PJ0 0x90
#define PJ1 0x91
#define PJ2 0x92
#define PJ3 0x93
#define PJ4 0x94
#define PJ5 0x95
#define PJ6 0x96
#define PJ7 0x97
#define PJ8 0x98
#define PJ9 0x99
#define PJ10 0x9A
#define PJ11 0x9B
#define PJ12 0x9C
#define PJ13 0x9D
#define PJ14 0x9E
#define PJ15 0x9F
 
#define PJ00 PJ0
#define PJ01 PJ1
#define PJ02 PJ2
#define PJ03 PJ3
#define PJ04 PJ4
#define PJ05 PJ5
#define PJ06 PJ6
#define PJ07 PJ7
#define PJ08 PJ8
#define PJ09 PJ9
#endif
 
#if defined(GPIOK)
#define PK0 0xA0
#define PK1 0xA1
#define PK2 0xA2
#define PK3 0xA3
#define PK4 0xA4
#define PK5 0xA5
#define PK6 0xA6
#define PK7 0xA7
#define PK8 0xA8
#define PK9 0xA9
#define PK10 0xAA
#define PK11 0xAB
#define PK12 0xAC
#define PK13 0xAD
#define PK14 0xAE
#define PK15 0xAF
 
#define PK00 PK0
#define PK01 PK1
#define PK02 PK2
#define PK03 PK3
#define PK04 PK4
#define PK05 PK5
#define PK06 PK6
#define PK07 PK7
#define PK08 PK8
#define PK09 PK9
#endif
 
#if defined(GPIOL) || defined(GPIOM) || defined(GPION) || defined(GPIOO) || defined(GPIOP) || defined(GPIOQ) || defined(GPIOR) || defined(GPIOS) || defined(GPIOT) || defined(GPIOU) || defined(GPIOV) || defined(GPIOW) || defined(GPIOX) || defined(GPIOY) || defined(GPIOZ)
#warning "Some GPIOx ports have not got defined pin names!"
#endif
// Pin name definitions - END
 
typedef enum WiringPinMode {
    OUTPUT, 
    OUTPUT_OPEN_DRAIN, 
    INPUT, 
    INPUT_ANALOG, 
    INPUT_PULLUP, 
    INPUT_PULLDOWN, 
    INPUT_FLOATING, 
    /*PWM,*/ 
    /*PWM_OPEN_DRAIN,*/ 
} WiringPinMode;
 
//GPIO_TypeDef* PIN_TO_PORT (uint8_t pin);
 
bool pinExists(GPIO_TypeDef *GPIOx, uint16_t PPin);
 
bool pinExists(uint8_t Pin);
 
bool enableGPIO(GPIO_TypeDef* GPIOx, bool enable);
 
#define PIN_TO_PORT_PIN(Pin) (0x01 << ((Pin)&0x0F)) //Arduino like pin to Pin of port
 
#define PIN_TO_PORT(Pin) (GPIO_Conversion_Table[(Pin)>>4]) //Arduino like pin to Port
 
extern GPIO_TypeDef *GPIO_Conversion_Table[];
 
uint8_t PortAndPinToPinNum(GPIO_TypeDef *GPIOx, uint16_t PPin);
 
bool canSetInterruptOnPin(uint8_t Pin);
 
GPIO_TypeDef* getInterruptGPIOfromPin(uint16_t Pin);
 
bool isInterruptSetOnPin(uint8_t Pin);
 
uint8_t pinMode(GPIO_TypeDef *GPIOx, uint16_t PPin, WiringPinMode mode, uint32_t speed);
 
inline void digitalWrite(GPIO_TypeDef *GPIOx, uint16_t PPin, bool val){
    HAL_GPIO_WritePin(GPIOx, PPin, (GPIO_PinState)val);
}
 
inline uint16_t digitalRead(GPIO_TypeDef *GPIOx, uint16_t PPin){
    return (uint16_t)HAL_GPIO_ReadPin(GPIOx, PPin);
}
 
inline void digitalToggle(GPIO_TypeDef *GPIOx, uint16_t PPin){
    HAL_GPIO_TogglePin(GPIOx, PPin);
}
 
//---Arduino like functions BEGIN
 
uint8_t pinMode(uint8_t Pin, WiringPinMode mode, uint32_t speed);
 
uint8_t inline pinMode(uint8_t Pin, WiringPinMode mode){
    return pinMode(Pin, mode, GPIO_SPEED_FREQ_LOW);
}
 
inline void digitalWrite(uint8_t Pin, bool val){
    HAL_GPIO_WritePin(PIN_TO_PORT(Pin), PIN_TO_PORT_PIN(Pin), (GPIO_PinState)val);
}
 
inline bool digitalRead(uint8_t Pin){
    GPIO_TypeDef *GPIOx = PIN_TO_PORT(Pin);
    uint16_t PPin = PIN_TO_PORT_PIN(Pin);
    /* Check the parameters */
    assert_param(IS_GPIO_PIN_AVAILABLE(GPIOx, PPin));
    return (GPIOx->IDR & PPin) != (uint32_t)GPIO_PIN_RESET;
}
 
inline void digitalToggle(uint8_t Pin){
    digitalWrite(Pin,!digitalRead(Pin));
}
 
int8_t attachInterrupt(uint8_t Pin, std::function<void(void)>, int mode);
 
int8_t detachInterrupt(uint8_t Pin, bool disableEXTIwhenNotUsed = false);
 
void InterruptHandler(uint8_t lineFrom, uint8_t lineTo);
 
int8_t isPinUsedByInt(uint8_t INTPPin);
 
uint32_t getPinPullSetting(GPIO_TypeDef *GPIOx, uint8_t INTPin);
 
uint32_t getPinSpeedSetting(GPIO_TypeDef *GPIOx, uint8_t INTPin);
 
//#define min(a,b) (((a)<(b))?(a):(b))
//#define max(a,b) (((a)>(b))?(a):(b))
 
#if !defined(min)
 
#define MIN(a,b) (((a)<(b))?(a):(b))
#endif
#if !defined(max)
 
#define MAX(a,b) (((a)>(b))?(a):(b))
#endif
#if !defined(Abs)
 
#define Abs(a) (((a)>=0)?(a):-(a))
#endif
 
 
#define lowByte(w)                     ((w) & 0xFF)
 
#define highByte(w)                    (((w) >> 8) & 0xFF)
 
#define bitRead(value, bit)            (((value) >> (bit)) & 0x01)
 
#define bitSet(value, bit)             ((value) |= (1UL << (bit)))
 
#define bitClear(value, bit)           ((value) &= ~(1UL << (bit)))
 
#define bitWrite(value, bit, bitvalue) (bitvalue ? bitSet(value, bit) : \
                                                   bitClear(value, bit))
 
#define bit(b)                         (1UL << (b))
 
#define millis() HAL_GetTick()
/*unsigned long inline millis(void){
    return HAL_GetTick();
}*/
 
#define delay(millis) HAL_Delay(millis)
//void delay(unsigned long millis);
 
bool WirishInit(void);
 
#ifdef DWT
//TODO add here calibration value for DWT
#else
//Value established by measuring to 16-18, it has to be measured more properly
#define WAIT_US_CALIBRATION (18) //It says, how many cycles (Not clock cycles) are used by calling this functions
//Ticks needed for calling this method ticks = WAIT_US_CALIBRATION * 3; (asm line takes 3 ticks for one cycle)
//Also minumum wait time is t = (WAIT_US_CALIBRATION * 3 + 2)/SystemCoreClock [seconds]
#endif
 
#if defined(DWT) || defined(DOXYGEN_FORCED) //We can use Data Watchpoint and Trace Register (DWT) and it's cycle counter
 
void __attribute__((optimize("Ofast"))) delayMicrosecondsDWT(uint32_t microseconds);
#endif //defined(DWT) || defined(DOXYGEN_FORCED)
 
void __attribute__((optimize("Ofast"))) delayMicroseconds(int32_t microseconds);
 
inline uint32_t __attribute__((optimize("Ofast"))) micros(){
/*#ifdef DWT //We can use Data Watchpoint and Trace Register (DWT) and it's cycle counter
    return cyccnt / (SystemCoreClock / 1000000); //TODO result may be truncated
 
#else //For MCUs, that does not have DWT*/
    uint32_t load = SysTick->LOAD;
    volatile uint32_t ms = uwTick; //This is set to volatile to not remove if statement bellow by optimization
    uint32_t initVal = SysTick->VAL;
    if(ms != uwTick){ //This solves situation, when storing uwTick SysTick->VAL overflowed, it can cause 1ms error
        //We know, SysTick->VAL overflowed, so values have to be captured again
        initVal = SysTick->VAL;
        ms = uwTick;
    }
    return ms*1000UL + ((load-initVal)*1000)/(load+1);
//#endif //DWT
}
 
inline uint64_t __attribute__((optimize("Ofast"))) micros64(){
/*#ifdef DWT //We can use Data Watchpoint and Trace Register (DWT) and it's cycle counter
    return cyccnt / (SystemCoreClock / 1000000); //TODO result may be truncated
 
#else //For MCUs, that does not have DWT*/
    uint32_t load = SysTick->LOAD;
    volatile uint32_t ms = uwTick; //This is set to volatile to not remove if statement bellow by optimization
    uint32_t initVal = SysTick->VAL;
    if(ms != uwTick){ //This solves situation, when storing uwTick SysTick->VAL overflowed, it can cause 1ms error
        //We know, SysTick->VAL overflowed, so values have to be captured again
        initVal = SysTick->VAL;
        ms = uwTick;
    }
    return ((uint64_t)ms)*1000ULL + (((uint64_t)(load-initVal))*1000ULL)/(load+1);
//#endif //DWT
}
 
#define cli() __disable_irq()
 
#define noInterrupts() cli()
 
#define sei() __enable_irq()
 
#define interrupts() sei()
 
 
//extern void attachInterrupt(uint8_t, void (*)(void), int mode);
 
unsigned long random(unsigned long from, unsigned long to);
 
unsigned long random(unsigned long to);
 
void randomSeed(unsigned long seed);
 
#define HIGH 0x1
 
#define LOW  0x0
 
#define LSBFIRST 0
 
#define MSBFIRST 1
 
#define CHANGE 1
 
#define FALLING 2
 
#define RISING 3
 
//---Arduino like functions END
 
#ifndef RCC_FLAG_PORRST
 
#define RESET_CAUSE_POWER_ON_POWER_DOWN_RESET RESET_CAUSE_EXTERNAL_RESET_PIN_RESET
#endif
 
typedef enum reset_cause_e{
    RESET_CAUSE_UNKNOWN = 0,
    RESET_CAUSE_LOW_POWER_RESET = 1,
    RESET_CAUSE_WINDOW_WATCHDOG_RESET = 2,
    RESET_CAUSE_INDEPENDENT_WATCHDOG_RESET = 3,
    RESET_CAUSE_SOFTWARE_RESET = 4,
#ifdef RCC_FLAG_PORRST
 
    RESET_CAUSE_POWER_ON_POWER_DOWN_RESET = 5,
#endif
 
    RESET_CAUSE_EXTERNAL_RESET_PIN_RESET = 6,
    RESET_CAUSE_BROWNOUT_RESET = 7,
#ifdef RCC_FLAG_FWRST
 
    RESET_CAUSE_FIREWALL_RESET = 8,
#endif
#ifdef RCC_FLAG_OBLRST
 
    RESET_CAUSE_OPT_BYTE_LDR_RESET = 9,
#endif
} ResetCause;
 
extern ResetCause rst_cs;
 
const char* getResetCauseName();
 
inline ResetCause getResetCause(){
    return rst_cs;
}
 
inline void getDeviceLOTID(char* buffer){
    buffer[0] = *((const char*) (UID_BASE + 5));
    buffer[1] = *((const char*) (UID_BASE + 6));
    buffer[2] = *((const char*) (UID_BASE + 7));
    buffer[3] = ' ';
    buffer[4] = *((const char*) (UID_BASE + 8));
    buffer[5] = *((const char*) (UID_BASE + 9));
    buffer[6] = *((const char*) (UID_BASE + 10));
    buffer[7] = 0;
}
 
 
inline uint8_t getDeviceWAFID(){
    return *((volatile uint8_t *)(UID_BASE + 4));
}
 
inline uint16_t getDeviceWAFX(){
    return *((volatile uint16_t *)(UID_BASE));
}
 
inline uint16_t getDeviceWAFY(){
    return *((volatile uint16_t *)(UID_BASE + 2));
}
 
inline uint32_t getFlashSize(){
    return *((volatile uint16_t *)(FLASHSIZE_BASE)) * 1024;
}
 
#endif