91882209bf
Documenting the SPI HAL API
226 lines
6.5 KiB
C
226 lines
6.5 KiB
C
/*
|
|
* Copyright (c) 2016-2017, Yanzi Networks.
|
|
* Copyright (c) 2017, University of Bristol - http://www.bristol.ac.uk/
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#include "spi-hal.h"
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_acquire(spi_device_t *dev)
|
|
{
|
|
spi_status_t r;
|
|
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
/* lock the bus */
|
|
r = spi_arch_lock(dev);
|
|
if(r != SPI_DEV_STATUS_OK) {
|
|
return r;
|
|
}
|
|
|
|
/* open the bus */
|
|
return spi_arch_open(dev);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_release(spi_device_t *dev)
|
|
{
|
|
spi_status_t r;
|
|
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
/* unlock the bus */
|
|
r = spi_arch_close(dev);
|
|
if(r != SPI_DEV_STATUS_OK) {
|
|
return r;
|
|
}
|
|
|
|
/* unlock the bus */
|
|
return spi_arch_unlock(dev);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_select(spi_device_t *dev)
|
|
{
|
|
return spi_arch_select(dev);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_deselect(spi_device_t *dev)
|
|
{
|
|
return spi_arch_deselect(dev);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
bool
|
|
spi_has_bus(spi_device_t *dev)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return false;
|
|
}
|
|
|
|
return spi_arch_has_lock(dev);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_write_byte(spi_device_t *dev, uint8_t data)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, &data, 1, 0, 0, 0);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_write(spi_device_t *dev, const uint8_t *data, int size)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, data, size, 0, 0, 0);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_read_byte(spi_device_t *dev, uint8_t *buf)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, NULL, 0, buf, 1, 0);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_read(spi_device_t *dev, uint8_t *buf, int size)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, NULL, 0, buf, size, 0);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_read_skip(spi_device_t *dev, int size)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, NULL, 0, NULL, 0, size);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_transfer(spi_device_t *dev,
|
|
const uint8_t *wdata, int wsize,
|
|
uint8_t *rbuf, int rsize, int ignore)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
if(wdata == NULL && wsize > 0) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(rbuf == NULL && rsize > 0) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, wdata, wsize, rbuf, rsize, ignore);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_read_register(spi_device_t *dev, uint8_t reg, uint8_t *data, int size)
|
|
{
|
|
spi_status_t status;
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
/* write the register first (will read a status) */
|
|
status = spi_write_byte(dev, reg);
|
|
if(status != SPI_DEV_STATUS_OK) {
|
|
return status;
|
|
}
|
|
|
|
/* then read the value (will read the value) */
|
|
status = spi_read(dev, data, size);
|
|
if(status != SPI_DEV_STATUS_OK) {
|
|
return status;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
spi_status_t
|
|
spi_strobe(spi_device_t *dev, uint8_t strobe, uint8_t *result)
|
|
{
|
|
if(dev == NULL || dev->spi_controller >= BOARD_SPI_CONTROLLERS) {
|
|
return SPI_DEV_STATUS_EINVAL;
|
|
}
|
|
|
|
if(!spi_arch_has_lock(dev)) {
|
|
return SPI_DEV_STATUS_BUS_LOCKED;
|
|
}
|
|
|
|
return spi_arch_transfer(dev, &strobe, 1, result, 1, 0);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|