1 /* Copyright (C) 2015 by Jacob Alexander
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.
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.
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/>.
17 // ----- Includes -----
20 #include <Lib/ScanLib.h>
33 // ----- Defines -----
35 #define LCD_TOTAL_VISIBLE_PAGES 4
36 #define LCD_PAGE_LEN 128
42 // Number of entries in the SPI0 TxFIFO
43 #define SPI0_TxFIFO_CNT ( ( SPI0_SR & SPI_SR_TXCTR ) >> 12 )
47 // ----- Structs -----
49 // ----- Function Declarations -----
52 void cliFunc_lcdCmd ( char* args );
53 void cliFunc_lcdColor( char* args );
54 void cliFunc_lcdInit ( char* args );
55 void cliFunc_lcdTest ( char* args );
59 // ----- Variables -----
61 // Default Image - Displays on startup
62 const uint8_t STLcdDefaultImage[] = { STLcdDefaultImage_define };
65 uint8_t cliFullToggleState = 0;
67 // Normal/Reverse Toggle State
68 uint8_t cliNormalReverseToggleState = 0;
70 // Scan Module command dictionary
71 CLIDict_Entry( lcdCmd, "Send byte via SPI, second argument enables a0. Defaults to control." );
72 CLIDict_Entry( lcdColor, "Set backlight color. 3 16-bit numbers: R G B. i.e. 0xFFF 0x1444 0x32" );
73 CLIDict_Entry( lcdInit, "Re-initialize the LCD display." );
74 CLIDict_Entry( lcdTest, "Test out the LCD display." );
76 CLIDict_Def( lcdCLIDict, "ST LCD Module Commands" ) = {
77 CLIDict_Item( lcdCmd ),
78 CLIDict_Item( lcdColor ),
79 CLIDict_Item( lcdInit ),
80 CLIDict_Item( lcdTest ),
81 { 0, 0, 0 } // Null entry for dictionary end
86 // ----- Interrupt Functions -----
90 // ----- Functions -----
92 inline void SPI_setup()
94 // Enable SPI internal clock
95 SIM_SCGC6 |= SIM_SCGC6_SPI0;
97 // Setup MOSI (SOUT) and SCLK (SCK)
98 PORTC_PCR6 = PORT_PCR_DSE | PORT_PCR_MUX(2);
99 PORTC_PCR5 = PORT_PCR_DSE | PORT_PCR_MUX(2);
102 PORTC_PCR4 = PORT_PCR_DSE | PORT_PCR_MUX(2);
105 SPI0_MCR = SPI_MCR_MSTR | SPI_MCR_PCSIS(1);
107 // DSPI Clock and Transfer Attributes
108 // Frame Size: 8 bits
110 // CLK Low by default
111 SPI0_CTAR0 = SPI_CTAR_FMSZ(7)
115 | SPI_CTAR_PBR(0) | SPI_CTAR_BR(7);
118 // Write buffer to SPI FIFO
119 void SPI_write( uint8_t *buffer, uint8_t len )
122 for ( uint8_t byte = 0; byte < len; byte++ )
124 // Wait for SPI TxFIFO to have 4 or fewer entries
125 while ( !( SPI0_SR & SPI_SR_TFFF ) )
126 delayMicroseconds(10);
128 // Write byte to TxFIFO
130 SPI0_PUSHR = ( buffer[ byte ] & 0xff ) | SPI_PUSHR_PCS(1);
132 // Indicate transfer has completed
133 while ( !( SPI0_SR & SPI_SR_TCF ) );
134 SPI0_SR |= SPI_SR_TCF;
138 // Write to a control register
139 void LCD_writeControlReg( uint8_t byte )
141 // Wait for TxFIFO to be empt
142 while ( SPI0_TxFIFO_CNT != 0 );
144 // Set A0 low to enter control register mode
145 GPIOC_PCOR |= (1<<7);
147 // Write byte to SPI FIFO
148 SPI_write( &byte, 1 );
150 // Wait for TxFIFO to be empty
151 while ( SPI0_TxFIFO_CNT != 0 );
153 // Make sure data has transferred
154 delayMicroseconds(10); // XXX Adjust if SPI speed changes
156 // Set A0 high to go back to display register mode
157 GPIOC_PSOR |= (1<<7);
160 // Write to display register
161 // Pages 0-7 normal display
162 // Page 8 icon buffer
163 void LCD_writeDisplayReg( uint8_t page, uint8_t *buffer, uint8_t len )
165 // Set the register page
166 LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
168 // Set display start line
169 LCD_writeControlReg( 0x40 );
171 // Reset Column Address
172 LCD_writeControlReg( 0x10 );
173 LCD_writeControlReg( 0x00 );
175 // Write buffer to SPI
176 SPI_write( buffer, len );
179 inline void LCD_clearPage( uint8_t page )
181 // Set the register page
182 LCD_writeControlReg( 0xB0 | ( 0x0F & page ) );
184 // Set display start line
185 LCD_writeControlReg( 0x40 );
187 // Reset Column Address
188 LCD_writeControlReg( 0x10 );
189 LCD_writeControlReg( 0x00 );
191 for ( uint8_t page_reg = 0; page_reg < LCD_PAGE_LEN; page_reg++ )
195 // Write buffer to SPI
196 SPI_write( &byte, 1 );
199 // Wait for TxFIFO to be empty
200 while ( SPI0_TxFIFO_CNT != 0 );
207 for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
209 LCD_clearPage( page );
212 // Reset Page, Start Line, and Column Address
214 LCD_writeControlReg( 0xB0 );
217 LCD_writeControlReg( 0x40 );
219 // Reset Column Address
220 LCD_writeControlReg( 0x10 );
221 LCD_writeControlReg( 0x00 );
225 void LCD_initialize()
227 // ADC Select (Normal)
228 LCD_writeControlReg( 0xA0 );
231 LCD_writeControlReg( 0xAE );
233 // COM Scan Output Direction
234 LCD_writeControlReg( 0xC0 );
236 // LCD Bias (1/6 bias)
237 LCD_writeControlReg( 0xA2 );
239 // Power Supply Operating Mode (Internal Only)
240 LCD_writeControlReg( 0x2F );
242 // Internal Rb/Ra Ratio
243 LCD_writeControlReg( 0x26 );
246 LCD_writeControlReg( 0xE2 );
248 // Electric volume mode set, and value
249 LCD_writeControlReg( 0x81 );
250 LCD_writeControlReg( 0x00 );
253 LCD_writeControlReg( 0xAF );
260 inline void LCD_setup()
262 // Register Scan CLI dictionary
263 CLI_registerDictionary( lcdCLIDict, lcdCLIDictName );
268 // Setup Register Control Signal (A0)
269 // Start in display register mode (1)
270 GPIOC_PDDR |= (1<<7);
271 PORTC_PCR7 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(1);
272 GPIOC_PSOR |= (1<<7);
274 // Setup LCD Reset pin (RST)
275 // 0 - Reset, 1 - Normal Operation
276 // Start in normal mode (1)
277 GPIOC_PDDR |= (1<<8);
278 PORTC_PCR8 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(1);
279 GPIOC_PSOR |= (1<<8);
281 // Run LCD intialization sequence
284 // Write default image to LCD
285 for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
286 LCD_writeDisplayReg( page, (uint8_t*)&STLcdDefaultImage[page * LCD_PAGE_LEN], LCD_PAGE_LEN );
289 // TODO Expose default settings
290 SIM_SCGC6 |= SIM_SCGC6_FTM0;
291 FTM0_CNT = 0; // Reset counter
297 // Set FTM to PWM output - Edge Aligned, Low-true pulses
298 FTM0_C0SC = 0x24; // MSnB:MSnA = 10, ELSnB:ELSnA = 01
302 // Base FTM clock selection (72 MHz system clock)
303 // @ 0xFFFF period, 72 MHz / 0xFFFF * 2 = Actual period
304 // Higher pre-scalar will use the most power (also look the best)
305 // Pre-scalar calculations
306 // 0 - 72 MHz -> 549 Hz
307 // 1 - 36 MHz -> 275 Hz
308 // 2 - 18 MHz -> 137 Hz
309 // 3 - 9 MHz -> 69 Hz (Slightly visible flicker)
310 // 4 - 4 500 kHz -> 34 Hz (Visible flickering)
311 // 5 - 2 250 kHz -> 17 Hz
312 // 6 - 1 125 kHz -> 9 Hz
313 // 7 - 562 500 Hz -> 4 Hz
314 // Using a higher pre-scalar without flicker is possible but FTM0_MOD will need to be reduced
315 // Which will reduce the brightness range
317 // System clock, /w prescalar setting
318 FTM0_SC = FTM_SC_CLKS(1) | FTM_SC_PS( STLcdBacklightPrescalar_define );
321 FTM0_C0V = STLcdBacklightRed_define;
322 PORTC_PCR1 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
325 FTM0_C1V = STLcdBacklightGreen_define;
326 PORTC_PCR2 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
329 FTM0_C2V = STLcdBacklightBlue_define;
330 PORTC_PCR3 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(4);
334 // LCD State processing loop
335 inline uint8_t LCD_scan()
337 // NOP - Screen Refresh
338 //LCD_writeControlReg( 0xE3 );
344 // ----- CLI Command Functions -----
346 void cliFunc_lcdInit( char* args )
351 void cliFunc_lcdTest( char* args )
353 // Write default image
354 for ( uint8_t page = 0; page < LCD_TOTAL_VISIBLE_PAGES; page++ )
355 LCD_writeDisplayReg( page, (uint8_t *)&STLcdDefaultImage[page * LCD_PAGE_LEN], LCD_PAGE_LEN );
358 void cliFunc_lcdCmd( char* args )
362 char* arg2Ptr = args;
364 print( NL ); // No \r\n by default after the command is entered
366 curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
367 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
370 if ( *arg1Ptr == '\0' )
374 uint8_t cmd = (uint8_t)numToInt( arg1Ptr );
376 curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
377 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
380 if ( *arg1Ptr == '\0' )
385 info_msg("Sending - ");
388 LCD_writeControlReg( cmd );
391 void cliFunc_lcdColor( char* args )
395 char* arg2Ptr = args;
398 uint16_t rgb[3]; // Red, Green, Blue
400 // Parse integers from 3 arguments
401 for ( uint8_t color = 0; color < 3; color++ )
404 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
406 // Give up if not enough args given
407 if ( *arg1Ptr == '\0' )
410 // Convert argument to integer
411 rgb[ color ] = numToInt( arg1Ptr );