mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-15 22:23:21 +00:00
212 lines
8.8 KiB
Python
Executable File
212 lines
8.8 KiB
Python
Executable File
"""Used by the make system to generate info_config.h from info.json.
|
|
"""
|
|
from pathlib import Path
|
|
from dotty_dict import dotty
|
|
|
|
from argcomplete.completers import FilesCompleter
|
|
from milc import cli
|
|
|
|
from qmk.info import info_json
|
|
from qmk.json_schema import json_load
|
|
from qmk.keyboard import keyboard_completer, keyboard_folder
|
|
from qmk.commands import dump_lines, parse_configurator_json
|
|
from qmk.path import normpath, FileType
|
|
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
|
|
|
|
|
|
def generate_define(define, value=None):
|
|
value = f' {value}' if value is not None else ''
|
|
return f"""
|
|
#ifndef {define}
|
|
# define {define}{value}
|
|
#endif // {define}"""
|
|
|
|
|
|
def direct_pins(direct_pins, postfix):
|
|
"""Return the config.h lines that set the direct pins.
|
|
"""
|
|
rows = []
|
|
|
|
for row in direct_pins:
|
|
cols = ','.join(map(str, [col or 'NO_PIN' for col in row]))
|
|
rows.append('{' + cols + '}')
|
|
|
|
return generate_define(f'DIRECT_PINS{postfix}', f'{{ {", ".join(rows)} }}')
|
|
|
|
|
|
def pin_array(define, pins, postfix):
|
|
"""Return the config.h lines that set a pin array.
|
|
"""
|
|
pin_array = ', '.join(map(str, [pin or 'NO_PIN' for pin in pins]))
|
|
|
|
return generate_define(f'{define}_PINS{postfix}', f'{{ {pin_array} }}')
|
|
|
|
|
|
def matrix_pins(matrix_pins, postfix=''):
|
|
"""Add the matrix config to the config.h.
|
|
"""
|
|
pins = []
|
|
|
|
if 'direct' in matrix_pins:
|
|
pins.append(direct_pins(matrix_pins['direct'], postfix))
|
|
|
|
if 'cols' in matrix_pins:
|
|
pins.append(pin_array('MATRIX_COL', matrix_pins['cols'], postfix))
|
|
|
|
if 'rows' in matrix_pins:
|
|
pins.append(pin_array('MATRIX_ROW', matrix_pins['rows'], postfix))
|
|
|
|
return '\n'.join(pins)
|
|
|
|
|
|
def generate_matrix_size(kb_info_json, config_h_lines):
|
|
"""Add the matrix size to the config.h.
|
|
"""
|
|
if 'matrix_pins' in kb_info_json:
|
|
config_h_lines.append(generate_define('MATRIX_COLS', kb_info_json['matrix_size']['cols']))
|
|
config_h_lines.append(generate_define('MATRIX_ROWS', kb_info_json['matrix_size']['rows']))
|
|
|
|
|
|
def generate_config_items(kb_info_json, config_h_lines):
|
|
"""Iterate through the info_config map to generate basic config values.
|
|
"""
|
|
info_config_map = json_load(Path('data/mappings/info_config.json'))
|
|
|
|
for config_key, info_dict in info_config_map.items():
|
|
info_key = info_dict['info_key']
|
|
key_type = info_dict.get('value_type', 'raw')
|
|
to_config = info_dict.get('to_config', True)
|
|
|
|
if not to_config:
|
|
continue
|
|
|
|
try:
|
|
config_value = kb_info_json[info_key]
|
|
except KeyError:
|
|
continue
|
|
|
|
if key_type.startswith('array.array'):
|
|
config_h_lines.append(generate_define(config_key, f'{{ {", ".join(["{" + ",".join(list(map(str, x))) + "}" for x in config_value])} }}'))
|
|
elif key_type.startswith('array'):
|
|
config_h_lines.append(generate_define(config_key, f'{{ {", ".join(map(str, config_value))} }}'))
|
|
elif key_type == 'bool':
|
|
if config_value:
|
|
config_h_lines.append(generate_define(config_key))
|
|
elif key_type == 'mapping':
|
|
for key, value in config_value.items():
|
|
config_h_lines.append(generate_define(key, value))
|
|
elif key_type == 'str':
|
|
escaped_str = config_value.replace('\\', '\\\\').replace('"', '\\"')
|
|
config_h_lines.append(generate_define(config_key, f'"{escaped_str}"'))
|
|
elif key_type == 'bcd_version':
|
|
(major, minor, revision) = config_value.split('.')
|
|
config_h_lines.append(generate_define(config_key, f'0x{major.zfill(2)}{minor}{revision}'))
|
|
else:
|
|
config_h_lines.append(generate_define(config_key, config_value))
|
|
|
|
|
|
def generate_encoder_config(encoder_json, config_h_lines, postfix=''):
|
|
"""Generate the config.h lines for encoders."""
|
|
a_pads = []
|
|
b_pads = []
|
|
resolutions = []
|
|
for encoder in encoder_json.get("rotary", []):
|
|
a_pads.append(encoder["pin_a"])
|
|
b_pads.append(encoder["pin_b"])
|
|
resolutions.append(encoder.get("resolution", None))
|
|
|
|
config_h_lines.append(generate_define(f'ENCODERS_PAD_A{postfix}', f'{{ {", ".join(a_pads)} }}'))
|
|
config_h_lines.append(generate_define(f'ENCODERS_PAD_B{postfix}', f'{{ {", ".join(b_pads)} }}'))
|
|
|
|
if None in resolutions:
|
|
cli.log.debug("Unable to generate ENCODER_RESOLUTION configuration")
|
|
elif len(set(resolutions)) == 1:
|
|
config_h_lines.append(generate_define(f'ENCODER_RESOLUTION{postfix}', resolutions[0]))
|
|
else:
|
|
config_h_lines.append(generate_define(f'ENCODER_RESOLUTIONS{postfix}', f'{{ {", ".join(map(str,resolutions))} }}'))
|
|
|
|
|
|
def generate_split_config(kb_info_json, config_h_lines):
|
|
"""Generate the config.h lines for split boards."""
|
|
if 'primary' in kb_info_json['split']:
|
|
if kb_info_json['split']['primary'] in ('left', 'right'):
|
|
config_h_lines.append('')
|
|
config_h_lines.append('#ifndef MASTER_LEFT')
|
|
config_h_lines.append('# ifndef MASTER_RIGHT')
|
|
if kb_info_json['split']['primary'] == 'left':
|
|
config_h_lines.append('# define MASTER_LEFT')
|
|
elif kb_info_json['split']['primary'] == 'right':
|
|
config_h_lines.append('# define MASTER_RIGHT')
|
|
config_h_lines.append('# endif // MASTER_RIGHT')
|
|
config_h_lines.append('#endif // MASTER_LEFT')
|
|
elif kb_info_json['split']['primary'] == 'pin':
|
|
config_h_lines.append(generate_define('SPLIT_HAND_PIN'))
|
|
elif kb_info_json['split']['primary'] == 'matrix_grid':
|
|
config_h_lines.append(generate_define('SPLIT_HAND_MATRIX_GRID', f'{{ {",".join(kb_info_json["split"]["matrix_grid"])} }}'))
|
|
elif kb_info_json['split']['primary'] == 'eeprom':
|
|
config_h_lines.append(generate_define('EE_HANDS'))
|
|
|
|
if 'protocol' in kb_info_json['split'].get('transport', {}):
|
|
if kb_info_json['split']['transport']['protocol'] == 'i2c':
|
|
config_h_lines.append(generate_define('USE_I2C'))
|
|
|
|
if 'right' in kb_info_json['split'].get('matrix_pins', {}):
|
|
config_h_lines.append(matrix_pins(kb_info_json['split']['matrix_pins']['right'], '_RIGHT'))
|
|
|
|
if 'right' in kb_info_json['split'].get('encoder', {}):
|
|
generate_encoder_config(kb_info_json['split']['encoder']['right'], config_h_lines, '_RIGHT')
|
|
|
|
|
|
def generate_led_animations_config(led_feature_json, config_h_lines, prefix):
|
|
for animation in led_feature_json.get('animations', {}):
|
|
if led_feature_json['animations'][animation]:
|
|
config_h_lines.append(generate_define(f'{prefix}{animation.upper()}'))
|
|
|
|
|
|
@cli.argument('filename', nargs='?', arg_only=True, type=FileType('r'), completer=FilesCompleter('.json'), help='A configurator export JSON to be compiled and flashed or a pre-compiled binary firmware file (bin/hex) to be flashed.')
|
|
@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, help='Keyboard to generate config.h for.')
|
|
@cli.subcommand('Used by the make system to generate info_config.h from info.json', hidden=True)
|
|
def generate_config_h(cli):
|
|
"""Generates the info_config.h file.
|
|
"""
|
|
# Determine our keyboard/keymap
|
|
if cli.args.filename:
|
|
user_keymap = parse_configurator_json(cli.args.filename)
|
|
kb_info_json = user_keymap.get('config', {})
|
|
elif cli.args.keyboard:
|
|
kb_info_json = dotty(info_json(cli.args.keyboard))
|
|
else:
|
|
cli.log.error('You must supply a configurator export or `--keyboard`.')
|
|
cli.subcommands['generate-config-h'].print_help()
|
|
return False
|
|
|
|
# Build the info_config.h file.
|
|
config_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
|
|
|
|
generate_config_items(kb_info_json, config_h_lines)
|
|
|
|
generate_matrix_size(kb_info_json, config_h_lines)
|
|
|
|
if 'matrix_pins' in kb_info_json:
|
|
config_h_lines.append(matrix_pins(kb_info_json['matrix_pins']))
|
|
|
|
if 'encoder' in kb_info_json:
|
|
generate_encoder_config(kb_info_json['encoder'], config_h_lines)
|
|
|
|
if 'split' in kb_info_json:
|
|
generate_split_config(kb_info_json, config_h_lines)
|
|
|
|
if 'led_matrix' in kb_info_json:
|
|
generate_led_animations_config(kb_info_json['led_matrix'], config_h_lines, 'ENABLE_LED_MATRIX_')
|
|
|
|
if 'rgb_matrix' in kb_info_json:
|
|
generate_led_animations_config(kb_info_json['rgb_matrix'], config_h_lines, 'ENABLE_RGB_MATRIX_')
|
|
|
|
if 'rgblight' in kb_info_json:
|
|
generate_led_animations_config(kb_info_json['rgblight'], config_h_lines, 'RGBLIGHT_EFFECT_')
|
|
|
|
# Show the results
|
|
dump_lines(cli.args.output, config_h_lines, cli.args.quiet)
|