neorv32_neoled.h File Reference

Smart LED Interface (NEOLED) HW driver header file. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	neorv32_neoled_t

Functions
Prototypes
int	neorv32_neoled_available (void)
void	neorv32_neoled_enable (void)
void	neorv32_neoled_disable (void)
void	neorv32_neoled_setup (uint32_t prsc, uint32_t t_total, uint32_t t_high_zero, uint32_t t_high_one)
void	neorv32_neoled_setup_ws2812 (void)
void	neorv32_neoled_strobe_blocking (void)
void	neorv32_neoled_strobe_nonblocking (void)
void	neorv32_neoled_write32_blocking (uint32_t data)
void	neorv32_neoled_write32_nonblocking (uint32_t data)
void	neorv32_neoled_write24_blocking (uint32_t data)
void	neorv32_neoled_write24_nonblocking (uint32_t data)
int	neorv32_neoled_get_fifo_depth (void)
int	neorv32_neoled_fifo_full (void)
int	neorv32_neoled_fifo_empty (void)
int	neorv32_neoled_busy (void)

IO Device: Smart LED Hardware Interface (NEOLED)
#define	NEORV32_NEOLED   ((neorv32_neoled_t*) (NEORV32_NEOLED_BASE))
enum	NEORV32_NEOLED_CTRL_enum {   NEOLED_CTRL_EN = 0 , NEOLED_CTRL_PRSC_LSB = 1 , NEOLED_CTRL_PRSC_MSB = 3 , NEOLED_CTRL_T_TOT_LSB = 4 ,   NEOLED_CTRL_T_TOT_MSB = 8 , NEOLED_CTRL_T_0H_LSB = 9 , NEOLED_CTRL_T_0H_MSB = 13 , NEOLED_CTRL_T_1H_LSB = 14 ,   NEOLED_CTRL_T_1H_MSB = 18 , NEOLED_CTRL_FIFO_LSB = 25 , NEOLED_CTRL_FIFO_MSB = 28 , NEOLED_CTRL_TX_EMPTY = 29 ,   NEOLED_CTRL_TX_FULL = 30 , NEOLED_CTRL_TX_BUSY = 31 }

Detailed Description

Smart LED Interface (NEOLED) HW driver header file.

Macro Definition Documentation

NEORV32_NEOLED

#define NEORV32_NEOLED   ((neorv32_neoled_t*) (NEORV32_NEOLED_BASE))

NEOLED module hardware handle (neorv32_neoled_t)

Enumeration Type Documentation

NEORV32_NEOLED_CTRL_enum

enum NEORV32_NEOLED_CTRL_enum

NEOLED control register bits

Enumerator
NEOLED_CTRL_EN	NEOLED control register(0) (r/w): NEOLED global enable
NEOLED_CTRL_PRSC_LSB	NEOLED control register(1) (r/w): Clock prescaler select bit, 0
NEOLED_CTRL_PRSC_MSB	NEOLED control register(3) (r/w): Clock prescaler select bit, 2
NEOLED_CTRL_T_TOT_LSB	NEOLED control register(4) (r/w): pulse-clock ticks per total period, bit 0
NEOLED_CTRL_T_TOT_MSB	NEOLED control register(8) (r/w): pulse-clock ticks per total period, bit 4
NEOLED_CTRL_T_0H_LSB	NEOLED control register(9) (r/w): pulse-clock ticks per ZERO high-time, bit 0
NEOLED_CTRL_T_0H_MSB	NEOLED control register(13) (r/w): pulse-clock ticks per ZERO high-time, bit 4
NEOLED_CTRL_T_1H_LSB	NEOLED control register(14) (r/w): pulse-clock ticks per ONE high-time, bit 0
NEOLED_CTRL_T_1H_MSB	NEOLED control register(18) (r/w): pulse-clock ticks per ONE high-time, bit 4
NEOLED_CTRL_FIFO_LSB	NEOLED control register(25) (r/-): log2(TX FIFO size), bit 0
NEOLED_CTRL_FIFO_MSB	NEOLED control register(28) (r/-): log2(TX FIFO size), bit 3
NEOLED_CTRL_TX_EMPTY	NEOLED control register(29) (r/-): TX FIFO is empty
NEOLED_CTRL_TX_FULL	NEOLED control register(30) (r/-): TX FIFO is full
NEOLED_CTRL_TX_BUSY	NEOLED control register(31) (r/-): serial PHY busy or TX FIFO not empty yet

Function Documentation

neorv32_neoled_available()

int neorv32_neoled_available

(

void

)

Check if NEOLED unit was synthesized.

Returns

0 if NEOLED was not synthesized, non-zero if NEOLED is available.

neorv32_neoled_busy()

int neorv32_neoled_busy

(

void

)

Check if NEOLED is busy (sending stuff).

Returns

0 if NEOLED is idle, non-zero if NEOLED is busy.

neorv32_neoled_disable()

void neorv32_neoled_disable

(

void

)

Disable NEOLED controller.

neorv32_neoled_enable()

void neorv32_neoled_enable

(

void

)

Enable NEOLED controller.

neorv32_neoled_fifo_empty()

int neorv32_neoled_fifo_empty

(

void

)

Check if TX FIFO is empty.

Returns

0 if FIFO is not empty, non-zero if FIFO is empty.

neorv32_neoled_fifo_full()

int neorv32_neoled_fifo_full

(

void

)

Check if TX FIFO is full.

Returns

0 if FIFO is not full, non-zero if FIFO is full

neorv32_neoled_get_fifo_depth()

int neorv32_neoled_get_fifo_depth

(

void

)

Get NEOLED hardware buffer size.

Returns

Number of entries in NEOLED TX buffer.

neorv32_neoled_setup()

void neorv32_neoled_setup	(	uint32_t	prsc,
		uint32_t	t_total,
		uint32_t	t_high_zero,
		uint32_t	t_high_one )

Enable and configure NEOLED controller. The NEOLED control register bits are listed in NEORV32_NEOLED_CTRL_enum. This function performs a "raw" configuration (just configuring the according control register bit).

Parameters

[in]	prsc	Clock prescaler select (0..7). See NEORV32_CLOCK_PRSC_enum.
[in]	t_total	Number of pre-scaled clock ticks for total bit period (0..31).
[in]	t_high_zero	Number of pre-scaled clock ticks to generate high-time for sending a '0' (0..31).
[in]	t_high_one	Number of pre-scaled clock ticks to generate high-time for sending a '1' (0..31).

neorv32_neoled_setup_ws2812()

void neorv32_neoled_setup_ws2812

(

void

)

Configure NEOLED controller for using WS2812 LEDs (NeoPixel-compatible). This function computes all the required timings and finally calls neorv32_neoled_setup.

Note

WS2812 timing: T_period = 1.2us, T_high_zero = 0.4us, T_high_one = 0.8us. Change the constants if required.

This function uses the SYSINFO_CLK value (from the SYSINFO HW module) to do the timing computations.

neorv32_neoled_strobe_blocking()

void neorv32_neoled_strobe_blocking

(

void

)

Send strobe command ("RESET") - blocking.

neorv32_neoled_strobe_nonblocking()

void neorv32_neoled_strobe_nonblocking

(

void

)

Send strobe command ("RESET") - non-blocking.

neorv32_neoled_write24_blocking()

void neorv32_neoled_write24_blocking

(

uint32_t

data

)

Send single RGB data word to NEOLED module (blocking).

Parameters

[in]

LSB-aligned

24-bit RGBW data

neorv32_neoled_write24_nonblocking()

void neorv32_neoled_write24_nonblocking

(

uint32_t

data

)

Send single RGB data word to NEOLED module (non-blocking).

Parameters

[in]

LSB-aligned

24-bit RGBW data

neorv32_neoled_write32_blocking()

void neorv32_neoled_write32_blocking

(

uint32_t

data

)

Send single RGBW data word to NEOLED module (blocking).

Parameters

[in]

32-bit

RGBW data

neorv32_neoled_write32_nonblocking()

void neorv32_neoled_write32_nonblocking

(

uint32_t

data

)

Send single RGBW data word to NEOLED module (non-blocking).

Parameters

[in]

32-bit

RGBW data