1 /* Copyright (C) 2014-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>
32 // ----- Defines -----
34 #define I2C_TxBufferLength 300
35 #define I2C_RxBufferLength 8
37 #define LED_BufferLength 144
40 // ----- Structs -----
42 typedef struct I2C_Buffer {
50 typedef struct LED_Buffer {
51 uint8_t buffer[LED_BufferLength];
56 // ----- Function Declarations -----
59 void cliFunc_echo( char* args );
60 void cliFunc_i2cRecv( char* args );
61 void cliFunc_i2cSend( char* args );
62 void cliFunc_ledTest( char* args );
63 void cliFunc_ledZero( char* args );
65 uint8_t I2C_TxBufferPop();
66 void I2C_BufferPush( uint8_t byte, I2C_Buffer *buffer );
67 uint16_t I2C_BufferLen( I2C_Buffer *buffer );
68 uint8_t I2C_Send( uint8_t *data, uint8_t sendLen, uint8_t recvLen );
72 // ----- Variables -----
74 // Scan Module command dictionary
75 CLIDict_Entry( i2cRecv, "Send I2C sequence of bytes and expect a reply of 1 byte on the last sequence." NL "\t\tUse |'s to split sequences with a stop." );
76 CLIDict_Entry( i2cSend, "Send I2C sequence of bytes. Use |'s to split sequences with a stop." );
77 CLIDict_Entry( ledTest, "Test out the led pages." );
78 CLIDict_Entry( ledZero, "Zero out LED register pages (non-configuration)." );
80 CLIDict_Def( ledCLIDict, "ISSI LED Module Commands" ) = {
81 CLIDict_Item( i2cRecv ),
82 CLIDict_Item( i2cSend ),
83 CLIDict_Item( ledTest ),
84 CLIDict_Item( ledZero ),
85 { 0, 0, 0 } // Null entry for dictionary end
90 // Before sending the sequence, I2C_TxBuffer_CurLen is assigned and as each byte is sent, it is decremented
91 // Once I2C_TxBuffer_CurLen reaches zero, a STOP on the I2C bus is sent
92 volatile uint8_t I2C_TxBufferPtr[ I2C_TxBufferLength ];
93 volatile uint8_t I2C_RxBufferPtr[ I2C_TxBufferLength ];
95 volatile I2C_Buffer I2C_TxBuffer = { 0, 0, 0, I2C_TxBufferLength, (uint8_t*)I2C_TxBufferPtr };
96 volatile I2C_Buffer I2C_RxBuffer = { 0, 0, 0, I2C_RxBufferLength, (uint8_t*)I2C_RxBufferPtr };
98 LED_Buffer LED_pageBuffer;
100 // A bit mask determining which LEDs are enabled in the ISSI chip
102 const uint8_t LED_ledEnableMask[] = {
104 0x00, // Starting register address
105 0xFF, 0xFF, // C1-1 -> C1-16
106 0xFF, 0xFF, // C2-1 -> C2-16
107 0xFF, 0xFF, // C3-1 -> C3-16
108 0xFF, 0xFF, // C4-1 -> C4-16
109 0xFF, 0xFF, // C5-1 -> C5-16
110 0xFF, 0xFF, // C6-1 -> C6-16
111 0xFF, 0xFF, // C7-1 -> C7-16
112 0xFF, 0xFF, // C8-1 -> C8-16
113 0xFF, 0xFF, // C9-1 -> C9-16
116 // XXX Pre-fill example of buffers
117 const uint8_t examplePage[] = {
119 0x24, // Starting register address
120 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, // C1-1 -> C1-16
121 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, // C2-1 -> C2-16
122 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, // C3-1 -> C3-16
123 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F, // C4-1 -> C4-16
124 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, // C5-1 -> C5-16
125 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F, // C6-1 -> C6-16
126 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F, // C7-1 -> C7-16
127 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F, // C8-1 -> C8-16
128 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, // C9-1 -> C9-16
133 // ----- Interrupt Functions -----
137 cli(); // Disable Interrupts
139 uint8_t status = I2C0_S; // Read I2C Bus status
141 // Master Mode Transmit
142 if ( I2C0_C1 & I2C_C1_TX )
144 // Check current use of the I2C bus
145 // Currently sending data
146 if ( I2C_TxBuffer.sequencePos > 0 )
148 // Make sure slave sent an ACK
149 if ( status & I2C_S_RXAK )
151 // NACK Detected, disable interrupt
152 erro_print("I2C NAK detected...");
153 I2C0_C1 = I2C_C1_IICEN;
156 I2C_TxBuffer.head = 0;
157 I2C_TxBuffer.tail = 0;
158 I2C_TxBuffer.sequencePos = 0;
163 I2C0_D = I2C_TxBufferPop();
167 else if ( I2C_RxBuffer.sequencePos > 0 )
169 // Master Receive, addr sent
170 if ( status & I2C_S_ARBL )
173 erro_print("Arbitration lost...");
176 I2C0_C1 = I2C_C1_IICEN;
177 I2C0_S = I2C_S_ARBL | I2C_S_IICIF; // Clear ARBL flag and interrupt
179 if ( status & I2C_S_RXAK )
181 // Slave Address NACK Detected, disable interrupt
182 erro_print("Slave Address I2C NAK detected...");
185 I2C0_C1 = I2C_C1_IICEN;
189 dbug_print("Attempting to read byte");
190 I2C0_C1 = I2C_RxBuffer.sequencePos == 1
191 ? I2C_C1_IICEN | I2C_C1_IICIE | I2C_C1_MST | I2C_C1_TXAK // Single byte read
192 : I2C_C1_IICEN | I2C_C1_IICIE | I2C_C1_MST; // Multi-byte read
199 printHex( I2C_BufferLen( (I2C_Buffer*)&I2C_TxBuffer ) );
203 // Delay around STOP to make sure it actually happens...
204 delayMicroseconds( 1 );
205 I2C0_C1 = I2C_C1_IICEN; // Send STOP
206 delayMicroseconds( 7 );
208 // If there is another sequence, start sending
209 if ( I2C_BufferLen( (I2C_Buffer*)&I2C_TxBuffer ) < I2C_TxBuffer.size )
211 // Clear status flags
212 I2C0_S = I2C_S_IICIF | I2C_S_ARBL;
214 // Wait...till the master dies
215 while ( I2C0_S & I2C_S_BUSY );
217 // Enable I2C interrupt
218 I2C0_C1 = I2C_C1_IICEN | I2C_C1_IICIE | I2C_C1_MST | I2C_C1_TX;
221 I2C0_D = I2C_TxBufferPop();
225 // Master Mode Receive
228 // XXX Do we need to handle 2nd last byte?
229 //I2C0_C1 = I2C_C1_IICEN | I2C_C1_IICIE | I2C_C1_MST | I2C_C1_TXAK; // No STOP, Rx, NAK on recv
232 if ( I2C_TxBuffer.sequencePos <= 1 )
235 I2C0_C1 = I2C_C1_IICEN | I2C_C1_MST | I2C_C1_TX;
238 I2C_BufferPush( I2C0_D, (I2C_Buffer*)&I2C_RxBuffer );
240 delayMicroseconds( 1 ); // Should be enough time before issuing the stop
241 I2C0_C1 = I2C_C1_IICEN; // Send STOP
246 I2C_BufferPush( I2C0_D, (I2C_Buffer*)&I2C_RxBuffer );
250 I2C0_S = I2C_S_IICIF; // Clear interrupt
252 sei(); // Re-enable Interrupts
257 // ----- Functions -----
259 inline void I2C_setup()
261 // Enable I2C internal clock
262 SIM_SCGC4 |= SIM_SCGC4_I2C0; // Bus 0
264 // External pull-up resistor
265 PORTB_PCR0 = PORT_PCR_ODE | PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(2);
266 PORTB_PCR1 = PORT_PCR_ODE | PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(2);
268 // SCL Frequency Divider
269 // 400kHz -> 120 (0x85) @ 48 MHz F_BUS
272 I2C0_C1 = I2C_C1_IICEN;
273 I2C0_C2 = I2C_C2_HDRS; // High drive select
275 // Enable I2C Interrupt
276 NVIC_ENABLE_IRQ( IRQ_I2C0 );
279 void LED_zeroPages( uint8_t startPage, uint8_t numPages, uint8_t startReg, uint8_t endReg )
282 uint8_t pageSetup[] = { 0xE8, 0xFD, 0x00 };
284 // Max length of a page + chip id + reg start
285 uint8_t fullPage[ 0xB4 + 2 ] = { 0 }; // Max size of page
286 fullPage[0] = 0xE8; // Set chip id
287 fullPage[1] = startReg; // Set start reg
289 // Iterate through given pages, zero'ing out the given register regions
290 for ( uint8_t page = startPage; page < startPage + numPages; page++ )
296 while ( I2C_Send( pageSetup, sizeof( pageSetup ), 0 ) == 0 )
300 while ( I2C_Send( fullPage, endReg - startReg + 2, 0 ) == 0 )
305 void LED_sendPage( uint8_t *buffer, uint8_t len, uint8_t page )
308 uint8_t pageSetup[] = { 0xE8, 0xFD, page };
311 while ( I2C_Send( pageSetup, sizeof( pageSetup ), 0 ) == 0 )
314 // Write page to I2C Tx Buffer
315 while ( I2C_Send( buffer, len, 0 ) == 0 )
320 void LED_writeReg( uint8_t reg, uint8_t val, uint8_t page )
323 uint8_t pageSetup[] = { 0xE8, 0xFD, page };
326 uint8_t writeData[] = { 0xE8, reg, val };
329 while ( I2C_Send( pageSetup, sizeof( pageSetup ), 0 ) == 0 )
332 while ( I2C_Send( writeData, sizeof( writeData ), 0 ) == 0 )
337 inline void LED_setup()
339 // Register Scan CLI dictionary
340 CLI_registerDictionary( ledCLIDict, ledCLIDictName );
345 // Zero out Frame Registers
346 // This needs to be done before disabling the hardware shutdown (or the leds will do undefined things)
347 LED_zeroPages( 0x0B, 1, 0x00, 0x0C ); // Control Registers
349 // Disable Hardware shutdown of ISSI chip (pull high)
350 GPIOD_PDDR |= (1<<1);
351 PORTD_PCR1 = PORT_PCR_SRE | PORT_PCR_DSE | PORT_PCR_MUX(1);
352 GPIOD_PSOR |= (1<<1);
355 LED_zeroPages( 0x00, 8, 0x00, 0xB4 ); // LED Registers
357 // Enable LEDs based upon mask
358 LED_sendPage( (uint8_t*)LED_ledEnableMask, sizeof( LED_ledEnableMask ), 0 );
360 // Disable Software shutdown of ISSI chip
361 LED_writeReg( 0x0A, 0x01, 0x0B );
365 inline uint8_t I2C_BufferCopy( uint8_t *data, uint8_t sendLen, uint8_t recvLen, I2C_Buffer *buffer )
369 // If sendLen is greater than buffer fail right away
370 if ( sendLen > buffer->size )
373 // Calculate new tail to determine if buffer has enough space
374 // The first element specifies the expected number of bytes from the slave (+1)
375 // The second element in the new buffer is the length of the buffer sequence (+1)
376 uint16_t newTail = buffer->tail + sendLen + 2;
377 if ( newTail >= buffer->size )
378 newTail -= buffer->size;
380 if ( I2C_BufferLen( buffer ) < sendLen + 2 )
385 printHex( sendLen + 2 );
393 // If buffer is clean, return 1, otherwise 2
394 reTurn = buffer->head == buffer->tail ? 1 : 2;
396 // Add to buffer, already know there is enough room (simplifies adding logic)
397 uint8_t bufferHeaderPos = 0;
398 for ( uint16_t c = 0; c < sendLen; c++ )
400 // Add data to buffer
401 switch ( bufferHeaderPos )
404 buffer->buffer[ buffer->tail ] = recvLen;
410 buffer->buffer[ buffer->tail ] = sendLen;
416 buffer->buffer[ buffer->tail ] = data[ c ];
420 // Check for wrap-around case
421 if ( buffer->tail + 1 >= buffer->size )
436 inline uint16_t I2C_BufferLen( I2C_Buffer *buffer )
439 if ( buffer->tail >= buffer->head )
440 return buffer->head + buffer->size - buffer->tail;
443 return buffer->head - buffer->tail;
447 void I2C_BufferPush( uint8_t byte, I2C_Buffer *buffer )
449 // Make sure buffer isn't full
450 if ( buffer->tail + 1 == buffer->head || ( buffer->head > buffer->tail && buffer->tail + 1 - buffer->size == buffer->head ) )
452 warn_msg("I2C_BufferPush failed, buffer full: ");
458 // Check for wrap-around case
459 if ( buffer->tail + 1 >= buffer->size )
469 // Add byte to buffer
470 buffer->buffer[ buffer->tail ] = byte;
474 uint8_t I2C_TxBufferPop()
476 // Return 0xFF if no buffer left (do not rely on this)
477 if ( I2C_BufferLen( (I2C_Buffer*)&I2C_TxBuffer ) >= I2C_TxBuffer.size )
479 erro_msg("No buffer to pop an entry from... ");
480 printHex( I2C_TxBuffer.head );
482 printHex( I2C_TxBuffer.tail );
484 printHex( I2C_TxBuffer.sequencePos );
489 // If there is currently no sequence being sent, the first entry in the RingBuffer is the length
490 if ( I2C_TxBuffer.sequencePos == 0 )
492 I2C_TxBuffer.sequencePos = 0xFF; // So this doesn't become an infinite loop
493 I2C_RxBuffer.sequencePos = I2C_TxBufferPop();
494 I2C_TxBuffer.sequencePos = I2C_TxBufferPop();
497 uint8_t data = I2C_TxBuffer.buffer[ I2C_TxBuffer.head ];
503 if ( I2C_TxBuffer.head >= I2C_TxBuffer.size )
504 I2C_TxBuffer.head = 0;
506 // Decrement buffer sequence (until next stop will be sent)
507 I2C_TxBuffer.sequencePos--;
510 dbug_msg("Popping: ");
513 printHex( I2C_TxBuffer.head );
515 printHex( I2C_TxBuffer.tail );
517 printHex( I2C_TxBuffer.sequencePos );
524 uint8_t I2C_Send( uint8_t *data, uint8_t sendLen, uint8_t recvLen )
526 // Check head and tail pointers
528 // If empty, start up I2C Master Tx
529 // If buffer is non-empty and non-full, just append to the buffer
530 switch ( I2C_BufferCopy( data, sendLen, recvLen, (I2C_Buffer*)&I2C_TxBuffer ) )
532 // Not enough buffer space...
535 erro_msg("Not enough Tx buffer space... ");
536 printHex( I2C_TxBuffer.head );
538 printHex( I2C_TxBuffer.tail );
542 printHex( I2C_TxBuffer.size );
547 // Empty buffer, initialize I2C
549 // Clear status flags
550 I2C0_S = I2C_S_IICIF | I2C_S_ARBL;
552 // Check to see if we already have control of the bus
553 if ( I2C0_C1 & I2C_C1_MST )
555 // Already the master (ah yeah), send a repeated start
556 I2C0_C1 = I2C_C1_IICEN | I2C_C1_MST | I2C_C1_RSTA | I2C_C1_TX;
558 // Otherwise, seize control
561 // Wait...till the master dies
562 while ( I2C0_S & I2C_S_BUSY );
564 // Now we're the master (ah yisss), get ready to send stuffs
565 I2C0_C1 = I2C_C1_IICEN | I2C_C1_MST | I2C_C1_TX;
568 // Enable I2C interrupt
569 I2C0_C1 = I2C_C1_IICEN | I2C_C1_IICIE | I2C_C1_MST | I2C_C1_TX;
571 // Depending on what type of transfer, the first byte is configured for R or W
572 I2C0_D = I2C_TxBufferPop();
577 // Dirty buffer, I2C already initialized
583 // LED State processing loop
584 inline uint8_t LED_scan()
596 // ----- CLI Command Functions -----
598 void cliFunc_i2cSend( char* args )
602 char* arg2Ptr = args;
604 // Buffer used after interpretting the args, will be sent to I2C functions
605 // NOTE: Limited to 8 bytes currently (can be increased if necessary
606 #define i2cSend_BuffLenMax 8
607 uint8_t buffer[ i2cSend_BuffLenMax ];
608 uint8_t bufferLen = 0;
610 // No \r\n by default after the command is entered
612 info_msg("Sending: ");
614 // Parse args until a \0 is found
615 while ( bufferLen < i2cSend_BuffLenMax )
617 curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
618 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
620 // Stop processing args if no more are found
621 if ( *arg1Ptr == '\0' )
624 // If | is found, end sequence and start new one
625 if ( *arg1Ptr == '|' )
628 I2C_Send( buffer, bufferLen, 0 );
633 // Interpret the argument
634 buffer[ bufferLen++ ] = (uint8_t)numToInt( arg1Ptr );
643 I2C_Send( buffer, bufferLen, 0 );
646 void cliFunc_i2cRecv( char* args )
650 char* arg2Ptr = args;
652 // Buffer used after interpretting the args, will be sent to I2C functions
653 // NOTE: Limited to 8 bytes currently (can be increased if necessary
654 #define i2cSend_BuffLenMax 8
655 uint8_t buffer[ i2cSend_BuffLenMax ];
656 uint8_t bufferLen = 0;
658 // No \r\n by default after the command is entered
660 info_msg("Sending: ");
662 // Parse args until a \0 is found
663 while ( bufferLen < i2cSend_BuffLenMax )
665 curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
666 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
668 // Stop processing args if no more are found
669 if ( *arg1Ptr == '\0' )
672 // If | is found, end sequence and start new one
673 if ( *arg1Ptr == '|' )
676 I2C_Send( buffer, bufferLen, 0 );
681 // Interpret the argument
682 buffer[ bufferLen++ ] = (uint8_t)numToInt( arg1Ptr );
691 I2C_Send( buffer, bufferLen, 1 ); // Only 1 byte is ever read at a time with the ISSI chip
694 void cliFunc_ledTest( char* args )
696 print( NL ); // No \r\n by default after the command is entered
697 LED_sendPage( (uint8_t*)examplePage, sizeof( examplePage ), 0 );
700 void cliFunc_ledZero( char* args )
702 print( NL ); // No \r\n by default after the command is entered
703 LED_zeroPages( 0x00, 8, 0x24, 0xB4 ); // Only PWMs