no-OS
Loading...
Searching...
No Matches
Functions
no_os_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 "no_os_mutex.h"
#include "no_os_alloc.h"
Include dependency graph for no_os_spi.c:

Functions

int32_t no_os_spi_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
 Initialize the SPI communication peripheral.
 
int32_t no_os_spibus_init (const struct no_os_spi_init_param *param)
 Initialize the SPI bus communication peripheral.
 
int32_t no_os_spi_remove (struct no_os_spi_desc *desc)
 Free the resources allocated by no_os_spi_init().
 
void no_os_spibus_remove (uint32_t bus_number)
 Removes SPI bus instance.
 
int32_t no_os_spi_write_and_read (struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
 Write and read data to/from SPI.
 
int32_t no_os_spi_transfer (struct no_os_spi_desc *desc, struct no_os_spi_msg *msgs, uint32_t len)
 Iterate over head list and send all spi messages.
 
int32_t no_os_spi_transfer_dma (struct no_os_spi_desc *desc, struct no_os_spi_msg *msgs, uint32_t len)
 Transfer a list of messages using DMA and busy wait for the completion.
 
int32_t no_os_spi_transfer_dma_async (struct no_os_spi_desc *desc, struct no_os_spi_msg *msgs, uint32_t len, void(*callback)(void *), void *ctx)
 Transfer a list of messages using DMA. The function will return after the first transfer is started. Once all the transfers are complete, a callback will be called.
 
int32_t no_os_spi_transfer_abort (struct no_os_spi_desc *desc)
 Abort SPI transfers.
 

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.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

◆ no_os_spi_init()

int32_t no_os_spi_init ( struct no_os_spi_desc ** desc,
const struct no_os_spi_init_param * param )

Initialize the SPI communication peripheral.

Parameters
desc- The SPI descriptor.
param- The structure that contains the SPI parameters.
Returns
0 in case of success, -1 otherwise.

◆ no_os_spi_remove()

int32_t no_os_spi_remove ( struct no_os_spi_desc * desc)

Free the resources allocated by no_os_spi_init().

Parameters
desc- The SPI descriptor.
Returns
0 in case of success, -1 otherwise.

◆ no_os_spi_transfer()

int32_t no_os_spi_transfer ( struct no_os_spi_desc * desc,
struct no_os_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
0 in case of success, negativ error code otherwise.

◆ no_os_spi_transfer_abort()

int32_t no_os_spi_transfer_abort ( struct no_os_spi_desc * desc)

Abort SPI transfers.

Parameters
desc- The SPI descriptor.
Returns
0 in case of success, -1 otherwise.

◆ no_os_spi_transfer_dma()

int32_t no_os_spi_transfer_dma ( struct no_os_spi_desc * desc,
struct no_os_spi_msg * msgs,
uint32_t len )

Transfer a list of messages using DMA and busy wait for the completion.

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

◆ no_os_spi_transfer_dma_async()

int32_t no_os_spi_transfer_dma_async ( struct no_os_spi_desc * desc,
struct no_os_spi_msg * msgs,
uint32_t len,
void(* callback )(void *),
void * ctx )

Transfer a list of messages using DMA. The function will return after the first transfer is started. Once all the transfers are complete, a callback will be called.

Parameters
desc- The SPI descriptor.
msgs- Array of messages.
len- Number of messages in the array.
callback- A function which will be called after all the transfers are done.
ctx- User specific data which should be passed to the callback function.
Returns
0 in case of success, negativ error code otherwise.

◆ no_os_spi_write_and_read()

int32_t no_os_spi_write_and_read ( struct no_os_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
0 in case of success, -1 otherwise.

◆ no_os_spibus_init()

int32_t no_os_spibus_init ( const struct no_os_spi_init_param * param)

Initialize the SPI bus communication peripheral.

Parameters
param- The structure that containes the SPI bus parameters
Returns
0 in case of success, error code otherwise

◆ no_os_spibus_remove()

void no_os_spibus_remove ( uint32_t bus_number)

Removes SPI bus instance.

Parameters
bus_number- SPI bus number