WWW.LAB-Z.COM

Step to UEFI (232）UEFI Shell 下控制 USBNotifier

前面的文章介绍了如何使用 CH55X 制作一个 USB 提醒器【参考1】，这次介绍如何在 UEFI Shell 下编写 Application 来控制使用它。

从思路上来说，可以使用加载驱动，然后调用驱动引入的 protocol 来进行控制。比如，FT232 有一个驱动，可以在 UEFI Shell 下直接调用【参考2】.但是，这次的USB 提醒器并没有这样的Driver（估计需要等待 WCH 来进行开发吧）。于是，我们只能尝试直接对其发送数据。

首先使用 USBView 查看一下：

这里需要特别关注的是 Endpoint, 可以看到有下面三个 Endpoint, 第一个是 interrupt, 用于传送控制信息；后面两个分别是 Bulk 的输入和输出用于传输真正的串口数据。

          ===>Endpoint Descriptor&lt;===
bLength:                           0x07
bDescriptorType:                   0x05
bEndpointAddress:                  0x81  -> Direction: IN - EndpointID: 1
bmAttributes:                      0x03  -> Interrupt Transfer Type
wMaxPacketSize:                  0x0008 = 0x08 bytes
bInterval:                         0x40

          ===>Endpoint Descriptor&lt;===
bLength:                           0x07
bDescriptorType:                   0x05
bEndpointAddress:                  0x02  -> Direction: OUT - EndpointID: 2
bmAttributes:                      0x02  -> Bulk Transfer Type
wMaxPacketSize:                  0x0040 = 0x40 bytes
bInterval:                         0x00

          ===>Endpoint Descriptor&lt;===
bLength:                           0x07
bDescriptorType:                   0x05
bEndpointAddress:                  0x82  -> Direction: IN - EndpointID: 2
bmAttributes:                      0x02  -> Bulk Transfer Type
wMaxPacketSize:                  0x0040 = 0x40 bytes
bInterval:                         0x00

另外因为 USBNotifier 实际上是一个假串口设备（意思是并非对外转接为串口数据），所以即使初始化时如果没有设置波特率等等这样的参数，仍然能够正确收到数据。所以，我们只需要将数据丢到Bulk 的 Endpoint 就可以正常收到并处理。关键步骤如下：

枚举当前系统中有 USBIo 的全部 handle
使用 UsbGetDeviceDescriptor() 取得每个设备的 PID 和 VID
使用 UsbGetInterfaceDescriptor() 找到 USBNotifier 的 EndPoint
使用 UsbBulkTransfer() 针对找到的 Endpoint 发送数据

需要特别注意的是：在 UEFI Shell 下， USBNotifier 会被认为两个设备，Interrupt 的Endpoint 为一个设备，另外2个 Bulk 的 Endpoint 被识别为一个设备。

完整的代码：

#include <Uefi.h>
#include <Library/UefiLib.h>
#include <Library/ShellCEntryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseMemoryLib.h>
#include <Protocol/UsbIo.h>

extern EFI_BOOT_SERVICES         *gBS;
#define USB_ENDPOINT_ADDR(EpAddr) ((EpAddr) & 0x7F)

EFI_GUID gEfiUsbIoProtocolGuid =
{ 0x2B2F68D6, 0x0CD2, 0x44CF, { 0x8E, 0x8B, 0xBB, 0xA2, 0x0B, 0x1B, 0x5B, 0x75 }};

int
EFIAPI
main (
        IN int Argc,
        IN CHAR16 **Argv
)
{
        EFI_STATUS    Status;
        UINTN         HandleIndex, HandleCount;
        //UINT8         i,j;
        EFI_HANDLE    *DevicePathHandleBuffer = NULL;
        EFI_USB_IO_PROTOCOL          *USBIO;
        EFI_USB_DEVICE_DESCRIPTOR     DeviceDescriptor;
        EFI_USB_INTERFACE_DESCRIPTOR  IfDesc;
        UINT8                         arr[64];
        UINTN                         LengthInBytes;
        UINT32                        TransferStatus;

        //Get all the Handles that have UsbIO Protocol
        Status = gBS->LocateHandleBuffer(
                ByProtocol,
                &gEfiUsbIoProtocolGuid,
                NULL,
                &HandleCount,
                &DevicePathHandleBuffer);
        if (EFI_ERROR(Status))
        {
                Print(L"ERROR : Get USBIO count fail.\n");
                return 0;
        }

        for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++)
        {
                Status = gBS->HandleProtocol(
                        DevicePathHandleBuffer[HandleIndex],
                        &gEfiUsbIoProtocolGuid,
                        (VOID**)&USBIO);
                if (EFI_ERROR(Status))
                {
                        Print(L"ERROR : Open USBIO fail.\n");
                        gBS->FreePool(DevicePathHandleBuffer);
                        return 0;
                }

                //Get USB Device Descriptor
                Status = USBIO->UsbGetDeviceDescriptor(USBIO, &DeviceDescriptor);
                if (EFI_ERROR(Status))
                {
                        Print(L"ERROR : Usb Get Device Descriptor fail.\n");
                        gBS->FreePool(DevicePathHandleBuffer);
                        return EFI_SUCCESS;
                }

                //Find the device which VID and PID is USB notifier
                if ((0x1209==DeviceDescriptor.IdVendor) && (0xC550==DeviceDescriptor.IdProduct))
                {
                        //Show the PID and VID
                        Print(L"Found a USB Notifier = %04X, ProductID = %04X\n",
                        DeviceDescriptor.IdVendor,
                        DeviceDescriptor.IdProduct);
                        //
                        // Get Interface Descriptor
                        //
                        Status = USBIO->UsbGetInterfaceDescriptor (USBIO, &IfDesc);
                        if (EFI_ERROR (Status))
                        {
                                continue;
                        }
                        
                        if (IfDesc.NumEndpoints==2)
                        {
                                Print(L"Found OUTPUT Endpoint, send the data!\n");
                                
                                arr[0]=0x5B; arr[1]=0x63; arr[2]=0xFF;
                                arr[3]=0x00; arr[4]=0x00; arr[5]=0x5D;
                                LengthInBytes=6;
                                
                                Status = USBIO->UsbBulkTransfer ( 
                                                        USBIO,
                                                        2,
                                                        &arr[0],
                                                        &LengthInBytes,
                                                        3000,
                                                        &TransferStatus );
                                Print(L"Red color\n");
                                gBS->Stall(3000000UL);
                                
                                arr[2]=00; arr[3]=0xFF; arr[4]=0x00;
                                Status = USBIO->UsbBulkTransfer ( 
                                                        USBIO,
                                                        2,
                                                        &arr[0],
                                                        &LengthInBytes,
                                                        3000,
                                                        &TransferStatus );
                                Print(L"Green color\n");
                                gBS->Stall(3000000UL);
                                
                                arr[2]=0x00; arr[3]=0x00; arr[4]=0xFF;
                                Status = USBIO->UsbBulkTransfer ( 
                                                        USBIO,
                                                        2,
                                                        &arr[0],
                                                        &LengthInBytes,
                                                        3000,
                                                        &TransferStatus ); 
                                Print(L"Blue color\n");
                                gBS->Stall(3000000UL);
                                
                                arr[2]=0x00; arr[3]=0x00; arr[4]=0x00;
                                Status = USBIO->UsbBulkTransfer ( 
                                                        USBIO,
                                                        2,
                                                        &arr[0],
                                                        &LengthInBytes,
                                                        3000,
                                                        &TransferStatus );   
                        }
                }
        }
        gBS->FreePool(DevicePathHandleBuffer);

        return EFI_SUCCESS;
}

工作的视频可以在 B 站看到。

https://www.bilibili.com/video/BV1dQ4y1X7XG/

完整工程下载：

USBNotifier 下载

参考：

https://www.lab-z.com/usbnt/ 做一个 USB 提醒器
https://www.lab-z.com/stufdti/ Step to UEFI (93）FTDI 串口驱动

国产高速芯片 CH9344 测试板

CH9344是南京沁恒出品的一款串口芯片。现在市面上常见的 CH340 也是他们家的产品。相比之下，CH9344有下面2个显著的特点：

1. 最高支持 12，000，000串口频率；

2. 一颗芯片带有4个串口。

更具体的信息可以在官方页面【参考1】上看到。

这次我尝试使用这个芯片制作了一个测试板。首先是绘制电路图，基本上就是照搬 Datasheet上提供的参考设计。需要特别注意的是：

1. 因为通讯速度较高（已经属于 USB High Speed了），因此使用的是30Mhz 的晶振；

2. Pin37 务必预留一个按钮，后面会讲述原因；

3. USB 口上预留了一个 H3 跳线，用于一些不需要从 USB口取电的情况；

Layout 还是比较狂野的：

3D 预览如下：

然后就做出来了，焊接难度中等，强烈推荐准备助焊锡膏（不是焊锡膏），因为在焊接的时候很容易出现引脚粘连，在助焊锡膏的帮助下才容易分开。

完成之后就开始了测试。测试中我发现当选择为 12Mhz 通讯时，实际只有 6Mhz。

为了解决这个问题首先在技术社区发帖咨询，管理员让我通过电子邮件联系技术支持（tech@wch.cn）。技术支持工程是先后确认过使用的驱动是最新版本，通讯软件正确（他们家有自己的串口软件），之后他们发现我的芯片版本较老：

升级的方法是：对地短接 Pin37 ，将模块插入电脑后运行升级软件即可更新内部Firmware：

之后，设备管理器中的设备信息有变化：

再次测量，可以看到能够实现 12Mhz 的通讯：

电路设计软件是立创 EDA

ch9344 下载

参考：

1. http://www.wch.cn/products/CH9344.html

相信很多人入门时都使用 MASM，这的 MASM 就是 Microsoft‘s Macro Assembler。其中的 Macro 就是宏的意思。相比函数，宏具有更加简洁，运行速度快（编译器会对代码进行“宏展开”，直接修改代码）等等特点。但是，如果需要调试和阅读具有多层宏定义就非常痛苦了。很多年前我接触到的P公司的BIOS代码就是这样，乍一看代码非常规整，每一行就像一个洋葱，追踪起来一层又一层，让人感叹阅读代码是个系统工程。

最近偶然看到 GCC 有展开宏功能，同样的在Microsoft 的Visual C++上也有类似功能，通过编译指令 /p 或者 /ep 即可实现。这两个参数的区别在于生成的” 预编译文件”是否有行号。例如，编写下面的代码，其中定义一个名为 SUM 的宏：

#include  <Uefi.h>
#include  <Library/UefiLib.h>
#include  <Library/ShellCEntryLib.h>
#define SUM(a,b) a+b


/***
  Print a welcoming message.

  Establishes the main structure of the application.

  @retval  0         The application exited normally.
  @retval  Other     An error occurred.
***/
INTN
EFIAPI
ShellAppMain (
  IN UINTN Argc,
  IN CHAR16 **Argv
  )
{
        int c =3,d=4;

  Print(L"Hello there fellow Programmer.\n");
  Print(L"Welcome to the world of EDK II.\n");

  Print(L"Macro test %d\n",SUM(c,d));
  
  return(0);
}

在 INF 中定义如下：

[BuildOptions]
  MSFT:*_*_X64_CC_FLAGS  = /P

在Build 目录下有生成一个 hello.i 其中有如下代码断，可以看到 SUM 宏已经展开。

INTN
__cdecl
ShellAppMain (
   UINTN Argc,
   CHAR16 **Argv
  )
{
        int c =3,d=4;

  Print(L"Hello there fellow Programmer.\n");
  Print(L"Welcome to the world of EDK II.\n");

  Print(L"Macro test %d\n",c+d);
  
  return(0);
}

如果使用 /EP /P 参数，那么生成的预编译文件中不会有行号：

[BuildOptions]
  MSFT:*_*_X64_CC_FLAGS  = /EP /P

下图中，左侧是 /EP /P 参数的运行结果，右侧是/P 的结果：

UEFI TIPS: 定义一个注释宏

最近看了一下C语言中 Define 的用法，这个可以看成是C 语言的宏定义，在使用时会进行展开。从这个角度来说，可以用它实现编译过程中自动删除代码的功能。

比如下面的代码中，当定义LAB_APP_DEBUG 1 后，编译过程中 zPrint 会被解释成为 “\\” 这样对应的一行就会被注释掉。

#include  <Uefi.h>
#include  <Library/BaseLib.h>
#include  <Library/UefiLib.h>
#include  <Library/ShellCEntryLib.h>

#include  <stdio.h>
#include  <stdlib.h>

#define LAB_APP_DEBUG 1
#if defined(LAB_APP_DEBUG)
        #define        zPrint   Print
#else   
        #define        zPrint   /\
/
#endif

INTN
EFIAPI
main (
  IN UINTN Argc,
  IN CHAR8 **Argv
  )
{
    zPrint(L"StringAAAA\n");
    zPrint(L"StringBBBB\n");
    
    return EFI_SUCCESS;
}

运行结果，第一个是定义了LAB_APP_DEBUG=1的结果，第二个是删除了这定义的结果

此外，EDK2 中一些宏将一些函数定义为空，在编译时通过当前时 DEBUG 还是 REALSE 进行区分，可以做到和上面相同的效果。

Arduino CH376 模块调试指南

去年的时候，介绍过通过串口来和 CH376 通讯【参考1】，最近又将它拿出来玩，和之前不同，这次是和 ESP32 通讯，没想到遇到了奇怪的问题，以此为契机仔细研读 datasheet 总结如下。

硬件连接：USB 转串口卡，上面的 5V(必须5V)，接VCC；GND 接 GND；TX接 RX； RX 接TX；特别注意，这种板子上有一个5V转3.3V的ASM1117，就是说5V提供给USB 设备，但是芯片是工作在3.3V 下，这种情况下串口一般都能正常工作，但是如果用 SPI 模式，需要特别注意和单片机的电平匹配问题；
串口发送 CHECK_EXIST （57 AB 06 AA），正确的回复是 0x55 如果没有回复或者是错误的，请检查硬件连接，还有波特率设定；默认情况下波特率为 9600

3.串口发送CMD_SET_USB_MOD (57 AB 15 06), 模式代码为 06H 时切换到已启用的 USB 主机方式，自动产生 SOF 包，正确回答是CMD_RET_SUCCESS 和 USB_INT_CONNECT (0x51 0x15)

串口发送 DISK_CONNECT(57 AB 30),检查U盘连接，正确回答是 0x14；如果有问题，请更换U盘或者检查格式，在【参考2】给出了一个Bug：如果保留扇区数>255，在老的芯片上会有问题；
串口发送 DISK_MOUNT (57 AB 31),初始化U盘，并且检测，正确回答是 0x14；
串口发送 DISK_CAPACITY (57 AB 3E), 查询U盘容量。查询结果需要发送 RD_USB_DATA0查询(57 AB 27)，收到返回值 04 FF 7F 7D 00 ，意思是 4个字节，0x7D7FFF= 8224767个扇区电脑上查看如下（感觉这个命令查询的结果是“U盘上最大的扇区号”，所以数量等于这个值加1）：

参考：

https://www.lab-z.com/ardch376/
http://www.wch.cn/bbs/thread-63674-1.html 工作人员回复说老版本芯片会有问题

Kabylake PCH UART 测试工具 Windows 版

之前发布过一个 UEFI Shell 版本的 PCH UART，这次发布的是 Windows 版本的。

功能和使用方法同之前的 Shell 版本没有差别。在 AmberLake-Y 下测试通过。

接收端串口设置

可执行程序下载(密码 lab-z.com)：

puw 下载

FT232H UART 速度测试

很早之前入手过一块 FT232H 的板卡，这次进行一下 UART 最高速度的测试。测试条件是 Windows 10 操作系统，系统默认的驱动（VCP）。

FT232 上 TXD 是 Pin13 （AD0）, RXD 是Pin14（AD1）

使用串口工具直接发送 HEX 55 55 55 55 55 55 55 55 55 55 值（这样从信号看起来就是不断变化的0 1 信号），示波器查看结果如下：

此外，有一些波特率是无法使用的比如：10Mhz ,测试显示无信号输出。测试板子上的晶振是 12Mhz 的，可能是因为这个原因，所有有些分频是无法出来的。从上面可以看出， FT232H UART 模式下，最高的有效传输速度可以达到 12Mhz*(8/10)=9 600 000 bits/s = 1.444Mbytes/s。

本文数据根据实验得出，有问题欢迎朋友直接指出共同探讨。

参考：

1. http://ftdichip.cn/Support/Documents/DataSheets/ICs/DS_FT232H.pdf

D3hot 和 D3Cold

从 Windows8 开始，操作系统将设备的 D3 状态分为2种： D3hot 和 D3Cold。

设备可以直接从 D0 状态进入D3Hot，D3Cold 只能从 D3Hot 状态进入。从 D0 到 D3Hot 的状态切换是通过驱动程序来完成的。进入 D3Hot 后，仍然能够在这个设备连接的总线（Bus）上看到这个设备。当这个总线上的设备进入 D3Hot 后，总线必须处于 D0 状态。进入 D3Hot 后，设备可以返回 D0 状态，或者进入 D3Cold 状态。

当设备进入 D3Cold 后，总线上无法检测到这个设备（设备完全断电）。当设备进入 D3Cold 后，它所处的总线可以进入低功耗状态。同时这个设备不会响应总线上的检测动作。进入 D3Cold 后，设备只能返回 D0 状态，不能直接切换为 D3Hot 状态。

参考：

1.https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/device-sleeping-states

2.https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/supporting-d3cold-in-a-driver

3.https://blog.csdn.net/qq_38180524/article/details/106079187

4.http://blog.chinaunix.net/uid-7374279-id-5838168.html

WinDbg 查看OS 版本命令：vertarget

5: kd> vertarget
Windows 10 Kernel Version 19041 MP (8 procs) Free x64
Product: WinNt, suite: TerminalServer SingleUserTS
Edition build lab: 19041.1.amd64fre.vb_release.191206-1406
Machine Name:
Kernel base = 0xfffff805`0da00000 PsLoadedModuleList = 0xfffff805`0e62a2b0
Debug session time: Wed Feb 10 15:55:42.009 2021 (UTC + 8:00)
System Uptime: 7 days 23:02:38.960

参考：

1.https://www.cnblogs.com/yilang/p/12009225.html