ScStw/ESP32-HUB75-MatrixPanel-DMA
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix: bugs of ROWS_PER_FRAME and PIXELS_PER_ROW when using default constructor

Browse source 
fix: bus noconfig set when using default constructor
fix: options to set config after construction, to enable use of default Constructor
     - begin(HUB75_I2S_CFG), setCfg(HUB75_I2S_CFG)
fix: second call of begin({pins}) would bug the pin between config and dma usage

fix: reorder attributes of HUB75_I2S_CFG and MatrixPanel_I2S_DMA to reduce object size (at least in debug mode)
This commit is contained in:
Lukas 2023-03-11 11:51:41 +01:00
parent 763aab6f09
commit f970b781b9
2 changed files with 106 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/ESP32-HUB75-MatrixPanel-I2S-DMA.cpp
View file

@ -367,7 +367,7 @@ uint16_t red16, green16, blue16;
uint8_t mask = (1 << (colour_depth_idx)); // expect 24 bit color (8 bits per RGB subpixel)
#endif
*/
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, m_cfg.getMaskOffset());
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, MASK_OFFSET);
uint16_t RGB_output_bits = 0;
/* Per the .h file, the order of the output RGB bits is:
@ -425,7 +425,7 @@ uint16_t red16, green16, blue16;
// uint8_t mask = (1 << (colour_depth_idx)); // expect 24 bit colour (8 bits per RGB subpixel)
// #endif
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, m_cfg.getMaskOffset());
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, MASK_OFFSET);
/* Per the .h file, the order of the output RGB bits is:
* BIT_B2, BIT_G2, BIT_R2, BIT_B1, BIT_G1, BIT_R1 */
@ -785,7 +785,7 @@ void MatrixPanel_I2S_DMA::brtCtrlOEv2(uint8_t brt, const int _buff_id) {
*/
bool MatrixPanel_I2S_DMA::begin(int r1, int g1, int b1, int r2, int g2, int b2, int a, int b, int c, int d, int e, int lat, int oe, int clk) {
if(initialized) return true;
// RGB
m_cfg.gpio.r1 = r1; m_cfg.gpio.g1 = g1; m_cfg.gpio.b1 = b1;
m_cfg.gpio.r2 = r2; m_cfg.gpio.g2 = g2; m_cfg.gpio.b2 = b2;
@ -800,6 +800,15 @@ bool MatrixPanel_I2S_DMA::begin(int r1, int g1, int b1, int r2, int g2, int b2,
return begin();
}
bool MatrixPanel_I2S_DMA::begin(const HUB75_I2S_CFG& cfg){
if(initialized) return true;
if(!setCfg(cfg)) return false;
return begin();
}
/**
* @brief - Sets how many clock cycles to blank OE before/after LAT signal change
@ -880,7 +889,7 @@ uint16_t red16, green16, blue16;
// #else
// uint8_t mask = (1 << (colour_depth_idx)); // expect 24 bit colour (8 bits per RGB subpixel)
// #endif
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, m_cfg.getMaskOffset());
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, MASK_OFFSET);
/* Per the .h file, the order of the output RGB bits is:
* BIT_B2, BIT_G2, BIT_R2, BIT_B1, BIT_G1, BIT_R1 */
@ -973,7 +982,7 @@ uint16_t red16, green16, blue16;
// uint8_t mask = (1 << (colour_depth_idx)); // expect 24 bit colour (8 bits per RGB subpixel)
// #endif
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, m_cfg.getMaskOffset());
uint16_t mask = PIXEL_COLOR_MASK_BIT(colour_depth_idx, MASK_OFFSET);
uint16_t RGB_output_bits = 0;
/* Per the .h file, the order of the output RGB bits is:

158
src/ESP32-HUB75-MatrixPanel-I2S-DMA.h
View file

@ -60,8 +60,10 @@
/* Do not change definitions below unless you pretty sure you know what you are doing! */
// RGB Panel Constants / Calculated Values
#ifndef MATRIX_ROWS_IN_PARALLEL
#define MATRIX_ROWS_IN_PARALLEL 2
#ifdef MATRIX_ROWS_IN_PARALLEL
#define MATRIX_ROWS_IN_PARALLEL_DEFAULT MATRIX_ROWS_IN_PARALLEL
#else
#define MATRIX_ROWS_IN_PARALLEL_DEFAULT 2
#endif
// 8bit per RGB color = 24 bit/per pixel,
@ -238,13 +240,6 @@ struct HUB75_I2S_CFG {
// Structure Variables
// physical width of a single matrix panel module (in pixels, usually it is 64 ;) )
uint16_t mx_width;
// physical height of a single matrix panel module (in pixels, usually almost always it is either 32 or 64)
uint16_t mx_height;
// number of chained panels regardless of the topology, default 1 - a single matrix module
uint16_t chain_length;
/**
* GPIO pins mapping
*/
@ -256,11 +251,28 @@ struct HUB75_I2S_CFG {
shift_driver driver;
// I2S clock speed
clk_speed i2sspeed;
// use DMA double buffer (twice as much RAM required)
bool double_buff;
// physical width of a single matrix panel module (in pixels, usually it is 64 ;) )
uint16_t mx_width;
// physical height of a single matrix panel module (in pixels, usually almost always it is either 32 or 64)
uint16_t mx_height;
// number of chained panels regardless of the topology, default 1 - a single matrix module
uint16_t chain_length;
// Minimum refresh / scan rate needs to be configured on start due to LSBMSB_TRANSITION_BIT calculation in allocateDMAmemory()
uint16_t min_refresh_rate;
// How many clock cycles to blank OE before/after LAT signal change, default is 1 clock
uint8_t latch_blanking;
// ROWS of each Panel which are controlled at the same time, usually 2, sometimes 4, (8 also possible)
// this is hardware property of your panel(s)
uint8_t matrix_rows_in_parallel;
// use DMA double buffer (twice as much RAM required)
bool double_buff;
/**
* I2S clock phase
* 0 - data lines are clocked with negative edge
@ -277,9 +289,6 @@ struct HUB75_I2S_CFG {
*/
bool clkphase;
// Minimum refresh / scan rate needs to be configured on start due to LSBMSB_TRANSITION_BIT calculation in allocateDMAmemory()
uint16_t min_refresh_rate;
// struct constructor
HUB75_I2S_CFG (
uint16_t _w = MATRIX_WIDTH,
@ -295,7 +304,8 @@ struct HUB75_I2S_CFG {
uint8_t _latblk = DEFAULT_LAT_BLANKING, // Anything > 1 seems to cause artefacts on ICS panels
bool _clockphase = true,
uint16_t _min_refresh_rate = 60,
uint8_t _pixel_color_depth_bits = PIXEL_COLOR_DEPTH_BITS_DEFAULT
uint8_t _pixel_color_depth_bits = PIXEL_COLOR_DEPTH_BITS_DEFAULT,
uint8_t _matrix_rows_in_parallel = MATRIX_ROWS_IN_PARALLEL_DEFAULT
) : mx_width(_w),
mx_height(_h),
chain_length(_chain),
@ -305,7 +315,8 @@ struct HUB75_I2S_CFG {
double_buff(_dbuff),
latch_blanking(_latblk),
clkphase(_clockphase),
min_refresh_rate(_min_refresh_rate)
min_refresh_rate(_min_refresh_rate),
matrix_rows_in_parallel(_matrix_rows_in_parallel)
{
setPixelColorDepthBits(_pixel_color_depth_bits);
}
@ -324,21 +335,16 @@ struct HUB75_I2S_CFG {
}else{
pixel_color_depth_bits = _pixel_color_depth_bits;
}
mask_offset = 16 - pixel_color_depth_bits;
}
uint8_t getPixelColorDepthBits(){
return pixel_color_depth_bits;
}
uint8_t getMaskOffset(){
return mask_offset;
}
private:
//these were priviously handeld as defines (PIXEL_COLOR_DEPTH_BITS, MASK_OFFSET)
//to make it changable after compilation, it is now part of the config
uint8_t pixel_color_depth_bits;
uint8_t mask_offset;
}; // end of structure HUB75_I2S_CFG
@ -377,17 +383,19 @@ class MatrixPanel_I2S_DMA {
*/
MatrixPanel_I2S_DMA(const HUB75_I2S_CFG& opts) :
#ifdef USE_GFX_ROOT
GFX(opts.mx_width*opts.chain_length, opts.mx_height),
GFX(opts.mx_width*opts.chain_length, opts.mx_height)
#elif !defined NO_GFX
Adafruit_GFX(opts.mx_width*opts.chain_length, opts.mx_height),
Adafruit_GFX(opts.mx_width*opts.chain_length, opts.mx_height)
#endif
m_cfg(opts) {}
{
setCfg(opts);
}
/* Propagate the DMA pin configuration, allocate DMA buffs and start data output, initially blank */
bool begin(){
if (initialized) return true; // we don't do this twice or more!
if(!config_set) return false;
ESP_LOGI("begin()", "Using GPIO %d for R1_PIN", m_cfg.gpio.r1);
ESP_LOGI("begin()", "Using GPIO %d for G1_PIN", m_cfg.gpio.g1);
@ -449,7 +457,7 @@ class MatrixPanel_I2S_DMA {
* overload for compatibility
*/
bool begin(int r1, int g1 = G1_PIN_DEFAULT, int b1 = B1_PIN_DEFAULT, int r2 = R2_PIN_DEFAULT, int g2 = G2_PIN_DEFAULT, int b2 = B2_PIN_DEFAULT, int a = A_PIN_DEFAULT, int b = B_PIN_DEFAULT, int c = C_PIN_DEFAULT, int d = D_PIN_DEFAULT, int e = E_PIN_DEFAULT, int lat = LAT_PIN_DEFAULT, int oe = OE_PIN_DEFAULT, int clk = CLK_PIN_DEFAULT);
bool begin(const HUB75_I2S_CFG& cfg);
// Adafruit's BASIC DRAW API (565 colour format)
virtual void drawPixel(int16_t x, int16_t y, uint16_t color); // overwrite adafruit implementation
@ -651,11 +659,6 @@ class MatrixPanel_I2S_DMA {
//setPanelBrightness(b * PIXELS_PER_ROW / 256);
}
/**
* Contains the resulting refresh rate (scan rate) that will be achieved
* based on the i2sspeed, colour depth and min_refresh_rate requested.
*/
int calculated_refresh_rate = 0;
/**
* @brief - Sets how many clock cycles to blank OE before/after LAT signal change
@ -672,6 +675,17 @@ class MatrixPanel_I2S_DMA {
*/
const HUB75_I2S_CFG& getCfg() const {return m_cfg;};
inline bool setCfg(const HUB75_I2S_CFG& cfg){
if(initialized) return false;
m_cfg = cfg;
PIXELS_PER_ROW = m_cfg.mx_width * m_cfg.chain_length;
ROWS_PER_FRAME = m_cfg.mx_height / m_cfg.matrix_rows_in_parallel;
MASK_OFFSET = 16 - m_cfg.getPixelColorDepthBits();
config_set = true;
return true;
}
/**
* Stop the ESP32 DMA Engine. Screen will forever be black until next ESP reboot.
@ -696,8 +710,6 @@ class MatrixPanel_I2S_DMA {
// those might be useful for child classes, like VirtualMatrixPanel
protected:
Bus_Parallel16 dma_bus;
/**
* @brief - clears and reinitializes colour/control data in DMA buffs
* When allocated, DMA buffs might be dirty, so we need to blank it and initialize ABCDE,LAT,OE control bits.
@ -764,40 +776,6 @@ class MatrixPanel_I2S_DMA {
// ------- PRIVATE -------
private:
// Matrix i2s settings
HUB75_I2S_CFG m_cfg;
/* ESP32-HUB75-MatrixPanel-I2S-DMA functioning constants
* we can't change those once object instance initialized it's DMA structs
*/
const uint8_t ROWS_PER_FRAME = m_cfg.mx_height / MATRIX_ROWS_IN_PARALLEL; // RPF - rows per frame, either 16 or 32 depending on matrix module
const uint16_t PIXELS_PER_ROW = m_cfg.mx_width * m_cfg.chain_length; // number of pixels in a single row of all chained matrix modules (WIDTH of a combined matrix chain)
// Other private variables
bool initialized = false;
int active_gfx_writes = 0; // How many async routines are 'drawing' (writing) to the DMA bit buffer. Function called from Adafruit_GFX draw routines like drawCircle etc.
int back_buffer_id = 0; // If using double buffer, which one is NOT active (ie. being displayed) to write too?
int brightness = 128; // If you get ghosting... reduce brightness level. ((60/64)*255) seems to be the limit before ghosting on a 64 pixel wide physical panel for some panels.
int lsbMsbTransitionBit = 0; // For colour depth calculations
// *** DMA FRAMEBUFFER structures
// ESP 32 DMA Linked List descriptor
int desccount = 0;
// lldesc_t * dmadesc_a = {0};
// lldesc_t * dmadesc_b = {0};
/* Pixel data is organized from LSB to MSB sequentially by row, from row 0 to row matrixHeight/matrixRowsInParallel
* (two rows of pixels are refreshed in parallel)
* Memory is allocated (malloc'd) by the row, and not in one massive chunk, for flexibility.
* The whole DMA framebuffer is just a vector of pointers to structs with ESP32_I2S_DMA_STORAGE_TYPE arrays
* Since it's dimensions is unknown prior to class initialization, we just declare it here as empty struct and will do all allocations later.
* Refer to rowBitStruct to get the idea of it's internal structure
*/
frameStruct dma_buff;
/* Calculate the memory available for DMA use, do some other stuff, and allocate accordingly */
bool allocateDMAmemory();
@ -846,6 +824,52 @@ class MatrixPanel_I2S_DMA {
}
#endif
};
public:
/**
* Contains the resulting refresh rate (scan rate) that will be achieved
* based on the i2sspeed, colour depth and min_refresh_rate requested.
*/
int calculated_refresh_rate = 0;
protected:
Bus_Parallel16 dma_bus;
private:
// Matrix i2s settings
HUB75_I2S_CFG m_cfg;
/* Pixel data is organized from LSB to MSB sequentially by row, from row 0 to row matrixHeight/matrixRowsInParallel
* (two rows of pixels are refreshed in parallel)
* Memory is allocated (malloc'd) by the row, and not in one massive chunk, for flexibility.
* The whole DMA framebuffer is just a vector of pointers to structs with ESP32_I2S_DMA_STORAGE_TYPE arrays
* Since it's dimensions is unknown prior to class initialization, we just declare it here as empty struct and will do all allocations later.
* Refer to rowBitStruct to get the idea of it's internal structure
*/
frameStruct dma_buff;
// ESP 32 DMA Linked List descriptor
int desccount = 0;
// lldesc_t * dmadesc_a = {0};
// lldesc_t * dmadesc_b = {0};
int active_gfx_writes = 0; // How many async routines are 'drawing' (writing) to the DMA bit buffer. Function called from Adafruit_GFX draw routines like drawCircle etc.
int back_buffer_id = 0; // If using double buffer, which one is NOT active (ie. being displayed) to write too?
int brightness = 128; // If you get ghosting... reduce brightness level. ((60/64)*255) seems to be the limit before ghosting on a 64 pixel wide physical panel for some panels.
int lsbMsbTransitionBit = 0; // For colour depth calculations
/* ESP32-HUB75-MatrixPanel-I2S-DMA functioning constants
* we should not those once object instance initialized it's DMA structs
* they weree const, but this lead to bugs, when the default constructor was called.
* So now they could be changed, but shouldn't. Maybe put a cpp lock around it, so it can't be changed after initialisation
*/
uint16_t PIXELS_PER_ROW = m_cfg.mx_width * m_cfg.chain_length; // number of pixels in a single row of all chained matrix modules (WIDTH of a combined matrix chain)
uint8_t ROWS_PER_FRAME = m_cfg.mx_height / m_cfg.matrix_rows_in_parallel; // RPF - rows per frame, either 16 or 32 depending on matrix module
uint8_t MASK_OFFSET = 16 - m_cfg.getPixelColorDepthBits();
// Other private variables
bool initialized = false;
bool config_set = false;
}; // end Class header
/***************************************************************************************/