NEORV32 - Software Framework Documentation
Loading...
Searching...
No Matches
neorv32_neoled.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_neoled.h - Smart LED Interface (NEOLED) HW Driver >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2023, Stephan Nolting. All rights reserved. #
7// # #
8// # Redistribution and use in source and binary forms, with or without modification, are #
9// # permitted provided that the following conditions are met: #
10// # #
11// # 1. Redistributions of source code must retain the above copyright notice, this list of #
12// # conditions and the following disclaimer. #
13// # #
14// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
15// # conditions and the following disclaimer in the documentation and/or other materials #
16// # provided with the distribution. #
17// # #
18// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
19// # endorse or promote products derived from this software without specific prior written #
20// # permission. #
21// # #
22// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
23// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
24// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
25// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
26// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
28// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
29// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
30// # OF THE POSSIBILITY OF SUCH DAMAGE. #
31// # ********************************************************************************************* #
32// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
33// #################################################################################################
34
35
36/**********************************************************************/
43#ifndef neorv32_neoled_h
44#define neorv32_neoled_h
45
46/**********************************************************************/
51typedef volatile struct __attribute__((packed,aligned(4))) {
52 uint32_t CTRL;
53 uint32_t DATA;
55
57#define NEORV32_NEOLED ((neorv32_neoled_t*) (NEORV32_NEOLED_BASE))
58
100/**********************************************************************/
105void neorv32_neoled_setup(uint32_t prsc, uint32_t t_total, uint32_t t_high_zero, uint32_t t_high_one, int irq_mode);
106void neorv32_neoled_setup_ws2812(int irq_mode);
107void neorv32_neoled_set_mode(uint32_t mode);
110void neorv32_neoled_enable(void);
111void neorv32_neoled_disable(void);
112void neorv32_neoled_write_blocking(uint32_t data);
113uint32_t neorv32_neoled_get_buffer_size(void);
117/**********************************************************************/
124inline void __attribute__ ((always_inline)) neorv32_neoled_write_nonblocking(uint32_t data) {
125
126 NEORV32_NEOLED->DATA = data; // send new LED data
127}
128
129#endif // neorv32_neoled_h
#define NEORV32_NEOLED
Definition neorv32_neoled.h:57
void neorv32_neoled_write_blocking(uint32_t data)
Definition neorv32_neoled.c:219
void neorv32_neoled_set_mode(uint32_t mode)
Definition neorv32_neoled.c:156
int neorv32_neoled_available(void)
Definition neorv32_neoled.c:52
void neorv32_neoled_strobe_blocking(void)
Definition neorv32_neoled.c:168
void neorv32_neoled_enable(void)
Definition neorv32_neoled.c:197
uint32_t neorv32_neoled_get_buffer_size(void)
Definition neorv32_neoled.c:236
void neorv32_neoled_disable(void)
Definition neorv32_neoled.c:206
NEORV32_NEOLED_CTRL_enum
Definition neorv32_neoled.h:60
@ NEOLED_CTRL_T_ONE_H_4
Definition neorv32_neoled.h:89
@ NEOLED_CTRL_T_ZERO_H_4
Definition neorv32_neoled.h:83
@ NEOLED_CTRL_PRSC1
Definition neorv32_neoled.h:65
@ NEOLED_CTRL_PRSC0
Definition neorv32_neoled.h:64
@ NEOLED_CTRL_TX_HALF
Definition neorv32_neoled.h:93
@ NEOLED_CTRL_T_ZERO_H_1
Definition neorv32_neoled.h:80
@ NEOLED_CTRL_TX_EMPTY
Definition neorv32_neoled.h:92
@ NEOLED_CTRL_T_ONE_H_3
Definition neorv32_neoled.h:88
@ NEOLED_CTRL_IRQ_CONF
Definition neorv32_neoled.h:91
@ NEOLED_CTRL_BUFS_0
Definition neorv32_neoled.h:68
@ NEOLED_CTRL_PRSC2
Definition neorv32_neoled.h:66
@ NEOLED_CTRL_T_TOT_4
Definition neorv32_neoled.h:77
@ NEOLED_CTRL_T_TOT_2
Definition neorv32_neoled.h:75
@ NEOLED_CTRL_STROBE
Definition neorv32_neoled.h:63
@ NEOLED_CTRL_T_TOT_0
Definition neorv32_neoled.h:73
@ NEOLED_CTRL_T_ONE_H_2
Definition neorv32_neoled.h:87
@ NEOLED_CTRL_TX_BUSY
Definition neorv32_neoled.h:95
@ NEOLED_CTRL_T_ZERO_H_0
Definition neorv32_neoled.h:79
@ NEOLED_CTRL_T_ONE_H_0
Definition neorv32_neoled.h:85
@ NEOLED_CTRL_T_ZERO_H_2
Definition neorv32_neoled.h:81
@ NEOLED_CTRL_T_ZERO_H_3
Definition neorv32_neoled.h:82
@ NEOLED_CTRL_MODE
Definition neorv32_neoled.h:62
@ NEOLED_CTRL_BUFS_3
Definition neorv32_neoled.h:71
@ NEOLED_CTRL_T_TOT_3
Definition neorv32_neoled.h:76
@ NEOLED_CTRL_TX_FULL
Definition neorv32_neoled.h:94
@ NEOLED_CTRL_T_TOT_1
Definition neorv32_neoled.h:74
@ NEOLED_CTRL_BUFS_2
Definition neorv32_neoled.h:70
@ NEOLED_CTRL_T_ONE_H_1
Definition neorv32_neoled.h:86
@ NEOLED_CTRL_BUFS_1
Definition neorv32_neoled.h:69
@ NEOLED_CTRL_EN
Definition neorv32_neoled.h:61
void neorv32_neoled_strobe_nonblocking(void)
Definition neorv32_neoled.c:183
void neorv32_neoled_setup(uint32_t prsc, uint32_t t_total, uint32_t t_high_zero, uint32_t t_high_one, int irq_mode)
Definition neorv32_neoled.c:73
void neorv32_neoled_write_nonblocking(uint32_t data)
Definition neorv32_neoled.h:124
void neorv32_neoled_setup_ws2812(int irq_mode)
Definition neorv32_neoled.c:97
Definition neorv32_neoled.h:51
uint32_t DATA
Definition neorv32_neoled.h:53
uint32_t CTRL
Definition neorv32_neoled.h:52