Adding cli API call to set LCD backlight brightness (16 bit per channel)

[kiibohd-controller.git] / Scan / STLcd / lcd_scan.c

diff --git a/Scan/STLcd/lcd_scan.c b/Scan/STLcd/lcd_scan.c
index 5cc7c89a5297b871a6b49dd3cf12599a4950bd18..b4933cb9cb8d894e5f29f448681c82099eb7c8c1 100644 (file)
--- a/Scan/STLcd/lcd_scan.c
+++ b/Scan/STLcd/lcd_scan.c
@@ -21,6 +21,7 @@
 
 // Project Includes
 #include <cli.h>
+#include <kll.h>
 #include <led.h>
 #include <print.h>
 
@@ -32,7 +33,7 @@
 // ----- Defines -----
 
 #define LCD_TOTAL_VISIBLE_PAGES 4
-#define LCD_PAGE_LEN 132
+#define LCD_PAGE_LEN 128
 
 
 
@@ -48,9 +49,10 @@
 // ----- Function Declarations -----
 
 // CLI Functions
-void cliFunc_lcdCmd( char* args );
-void cliFunc_lcdInit( char* args );
-void cliFunc_lcdTest( char* args );
+void cliFunc_lcdCmd  ( char* args );
+void cliFunc_lcdColor( char* args );
+void cliFunc_lcdInit ( char* args );
+void cliFunc_lcdTest ( char* args );
 
 
 
@@ -64,11 +66,13 @@ uint8_t cliNormalReverseToggleState = 0;
 
 // Scan Module command dictionary
 CLIDict_Entry( lcdCmd,      "Send byte via SPI, second argument enables a0. Defaults to control." );
+CLIDict_Entry( lcdColor,    "Set backlight color. 3 16-bit numbers: R G B. i.e. 0xFFF 0x1444 0x32" );
 CLIDict_Entry( lcdInit,     "Re-initialize the LCD display." );
 CLIDict_Entry( lcdTest,     "Test out the LCD display." );
 
 CLIDict_Def( lcdCLIDict, "ST LCD Module Commands" ) = {
        CLIDict_Item( lcdCmd ),
+       CLIDict_Item( lcdColor ),
        CLIDict_Item( lcdInit ),
        CLIDict_Item( lcdTest ),
        { 0, 0, 0 } // Null entry for dictionary end
@@ -158,6 +162,13 @@ void LCD_writeDisplayReg( uint8_t page, uint8_t *buffer, uint8_t len )
        // Set the register page
        LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
 
+       // Set display start line
+       LCD_writeControlReg( 0x40 );
+
+       // Reset Column Address
+       LCD_writeControlReg( 0x10 );
+       LCD_writeControlReg( 0x00 );
+
        // Write buffer to SPI
        SPI_write( buffer, len );
 }
@@ -251,7 +262,6 @@ inline void LCD_setup()
        // Initialize SPI
        SPI_setup();
 
-
        // Setup Register Control Signal (A0)
        // Start in display register mode (1)
        GPIOC_PDDR |= (1<<7);
@@ -267,6 +277,50 @@ inline void LCD_setup()
 
        // Run LCD intialization sequence
        LCD_initialize();
+
+       // Setup Backlight
+       // TODO Expose default settings
+       SIM_SCGC6 |= SIM_SCGC6_FTM0;
+       FTM0_CNT = 0; // Reset counter
+
+       // PWM Period
+       // 16-bit maximum
+       FTM0_MOD = 0xFFFF;
+
+       // Set FTM to PWM output - Edge Aligned, Low-true pulses
+       FTM0_C0SC = 0x24; // MSnB:MSnA = 10, ELSnB:ELSnA = 01
+       FTM0_C1SC = 0x24;
+       FTM0_C2SC = 0x24;
+
+       // Base FTM clock selection (72 MHz system clock)
+       // @ 0xFFFF period, 72 MHz / 0xFFFF * 2 = Actual period
+       // Higher pre-scalar will use the most power (also look the best)
+       // Pre-scalar calculations
+       // 0 -      72 MHz -> 549 Hz
+       // 1 -      36 MHz -> 275 Hz
+       // 2 -      18 MHz -> 137 Hz
+       // 3 -       9 MHz ->  69 Hz (Slightly visible flicker)
+       // 4 -   4 500 kHz ->  34 Hz (Visible flickering)
+       // 5 -   2 250 kHz ->  17 Hz
+       // 6 -   1 125 kHz ->   9 Hz
+       // 7 - 562 500  Hz ->   4 Hz
+       // Using a higher pre-scalar without flicker is possible but FTM0_MOD will need to be reduced
+       // Which will reduce the brightness range
+
+       // System clock, /w prescalar setting
+       FTM0_SC = FTM_SC_CLKS(1) | FTM_SC_PS( STLcdBacklightPrescalar_define );
+
+       // Red
+       FTM0_C0V = STLcdBacklightRed_define;
+       PORTC_PCR1 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
+
+       // Green
+       FTM0_C1V = STLcdBacklightGreen_define;
+       PORTC_PCR2 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
+
+       // Blue
+       FTM0_C2V = STLcdBacklightBlue_define;
+       PORTC_PCR3 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
 }
 
 
@@ -295,10 +349,23 @@ void cliFunc_lcdTest( char* args )
        //LCD_initialize();
        // Test pattern
        uint8_t pattern[] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
+
+
+uint8_t logo[] = {
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+};
        //uint8_t pattern[] = { 0xFF, 0x00, 0x96, 0xFF, 0x00, 0xFF, 0x00 };
 
        // Write to page D0
-       LCD_writeDisplayReg( 0, pattern, sizeof( pattern ) );
+       //LCD_writeDisplayReg( 0, pattern, sizeof( pattern ) );
+
+       for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
+       {
+               LCD_writeDisplayReg( page, &logo[page * LCD_PAGE_LEN], LCD_PAGE_LEN );
+       }
 }
 
 void cliFunc_lcdCmd( char* args )
@@ -334,3 +401,34 @@ cmd:
        LCD_writeControlReg( cmd );
 }
 
+void cliFunc_lcdColor( char* args )
+{
+       char* curArgs;
+       char* arg1Ptr;
+       char* arg2Ptr = args;
+
+       // Colors
+       uint16_t rgb[3]; // Red, Green, Blue
+
+       // Parse integers from 3 arguments
+       for ( uint8_t color = 0; color < 3; color++ )
+       {
+               curArgs = arg2Ptr;
+               CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+
+               // Give up if not enough args given
+               if ( *arg1Ptr == '\0' )
+                       return;
+
+               // Convert argument to integer
+               rgb[ color ] = numToInt( arg1Ptr );
+       }
+
+       // Set PWM channels
+       FTM0_C0V = rgb[0];
+       FTM0_C1V = rgb[1];
+       FTM0_C2V = rgb[2];
+
+       print( NL ); // No \r\n by default after the command is entered
+}
+