info_rules.hjson
3985 bytes
1// This file maps keys between `rules.mk` and `info.json`. It is used by QMK
2// to correctly and consistently map back and forth between the two systems.
3{
4 // Format:
5 // <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
6 // value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping", "str", "raw"
7 // to_json: Default `true`. Set to `false` to exclude this mapping from info.json
8 // to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk
9 // warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
10 // deprecated: Default `false`. Set to `true` to turn on warning when a value exists
11 // invalid: Default `false`. Set to `true` to generate errors when a value exists
12 // replace_with: use with a key marked deprecated or invalid to designate a replacement
13
14 "AUDIO_DRIVER": {"info_key": "audio.driver"},
15 "BACKLIGHT_DRIVER": {"info_key": "backlight.driver"},
16 "BLUETOOTH_DRIVER": {"info_key": "bluetooth.driver"},
17 "BOARD": {"info_key": "board"},
18 "BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
19 "BOOTMAGIC_ENABLE": {"info_key": "bootmagic.enabled", "value_type": "bool"},
20 "CAPS_WORD_ENABLE": {"info_key": "caps_word.enabled", "value_type": "bool"},
21 "DIP_SWITCH_ENABLE": {"info_key": "dip_switch.enabled", "value_type": "bool"},
22 "DEBOUNCE_TYPE": {"info_key": "build.debounce_type"},
23 "EEPROM_DRIVER": {"info_key": "eeprom.driver"},
24 "ENCODER_ENABLE": {"info_key": "encoder.enabled", "value_type": "bool"},
25 "ENCODER_DRIVER": {"info_key": "encoder.driver"},
26 "FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
27 "HAPTIC_DRIVER": {"info_key": "haptic.driver"},
28 "JOYSTICK_DRIVER": {"info_key": "joystick.driver"},
29 "JOYSTICK_ENABLE": {"info_key": "joystick.enabled", "value_type": "bool"},
30 "KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
31 "LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
32 "LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},
33 "LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"},
34 "MCU": {"info_key": "processor", "warn_duplicate": false},
35 "MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"},
36 "MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"},
37 "NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"},
38 "PIN_COMPATIBLE": {"info_key": "pin_compatible"},
39 "PLATFORM_KEY": {"info_key": "platform_key", "to_json": false},
40 "PS2_DRIVER": {"info_key": "ps2.driver"},
41 "PS2_ENABLE": {"info_key": "ps2.enabled", "value_type": "bool"},
42 "PS2_MOUSE_ENABLE": {"info_key": "ps2.mouse_enabled", "value_type": "bool"},
43 "RGB_MATRIX_DRIVER": {"info_key": "rgb_matrix.driver"},
44 "RGBLIGHT_DRIVER": {"info_key": "rgblight.driver"},
45 "SECURE_ENABLE": {"info_key": "secure.enabled", "value_type": "bool"},
46 "SERIAL_DRIVER": {"info_key": "split.serial.driver"},
47 "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
48 "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "to_c": false},
49 "STENO_ENABLE": {"info_key": "stenography.enabled", "value_type": "bool"},
50 "STENO_PROTOCOL": {"info_key": "stenography.protocol"},
51 "USB_WAIT_FOR_ENUMERATION": {"info_key": "usb.wait_for_enumeration", "value_type": "bool"},
52 "WEAR_LEVELING_DRIVER": {"info_key": "eeprom.wear_leveling.driver"},
53 "WS2812_DRIVER": {"info_key": "ws2812.driver"},
54
55 // Items we want flagged in lint
56 "CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
57 "CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
58 "VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true}
59}