Autogen weak matrix_mask

qmk · Sep 14, 2023 · fc8337e · fc8337e
1 parent ef4df06
commit fc8337e
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/lib/python/qmk/cli/generate/config_h.py b/lib/python/qmk/cli/generate/config_h.py
@@ -72,6 +72,12 @@ def generate_matrix_size(kb_info_json, config_h_lines):
         config_h_lines.append(generate_define('MATRIX_ROWS', kb_info_json['matrix_size']['rows']))
 
 
+def generate_matrix_masked(kb_info_json, config_h_lines):
+    """"Enable matrix mask if required"""
+    if 'matrix_grid' in kb_info_json.get('dip_switch', {}):
+        config_h_lines.append(generate_define('MATRIX_MASKED'))
+
+
 def generate_config_items(kb_info_json, config_h_lines):
     """Iterate through the info_config map to generate basic config values.
     """
@@ -196,6 +202,8 @@ def generate_config_h(cli):
 
     generate_matrix_size(kb_info_json, config_h_lines)
 
+    generate_matrix_masked(kb_info_json, config_h_lines)
+
     if 'matrix_pins' in kb_info_json:
         config_h_lines.append(matrix_pins(kb_info_json['matrix_pins']))
 

diff --git a/lib/python/qmk/cli/generate/keyboard_c.py b/lib/python/qmk/cli/generate/keyboard_c.py
@@ -57,6 +57,31 @@ def _gen_led_config(info_data):
     return lines
 
 
+def _gen_matrix_mask(info_data):
+    """Convert info.json content to matrix_mask
+    """
+    cols = info_data['matrix_size']['cols']
+    rows = info_data['matrix_size']['rows']
+
+    # Default mask to everything enabled
+    mask = [['1'] * cols for i in range(rows)]
+
+    # Automatically mask out dip_switch.matrix_grid locations
+    matrix_grid = info_data.get('dip_switch', {}).get('matrix_grid', [])
+    for row, col in matrix_grid:
+        mask[row][col] = '0'
+
+    lines = []
+    lines.append('#ifdef MATRIX_MASKED')
+    lines.append('__attribute__((weak)) const matrix_row_t matrix_mask[] = {')
+    for i in range(rows):
+        lines.append(f'    0b{"".join(reversed(mask[i]))},')
+    lines.append('};')
+    lines.append('#endif')
+
+    return lines
+
+
 @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
 @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
 @cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='Keyboard to generate keyboard.c for.')
@@ -70,6 +95,7 @@ def generate_keyboard_c(cli):
     keyboard_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#include QMK_KEYBOARD_H', '']
 
     keyboard_h_lines.extend(_gen_led_config(kb_info_json))
+    keyboard_h_lines.extend(_gen_matrix_mask(kb_info_json))
 
     # Show the results
     dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet)