diff --git a/docs/nordic_ncs_官方知识索引.md b/docs/nordic_ncs_官方知识索引.md new file mode 100644 index 0000000..8908040 --- /dev/null +++ b/docs/nordic_ncs_官方知识索引.md @@ -0,0 +1,118 @@ +# new_kbd 项目 Nordic NCS 官方知识索引 + +## 说明 + +- 生成时间:2026-03-30 +- 文档来源:仅收录 `docs.nordicsemi.com` 上可直接访问的 Nordic 官方文档 +- 版本基线:按项目当前环境优先核对 `ncs-3.2.3` +- 项目芯片基线:`atguigu_mini_keyboard/nrf52840` +- 芯片依据:项目板级文件 [atguigu_mini_keyboard.yaml](E:/extra/boards/atguigu/atguigu_mini_keyboard/atguigu_mini_keyboard.yaml) 与 [atguigu_mini_keyboard.dts](E:/extra/boards/atguigu/atguigu_mini_keyboard/atguigu_mini_keyboard.dts) 明确基于 `nrf52840` +- 收录范围:仅收录 `E:\projects\new_kbd` 实际使用到的 NCS 官方知识,以及 Nordic 站点中同时存在的 Zephyr 镜像文档 +- 不收录原则:如果没有核到 Nordic 官方页面,则不写入本索引 +- 本版校验方式:使用浏览器渲染后再判定,凡标题或正文渲染为 `Error 404 - Page Not Found` / `ERROR CODE: 404` 的页面,均视为无效并移除 + +## NCS 托管的 Zephyr 文档镜像 + +### 构建与配置 + +- [应用开发总览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/develop/application/index.html) +- [CMake 构建系统(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/cmake/index.html) +- [Kconfig 配置系统(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/kconfig/index.html) +- [Sysbuild 系统构建(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/sysbuild/index.html) + +### 设备树与设备模型 + +- [设备树入门(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/intro.html) +- [设备树 HOWTO(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/howtos.html) +- [设备树 C/C++ API 用法(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/api-usage.html) +- [zephyr,user 自定义节点(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/zephyr-user-node.html) + +### 内核与并发 + +- [工作队列与延迟工作(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/kernel/services/threads/workqueue.html) +- [原子操作(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/kernel/services/other/atomic.html) +- [自旋锁 API(NCS 镜像)](https://docs.nordicsemi.com/bundle/zephyr-apis-3.2.3/page/spinlock_8h.html) +- [时钟、超时与 uptime(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/kernel/services/timing/clocks.html) + +### 日志与存储 + +- [日志子系统(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/services/logging/index.html) +- [Settings 设置子系统(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/services/storage/settings/index.html) +- [NVS 非易失存储(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/services/storage/nvs/nvs.html) +- [Flash Map 闪存映射(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/services/storage/flash_map/flash_map.html) + +### 蓝牙 Low Energy + +- [Bluetooth GAP 概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/bluetooth/api/gap.html) +- [Bluetooth 连接管理(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/bluetooth/api/connection_mgmt.html) +- [Bluetooth GATT 概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/bluetooth/api/gatt.html) +- [Bluetooth 标准服务总览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/bluetooth/api/services.html) + +### USB 与 HID + +- [USB 设备栈(Device Stack Next,NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/usb/device_next/usb_device.html) +- [USB HID 设备 API(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/usb/device_next/api/usbd_hid_device.html) +- [HID 通用定义与报告描述符(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/connectivity/usb/api/hid.html) + +### 外设驱动 + +- [ADC 外设概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/hardware/peripherals/adc.html) +- [GPIO 外设概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/hardware/peripherals/gpio.html) +- [I2C 外设概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/hardware/peripherals/i2c.html) +- [传感器子系统概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/hardware/peripherals/sensor/index.html) +- [LED 外设概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/hardware/peripherals/led.html) + +### 显示与 GUI + +- [显示子系统概览(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/hardware/peripherals/display/index.html) +- [PWM LEDs 设备树绑定(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/api/bindings/led/pwm-leds.html) +- [GPIO LEDs 设备树绑定(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/api/bindings/led/gpio-leds.html) +- [LVGL 官方示例入口(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/samples/modules/lvgl/lvgl.html) + +### 通用工具宏与字节序 + +- [sys/byteorder 字节序 API(NCS 镜像)](https://docs.nordicsemi.com/bundle/zephyr-apis-3.2.3/page/sys_2byteorder_8h.html) +- [spinlock 文件参考(NCS API 镜像)](https://docs.nordicsemi.com/bundle/zephyr-apis-3.2.3/page/spinlock_8h.html) + +## Partition Manager 与存储布局 + +- [Partition Manager](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/scripts/partition_manager/partition_manager.html) + +## CAF 总览与基础设施 + +- [Common Application Framework (CAF) 总览](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/caf/caf_overview.html) +- [Application Event Manager](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/others/app_event_manager.html) +- [Application Event Manager Profiler Tracer](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/others/app_event_manager_profiler_tracer.html) + +## CAF 模块 + +- [CAF Buttons 模块](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/caf/buttons.html) +- [CAF LEDs 模块](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/caf/leds.html) +- [CAF BLE Advertising 模块](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/caf/ble_adv.html) +- [CAF BLE State 模块](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/caf/ble_state.html) +- [CAF Power Manager 模块](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/libraries/caf/power_manager.html) +- [Settings Loader](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/nrf/applications/nrf_desktop/doc/settings_loader.html) + +## CAF API / 辅助定义 + +- [led_effect API](https://docs.nordicsemi.com/bundle/nrf-apis-3.2.3/page/group_led_effect_CAF.html) + +## 芯片与 Nordic 外设相关 + +- [nRF52840 驱动索引](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/nrf52840_drivers.html) +- [nRF52840 DK 用户指南](https://docs.nordicsemi.com/bundle/ug_nrf52840_dk) +- [Nordic nRF USBD 设备树绑定(NCS 镜像)](https://docs.nordicsemi.com/bundle/ncs-3.2.3/page/zephyr/build/dts/api/bindings/usb/nordic_nrf-usbd.html) +- [nrf_qdec HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_qdec.html) +- [nrf_saadc HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_saadc.html) +- [nrf_usbd HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_usbd.html) +- [nrf_gpio HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_gpio.html) +- [nrf_pwm HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_pwm.html) +- [nrf_spi HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_spi.html) +- [nrf_twim HAL / 寄存器 API](https://docs.nordicsemi.com/bundle/nrfx-apis-3.2.3/page/group_nrf_twim.html) + +## 备注 + +- `pm_static.yml` 相关内容,本次仅核到 Nordic 官方的 Partition Manager 页面;未单独核到专门以 `pm_static.yml` 命名的独立官方页面,因此这里索引到 Partition Manager 官方文档 +- Zephyr 侧已经收录的知识,只要在 Nordic 站点存在并通过浏览器渲染校验,本索引也一并收录 +- 芯片相关知识本次按项目实际硬件基线 `nrf52840` 收录,没有扩展到未使用的其他 Nordic SoC +- 当前 Nordic 站点里,很多 `zephyr-apis-3.2.3`、`nrf-apis-3.2.3` 与部分 CAF 事件页虽然返回 `200`,但浏览器渲染后是 `Error 404 - Page Not Found`,因此已从本索引移除 diff --git a/docs/zephyr_官方知识索引.md b/docs/zephyr_官方知识索引.md new file mode 100644 index 0000000..d852724 --- /dev/null +++ b/docs/zephyr_官方知识索引.md @@ -0,0 +1,96 @@ +# new_kbd 项目 Zephyr 官方知识索引 + +## 说明 + +- 生成时间:2026-03-30 +- 扫描范围:`src/`、`inc/`、`prj.conf`、`sysbuild.conf`、`app.overlay`、`pm_static.yml` +- 收录原则:仅收录 `E:\projects\new_kbd` 当前实际用到、且已确认页面真实存在的 Zephyr 官方文档 +- 链接范围:`https://docs.zephyrproject.org/latest/`、`https://docs.zephyrproject.org/apidoc/latest/`、`https://docs.zephyrproject.org/latest/doxygen/html/` +- 不收录范围:Nordic NCS/CAF/App Event Manager/Partition Manager 文档,以及项目自定义驱动或项目私有协议说明 +- Nordic NCS 官方补充索引见:[new_kbd 项目 Nordic NCS 官方知识索引](./nordic_ncs_官方知识索引.md) + +## 构建与配置 + +- [应用开发总览](https://docs.zephyrproject.org/latest/develop/application/index.html) +- [CMake 构建系统](https://docs.zephyrproject.org/latest/build/cmake/index.html) +- [Kconfig 配置系统](https://docs.zephyrproject.org/latest/build/kconfig/index.html) +- [Sysbuild 系统构建](https://docs.zephyrproject.org/latest/build/sysbuild/index.html) + +## 设备树与设备模型 + +- [设备树入门](https://docs.zephyrproject.org/latest/build/dts/intro.html) +- [设备树 HOWTO](https://docs.zephyrproject.org/latest/build/dts/howtos.html) +- [设备树 C/C++ API 用法](https://docs.zephyrproject.org/latest/build/dts/api-usage.html) +- [zephyr,user 自定义节点](https://docs.zephyrproject.org/latest/build/dts/zephyr-user-node.html) +- [设备模型 API](https://docs.zephyrproject.org/apidoc/latest/group__device__model.html) +- [设备树通用标识符 API](https://docs.zephyrproject.org/apidoc/latest/group__devicetree-generic-id.html) + +## 内核与并发 + +- [工作队列与延迟工作](https://docs.zephyrproject.org/latest/kernel/services/threads/workqueue.html) +- [原子操作](https://docs.zephyrproject.org/latest/kernel/services/other/atomic.html) +- [自旋锁 API](https://docs.zephyrproject.org/apidoc/latest/spinlock_8h.html) +- [时钟、超时与 uptime](https://docs.zephyrproject.org/latest/kernel/services/timing/clocks.html) + +## 日志与存储 + +- [日志子系统](https://docs.zephyrproject.org/latest/services/logging/index.html) +- [Settings 设置子系统](https://docs.zephyrproject.org/latest/services/storage/settings/index.html) +- [NVS 非易失存储](https://docs.zephyrproject.org/latest/services/storage/nvs/nvs.html) +- [Flash Map 闪存映射](https://docs.zephyrproject.org/latest/services/storage/flash_map/flash_map.html) + +## 蓝牙 Low Energy + +- [Bluetooth GAP 概览](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/gap.html) +- [Bluetooth GAP API](https://docs.zephyrproject.org/apidoc/latest/group__bt__gap.html) +- [Bluetooth 连接管理](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/connection_mgmt.html) +- [Bluetooth 连接管理 API](https://docs.zephyrproject.org/apidoc/latest/group__bt__conn.html) +- [Bluetooth GATT 概览](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/gatt.html) +- [Bluetooth GATT Server API](https://docs.zephyrproject.org/apidoc/latest/group__bt__gatt__server.html) +- [Bluetooth UUID API](https://docs.zephyrproject.org/apidoc/latest/group__bt__uuid.html) +- [Bluetooth Battery Service (BAS) API](https://docs.zephyrproject.org/apidoc/latest/group__bt__bas.html) +- [Bluetooth 标准服务总览](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/services.html) +- [BLE HID 外设官方示例](https://docs.zephyrproject.org/latest/samples/bluetooth/peripheral_hids/README.html) + +## USB 与 HID + +- [USB 设备栈(Device Stack Next)](https://docs.zephyrproject.org/latest/connectivity/usb/device_next/usb_device.html) +- [USB Device API](https://docs.zephyrproject.org/apidoc/latest/group__usbd__api.html) +- [USB HID 设备 API](https://docs.zephyrproject.org/latest/connectivity/usb/device_next/api/usbd_hid_device.html) +- [USB HID Device API 参考](https://docs.zephyrproject.org/apidoc/latest/group__usbd__hid__device.html) +- [HID 通用定义与报告描述符](https://docs.zephyrproject.org/latest/connectivity/usb/api/hid.html) +- [zephyr,hid-device 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/usb/zephyr%2Chid-device.html) + +## 外设驱动 + +- [ADC 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/adc.html) +- [ADC API](https://docs.zephyrproject.org/apidoc/latest/group__adc__interface.html) +- [GPIO 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/gpio.html) +- [GPIO API](https://docs.zephyrproject.org/apidoc/latest/group__gpio__interface.html) +- [I2C 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/i2c.html) +- [传感器子系统概览](https://docs.zephyrproject.org/latest/hardware/peripherals/sensor/index.html) +- [传感器 API](https://docs.zephyrproject.org/apidoc/latest/group__sensor__interface.html) +- [LED 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/led.html) +- [LED API](https://docs.zephyrproject.org/apidoc/latest/group__led__interface.html) +- [Nordic nRF QDEC 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/sensor/nordic%2Cnrf-qdec.html) + +## 显示与 GUI + +- [显示子系统概览](https://docs.zephyrproject.org/latest/hardware/peripherals/display/index.html) +- [MIPI-DBI SPI 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/mipi-dbi/zephyr%2Cmipi-dbi-spi.html) +- [ST7789V 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/display/sitronix%2Cst7789v.html) +- [PWM LEDs 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/led/pwm-leds.html) +- [GPIO LEDs 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/led/gpio-leds.html) +- [LVGL 官方示例入口](https://docs.zephyrproject.org/latest/samples/modules/lvgl/lvgl.html) + +## 通用工具宏与字节序 + +- [sys/util 通用工具宏 API](https://docs.zephyrproject.org/apidoc/latest/group__sys-util.html) +- [sys/byteorder 字节序 API](https://docs.zephyrproject.org/latest/doxygen/html/sys_2byteorder_8h.html) + +## 未纳入本索引的项目项 + +- `zephyr/drivers/power/ip5305.h`、`CONFIG_IP5305`:当前项目使用的是自定义驱动/自定义绑定,Zephyr 官方 latest 站点未核到对应官方页面,因此未纳入 +- `pm_static.yml` 对应的 Partition Manager 规划:属于 Nordic NCS 范畴,不属于 Zephyr 官方 docs 站点范围;Nordic 官方索引见 [nordic_ncs_官方知识索引.md](./nordic_ncs_官方知识索引.md) +- `CAF`、`App Event Manager`、`settings_loader`、`ble_state`、`ble_common_event`、`power_manager`、`buttons_def.h` 等:属于 Nordic NCS/CAF 文档范围,不属于本 Zephyr 官方索引;Nordic 官方索引见 [nordic_ncs_官方知识索引.md](./nordic_ncs_官方知识索引.md) +- 项目私有协议与实现,如时间同步私有 GATT 服务、主机 HID 命令协议、显示主题持久化逻辑等:只索引其依赖的 Zephyr 通用能力,不索引项目私有设计本身