(1) 全局代码索引#

• Clangd 的索引范围：VSCode 的 Clangd 插件会基于工作区内的所有文件建立全局索引。

• 内核源码的覆盖：将内核目录加入工作区后，Clangd 会索引整个内核源码，包括头文件、函数定义、符号表等，使得驱动代码可以正确跳转到内核源码中的定义。

(2) 统一的编译配置#

• compile_commands. json：该文件记录了每个源文件的编译参数（如头文件路径、宏定义等）。
• 内核的编译配置：内核目录的 compile_commands.json 包含了内核编译时的完整配置（如架构 ARCH=arm、交叉编译器路径等）。
• 驱动的编译配置：驱动目录的 compile_commands.json 需要与内核的编译配置保持一致（例如使用相同的交叉编译器 arm-buildroot-linux-gnueabihf-gcc）。

(3) 跨目录依赖解析#

• 头文件路径解析：驱动代码中可能包含如下头文件引用：

  #include <linux/module.h> // 内核头文件

  如果内核目录不在工作区中，Clangd 将无法找到这些头文件的实际路径。

(4) 避免路径冲突#

• 相对路径与绝对路径：内核和驱动可能分布在不同的目录中（例如内核在 /home/book/linux-kernel，驱动在 /home/book/drivers）。

• 工作区统一管理：通过工作区将两者绑定，Clangd 可以自动处理跨目录的路径关系，无需手动配置头文件路径。

4.1 创建内核工作区#

• 目的：将内核源码目录作为工作区的根目录，确保 Clangd 能索引整个内核源码。
• 操作：在 VSCode 中打开内核目录，保存为 .code-workspace 文件。

4.2 将驱动目录加入工作区#

1. 编译驱动生成 compile_commands.json：

   cd /home/book/nfs_rootfs/drivers_projects/01_hello_drv/

   bear make # 生成 compile_commands. json

   • bear 会记录 make 编译时的命令，生成驱动代码的编译配置。

2. 修改 compile_commands.json：

   • 将文件中的编译器 "cc" 替换为交叉编译器 "arm-buildroot-linux-gnueabihf-gcc"。

   • 原因：驱动代码需要针对 ARM 架构交叉编译，确保 Clangd 使用正确的编译器解析代码。

3. 将驱动目录加入工作区：

   • 在 VSCode 中通过 File > Add Folder to Workspace 添加驱动目录。

   • 效果：工作区现在包含内核和驱动两个目录，Clangd 会同时索引两者的代码。

4.3 验证#

• 代码跳转：在驱动代码中按住 Ctrl 点击内核头文件（如 #include <linux/module.h>），应能跳转到内核源码中的定义。

• 悬停提示：将鼠标悬停在函数或变量上，显示其定义和注释。