diff options
Diffstat (limited to 'docs/zh-cn/faq_debug.md')
| -rw-r--r-- | docs/zh-cn/faq_debug.md | 188 |
1 files changed, 94 insertions, 94 deletions
diff --git a/docs/zh-cn/faq_debug.md b/docs/zh-cn/faq_debug.md index 4dba44c275..63d688ed9e 100644 --- a/docs/zh-cn/faq_debug.md +++ b/docs/zh-cn/faq_debug.md @@ -1,136 +1,136 @@ -# 调试的常见问题 +# 调试 FAQ -本篇详细介绍了人们在键盘故障排除时的各种常见问题。 +<!--- + original document: 0.15.12:docs/faq_debug.md + git diff 0.15.12 HEAD -- docs/faq_debug.md | cat +--> -# 调试控制台 +此页面详细介绍了人们对键盘故障排除的各种常见问题。 -## `hid_listen` 无法识别设备 -当设备的调试控制台未就绪时，您将看到如下内容： +## 调试 :id=debugging -``` -Waiting for device:......... -``` - -插入设备后，*hid_listen*找到该设备，您将收到以下消息： +如果你在 `rules.mk` 中配置了 `CONSOLE_ENABLE = yes`，你的键盘将会输出调试信息。默认情况下输出很有限，可以启用调试模式来增加调试输出的丰富度。使用你的键映射方案中的 `DEBUG` 键码，或使用[指令](zh-cn/feature_command.md)功能来启动调试模式，或者将下面这段代码放到你的键映射中： -``` -Waiting for new device:......................... -Listening: +```c +void keyboard_post_init_user(void) { + // 通过调整这些值可以改变其表现 + debug_enable=true; + debug_matrix=true; + //debug_keyboard=true; + //debug_mouse=true; +} ``` -如果您无法获得这条“Listening:”消息，请尝试在[Makefile]中使用 `CONSOLE_ENABLE=yes` +## 调试工具 -在Linux这样的操作系统上，你可能需要一些权限。 -- 使用`sudo hid_listen` +有多种可用于调试的工具。 -## 控制台没有返回消息 -检查: -- *hid_listen* 找到了你的设备。看前面。 -- 输入**Magic**+d打开调试。详见[Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands)。 -- 设置`debug_enable=true` ，一般存在于**matrix.c**的`matrix_init()`中。 -- 尝试使用'print'函数而不要用调试输出。详见**common/print.h**。 -- 断开其他有控制台功能的设备。 详见[Issue #97](https://github.com/tmk/tmk_keyboard/issues/97)。 +### 使用QMK工具箱调试 -## Linux或UNIX这样的系统如何请求超级用户权限 -用'sudo'来执行*hid_listen*就有权限了。 -``` -$ sudo hid_listen -``` +在兼容的平台上，[QMK工具箱](https://github.com/qmk/qmk_toolbox)可以展示你的键盘的调试输出。 -或者把一个文件放到规则文件夹来为TMK设备添加*udev规则*，不同系统的目录可能有所不同。 +### 使用 QMK CLI 进行调试 -文件: /etc/udev/rules.d/52-tmk-keyboard.rules(在Ubuntu系统的情况下) -``` -# tmk keyboard products https://github.com/tmk/tmk_keyboard -SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666" -``` +倾向于在终端进行调试？使用 [QMK CLI 命令行](zh-cn/cli_commands.md#qmk-console)可以展示键盘输出的调试信息。 -*** +### 使用hid_listen调试 -# 其他 -## 安全注意事项 +更喜欢使用终端的方案？PJRC提供的[hid_listen](https://www.pjrc.com/teensy/hid_listen.html)也可以用来展示调试信息，已有Windows、Linux及MacOS下预编译好的可执行文件。 -你应该不想要把你的键盘变成"砖头"吧，就是变成没法重写固件的那种。 -下面讲解一些参数来告诉你什么风险很大（其实也不是很大）。 +## 发送自定义调试信息 :id=debug-api -- 假如你键盘表面没有设计重置键"RESET", 那你要进入bootloader的话就要按PCB上的RESET了。 - 按PCB上的RESET要拧开键盘底部。 -- 如果 tmk_core / common 里面的文件丢失键盘可能失灵。 -- .hex太大可能不太好; `make dfu` 会删除块，检验大小（咦?好像反了...）。 - 一但出错，刷新键盘失败的话就困在DFU出不去了。 - - 所以, 要知道大小限制。 Planck键盘上.hex文件最大大小是 is 7000h (十进制是28672) +有时在[自定义代码](zh-cn/custom_quantum_functions.md)中输出调试信息非常有用，要做到这个功能也很简单，在代码文件头部包含 `print.h` 文件： +```c +#include "print.h" ``` -Linking: .build/planck_rev4_cbbrowne.elf [OK] -Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK] -Size after: - text data bss dec hex filename - 0 22396 0 22396 577c planck_rev4_cbbrowne.hex -``` +然后可以使用以下输出函数： - - 上面那个文件大小是 22396/577ch，比28672/7000h小 - - 当你有一个合适的.hex文件时，你就要重试加载那个了 - - 您在键盘Makefile中的某些选项可能消耗额外内存；注意以下这几个 - BOOTMAGIC_ENABLE, MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE -- DFU 工具/不/可以写入bootloader (unless you throw in extra fruit salad of options), - 所以还是有点危险的 -- EEPROM大概有100000次循环寿命。不要总是频繁重写固件；EEPROM会玩坏的。 -## 全键无冲不好用 -首先你要在**Makefile**用如下命令编译固件`NKRO_ENABLE`。 +* `print("string")`: 字符串输出 +* `uprintf("%s string", var)`: 格式化字符串输出 +* `dprint("string")` 仅调试模式下，字符串输出 +* `dprintf("%s string", var)`: 仅调试模式下，格式化字符串输出 -全键无冲还不好用的话试着用`Magic` **N** 命令(默认是`LShift+RShift+N`)。这个命令会在**全键无冲**和**六键无冲**之间临时切换。有些情况**全键无冲**不好用你就需要使用**六键无冲**模式，尤其是在BIOS中。 +## 调试示例 +以下列出了一些实际出现过的调试范例，更多资料参见[调试/定位QMK问题](zh-cn/faq_debug.md)。 -## 指点杆需要复位电路(PS/2 鼠标支持) -如果没有复位电路，由于硬件初始化不正确，您将得到不一致的结果。查看TPM754复位电路。 +### 当前按下的键的矩阵坐标是什么？ -- https://geekhack.org/index.php?topic=50176.msg1127447#msg1127447 -- https://www.mikrocontroller.net/attachment/52583/tpm754.pdf +在移植或尝试诊断PCB问题时，确认按下的键被正确扫描到是很有用的排查步骤。要启用该场景的日志输出，请在 `keymap.c` 中添加： +```c +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + // If console is enabled, it will print the matrix position and status of each key pressed +#ifdef CONSOLE_ENABLE + uprintf("KL: kc: 0x%04X, col: %u, row: %u, pressed: %b, time: %u, interrupt: %b, count: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed, record->event.time, record->tap.interrupted, record->tap.count); +#endif + return true; +} +``` -## 矩阵不可读16以上的列 -当列超过16时[matrix.h]的`read_cols()`中，用`1UL<<16`而不要用`1<<16`。 - -在C语言中`1` 是一个[int] 类型的[16 bit]值，在AVR中你不能左移大于15次。如果你使用`1<<16`的话会得到意外的零。你要用 [unsigned long]类型，比如`1UL`。 +输出示例 +```text +Waiting for device:....... +Listening: +KL: kc: 169, col: 0, row: 0, pressed: 1 +KL: kc: 169, col: 0, row: 0, pressed: 0 +KL: kc: 174, col: 1, row: 0, pressed: 1 +KL: kc: 174, col: 1, row: 0, pressed: 0 +KL: kc: 172, col: 2, row: 0, pressed: 1 +KL: kc: 172, col: 2, row: 0, pressed: 0 +``` -https://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279 +### 扫描到一个键码需要多久？ -## 特殊额外键不起作用(系统，音频控制键) -你要在`rules.mk`定义`EXTRAKEY_ENABLE`在QMK中使用它们。 +调试性能问题时，知晓开关矩阵的扫描频率是很有用的排查步骤。要启用该场景的日志输出，请在 `config.h` 中添加： +```c +#define DEBUG_MATRIX_SCAN_RATE ``` -EXTRAKEY_ENABLE = yes # 音频控制和系统控制 -``` - -## 睡眠唤醒不好用 - -在Windows查看设备管理器中该键盘设备属性中电源管理选项卡中的`允许此设备唤醒计算机(O)`是否勾选。同时看一眼BIOS设置。 -在主机睡眠时按下任何键都可以唤醒了。 +输出示例 +```text + > matrix scan frequency: 315 + > matrix scan frequency: 313 + > matrix scan frequency: 316 + > matrix scan frequency: 316 + > matrix scan frequency: 316 + > matrix scan frequency: 316 +``` -## 使用Arduino? +## `hid_listen` 无法识别到设备 -**注意Arduino的针脚名字和主控芯片的不一样。** 比如, Arduino的`D0`并不是`PD0`。自己用原理图捋一下电路。 +如果设备没有就绪，在命令行下调试会看到如下输出： -- https://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf -- https://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf +``` +Waiting for device:......... +``` -Arduino Leonardo和micro使用**ATMega32U4**，该芯片TMK可用，但Arduino的bootloader会导致问题。 +当设备插入后，*hid_listen*可以发现设备，会有如下输出： -## USB 3 兼容性 -据传说有些人用USB3接口会有问题，用USB2的试试。 +``` +Waiting for new device:......................... +Listening: +``` +若无法出现'Listening:'消息，尝试在[Makefile]中添加 `CONSOLE_ENABLE=yes` -## Mac 兼容性 -### OS X 10.11 和集线器 -https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034 +在类Linux系统下，访问设备可能需要一定权限，尝试使用 `sudo hid_listen`。 +此外，很多Linux发行版可以通过创建如下内容的文件 `/etc/udev/rules.d/70-hid-listen.rules` 来避免通过root权限执行hid_listen： -## 对于BIOS (UEFI)/恢复(睡眠和唤醒)/重新启动 有问题 -有人说他们的键盘在BIOS中，或许是恢复(睡眠和唤醒)后不工作. +``` +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="abcd", ATTRS{idProduct}=="def1", TAG+="uaccess", RUN{builtin}+="uaccess" +``` -截止至目前，其根本原因未知，不排除与某些构建选项有关。试着在Makefile中失能`CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE`这样的选项，也试试其他的。 +使用设备的真实VID和PID替换上面的abcd和def1，留意必须全小写。其中 `RUN{builtin}+="uaccess"` 仅在较老的发行版中需要使用。 -https://github.com/tmk/tmk_keyboard/issues/266 -https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778 +## 命令行无法成功输出消息 +请检查: +- *hid_listen*确实找到了设备，如前文所述。 +- 通过**Magic**+d命令启用调试模式，参见[Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands). +- 配置`debug_enable=true`. 参见[调试](#debugging) +- 尝试用 `print` 替代 `dprint`， 参见**common/print.h**. +- 拔出其它可能影响命令行的设备，参见[Issue #97](https://github.com/tmk/tmk_keyboard/issues/97). |