第七十一章 USB U盘(Host)实验

       本章我们先介绍FATFS这个软件工具，利用它在STM32上实现类似电脑上的文件管理功能，通过USB HOST功能，实现读写U盘/读卡器等大容量USB存储设备。

       本章分为如下几个小节：

       71.1 U盘简介 

       71.2 硬件设计

       71.3 程序设计

       71.4 下载验证

        71.1 U盘简介

       U盘，全称USB闪存盘，英文名“USB flash disk”。它是一种使用USB接口的无需物理驱动器的微型高容量移动存储产品，通过USB接口与主机连接，实现即插即用，是最常用的移动存储设备之一。

       STM32H7R7的USB OTG HS支持U盘，并且ST官方提供了USB HOST大容量存储设备（MSC）例程，ST官方例程路径：光盘→8，STM32参考资料 →1，STM32CubeH7RS固件包 →STM32Cube_FW_H7RS_V1.0.0 →Projects →STM32H7S78-DK →Applications →USB_Host →MSC_RTOS。本实验，我们就要移植该例程到开发板上，以通过STM32H7R7的USB HOST接口，读写U盘或SD卡读卡器等设备。 

        71.2 硬件设计

       1. 例程功能

       本实验代码，开机后，检测字库，然后初始化USB HOST，并不断轮询。当检测并识别U盘后，在LCD上面显示U盘总容量和剩余容量，此时便可以通过USMART调用FATFS相关函数，来测试U盘数据的读写了，方法同FATFS实验一模一样。

       LED0闪烁，提示程序运行。

       2. 硬件资源

       1）LED灯

              LED0 ：LED0 – PD14

              LED1 ：LED1 – PC0

       2）串口1(PB14/PB15连接在板载USB转串口芯片CH340上面)

       3）正点原子2.8/3.5/4.3/7/10寸TFTLCD模块(包括MCU屏和RGB屏,都支持)

       4）HyperRAM芯片

       5)  SD卡，通过SDMMC驱动

       6）USB_HOST接口(D-/D+连接在PM5/PM6上)

       3. 原理图

       本开发板的USB HOST接口采用的是贴片USB母座，它和USB SLAVE的5PIN MiniUSB接头是共用USB_DM和USB_DP信号的，所以USB HOST和USB SLAVE功能不能同时使用。USB HOST和STM32的连接原理图，如下图所示：

图71.2.1 USB母座与STM32的连接电路图

       从上图可以看出，USB HOST和USB Slave共用USB DM/DP信号，通过P11连接到STM32H7R7、所以我们需要通过跳线帽将DM和DP分别连接到HS D-和HS D+，如图71.2.2所示：

图71.2.2 硬件连接示意图

       使用USB HOST驱动外部USB设备的时候，必须要先控制USB_PWR输出1，给外部设备供电，之后才可以识别到外部设备！

        71.3 程序设计 

       71.3.1 程序解析

       这里我们只讲解核心代码，详细的源码请大家参考光盘本实验对应源码。

       本实验，我们在：实验45 图片显示实验上修改，代码移植自ST官方例程：STM32Cube_FW_H7RS_V1.0.0\Projects\STM32H7S78-DK\Applications\USB_Host\MSC_RTOS有了这个官方例程做指引，我们就知道具体需要哪些文件，从而实现本实验。由于官方提供的USB_APP文件不太好用，我们正点原子团队直接编写了一套USB_APP代码，读者可以直接拷贝我们例程中的USB_APP文件夹，即：实验60 USB U盘（Host）实验→Middlewares→USB→USB_APP。

       本实验的具体移植步骤，我们这里就不一一介绍了，最终移植好之后的工程分组截图，如图71.3.2.1所示：

图71.3.2.1 USB U盘(Host)实验工程分组

       上图工程分组中的Middlewares/USB_CORE和Middlewares/USB_CLASS分组下的.c文件，直接拷贝ST官方USB HOST库，我们重点要修改的是USB_APP文件夹下面的代码和FATFS文件夹下面的代码，详细的源码请参考光盘本实验对应的源码。

       1. USB驱动代码

       usbh_conf.c提供了USB主机库的回调及MSP初始化函数，当USB状态机处理完不同事务的时候，会调用这些回调函数，我们通过这些回调函数，就可以知道USB当前状态，比如：是否连接上了？是否断开了？等，根据这些状态，用户应用程序可以执行不同操作，完成特定功能。该.c文件我们重点介绍3个函数，首先是初始化PCD MSP函数，其定义如下：

/**
 * @brief   HAL库HCD初始化MSP函数
 * @param   hpcd: HCD句柄指针
 * @retval  无
 */
void HAL_HCD_MspInit(HCD_HandleTypeDef* hcdHandle)
{
    RCC_PeriphCLKInitTypeDef rcc_periph_clk_init_struct = {0};
    GPIO_InitTypeDef gpio_init_struct = {0};
    
    if(hcdHandle->Instance == USB_OTG_FS)
    {
        /* 配置时钟 */
        rcc_periph_clk_init_struct.PeriphClockSelection = 
RCC_PERIPHCLK_USBOTGFS;
        rcc_periph_clk_init_struct.UsbOtgFsClockSelection = 
RCC_USBOTGFSCLKSOURCE_HSI48;
        HAL_RCCEx_PeriphCLKConfig(&rcc_periph_clk_init_struct);
 
        /* 使能USB电源监测器 */
        HAL_PWREx_EnableUSBVoltageDetector();
        
        /* 使能时钟 */
        __HAL_RCC_USB_OTG_FS_CLK_ENABLE();
        __HAL_RCC_USBPHYC_CLK_ENABLE();
        __HAL_RCC_GPIOM_CLK_ENABLE();
        __HAL_RCC_GPIOF_CLK_ENABLE();
        
        /* 初始化DM、DP引脚 */
        gpio_init_struct.Pin = GPIO_PIN_11 | GPIO_PIN_12;
        gpio_init_struct.Mode = GPIO_MODE_AF_PP;
        gpio_init_struct.Pull = GPIO_NOPULL;
        gpio_init_struct.Speed = GPIO_SPEED_FREQ_HIGH;
        gpio_init_struct.Alternate = GPIO_AF10_OTG_FS;
        HAL_GPIO_Init(GPIOM, &gpio_init_struct);
        
        /* 初始化电源输出配置引脚 */
        HAL_GPIO_WritePin(GPIOF, GPIO_PIN_4, GPIO_PIN_RESET);
        gpio_init_struct.Pin = GPIO_PIN_4;
        gpio_init_struct.Mode = GPIO_MODE_OUTPUT_PP;
        gpio_init_struct.Pull = GPIO_PULLDOWN;
        gpio_init_struct.Speed = GPIO_SPEED_FREQ_LOW;
        HAL_GPIO_Init(GPIOF, &gpio_init_struct);
        
        /* 配置中断 */
        HAL_NVIC_SetPriority(OTG_FS_IRQn, 0, 0);
        HAL_NVIC_EnableIRQ(OTG_FS_IRQn);
    }
}

       HAL_HCD_MspInit函数，用于使能USB时钟，选择内核时钟源，初始化IO口，开启USB供电，设置中断等。该函数在HAL_HCD_Init函数里面被调用。

       接下来介绍的是USB OTG 中断服务函数，其定义如下：

/**
 * @brief   OTG HS中断服务函数
 * @param   无
 * @retval  无
 */
void OTG_HS_IRQHandler(void)
{
    HAL_HCD_IRQHandler(&g_hcd_handle);
}

       OTG_HS_IRQHandler函数，是USB的中断服务函数，通过调用HAL_HCD_IRQHandler函数，实现对USB各种事务的处理。

       最后介绍的是USBH底层初始化函数，其定义如下：

/**
  * @brief  USBH_LL_Init
  *         Initialize the Low Level portion of the Host driver.
  * @param  phost: Host handle
  * @retval USBH Status
  */
USBH_StatusTypeDef USBH_LL_Init(USBH_HandleTypeDef *phost)
{
    HAL_StatusTypeDef hal_status;
    USBH_StatusTypeDef usb_status;
    
    if (phost->id == HOST_HS)
    {
        g_hcd_handle.pData = phost;
        phost->pData = &g_hcd_handle;
        g_hcd_handle.Instance = USB_OTG_HS;
        g_hcd_handle.Init.Host_channels = 16;
        g_hcd_handle.Init.speed = HCD_SPEED_HIGH;
        g_hcd_handle.Init.dma_enable = DISABLE;
        g_hcd_handle.Init.phy_itface = USB_OTG_HS_EMBEDDED_PHY;
        g_hcd_handle.Init.Sof_enable = DISABLE;
        g_hcd_handle.Init.low_power_enable = DISABLE;
        g_hcd_handle.Init.use_external_vbus = DISABLE;
        hal_status = HAL_HCD_Init(&g_hcd_handle);
        usb_status = USBH_Get_USB_Status(hal_status);
        if (usb_status != USBH_OK)
        {
            return usb_status;
        }
        
        USBH_LL_SetTimer(phost, HAL_HCD_GetCurrentFrame(&g_hcd_handle));
    }
    
    return USBH_OK;
}

       USBH_LL_Init函数，用于初始化USB底层设置，比如，使用内部PHY，使用全速模式等，详见以上代码。该函数在USBH_Init函数里面被调用。  

       usbh_disk.c提供U盘和FATFS文件系统之间的输入/输出接口函数，这里总共有5个函数，首先介绍的是初始化USBH函数，其定义如下：

/**
 * @brief   初始化USB磁盘
 * @param   无
 * @retval  初始化结果
 * @arg     0: 成功
 * @arg     1: 失败
 */
uint8_t usbh_disk_init(void)
{
    return 0;
}

       USBH_initialize函数，用于初始化U盘，我们不需要做任何事情，直接返回OK即可。

       下面介绍的是读取USB磁盘函数，其定义如下：

/**
 * @brief   读取USB磁盘
 * @param   buf: 数据
 * @param   address: 地址
 * @param   len: 数据长度
 * @retval  读取结果
 * @arg     0: 成功
 * @arg     1: 失败
 */
uint8_t usbh_disk_read(uint8_t *buf, uint32_t address, uint32_t len)
{
    MSC_HandleTypeDef *msc_handle;
    
    msc_handle = (MSC_HandleTypeDef *)g_usbh_handle.pActiveClass->pData;
if (USBH_MSC_Read(&g_usbh_handle, msc_handle->current_lun, address, buf,
 len) != USBH_OK)
    {
        return 1;
    }
    
    return 0;
}

       usbh_disk_read函数，用于从U盘指定位置，读取指定长度的数据。

       下面介绍的是写入USB磁盘函数，其定义如下：

/**
 * @brief   写入USB磁盘
 * @param   buf: 数据
 * @param   address: 地址
 * @param   len: 数据长度
 * @retval  写入结果
 * @arg     0: 成功
 * @arg     1: 失败
 */
uint8_t usbh_disk_write(uint8_t *buf, uint32_t address, uint32_t len)
{
MSC_HandleTypeDef *msc_handle = (MSC_HandleTypeDef *)g_usbh_handle
.pActiveClass->pData;
    
if (USBH_MSC_Write(&g_usbh_handle, msc_handle->current_lun, address, buf,
 len) != USBH_OK)
    {
        return 1;
    }
    
    return 0;
}

       usbh_disk_write函数，用于往U盘指定位置，写入指定长度的数据。

       最后介绍的是获取U盘磁盘块大小和数量的函数，其定义如下：

/**
 * @brief   获取USB磁盘块大小
 * @param   size: 块大小
 * @retval  获取结果
 * @arg     0: 成功
 * @arg     1: 失败
 */
uint8_t usbh_disk_get_block_size(uint16_t *size)
{
MSC_HandleTypeDef *msc_handle = (MSC_HandleTypeDef *)g_usbh_handle
.pActiveClass->pData;
    MSC_LUNTypeDef msc_lun_struct;
    
if (USBH_MSC_GetLUNInfo(&g_usbh_handle, msc_handle->current_lun, 
&msc_lun_struct) != USBH_OK)
    {
        return 1;
    }
    
    *size = msc_lun_struct.capacity.block_size;
    
    return 0;
}
 
/**
 * @brief   获取USB磁盘块数量
 * @param   count: 块数量
 * @retval  获取结果
 * @arg     0: 成功
 * @arg     1: 失败
 */
uint8_t usbh_disk_get_block_count(uint32_t *count)
{
MSC_HandleTypeDef *msc_handle = (MSC_HandleTypeDef *)g_usbh_handle
.pActiveClass->pData;
    MSC_LUNTypeDef msc_lun_struct;
    
if (USBH_MSC_GetLUNInfo(&g_usbh_handle, msc_handle->current_lun, 
&msc_lun_struct) != USBH_OK)
    {
        return 1;
    }
    
    *count = msc_lun_struct.capacity.block_nbr;
    
    return 0;
}

       usbh_disk_get_block_size和usbh_disk_get_block_count函数，可以用于获取U盘磁盘块大小和磁盘块大数量等信息。

       我们将这5个函数在diskio.c里面和FATFS完成对接，同时需要设置FATFS支持4个磁盘（SD卡、NOR FLASH、SD NAND和U盘），需要在ffconf.h文件里面将FF_VOLUMES的宏定义值改成4，以支持FATFS操作U盘，具体参照例程代码，这里就不再详细介绍了。

       2. main.c代码

       下面是main.c的程序，具体如下：

/* USBH句柄 */
USBH_HandleTypeDef g_usbh_handle;
 
/**
 * @brief   USB用户回调函数
 * @param   phost: 指向USBH句柄的指针
 * @param   id: 事件ID
 * @retval  无
 */
static void usbh_user_process(USBH_HandleTypeDef *phost, uint8_t id)
{
    uint32_t total;
    uint32_t free;
    
    switch(id)
    {
        case HOST_USER_CLASS_ACTIVE:
        {
            LED1(0);
            f_mount(fs[3], "3:", 1);
            text_show_string(30, 110, 200, 16, "U盘连接成功!  ", 16, 0, BLUE);
            if (exfuns_get_free("3:", &total, &free) == 0)
            {
                text_show_string(30, 130, 200, 16,"U盘容量: MB", 16, 0, BLUE);
                text_show_string(30, 150, 200, 16,"U盘可用空间: MB",16,0, BLUE);
                lcd_show_num(102, 130, total >> 10, 5, 16, BLUE);
                lcd_show_num(134, 150, free >> 10, 5, 16, BLUE);
            }
            else
            {
                text_show_string(30, 130, 200, 16,"获取U盘容量失败",16,0, BLUE);
            }
            break;
        }
        case HOST_USER_DISCONNECTION:
        {
            LED1(1);
            f_unmount("3:");
            text_show_string(30, 110, 200, 16, "等待U盘插入...", 16, 0, BLUE);
            lcd_fill(30, 130, 240, 166, WHITE);
            break;
        }
        case HOST_USER_SELECT_CONFIGURATION:
        case HOST_USER_CLASS_SELECTED:
        case HOST_USER_CONNECTION:
        case HOST_USER_UNRECOVERED_ERROR:
        default:
        {
            break;
        }
    }
}
 
int main(void)
{
    uint8_t t = 0;
    
    sys_mpu_config();                   /* 配置MPU */
    sys_cache_enable();                 /* 使能Cache */
    HAL_Init();                         /* 初始化HAL库 */
    sys_stm32_clock_init(300, 6, 2);    /* 配置时钟，600MHz */
    delay_init(600);                    /* 初始化延时 */
    usart_init(115200);                 /* 初始化串口 */
    led_init();                         /* 初始化LED */
    hyperram_init();                    /* 初始化HyperRAM */
    lcd_init();                         /* 初始化LCD */
    usmart_dev.init(300);               /* 初始化USMART */
    my_mem_init(SRAMIN);                /* 初始化AXI-SRAM1~4内存池 */
    my_mem_init(SRAMEX);                /* 初始化XSPI2 HyperRAM内存池 */
    my_mem_init(SRAM12);                /* 初始化AHB-SRAM1~2内存池 */
    my_mem_init(SRAMDTCM);              /* 初始化DTCM内存池 */
    my_mem_init(SRAMITCM);              /* 初始化ITCM内存池 */
    exfuns_init();                      /* 为exfuns申请内存 */
    f_mount(fs[0], "0:", 1);            /* 挂载SD卡 */
    f_mount(fs[1], "1:", 1);            /* 挂载NOR Flash */
    f_mount(fs[2], "2:", 1);            /* 挂载NAND Flash */
    
    /* 检查字库 */
    while (fonts_init() != 0)
    {
        lcd_show_string(30, 30, 200, 16, 16, "Font Error!  ", RED);
        delay_ms(500);
        lcd_show_string(30, 30, 200, 16, 16, "Please Check!", RED);
        delay_ms(500);
    }
    lcd_fill(30, 30, 30 + 200, 30 + 16, WHITE);
    
    text_show_string(30, 50, 200, 16, "STM32", 16, 0, RED);
    text_show_string(30, 70, 200, 16, "USB U盘(Host)实验", 16, 0, RED);
    text_show_string(30, 90, 200, 16, "ATOM@ALIENTEK", 16, 0, RED);
    text_show_string(30, 110, 200, 16, "等待U盘插入...", 16, 0, BLUE);
    
    USBH_Init(&g_usbh_handle, usbh_user_process, HOST_HS);
    USBH_RegisterClass(&g_usbh_handle, USBH_MSC_CLASS);
    USBH_Start(&g_usbh_handle);
    
    while (1)
    {
        USBH_Process(&g_usbh_handle);
        
        if (++t == 20)
        {
            t = 0;
            LED0_TOGGLE();
        }
        
        delay_ms(10);
    }
}

       其中，USBH_HandleTypeDef是一个用于USB主机类通信处理的结构体类型，它包含了USB主机通信的各种变量、结构体参数、传输状态和管道信息等。凡是USB主机类通信，都必须要用定义一个这样的结构体，这里定义成：g_usbh_handle。

       同USB Device类通信类似，USB Host的初始化过程如下：

       1， 调用USBH_Init函数，初始化USB主机内核；

       2， 调用USBH_RegisterClass函数，链接MSC主机类驱动程序到主机内核； 

       3， 调用USBH_Start函数，启动USB通信；

       经过以上三步处理，USB主机就启动了，所有USB事务，都是通过USB中断触发，并由USB驱动库自动处理。USB中断服务函数在usbh_conf.c里面：

/**
 * @brief   OTG HS中断服务函数
 * @param   无
 * @retval  无
 */
void OTG_HS_IRQHandler(void)
{
    HAL_HCD_IRQHandler(&g_hcd_handle);
}

       该函数调用HAL_HCD_IRQHandler函数来处理各种USB中断请求。 

       整个main函数代码比较简单，不过我们在main函数里面，必须不停的调用：USBH_Process函数，该函数用于实现USB主机通信的核心状态机处理，该函数必须在主函数里面被循环调用，而且调用频率得比较快才行（越快越好），以便及时处理各种事务。

       USBH_MSC_Process函数是USB主机用户处理回调函数，参数id表示USB主机当前的一些状态，总共有6种状态：

#define HOST_USER_SELECT_CONFIGURATION   0x01U   /* USB进入配置状态 */
#define HOST_USER_CLASS_ACTIVE           0x02U   /* USB初始化配置完成 */
#define HOST_USER_CLASS_SELECTED         0x03U   /* USB选择了一个类 */
#define HOST_USER_CONNECTION             0x04U   /* USB连接成功 */
#define HOST_USER_DISCONNECTION          0x05U   /* USB连接断开 */
#define HOST_USER_UNRECOVERED_ERROR      0x06U   /* USB发生了不可恢复错误 */

       本例程我们只用了：HOST_USER_DISCONNECTION和HOST_USER_CLASS_ACTIVE两个状态。程序运行后，如果没有U盘插入，则不会执行到USBH_MSC_Process函数，当插入U盘，并成功识别之后，USBH_MSC_Process函数会进入：HOST_USER_CLASS_ACTIVE状态，我们就可以挂载U盘，并显示容量等信息，表示U盘识别完成。此时，如果我们把U盘拔出，则会进入：HOST_USER_DISCONNECTION状态，表示U盘拔出，我们取消U盘的挂载，并显示设备连接中…（表示当前正在连接设备）。 

       最后，我们需要将FATFS相关测试函数(mf_open/ mf_close等函数)，加入USMART管理，这里和FATFS实验一模一样，可以参考该实验的方法操作。

        71.4 下载验证

       将程序下载到开发板后，然后在USB_HOST端子插入U盘/读卡器（带卡），注意：此时USB SLAVE口不要插USB线到电脑，否则会干扰！

       等U盘成功识别后，便可以看到LCD显示U盘容量等信息，如图71.4.1所示：

图71.4.1 U盘识别成功

       此时，我们便可以通过USMART来测试U盘读写了，如图71.4.2和图71.4.3所示：

图71.4.2 测试读取U盘读取

图71.4.3 测试U盘写入

       图71.4.2分别是通过发送：mf_scan_files("3:")和mf_scan_files("3:/PICTURE")，扫描U盘根目录所有文件和PICTURE目录下的所有文件，说明读U盘是没问题的。

       图71.4.3通过发送：mf_open("3:test u disk.txt",7)，在U盘根目录创建test u disk.txt这个文件，然后发送：mf_write("这是一个测试，写入文件",0x16)，写入“这是一个测试，写入文件”到这个文件里面，然后发送：mf_close()，关闭文件，完成一次文件创建。最后，发送：mf_scan_files("3:")，扫描U盘根目录文件，发现比图71.4.3所示多出了一个test u disk.txt的文件，说明U盘写入成功。

       这样，就完成了本实验的设计目的：实现U盘的读写操作。最后，大家还可以调用其他函数，实现相关功能测试，这里就不给大家一一演示了。