cpu_spi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Freie Universität Berlin
 *               2017 OTA keys S.A.
 *
 * 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 <stdint.h>
 
#include "cpu.h"
#include "macros/units.h"
#include "periph/cpu_dma.h"
#include "periph/cpu_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef DOXYGEN
/* resolve circular dependency by declaring spi_t here */
#define HAVE_SPI_T
typedef uint_fast8_t spi_t;
#endif

#define SPI_HWCS_MASK       (0xffffff00)

#define SPI_HWCS(x)         (SPI_HWCS_MASK | x)

#define SPI_CS_UNDEF        (GPIO_UNDEF)
 
#ifndef DOXYGEN
#define HAVE_SPI_CS_T
typedef uint32_t spi_cs_t;
#endif

#define PERIPH_SPI_NEEDS_TRANSFER_BYTE
#define PERIPH_SPI_NEEDS_TRANSFER_REG
#define PERIPH_SPI_NEEDS_TRANSFER_REGS

#define HAVE_SPI_CLK_T
enum {
    SPI_CLK_100KHZ = KHZ(100), 
    SPI_CLK_400KHZ = KHZ(400), 
    SPI_CLK_1MHZ   = MHZ(1),   
    SPI_CLK_5MHZ   = MHZ(5),   
    SPI_CLK_10MHZ  = MHZ(10),  
};

typedef uint32_t spi_clk_t;

typedef struct {
    SPI_TypeDef *dev;       
    gpio_t mosi_pin;        
    gpio_t miso_pin;        
    gpio_t sclk_pin;        
    spi_cs_t cs_pin;        
#ifndef CPU_FAM_STM32F1
    gpio_af_t mosi_af;      
    gpio_af_t miso_af;      
    gpio_af_t sclk_af;      
    gpio_af_t cs_af;        
#endif
    uint32_t rccmask;       
    uint8_t apbbus;         
#ifdef MODULE_PERIPH_DMA
    dma_t tx_dma;           
    uint8_t tx_dma_chan;    
    dma_t rx_dma;           
    uint8_t rx_dma_chan;    
#endif
} spi_conf_t;
 
#ifndef DOXYGEN
gpio_t spi_pin_miso(spi_t bus);
gpio_t spi_pin_mosi(spi_t bus);
gpio_t spi_pin_clk(spi_t bus);
#endif
 
#ifdef __cplusplus
}
#endif