no-OS
Functions
spi.c File Reference

Implementation of the SPI Interface. More...

#include <inttypes.h>
#include "no-os/spi.h"
#include <stdlib.h>
#include "no-os/error.h"
Include dependency graph for spi.c:

Functions

int32_t spi_init (struct spi_desc **desc, const struct spi_init_param *param)
 Initialize the SPI communication peripheral. More...
 
int32_t spi_remove (struct spi_desc *desc)
 Free the resources allocated by spi_init(). More...
 
int32_t spi_write_and_read (struct spi_desc *desc, uint8_t *data, uint16_t bytes_number)
 Write and read data to/from SPI. More...
 
int32_t spi_transfer (struct spi_desc *desc, struct spi_msg *msgs, uint32_t len)
 Iterate over head list and send all spi messages. More...
 

Detailed Description

Implementation of the SPI Interface.

Author
Antoniu Miclaus (anton.nosp@m.iu.m.nosp@m.iclau.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright 2020(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.

Function Documentation

◆ spi_init()

int32_t spi_init ( struct spi_desc **  desc,
const struct spi_init_param param 
)

Initialize the SPI communication peripheral.

Parameters
desc- The SPI descriptor.
param- The structure that contains the SPI parameters.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ spi_remove()

int32_t spi_remove ( struct spi_desc desc)

Free the resources allocated by spi_init().

Parameters
desc- The SPI descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ spi_transfer()

int32_t spi_transfer ( struct spi_desc desc,
struct spi_msg msgs,
uint32_t  len 
)

Iterate over head list and send all spi messages.

Parameters
desc- The SPI descriptor.
msgs- Array of messages.
len- Number of messages in the array.
Returns
SUCCESS in case of success, negativ error code otherwise.

◆ spi_write_and_read()

int32_t spi_write_and_read ( struct spi_desc desc,
uint8_t *  data,
uint16_t  bytes_number 
)

Write and read data to/from SPI.

Parameters
desc- The SPI descriptor.
data- The buffer with the transmitted/received data.
bytes_number- Number of bytes to write/read.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function: