circuitpython/ports/stm/peripherals/stm32f4/periph.h

/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Lucian Copeland for Adafruit Industries
 *
 * 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.
 */

#ifndef __MICROPY_INCLUDED_STM32F4_PERIPHERALS_PERIPH_H__
#define __MICROPY_INCLUDED_STM32F4_PERIPHERALS_PERIPH_H__

#include <stdint.h>
#include <stdbool.h>

#include "stm32f4xx_hal.h"
#include "stm32f4/pins.h"

// I2C 
// TODO: these objects should be condensed into a single 'periph_pin' unless we
// find a compelling reason to store more unique data in them. 

typedef struct {
    uint8_t i2c_index:4; // Index of the I2C unit (1 to 3)
    uint8_t altfn_index:4; //Index of the altfn for this pin (0 to 15)
    const mcu_pin_obj_t * pin;
} mcu_i2c_sda_obj_t;

typedef struct {
    uint8_t i2c_index:4; 
    uint8_t altfn_index:4; 
    const mcu_pin_obj_t * pin;
} mcu_i2c_scl_obj_t;


#define I2C_SDA(index, alt, sda_pin)       \
{ \
    .i2c_index = index, \
    .altfn_index = alt, \
    .pin = sda_pin, \
}

#define I2C_SCL(index, alt, scl_pin)       \
{ \
    .i2c_index = index, \
    .altfn_index = alt, \
    .pin = scl_pin, \
}

// SPI 
// TODO: these objects should be condensed into a single 'periph_pin' unless we
// find a compelling reason to store more unique data in them. 

typedef struct {
    uint8_t spi_index:4; //Up to 6 SPI units
    uint8_t altfn_index:4; //Up to 15 alt channels
    const mcu_pin_obj_t * pin;
} mcu_spi_sck_obj_t;

typedef struct {
    uint8_t spi_index:4; 
    uint8_t altfn_index:4; 
    const mcu_pin_obj_t * pin;
} mcu_spi_mosi_obj_t;

typedef struct {
    uint8_t spi_index:4; 
    uint8_t altfn_index:4; 
    const mcu_pin_obj_t * pin;
} mcu_spi_miso_obj_t;

typedef struct {
    uint8_t spi_index:4; 
    uint8_t altfn_index:4; 
    const mcu_pin_obj_t * pin;
} mcu_spi_nss_obj_t;

#define SPI(index, alt, spi_pin)       \
{ \
    .spi_index = index, \
    .altfn_index = alt, \
    .pin = spi_pin, \
}

// UART
// TODO: these objects should be condensed into a single 'periph_pin' unless we
// find a compelling reason to store more unique data in them. 

typedef struct {
    uint8_t uart_index:4; 
    uint8_t altfn_index:4; 
    const mcu_pin_obj_t * pin;
} mcu_uart_tx_obj_t;

typedef struct {
    uint8_t uart_index:4; 
    uint8_t altfn_index:4; 
    const mcu_pin_obj_t * pin;
} mcu_uart_rx_obj_t;

#define UART(index, alt, uart_pin)       \
{ \
    .uart_index = index, \
    .altfn_index = alt, \
    .pin = uart_pin, \
}

//Timers
typedef struct {
    uint8_t tim_index:4; 
    uint8_t altfn_index:4; 
    uint8_t channel_index:4;
    const mcu_pin_obj_t * pin;
} mcu_tim_pin_obj_t;

#define TIM(index, alt, channel, tim_pin)       \
{ \
    .tim_index = index, \
    .altfn_index = alt, \
    .channel_index = channel, \
    .pin = tim_pin, \
}

//Access Lines

#ifdef STM32F401xE
#define HAS_DAC 0
#define HAS_TRNG 0
#define HAS_BASIC_TIM 0
#include "stm32f401xe/periph.h"
#endif

#ifdef STM32F411xE
#define HAS_DAC 0
#define HAS_TRNG 0
#define HAS_BASIC_TIM 0
#include "stm32f411xe/periph.h"
#endif

#ifdef STM32F412Zx
#define HAS_DAC 0
#define HAS_TRNG 1
#define HAS_BASIC_TIM 1
#include "stm32f412zx/periph.h"
#endif

//Foundation Lines

#ifdef STM32F405xx
#define HAS_DAC 1
#define HAS_TRNG 1
#define HAS_BASIC_TIM 1
#include "stm32f405xx/periph.h"
#endif

#ifdef STM32F407xx
#define HAS_DAC 1
#define HAS_TRNG 1
#define HAS_BASIC_TIM 1
#include "stm32f407xx/periph.h"
#endif

#endif // __MICROPY_INCLUDED_STM32F4_PERIPHERALS_PERIPH_H__