spi.h File Reference

Header file of SPI Interface. More...

#include <stdint.h>

Include dependency graph for spi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	spi_msg
struct	spi_init_param
	Structure holding the parameters for SPI initialization. More...
struct	spi_desc
	Structure holding SPI descriptor. More...
struct	spi_platform_ops
	Structure holding SPI function pointers that point to the platform specific function. More...

Macros
#define	SPI_CPHA   0x01
#define	SPI_CPOL   0x02

Typedefs
typedef enum spi_mode	spi_mode
typedef enum spi_bit_order	spi_bit_order
typedef struct spi_init_param	spi_init_param
typedef struct spi_desc	spi_desc

Enumerations
enum	spi_mode {   NO_OS_SPI_MODE_0 = (0 | 0),   NO_OS_SPI_MODE_1 = (0 | SPI_CPHA),   NO_OS_SPI_MODE_2 = (SPI_CPOL | 0),   NO_OS_SPI_MODE_3 = (SPI_CPOL | SPI_CPHA) }
	SPI configuration for clock phase and polarity. More...
enum	spi_bit_order {   SPI_BIT_ORDER_MSB_FIRST = 0,   SPI_BIT_ORDER_LSB_FIRST = 1 }
	SPI configuration for bit order (MSB/LSB). More...

Functions
int32_t	spi_init (struct spi_desc **desc, const struct spi_init_param *param)
	Initialize the SPI communication peripheral. More...
int32_t	spi_remove (struct spi_desc *desc)
	Free the resources allocated by spi_init(). More...
int32_t	spi_write_and_read (struct spi_desc *desc, uint8_t *data, uint16_t bytes_number)
	Write and read data to/from SPI. More...
int32_t	spi_transfer (struct spi_desc *desc, struct spi_msg *msgs, uint32_t len)
	Iterate over head list and send all spi messages. More...

Detailed Description

Header file of SPI Interface.

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:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

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_CPHA

#define SPI_CPHA   0x01

SPI_CPOL

#define SPI_CPOL   0x02

Typedef Documentation

spi_bit_order

typedef enum spi_bit_order spi_bit_order

spi_desc

typedef struct spi_desc spi_desc

spi_init_param

typedef struct spi_init_param spi_init_param

spi_mode

typedef enum spi_mode spi_mode

Enumeration Type Documentation

spi_bit_order

enum spi_bit_order

SPI configuration for bit order (MSB/LSB).

Enumerator
SPI_BIT_ORDER_MSB_FIRST	Most-significant bit (MSB) first
SPI_BIT_ORDER_LSB_FIRST	Least-significant bit (LSB) first

spi_mode

enum spi_mode

SPI configuration for clock phase and polarity.

Enumerator
NO_OS_SPI_MODE_0	Data on rising, shift out on falling
NO_OS_SPI_MODE_1	Data on falling, shift out on rising
NO_OS_SPI_MODE_2	Data on falling, shift out on rising
NO_OS_SPI_MODE_3	Data on rising, shift out on falling

Function Documentation

spi_init()

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

spi_remove()

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

Here is the caller graph for this function:

spi_transfer()

int32_t spi_transfer	(	struct spi_desc *	desc,
		struct 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

SUCCESS in case of success, negativ error code otherwise.

spi_write_and_read()

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

Here is the caller graph for this function: