spi_engine.h File Reference

#include <stdint.h>
#include "spi_engine_private.h"
#include "axi_dmac.h"

Include dependency graph for spi_engine.h:

Classes
struct	spi_engine_init_param
	Structure containing the init parameters needed by the SPI engine. More...
struct	spi_engine_desc
	Structure representing an SPI engine device. More...
struct	spi_engine_offload_init_param
	Structure containing the init parameters needed by the offload module. More...
struct	spi_engine_offload_message
	Structure representing an offload message. More...

Macros
#define	OFFLOAD_DISABLED   0x00
#define	OFFLOAD_TX_EN   NO_OS_BIT(0)
#define	OFFLOAD_RX_EN   NO_OS_BIT(1)
#define	OFFLOAD_TX_RX_EN   OFFLOAD_TX_EN | OFFLOAD_RX_EN
#define	SPI_ENGINE_MSG_QUEUE_END   0xFFFFFFFF
#define	WRITE(no_bytes)
#define	READ(no_bytes)
#define	WRITE_READ(no_bytes)
#define	SLEEP(time)
#define	CS_HIGH   SPI_ENGINE_CMD_ASSERT(0x03, 0xFF)
#define	CS_LOW   SPI_ENGINE_CMD_ASSERT(0x03, 0x00)

Functions
int32_t	spi_engine_write (struct spi_engine_desc *desc, uint32_t reg_addr, uint32_t reg_data)
	Write SPI Engine's axi registers.
int32_t	spi_engine_read (struct spi_engine_desc *desc, uint32_t reg_addr, uint32_t *reg_data)
	Read SPI Engine's axi registers.
int32_t	spi_engine_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
	Initialize the spi engine.
int32_t	spi_engine_write_and_read (struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
	Write/read on the spi interface.
int32_t	spi_engine_remove (struct no_os_spi_desc *desc)
	Free the resources allocated by no_os_spi_init().
int32_t	spi_engine_offload_init (struct no_os_spi_desc *desc, const struct spi_engine_offload_init_param *param)
	Initialize the SPI engine's offload module.
int32_t	spi_engine_offload_transfer (struct no_os_spi_desc *desc, struct spi_engine_offload_message msg, uint32_t no_samples)
	Initiate a SPI transfer in offload mode.
int32_t	spi_engine_set_transfer_width (struct no_os_spi_desc *desc, uint8_t data_wdith)
	Set width of the transfered word over SPI.
void	spi_engine_set_speed (struct no_os_spi_desc *desc, uint32_t speed_hz)
	Set SPI engine clock frequency.

Variables
const struct no_os_spi_platform_ops	spi_eng_platform_ops
	Spi engine platform specific SPI platform ops structure.

Macro Definition Documentation

CS_HIGH

#define CS_HIGH   SPI_ENGINE_CMD_ASSERT(0x03, 0xFF)

CS_LOW

#define CS_LOW   SPI_ENGINE_CMD_ASSERT(0x03, 0x00)

OFFLOAD_DISABLED

#define OFFLOAD_DISABLED   0x00

OFFLOAD_RX_EN

#define OFFLOAD_RX_EN   NO_OS_BIT(1)

OFFLOAD_TX_EN

#define OFFLOAD_TX_EN   NO_OS_BIT(0)

OFFLOAD_TX_RX_EN

#define OFFLOAD_TX_RX_EN   OFFLOAD_TX_EN | OFFLOAD_RX_EN

READ

#define READ

(

no_bytes

)

Value:

    ((SPI_ENGINE_INST_TRANSFER << 12) |\
    (SPI_ENGINE_INSTRUCTION_TRANSFER_R << 8) | no_bytes)

SLEEP

#define SLEEP

(

time

)

Value:

SPI_ENGINE_CMD_SLEEP(time & 0xF)

SPI_ENGINE_MSG_QUEUE_END

#define SPI_ENGINE_MSG_QUEUE_END   0xFFFFFFFF

WRITE

#define WRITE

(

no_bytes

)

Value:

    ((SPI_ENGINE_INST_TRANSFER << 12) |\
    (SPI_ENGINE_INSTRUCTION_TRANSFER_W << 8) | no_bytes)

WRITE_READ

#define WRITE_READ

(

no_bytes

)

Value:

    ((SPI_ENGINE_INST_TRANSFER << 12) |\
    (SPI_ENGINE_INSTRUCTION_TRANSFER_RW << 8) | no_bytes)

Function Documentation

spi_engine_init()

int32_t spi_engine_init	(	struct no_os_spi_desc **	desc,
		const struct no_os_spi_init_param *	param )

Initialize the spi engine.

Parameters

desc	Decriptor containing SPI interface parameters
param	Structure containing the spi init parameters

Returns

int32_t - 0 if the transfer finished

• -1 if the memory allocation failed

spi_engine_offload_init()

int32_t spi_engine_offload_init	(	struct no_os_spi_desc *	desc,
		const struct spi_engine_offload_init_param *	param )

Initialize the SPI engine's offload module.

Parameters

desc	Decriptor containing SPI interface parameters
param	Structure containing the offload init parameters

Returns

int32_t This function allways returns 0

spi_engine_offload_transfer()

int32_t spi_engine_offload_transfer	(	struct no_os_spi_desc *	desc,
		struct spi_engine_offload_message	msg,
		uint32_t	no_samples )

Initiate a SPI transfer in offload mode.

Parameters

desc	Decriptor containing SPI interface parameters
msg	Offload message that get's to be transferred
no_samples	Number of time the messages will be transferred

Returns

int32_t This function allways returns 0

spi_engine_read()

int32_t spi_engine_read	(	struct spi_engine_desc *	desc,
		uint32_t	reg_addr,
		uint32_t *	reg_data )

Read SPI Engine's axi registers.

Parameters

desc	Decriptor containing SPI Engine's parameters
reg_addr	The address of the SPI Engine's axi register from where the data where the data will be read
reg_data	Pointer where the read that will be stored

Returns

int32_t This function allways returns 0

spi_engine_remove()

int32_t spi_engine_remove

(

struct no_os_spi_desc *

desc

)

Free the resources allocated by no_os_spi_init().

Parameters

desc	Decriptor containing SPI interface parameters

Returns

int32_t This function allways returns 0

spi_engine_set_speed()

void spi_engine_set_speed	(	struct no_os_spi_desc *	desc,
		uint32_t	speed_hz )

Set SPI engine clock frequency.

Parameters

desc	Decriptor containing SPI Engine's parameters
speed_hz	SPI engine transfer speed

spi_engine_set_transfer_width()

int32_t spi_engine_set_transfer_width	(	struct no_os_spi_desc *	desc,
		uint8_t	data_wdith )

Set width of the transfered word over SPI.

Parameters

desc	Decriptor containing SPI interface parameters
data_wdith	The desired data width The supported values are: 8 16 24 32

spi_engine_write()

int32_t spi_engine_write	(	struct spi_engine_desc *	desc,
		uint32_t	reg_addr,
		uint32_t	reg_data )

Write SPI Engine's axi registers.

Parameters

desc	Decriptor containing SPI Engine's parameters
reg_addr	The address of the SPI Engine's axi register where the data will be written
reg_data	Data that will be written

Returns

int32_t This function allways returns 0

spi_engine_write_and_read()

int32_t spi_engine_write_and_read	(	struct no_os_spi_desc *	desc,
		uint8_t *	data,
		uint16_t	bytes_number )

Write/read on the spi interface.

Parameters

desc	Decriptor containing SPI interface parameters
data	Pointer to data buffer
bytes_number	Number of bytes to transfer

Returns

int32_t - 0 if the transfer finished

• -1 if the memory allocation or transfer failed

Variable Documentation

spi_eng_platform_ops

const struct no_os_spi_platform_ops spi_eng_platform_ops

extern

Spi engine platform specific SPI platform ops structure.