soft_spi.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Hamburg University of Applied Sciences
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "periph/gpio.h"
#include "periph/spi.h"
#include "mutex.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef SOFT_SPI_DEV
#define SOFT_SPI_DEV(x)      (x)
#endif

#ifndef SOFT_SPI_UNDEF
#define SOFT_SPI_UNDEF       (UINT_MAX)
#endif

#ifndef SOFT_SPI_CS_UNDEF
#define SOFT_SPI_CS_UNDEF    (GPIO_UNDEF)
#endif

typedef unsigned int soft_spi_t;

typedef gpio_t soft_spi_cs_t;

enum {
    SOFT_SPI_OK          =  0,   
    SOFT_SPI_NODEV       = -1,   
    SOFT_SPI_NOCS        = -2,   
    SOFT_SPI_NOMODE      = -3,   
    SOFT_SPI_NOCLK       = -4    
};

typedef enum {
    SOFT_SPI_MODE_0 = 0,         
    SOFT_SPI_MODE_1,             
    SOFT_SPI_MODE_2,             
    SOFT_SPI_MODE_3              
} soft_spi_mode_t;

typedef enum {
    SOFT_SPI_CLK_100KHZ = 5,     
    SOFT_SPI_CLK_1MHZ   = 1,     
    SOFT_SPI_CLK_DEFAULT = 0,    
} soft_spi_clk_t;

typedef struct {
    gpio_t miso_pin;                
    gpio_t mosi_pin;                
    gpio_t clk_pin;                 
    soft_spi_mode_t soft_spi_mode;  
    soft_spi_clk_t soft_spi_clk;    
} soft_spi_conf_t;

void soft_spi_init(soft_spi_t bus);

void soft_spi_init_pins(soft_spi_t bus);

int soft_spi_init_cs(soft_spi_t bus, soft_spi_cs_t cs);

void soft_spi_acquire(soft_spi_t bus, soft_spi_cs_t cs, soft_spi_mode_t mode, soft_spi_clk_t clk);

void soft_spi_release(soft_spi_t bus);

uint8_t soft_spi_transfer_byte(soft_spi_t bus, soft_spi_cs_t cs, bool cont, uint8_t out);

void soft_spi_transfer_bytes(soft_spi_t bus, soft_spi_cs_t cs, bool cont,
                        const void *out, void *in, size_t len);

uint8_t soft_spi_transfer_reg(soft_spi_t bus, soft_spi_cs_t cs, uint8_t reg, uint8_t out);

void soft_spi_transfer_regs(soft_spi_t bus, soft_spi_cs_t cs, uint8_t reg,
                       const void *out, void *in, size_t len);
 
#ifdef __cplusplus
}
#endif