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

Implementation of Xilinx SPI Generic Driver. More...

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

Macros

#define SPI_NUM_INSTANCES   0
 

Functions

int32_t xil_spi_init (struct spi_desc **desc, const struct spi_init_param *param)
 Initialize the SPI communication peripheral. More...
 
int32_t xil_spi_remove (struct spi_desc *desc)
 Free the resources allocated by spi_init(). More...
 
int32_t xil_spi_write_and_read (struct spi_desc *desc, uint8_t *data, uint16_t bytes_number)
 Write and read data to/from SPI. More...
 

Variables

const struct spi_platform_ops xil_spi_ops
 Xilinx platform specific SPI platform ops structure. More...
 

Detailed Description

Implementation of Xilinx SPI Generic Driver.

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

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.

Macro Definition Documentation

◆ SPI_NUM_INSTANCES

#define SPI_NUM_INSTANCES   0

Function Documentation

◆ xil_spi_init()

int32_t xil_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:

◆ xil_spi_remove()

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

◆ xil_spi_write_and_read()

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

Variable Documentation

◆ xil_spi_ops

const struct spi_platform_ops xil_spi_ops
Initial value:
= {
.init = &xil_spi_init,
.write_and_read = &xil_spi_write_and_read,
.remove = &xil_spi_remove
}

Xilinx platform specific SPI platform ops structure.

Xilinx specific SPI platform ops structure.

Spi engine platform specific SPI platform ops structure.

xil_spi_init
int32_t xil_spi_init(struct spi_desc **desc, const struct spi_init_param *param)
Initialize the SPI communication peripheral.
Definition: xilinx_spi.c:252
xil_spi_remove
int32_t xil_spi_remove(struct spi_desc *desc)
Free the resources allocated by spi_init().
Definition: xilinx_spi.c:306
xil_spi_write_and_read
int32_t xil_spi_write_and_read(struct spi_desc *desc, uint8_t *data, uint16_t bytes_number)
Write and read data to/from SPI.
Definition: xilinx_spi.c:364