Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix WAIT_FOR_USB handling #23598

Merged
merged 2 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion data/mappings/info_rules.hjson
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "to_c": false},
"STENO_ENABLE": {"info_key": "stenography.enabled", "value_type": "bool"},
"STENO_PROTOCOL": {"info_key": "stenography.protocol"},
"WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"},
"USB_WAIT_FOR_ENUMERATION": {"info_key": "usb.wait_for_enumeration", "value_type": "bool"},
"WEAR_LEVELING_DRIVER": {"info_key": "eeprom.wear_leveling.driver"},
"WS2812_DRIVER": {"info_key": "ws2812.driver"},

Expand Down
2 changes: 1 addition & 1 deletion data/schemas/keyboard.jsonschema
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@
}
},
"suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"wait_for": {"type": "boolean"}
"wait_for_enumeration": {"type": "boolean"}
}
},
"qmk": {
Expand Down
2 changes: 1 addition & 1 deletion docs/config_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ Use these to enable or disable building certain features. The more you have enab
* Allows replacing the standard matrix scanning routine with a custom one.
* `DEBOUNCE_TYPE`
* Allows replacing the standard key debouncing routine with an alternative or custom one.
* `WAIT_FOR_USB`
* `USB_WAIT_FOR_ENUMERATION`
* Forces the keyboard to wait for a USB connection to be established before it starts up
* `NO_USB_STARTUP_CHECK`
* Disables usb suspend check after keyboard startup. Usually the keyboard waits for the host to wake it up before any tasks are performed. This is useful for split keyboards as one half will not get a wakeup call but must send commands to the master.
Expand Down
2 changes: 1 addition & 1 deletion docs/ja/config_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
* 標準マトリックス走査ルーチンを独自のものに置き換えることができます。
* `DEBOUNCE_TYPE`
* 標準キーデバウンスルーチンを代替または独自のものに置き換えることができます。
* `WAIT_FOR_USB`
* `USB_WAIT_FOR_ENUMERATION`
* キーボードが起動する前に、USB 接続が確立されるのをキーボードに待機させます
* `NO_USB_STARTUP_CHECK`
* キーボードの起動後の usb サスペンドチェックを無効にします。通常、キーボードはタスクが実行される前にホストがウェイク アップするのを待ちます。分割キーボードは半分はウェイクアップコールを取得できませんが、マスタにコマンドを送信する必要があるため、役に立ちます。
Expand Down
2 changes: 1 addition & 1 deletion docs/reference_info_json.md
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@ Configures the [Stenography](feature_stenography.md) feature.
* `suspend_wakeup_delay`
* The amount of time to wait after sending a wakeup packet, in milliseconds.
* Default: `0` (disabled)
* `wait_for`
* `wait_for_enumeration`
* Force the keyboard to wait for USB enumeration before starting up.
* Default: `false`

Expand Down
3 changes: 2 additions & 1 deletion keyboards/converter/hp_46010a/keyboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"usb": {
"vid": "0xFEED",
"pid": "0x6060",
"device_version": "0.0.1"
"device_version": "0.0.1",
"wait_for_enumeration": true
},
"processor": "atmega32u4",
"bootloader": "halfkay",
Expand Down
1 change: 0 additions & 1 deletion keyboards/converter/hp_46010a/rules.mk
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
WAIT_FOR_USB = yes
CUSTOM_MATRIX = yes

SRC = matrix.c
2 changes: 0 additions & 2 deletions keyboards/geekboards/macropad_v2/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,3 @@
#define WS2812_PWM_PAL_MODE 1
#define WS2812_PWM_DMA_STREAM STM32_DMA1_STREAM3
#define WS2812_PWM_DMA_CHANNEL 3

#define WAIT_FOR_USB
3 changes: 2 additions & 1 deletion keyboards/geekboards/macropad_v2/keyboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"usb": {
"vid": "0x0483",
"pid": "0xA372",
"device_version": "0.0.2"
"device_version": "0.0.2",
"wait_for_enumeration": true
},
"qmk": {
"tap_keycode_delay": 10
Expand Down
3 changes: 2 additions & 1 deletion keyboards/ristretto/keyboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"usb": {
"vid": "0x666B",
"pid": "0x7273",
"device_version": "0.0.1"
"device_version": "0.0.1",
"wait_for_enumeration": true
},
"features": {
"bootmagic": false,
Expand Down
1 change: 0 additions & 1 deletion keyboards/ristretto/rules.mk

This file was deleted.

4 changes: 4 additions & 0 deletions tmk_core/protocol.mk
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ ifeq ($(strip $(NO_USB_STARTUP_CHECK)), yes)
OPT_DEFS += -DNO_USB_STARTUP_CHECK
endif

ifeq ($(strip $(USB_WAIT_FOR_ENUMERATION)), yes)
OPT_DEFS += -DUSB_WAIT_FOR_ENUMERATION
endif

ifeq ($(strip $(JOYSTICK_SHARED_EP)), yes)
OPT_DEFS += -DJOYSTICK_SHARED_EP
SHARED_EP_ENABLE = yes
Expand Down
7 changes: 6 additions & 1 deletion tmk_core/protocol/chibios/chibios.c
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@

#define USB_GETSTATUS_REMOTE_WAKEUP_ENABLED (2U)

#ifdef WAIT_FOR_USB
// TODO: Remove backwards compatibility with old define
# define USB_WAIT_FOR_ENUMERATION
#endif

/* -------------------------
* TMK host driver defs
* -------------------------
Expand Down Expand Up @@ -143,7 +148,7 @@ void protocol_pre_init(void) {

/* Wait until USB is active */
while (true) {
#if defined(WAIT_FOR_USB)
#if defined(USB_WAIT_FOR_ENUMERATION)
if (USB_DRIVER.state == USB_ACTIVE) {
driver = &chibios_driver;
break;
Expand Down
7 changes: 6 additions & 1 deletion tmk_core/protocol/lufa/lufa.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@
# include "raw_hid.h"
#endif

#ifdef WAIT_FOR_USB
// TODO: Remove backwards compatibility with old define
# define USB_WAIT_FOR_ENUMERATION
#endif

uint8_t keyboard_idle = 0;
/* 0: Boot Protocol, 1: Report Protocol(default) */
uint8_t keyboard_protocol = 1;
Expand Down Expand Up @@ -807,7 +812,7 @@ void protocol_pre_init(void) {

/* wait for USB startup & debug output */

#ifdef WAIT_FOR_USB
#ifdef USB_WAIT_FOR_ENUMERATION
while (USB_DeviceState != DEVICE_STATE_Configured) {
# if defined(INTERRUPT_CONTROL_ENDPOINT)
;
Expand Down
Loading