mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2026-01-01 01:41:18 +01:00
drivers: Initial import of SPI low-level driver IF
This commit is contained in:
Hauke Petersen
parent
85a5e6748a
commit
e5ae56323e
159
drivers/include/periph/spi.h
Normal file
159
drivers/include/periph/spi.h
Normal file
@ -0,0 +1,159 @@
|
||||
/*
|
||||
* Copyright (C) 2014 Freie Universität Berlin
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup driver_periph
|
||||
* @brief Low-level SPI peripheral driver
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
* @brief Low-level SPI peripheral driver interface definitions
|
||||
*
|
||||
* TODO: optimize interface for master AND slave usage, interface is focused on master mode so far...
|
||||
*
|
||||
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
*/
|
||||
|
||||
#ifndef __SPI_H
|
||||
#define __SPI_H
|
||||
|
||||
#include "periph_conf.h"
|
||||
|
||||
|
||||
/**
|
||||
* @brief Definition available SPI devices
|
||||
*/
|
||||
typedef enum {
|
||||
#if SPI_0_EN
|
||||
SPI_0 = 0, /**< SPI device 0 */
|
||||
#endif
|
||||
#if SPI_1_EN
|
||||
SPI_1, /**< SPI device 1 */
|
||||
#endif
|
||||
#if SPI_2_EN
|
||||
SPI_2, /**< SPI device 2 */
|
||||
#endif
|
||||
#if SPI_3_EN
|
||||
SPI_3, /**< SPI device 3 */
|
||||
#endif
|
||||
SPI_UNDEFINED
|
||||
} spi_t;
|
||||
|
||||
/**
|
||||
* @brief Define the SPI mode, master or slave
|
||||
*/
|
||||
typedef enum {
|
||||
SPI_MODE_MASTER = 0, /**< configure SPI as master */
|
||||
SPI_MODE_SLAVE /**< configure SPI as slave */
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief The SPI mode is defined by the four possible combinations of clock polarity and
|
||||
* clock phase.
|
||||
*/
|
||||
typedef enum {
|
||||
SPI_CONF_FIRST_RISING = 0, /**< first data bit is transacted on the first rising SCK edge */
|
||||
SPI_CONF_SECOND_RISING, /**< first data bit is transacted on the second rising SCK edge */
|
||||
SPI_CONF_FIRST_FALLING, /**< first data bit is transacted on the first falling SCK edge */
|
||||
SPI_CONF_SECOND_RISING /**< first data bit is transacted on the second falling SCK edge */
|
||||
} spi_conf_t;
|
||||
|
||||
|
||||
/**
|
||||
* @brief Initialize a given SPI device
|
||||
*
|
||||
* @param[in] dev SPI device to initialize
|
||||
* @param[in] mode Configure SPI as master or slave
|
||||
* @param[in] conf Mode of clock phase and clock polarity
|
||||
* @param[in] speed SPI bus speed in Hz
|
||||
*
|
||||
* @return 0 on success
|
||||
* @return -1 on undefined SPI device
|
||||
* @return -2 on unavailable speed value
|
||||
*/
|
||||
int spi_init(spi_t dev, spi_mode_t mode, spi_conf_t conf, uint32_t speed);
|
||||
|
||||
/**
|
||||
* @brief Transfer one byte on the given SPI bus
|
||||
*
|
||||
* @param[in] dev SPI device to use
|
||||
* @param[in] out Byte to send out, set NULL if only receiving
|
||||
* @param[out] in Byte to read, set NULL if only sending
|
||||
*
|
||||
* @return Number of bytes that were transfered
|
||||
* @return -1 on error
|
||||
*/
|
||||
int spi_transfer_byte(spi_t dev, char out, char *in);
|
||||
|
||||
/**
|
||||
* @brief Transfer a number bytes on the given SPI bus
|
||||
*
|
||||
* @param[in] dev SPI device to use
|
||||
* @param[in] out Array of bytes to send, set NULL if only receiving
|
||||
* @param[out] in Buffer to receive bytes to, set NULL if only sending
|
||||
* @param[in] length Number of bytes to transfer
|
||||
*
|
||||
* @return Number of bytes that were transfered
|
||||
* @return -1 on error
|
||||
*/
|
||||
int spi_transfer_bytes(spi_t dev, char *out, char *in, int length);
|
||||
|
||||
/**
|
||||
* @brief Transfer on byte to/from a given register address
|
||||
*
|
||||
* This function is a shortcut function for easier handling of register based SPI devices. As
|
||||
* many SPI devices us a register based addressing scheme, this function is a convenient short-
|
||||
* cut for interfacing with such devices.
|
||||
*
|
||||
* @param[in] dev SPI device to use
|
||||
* @param[in] reg Register address to transfer data to/from
|
||||
* @param[in] out Byte to send, set NULL if only receiving data
|
||||
* @param[out] in Byte to read, set NULL if only sending
|
||||
*
|
||||
* @return Number of bytes that were transfered
|
||||
* @return -1 on error
|
||||
*/
|
||||
int spi_transfer_reg(spi_t dev, uint8_t reg, char *out, char *in);
|
||||
|
||||
/**
|
||||
* @brief Transfer a number of bytes from/to a given register address
|
||||
*
|
||||
* This function is a shortcut function for easier handling of register based SPI devices. As
|
||||
* many SPI devices us a register based addressing scheme, this function is a convenient short-
|
||||
* cut for interfacing with such devices.
|
||||
*
|
||||
* @param[in] dev SPI device to use
|
||||
* @param[in] reg Register address to transfer data to/from
|
||||
* @param[in] out Byte array to send data from, set NULL if only receiving
|
||||
* @param[out] in Byte buffer to read into, set NULL if only sending
|
||||
* @param[in] length Number of bytes to transfer
|
||||
*
|
||||
* @return Number of bytes that were transfered
|
||||
* @return -1 on error
|
||||
*/
|
||||
int spi_transfer_regs(spi_t dev, uint8_t reg, char *out, char *in, int length);
|
||||
|
||||
/**
|
||||
* @brief Power on the given SPI device
|
||||
*
|
||||
* @param[in] dev SPI device to power on
|
||||
*
|
||||
* @return 0 on success
|
||||
* @return -1 on undefined device
|
||||
*/
|
||||
int spi_poweron(spi_t dev);
|
||||
|
||||
/**
|
||||
* @brief Power off the given SPI device
|
||||
*
|
||||
* @param[in] dev SPI device to power off
|
||||
*
|
||||
* @return 0 on success
|
||||
* @return -1 on undefined device
|
||||
*/
|
||||
int spi_poweroff(spi_t dev);
|
||||
Loading…
x
Reference in New Issue
Block a user