neorv32_neoled.h

Go to the documentation of this file.

// #################################################################################################
// # << NEORV32: neorv32_neoled.h - Smart LED Interface (NEOLED) HW Driver >>                      #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2023, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # Redistribution and use in source and binary forms, with or without modification, are          #
// # permitted provided that the following conditions are met:                                     #
// #                                                                                               #
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
// #    conditions and the following disclaimer.                                                   #
// #                                                                                               #
// # 2. 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.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
// #    endorse or promote products derived from this software without specific prior written      #
// #    permission.                                                                                #
// #                                                                                               #
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************/
#ifndef neorv32_neoled_h
#define neorv32_neoled_h
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL; 
  uint32_t DATA; 
} neorv32_neoled_t;
 
#define NEORV32_NEOLED ((neorv32_neoled_t*) (NEORV32_NEOLED_BASE))
 
enum NEORV32_NEOLED_CTRL_enum {
  NEOLED_CTRL_EN         =  0, 
  NEOLED_CTRL_MODE       =  1, 
  NEOLED_CTRL_STROBE     =  2, 
  NEOLED_CTRL_PRSC0      =  3, 
  NEOLED_CTRL_PRSC1      =  4, 
  NEOLED_CTRL_PRSC2      =  5, 
  NEOLED_CTRL_BUFS_0     =  6, 
  NEOLED_CTRL_BUFS_1     =  7, 
  NEOLED_CTRL_BUFS_2     =  8, 
  NEOLED_CTRL_BUFS_3     =  9, 
  NEOLED_CTRL_T_TOT_0    = 10, 
  NEOLED_CTRL_T_TOT_1    = 11, 
  NEOLED_CTRL_T_TOT_2    = 12, 
  NEOLED_CTRL_T_TOT_3    = 13, 
  NEOLED_CTRL_T_TOT_4    = 14, 
  NEOLED_CTRL_T_ZERO_H_0 = 15, 
  NEOLED_CTRL_T_ZERO_H_1 = 16, 
  NEOLED_CTRL_T_ZERO_H_2 = 17, 
  NEOLED_CTRL_T_ZERO_H_3 = 18, 
  NEOLED_CTRL_T_ZERO_H_4 = 19, 
  NEOLED_CTRL_T_ONE_H_0  = 20, 
  NEOLED_CTRL_T_ONE_H_1  = 21, 
  NEOLED_CTRL_T_ONE_H_2  = 22, 
  NEOLED_CTRL_T_ONE_H_3  = 23, 
  NEOLED_CTRL_T_ONE_H_4  = 24, 
  NEOLED_CTRL_IRQ_CONF   = 27, 
  NEOLED_CTRL_TX_EMPTY   = 28, 
  NEOLED_CTRL_TX_HALF    = 29, 
  NEOLED_CTRL_TX_FULL    = 30, 
  NEOLED_CTRL_TX_BUSY    = 31  
};
/**********************************************************************/
int      neorv32_neoled_available(void);
void     neorv32_neoled_setup(uint32_t prsc, uint32_t t_total, uint32_t t_high_zero, uint32_t t_high_one, int irq_mode);
void     neorv32_neoled_setup_ws2812(int irq_mode);
void     neorv32_neoled_set_mode(uint32_t mode);
void     neorv32_neoled_strobe_blocking(void);
void     neorv32_neoled_strobe_nonblocking(void);
void     neorv32_neoled_enable(void);
void     neorv32_neoled_disable(void);
void     neorv32_neoled_write_blocking(uint32_t data);
uint32_t neorv32_neoled_get_buffer_size(void);
/**********************************************************************/
inline void __attribute__ ((always_inline)) neorv32_neoled_write_nonblocking(uint32_t data) {
 
  NEORV32_NEOLED->DATA = data; // send new LED data
}
 
#endif // neorv32_neoled_h