Add protocol detection

qmk_commands.py

@@ -16,19 +16,21 @@
         if key not in os.environ:
             os.environ[key] = os.environ['GIT_BRANCH']
 
-CHIBIOS_GIT_BRANCH = os.environ.get('CHIBIOS_GIT_BRANCH', 'qmk')
-CHIBIOS_GIT_URL = os.environ.get('CHIBIOS_GIT_URL', 'https://github.com/qmk/ChibiOS')
-CHIBIOS_CONTRIB_GIT_BRANCH = os.environ.get('CHIBIOS_CONTRIB_GIT_BRANCH', 'qmk')
-CHIBIOS_CONTRIB_GIT_URL = os.environ.get('CHIBIOS_CONTRIB_GIT_URL', 'https://github.com/qmk/ChibiOS-Contrib')
 DISCORD_WARNING_SENT = False
 DISCORD_WEBHOOK_URL = os.environ.get('DISCORD_WEBHOOK_URL')
 DISCORD_WEBHOOK_INFO_URL = os.environ.get('DISCORD_WEBHOOK_INFO_URL', DISCORD_WEBHOOK_URL)
 DISCORD_WEBHOOK_WARNING_URL = os.environ.get('DISCORD_WEBHOOK_WARNING_URL', DISCORD_WEBHOOK_URL)
 DISCORD_WEBHOOK_ERROR_URL = os.environ.get('DISCORD_WEBHOOK_ERROR_URL', DISCORD_WEBHOOK_URL)
-LUFA_GIT_BRANCH = os.environ.get('LUFA_GIT_BRANCH', 'master')
-LUFA_GIT_URL = os.environ.get('LUFA_GIT_URL', 'https://github.com/qmk/lufa')
+
 QMK_GIT_BRANCH = os.environ.get('QMK_GIT_BRANCH', 'master')
 QMK_GIT_URL = os.environ.get('QMK_GIT_URL', 'https://github.com/qmk/qmk_firmware.git')
+CHIBIOS_GIT_BRANCH = os.environ.get('CHIBIOS_GIT_BRANCH', 'qmk')
+CHIBIOS_GIT_URL = os.environ.get('CHIBIOS_GIT_URL', 'https://github.com/qmk/ChibiOS')
+CHIBIOS_CONTRIB_GIT_BRANCH = os.environ.get('CHIBIOS_CONTRIB_GIT_BRANCH', 'qmk')
+CHIBIOS_CONTRIB_GIT_URL = os.environ.get('CHIBIOS_CONTRIB_GIT_URL', 'https://github.com/qmk/ChibiOS-Contrib')
+LUFA_GIT_BRANCH = os.environ.get('LUFA_GIT_BRANCH', 'master')
+LUFA_GIT_URL = os.environ.get('LUFA_GIT_URL', 'https://github.com/qmk/lufa')
+
 ZIP_EXCLUDES = {
     'qmk_firmware': ('qmk_firmware/.build/*', 'qmk_firmware/.git/*', 'qmk_firmware/lib/chibios/.git', 'qmk_firmware/lib/chibios-contrib/.git'),
     'chibios': ('chibios/.git/*'),
@@ -117,36 +119,31 @@ def checkout_qmk(skip_cache=False, require_cache=False):
         git_clone(QMK_GIT_URL, QMK_GIT_BRANCH)
 
 
-def checkout_chibios():
-    """Do whatever is needed to get the latest version of ChibiOS and ChibiOS-Contrib.
+def checkout_submodule(name, url, branch):
+    """Clone a submodule to the lib directory.
     """
-    chibios = ('chibios', CHIBIOS_GIT_URL, CHIBIOS_GIT_BRANCH)
-    chibios_contrib = ('chibios-contrib', CHIBIOS_CONTRIB_GIT_URL, CHIBIOS_CONTRIB_GIT_BRANCH)
-
     os.chdir('qmk_firmware/lib')
 
-    for submodule, git_url, git_branch in chibios, chibios_contrib:
-        if os.path.exists(submodule):
-            rmtree(submodule)
+    if os.path.exists(name):
+        rmtree(name)
 
-        if not fetch_source(submodule):
-            git_clone(git_url, git_branch)
+    if not fetch_source(name):
+        git_clone(url, branch)
 
     os.chdir('../..')
 
 
-def checkout_lufa():
-    """Do whatever is needed to get the latest version of lufa
+def checkout_chibios():
+    """Do whatever is needed to get the latest version of ChibiOS and ChibiOS-Contrib.
     """
-    os.chdir('qmk_firmware/lib')
-
-    if os.path.exists('lufa'):
-        rmtree('lufa')
+    checkout_submodule('chibios', CHIBIOS_GIT_URL, CHIBIOS_GIT_BRANCH)
+    checkout_submodule('chibios-contrib', CHIBIOS_CONTRIB_GIT_URL, CHIBIOS_CONTRIB_GIT_BRANCH)
 
-    if not fetch_source('lufa'):
-        git_clone(LUFA_GIT_URL, LUFA_GIT_BRANCH)
 
-    os.chdir('../..')
+def checkout_lufa():
+    """Do whatever is needed to get the latest version of LUFA.
+    """
+    checkout_submodule('lufa', LUFA_GIT_URL, LUFA_GIT_BRANCH)
 
 
 def git_clone(git_url=QMK_GIT_URL, git_branch=QMK_GIT_BRANCH):

qmk_compiler.py

@@ -132,11 +132,10 @@ def compile_firmware(keyboard, keymap, layout, layers):
             return {'returncode': -1, 'command': '', 'output': 'Unknown keyboard!', 'firmware': None}
 
         # If this keyboard needs a submodule check it out
-        if kb_data['processor_type'] == 'arm':
-            checkout_chibios()
-
-        if kb_data['processor_type'] in ['avr', 'arm']:
+        if kb_data['protocol'] in ['ChibiOS', 'LUFA']:
             checkout_lufa()
+            if kb_data['protocol'] == 'ChibiOS':
+                checkout_chibios()
 
         # Write the keymap file
         with open(path.join('qmk_firmware', keymap_json_file), 'w') as fd:

update_kb_redis.py

@@ -469,12 +469,14 @@ def arm_processor_rules(keyboard_info, rules_mk):
             keyboard_info['bootloader'] = 'stm32-dfu'
         elif keyboard_info.get('manufacturer') == 'Input Club':
             keyboard_info['bootloader'] = 'kiibohd-dfu'
+    keyboard_info['protocol'] = 'ChibiOS'
     if 'STM32' in keyboard_info['processor']:
         keyboard_info['platform'] = 'STM32'
     elif 'MCU_SERIES' in rules_mk:
         keyboard_info['platform'] = rules_mk['MCU_SERIES']
     elif 'ARM_ATSAM' in rules_mk:
         keyboard_info['platform'] = 'ARM_ATSAM'
+        keyboard_info['protocol'] = 'ATSAM'
 
 
 def avr_processor_rules(keyboard_info, rules_mk):
@@ -485,6 +487,14 @@ def avr_processor_rules(keyboard_info, rules_mk):
     keyboard_info['platform'] = rules_mk['ARCH'] if 'ARCH' in rules_mk else 'unknown'
     keyboard_info['processor'] = rules_mk['MCU'] if 'MCU' in rules_mk else 'unknown'
 
+    # These are the only two MCUs which need V-USB at the moment.
+    # Eventually we should detect the protocol by looking at PROTOCOL inherited from mcu_selection.mk:
+    #if rules_mk['PROTOCOL'] == 'VUSB':
+    if rules_mk.get('MCU') in ['atmega32a', 'atmega328p']:
+        keyboard_info['protocol'] = 'V-USB'
+    else:
+        keyboard_info['protocol'] = 'LUFA'
+
 
 def unknown_processor_rules(keyboard_info, rules_mk):
     """Setup the default keyboard info for unknown boards.
@@ -493,6 +503,7 @@ def unknown_processor_rules(keyboard_info, rules_mk):
     keyboard_info['platform'] = 'unknown'
     keyboard_info['processor'] = 'unknown'
     keyboard_info['processor_type'] = 'unknown'
+    keyboard_info['protocol'] = 'unknown'
 
 
 def store_keyboard_readme(keyboard_info):