no-OS
Functions | Variables
generic_spi.c File Reference
#include "no_os_error.h"
#include "no_os_spi.h"
Include dependency graph for generic_spi.c:

Functions

int32_t generic_spi_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
 Initialize the SPI communication peripheral. More...
 
int32_t generic_spi_remove (struct no_os_spi_desc *desc)
 Free the resources allocated by no_os_spi_init(). More...
 
int32_t generic_spi_write_and_read (struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
 Write and read data to/from SPI. More...
 

Variables

const struct no_os_spi_platform_ops generic_spi_ops
 Generic platform SPI ops. More...
 

Detailed Description

Author
DBogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2019(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

◆ generic_spi_init()

int32_t generic_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.

◆ generic_spi_remove()

int32_t generic_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.

◆ generic_spi_write_and_read()

int32_t generic_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.

Variable Documentation

◆ generic_spi_ops

const struct no_os_spi_platform_ops generic_spi_ops
Initial value:
= {
.init = &generic_spi_init,
.write_and_read = &generic_spi_write_and_read,
.remove = &generic_spi_remove
}

Generic platform SPI ops.

generic_spi_init
int32_t generic_spi_init(struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
Initialize the SPI communication peripheral.
Definition: generic_spi.c:56
generic_spi_write_and_read
int32_t generic_spi_write_and_read(struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
Write and read data to/from SPI.
Definition: generic_spi.c:91
generic_spi_remove
int32_t generic_spi_remove(struct no_os_spi_desc *desc)
Free the resources allocated by no_os_spi_init().
Definition: generic_spi.c:75