lws-spi.h File Reference

#include <stdint.h>
#include <stddef.h>

Include dependency graph for lws-spi.h:

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

Go to the source code of this file.

Data Structures
struct	lws_spi_desc
struct	lws_spi_ops

Typedefs
typedef int(*	lws_spi_cb_t) (void *opaque)
typedef struct lws_spi_desc	lws_spi_desc_t
typedef struct lws_spi_ops	lws_spi_ops_t

Enumerations
enum	{   LWSSPIMODE_CPOL = (1 << 0) , LWSSPIMODE_CPHA = (1 << 1) , LWS_SPI_BUSMODE_CLK_IDLE_LOW_SAMP_RISING = 0 , LWS_SPI_BUSMODE_CLK_IDLE_HIGH_SAMP_RISING = LWSSPIMODE_CPOL ,   LWS_SPI_BUSMODE_CLK_IDLE_LOW_SAMP_FALLING = LWSSPIMODE_CPHA , LWS_SPI_BUSMODE_CLK_IDLE_HIGH_SAMP_FALLING , LWS_SPI_TXN_HALF_DUPLEX_DISCRETE = 0 , LWS_SPI_FLAG_DATA_CONTINUE = (1 << 0) ,   LWS_SPI_FLAG_DC_CMD_IS_HIGH = (1 << 1) , LWS_SPI_FLAG_DMA_BOUNCE_NOT_NEEDED = (1 << 2) }

Functions
LWS_VISIBLE LWS_EXTERN int	lws_spi_table_issue (const lws_spi_ops_t *spi_ops, uint32_t flags, const uint8_t *p, size_t len)
LWS_VISIBLE LWS_EXTERN int	lws_spi_readback (const lws_spi_ops_t *spi_ops, uint32_t flags, const uint8_t *p, size_t len, uint8_t *rb, size_t rb_len)

---

Data Structure Documentation

lws_spi_desc

struct lws_spi_desc

Definition at line 61 of file lws-spi.h.

Collaboration diagram for lws_spi_desc:

Data Fields
const uint8_t *	src
const uint8_t *	data
uint8_t *	dest
void *	opaque
lws_spi_cb_t	completion_cb
uint16_t	count_cmd
uint16_t	count_write
uint16_t	count_read
uint8_t	txn_type
uint8_t	channel
uint8_t	flags

lws_spi_ops

struct lws_spi_ops

Definition at line 76 of file lws-spi.h.

Collaboration diagram for lws_spi_ops:

Data Fields
int(*)(const struct lws_spi_ops *ctx)	init
int(*)(const struct lws_spi_ops *ctx, const lws_spi_desc_t *desc)	queue
void *(*)(const struct lws_spi_ops *ctx, size_t size)	alloc_dma
void(*)(const struct lws_spi_ops *ctx, void **p)	free_dma
int(*)(const struct lws_spi_ops *ctx)	in_flight
uint32_t	spi_clk_hz
uint8_t	bus_mode

Typedef Documentation

lws_spi_cb_t

typedef int(* lws_spi_cb_t) (void *opaque)

Definition at line 37 of file lws-spi.h.

lws_spi_desc_t

typedef struct lws_spi_desc lws_spi_desc_t

lws_spi_ops_t

typedef struct lws_spi_ops lws_spi_ops_t

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
LWSSPIMODE_CPOL
LWSSPIMODE_CPHA
LWS_SPI_BUSMODE_CLK_IDLE_LOW_SAMP_RISING
LWS_SPI_BUSMODE_CLK_IDLE_HIGH_SAMP_RISING
LWS_SPI_BUSMODE_CLK_IDLE_LOW_SAMP_FALLING
LWS_SPI_BUSMODE_CLK_IDLE_HIGH_SAMP_FALLING
LWS_SPI_TXN_HALF_DUPLEX_DISCRETE	separate MISO and MOSI, but only either MISO or MOSI has data at one time... i2c style in SPI
LWS_SPI_FLAG_DATA_CONTINUE	leave without finalizing the SPI transaction
LWS_SPI_FLAG_DC_CMD_IS_HIGH	It's normally 0 for cmd phase, invert with this flag
LWS_SPI_FLAG_DMA_BOUNCE_NOT_NEEDED	It's normally 0 for cmd phase, invert with this flag

Definition at line 39 of file lws-spi.h.

     {
        LWSSPIMODE_CPOL                                  = (1 << 0),
        LWSSPIMODE_CPHA                                  = (1 << 1),
 
        LWS_SPI_BUSMODE_CLK_IDLE_LOW_SAMP_RISING        = 0,
        LWS_SPI_BUSMODE_CLK_IDLE_HIGH_SAMP_RISING      = LWSSPIMODE_CPOL,
        LWS_SPI_BUSMODE_CLK_IDLE_LOW_SAMP_FALLING      = LWSSPIMODE_CPHA,
        LWS_SPI_BUSMODE_CLK_IDLE_HIGH_SAMP_FALLING    = LWSSPIMODE_CPHA |
                                                          LWSSPIMODE_CPOL,
 
        LWS_SPI_TXN_HALF_DUPLEX_DISCRETE        = 0,
 
        LWS_SPI_FLAG_DATA_CONTINUE                    = (1 << 0),
        LWS_SPI_FLAG_DC_CMD_IS_HIGH                  = (1 << 1),
        LWS_SPI_FLAG_DMA_BOUNCE_NOT_NEEDED            = (1 << 2),
};

Function Documentation

lws_spi_table_issue()

LWS_VISIBLE LWS_EXTERN int lws_spi_table_issue	(	const lws_spi_ops_t *	spi_ops,
		uint32_t	flags,
		const uint8_t *	p,
		size_t	len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_spi_readback()

LWS_VISIBLE LWS_EXTERN int lws_spi_readback	(	const lws_spi_ops_t *	spi_ops,
		uint32_t	flags,
		const uint8_t *	p,
		size_t	len,
		uint8_t *	rb,
		size_t	rb_len )