Adds basic macro unit testing support

See Scan/TestIn/test.py for basic usage

- Works in NKRO and 6KRO modes
- Added convenience Python datastructures to help with comparisons
- Added exit command for cli so it's possible to drop to the virtual cli during a test (and pause)
- Added more callback pointer refresh functions (not sure why needed, but prevents segfaults)
- Added initial code to control the timer systicks (will be used for timed macro evaluation)

Author: haata

Debug/cli/cli.c

@@ -33,8 +33,11 @@
 // ----- Variables -----
 
 // Basic command dictionary
-CLIDict_Entry( clear, "Clear the screen.");
+CLIDict_Entry( clear,    "Clear the screen.");
 CLIDict_Entry( cliDebug, "Enables/Disables hex output of the most recent cli input." );
+#if defined(_host_)
+CLIDict_Entry( exit,     "Host KLL Only - Exits cli." );
+#endif
 CLIDict_Entry( help,     "You're looking at it :P" );
 CLIDict_Entry( led,      "Enables/Disables indicator LED. Try a couple times just in case the LED is in an odd state.\r\n\t\t\033[33mWarning\033[0m: May adversely affect some modules..." );
 CLIDict_Entry( reload,   "Signals microcontroller to reflash/reload." );
@@ -46,6 +49,9 @@ CLIDict_Entry( version,  "Version information about this firmware." );
 CLIDict_Def( basicCLIDict, "General Commands" ) = {
 	CLIDict_Item( clear ),
 	CLIDict_Item( cliDebug ),
+#if defined(_host_)
+	CLIDict_Item( exit ),
+#endif
 	CLIDict_Item( help ),
 	CLIDict_Item( led ),
 	CLIDict_Item( reload ),
@@ -56,6 +62,10 @@ CLIDict_Def( basicCLIDict, "General Commands" ) = {
 	{ 0, 0, 0 } // Null entry for dictionary end
 };
 
+#if defined(_host_)
+int CLI_exit = 0; // When 1, cli signals library to exit (Host-side KLL only)
+#endif
+
 
 
 // ----- Functions -----
@@ -90,10 +100,15 @@ inline void CLI_init()
 
 	// Hex debug mode is off by default
 	CLIHexDebugMode = 0;
+
+#if defined(_host_)
+	// Make sure we're not exiting right away in Host-side KLL mode
+	CLI_exit = 0;
+#endif
 }
 
 // Query the serial input buffer for any new characters
-void CLI_process()
+int CLI_process()
 {
 	// Current buffer position
 	uint8_t prev_buf_pos = CLILineBufferCurrent;
@@ -120,7 +135,7 @@ void CLI_process()
 			// Reset the prompt
 			prompt();
 
-			return;
+			return 0;
 		}
 
 		// Place into line buffer
@@ -189,9 +204,18 @@ void CLI_process()
 			print( NL );
 			prompt();
 
+			// Check if we need to exit right away
+#if defined(_host_)
+			if ( CLI_exit )
+			{
+				CLI_exit = 0;
+				return 1;
+			}
+#endif
+
 			// XXX There is a potential bug here when resetting the buffer (losing valid keypresses)
 			//     Doesn't look like it will happen *that* often, so not handling it for now -HaaTa
-			return;
+			return 0;
 
 		case 0x09: // Tab
 			// Tab completion for the current command
@@ -201,7 +225,7 @@ void CLI_process()
 
 			// XXX There is a potential bug here when resetting the buffer (losing valid keypresses)
 			//     Doesn't look like it will happen *that* often, so not handling it for now -HaaTa
-			return;
+			return 0;
 
 		case 0x1B: // Esc / Escape codes
 			// Check for other escape sequence
@@ -235,7 +259,7 @@ void CLI_process()
 					CLI_retreiveHistory( CLIHistoryCurrent );
 				}
 			}
-			return;
+			return 0;
 
 		case 0x08:
 		case 0x7F: // Backspace
@@ -267,6 +291,8 @@ void CLI_process()
 			break;
 		}
 	}
+
+	return 0;
 }
 
 // Takes a string, returns two pointers
@@ -484,6 +510,13 @@ void cliFunc_cliDebug( char* args )
 	}
 }
 
+#if defined(_host_)
+void cliFunc_exit( char* args )
+{
+	CLI_exit = 1;
+}
+#endif
+
 void cliFunc_help( char* args )
 {
 	// Scan array of dictionaries and print every description
@@ -549,6 +582,9 @@ void cliFunc_tick( char* args )
 #if defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
 	extern volatile uint32_t systick_millis_count;
 	uint32_t ms_count = systick_millis_count;
+#elif defined(_host_)
+	extern volatile uint32_t systick_millis_count;
+	uint32_t ms_count = systick_millis_count;
 #else
 	// TODO
 	uint32_t ms_count = 0;
@@ -560,6 +596,8 @@ void cliFunc_tick( char* args )
 	print("13.889 ns");
 #elif F_CPU == 48000000
 	print("20.833 ns");
+#elif defined(_host_)
+	print("<USERDEFINED>");
 #else
 	print("<UNSET>");
 #endif
@@ -569,6 +607,9 @@ void cliFunc_tick( char* args )
 	print(":");
 #if defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
 	printInt32( ARM_DWT_CYCCNT );
+#elif defined(_host_)
+	extern volatile uint32_t ns_since_systick_count;
+	printInt32( ns_since_systick_count );
 #endif
 	print( NL );
 }

Debug/cli/cli.h

@@ -107,7 +107,7 @@ uint8_t CLIHexDebugMode;
 // ----- Functions and Corresponding Function Aliases -----
 
 void CLI_init();
-void CLI_process();
+int CLI_process();
 void CLI_registerDictionary( const CLIDictItem *cmdDict, const char* dictName );
 void CLI_argumentIsolation( char* string, char** first, char** second );
 
@@ -118,11 +118,9 @@ void CLI_saveHistory( char *buff );
 void CLI_retreiveHistory( int index );
 
 // CLI Command Functions
-void cliFunc_arch    ( char* args );
-void cliFunc_chip    ( char* args );
 void cliFunc_clear   ( char* args );
 void cliFunc_cliDebug( char* args );
-void cliFunc_device  ( char* args );
+void cliFunc_exit    ( char* args );
 void cliFunc_help    ( char* args );
 void cliFunc_led     ( char* args );
 void cliFunc_reload  ( char* args );

Lib/CMake/host.cmake

@@ -77,12 +77,12 @@ set( WARN "-Wall -ggdb3" )
 #| Clang Compiler
 if ( "${COMPILER}" MATCHES "clang" )
 	# TODO
-	set ( TUNING "-nostdlib -fdata-sections -ffunction-sections -fshort-wchar -fno-builtin" )
+	set ( TUNING "-nostdlib -fshort-enums -fdata-sections -ffunction-sections -fshort-wchar -fno-builtin" )
 
 #| GCC Compiler
 else()
 	# TODO
-	set( TUNING "-nostdlib -fdata-sections -ffunction-sections -fshort-wchar -fno-builtin -nostartfiles" )
+	set( TUNING "-nostdlib -fshort-enums -fdata-sections -ffunction-sections -fshort-wchar -fno-builtin -nostartfiles" )
 endif()
 
 

Lib/host.py

@@ -31,8 +31,6 @@
 
 from ctypes import CFUNCTYPE, c_int, c_char_p
 
-import serial
-
 
 
 ### Decorators ###
@@ -64,6 +62,21 @@ def textFormatter_gettext( s ):
 
 ### Classes ###
 
+class Data:
+	'''
+	Generic class used to hold data retrieved from libkiibohd callbacks
+	'''
+	def __init__( self ):
+		self.usb_keyboard_data = None
+
+	def usb_keyboard( self ):
+		'''
+		Returns a tuple of USB Keyboard output
+		'''
+		if self.usb_keyboard_data is not None:
+			return self.usb_keyboard_data.protocol, self.usb_keyboard_data.codes(), self.usb_keyboard_data.consumer_ctrl, self.usb_keyboard_data.system_ctrl
+		return None
+
 class Control:
 	'''
 	Handles general control of the libkiibohd host setup
@@ -100,6 +113,12 @@ def __init__( self, scan_module, output_module, libkiibohd_path ):
 		output = importlib.util.module_from_spec( spec )
 		spec.loader.exec_module( output )
 
+		# Container for any libkiibohd callback data storage
+		global data
+		self.data = Data()
+		scan.data = self.data
+		output.data = self.data
+
 		# Build command and callback dictionaries
 		self.build_command_list()
 		self.build_callback_list()
@@ -116,6 +135,7 @@ def __init__( self, scan_module, output_module, libkiibohd_path ):
 			print( "{0} Could not open -> {1}".format( ERROR, libkiibohd_path ) )
 			print( err )
 			sys.exit( 1 )
+		self.kiibohd = kiibohd
 
 		# Register Callback
 		self.callback_setup()
@@ -146,7 +166,7 @@ def callback_setup( self ):
 		'''
 		self.CTYPE_callback = CFUNCTYPE( c_int, c_char_p, c_char_p )
 		try:
-			self.CTYPE_callback_ref = kiibohd.Host_register_callback( self.CTYPE_callback( callback ) )
+			refresh_callback()
 		except Exception as err:
 			print( "{0} Could not register libkiibohd callback function".format( ERROR ) )
 			print( err )
@@ -199,7 +219,7 @@ def process_args( self ):
 		# Run test if requested, then exit
 		if args.test:
 			print("libkiibohd.so - Callback Test")
-			val = kiibohd.Host_callback_test()
+			val = self.kiibohd.Host_callback_test()
 			print("Return Value:", val )
 			sys.exit( 0 )
 
@@ -210,8 +230,54 @@ def process( self ):
 		Run main commands
 		'''
 		# Initialize kiibohd
-		kiibohd.Host_init()
+		print(">Host_init")
+		self.kiibohd.Host_init()
+		print("")
+
+		# Run cli if enabled
+		self.virtual_serialport_process()
+
+	def loop( self, number_of_loops=1 ):
+		'''
+		Run Host-side KLL main processing loop N number of times
+
+		@param number_of_loops: Number of times to run main loop
+		'''
+		loop = 0
+		while loop < number_of_loops:
+			# Refresh callback interface
+			refresh_callback()
+
+			print( ">Host_process ({0})".format( loop ) )
+			self.kiibohd.Host_process()
+			loop += 1
+
+	def cmd( self, command_name ):
+		'''
+		Run given command from Host-side KLL
 
+		Does a lookup of both Scan and Output module commands
+
+		@param command_name: String of command
+		@return: Function
+		'''
+		# Refresh callback interface
+		refresh_callback()
+
+		return self.command_dict[ command_name ]
+
+	def cli( self ):
+		'''
+		Setup and process cli commands
+		Convenience function for test cases
+		'''
+		self.virtual_serialport_setup()
+		self.virtual_serialport_process()
+
+	def virtual_serialport_process( self ):
+		'''
+		Process virtual serial port commands
+		'''
 		# Run cli loop if available
 		while self.serial is not None:
 			value = os.read( self.serial_master, 1 ).decode('utf-8')
@@ -223,7 +289,14 @@ def process( self ):
 				sys.stdout.flush()
 
 			# Check if any cli commands need to be processed
-			kiibohd.Host_cli_process()
+			ret = self.kiibohd.Host_cli_process()
+
+			# If non-zero return, break out of processing loop
+			if ret != 0:
+				# Cleanup virtual serialport
+				os.close( self.serial_master )
+				os.close( self.serial_slave )
+				break
 
 	def virtual_serialport_setup( self ):
 		'''
@@ -256,6 +329,17 @@ def get_method_dict( obj ):
 	return output
 
 
+def refresh_callback():
+	'''
+	XXX
+	Refresh callback pointer
+	For some reason, either garbage collection, or something else, the pointer becomes stale in certain situations
+	Usually when calling different library functions
+	This just refreshes the pointer (shouldn't be necessary, but it works...) -Jacob
+	'''
+	control.CTYPE_callback_ref = kiibohd.Host_register_callback( control.CTYPE_callback( callback ) )
+
+
 def callback( command, args ):
 	'''
 	libkiibohd callback function
@@ -268,12 +352,8 @@ def callback( command, args ):
 	# Must convert byte string to utf-8 first
 	ret = control.callback_dict[ command.decode('utf-8') ]( args.decode('utf-8') )
 
-	# XXX
-	# Refresh callback pointer
-	# For some reason, either garbage collection, or something else, the pointer becomes stale in certain situations
-	# Usually when calling different library functions
-	# This just refreshes the pointer (shouldn't be necessary, but it works...) -Jacob
-	control.CTYPE_callback_ref = kiibohd.Host_register_callback( control.CTYPE_callback( callback ) )
+	# Refresh callback interface
+	refresh_callback()
 
 	# If returning None (default), change out to 1, C default
 	return ret is None and 1 or ret