Scan/STLcd/lcd_scan.c

   1 /* Copyright (C) 2015 by Jacob Alexander
   2  *
   3  * This file is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This file is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this file.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 // ----- Includes -----
  18
  19 // Compiler Includes
  20 #include <Lib/ScanLib.h>
  21
  22 // Project Includes
  23 #include <cli.h>
  24 #include <kll_defs.h>
  25 #include <led.h>
  26 #include <print.h>
  27
  28 // Local Includes
  29 #include "lcd_scan.h"
  30
  31
  32
  33 // ----- Defines -----
  34
  35 #define LCD_TOTAL_VISIBLE_PAGES 4
  36 #define LCD_TOTAL_PAGES 9
  37 #define LCD_PAGE_LEN 128
  38
  39
  40
  41 // ----- Macros -----
  42
  43 // Number of entries in the SPI0 TxFIFO
  44 #define SPI0_TxFIFO_CNT ( ( SPI0_SR & SPI_SR_TXCTR ) >> 12 )
  45
  46
  47
  48 // ----- Structs -----
  49
  50 // ----- Function Declarations -----
  51
  52 // CLI Functions
  53 void cliFunc_lcdCmd  ( char* args );
  54 void cliFunc_lcdColor( char* args );
  55 void cliFunc_lcdDisp ( char* args );
  56 void cliFunc_lcdInit ( char* args );
  57 void cliFunc_lcdTest ( char* args );
  58
  59
  60
  61 // ----- Variables -----
  62
  63 // Default Image - Displays on startup
  64 const uint8_t STLcdDefaultImage[] = { STLcdDefaultImage_define };
  65
  66 // Full Toggle State
  67 uint8_t cliFullToggleState = 0;
  68
  69 // Normal/Reverse Toggle State
  70 uint8_t cliNormalReverseToggleState = 0;
  71
  72 // Scan Module command dictionary
  73 CLIDict_Entry( lcdCmd,      "Send byte via SPI, second argument enables a0. Defaults to control." );
  74 CLIDict_Entry( lcdColor,    "Set backlight color. 3 16-bit numbers: R G B. i.e. 0xFFF 0x1444 0x32" );
  75 CLIDict_Entry( lcdDisp,     "Write byte(s) to given page starting at given address. i.e. 0x1 0x5 0xFF 0x00" );
  76 CLIDict_Entry( lcdInit,     "Re-initialize the LCD display." );
  77 CLIDict_Entry( lcdTest,     "Test out the LCD display." );
  78
  79 CLIDict_Def( lcdCLIDict, "ST LCD Module Commands" ) = {
  80         CLIDict_Item( lcdCmd ),
  81         CLIDict_Item( lcdColor ),
  82         CLIDict_Item( lcdDisp ),
  83         CLIDict_Item( lcdInit ),
  84         CLIDict_Item( lcdTest ),
  85         { 0, 0, 0 } // Null entry for dictionary end
  86 };
  87
  88
  89
  90 // ----- Interrupt Functions -----
  91
  92
  93
  94 // ----- Functions -----
  95
  96 inline void SPI_setup()
  97 {
  98         // Enable SPI internal clock
  99         SIM_SCGC6 |= SIM_SCGC6_SPI0;
 100
 101         // Setup MOSI (SOUT) and SCLK (SCK)
 102         PORTC_PCR6 = PORT_PCR_DSE | PORT_PCR_MUX(2);
 103         PORTC_PCR5 = PORT_PCR_DSE | PORT_PCR_MUX(2);
 104
 105         // Setup SS (PCS)
 106         PORTC_PCR4 = PORT_PCR_DSE | PORT_PCR_MUX(2);
 107
 108         // Master Mode, CS0
 109         SPI0_MCR = SPI_MCR_MSTR | SPI_MCR_PCSIS(1);
 110
 111         // DSPI Clock and Transfer Attributes
 112         // Frame Size: 8 bits
 113         // MSB First
 114         // CLK Low by default
 115         SPI0_CTAR0 = SPI_CTAR_FMSZ(7)
 116                 | SPI_CTAR_ASC(7)
 117                 | SPI_CTAR_DT(7)
 118                 | SPI_CTAR_CSSCK(7)
 119                 | SPI_CTAR_PBR(0) | SPI_CTAR_BR(7);
 120 }
 121
 122 // Write buffer to SPI FIFO
 123 void SPI_write( uint8_t *buffer, uint8_t len )
 124 {
 125
 126         for ( uint8_t byte = 0; byte < len; byte++ )
 127         {
 128                 // Wait for SPI TxFIFO to have 4 or fewer entries
 129                 while ( !( SPI0_SR & SPI_SR_TFFF ) )
 130                         delayMicroseconds(10);
 131
 132                 // Write byte to TxFIFO
 133                 // CS0, CTAR0
 134                 SPI0_PUSHR = ( buffer[ byte ] & 0xff ) | SPI_PUSHR_PCS(1);
 135
 136                 // Indicate transfer has completed
 137                 while ( !( SPI0_SR & SPI_SR_TCF ) );
 138                 SPI0_SR |= SPI_SR_TCF;
 139         }
 140 }
 141
 142 // Write to a control register
 143 void LCD_writeControlReg( uint8_t byte )
 144 {
 145         // Wait for TxFIFO to be empt
 146         while ( SPI0_TxFIFO_CNT != 0 );
 147
 148         // Set A0 low to enter control register mode
 149         GPIOC_PCOR |= (1<<7);
 150
 151         // Write byte to SPI FIFO
 152         SPI_write( &byte, 1 );
 153
 154         // Wait for TxFIFO to be empty
 155         while ( SPI0_TxFIFO_CNT != 0 );
 156
 157         // Make sure data has transferred
 158         delayMicroseconds(10); // XXX Adjust if SPI speed changes
 159
 160         // Set A0 high to go back to display register mode
 161         GPIOC_PSOR |= (1<<7);
 162 }
 163
 164 // Write to display register
 165 // Pages 0-7 normal display
 166 // Page  8   icon buffer
 167 void LCD_writeDisplayReg( uint8_t page, uint8_t *buffer, uint8_t len )
 168 {
 169         // Set the register page
 170         LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
 171
 172         // Set display start line
 173         LCD_writeControlReg( 0x40 );
 174
 175         // Reset Column Address
 176         LCD_writeControlReg( 0x10 );
 177         LCD_writeControlReg( 0x00 );
 178
 179         // Write buffer to SPI
 180         SPI_write( buffer, len );
 181 }
 182
 183 inline void LCD_clearPage( uint8_t page )
 184 {
 185         // Set the register page
 186         LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
 187
 188         // Set display start line
 189         LCD_writeControlReg( 0x40 );
 190
 191         // Reset Column Address
 192         LCD_writeControlReg( 0x10 );
 193         LCD_writeControlReg( 0x00 );
 194
 195         for ( uint8_t page_reg = 0; page_reg < LCD_PAGE_LEN; page_reg++ )
 196         {
 197                 uint8_t byte = 0;
 198
 199                 // Write buffer to SPI
 200                 SPI_write( &byte, 1 );
 201         }
 202
 203         // Wait for TxFIFO to be empty
 204         while ( SPI0_TxFIFO_CNT != 0 );
 205 }
 206
 207 // Clear Display
 208 void LCD_clear()
 209 {
 210         // Setup each page
 211         for ( uint8_t page = 0; page < LCD_TOTAL_PAGES; page++ )
 212         {
 213                 LCD_clearPage( page );
 214         }
 215
 216         // Reset Page, Start Line, and Column Address
 217         // Page
 218         LCD_writeControlReg( 0xB0 );
 219
 220         // Start Line
 221         LCD_writeControlReg( 0x40 );
 222
 223         // Reset Column Address
 224         LCD_writeControlReg( 0x10 );
 225         LCD_writeControlReg( 0x00 );
 226 }
 227
 228 // Intialize display
 229 void LCD_initialize()
 230 {
 231         // ADC Select (Normal)
 232         LCD_writeControlReg( 0xA0 );
 233
 234         // LCD Off
 235         LCD_writeControlReg( 0xAE );
 236
 237         // COM Scan Output Direction
 238         LCD_writeControlReg( 0xC0 );
 239
 240         // LCD Bias (1/6 bias)
 241         LCD_writeControlReg( 0xA2 );
 242
 243         // Power Supply Operating Mode (Internal Only)
 244         LCD_writeControlReg( 0x2F );
 245
 246         // Internal Rb/Ra Ratio
 247         LCD_writeControlReg( 0x26 );
 248
 249         // Reset
 250         LCD_writeControlReg( 0xE2 );
 251
 252         // Electric volume mode set, and value
 253         LCD_writeControlReg( 0x81 );
 254         LCD_writeControlReg( 0x00 );
 255
 256         // LCD On
 257         LCD_writeControlReg( 0xAF );
 258
 259         // Clear Display RAM
 260         LCD_clear();
 261 }
 262
 263 // Setup
 264 inline void LCD_setup()
 265 {
 266         // Register Scan CLI dictionary
 267         CLI_registerDictionary( lcdCLIDict, lcdCLIDictName );
 268
 269         // Initialize SPI
 270         SPI_setup();
 271
 272         // Setup Register Control Signal (A0)
 273         // Start in display register mode (1)
 274         GPIOC_PDDR |= (1<<7);
 275         PORTC_PCR7 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(1);
 276         GPIOC_PSOR |= (1<<7);
 277
 278         // Setup LCD Reset pin (RST)
 279         // 0 - Reset, 1 - Normal Operation
 280         // Start in normal mode (1)
 281         GPIOC_PDDR |= (1<<8);
 282         PORTC_PCR8 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(1);
 283         GPIOC_PSOR |= (1<<8);
 284
 285         // Run LCD intialization sequence
 286         LCD_initialize();
 287
 288         // Write default image to LCD
 289         for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
 290                 LCD_writeDisplayReg( page, (uint8_t*)&STLcdDefaultImage[page * LCD_PAGE_LEN], LCD_PAGE_LEN );
 291
 292         // Setup Backlight
 293         SIM_SCGC6 |= SIM_SCGC6_FTM0;
 294         FTM0_CNT = 0; // Reset counter
 295
 296         // PWM Period
 297         // 16-bit maximum
 298         FTM0_MOD = 0xFFFF;
 299
 300         // Set FTM to PWM output - Edge Aligned, Low-true pulses
 301         FTM0_C0SC = 0x24; // MSnB:MSnA = 10, ELSnB:ELSnA = 01
 302         FTM0_C1SC = 0x24;
 303         FTM0_C2SC = 0x24;
 304
 305         // Base FTM clock selection (72 MHz system clock)
 306         // @ 0xFFFF period, 72 MHz / (0xFFFF * 2) = Actual period
 307         // Higher pre-scalar will use the most power (also look the best)
 308         // Pre-scalar calculations
 309         // 0 -      72 MHz -> 549 Hz
 310         // 1 -      36 MHz -> 275 Hz
 311         // 2 -      18 MHz -> 137 Hz
 312         // 3 -       9 MHz ->  69 Hz (Slightly visible flicker)
 313         // 4 -   4 500 kHz ->  34 Hz (Visible flickering)
 314         // 5 -   2 250 kHz ->  17 Hz
 315         // 6 -   1 125 kHz ->   9 Hz
 316         // 7 - 562 500  Hz ->   4 Hz
 317         // Using a higher pre-scalar without flicker is possible but FTM0_MOD will need to be reduced
 318         // Which will reduce the brightness range
 319
 320         // System clock, /w prescalar setting
 321         FTM0_SC = FTM_SC_CLKS(1) | FTM_SC_PS( STLcdBacklightPrescalar_define );
 322
 323         // Red
 324         FTM0_C0V = STLcdBacklightRed_define;
 325         PORTC_PCR1 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
 326
 327         // Green
 328         FTM0_C1V = STLcdBacklightGreen_define;
 329         PORTC_PCR2 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
 330
 331         // Blue
 332         FTM0_C2V = STLcdBacklightBlue_define;
 333         PORTC_PCR3 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
 334 }
 335
 336
 337 // LCD State processing loop
 338 inline uint8_t LCD_scan()
 339 {
 340         return 0;
 341 }
 342
 343
 344
 345 // ----- Capabilities -----
 346
 347 uint16_t LCD_layerStack_prevSize = 0;
 348 void LCD_layerStack_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 349 {
 350         // Display capability name
 351         if ( stateType == 0xFF && state == 0xFF )
 352         {
 353                 print("LCD_layerStack_capability");
 354                 return;
 355         }
 356
 357         // Parse the layer stack, top to bottom
 358         extern uint16_t macroLayerIndexStack[];
 359         extern uint16_t macroLayerIndexStackSize;
 360
 361         // Only process if the stack size has changed
 362         if ( macroLayerIndexStackSize == LCD_layerStack_prevSize )
 363         {
 364                 return;
 365         }
 366         LCD_layerStack_prevSize = macroLayerIndexStackSize;
 367
 368         // Number data for LCD
 369         const uint8_t numbers[10][128] = {
 370                 { STLcdNumber0_define },
 371                 { STLcdNumber1_define },
 372                 { STLcdNumber2_define },
 373                 { STLcdNumber3_define },
 374                 { STLcdNumber4_define },
 375                 { STLcdNumber5_define },
 376                 { STLcdNumber6_define },
 377                 { STLcdNumber7_define },
 378                 { STLcdNumber8_define },
 379                 { STLcdNumber9_define },
 380         };
 381
 382         // Color data for numbers
 383         const uint16_t colors[10][3] = {
 384                 { STLcdNumber0Color_define },
 385                 { STLcdNumber1Color_define },
 386                 { STLcdNumber2Color_define },
 387                 { STLcdNumber3Color_define },
 388                 { STLcdNumber4Color_define },
 389                 { STLcdNumber5Color_define },
 390                 { STLcdNumber6Color_define },
 391                 { STLcdNumber7Color_define },
 392                 { STLcdNumber8Color_define },
 393                 { STLcdNumber9Color_define },
 394         };
 395
 396         // Only display if there are layers active
 397         if ( macroLayerIndexStackSize > 0 )
 398         {
 399                 // Set the color according to the "top-of-stack" layer
 400                 uint16_t layerIndex = macroLayerIndexStack[ macroLayerIndexStackSize - 1 ];
 401                 FTM0_C0V = colors[ layerIndex ][0];
 402                 FTM0_C1V = colors[ layerIndex ][1];
 403                 FTM0_C2V = colors[ layerIndex ][2];
 404
 405                 // Iterate through each of the pages
 406                 // XXX Many of the values here are hard-coded
 407                 //     Eventually a proper font rendering engine should take care of things like this... -HaaTa
 408                 for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
 409                 {
 410                         // Set the register page
 411                         LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
 412
 413                         // Set starting address
 414                         LCD_writeControlReg( 0x10 );
 415                         LCD_writeControlReg( 0x00 );
 416
 417                         // Write data
 418                         for ( uint16_t layer = 1; layer <= macroLayerIndexStackSize; layer++ )
 419                         {
 420                                 layerIndex = macroLayerIndexStack[ macroLayerIndexStackSize - layer ];
 421
 422                                 // Default to 0, if over 9
 423                                 if ( layerIndex > 9 )
 424                                 {
 425                                         layerIndex = 0;
 426                                 }
 427
 428                                 // Write page of number to display
 429                                 SPI_write( (uint8_t*)&numbers[ layerIndex ][ page * 32 ], 32 );
 430                         }
 431
 432                         // Blank out rest of display
 433                         uint8_t data = 0;
 434                         for ( uint8_t c = 0; c < 4 - macroLayerIndexStackSize; c++ )
 435                         {
 436                                 for ( uint8_t byte = 0; byte < 32; byte++ )
 437                                 {
 438                                         SPI_write( &data, 1 );
 439                                 }
 440                         }
 441                 }
 442         }
 443         else
 444         {
 445                 // Set default backlight
 446                 FTM0_C0V = STLcdBacklightRed_define;
 447                 FTM0_C1V = STLcdBacklightGreen_define;
 448                 FTM0_C2V = STLcdBacklightBlue_define;
 449
 450                 // Write default image
 451                 for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
 452                         LCD_writeDisplayReg( page, (uint8_t *)&STLcdDefaultImage[page * LCD_PAGE_LEN], LCD_PAGE_LEN );
 453         }
 454 }
 455
 456
 457
 458 // ----- CLI Command Functions -----
 459
 460 void cliFunc_lcdInit( char* args )
 461 {
 462         LCD_initialize();
 463 }
 464
 465 void cliFunc_lcdTest( char* args )
 466 {
 467         // Write default image
 468         for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
 469                 LCD_writeDisplayReg( page, (uint8_t *)&STLcdDefaultImage[page * LCD_PAGE_LEN], LCD_PAGE_LEN );
 470 }
 471
 472 void cliFunc_lcdCmd( char* args )
 473 {
 474         char* curArgs;
 475         char* arg1Ptr;
 476         char* arg2Ptr = args;
 477
 478         print( NL ); // No \r\n by default after the command is entered
 479
 480         curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
 481         CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 482
 483         // No args
 484         if ( *arg1Ptr == '\0' )
 485                 return;
 486
 487         // SPI Command
 488         uint8_t cmd = (uint8_t)numToInt( arg1Ptr );
 489
 490         curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
 491         CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 492
 493         // Single Arg
 494         if ( *arg1Ptr == '\0' )
 495                 goto cmd;
 496
 497         // TODO Deal with a0
 498 cmd:
 499         info_msg("Sending - ");
 500         printHex( cmd );
 501         print( NL );
 502         LCD_writeControlReg( cmd );
 503 }
 504
 505 void cliFunc_lcdColor( char* args )
 506 {
 507         char* curArgs;
 508         char* arg1Ptr;
 509         char* arg2Ptr = args;
 510
 511         // Colors
 512         uint16_t rgb[3]; // Red, Green, Blue
 513
 514         // Parse integers from 3 arguments
 515         for ( uint8_t color = 0; color < 3; color++ )
 516         {
 517                 curArgs = arg2Ptr;
 518                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 519
 520                 // Give up if not enough args given
 521                 if ( *arg1Ptr == '\0' )
 522                         return;
 523
 524                 // Convert argument to integer
 525                 rgb[ color ] = numToInt( arg1Ptr );
 526         }
 527
 528         // Set PWM channels
 529         FTM0_C0V = rgb[0];
 530         FTM0_C1V = rgb[1];
 531         FTM0_C2V = rgb[2];
 532 }
 533
 534 void cliFunc_lcdDisp( char* args )
 535 {
 536         char* curArgs;
 537         char* arg1Ptr;
 538         char* arg2Ptr = args;
 539
 540         // First process page and starting address
 541         curArgs = arg2Ptr;
 542         CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 543
 544         // Stop processing args if no more are found
 545         if ( *arg1Ptr == '\0' )
 546                 return;
 547         uint8_t page = numToInt( arg1Ptr );
 548
 549         curArgs = arg2Ptr;
 550         CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 551
 552         // Stop processing args if no more are found
 553         if ( *arg1Ptr == '\0' )
 554                 return;
 555         uint8_t address = numToInt( arg1Ptr );
 556
 557         // Set the register page
 558         LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
 559
 560         // Set starting address
 561         LCD_writeControlReg( 0x10 | ( ( 0xF0 & address ) >> 4 ) );
 562         LCD_writeControlReg( 0x00 | ( 0x0F & address ));
 563
 564         // Process all args
 565         for ( ;; )
 566         {
 567                 curArgs = arg2Ptr;
 568                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 569
 570                 // Stop processing args if no more are found
 571                 if ( *arg1Ptr == '\0' )
 572                         break;
 573
 574                 uint8_t value = numToInt( arg1Ptr );
 575
 576                 // Write buffer to SPI
 577                 SPI_write( &value, 1 );
 578         }
 579 }
 580