neorv32_neoled.h

Go to the documentation of this file.

// ================================================================================ //
// The NEORV32 RISC-V Processor - https://github.com/stnolting/neorv32              //
// Copyright (c) NEORV32 contributors.                                              //
// Copyright (c) 2020 - 2025 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //

 
#ifndef NEORV32_NEOLED_H
#define NEORV32_NEOLED_H
 
#include <stdint.h>
 
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL;   
  uint32_t DATA24; 
  uint32_t DATA32; 
  uint32_t STROBE; 
} neorv32_neoled_t;

#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  
};

 
 
/**********************************************************************/
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);
 
 
#endif // NEORV32_NEOLED_H