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'] = ""
123 # Iterate through defines and lookup the variables
124 for define in variables.defines.keys():
125 if define in variables.overallVariables.keys():
126 self.fill_dict['Defines'] += "\n#define {0} {1}".format( variables.defines[ define ], variables.overallVariables[ define ].replace( '\n', ' \\\n' ) )
128 print( "{0} '{1}' not defined...".format( WARNING, define ) )
132 self.fill_dict['CapabilitiesFuncDecl'] = ""
133 self.fill_dict['CapabilitiesList'] = "const Capability CapabilitiesList[] = {\n"
134 self.fill_dict['CapabilitiesIndices'] = "typedef enum CapabilityIndex {\n"
136 # Keys are pre-sorted
137 for key in capabilities.keys():
138 funcName = capabilities.funcName( key )
139 argByteWidth = capabilities.totalArgBytes( key )
140 self.fill_dict['CapabilitiesList'] += "\t{{ {0}, {1} }},\n".format( funcName, argByteWidth )
141 self.fill_dict['CapabilitiesFuncDecl'] += "void {0}( uint8_t state, uint8_t stateType, uint8_t *args );\n".format( funcName )
142 self.fill_dict['CapabilitiesIndices'] += "\t{0}_index,\n".format( funcName )
144 self.fill_dict['CapabilitiesList'] += "};"
145 self.fill_dict['CapabilitiesIndices'] += "} CapabilityIndex;"
149 self.fill_dict['ResultMacros'] = ""
151 # Iterate through each of the result macros
152 for result in range( 0, len( macros.resultsIndexSorted ) ):
153 self.fill_dict['ResultMacros'] += "Guide_RM( {0} ) = {{ ".format( result )
155 # Add the result macro capability index guide (including capability arguments)
156 # See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
157 for sequence in range( 0, len( macros.resultsIndexSorted[ result ] ) ):
158 # If the sequence is longer than 1, prepend a sequence spacer
159 # Needed for USB behaviour, otherwise, repeated keys will not work
161 # <single element>, <usbCodeSend capability>, <USB Code 0x00>
162 self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.capabilityLookup('USB') ) )
164 # For each combo in the sequence, add the length of the combo
165 self.fill_dict['ResultMacros'] += "{0}, ".format( len( macros.resultsIndexSorted[ result ][ sequence ] ) )
167 # For each combo, add each of the capabilities used and their arguments
168 for combo in range( 0, len( macros.resultsIndexSorted[ result ][ sequence ] ) ):
169 resultItem = macros.resultsIndexSorted[ result ][ sequence ][ combo ]
171 # Add the capability index
172 self.fill_dict['ResultMacros'] += "{0}, ".format( capabilities.getIndex( resultItem[0] ) )
174 # Add each of the arguments of the capability
175 for arg in range( 0, len( resultItem[1] ) ):
177 if isinstance( resultItem[1][ arg ], str ):
178 # If this is a CONSUMER_ element, needs to be split into 2 elements
179 # AC_ and AL_ are other sections of consumer control
180 if re.match( '^(CONSUMER|AC|AL)_', resultItem[1][ arg ] ):
181 tag = resultItem[1][ arg ].split( '_', 1 )[1]
183 tag = tag.replace( '_', '' )
184 lookupNum = kll_hid_lookup_dictionary['ConsCode'][ tag ][1]
185 byteForm = lookupNum.to_bytes( 2, byteorder='little' ) # XXX Yes, little endian from how the uC structs work
186 self.fill_dict['ResultMacros'] += "{0}, {1}, ".format( *byteForm )
189 # None, fall-through disable
190 elif resultItem[0] is self.capabilityLookup('NONE'):
193 self.fill_dict['ResultMacros'] += "{0}, ".format( resultItem[1][ arg ] )
195 # If sequence is longer than 1, append a sequence spacer at the end of the sequence
196 # Required by USB to end at sequence without holding the key down
197 if len( macros.resultsIndexSorted[ result ] ) > 1:
198 # <single element>, <usbCodeSend capability>, <USB Code 0x00>
199 self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.capabilityLookup('USB') ) )
201 # Add list ending 0 and end of list
202 self.fill_dict['ResultMacros'] += "0 };\n"
203 self.fill_dict['ResultMacros'] = self.fill_dict['ResultMacros'][:-1] # Remove last newline
206 ## Result Macro List ##
207 self.fill_dict['ResultMacroList'] = "const ResultMacro ResultMacroList[] = {\n"
209 # Iterate through each of the result macros
210 for result in range( 0, len( macros.resultsIndexSorted ) ):
211 self.fill_dict['ResultMacroList'] += "\tDefine_RM( {0} ),\n".format( result )
212 self.fill_dict['ResultMacroList'] += "};"
215 ## Result Macro Record ##
216 self.fill_dict['ResultMacroRecord'] = "ResultMacroRecord ResultMacroRecordList[ ResultMacroNum ];"
220 self.fill_dict['TriggerMacros'] = ""
222 # Iterate through each of the trigger macros
223 for trigger in range( 0, len( macros.triggersIndexSorted ) ):
224 self.fill_dict['TriggerMacros'] += "Guide_TM( {0} ) = {{ ".format( trigger )
226 # Add the trigger macro scan code guide
227 # See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
228 for sequence in range( 0, len( macros.triggersIndexSorted[ trigger ][0] ) ):
229 # For each combo in the sequence, add the length of the combo
230 self.fill_dict['TriggerMacros'] += "{0}, ".format( len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) )
232 # For each combo, add the key type, key state and scan code
233 for combo in range( 0, len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) ):
234 triggerItemId = macros.triggersIndexSorted[ trigger ][0][ sequence ][ combo ]
236 # Lookup triggerItem in ScanCodeStore
237 triggerItemObj = macros.scanCodeStore[ triggerItemId ]
238 triggerItem = triggerItemObj.offset( macros.interconnectOffset )
240 # TODO Add support for Analog keys
241 # TODO Add support for LED states
242 self.fill_dict['TriggerMacros'] += "0x00, 0x01, 0x{0:02X}, ".format( triggerItem )
244 # Add list ending 0 and end of list
245 self.fill_dict['TriggerMacros'] += "0 };\n"
246 self.fill_dict['TriggerMacros'] = self.fill_dict['TriggerMacros'][ :-1 ] # Remove last newline
249 ## Trigger Macro List ##
250 self.fill_dict['TriggerMacroList'] = "const TriggerMacro TriggerMacroList[] = {\n"
252 # Iterate through each of the trigger macros
253 for trigger in range( 0, len( macros.triggersIndexSorted ) ):
254 # Use TriggerMacro Index, and the corresponding ResultMacro Index
255 self.fill_dict['TriggerMacroList'] += "\tDefine_TM( {0}, {1} ),\n".format( trigger, macros.triggersIndexSorted[ trigger ][1] )
256 self.fill_dict['TriggerMacroList'] += "};"
259 ## Trigger Macro Record ##
260 self.fill_dict['TriggerMacroRecord'] = "TriggerMacroRecord TriggerMacroRecordList[ TriggerMacroNum ];"
264 self.fill_dict['MaxScanCode'] = "#define MaxScanCode 0x{0:X}".format( macros.overallMaxScanCode )
267 ## Interconnect ScanCode Offset List ##
268 self.fill_dict['ScanCodeInterconnectOffsetList'] = "const uint8_t InterconnectOffsetList[] = {\n"
269 for offset in range( 0, len( macros.interconnectOffset ) ):
270 self.fill_dict['ScanCodeInterconnectOffsetList'] += "\t0x{0:02X},\n".format( macros.interconnectOffset[ offset ] )
271 self.fill_dict['ScanCodeInterconnectOffsetList'] += "};"
274 ## Max Interconnect Nodes ##
275 self.fill_dict['InterconnectNodeMax'] = "#define InterconnectNodeMax 0x{0:X}\n".format( len( macros.interconnectOffset ) )
278 ## Default Layer and Default Layer Scan Map ##
279 self.fill_dict['DefaultLayerTriggerList'] = ""
280 self.fill_dict['DefaultLayerScanMap'] = "const nat_ptr_t *default_scanMap[] = {\n"
282 # Iterate over triggerList and generate a C trigger array for the default map and default map array
283 for triggerList in range( macros.firstScanCode[0], len( macros.triggerList[0] ) ):
284 # Generate ScanCode index and triggerList length
285 self.fill_dict['DefaultLayerTriggerList'] += "Define_TL( default, 0x{0:02X} ) = {{ {1}".format( triggerList, len( macros.triggerList[0][ triggerList ] ) )
287 # Add scanCode trigger list to Default Layer Scan Map
288 self.fill_dict['DefaultLayerScanMap'] += "default_tl_0x{0:02X}, ".format( triggerList )
290 # Add each item of the trigger list
291 for triggerItem in macros.triggerList[0][ triggerList ]:
292 self.fill_dict['DefaultLayerTriggerList'] += ", {0}".format( triggerItem )
294 self.fill_dict['DefaultLayerTriggerList'] += " };\n"
295 self.fill_dict['DefaultLayerTriggerList'] = self.fill_dict['DefaultLayerTriggerList'][:-1] # Remove last newline
296 self.fill_dict['DefaultLayerScanMap'] = self.fill_dict['DefaultLayerScanMap'][:-2] # Remove last comma and space
297 self.fill_dict['DefaultLayerScanMap'] += "\n};"
300 ## Partial Layers and Partial Layer Scan Maps ##
301 self.fill_dict['PartialLayerTriggerLists'] = ""
302 self.fill_dict['PartialLayerScanMaps'] = ""
304 # Iterate over each of the layers, excluding the default layer
305 for layer in range( 1, len( macros.triggerList ) ):
307 self.fill_dict['PartialLayerScanMaps'] += "// Partial Layer {0}\n".format( layer )
308 self.fill_dict['PartialLayerScanMaps'] += "const nat_ptr_t *layer{0}_scanMap[] = {{\n".format( layer )
309 self.fill_dict['PartialLayerTriggerLists'] += "// Partial Layer {0}\n".format( layer )
311 # Iterate over triggerList and generate a C trigger array for the layer
312 for triggerList in range( macros.firstScanCode[ layer ], len( macros.triggerList[ layer ] ) ):
313 # Generate ScanCode index and triggerList length
314 self.fill_dict['PartialLayerTriggerLists'] += "Define_TL( layer{0}, 0x{1:02X} ) = {{ {2}".format( layer, triggerList, len( macros.triggerList[ layer ][ triggerList ] ) )
316 # Add scanCode trigger list to Default Layer Scan Map
317 self.fill_dict['PartialLayerScanMaps'] += "layer{0}_tl_0x{1:02X}, ".format( layer, triggerList )
319 # Add each item of the trigger list
320 for trigger in macros.triggerList[ layer ][ triggerList ]:
321 self.fill_dict['PartialLayerTriggerLists'] += ", {0}".format( trigger )
323 self.fill_dict['PartialLayerTriggerLists'] += " };\n"
324 self.fill_dict['PartialLayerTriggerLists'] += "\n"
325 self.fill_dict['PartialLayerScanMaps'] = self.fill_dict['PartialLayerScanMaps'][:-2] # Remove last comma and space
326 self.fill_dict['PartialLayerScanMaps'] += "\n};\n\n"
327 self.fill_dict['PartialLayerTriggerLists'] = self.fill_dict['PartialLayerTriggerLists'][:-2] # Remove last 2 newlines
328 self.fill_dict['PartialLayerScanMaps'] = self.fill_dict['PartialLayerScanMaps'][:-2] # Remove last 2 newlines
331 ## Layer Index List ##
332 self.fill_dict['LayerIndexList'] = "const Layer LayerIndex[] = {\n"
334 # Iterate over each layer, adding it to the list
335 for layer in range( 0, len( macros.triggerList ) ):
336 # Lookup first scancode in map
337 firstScanCode = macros.firstScanCode[ layer ]
339 # Generate stacked name
341 if '*NameStack' in variables.layerVariables[ layer ].keys():
342 for name in range( 0, len( variables.layerVariables[ layer ]['*NameStack'] ) ):
343 stackName += "{0} + ".format( variables.layerVariables[ layer ]['*NameStack'][ name ] )
344 stackName = stackName[:-3]
346 # Default map is a special case, always the first index
348 self.fill_dict['LayerIndexList'] += '\tLayer_IN( default_scanMap, "D: {1}", 0x{0:02X} ),\n'.format( firstScanCode, stackName )
350 self.fill_dict['LayerIndexList'] += '\tLayer_IN( layer{0}_scanMap, "{0}: {2}", 0x{1:02X} ),\n'.format( layer, firstScanCode, stackName )
351 self.fill_dict['LayerIndexList'] += "};"
355 self.fill_dict['LayerState'] = "uint8_t LayerState[ LayerNum ];"