2018-10-23 02:00:47 +02:00
# include "ESP32-RGB64x32MatrixPanel-I2S-DMA.h"
// Credits: Louis Beaudoin <https://github.com/pixelmatix/SmartMatrix/tree/teensylc>
// and Sprite_TM: https://www.esp32.com/viewtopic.php?f=17&t=3188 and https://www.esp32.com/viewtopic.php?f=13&t=3256
2020-07-29 09:47:54 +02:00
/*
This is example code to driver a p3 ( 2121 ) 64 * 32 - style RGB LED display . These types of displays do not have memory and need to be refreshed
continuously . The display has 2 RGB inputs , 4 inputs to select the active line , a pixel clock input , a latch enable input and an output - enable
input . The display can be seen as 2 64 x16 displays consisting of the upper half and the lower half of the display . Each half has a separate
RGB pixel input , the rest of the inputs are shared .
Each display half can only show one line of RGB pixels at a time : to do this , the RGB data for the line is input by setting the RGB input pins
to the desired value for the first pixel , giving the display a clock pulse , setting the RGB input pins to the desired value for the second pixel ,
giving a clock pulse , etc . Do this 64 times to clock in an entire row . The pixels will not be displayed yet : until the latch input is made high ,
the display will still send out the previously clocked in line . Pulsing the latch input high will replace the displayed data with the data just
clocked in .
The 4 line select inputs select where the currently active line is displayed : when provided with a binary number ( 0 - 15 ) , the latched pixel data
will immediately appear on this line . Note : While clocking in data for a line , the * previous * line is still displayed , and these lines should
be set to the value to reflect the position the * previous * line is supposed to be on .
Finally , the screen has an OE input , which is used to disable the LEDs when latching new data and changing the state of the line select inputs :
doing so hides any artifacts that appear at this time . The OE line is also used to dim the display by only turning it on for a limited time every
line .
All in all , an image can be displayed by ' scanning ' the display , say , 100 times per second . The slowness of the human eye hides the fact that
only one line is showed at a time , and the display looks like every pixel is driven at the same time .
Now , the RGB inputs for these types of displays are digital , meaning each red , green and blue subpixel can only be on or off . This leads to a
color palette of 8 pixels , not enough to display nice pictures . To get around this , we use binary code modulation .
Binary code modulation is somewhat like PWM , but easier to implement in our case . First , we define the time we would refresh the display without
binary code modulation as the ' frame time ' . For , say , a four - bit binary code modulation , the frame time is divided into 15 ticks of equal length .
We also define 4 subframes ( 0 to 3 ) , defining which LEDs are on and which LEDs are off during that subframe . ( Subframes are the same as a
normal frame in non - binary - coded - modulation mode , but are showed faster . ) From our ( non - monochrome ) input image , we take the ( 8 - bit : bit 7
to bit 0 ) RGB pixel values . If the pixel values have bit 7 set , we turn the corresponding LED on in subframe 3. If they have bit 6 set ,
we turn on the corresponding LED in subframe 2 , if bit 5 is set subframe 1 , if bit 4 is set in subframe 0.
Now , in order to ( on average within a frame ) turn a LED on for the time specified in the pixel value in the input data , we need to weigh the
subframes . We have 15 pixels : if we show subframe 3 for 8 of them , subframe 2 for 4 of them , subframe 1 for 2 of them and subframe 1 for 1 of
them , this ' automatically ' happens . ( We also distribute the subframes evenly over the ticks , which reduces flicker . )
In this code , we use the I2S peripheral in parallel mode to achieve this . Essentially , first we allocate memory for all subframes . This memory
contains a sequence of all the signals ( 2 xRGB , line select , latch enable , output enable ) that need to be sent to the display for that subframe .
Then we ask the I2S - parallel driver to set up a DMA chain so the subframes are sent out in a sequence that satisfies the requirement that
subframe x has to be sent out for ( 2 ^ x ) ticks . Finally , we fill the subframes with image data .
We use a frontbuffer / backbuffer technique here to make sure the display is refreshed in one go and drawing artifacts do not reach the display .
In practice , for small displays this is not really necessarily .
*/
# define ESP32_NUM_FRAME_BUFFERS 1
bool RGB64x32MatrixPanel_I2S_DMA : : allocateDMAmemory ( )
2018-10-23 02:00:47 +02:00
{
2020-07-29 09:47:54 +02:00
/***
* Step 1 : Look at the overall DMA capable memory for the DMA FRAMEBUFFER data only ( not the DMA linked list descriptors yet )
* and do some pre - checks .
*/
int _num_frame_buffers = ( double_buffering_enabled ) ? 2 : 1 ;
size_t _frame_buffer_memory_required = sizeof ( frameStruct ) * _num_frame_buffers ;
size_t _dma_linked_list_memory_required = 0 ;
size_t _total_dma_capable_memory_reserved = 0 ;
// 1. Calculate and malloc the LARGEST available DMA memory block to matrix_framebuffer_malloc_1
# if SERIAL_DEBUG
Serial . printf ( " Panel Height: %d pixels. \r \n " , MATRIX_HEIGHT ) ;
Serial . printf ( " Panel Width: %d pixels. \r \n " , MATRIX_WIDTH ) ;
if ( double_buffering_enabled ) {
Serial . println ( " DOUBLE FRAME BUFFERS / DOUBLE BUFFERING IS ENABLED. DOUBLE THE RAM REQUIRED! " ) ;
}
2020-07-29 11:44:38 +02:00
2020-07-29 09:47:54 +02:00
Serial . println ( " DMA memory blocks available before any malloc's: " ) ;
heap_caps_print_heap_info ( MALLOC_CAP_DMA ) ;
2020-07-29 11:44:38 +02:00
2020-07-29 09:47:54 +02:00
Serial . printf ( " FYI: Size of an ESP32 DMA linked list descriptor (lldesc_t) is %d bytes \r \n " , sizeof ( lldesc_t ) ) ;
Serial . printf ( " We're going to need %d bytes of SRAM just for the frame buffer(s). \r \n " , _frame_buffer_memory_required ) ;
Serial . printf ( " Largest DMA capable SRAM memory block is %d bytes. \r \n " , heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) ) ;
# endif
// Can we fit the framebuffer into the single DMA capable memory block available?
2020-07-29 11:44:38 +02:00
if ( heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) < _frame_buffer_memory_required ) {
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
# if SERIAL_DEBUG
Serial . printf ( " ######### Insufficent memory for requested resolution. Reduce MATRIX_COLOR_DEPTH and try again. \r \n \t Additional %d bytes of memory required. \r \n \r \n " , ( _frame_buffer_memory_required - heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) ) ) ;
# endif
return false ;
}
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
// Allocate the framebuffer 1 memory, fail if we can even do this
matrix_framebuffer_malloc_1 = ( frameStruct * ) heap_caps_malloc ( _frame_buffer_memory_required , MALLOC_CAP_DMA ) ;
if ( matrix_framebuffer_malloc_1 = = NULL ) {
# if SERIAL_DEBUG
Serial . println ( " ERROR: Couldn't malloc matrix_framebuffer_malloc_1! Critical fail. \r \n " ) ;
# endif
return false ;
}
_total_dma_capable_memory_reserved + = _frame_buffer_memory_required ;
// SPLIT MEMORY MODE
2020-07-29 09:47:54 +02:00
# ifdef SPLIT_MEMORY_MODE
2020-07-29 11:44:38 +02:00
Serial . println ( " SPLIT MEMORY MODE ENABLED! " ) ;
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
# if SERIAL_DEBUG
Serial . print ( " Rows per frame (overall): " ) ; Serial . println ( ROWS_PER_FRAME , DEC ) ;
Serial . print ( " Rows per split framebuffer malloc: " ) ; Serial . println ( SPLIT_MEMORY_ROWS_PER_FRAME , DEC ) ;
# endif
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
// Can we fit the framebuffer into the single DMA capable memory block available?
// Can we fit the framebuffer into the single DMA capable memory block available?
if ( heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) < _frame_buffer_memory_required ) {
# if SERIAL_DEBUG
Serial . printf ( " ######### Insufficent memory for second framebuffer for requested resolution. Reduce MATRIX_COLOR_DEPTH and try again. \r \n \t Additional %d bytes of memory required. \r \n \r \n " , ( _frame_buffer_memory_required - heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) ) ) ;
# endif
return false ;
}
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
// Allocate the framebuffer 2 memory, fail if we can even do this
2020-07-29 09:47:54 +02:00
matrix_framebuffer_malloc_2 = ( frameStruct * ) heap_caps_malloc ( _frame_buffer_memory_required , MALLOC_CAP_DMA ) ;
2020-07-29 11:44:38 +02:00
if ( matrix_framebuffer_malloc_2 = = NULL ) {
2020-07-29 09:47:54 +02:00
# if SERIAL_DEBUG
Serial . println ( " ERROR: Couldn't malloc matrix_framebuffer_malloc_2! Critical fail. \r \n " ) ;
# endif
return false ;
}
_total_dma_capable_memory_reserved + = _frame_buffer_memory_required ;
2020-07-29 11:44:38 +02:00
2020-07-29 09:47:54 +02:00
# endif
/***
* Step 2 : Calculate the amount of memory required for the DMA engine ' s linked list descriptors .
* Credit to SmartMatrix for this stuff .
*/
// Calculate what color depth is actually possible based on memory avaialble vs. required dma linked-list descriptors.
// aka. Calculate the lowest LSBMSB_TRANSITION_BIT value that will fit in memory
int numDMAdescriptorsPerRow = 0 ;
2018-10-23 02:00:47 +02:00
lsbMsbTransitionBit = 0 ;
while ( 1 ) {
2020-07-29 09:47:54 +02:00
numDMAdescriptorsPerRow = 1 ;
for ( int i = lsbMsbTransitionBit + 1 ; i < PIXEL_COLOR_DEPTH_BITS ; i + + ) {
numDMAdescriptorsPerRow + = 1 < < ( i - lsbMsbTransitionBit - 1 ) ;
2018-10-23 02:00:47 +02:00
}
2020-07-29 09:47:54 +02:00
int ramrequired = numDMAdescriptorsPerRow * ROWS_PER_FRAME * _num_frame_buffers * sizeof ( lldesc_t ) ;
2018-10-23 02:00:47 +02:00
int largestblockfree = heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) ;
2020-07-29 09:47:54 +02:00
# if SERIAL_DEBUG
Serial . printf ( " numdesciptors per row %d, lsbMsbTransitionBit of %d requires %d RAM, %d available, leaving %d free: \r \n " , numDMAdescriptorsPerRow , lsbMsbTransitionBit , ramrequired , largestblockfree , largestblockfree - ramrequired ) ;
# endif
2018-10-23 02:00:47 +02:00
2020-07-29 09:47:54 +02:00
if ( ramrequired < largestblockfree )
2018-10-23 02:00:47 +02:00
break ;
2020-07-29 09:47:54 +02:00
if ( lsbMsbTransitionBit < PIXEL_COLOR_DEPTH_BITS - 1 )
2018-10-23 02:00:47 +02:00
lsbMsbTransitionBit + + ;
else
break ;
}
2020-07-29 09:47:54 +02:00
Serial . printf ( " Raised lsbMsbTransitionBit to %d/%d to fit in remaining RAM \r \n " , lsbMsbTransitionBit , PIXEL_COLOR_DEPTH_BITS - 1 ) ;
2018-10-23 02:00:47 +02:00
// calculate the lowest LSBMSB_TRANSITION_BIT value that will fit in memory that will meet or exceed the configured refresh rate
while ( 1 ) {
int psPerClock = 1000000000000UL / ESP32_I2S_CLOCK_SPEED ;
2020-07-29 09:47:54 +02:00
int nsPerLatch = ( ( PIXELS_PER_ROW + CLKS_DURING_LATCH ) * psPerClock ) / 1000 ;
2018-10-23 02:00:47 +02:00
// add time to shift out LSBs + LSB-MSB transition bit - this ignores fractions...
2020-07-29 09:47:54 +02:00
int nsPerRow = PIXEL_COLOR_DEPTH_BITS * nsPerLatch ;
2018-10-23 02:00:47 +02:00
// add time to shift out MSBs
2020-07-29 09:47:54 +02:00
for ( int i = lsbMsbTransitionBit + 1 ; i < PIXEL_COLOR_DEPTH_BITS ; i + + )
nsPerRow + = ( 1 < < ( i - lsbMsbTransitionBit - 1 ) ) * ( PIXEL_COLOR_DEPTH_BITS - i ) * nsPerLatch ;
2018-10-23 02:00:47 +02:00
int nsPerFrame = nsPerRow * ROWS_PER_FRAME ;
int actualRefreshRate = 1000000000UL / ( nsPerFrame ) ;
2020-07-29 09:47:54 +02:00
calculated_refresh_rate = actualRefreshRate ;
2018-10-23 02:00:47 +02:00
Serial . printf ( " lsbMsbTransitionBit of %d gives %d Hz refresh: \r \n " , lsbMsbTransitionBit , actualRefreshRate ) ;
2019-07-29 14:45:06 +02:00
if ( actualRefreshRate > min_refresh_rate ) // HACK Hard Coded: 100
2018-10-23 02:00:47 +02:00
break ;
2020-07-29 09:47:54 +02:00
if ( lsbMsbTransitionBit < PIXEL_COLOR_DEPTH_BITS - 1 )
2018-10-23 02:00:47 +02:00
lsbMsbTransitionBit + + ;
else
break ;
}
2020-07-29 09:47:54 +02:00
Serial . printf ( " Raised lsbMsbTransitionBit to %d/%d to meet minimum refresh rate \r \n " , lsbMsbTransitionBit , PIXEL_COLOR_DEPTH_BITS - 1 ) ;
2018-10-23 02:00:47 +02:00
2020-07-29 09:47:54 +02:00
// lsbMsbTransition Bit is now finalized - recalcuate descriptor count in case it changed to hit min refresh rate
numDMAdescriptorsPerRow = 1 ;
for ( int i = lsbMsbTransitionBit + 1 ; i < PIXEL_COLOR_DEPTH_BITS ; i + + ) {
numDMAdescriptorsPerRow + = 1 < < ( i - lsbMsbTransitionBit - 1 ) ;
2018-10-23 02:00:47 +02:00
}
2020-07-29 09:47:54 +02:00
/***
* Step 3 : Allocate memory for DMA linked list , linking up each framebuffer row in sequence for GPIO output .
*/
_dma_linked_list_memory_required = numDMAdescriptorsPerRow * ROWS_PER_FRAME * _num_frame_buffers * sizeof ( lldesc_t ) ;
Serial . printf ( " Descriptors for lsbMsbTransitionBit %d/%d with %d rows require %d bytes of DMA RAM \r \n " , lsbMsbTransitionBit , PIXEL_COLOR_DEPTH_BITS - 1 , ROWS_PER_FRAME , _dma_linked_list_memory_required ) ;
_total_dma_capable_memory_reserved + = _dma_linked_list_memory_required ;
// Do a final check to see if we have enough space for the additional DMA linked list descriptors that will be required to link it all up!
if ( _dma_linked_list_memory_required > heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) ) {
# if SERIAL_DEBUG
Serial . printf ( " ERROR: Not enough SRAM left over for DMA linked-list descriptor memory reservation! Oh so close! \r \n " ) ;
# endif
return false ;
} // linked list descriptors memory check
2018-10-23 02:00:47 +02:00
// malloc the DMA linked list descriptors that i2s_parallel will need
2020-07-29 09:47:54 +02:00
desccount = numDMAdescriptorsPerRow * ROWS_PER_FRAME ;
//lldesc_t * dmadesc_a = (lldesc_t *)heap_caps_malloc(desccount * sizeof(lldesc_t), MALLOC_CAP_DMA);
dmadesc_a = ( lldesc_t * ) heap_caps_malloc ( desccount * sizeof ( lldesc_t ) , MALLOC_CAP_DMA ) ;
assert ( " Can't allocate descriptor framebuffer a " ) ;
2018-10-23 02:00:47 +02:00
if ( ! dmadesc_a ) {
2020-07-29 09:47:54 +02:00
Serial . printf ( " Error: Could not malloc descriptor framebuffer a. " ) ;
return false ;
2018-10-23 02:00:47 +02:00
}
2020-07-29 09:47:54 +02:00
if ( double_buffering_enabled ) // reserve space for second framebuffer linked list
{
//lldesc_t * dmadesc_b = (lldesc_t *)heap_caps_malloc(desccount * sizeof(lldesc_t), MALLOC_CAP_DMA);
dmadesc_b = ( lldesc_t * ) heap_caps_malloc ( desccount * sizeof ( lldesc_t ) , MALLOC_CAP_DMA ) ;
assert ( " Could not malloc descriptor framebuffer b. " ) ;
if ( ! dmadesc_b ) {
Serial . printf ( " Error: Could not malloc descriptor framebuffer b. " ) ;
return false ;
}
2018-10-23 02:00:47 +02:00
}
2020-07-29 09:47:54 +02:00
Serial . printf ( " *** Memory Allocations Complete *** \r \n " ) ;
Serial . printf ( " Total memory that was reserved: %d kB. \r \n " , _total_dma_capable_memory_reserved / 1024 ) ;
Serial . printf ( " Heap Memory Available: %d bytes total. Largest free block: %d bytes. \r \n " , heap_caps_get_free_size ( 0 ) , heap_caps_get_largest_free_block ( 0 ) ) ;
Serial . printf ( " DMA Memory Available: %d bytes total. Largest free block: %d bytes. \r \n " , heap_caps_get_free_size ( MALLOC_CAP_DMA ) , heap_caps_get_largest_free_block ( MALLOC_CAP_DMA ) ) ;
Serial . printf ( " General RAM Available: %d bytes total. Largest free block: %d bytes. \r \n " , heap_caps_get_free_size ( MALLOC_CAP_DEFAULT ) , heap_caps_get_largest_free_block ( MALLOC_CAP_DEFAULT ) ) ;
2020-07-29 11:44:38 +02:00
# if SERIAL_DEBUG
Serial . println ( " DMA memory blocks available after malloc's: " ) ;
heap_caps_print_heap_info ( MALLOC_CAP_DMA ) ;
delay ( 1000 ) ;
# endif
2020-07-29 09:47:54 +02:00
return true ;
2018-10-23 02:00:47 +02:00
2020-07-29 09:47:54 +02:00
} // end initMatrixDMABuffer()
void RGB64x32MatrixPanel_I2S_DMA : : configureDMA ( int r1_pin , int g1_pin , int b1_pin , int r2_pin , int g2_pin , int b2_pin , int a_pin , int b_pin , int c_pin , int d_pin , int e_pin , int lat_pin , int oe_pin , int clk_pin )
{
# if SERIAL_DEBUG
Serial . println ( " configureDMA(): Starting configuration of DMA engine. \r \n " ) ;
# endif
lldesc_t * previous_dmadesc_a = 0 ;
lldesc_t * previous_dmadesc_b = 0 ;
int current_dmadescriptor_offset = 0 ;
/* Fill DMA linked lists for both frames (as in, halves of the HUB75 panel)
* . . and if double buffering is enabled , link it up for both buffers .
*/
for ( int j = 0 ; j < ROWS_PER_FRAME ; j + + )
{
// Split framebuffer malloc hack 'improvement'
frameStruct * fb_malloc_ptr = matrix_framebuffer_malloc_1 ;
int fb_malloc_j = j ;
# ifdef SPLIT_MEMORY_MODE
if ( j > = SPLIT_MEMORY_ROWS_PER_FRAME ) {
fb_malloc_ptr = matrix_framebuffer_malloc_2 ;
fb_malloc_j - = SPLIT_MEMORY_ROWS_PER_FRAME ; // IMPORTANT
# if SERIAL_DEBUG
Serial . printf ( " Split memory mode. Panel row: %d, mapped to framebuffer malloc 2 offset: %d. \r \n " , j , fb_malloc_j ) ;
# endif
}
# endif
2018-10-23 02:00:47 +02:00
// first set of data is LSB through MSB, single pass - all color bits are displayed once, which takes care of everything below and inlcluding LSBMSB_TRANSITION_BIT
// TODO: size must be less than DMA_MAX - worst case for SmartMatrix Library: 16-bpp with 256 pixels per row would exceed this, need to break into two
2020-07-29 09:47:54 +02:00
link_dma_desc ( & dmadesc_a [ current_dmadescriptor_offset ] , previous_dmadesc_a , & ( fb_malloc_ptr [ 0 ] . rowdata [ fb_malloc_j ] . rowbits [ 0 ] . data ) , sizeof ( rowBitStruct ) * PIXEL_COLOR_DEPTH_BITS ) ;
previous_dmadesc_a = & dmadesc_a [ current_dmadescriptor_offset ] ;
if ( double_buffering_enabled ) {
link_dma_desc ( & dmadesc_b [ current_dmadescriptor_offset ] , previous_dmadesc_b , & ( fb_malloc_ptr [ 1 ] . rowdata [ fb_malloc_j ] . rowbits [ 0 ] . data ) , sizeof ( rowBitStruct ) * PIXEL_COLOR_DEPTH_BITS ) ;
previous_dmadesc_b = & dmadesc_b [ current_dmadescriptor_offset ] ; }
current_dmadescriptor_offset + + ;
for ( int i = lsbMsbTransitionBit + 1 ; i < PIXEL_COLOR_DEPTH_BITS ; i + + ) {
2018-10-23 02:00:47 +02:00
// binary time division setup: we need 2 of bit (LSBMSB_TRANSITION_BIT + 1) four of (LSBMSB_TRANSITION_BIT + 2), etc
// because we sweep through to MSB each time, it divides the number of times we have to sweep in half (saving linked list RAM)
// we need 2^(i - LSBMSB_TRANSITION_BIT - 1) == 1 << (i - LSBMSB_TRANSITION_BIT - 1) passes from i to MSB
2020-07-29 09:47:54 +02:00
//Serial.printf("buffer %d: repeat %d times, size: %d, from %d - %d\r\n", current_dmadescriptor_offset, 1<<(i - lsbMsbTransitionBit - 1), (PIXEL_COLOR_DEPTH_BITS - i), i, PIXEL_COLOR_DEPTH_BITS-1);
2018-10-23 02:00:47 +02:00
for ( int k = 0 ; k < 1 < < ( i - lsbMsbTransitionBit - 1 ) ; k + + ) {
2020-07-29 09:47:54 +02:00
link_dma_desc ( & dmadesc_a [ current_dmadescriptor_offset ] , previous_dmadesc_a , & ( fb_malloc_ptr [ 0 ] . rowdata [ fb_malloc_j ] . rowbits [ i ] . data ) , sizeof ( rowBitStruct ) * ( PIXEL_COLOR_DEPTH_BITS - i ) ) ;
previous_dmadesc_a = & dmadesc_a [ current_dmadescriptor_offset ] ;
if ( double_buffering_enabled ) {
link_dma_desc ( & dmadesc_b [ current_dmadescriptor_offset ] , previous_dmadesc_b , & ( fb_malloc_ptr [ 1 ] . rowdata [ fb_malloc_j ] . rowbits [ i ] . data ) , sizeof ( rowBitStruct ) * ( PIXEL_COLOR_DEPTH_BITS - i ) ) ;
previous_dmadesc_b = & dmadesc_b [ current_dmadescriptor_offset ] ; }
current_dmadescriptor_offset + + ;
} // end color depth ^ 2 linked list
} // end color depth loop
} // end frame rows
# if SERIAL_DEBUG
Serial . println ( " configureDMA(): Configured LL structure. \r \n " ) ;
# endif
dmadesc_a [ desccount - 1 ] . eof = 1 ;
dmadesc_a [ desccount - 1 ] . qe . stqe_next = ( lldesc_t * ) & dmadesc_a [ 0 ] ;
//End markers for DMA LL
if ( double_buffering_enabled ) {
dmadesc_b [ desccount - 1 ] . eof = 1 ;
dmadesc_b [ desccount - 1 ] . qe . stqe_next = ( lldesc_t * ) & dmadesc_b [ 0 ] ;
} else {
dmadesc_b = dmadesc_a ; // link to same 'a' buffer
2018-10-23 02:00:47 +02:00
}
2020-07-29 09:47:54 +02:00
/*
2018-10-23 02:00:47 +02:00
//End markers
dmadesc_a [ desccount - 1 ] . eof = 1 ;
dmadesc_b [ desccount - 1 ] . eof = 1 ;
dmadesc_a [ desccount - 1 ] . qe . stqe_next = ( lldesc_t * ) & dmadesc_a [ 0 ] ;
2020-07-29 09:47:54 +02:00
dmadesc_b [ desccount - 1 ] . qe . stqe_next = ( lldesc_t * ) & dmadesc_b [ 0 ] ;
*/
//Serial.printf("Performing I2S setup.\n");
Added ability to define custom pin mappings
Closes issue #4
Use something like:
' display.begin(R1_PIN, G1_PIN, B1_PIN, R2_PIN, G2_PIN, B2_PIN, A_PIN, B_PIN, C_PIN, D_PIN, E_PIN, LAT_PIN, OE_PIN, CLK_PIN ); // setup the LED matrix'
with R1_PIN etc. referring to your own define or constant variables
2019-01-03 01:22:48 +01:00
i2s_parallel_config_t cfg = {
. gpio_bus = { r1_pin , g1_pin , b1_pin , r2_pin , g2_pin , b2_pin , lat_pin , oe_pin , a_pin , b_pin , c_pin , d_pin , e_pin , - 1 , - 1 , - 1 } ,
. gpio_clk = clk_pin ,
2018-10-23 02:00:47 +02:00
. clkspeed_hz = ESP32_I2S_CLOCK_SPEED , //ESP32_I2S_CLOCK_SPEED, // formula used is 80000000L/(cfg->clkspeed_hz + 1), must result in >=2. Acceptable values 26.67MHz, 20MHz, 16MHz, 13.34MHz...
2020-07-29 09:47:54 +02:00
. bits = ESP32_I2S_DMA_MODE , //ESP32_I2S_DMA_MODE,
2018-10-23 02:00:47 +02:00
. bufa = 0 ,
. bufb = 0 ,
desccount ,
desccount ,
dmadesc_a ,
dmadesc_b
} ;
//Setup I2S
i2s_parallel_setup_without_malloc ( & I2S1 , & cfg ) ;
2020-07-29 09:47:54 +02:00
# if SERIAL_DEBUG
Serial . println ( " configureDMA(): DMA configuration completed on I2S1. \r \n " ) ;
# endif
2020-07-29 11:44:38 +02:00
# if SERIAL_DEBUG
Serial . println ( " DMA Memory Map after DMA LL allocations: " ) ;
heap_caps_print_heap_info ( MALLOC_CAP_DMA ) ;
delay ( 1000 ) ;
# endif
2018-10-23 02:00:47 +02:00
// Just os we know
2020-07-29 09:47:54 +02:00
everything_OK = true ;
2018-10-23 02:00:47 +02:00
} // end initMatrixDMABuff
2020-07-29 09:47:54 +02:00
2019-01-03 00:09:32 +01:00
/* Update a specific co-ordinate in the DMA buffer */
2018-10-23 02:00:47 +02:00
void RGB64x32MatrixPanel_I2S_DMA : : updateMatrixDMABuffer ( int16_t x_coord , int16_t y_coord , uint8_t red , uint8_t green , uint8_t blue )
{
2020-07-29 11:44:38 +02:00
if ( ! everything_OK ) {
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
# if SERIAL_DEBUG
Serial . println ( " Cannot updateMatrixDMABuffer as setup failed! " ) ;
# endif
return ;
}
2020-07-29 09:47:54 +02:00
2020-07-29 11:44:38 +02:00
# ifdef SPLIT_MEMORY_MODE
# ifdef SERIAL_DEBUG
2020-07-29 09:47:54 +02:00
int tmp_y_coord = y_coord ;
2020-07-29 11:44:38 +02:00
# endif
# endif
2018-10-23 02:00:47 +02:00
2020-07-29 09:47:54 +02:00
/* 1) Check that the co-ordinates are within range, or it'll break everything big time.
* Valid co - ordinates are from 0 to ( MATRIX_XXXX - 1 )
*/
if ( x_coord < 0 | | y_coord < 0 | | x_coord > = MATRIX_WIDTH | | y_coord > = MATRIX_HEIGHT ) {
return ;
2018-10-23 02:00:47 +02:00
}
2020-07-29 09:47:54 +02:00
/* 2) Convert the vertical axis / y-axis pixel co-ordinate to a matrix panel parallel co-ordinate..
* eg . If the y co - ordinate is 23 , that ' s actually in the second half of the panel , row 7.
* 23 ( y coord ) - 16 ( for 32 px high panel ) = 7
*/
2018-10-23 02:00:47 +02:00
bool paint_top_half = true ;
2020-07-29 09:47:54 +02:00
if ( y_coord > = ROWS_PER_FRAME ) // co-ords start at zero, y_coord = 15 = 16 (rows per frame)
2018-10-23 02:00:47 +02:00
{
2020-07-29 09:47:54 +02:00
y_coord - = ROWS_PER_FRAME ; // Subtract the ROWS_PER_FRAME from the pixel co-ord to get the panel co-ord.
2018-10-23 02:00:47 +02:00
paint_top_half = false ;
}
2020-07-29 09:47:54 +02:00
for ( int color_depth_idx = 0 ; color_depth_idx < PIXEL_COLOR_DEPTH_BITS ; color_depth_idx + + ) // color depth - 8 iterations
2018-10-23 02:00:47 +02:00
{
uint16_t mask = ( 1 < < color_depth_idx ) ; // 24 bit color
// The destination for the pixel bitstream
2020-07-29 09:47:54 +02:00
//rowBitStruct *p = &matrix_framebuffer_malloc_1[back_buffer_id].rowdata[y_coord].rowbits[color_depth_idx]; //matrixUpdateFrames location to write to uint16_t's
rowBitStruct * p = & matrix_framebuffer_malloc_1 [ back_buffer_id ] . rowdata [ y_coord ] . rowbits [ color_depth_idx ] ;
# ifdef SPLIT_MEMORY_MODE
if ( y_coord > = SPLIT_MEMORY_ROWS_PER_FRAME ) {
p = & matrix_framebuffer_malloc_2 [ back_buffer_id ] . rowdata [ ( y_coord - SPLIT_MEMORY_ROWS_PER_FRAME ) ] . rowbits [ color_depth_idx ] ; //matrixUpdateFrames location to write to uint16_t's
2020-07-29 11:44:38 +02:00
2020-07-29 09:47:54 +02:00
# ifdef SERIAL_DEBUG
2020-07-29 11:44:38 +02:00
// Serial.printf("fb_malloc_2. y-coord: %d, calc. offset: %d \r\n", tmp_y_coord, (y_coord-SPLIT_MEMORY_ROWS_PER_FRAME) );
2020-07-29 09:47:54 +02:00
# endif
2020-07-29 11:44:38 +02:00
}
2020-07-29 09:47:54 +02:00
# endif
2018-10-23 02:00:47 +02:00
int v = 0 ; // the output bitstream
// if there is no latch to hold address, output ADDX lines directly to GPIO and latch data at end of cycle
int gpioRowAddress = y_coord ;
// normally output current rows ADDX, special case for LSB, output previous row's ADDX (as previous row is being displayed for one latch cycle)
if ( color_depth_idx = = 0 )
gpioRowAddress = y_coord - 1 ;
if ( gpioRowAddress & 0x01 ) v | = BIT_A ; // 1
if ( gpioRowAddress & 0x02 ) v | = BIT_B ; // 2
if ( gpioRowAddress & 0x04 ) v | = BIT_C ; // 4
if ( gpioRowAddress & 0x08 ) v | = BIT_D ; // 8
if ( gpioRowAddress & 0x10 ) v | = BIT_E ; // 16
2019-07-29 12:00:04 +02:00
/* ORIG
2018-10-23 02:00:47 +02:00
// need to disable OE after latch to hide row transition
if ( ( x_coord ) = = 0 ) v | = BIT_OE ;
// drive latch while shifting out last bit of RGB data
if ( ( x_coord ) = = PIXELS_PER_LATCH - 1 ) v | = BIT_LAT ;
2019-07-29 12:00:04 +02:00
// need to turn off OE one clock before latch, otherwise can get ghosting
if ( ( x_coord ) = = PIXELS_PER_LATCH - 1 ) v | = BIT_OE ;
*/
// need to disable OE after latch to hide row transition
if ( ( x_coord ) = = 0 ) v | = BIT_OE ;
// drive latch while shifting out last bit of RGB data
2020-07-29 09:47:54 +02:00
if ( ( x_coord ) = = PIXELS_PER_ROW - 1 ) v | = BIT_LAT ;
2019-07-29 12:00:04 +02:00
// need to turn off OE one clock before latch, otherwise can get ghosting
2020-07-29 09:47:54 +02:00
if ( ( x_coord ) = = PIXELS_PER_ROW - 2 ) v | = BIT_OE ;
2019-07-29 12:00:04 +02:00
2018-10-23 02:00:47 +02:00
// turn off OE after brightness value is reached when displaying MSBs
// MSBs always output normal brightness
// LSB (!color_depth_idx) outputs normal brightness as MSB from previous row is being displayed
2018-10-30 00:29:42 +01:00
if ( ( color_depth_idx > lsbMsbTransitionBit | | ! color_depth_idx ) & & ( ( x_coord ) > = brightness ) ) v | = BIT_OE ; // For Brightness
2018-10-23 02:00:47 +02:00
// special case for the bits *after* LSB through (lsbMsbTransitionBit) - OE is output after data is shifted, so need to set OE to fractional brightness
if ( color_depth_idx & & color_depth_idx < = lsbMsbTransitionBit ) {
// divide brightness in half for each bit below lsbMsbTransitionBit
int lsbBrightness = brightness > > ( lsbMsbTransitionBit - color_depth_idx + 1 ) ;
2018-10-30 00:29:42 +01:00
if ( ( x_coord ) > = lsbBrightness ) v | = BIT_OE ; // For Brightness
2018-10-23 02:00:47 +02:00
}
2020-07-29 11:44:38 +02:00
/* When using the drawPixel, we are obviously only changing the value of one x,y position,
* however , the HUB75 is wired up such that it is always painting TWO lines at the same time
* and this reflects the parallel in - DMA - memory data structure of uint16_t ' s that are getting
* pumped out at high speed .
*
* So we need to ensure we persist the bits ( 8 of them ) of the uint16_t for the row we aren ' t changing .
2018-10-23 02:00:47 +02:00
*
2019-01-12 18:20:49 +01:00
* The DMA buffer order has also been reversed ( refer to the last code in this function )
2019-01-04 00:09:00 +01:00
* so we have to check for this and check the correct position of the MATRIX_DATA_STORAGE_TYPE
2018-10-23 02:00:47 +02:00
* data .
*/
2020-07-29 11:44:38 +02:00
int tmp_x_coord = x_coord ;
2018-10-23 02:00:47 +02:00
if ( x_coord % 2 )
{
tmp_x_coord - = 1 ;
} else {
tmp_x_coord + = 1 ;
} // end reordering
if ( paint_top_half )
{ // Need to copy what the RGB status is for the bottom pixels
// Set the color of the pixel of interest
2020-07-29 11:44:38 +02:00
if ( green & mask ) { v | = BIT_G1 ; }
if ( blue & mask ) { v | = BIT_B1 ; }
if ( red & mask ) { v | = BIT_R1 ; }
2018-10-23 02:00:47 +02:00
// Persist what was painted to the other half of the frame equiv. pixel
if ( p - > data [ tmp_x_coord ] & BIT_R2 )
v | = BIT_R2 ;
if ( p - > data [ tmp_x_coord ] & BIT_G2 )
v | = BIT_G2 ;
if ( p - > data [ tmp_x_coord ] & BIT_B2 )
v | = BIT_B2 ;
}
else
{ // Do it the other way around
// Color to set
2020-07-29 11:44:38 +02:00
if ( red & mask ) { v | = BIT_R2 ; }
if ( green & mask ) { v | = BIT_G2 ; }
if ( blue & mask ) { v | = BIT_B2 ; }
2018-10-23 02:00:47 +02:00
// Copy
if ( p - > data [ tmp_x_coord ] & BIT_R1 )
v | = BIT_R1 ;
if ( p - > data [ tmp_x_coord ] & BIT_G1 )
v | = BIT_G1 ;
if ( p - > data [ tmp_x_coord ] & BIT_B1 )
v | = BIT_B1 ;
} // paint
2019-07-29 12:00:04 +02:00
2018-10-23 02:00:47 +02:00
// 16 bit parallel mode
//Save the calculated value to the bitplane memory in reverse order to account for I2S Tx FIFO mode1 ordering
if ( x_coord % 2 ) {
p - > data [ ( x_coord ) - 1 ] = v ;
} else {
p - > data [ ( x_coord ) + 1 ] = v ;
} // end reordering
} // color depth loop (8)
2019-01-10 00:51:27 +01:00
2020-07-29 11:44:38 +02:00
} // updateMatrixDMABuffer (specific co-ords change)
2018-10-23 02:00:47 +02:00
2019-01-03 00:09:32 +01:00
/* Update the entire buffer with a single specific colour - quicker */
void RGB64x32MatrixPanel_I2S_DMA : : updateMatrixDMABuffer ( uint8_t red , uint8_t green , uint8_t blue )
{
2020-07-29 11:44:38 +02:00
if ( ! everything_OK ) return ;
2020-07-29 09:47:54 +02:00
for ( unsigned int matrix_frame_parallel_row = 0 ; matrix_frame_parallel_row < ROWS_PER_FRAME ; matrix_frame_parallel_row + + ) // half height - 16 iterations
2019-01-03 00:09:32 +01:00
{
2020-07-29 09:47:54 +02:00
for ( int color_depth_idx = 0 ; color_depth_idx < PIXEL_COLOR_DEPTH_BITS ; color_depth_idx + + ) // color depth - 8 iterations
2019-01-03 00:09:32 +01:00
{
uint16_t mask = ( 1 < < color_depth_idx ) ; // 24 bit color
// The destination for the pixel bitstream
2020-07-29 09:47:54 +02:00
rowBitStruct * p = & matrix_framebuffer_malloc_1 [ back_buffer_id ] . rowdata [ matrix_frame_parallel_row ] . rowbits [ color_depth_idx ] ; //matrixUpdateFrames location to write to uint16_t's
# ifdef SPLIT_MEMORY_MODE
if ( matrix_frame_parallel_row > = SPLIT_MEMORY_ROWS_PER_FRAME ) {
p = & matrix_framebuffer_malloc_2 [ back_buffer_id ] . rowdata [ ( matrix_frame_parallel_row - SPLIT_MEMORY_ROWS_PER_FRAME ) ] . rowbits [ color_depth_idx ] ; //matrixUpdateFrames location to write to uint16_t's
# ifdef SERIAL_DEBUG
2020-07-29 11:44:38 +02:00
//Serial.printf("Using framebuffer_malloc_2. Row %d = Offset %d\r\n", matrix_frame_parallel_row, (matrix_frame_parallel_row-SPLIT_MEMORY_ROWS_PER_FRAME) );
# endif
}
else
{
# ifdef SERIAL_DEBUG
// Serial.printf("Using framebuffer_malloc_1. Row %d\r\n", matrix_frame_parallel_row );
2020-07-29 09:47:54 +02:00
# endif
}
# endif
2019-01-03 00:09:32 +01:00
2020-07-29 11:44:38 +02:00
2019-01-03 00:09:32 +01:00
for ( int x_coord = 0 ; x_coord < MATRIX_WIDTH ; x_coord + + ) // row pixel width 64 iterations
{
2020-07-29 11:44:38 +02:00
int v = 0 ; // the output bitstream
// if there is no latch to hold address, output ADDX lines directly to GPIO and latch data at end of cycle
int gpioRowAddress = matrix_frame_parallel_row ;
// normally output current rows ADDX, special case for LSB, output previous row's ADDX (as previous row is being displayed for one latch cycle)
if ( color_depth_idx = = 0 )
gpioRowAddress = matrix_frame_parallel_row - 1 ;
if ( gpioRowAddress & 0x01 ) v | = BIT_A ; // 1
if ( gpioRowAddress & 0x02 ) v | = BIT_B ; // 2
if ( gpioRowAddress & 0x04 ) v | = BIT_C ; // 4
if ( gpioRowAddress & 0x08 ) v | = BIT_D ; // 8
if ( gpioRowAddress & 0x10 ) v | = BIT_E ; // 16
/* ORIG
// need to disable OE after latch to hide row transition
if ( ( x_coord ) = = 0 ) v | = BIT_OE ;
// drive latch while shifting out last bit of RGB data
if ( ( x_coord ) = = PIXELS_PER_LATCH - 1 ) v | = BIT_LAT ;
// need to turn off OE one clock before latch, otherwise can get ghosting
if ( ( x_coord ) = = PIXELS_PER_LATCH - 1 ) v | = BIT_OE ;
*/
// need to disable OE after latch to hide row transition
if ( ( x_coord ) = = 0 ) v | = BIT_OE ;
// drive latch while shifting out last bit of RGB data
if ( ( x_coord ) = = PIXELS_PER_ROW - 1 ) v | = BIT_LAT ;
// need to turn off OE one clock before latch, otherwise can get ghosting
if ( ( x_coord ) = = PIXELS_PER_ROW - 2 ) v | = BIT_OE ;
// turn off OE after brightness value is reached when displaying MSBs
// MSBs always output normal brightness
// LSB (!color_depth_idx) outputs normal brightness as MSB from previous row is being displayed
if ( ( color_depth_idx > lsbMsbTransitionBit | | ! color_depth_idx ) & & ( ( x_coord ) > = brightness ) ) v | = BIT_OE ; // For Brightness
// special case for the bits *after* LSB through (lsbMsbTransitionBit) - OE is output after data is shifted, so need to set OE to fractional brightness
if ( color_depth_idx & & color_depth_idx < = lsbMsbTransitionBit ) {
// divide brightness in half for each bit below lsbMsbTransitionBit
int lsbBrightness = brightness > > ( lsbMsbTransitionBit - color_depth_idx + 1 ) ;
if ( ( x_coord ) > = lsbBrightness ) v | = BIT_OE ; // For Brightness
}
// Top and bottom matrix MATRIX_ROWS_IN_PARALLEL half colours
if ( green & mask ) { v | = BIT_G1 ; v | = BIT_R2 ; }
if ( blue & mask ) { v | = BIT_B1 ; v | = BIT_G2 ; }
if ( red & mask ) { v | = BIT_R1 ; v | = BIT_B2 ; }
// 16 bit parallel mode
//Save the calculated value to the bitplane memory in reverse order to account for I2S Tx FIFO mode1 ordering
if ( x_coord % 2 ) {
p - > data [ ( x_coord ) - 1 ] = v ;
} else {
p - > data [ ( x_coord ) + 1 ] = v ;
} // end reordering
} // end x_coord iteration
2019-01-03 00:09:32 +01:00
} // colour depth loop (8)
} // end row iteration
2020-07-29 11:44:38 +02:00
} // updateMatrixDMABuffer (full frame paint)