no-OS
Macros | Functions | Variables
pico_spi.c File Reference

Implementation of pico spi driver. More...

#include "no_os_error.h"
#include "no_os_util.h"
#include "no_os_spi.h"
#include "pico_spi.h"
#include "pico/stdlib.h"
#include "no_os_delay.h"
#include "hardware/resets.h"
Include dependency graph for pico_spi.c:

Macros

#define PICO_SPI_MAX_INSTANCES   2U
 

Functions

int32_t pico_spi_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
 Initialize the SPI communication peripheral. More...
 
int32_t pico_spi_remove (struct no_os_spi_desc *desc)
 Free the resources allocated by no_os_spi_init(). More...
 
int32_t pico_spi_transfer (struct no_os_spi_desc *desc, struct no_os_spi_msg *msgs, uint32_t len)
 Write/read multiple messages to/from SPI. More...
 
int32_t pico_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 pico_spi_ops
 pico platform specific SPI platform ops structure More...
 

Detailed Description

Implementation of pico spi driver.

Author
RBolboac (ramon.nosp@m.a.bo.nosp@m.lboac.nosp@m.a@an.nosp@m.alog..nosp@m.com)

Copyright 2022(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.

Macro Definition Documentation

◆ PICO_SPI_MAX_INSTANCES

#define PICO_SPI_MAX_INSTANCES   2U

Function Documentation

◆ pico_spi_init()

int32_t pico_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, error code otherwise.

◆ pico_spi_remove()

int32_t pico_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, error code otherwise.

◆ pico_spi_transfer()

int32_t pico_spi_transfer ( struct no_os_spi_desc desc,
struct no_os_spi_msg msgs,
uint32_t  len 
)

Write/read multiple messages to/from SPI.

Parameters
desc- The SPI descriptor.
msgs- The messages array.
len- Number of messages.
Returns
0 in case of success, errno codes otherwise.
Here is the caller graph for this function:

◆ pico_spi_write_and_read()

int32_t pico_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, error code otherwise.

Variable Documentation

◆ pico_spi_ops

const struct no_os_spi_platform_ops pico_spi_ops
Initial value:
= {
.init = &pico_spi_init,
.write_and_read = &pico_spi_write_and_read,
.transfer = &pico_spi_transfer,
.remove = &pico_spi_remove
}

pico platform specific SPI platform ops structure

pico specific SPI platform ops structure

pico_spi_transfer
int32_t pico_spi_transfer(struct no_os_spi_desc *desc, struct no_os_spi_msg *msgs, uint32_t len)
Write/read multiple messages to/from SPI.
Definition: pico_spi.c:221
pico_spi_init
int32_t pico_spi_init(struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
Initialize the SPI communication peripheral.
Definition: pico_spi.c:140
pico_spi_remove
int32_t pico_spi_remove(struct no_os_spi_desc *desc)
Free the resources allocated by no_os_spi_init().
Definition: pico_spi.c:198
pico_spi_write_and_read
int32_t pico_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: pico_spi.c:275