2 # KLL Compiler - Kiibohd Backend
4 # Backend code generator for the Kiibohd Controller firmware.
6 # Copyright (C) 2014-2015 by Jacob Alexander
8 # This file is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This file is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this file. If not, see <http://www.gnu.org/licenses/>.
27 from datetime import date
29 # Modifying Python Path, which is dumb, but the only way to import up one directory...
30 sys.path.append( os.path.expanduser('..') )
32 from kll_lib.backends import *
33 from kll_lib.containers import *
34 from kll_lib.hid_dict import *
39 class Backend( BackendBase ):
40 # Default templates and output files
41 templatePaths = ["templates/kiibohdKeymap.h", "templates/kiibohdDefs.h"]
42 outputPaths = ["generatedKeymap.h", "kll_defs.h"]
44 requiredCapabilities = {
45 'CONS' : 'consCtrlOut',
52 def capabilityLookup( self, type ):
53 return self.requiredCapabilities[ type ];
57 def layerInformation( self, name, date, author ):
58 self.fill_dict['Information'] += "// Name: {0}\n".format( "TODO" )
59 self.fill_dict['Information'] += "// Version: {0}\n".format( "TODO" )
60 self.fill_dict['Information'] += "// Date: {0}\n".format( "TODO" )
61 self.fill_dict['Information'] += "// Author: {0}\n".format( "TODO" )
64 # Processes content for fill tags and does any needed dataset calculations
65 def process( self, capabilities, macros, variables, gitRev, gitChanges ):
66 # Build string list of compiler arguments
69 if "--" in arg or ".py" in arg:
70 compilerArgs += "// {0}\n".format( arg )
72 compilerArgs += "// {0}\n".format( arg )
74 # Build a string of modified files, if any
76 if len( gitChanges ) > 0:
77 for gitFile in gitChanges:
78 gitChangesStr += "// {0}\n".format( gitFile )
80 gitChangesStr = " None\n"
82 # Prepare BaseLayout and Layer Info
85 partialLayersInfo = ""
86 for file, name in zip( variables.baseLayout['*LayerFiles'], variables.baseLayout['*NameStack'] ):
87 baseLayoutInfo += "// {0}\n// {1}\n".format( name, file )
88 if '*LayerFiles' in variables.layerVariables[0].keys():
89 for file, name in zip( variables.layerVariables[0]['*LayerFiles'], variables.layerVariables[0]['*NameStack'] ):
90 defaultLayerInfo += "// {0}\n// {1}\n".format( name, file )
91 if '*LayerFiles' in variables.layerVariables[1].keys():
92 for layer in range( 1, len( variables.layerVariables ) ):
93 partialLayersInfo += "// Layer {0}\n".format( layer )
94 if len( variables.layerVariables[ layer ]['*LayerFiles'] ) > 0:
95 for file, name in zip( variables.layerVariables[ layer ]['*LayerFiles'], variables.layerVariables[ layer ]['*NameStack'] ):
96 partialLayersInfo += "// {0}\n// {1}\n".format( name, file )
100 self.fill_dict['Information'] = "// This file was generated by the kll compiler, DO NOT EDIT.\n"
101 self.fill_dict['Information'] += "// Generation Date: {0}\n".format( date.today() )
102 self.fill_dict['Information'] += "// KLL Backend: {0}\n".format( "kiibohd" )
103 self.fill_dict['Information'] += "// KLL Git Rev: {0}\n".format( gitRev )
104 self.fill_dict['Information'] += "// KLL Git Changes:{0}".format( gitChangesStr )
105 self.fill_dict['Information'] += "// Compiler arguments:\n{0}".format( compilerArgs )
106 self.fill_dict['Information'] += "//\n"
107 self.fill_dict['Information'] += "// - Base Layer -\n{0}".format( baseLayoutInfo )
108 self.fill_dict['Information'] += "// - Default Layer -\n{0}".format( defaultLayerInfo )
109 self.fill_dict['Information'] += "// - Partial Layers -\n{0}".format( partialLayersInfo )
112 ## Variable Information ##
113 self.fill_dict['VariableInformation'] = ""
115 # Iterate through the variables, output, and indicate the last file that modified it's value
116 # Output separate tables per file, per table and overall
121 self.fill_dict['Defines'] = ""
124 # Iterate through defines and lookup the variables
125 for define in variables.defines.keys():
126 if define in variables.overallVariables.keys():
127 self.fill_dict['Defines'] += "\n#define {0} {1}".format( variables.defines[ define ], variables.overallVariables[ define ].replace( '\n', ' \\\n' ) )
128 if define == "stateWordSize":
129 stateWordSize = variables.overallVariables[ define ]
131 print( "{0} '{1}' not defined...".format( WARNING, define ) )
135 self.fill_dict['CapabilitiesFuncDecl'] = ""
136 self.fill_dict['CapabilitiesList'] = "const Capability CapabilitiesList[] = {\n"
137 self.fill_dict['CapabilitiesIndices'] = "typedef enum CapabilityIndex {\n"
139 # Keys are pre-sorted
140 for key in capabilities.keys():
141 funcName = capabilities.funcName( key )
142 argByteWidth = capabilities.totalArgBytes( key )
143 self.fill_dict['CapabilitiesList'] += "\t{{ {0}, {1} }},\n".format( funcName, argByteWidth )
144 self.fill_dict['CapabilitiesFuncDecl'] += "void {0}( uint8_t state, uint8_t stateType, uint8_t *args );\n".format( funcName )
145 self.fill_dict['CapabilitiesIndices'] += "\t{0}_index,\n".format( funcName )
147 self.fill_dict['CapabilitiesList'] += "};"
148 self.fill_dict['CapabilitiesIndices'] += "} CapabilityIndex;"
152 self.fill_dict['ResultMacros'] = ""
154 # Iterate through each of the result macros
155 for result in range( 0, len( macros.resultsIndexSorted ) ):
156 self.fill_dict['ResultMacros'] += "Guide_RM( {0} ) = {{ ".format( result )
158 # Add the result macro capability index guide (including capability arguments)
159 # See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
160 for sequence in range( 0, len( macros.resultsIndexSorted[ result ] ) ):
161 # If the sequence is longer than 1, prepend a sequence spacer
162 # Needed for USB behaviour, otherwise, repeated keys will not work
164 # <single element>, <usbCodeSend capability>, <USB Code 0x00>
165 self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.capabilityLookup('USB') ) )
167 # For each combo in the sequence, add the length of the combo
168 self.fill_dict['ResultMacros'] += "{0}, ".format( len( macros.resultsIndexSorted[ result ][ sequence ] ) )
170 # For each combo, add each of the capabilities used and their arguments
171 for combo in range( 0, len( macros.resultsIndexSorted[ result ][ sequence ] ) ):
172 resultItem = macros.resultsIndexSorted[ result ][ sequence ][ combo ]
174 # Add the capability index
175 self.fill_dict['ResultMacros'] += "{0}, ".format( capabilities.getIndex( resultItem[0] ) )
177 # Add each of the arguments of the capability
178 for arg in range( 0, len( resultItem[1] ) ):
180 if isinstance( resultItem[1][ arg ], str ):
181 # If this is a CONSUMER_ element, needs to be split into 2 elements
182 # AC_ and AL_ are other sections of consumer control
183 if re.match( '^(CONSUMER|AC|AL)_', resultItem[1][ arg ] ):
184 tag = resultItem[1][ arg ].split( '_', 1 )[1]
186 tag = tag.replace( '_', '' )
188 lookupNum = kll_hid_lookup_dictionary['ConsCode'][ tag ][1]
189 except KeyError as err:
190 print ( "{0} {1} Consumer HID kll bug...please report.".format( ERROR, err ) )
192 byteForm = lookupNum.to_bytes( 2, byteorder='little' ) # XXX Yes, little endian from how the uC structs work
193 self.fill_dict['ResultMacros'] += "{0}, {1}, ".format( *byteForm )
196 # None, fall-through disable
197 elif resultItem[0] is self.capabilityLookup('NONE'):
200 self.fill_dict['ResultMacros'] += "{0}, ".format( resultItem[1][ arg ] )
202 # If sequence is longer than 1, append a sequence spacer at the end of the sequence
203 # Required by USB to end at sequence without holding the key down
204 if len( macros.resultsIndexSorted[ result ] ) > 1:
205 # <single element>, <usbCodeSend capability>, <USB Code 0x00>
206 self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.capabilityLookup('USB') ) )
208 # Add list ending 0 and end of list
209 self.fill_dict['ResultMacros'] += "0 };\n"
210 self.fill_dict['ResultMacros'] = self.fill_dict['ResultMacros'][:-1] # Remove last newline
213 ## Result Macro List ##
214 self.fill_dict['ResultMacroList'] = "const ResultMacro ResultMacroList[] = {\n"
216 # Iterate through each of the result macros
217 for result in range( 0, len( macros.resultsIndexSorted ) ):
218 self.fill_dict['ResultMacroList'] += "\tDefine_RM( {0} ),\n".format( result )
219 self.fill_dict['ResultMacroList'] += "};"
221 results_count = len( macros.resultsIndexSorted );
222 print( "Results count: ", results_count )
225 ## Result Macro Record ##
226 self.fill_dict['ResultMacroRecord'] = "ResultMacroRecord ResultMacroRecordList[ ResultMacroNum ];"
230 self.fill_dict['TriggerMacros'] = ""
232 # Iterate through each of the trigger macros
234 for trigger in range( 0, len( macros.triggersIndexSorted ) ):
235 self.fill_dict['TriggerMacros'] += "Guide_TM( {0} ) = {{ ".format( trigger )
237 # Add the trigger macro scan code guide
238 # See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
239 for sequence in range( 0, len( macros.triggersIndexSorted[ trigger ][0] ) ):
240 # For each combo in the sequence, add the length of the combo
241 self.fill_dict['TriggerMacros'] += "{0}, ".format( len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) )
243 # For each combo, add the key type, key state and scan code
244 for combo in range( 0, len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) ):
245 triggerItemId = macros.triggersIndexSorted[ trigger ][0][ sequence ][ combo ]
247 # Lookup triggerItem in ScanCodeStore
248 triggerItemObj = macros.scanCodeStore[ triggerItemId ]
249 triggerItem = triggerItemObj.offset( macros.interconnectOffset )
251 # TODO Add support for Analog keys
252 # TODO Add support for LED states
253 self.fill_dict['TriggerMacros'] += "0x00, 0x01, 0x{0:02X}, ".format( triggerItem )
256 # Add list ending 0 and end of list
257 self.fill_dict['TriggerMacros'] += "0 };\n"
258 self.fill_dict['TriggerMacros'] = self.fill_dict['TriggerMacros'][ :-1 ] # Remove last newline
260 print( "Triggers count:", triggers_count )
262 # check for too small stateWordSize
263 if stateWordSize == "8" and (triggers_count > 255 or results_count > 255):
264 print ("{0} Over 255 trigger or result macros, changing stateWordSize to 16.".format( WARNING ) )
265 stateWordSize == "16"
266 self.fill_dict['Defines'] = self.fill_dict['Defines'].replace("StateWordSize_define 8", "StateWordSize_define 16")
267 #print (self.fill_dict['Defines'])
269 ## Trigger Macro List ##
270 self.fill_dict['TriggerMacroList'] = "const TriggerMacro TriggerMacroList[] = {\n"
272 # Iterate through each of the trigger macros
273 for trigger in range( 0, len( macros.triggersIndexSorted ) ):
274 # Use TriggerMacro Index, and the corresponding ResultMacro Index
275 self.fill_dict['TriggerMacroList'] += "\tDefine_TM( {0}, {1} ),\n".format( trigger, macros.triggersIndexSorted[ trigger ][1] )
276 self.fill_dict['TriggerMacroList'] += "};"
279 ## Trigger Macro Record ##
280 self.fill_dict['TriggerMacroRecord'] = "TriggerMacroRecord TriggerMacroRecordList[ TriggerMacroNum ];"
284 self.fill_dict['MaxScanCode'] = "#define MaxScanCode 0x{0:X}".format( macros.overallMaxScanCode )
287 ## Interconnect ScanCode Offset List ##
288 self.fill_dict['ScanCodeInterconnectOffsetList'] = "const uint8_t InterconnectOffsetList[] = {\n"
289 for offset in range( 0, len( macros.interconnectOffset ) ):
290 self.fill_dict['ScanCodeInterconnectOffsetList'] += "\t0x{0:02X},\n".format( macros.interconnectOffset[ offset ] )
291 self.fill_dict['ScanCodeInterconnectOffsetList'] += "};"
294 ## Max Interconnect Nodes ##
295 self.fill_dict['InterconnectNodeMax'] = "#define InterconnectNodeMax 0x{0:X}\n".format( len( macros.interconnectOffset ) )
298 ## Default Layer and Default Layer Scan Map ##
299 self.fill_dict['DefaultLayerTriggerList'] = ""
300 self.fill_dict['DefaultLayerScanMap'] = "const nat_ptr_t *default_scanMap[] = {\n"
302 # Iterate over triggerList and generate a C trigger array for the default map and default map array
303 for triggerList in range( macros.firstScanCode[0], len( macros.triggerList[0] ) ):
304 # Generate ScanCode index and triggerList length
305 self.fill_dict['DefaultLayerTriggerList'] += "Define_TL( default, 0x{0:02X} ) = {{ {1}".format( triggerList, len( macros.triggerList[0][ triggerList ] ) )
307 # Add scanCode trigger list to Default Layer Scan Map
308 self.fill_dict['DefaultLayerScanMap'] += "default_tl_0x{0:02X}, ".format( triggerList )
310 # Add each item of the trigger list
311 for triggerItem in macros.triggerList[0][ triggerList ]:
312 self.fill_dict['DefaultLayerTriggerList'] += ", {0}".format( triggerItem )
314 self.fill_dict['DefaultLayerTriggerList'] += " };\n"
315 self.fill_dict['DefaultLayerTriggerList'] = self.fill_dict['DefaultLayerTriggerList'][:-1] # Remove last newline
316 self.fill_dict['DefaultLayerScanMap'] = self.fill_dict['DefaultLayerScanMap'][:-2] # Remove last comma and space
317 self.fill_dict['DefaultLayerScanMap'] += "\n};"
320 ## Partial Layers and Partial Layer Scan Maps ##
321 self.fill_dict['PartialLayerTriggerLists'] = ""
322 self.fill_dict['PartialLayerScanMaps'] = ""
324 # Iterate over each of the layers, excluding the default layer
325 for layer in range( 1, len( macros.triggerList ) ):
327 self.fill_dict['PartialLayerScanMaps'] += "// Partial Layer {0}\n".format( layer )
328 self.fill_dict['PartialLayerScanMaps'] += "const nat_ptr_t *layer{0}_scanMap[] = {{\n".format( layer )
329 self.fill_dict['PartialLayerTriggerLists'] += "// Partial Layer {0}\n".format( layer )
331 # Iterate over triggerList and generate a C trigger array for the layer
332 for triggerList in range( macros.firstScanCode[ layer ], len( macros.triggerList[ layer ] ) ):
333 # Generate ScanCode index and triggerList length
334 self.fill_dict['PartialLayerTriggerLists'] += "Define_TL( layer{0}, 0x{1:02X} ) = {{ {2}".format( layer, triggerList, len( macros.triggerList[ layer ][ triggerList ] ) )
336 # Add scanCode trigger list to Default Layer Scan Map
337 self.fill_dict['PartialLayerScanMaps'] += "layer{0}_tl_0x{1:02X}, ".format( layer, triggerList )
339 # Add each item of the trigger list
340 for trigger in macros.triggerList[ layer ][ triggerList ]:
341 self.fill_dict['PartialLayerTriggerLists'] += ", {0}".format( trigger )
343 self.fill_dict['PartialLayerTriggerLists'] += " };\n"
344 self.fill_dict['PartialLayerTriggerLists'] += "\n"
345 self.fill_dict['PartialLayerScanMaps'] = self.fill_dict['PartialLayerScanMaps'][:-2] # Remove last comma and space
346 self.fill_dict['PartialLayerScanMaps'] += "\n};\n\n"
347 self.fill_dict['PartialLayerTriggerLists'] = self.fill_dict['PartialLayerTriggerLists'][:-2] # Remove last 2 newlines
348 self.fill_dict['PartialLayerScanMaps'] = self.fill_dict['PartialLayerScanMaps'][:-2] # Remove last 2 newlines
351 ## Layer Index List ##
352 self.fill_dict['LayerIndexList'] = "const Layer LayerIndex[] = {\n"
354 # Iterate over each layer, adding it to the list
355 for layer in range( 0, len( macros.triggerList ) ):
356 # Lookup first scancode in map
357 firstScanCode = macros.firstScanCode[ layer ]
359 # Generate stacked name
361 if '*NameStack' in variables.layerVariables[ layer ].keys():
362 for name in range( 0, len( variables.layerVariables[ layer ]['*NameStack'] ) ):
363 stackName += "{0} + ".format( variables.layerVariables[ layer ]['*NameStack'][ name ] )
364 stackName = stackName[:-3]
366 # Default map is a special case, always the first index
368 self.fill_dict['LayerIndexList'] += '\tLayer_IN( default_scanMap, "D: {1}", 0x{0:02X} ),\n'.format( firstScanCode, stackName )
370 self.fill_dict['LayerIndexList'] += '\tLayer_IN( layer{0}_scanMap, "{0}: {2}", 0x{1:02X} ),\n'.format( layer, firstScanCode, stackName )
371 self.fill_dict['LayerIndexList'] += "};"
375 self.fill_dict['LayerState'] = "uint8_t LayerState[ LayerNum ];"