louis/kiibohd-controller: Output/usbMuxUart/output

comparison Output/usbMuxUart/output_com.c @ 347:136e47478441

UARTConnect enumeration working! - Fixed cli reflash mode set - Cleaned up debugging code - 4 500 000 baud seems to be reliable - Fixed master selection (assumes slave node unless USB enumerates)

author	Jacob Alexander <haata@kiibohd.com>
date	Sat, 18 Jul 2015 18:53:21 -0700
parents	e8841d3c6db5
children	39e338a6733d

comparison

equal deleted inserted replaced

-:1beec5f17e64
+:136e47478441
 // ----- Function Declarations -----
 void cliFunc_kbdProtocol( char* args );
+void cliFunc_outputDebug( char* args );
 void cliFunc_readLEDs   ( char* args );
 void cliFunc_readUART   ( char* args );
 void cliFunc_sendKeys   ( char* args );
 void cliFunc_sendUART   ( char* args );
 void cliFunc_setKeys    ( char* args );
 // ----- Variables -----
 // Output Module command dictionary
 CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode" );
+CLIDict_Entry( outputDebug, "Toggle Output Debug mode." );
 CLIDict_Entry( readLEDs,    "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc." );
 CLIDict_Entry( readUART,    "Read UART buffer until empty." );
 CLIDict_Entry( sendKeys,    "Send the prepared list of USB codes and modifier byte." );
 CLIDict_Entry( sendUART,    "Send characters over UART0." );
 CLIDict_Entry( setKeys,     "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m." );
 CLIDict_Entry( setMod,      "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI" );
 CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
 	CLIDict_Item( kbdProtocol ),
+	CLIDict_Item( outputDebug ),
 	CLIDict_Item( readLEDs ),
 	CLIDict_Item( readUART ),
 	CLIDict_Item( sendKeys ),
 	CLIDict_Item( sendUART ),
 	CLIDict_Item( setKeys ),
 // Which modifier keys are currently pressed
 // 1=left ctrl,    2=left shift,   4=left alt,    8=left gui
 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
-	uint8_t  USBKeys_Modifiers    = 0;
+uint8_t  USBKeys_Modifiers    = 0;
-	uint8_t  USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
+uint8_t  USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
-	uint8_t  USBKeys_Keys   [USB_NKRO_BITFIELD_SIZE_KEYS];
+uint8_t  USBKeys_Keys   [USB_NKRO_BITFIELD_SIZE_KEYS];
-	uint8_t  USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
+uint8_t  USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
 // System Control and Consumer Control 1KRO containers
-	uint8_t  USBKeys_SysCtrl;
+uint8_t  USBKeys_SysCtrl;
-	uint16_t USBKeys_ConsCtrl;
+uint16_t USBKeys_ConsCtrl;
 // The number of keys sent to the usb in the array
-	uint8_t  USBKeys_Sent    = 0;
+uint8_t  USBKeys_Sent    = 0;
-	uint8_t  USBKeys_SentCLI = 0;
+uint8_t  USBKeys_SentCLI = 0;
 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
 volatile uint8_t  USBKeys_LEDs = 0;
 // Protocol setting from the host.
 // 0 - Boot Mode
 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
-volatile uint8_t  USBKeys_Protocol = 0;
+volatile uint8_t  USBKeys_Protocol = 1;
 // Indicate if USB should send update
 // OS only needs update if there has been a change in state
 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
 // the idle configuration, how often we send the report to the
 // host (ms * 4) even when it hasn't changed
-	uint8_t  USBKeys_Idle_Config = 125;
+uint8_t  USBKeys_Idle_Config = 125;
 // count until idle timeout
-	uint8_t  USBKeys_Idle_Count = 0;
+uint8_t  USBKeys_Idle_Count = 0;
 // Indicates whether the Output module is fully functional
 // 0 - Not fully functional, 1 - Fully functional
 // 0 is often used to show that a USB cable is not plugged in (but has power)
-	uint8_t  Output_Available = 0;
+volatile uint8_t  Output_Available = 0;
 // Debug control variable for Output modules
 // 0 - Debug disabled (default)
 // 1 - Debug enabled
-	 uint8_t  Output_DebugMode = 0;
+uint8_t  Output_DebugMode = 0;
 // ----- Capabilities -----
 	if ( state == 0x01 || state == 0x03 )
 		USBKeys_Changed |= USBKeyChangeState_Consumer;
 	// Only send keypresses if press or hold state
 	if ( stateType == 0x00 && state == 0x03 ) // Release state
-		return;
+	{
+		USBKeys_ConsCtrl = 0;
+		return;
+	}
 	// Set consumer control code
 	USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
 }
 	if ( state == 0x01 || state == 0x03 )
 		USBKeys_Changed |= USBKeyChangeState_System;
 	// Only send keypresses if press or hold state
 	if ( stateType == 0x00 && state == 0x03 ) // Release state
-		return;
+	{
+		USBKeys_SysCtrl = 0;
+		return;
+	}
 	// Set system control code
 	USBKeys_SysCtrl = args[0];
 }
 	uint8_t key = args[0];
 	// Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
 	// Boot mode - Maximum of 6 byte codes
 	// NKRO mode - Each bit of the 26 byte corresponds to a key
-	//  Bits   0 - 160 (first 20 bytes) correspond to USB Codes 4   - 164
+	//  Bits   0 -  45 (bytes  0 -  5) correspond to USB Codes   4 -  49 (Main)
-	//  Bits 161 - 205 (last 6 bytes)   correspond to USB Codes 176 - 221
+	//  Bits  48 - 161 (bytes  6 - 20) correspond to USB Codes  51 - 164 (Secondary)
-	//  Bits 206 - 208 (last byte)      correspond to the 3 padded bits in USB (unused)
+	//  Bits 168 - 213 (bytes 21 - 26) correspond to USB Codes 176 - 221 (Tertiary)
+	//  Bits 214 - 216                 unused
 	uint8_t bytePosition = 0;
 	uint8_t byteShift = 0;
 	switch ( USBKeys_Protocol )
 	{
 	case 0: // Boot Mode
 			}
 			USBKeys_Changed |= USBKeyChangeState_Modifiers;
 			break;
 		}
-		// First 20 bytes
+		// First 6 bytes
-		else if ( key >= 4 && key <= 164 )
+		else if ( key >= 4 && key <= 49 )
 		{
 			// Lookup (otherwise division or multiple checks are needed to do alignment)
-			uint8_t keyPos = key - 4; // Starting position in array
+			// Starting at 0th position, each byte has 8 bits, starting at 4th bit
+			uint8_t keyPos = key + (0 * 8 - 4); // Starting position in array, Ignoring 4 keys
 			switch ( keyPos )
 			{
 				byteLookup( 0 );
 				byteLookup( 1 );
 				byteLookup( 2 );
 				byteLookup( 3 );
 				byteLookup( 4 );
 				byteLookup( 5 );
+			}
+			USBKeys_Changed |= USBKeyChangeState_MainKeys;
+		}
+		// Next 14 bytes
+		else if ( key >= 51 && key <= 155 )
+		{
+			// Lookup (otherwise division or multiple checks are needed to do alignment)
+			// Starting at 6th byte position, each byte has 8 bits, starting at 51st bit
+			uint8_t keyPos = key + (6 * 8 - 51); // Starting position in array
+			switch ( keyPos )
+			{
 				byteLookup( 6 );
 				byteLookup( 7 );
 				byteLookup( 8 );
 				byteLookup( 9 );
 				byteLookup( 10 );
 				byteLookup( 17 );
 				byteLookup( 18 );
 				byteLookup( 19 );
 			}
-			USBKeys_Changed |= USBKeyChangeState_MainKeys;
+			USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
+		}
+		// Next byte
+		else if ( key >= 157 && key <= 164 )
+		{
+			// Lookup (otherwise division or multiple checks are needed to do alignment)
+			uint8_t keyPos = key + (20 * 8 - 157); // Starting position in array, Ignoring 6 keys
+			switch ( keyPos )
+			{
+				byteLookup( 20 );
+			}
+			USBKeys_Changed |= USBKeyChangeState_TertiaryKeys;
 		}
 		// Last 6 bytes
 		else if ( key >= 176 && key <= 221 )
 		{
 			// Lookup (otherwise division or multiple checks are needed to do alignment)
-			uint8_t keyPos = key - 176; // Starting position in array
+			uint8_t keyPos = key + (21 * 8 - 176); // Starting position in array
 			switch ( keyPos )
 			{
-				byteLookup( 20 );
 				byteLookup( 21 );
 				byteLookup( 22 );
 				byteLookup( 23 );
 				byteLookup( 24 );
 				byteLookup( 25 );
-			}
+				byteLookup( 26 );
+			}
-			USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
+			USBKeys_Changed |= USBKeyChangeState_QuartiaryKeys;
+		}
+		// Received 0x00
+		// This is a special USB Code that internally indicates a "break"
+		// It is used to send "nothing" in order to break up sequences of USB Codes
+		else if ( key == 0x00 )
+		{
+			USBKeys_Changed |= USBKeyChangeState_MainKeys;
+			// Also flush out buffers just in case
+			Output_flushBuffers();
+			break;
 		}
 		// Invalid key
 		else
 		{
-			warn_msg("USB Code not within 4-164 (0x4-0xA4) or 176-221 (0xB0-0xDD) NKRO Mode: ");
+			warn_msg("USB Code not within 4-49 (0x4-0x31), 51-155 (0x33-0x9B), 157-164 (0x9D-0xA4), 176-221 (0xB0-0xDD) or 224-231 (0xE0-0xE7) NKRO Mode: ");
 			printHex( key );
 			print( NL );
 			break;
 		}
 // USB Module Setup
 inline void Output_setup()
 {
 	// Setup UART
 	uart_serial_setup();
-	print("\033[2J"); // Clear screen
+	// Initialize the USB
-	// Initialize the USB, and then wait for the host to set configuration.
+	// If a USB connection does not exist, just ignore it
-	// This will hang forever if USB does not initialize
+	// All usb related functions will non-fatally fail if called
+	// If the USB initialization is delayed, then functionality will just be delayed
 	usb_init();
-	while ( !usb_configured() );
 	// Register USB Output CLI dictionary
 	CLI_registerDictionary( outputCLIDict, outputCLIDictName );
-	// Zero out USBKeys_Keys array
+	// Flush key buffers
-	for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
+	Output_flushBuffers();
-		USBKeys_Keys[ c ] = 0;
 }
 // USB Data Send
 inline void Output_send()
 	// Send keypresses while there are pending changes
 	while ( USBKeys_Changed )
 		usb_keyboard_send();
-	// Clear modifiers and keys
+	// Clear keys sent
-	USBKeys_Modifiers = 0;
+	USBKeys_Sent = 0;
-	USBKeys_Sent      = 0;
 	// Signal Scan Module we are finished
 	switch ( USBKeys_Protocol )
 	{
 	case 0: // Boot Mode
+		// Clear modifiers only in boot mode
+		USBKeys_Modifiers = 0;
 		Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
 		break;
 	case 1: // NKRO Mode
 		Scan_finishedWithOutput( USBKeys_Sent );
 		break;
 	}
 }
 // Sets the device into firmware reload mode
-inline void Output_firmwareReload()
+void Output_firmwareReload()
 {
-	uart_device_reload();
+	usb_device_reload();
 }
 // USB Input buffer available
 inline unsigned int Output_availablechar()
 	info_msg("Keyboard Protocol: ");
 	printInt8( USBKeys_Protocol );
 }
-void cliFunc_readLEDs( char* args )
+void cliFunc_outputDebug( char* args )
-{
-	print( NL );
-	info_msg("LED State: ");
-	printInt8( USBKeys_LEDs );
-}
-void cliFunc_readUART( char* args )
-{
-	print( NL );
-	// Read UART buffer until empty
-	while ( uart_serial_available() > 0 )
-	{
-		char out[] = { (char)uart_serial_getchar(), '\0' };
-		dPrint( out );
-	}
-}
-void cliFunc_sendKeys( char* args )
-{
-	// Copy USBKeys_KeysCLI to USBKeys_Keys
-	for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
-	{
-		// TODO
-		//USBKeys_Keys[key] = USBKeys_KeysCLI[key];
-	}
-	USBKeys_Sent = USBKeys_SentCLI;
-	// Set modifier byte
-	USBKeys_Modifiers = USBKeys_ModifiersCLI;
-}
-void cliFunc_sendUART( char* args )
-{
-	// Write all args to UART
-	uart_serial_write( args, lenStr( args ) );
-}
-void cliFunc_setKeys( char* args )
-{
-	char* curArgs;
-	char* arg1Ptr;
-	char* arg2Ptr = args;
-	// Parse up to USBKeys_MaxSize args (whichever is least)
-	for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
-	{
-		curArgs = arg2Ptr;
-		CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
-		// Stop processing args if no more are found
-		if ( *arg1Ptr == '\0' )
-			break;
-		// Add the USB code to be sent
-		// TODO
-		//USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
-	}
-}
-void cliFunc_setMod( char* args )
 {
 	// Parse number from argument
 	//  NOTE: Only first argument is used
 	char* arg1Ptr;
 	char* arg2Ptr;
 	CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+	// Default to 1 if no argument is given
+	Output_DebugMode = 1;
+	if ( arg1Ptr[0] != '\0' )
+	{
+		Output_DebugMode = (uint16_t)numToInt( arg1Ptr );
+	}
+}
+void cliFunc_readLEDs( char* args )
+{
+	print( NL );
+	info_msg("LED State: ");
+	printInt8( USBKeys_LEDs );
+}
+void cliFunc_readUART( char* args )
+{
+	print( NL );
+	// Read UART buffer until empty
+	while ( uart_serial_available() > 0 )
+	{
+		char out[] = { (char)uart_serial_getchar(), '\0' };
+		dPrint( out );
+	}
+}
+void cliFunc_sendKeys( char* args )
+{
+	// Copy USBKeys_KeysCLI to USBKeys_Keys
+	for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
+	{
+		// TODO
+		//USBKeys_Keys[key] = USBKeys_KeysCLI[key];
+	}
+	USBKeys_Sent = USBKeys_SentCLI;
+	// Set modifier byte
+	USBKeys_Modifiers = USBKeys_ModifiersCLI;
+}
+void cliFunc_sendUART( char* args )
+{
+	// Write all args to UART
+	uart_serial_write( args, lenStr( args ) );
+}
+void cliFunc_setKeys( char* args )
+{
+	char* curArgs;
+	char* arg1Ptr;
+	char* arg2Ptr = args;
+	// Parse up to USBKeys_MaxSize args (whichever is least)
+	for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
+	{
+		curArgs = arg2Ptr;
+		CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+		// Stop processing args if no more are found
+		if ( *arg1Ptr == '\0' )
+			break;
+		// Add the USB code to be sent
+		// TODO
+		//USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
+	}
+}
+void cliFunc_setMod( char* args )
+{
+	// Parse number from argument
+	//  NOTE: Only first argument is used
+	char* arg1Ptr;
+	char* arg2Ptr;
+	CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 	USBKeys_ModifiersCLI = numToInt( arg1Ptr );
 }

Mercurial > louis > kiibohd-controller

comparison Output/usbMuxUart/output_com.c @ 347:136e47478441