Android Bluetooth HCI log 详解

向右看齐 2023-03-02 07:54 8阅读 0赞

# 0. 引子 #

对于蓝牙开发者来说，通过HCI log可以帮助我们更好地分析问题，理解蓝牙协议，就好像网络开发一定要会使用Wireshark分析网络协议一样。

本篇主要介绍**HCI log的作用**、**如何抓取一份HCI log**，并结合一个**实际的例子**来说明**如何分析HCI log**。

# 1. HCI log 介绍 #

## 1.1 HCI log 作用 ##

HCI log是用来分析蓝牙设备之间的交互行为**是否符合预期**，**是否符合蓝牙规范**。在日常的开发中，通常使用HCI log来做这样几件事：

*  **分析Bug**：蓝牙打开后搜索不到设备，或者搜索到的设备没有名称只有蓝牙地址；Android手机不能向苹果手机传输文件 ... ...
 *  **需求分析**：手机需要适配一款蓝牙自拍杆来控制拍照，通过HCI log可以观察竞品在实现这个功能时，使用的是什么Bluetooth Profile？只要知道了使用的Bluetooth Profile，我们就有了实现这个功能的思路。
 *  **蓝牙协议学习**：通过HCI log辅助学习蓝牙协议，就好像学习TCP/IP时，通过wireshark抓包来学习TCP协议

## 1.2 蓝牙核心系统架构 ##

说了这么多HCI log的用处，要想更好地理解HCI log，我们需要先来看下HCI在整个蓝牙核心系统架构中所处的位置。为了理解起来更简单，我这边将蓝牙核心系统架构**抽象为3层**：

*  **User Application(Host)**：User Application即应用层，也被称为Host，我们调用Bluetooth API就属于应用层，例如，[BluetoothAdapter][]中提供的接口。
 *  **HCI (Host controller Interface)**：上层在调用蓝牙API时，**不会直接操作蓝牙底层**(Controller)相关接口，而是**通过HCI下发对应操作的Command给Controller**，然后底层执行命令后返回执行结果，**即Controller发送Event给HCI，HCI再通知给应用层**，HCI起到了一个**中间层**的作用。
 *  **Controller**：Controller是在最底层，可以理解为我们手机上的蓝牙芯片。

![format_png][] 标题抽象后的蓝牙架构

完整的蓝牙核心系统架构比较复杂，这里我们就不再深入，感兴趣的同学可以参考蓝牙规范[Core\_v4.2.pdf][Core_v4.2.pdf]，里面有详细的定义和介绍。我们后面在分析HCI log时，也会参考这个规范中定义的内容。

![format_png 1][] 完整的蓝牙架构标题

# 2. 如何抓取HCI log #

在开发者选项中打开**启用蓝牙HCI信息收集日志**开关，Android系统就开始自动地收集HCI log并保存到手机上。

![format_png 2][] 标启用蓝牙HCI信息收集日志题

不同的平台存放HCI log的路径会不一样，**MTK**存放HCI log的路径为**/sdcard/mtklog/btlog/btsnoop\_hci.log**，**高通**的存放路径为**/sdcard/btsnoop\_hci.log**

MTK:/ $ ls -l /sdcard/mtklog/btlog/
    total 816
    -rw-rw---- 1 root sdcard_rw 412258 2016-02-28 00:39 btsnoop_hci.log
    
    shell@Qualcomm:/ $ ls -l /sdcard/btsnoop_hci.log
    -rw-rw---- root     sdcard_rw    12744 2017-06-16 15:43 btsnoop_hci.log

如果上面提到的路径下都没有HCI log，我们还可以通过手机上的**蓝牙配置文件bt\_stack.conf来查看路径**，bt\_stack.conf位于**/etc/bluetooth/**路径下。HCI log路径通过**BtSnoopFileName=/sdcard/btsnoop\_hci.log**来进行设置的。

![format_png 3][] 标题HCI log在手机上的路径

而bt\_stack.conf是通过Android源码中的[/system/bt/conf/bt\_stack.conf][system_bt_conf_bt_stack.conf]来配置的。

// /system/bt/conf/bt_stack.conf
    # BtSnoop log output file
    BtSnoopFileName=/sdcard/btsnoop_hci.log

将抓取到的HCI log pull出来，直接用记事本打开，看到的都是乱码。我们还需要一个HCI log分析工具：**Frontline ComProbe Protocol Analysis System**

C:\Windows\System32>adb pull /sdcard/mtklog/btlog/btsnoop_hci.log C:\Users\admin\Desktop\hci
    501 KB/s (4880 bytes in 0.009s)

# 3. HCI log分析工具 #

**Frontline ComProbe Protocol Analysis System**是Frontline提供的一款蓝牙协议log分析工具，Frontine这家公司主要是做抓取蓝牙Air sniff log设备的，我们后面再来说下什么是Air sniff log。购买他们的抓包工具就会附带log分析工具，也可以在[Frontine官网][Frontine]上下载，下载的时候需要填一些信息，觉得麻烦的同学可以去其他[非官网途径][Link 1]进行下载。

安装完成后，在开始菜单中找到Frontline ComProbe Protocol Analysis System，使用Capture File Viewer可以打开HCI log

![format_png 4][] ComProbe Protocol Analysis System

**Step 1**. 首先，选择要**打开的HCI log**，并选择log类型为**BtSnoop Files**，即以\*.log结尾的文件。  
还有一种方式是将btsnoop\_hci.log的后缀修改为btsnoop\_hci.cfa，就可以直接用Capture File Viewer打开。

![format_png 5][] Step 1. 打开的HCI log

![format_png 6][] 选择log类型

**Step 2**. 打开log文件后，选择**Frame Display**就可以看到我们抓取的HCI log了

![format_png 7][] Step 2 . 选择Frame Display

![format_png 8][] Frame Display主界面

**Step 3**. Frame Display窗口中有很多Tab，将协议栈中各类协议分类显示，例如：HCI相关的log放在HCI的Tab中，**Hands-Free（HFP）**属于**应用层的Bluetooth Profile**，和HFP相关操作的log都放在Hands-Free这个Tab中。

![format_png 9][] Frame Display

*  **Air sniff log**  
    Android设备上抓取的HCI log只能分析Host和Control之间的问题，当Host和Control之间交互是正常的，那就可能就是**传输的过程中（Air Interface）**出了问题，此时就需要分析Air sniff log。Air sniff log能够抓取的两个蓝牙设备在数据传输过程中的空中包，抓取Air sniff log需要专门的设备。

![format_png 10][] Air sniff log

# 4. HCI log 案例 - 蓝牙扫描设备过程分析 #

应用层在调用**startDiscovery()**进行设备扫描时，**Host**会通过HCI发送一个**Inquiry HCI Command**给**Controller**。接下来我们会通过分析HCI log，来学习Inquiry 的流程。在分析HCI log前，我们先来学习下**HCI Command数据包**的结构。

## 4.1 HCI Command 数据包结构 ##

HCI Command数据包结构定义在蓝牙核心协议规范[Core\_v4.2.pdf][Core_v4.2.pdf]中。

HCI Command数据包格式如下，开头的**Opcode是区分不同类型的命令的唯一标识**，Opcode由**OpCode Group Field (OGF)** 和 **OpCode Command Field (OCF)**组成。根据OGF的值，可以将HCI commands进行分类。OpCode 的计算公式为：\*\* OpCode = OGF << 6 + OCF **。有了OpCode计算的方式，我们就可以**通过OpCode过滤\*\*HCI log里面的指定类型的HCI Command。

![format_png 11][] HCI Command Packet

![format_png 12][] OpCode计算方法

## 4.2 过滤Inquiry Command ##

**Inquiry Command**是**Link Control command**类型的command，通过查询[Bluetooth Core Specification][Core_v4.2.pdf]的中**Vol 2->Part E->7.1 LINK CONTROL COMMANDS**小节，可知Link Control command的**OCF值为0x0001**。

![format_png 13][] Bluetooth Core Specification目录

![format_png 14][] For the Link Control commands, the OGF is defined as 0x01

因此，**Inquiry Command的Opcode**为 0x0001 << 6 + 0x01 = **0x0401** ，**通过0x0401就确定某条command为Inquiry Command**，该命令的名称为**HCI\_Inquiry**

![format_png 15][] Inquiry Command

ComProbe Protocol Analysis System支持过滤功能，通过**设置filter**可以过滤出Opcode为0x0401的log，设置方法如下图：

![aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy8yMTE4NDM4LTYwYTZhNjBhNDNmYmRmNTkuZ2lmP2ltYWdlTW9ncjIvYXV0by1vcmllbnQvc3RyaXB8aW1hZ2VWaWV3Mi8yL3cvMTIwMC9mb3JtYXQvd2VicA][] 过滤HCI\_Inquiry

## 4.3 扫描过程分析 ##

1. 发送Inquiry请求

*  **Host发送HCI\_Inquiry Command**  
    应用层要进行蓝牙设备扫描啦，Host先发一条HCI\_Inquiry的Command通知Controller

![format_png 16][] Host： HCI\_Inquiry

*  **Controller回复HCI Event**  
    Controller在收到HCI\_Inquiry这条Command后，会**回复一条Command Status的HCI Event**，来表示Controller执行HCI\_Inquiry后的状态，即**Status：Success**。仔细观察可以发现这两条HCI log的Frame标号是挨着的，HCI\_Inquiry的帧号是196，Command Status的帧号是197。

![format_png 17][] Controller：Command\_status、

2. 扫描结果

**扫描完成**后，Controller会发送Event：**HCI Extended Inquiry Result**。以列表中搜索到的**Jabra Classic v0.5.3**为例，它的HCI Extended Inquiry Result数据包中会包含它的**设备名称**、它所**支持的Service的UUID**，和**设备类型**：**Wearable Headset device**，因此，Jabra Classic v0.5.3的Icon是一个**耳机的图标**。

![format_png 18][] 扫描结果

![format_png 19][] Jabra Classic v0.5.3的HCI Extended Inquiry Result

# 5. 参考 #

*  [Core\_v4.2.pdf][Core_v4.2.pdf]
 *  [HCI Layer Tutorial][]

作者：伤口不该结疤  
链接：https://www.jianshu.com/p/73f7366161d1  
来源：简书  
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

[BluetoothAdapter]: https://link.jianshu.com?t=https://developer.android.com/reference/android/bluetooth/BluetoothAdapter.html
[format_png]: /images/20230208/6ced99cb89e14ad3a314124a9619127e.png
[Core_v4.2.pdf]: https://link.jianshu.com?t=https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=286439
[format_png 1]: /images/20230208/807c436bfd924261b9c3855f566df805.png
[format_png 2]: /images/20230208/5e282f3adfc345a7822e80c9fa30d3f6.png
[format_png 3]: /images/20230208/5868f8f0956c4bac9ad71e5ae156dac3.png
[system_bt_conf_bt_stack.conf]: https://link.jianshu.com?t=http://androidxref.com/6.0.0_r1/xref/system/bt/conf/bt_stack.conf
[Frontine]: https://link.jianshu.com?t=http://www.fte.com/products/default.aspx
[Link 1]: https://link.jianshu.com?t=http://download.csdn.net/download/sunrain_hjb/9744464
[format_png 4]: /images/20230208/f94682fdcd9e4a8f9b7feebddf1c0ded.png
[format_png 5]: /images/20230208/083a45b872ad4f6a969d5ecb75376e57.png
[format_png 6]: /images/20230208/0c27662d60f7439c9c232b6f635bb68d.png
[format_png 7]: /images/20230208/ffc091528ca641b293b490a65dfdf6bd.png
[format_png 8]: /images/20230208/2c06e08a75ce4e6eb8afce53c824cc5b.png
[format_png 9]: /images/20230208/3b22487f543e45d981df9074900c8bef.png
[format_png 10]: /images/20230208/f77cca6c303c40b6a4fdfda0ddde96db.png
[format_png 11]: /images/20230208/6f26054bfeae4107a54d584506f48664.png
[format_png 12]: /images/20230208/449cb0a08c964c1e86728d3a642c40d6.png
[format_png 13]: /images/20230208/7390a506fb8a4330b3118ce6b71dbc85.png
[format_png 14]: /images/20230208/010af3f9601746c78fc788ed13402122.png
[format_png 15]: /images/20230208/ef17ca523d6c4de1b89780c5fe1e1344.png
[aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy8yMTE4NDM4LTYwYTZhNjBhNDNmYmRmNTkuZ2lmP2ltYWdlTW9ncjIvYXV0by1vcmllbnQvc3RyaXB8aW1hZ2VWaWV3Mi8yL3cvMTIwMC9mb3JtYXQvd2VicA]: /images/20230208/6cc2554424eb417496176628561541ee.png
[format_png 16]: /images/20230208/1cddd15a1d56430fb98c26e38febd33b.png
[format_png 17]: /images/20230208/26f72f350afc4178980c9138b00bb61b.png
[format_png 18]: /images/20230208/db5e69bc6c7240598791f4fc1072e8ac.png
[format_png 19]: /images/20230208/c3bbbcc1b688444391d6ad169f57b28a.png
[HCI Layer Tutorial]: https://link.jianshu.com?t=http://www.amd.e-technik.uni-rostock.de/ma/gol/lectures/wirlec/bluetooth_info/hci.html