no-OS
|
Header file of SPI Interface. More...
#include <stdint.h>
Go to the source code of this file.
Classes | |
struct | no_os_spi_msg |
struct | no_os_spi_init_param |
Structure holding the parameters for SPI initialization. More... | |
struct | no_os_spi_desc |
Structure holding SPI descriptor. More... | |
struct | no_os_spi_platform_ops |
Structure holding SPI function pointers that point to the platform specific function. More... | |
Macros | |
#define | NO_OS_SPI_CPHA 0x01 |
#define | NO_OS_SPI_CPOL 0x02 |
Enumerations | |
enum | no_os_spi_mode { NO_OS_SPI_MODE_0 = (0 | 0), NO_OS_SPI_MODE_1 = (0 | NO_OS_SPI_CPHA), NO_OS_SPI_MODE_2 = (NO_OS_SPI_CPOL | 0), NO_OS_SPI_MODE_3 = (NO_OS_SPI_CPOL | NO_OS_SPI_CPHA) } |
SPI configuration for clock phase and polarity. More... | |
enum | no_os_spi_bit_order { NO_OS_SPI_BIT_ORDER_MSB_FIRST = 0, NO_OS_SPI_BIT_ORDER_LSB_FIRST = 1 } |
SPI configuration for bit order (MSB/LSB). More... | |
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. More... | |
int32_t | no_os_spi_remove (struct no_os_spi_desc *desc) |
Free the resources allocated by no_os_spi_init(). More... | |
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. More... | |
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. More... | |
Header file of SPI Interface.
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.
#define NO_OS_SPI_CPHA 0x01 |
#define NO_OS_SPI_CPOL 0x02 |
enum no_os_spi_bit_order |
enum no_os_spi_mode |
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.
desc | - The SPI descriptor. |
param | - The structure that contains the SPI parameters. |
int32_t no_os_spi_remove | ( | struct no_os_spi_desc * | desc | ) |
Free the resources allocated by no_os_spi_init().
desc | - The SPI descriptor. |
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.
desc | - The SPI descriptor. |
msgs | - Array of messages. |
len | - Number of messages in the array. |
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.
desc | - The SPI descriptor. |
data | - The buffer with the transmitted/received data. |
bytes_number | - Number of bytes to write/read. |