1 前言
本文将基于STM32F4 Discovery板,从零开始设计并实现一个USB Audio的例子。
2 设计构思
所谓的USB AUDIO就是制作一个盒子,这个盒子可以通过USB连接到PC,PC端将其识别为Audio设备,然后在PC端播放音乐的时候,声音可以通过盒子播放出来。
2.1 从原理框图开始
如上图所示,我们大概构思一下,为了实现USB AUDIO功能,我们使用一个MCU的USB外设连接PC端,整个流程是这样: PC端播放音乐时,代表音乐的数据流从PC端通过USB传输到MCU端,MCU端然后将其转发给一个外部Codec,最后通过Codec上连接的扬声器或耳机播放音乐。
2.2 硬件支撑
这里选择ST官方的STM32F4-DISCOVERY板来实现,之所以选择这块板子,就是因为其上有USB接口和Codec,正好符合我们设计的要求。
2.2.1 USB接口
如下图为USB接口部分的电路:
这个一个将USB作为OTG的电路设计,在本设计中,我们只是将USB作为device来使用,因此,上图我们关注下面部分就可以了。在本设计中,我们使用到全速USB,从上图可以看出D+与D-引脚分别为PA12,PA11。
2.2.2 Codec部分
如下图所示:
图3
如上图所示,这里的Codec为具体型号为CS43L22,MCU通过I2C接口(PB9,PB6)连接Codec,作为其控制接口,使用I2S(PC7,PC10,PC12,PA4)作为数据通道,此外,MCU使用PD4这个IO管脚控制Codec的reset。CS43L22的14,15脚连接到外面的耳机插孔,也就是说,我们可以通过插入耳机线的方式来收听PC端播放的声音。
2.3 软件设计
为了简化开发流程,这里使用CubeMx自动生成代码工具来生成初始化代码,首先基于Cube库架构以及USB协议栈的特点,我们得先设计一个合理的软件框架。
图4
如上图,蓝色表示的模块为标准模块,不需要我们去修改它,将由CubeMx自动生成,而绿色部分则可能涉及到需要修改,其中BSP部分是需要自己添加的代码,其他的都是由CubeMx生成。
各个模块的工作流程如下设计:
- 初始化流程: 由main开始,它首先对将使用到的外设I2C,I2S初始化,这最终将调到HAL MSP底层部分实现对具体IO管脚和外设的初始化。同时main使用usb description的数据通过调用USB栈初始化接口来完成对USB接口的初始化,这一步还涉及到USB的枚举过程。
- USB数据传输过程:PC端软件在播放音乐后,通过USB通道向MCU传输音频数据,音频数据到达MCU时,首先触发USB中断,然后进入到HAL driver层,在回调到 usb conf模块,接着进入到usb core,usb core再转给usb audio class,最后音频数据到达usb audio interface模块,到达这里,就只剩下对音频数据进行处理了。Usb audio interface模块是一个数据接收到数据处理的一个中间对接模块。
- USB音频数据处理过程: usb audio interface 模块将从USB stack底层传上来的音频数据转发给Codec组件,最终通过Codec组件连接的耳机播放出来。
从以上的音频数据流程来看,最主要的就是usbaudio interface模块,它实现了从USB audio stack到codec驱动的对接。
接下来,我们来看看软件层面上的实现。3 软件实现
还是老办法,采用CubeMx这个工具来生成初始化代码,这样可以节省我们花费在基本外设上的调试初始参数时间。
3.1 创建CubeMx工程
由于我们使用到的硬件平台是STM32F4Discovery板,上面搭载的MCU型号是STM32F407VGT6,我们就以此型号创建一个名为Audio_Test的工程。
pinout:
外设有用到USB_OTG_FS(PA11,PA12device模式),I2C1(PB6,PB9),I2S3(PC12,PA4,PC10,PC7,半双工主模式),此外Codec的reset使用PD4管脚控制,使用外部8M HSE。其pinout如下图所示:
图5
Clock configuration:
图6
时钟树如上设置,主频使用168M,I2S时钟输出初始化为96M。
Configuration:
- HAL层:
Usb_FS:使用默认参数。
I2C:100K速率,7位地址宽度,使用默认参数。
I2S:主发模式,标准16位宽,默认音频为48K,如下图:并为I2S发送添加DMA,半字位宽:
图8
- MiddleWares:
USB选择Audiodevice class,其配置参数如下:
图9
这里都是默认参数。
图10
在描述符参数内得为usb audio class修改两个参数:
- PID得修改为0x5730(否则windows驱动会加载出错)
- 序列号:序列号字符串内不能包含字母,只能是数据(否则windowsaudio驱动在枚举后也不会将音频数据传输下来)。
最后修改工程设置,将堆大小设为4K,栈大小设为1K,如下图:
图11
如此就可以生成工程了,我们生成IAR工程。
3.2 生成的IAR工程介绍
图12
如上图所示,生成的IAR工程,主要有User,Drivers,Middleware3个目录。
- User目录下为用户源码文件,用户的主要修改也将集中在此目录下,在这里,我们的主要工作是集中在usbd_audio_if.c文件,它对应着之前软件框图中的usbaudio interface模块,主要是实现USB audio协议栈与Codec的对接。其他源文件都保持不变就可以了。
- Middlewares目录对应着usb audio stack模块,它由CubeMx自动生成,保持原样就可以,不需要任何修改。
- Drivers目录对应着HAL层,它包含CMSIS,HAL驱动。
3.3 开发
3.3.1 初次编译测试
首先我们不做任何修改,先编译一下工程,发现能顺利编译通过,并烧录进STM32F4DISCOVERY板,运行后通过USB连接上电脑,发现在设备管理器中能正常识别到这个USB AUDIO设备,如下图所示:
图13
这说明,USB与PC端的连接是OK的,但不知道具体有没有数据。我们使用USB分析仪TOTAL PHASE USB480这个设备对USB总线进行数据监控,能够正常采集USB枚举过程和播放音乐的通信数据,如下图所示:
图14
这表明,到目前为止,从PC端到USB端都是能正常工作的,从PC端发送过来的音频数据已经到达usb audio interface模块,目前只不过还没有对这些数据进行处理,显然,接下来的工作,我们就需要将这些音频数据通过codec驱动发送出去,最终到达外部组件CS32L22.
3.3.2 添加codec驱动和audio bsp模块
我们已经知道,我们需要为audio添加BSP模块,在这里,我们将BSP归属于drivers类,因此,在drivers目录下添加BSP目录,通过之前的软件架构图我们可以知道,BSP包含Codec驱动(CS43L22)和Audio bsp模块,因此,我们在BSP目录下有添加了Codec的驱动源码cs43l22.c与bsp_audio.c,如下图所示:
图15
其中cs43l22.c为codec cs32l22的驱动,我们可以从ST的组件驱动中找到它,并copy过来直接使用,不需要修改任何代码。而bsp_audio.c是我们自己写的,它的任务是为usbd_audio_if.c与cs43l22.c提供服务,让这两个模块胜利对接。
3.3.2.1 Codec与HAL的对接
首先我们来看Codec驱动文件cs43l22.c源文件,这个文件需要使用这个外部需要提供的接口:
- AUDIO_IO_Init()
- AUDIO_IO_DeInit()
- AUDIO_IO_Write()
- AUDIO_IO_Read()
这个都是Codec的基本控制接口,是通过I2C来控制的。都是需要用户在驱动外部来提供这些接口给到驱动,于是,我们在bsp_audio.c文件中来提供这个接口的实现:
- //---------------------for c43l22 port--------------------------//
- static void I2Cx_Error(uint8_t Addr)
- {
- /* De-initialize the IOE comunication BUS */
- HAL_I2C_DeInit(&hi2c1);
- /* Re-Initiaize the IOE comunication BUS */
- //I2Cx_Init();
- //MX_I2C1_Init();
- }
- static void CODEC_Reset(void)
- {
- HAL_GPIO_WritePin(AUDIO_RESET_GPIO_Port, AUDIO_RESET_Pin, GPIO_PIN_RESET);
- HAL_Delay(5);
- HAL_GPIO_WritePin(AUDIO_RESET_GPIO_Port, AUDIO_RESET_Pin, GPIO_PIN_SET);
- HAL_Delay(5);
- }
- void AUDIO_IO_Init(void)
- {
- //I2Cx_Init();
- }
- void AUDIO_IO_DeInit(void)
- {
- }
- /**
- * @brief Writes a single data.
- * @param Addr: I2C address
- * @param Reg: Reg address
- * @param Value: Data to be written
- */
- static void I2Cx_Write(uint8_t Addr, uint8_t Reg, uint8_t Value)
- {
- HAL_StatusTypeDef status = HAL_OK;
- status = HAL_I2C_Mem_Write(&hi2c1, Addr, (uint16_t)Reg, I2C_MEMADD_SIZE_8BIT, &Value, 1, I2C_TIMEOUT);
- /* Check the communication status */
- if(status != HAL_OK)
- {
- /* I2C error occured */
- I2Cx_Error(Addr);
- }
- }
- void AUDIO_IO_Write(uint8_t Addr, uint8_t Reg, uint8_t Value)
- {
- I2Cx_Write(Addr, Reg, Value);
- }
- /**
- * @brief Reads a single data.
- * @param Addr: I2C address
- * @param Reg: Reg address
- * @retval Data to be read
- */
- static uint8_t I2Cx_Read(uint8_t Addr, uint8_t Reg)
- {
- HAL_StatusTypeDef status = HAL_OK;
- uint8_t Value = 0;
- status = HAL_I2C_Mem_Read(&hi2c1, Addr, Reg, I2C_MEMADD_SIZE_8BIT, &Value, 1, I2C_TIMEOUT);
- /* Check the communication status */
- if(status != HAL_OK)
- {
- /* Execute user timeout callback */
- I2Cx_Error(Addr);
- }
- return Value;
- }
- uint8_t AUDIO_IO_Read(uint8_t Addr, uint8_t Reg)
- {
- return I2Cx_Read(Addr, Reg);
- }
由于在main函数中已经对I2C初始化过了,因此,在AUDIO_IO_Init函数中不需要再次初始化。
就这样,就完成了Codec驱动与与HAL的对接。3.3.2.2 usb audiointerface与codec的对接
我们打开usb audio interface源码文件usbd_audio.if.c文件,此文件由CubeMx自动生成,已经自动给出了一些关于usb audio class的函数,且这些函数体内容都是空白的,毫无疑问,接下来的工作,我们就是要完成这个空白的内容,就好比做填空题一样,当然,在做这些”填空题”的过程中,我们将使用到Codec驱动提供的接口,这一过程,就是usb audiointerface与codec的对接过程。
按照这一清晰思路,我们首先找到usbd_audio_if.c的一个接口:- static int8_t AUDIO_Init_FS(uint32_t AudioFreq, uint32_t Volume, uint32_t options)
- {
- /* USER CODE BEGIN 0 */
- return (USBD_OK);
- /* USER CODE END 0 */
- }
这是个空白函数,它是在USB枚举结束并收到set_configuration消息时会被调用到,我们利用他来实现对codec的初始化。在bsp_audio.c文件中,我们添加一个函数,如下:
- static void I2Sx_Init(uint32_t AudioFreq)
- {
- /* Initialize the haudio_i2s Instance parameter */
- hi2s3.Instance = SPI3;
- /* Disable I2S block */
- __HAL_I2S_DISABLE(&hi2s3);
- hi2s3.Init.Mode = I2S_MODE_MASTER_TX;
- hi2s3.Init.Standard = I2S_STANDARD;
- hi2s3.Init.DataFormat = I2S_DATAFORMAT_16B;
- hi2s3.Init.AudioFreq = AudioFreq;
- hi2s3.Init.CPOL = I2S_CPOL_LOW;
- hi2s3.Init.MCLKOutput = I2S_MCLKOUTPUT_ENABLE;
- if(HAL_I2S_GetState(&hi2s3) == HAL_I2S_STATE_RESET)
- {
- HAL_I2S_MspInit(&hi2s3);
- }
- /* Init the I2S */
- HAL_I2S_Init(&hi2s3);
- }
- const uint32_t I2SFreq[8] = {8000, 11025, 16000, 22050, 32000, 44100, 48000, 96000};
- const uint32_t I2SPLLN[8] = {256, 429, 213, 429, 426, 271, 258, 344};
- const uint32_t I2SPLLR[8] = {5, 4, 4, 4, 4, 6, 3, 1};
- uint8_t BSP_AUDIO_OUT_Init(uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq)
- {
- uint32_t deviceid = 0x00;
- uint8_t ret = AUDIO_ERROR;
- uint8_t index = 0, freqindex = 0xFF;
- RCC_PeriphCLKInitTypeDef RCC_ExCLKInitStruct;
- //get the according P,N value and set into config,this is for audio clock provide
- for(index = 0; index < 8; index++)
- {
- if(I2SFreq[index] == AudioFreq)
- {
- freqindex = index;
- }
- }
- HAL_RCCEx_GetPeriphCLKConfig(&RCC_ExCLKInitStruct);
- if(freqindex != 0xFF)
- {
- RCC_ExCLKInitStruct.PeriphClockSelection = RCC_PERIPHCLK_I2S;
- RCC_ExCLKInitStruct.PLLI2S.PLLI2SN = I2SPLLN[freqindex];
- RCC_ExCLKInitStruct.PLLI2S.PLLI2SR = I2SPLLR[freqindex];
- HAL_RCCEx_PeriphCLKConfig(&RCC_ExCLKInitStruct);
- }
- else
- {
- RCC_ExCLKInitStruct.PeriphClockSelection = RCC_PERIPHCLK_I2S;
- RCC_ExCLKInitStruct.PLLI2S.PLLI2SN = 258;
- RCC_ExCLKInitStruct.PLLI2S.PLLI2SR = 3;
- HAL_RCCEx_PeriphCLKConfig(&RCC_ExCLKInitStruct);
- }
- //reset the Codec register
- CODEC_Reset();
- deviceid = cs43l22_drv.ReadID(AUDIO_I2C_ADDRESS);
- if((deviceid & CS43L22_ID_MASK) == CS43L22_ID)
- {
- /* Initialize the audio driver structure */
- audio_drv = &cs43l22_drv;
- ret = AUDIO_OK;
- }
- else
- {
- ret = AUDIO_ERROR;
- }
- if(ret == AUDIO_OK)
- {
- audio_drv->Init(AUDIO_I2C_ADDRESS, OutputDevice, Volume, AudioFreq);
- /* I2S data transfer preparation:
- Prepare the Media to be used for the audio transfer from memory to I2S peripheral */
- /* Configure the I2S peripheral */
- I2Sx_Init(AudioFreq);
- }
- return AUDIO_OK;
- }
在BSP_AUDIO_OUT_Init()这个函数内,根据所传入的采样率,程序在预定义的数组内选择出MCU内部时钟树对I2S时钟的一个合理的分频值,并设置进时钟树配置内,然后再对codec进行初始化,最后对I2S外设初始化。
这个选择I2S时钟合理分频值的过程是根据STM32F407的参考手册中的建议来做的,如下参考手册中的28.4.4中表126:
在48K采样率下,假设时钟树下的PLLM VCO=1MHz情况下,且MCK使能,为了尽可能输出靠近期望的时钟,此时应该将时钟树内的PLL2SN设为258,且PLL2SR设为3,I2S内部的预分频因子I2SDIV设为3,以及零散因子I2SODD设为1。这个计算公式为:
也就是(1M*258/3)/[(16*2)*((2*3)+1)]=47991.07142857143,差不多48K。
PLL2SN,与PLL2SR的设置在上述代码中都有所体现,但是,预分频因子I2SDIV和零散因子I2SODD又是在哪里设置的呢?答案是在代码调用HAL_I2S_Init()时,在这个HAL接口内部会根据I2S的Audio Frequency(CubeMx中的I2S的Configuration中配置的参数),以及I2S的输入时钟频率和MCK是否使能这些前提条件来自动计算出预分频因子I2SDIV和零散因子I2SODD的值,以此来尽可能匹配输出想要的位时钟,也对应着采样率48K。
搞懂了这些之后,我们马上将其代码进行对接:- static int8_t AUDIO_Init_FS(uint32_t AudioFreq, uint32_t Volume, uint32_t options)
- {
- /* USER CODE BEGIN 0 */
- BSP_AUDIO_OUT_Init(OUTPUT_DEVICE_AUTO, Volume, AudioFreq);
- return (USBD_OK);
- /* USER CODE END 0 */
- }
接下来下一个需要对接的接口:
- static int8_t AUDIO_DeInit_FS(uint32_t options)
- {
- /* USER CODE BEGIN 1 */
- BSP_AUDIO_OUT_Stop(CODEC_PDWN_SW);
- return (USBD_OK);
- /* USER CODE END 1 */
- }
很明显,这个个反初始化的接口,它的具体实现如下:
- uint8_t BSP_AUDIO_OUT_Stop(uint32_t Option)
- {
- /* Call the Media layer stop function */
- HAL_I2S_DMAStop(&hi2s3);
- /* Call Audio Codec Stop function */
- if(audio_drv->Stop(AUDIO_I2C_ADDRESS, Option) != 0)
- {
- return AUDIO_ERROR;
- }
- else
- {
- if(Option == CODEC_PDWN_HW)
- {
- /* Wait at least 1ms */
- HAL_Delay(1);
- /* Reset the pin */
- //BSP_IO_WritePin(AUDIO_RESET_PIN, RESET);
- HAL_GPIO_WritePin(AUDIO_RESET_GPIO_Port, AUDIO_RESET_Pin, GPIO_PIN_RESET);
- }
- /* Return AUDIO_OK when all operations are correctly done */
- return AUDIO_OK;
- }
- }
先关闭I2S的DMA,在调用Codec的停止接口。
OK,下一个:- static int8_t AUDIO_AudioCmd_FS (uint8_t* pbuf, uint32_t size, uint8_t cmd)
- {
- /* USER CODE BEGIN 2 */
- switch(cmd)
- {
- case AUDIO_CMD_START:
- BSP_AUDIO_OUT_Play((uint16_t *)pbuf, size);
- break;
- case AUDIO_CMD_PLAY:
- BSP_AUDIO_OUT_ChangeBuffer((uint16_t *)pbuf, size);
- break;
- }
- return (USBD_OK);
- /* USER CODE END 2 */
- }
第一次USB audio stack接收到USB OUT数据时会回调这个接口并传入AUDIO_CMD_START参数,这里的处理代码是:
- uint8_t BSP_AUDIO_OUT_Play(uint16_t* pBuffer, uint32_t Size)
- {
- /* Call the audio Codec Play function */
- if(audio_drv->Play(AUDIO_I2C_ADDRESS, pBuffer, Size) != 0)
- {
- return AUDIO_ERROR;
- }
- else
- {
- /* Update the Media layer and enable it for play */
- HAL_I2S_Transmit_DMA(&hi2s3, pBuffer, DMA_MAX(Size/AUDIODATA_SIZE));
- return AUDIO_OK;
- }
- }
很明显,它是调用Codec驱动处理数据,也就是通过I2S的DMA方式发送给Codec。
然后I2S的DMA会产生传输完成中断和半传输完成中断,在这两个中断处理上,会回调到AUDIO_AudioCmd_FS()接口,并且此时传入的参数变为AUDIO_CMD_PLAY,此时,音频数据的处理函数为:- void BSP_AUDIO_OUT_ChangeBuffer(uint16_t *pData, uint16_t Size)
- {
- HAL_I2S_Transmit_DMA(&hi2s3, pData, Size);
- }
也是通过I2S的DMA将数据传输给外部Codec。
上述过程涉及到另外两个usbd_audio_if接口函数,即I2S的DMA半传输完成和传输完成中断回调,如下所示:- void TransferComplete_CallBack_FS(void)
- {
- /* USER CODE BEGIN 7 */
- USBD_AUDIO_Sync(&hUsbDeviceFS, AUDIO_OFFSET_FULL);
- /* USER CODE END 7 */
- }
- void HalfTransfer_CallBack_FS(void)
- {
- /* USER CODE BEGIN 8 */
- USBD_AUDIO_Sync(&hUsbDeviceFS, AUDIO_OFFSET_HALF);
- /* USER CODE END 8 */
- }
此代码为CubeMx自动生成,且在自动生成的代码中就已经调用了usb audio class函数USBD_AUDIO_Sync(),在这里,对于这个,我们是不需要添加任何额外代码的。之前我们说过,在USBD_AUDIO_Sync()函数内部,会实现对AUDIO_AudioCmd_FS()的回调,目的是,需要及时将数据缓冲中另一半准备好的数据也通过I2S的DMA传输给外部Codec,这个不间断的传输,才能实现音频播放的连贯性。
此外,在USB设备端,后续接收到的音频数据会紧接着之前的数据进行存放,这里实现了一个数据环形缓冲区,来实现了USB接收端与I2S输出端数据有效的缓存。
接下来看下一个usbd_audio_if接口函数对接:- static int8_t AUDIO_VolumeCtl_FS (uint8_t vol)
- {
- /* USER CODE BEGIN 3 */
- BSP_AUDIO_OUT_SetVolume(vol);
- return (USBD_OK);
- /* USER CODE END 3 */
- }
很明显,这个是音量控制接口,也对接下:
- uint8_t BSP_AUDIO_OUT_SetVolume(uint8_t Volume)
- {
- /* Call the codec volume control function with converted volume value */
- if(audio_drv->SetVolume(AUDIO_I2C_ADDRESS, Volume) != 0)
- {
- return AUDIO_ERROR;
- }
- else
- {
- /* Return AUDIO_OK when all operations are correctly done */
- return AUDIO_OK;
- }
- }
直接调用Codec启动的相应接口。需要注意地是,实际上,在PC端进行音量的调节,并不会向USB端发送相应的音量调节指令,这里只是象征性的对接下,实际上在USB AUDIO中代码并不会允许到这里,音量的放大和变小直接体现在音频数据本身内。
下一个:- static int8_t AUDIO_MuteCtl_FS (uint8_t cmd)
- {
- /* USER CODE BEGIN 4 */
- BSP_AUDIO_OUT_SetMute(cmd);
- return (USBD_OK);
- /* USER CODE END 4 */
- }
静音控制,其实现为:
- uint8_t BSP_AUDIO_OUT_SetMute(uint32_t Cmd)
- {
- /* Call the Codec Mute function */
- if(audio_drv->SetMute(AUDIO_I2C_ADDRESS, Cmd) != 0)
- {
- return AUDIO_ERROR;
- }
- else
- {
- /* Return AUDIO_OK when all operations are correctly done */
- return AUDIO_OK;
- }
- }
很简单,直接调用codec驱动的静音接口。静音接口与音量控制不同,在PC端进行静音操作会发送相应的mute指令,进而运行到这里。
OK,就这样,usbd_audio_if模块的接口基本上对接到这样就可以了。4 测试验证
将代码编译后烧录进STM32F4DISCVOERY板进行验证。
最终验证是OK的,可以从耳机上听到PC端播放的音乐。
嵌入式学习交流群:561213221
5 结束语
在CubeMx上对中间件USB配置时,将USB audio class的音频采样率设置为48K,那个这个参数会再USB枚举期间会传递给windows的audio驱动,在枚举通过后,后续通过USB传输的音频数据都将是固定以48K采样率来的,也就是192bytes/ms,也就是说,不管PC端播放什么音乐,windows的audio驱动都会固定以48K采样率向USB端口进行传输。这种特性是由windows的audio驱动决定的。
I2S外设向codec传输的时钟是可以改变的,在本应用中是用不着改变,这个是因为USB端固定以48K采样率接收数据,那么I2S也可以固定以48K采样率所对应的速度向Codec传输速度,这个特点,正式因为USB audio的固定传输特性所决定的。若换成播放本地U盘音频文件或连接iPhone并播放iPhone的音乐时,则I2S外设的时钟是根据每次播放的具体音乐所对应的采样率来配置I2S的时钟的,这种机制稍微有所不同,这里只需注意下,理解了就可以了。
在本例中,从I2S传输数据的速率是48K的采样率,但实际精度却是47991.07142857143。这个与标准的48K还是有所偏差的,实际上,无论USB端和I2S端的传输速度在理论上有多匹配,在实际上,多少都会存在些偏差,这也就意味着,在USB与I2S这两个”入口”与”出口”之间的缓存,在随着时间流逝,如不进行任何处理,这个缓存理论上一定会爆掉或掏空。那么这里就需要针对这个缓存这种现象的一种处理,或者叫做算法,算法的好坏在一定程度上决定了音质的好坏。而本例中,我们使用的是CubeMx生成的默认的最简单的算法,我们不做深入讨论,只是让大家有这么一个概念即可。