diff --git a/en/device-dev/driver/Readme-EN.md b/en/device-dev/driver/Readme-EN.md index c2c3dea84dfb01310ae917c9d6c60dd2c5a1e672..437ecdd6858311575d67bf94c48af921180d2005 100644 --- a/en/device-dev/driver/Readme-EN.md +++ b/en/device-dev/driver/Readme-EN.md @@ -31,7 +31,8 @@ - [PWM](driver-platform-pwm-des.md) - [Peripheral Driver Usage](driver-peripherals.md) - [LCD](driver-peripherals-lcd-des.md) - - [TOUCHSCREEN](driver-peripherals-touch-des.md) + - [Touchscreen](driver-peripherals-touch-des.md) - [Sensor](driver-peripherals-sensor-des.md) - [WLAN](driver-peripherals-external-des.md) + - [Audio](driver-peripherals-audio-des.md) - [USB](driver-peripherals-usb-des.md) \ No newline at end of file diff --git a/en/device-dev/driver/driver-peripherals-audio-des.md b/en/device-dev/driver/driver-peripherals-audio-des.md new file mode 100644 index 0000000000000000000000000000000000000000..7529e34c2392c6661ec30ce34b2f62aead119457 --- /dev/null +++ b/en/device-dev/driver/driver-peripherals-audio-des.md @@ -0,0 +1,1408 @@ +# Audio + +- **[Audio Driver Overview](#section1000)** + +- **[Audio Driver Architecture](#section2000)** + +- **[Audio Driver Development](#section3000)** + + - **[Audio ADM Architecture](#section3100)** + - [Startup Process](#section3111) + - [Playback Process](#section3112) + - [Control Process](#section3113) + + - **[Audio Driver Development Procedure](#section3200)** + - [Development on an Adapted Platform](#section3221) + - [Development on a New Platform](#section3222) + +- **[Audio Driver Development Examples](#section4000)** + - [Codec Driver Development Example](#section4100) + - [Filling in Codec Data Structures](#section4111) + - [Initializing the Codec Device and Codec DAI Device](#section4112) + - [Implementing the Codec Operation Function Set](#section4113) + - [Registering and Binding Codec to HDF](#section4114) + - [Configuring HCS](#section4115) + - [Accessory Driver Development Example](#section4200) + - [Filling in Accessory Data Structures](#section4221) + - [Initializing the Accessory Device and Accessory DAI Device](#section4222) + - [Implementing the Accessory Operation Function Set](#section4223) + - [Registering and Binding Accessory to HDF](#section4224) + - [Configuring HCS](#section4225) + - [Platform Driver Development Example](#section4300) + - [Filling in Platform Data Structures](#section4331) + - [Initializing the DMA Device](#section4332) + - [Implementing the DMA Operation Function Set](#section4333) + - [Registering and Binding Platform to HDF](#section4334) + - [Configuring HCS](#section4335) + - [DAI Driver Development Example](#section4400) + - [Filling in DAI Data Structures](#section4441) + - [Initializing the DAI Device](#section4442) + - [Implementing the DAI Operation Function Set](#section4443) + - [Registering and Binding DAI to HDF](#section4444) + - [Configuring HCS](#section4445) + - [Adding Compilation Configuration to Makefile](#section4500) + - [Source Code Structure and Directory](#section4600) + +- **[HAL-based Development Procedure and Example](#section5000)** + - [Development Procedure](#section5100) + - [Development Example](#section5200) + +- **[Summary](#section9999)** + +# Audio Driver Overview + +A multimedia system is an indispensable part in Internet of Things (IoT) devices. Audio is an important module of the multimedia system, and building an audio driver model is particularly important in device development. + +This document describes the audio driver architecture and functional modules and how to develop audio drivers based on the Hardware Driver Foundation (HDF). Chip vendors can develop their own drivers and invocation of Hardware Abstraction Layer (HAL) APIs based on the driver architecture. + + + +# Audio Driver Architecture + +The audio driver architecture is implemented based on the [HDF](https://device.harmonyos.com/en/docs/documentation/guide/driver-hdf-overview-0000001051715456). The audio driver architecture is as follows: +![](figures/Audio_architecture.png) + +The driver architecture consists of the following: +- Hardware Device Interface (HDI) adapter: implements the audio HAL driver (HDI adaptation) and provides hardware driver capability interfaces for the audio service (frameworks). The HDI adapter provides interface objects such as Audio Manager, Audio Adapter, Audio Control, Audio Capture, and Audio Render. +- Audio Interface Lib: works with the Audio Driver Model (ADM) in the kernel to control audio hardware, read recording data, and write playback data. The **Stream_ctrl_common** in the Audio Interface Lib interacts with the audio HDI adapter layer. +- ADM: helps system developers to develop scenario-specific applications for the multimedia audio subsystem. With the ADM, codec and DSP device vendors can adapt their driver code based on the unified interfaces provided by the ADM and implement quick development and easy adaptation to the OpenHarmony system. +- Audio Control Dispatch: dispatches the control instructions from the Audio Interface Lib to the driver layer. +- Audio Stream Dispatch: dispatches the data from the Audio Interface Lib to the driver layer. + +- Card Manager: manages multiple audio adapters. Each audio adapter consists of the digital audio interface (DAI), platform, codec, accessory, DSP, and Smart Audio Power Manager (SAPM) modules. +- Platform Drivers: implement driver adaptation. +- SAPM: optimizes the power consumption policy of the ADM. + +# Audio Driver Development + +The following uses the Hi3516D V300 as an example to describe how to develop drivers based on the audio driver architecture. + +## Audio ADM Architecture +The audio driver provides the **hdf_audio_render**, **hdf_audio_capture**, and **hdf_audio_control** services for the HDI layer. The driver service nodes in the **dev** directory of the development board are as follows: + +```c +# ls -l hdf_audio* +crw-rw---- 1 system system 248, 6 1970-01-01 00:00 hdf_audio_capture // Voice recording service. +crw-rw---- 1 system system 248, 4 1970-01-01 00:00 hdf_audio_codec_dev0 // Name of audio adapter 0. +crw-rw---- 1 system system 248, 4 1970-01-01 00:00 hdf_audio_codec_dev1 // Name of audio adapter 1. +crw-rw---- 1 system system 248, 5 1970-01-01 00:00 hdf_audio_control // Audio control service. +crw-rw---- 1 system system 248, 7 1970-01-01 00:00 hdf_audio_render // Audio playback service. +``` + +The audio adapters have the following driver services: + +hdf\_audio\_codec\_dev0 +- **dma\_service\_0**: direct memory access (DMA) service +- **dai_service**: CPU DAI service +- **codec\_service\_0**: codec service (built-in codec) +- **dsp\_service\_0**: DSP service (optional) + +hdf\_audio\_codec\_dev1 +- **dma\_service\_0**: DMA service +- **dai_service**: CPU DAI service +- **codec\_service\_1**: accessory service (SmartPA) +- **dsp\_service\_0**: DSP service (optional) + +### Startup Process + +![](figures/ADM_startup_flowchart.png) + +1. When the system starts, the platform, codec, accessory, DSP, and DAI drivers of the audio module are loaded first. Each driver obtains the configuration information from its configuration file and saves the obtained information to the data structures. + +2. Each driver module calls the ADM registration interface to add itself to the linked list of the driver module. + +3. The ADM obtains the hdf_audio_driver_0 and hdf_audio_driver_1 configuration and loads the devices of each module. + +4. The ADM module initializes each module device by calling the initialization API of the respective module. + +5. The initialized audio devices are added to the cardManager linked list. + +### Playback Process +![=](figures/ADM_playback_flowchart.png) +1. The Audio Interface Lib sends the **Render Open** instruction to the Audio Stream Dispatch service. The Audio Stream Dispatch service calls the API of each module to deliver the instruction. + +2. The Audio Interface Lib sends a path select instruction to the Control Dispatch service. The Control Dispatch service calls the DAI API to set the path. + +3. The Audio Interface Lib sends hardware parameters to the Audio Stream Dispatch service. The Audio Stream Dispatch service calls the API of each module to set the hardware parameters. + +4. The Audio Interface Lib sends the start playing instruction to the Audio Stream Dispatch service. The Audio Stream Dispatch service calls the API of each module to perform related settings for each module. + +5. The Audio Interface Lib sends audio data to the Audio Stream Dispatch service. The Audio Stream Dispatch service calls the **Platform AudioPcmWrite** API to send the audio data to DMA. + +6. The Audio Interface Lib sends the stop playing instruction to the Audio Stream Dispatch service. The Audio Stream Dispatch service calls the stop API of each module to perform related stop settings for each module. + +7. The Audio Interface Lib sends the **Render Close** instruction to the Audio Stream Dispatch service. The Audio Stream Dispatch service calls the **Platform AudioRenderClose** API to release resources. + +### Control Process + +![](figures/ADM_control_flowchart.png) + +1. When the volume needs to be adjusted, the Audio Interface Lib sends an instruction for obtaining the volume range to the Control Dispatch service. The Control Dispatch service parses the instruction and calls **get()** of the codec module to obtain the volume range. +2. The Audio Interface Lib sends an instruction for setting the volume to the Control Dispatch service. The Control Dispatch service parses the instruction and calls **Set()** of the codec module to set the volume. + +## Audio Driver Development Procedure + +### Development on an Adapted Platform + +The following figure shows the process for developing the codec or accessory (SmartPA) driver on a chip platform (Hi3516D V300) to which the ADM has adapted. + +![](figures/development_flowchart_1.png) + +1. Add register information to the private HDF configuration source (HCS) of the codec or SmartPA based on the chip description. + + If the workflow of the newly added codec or SmartPA is the same as that of the existing codec or SmartPA, you do not need to implement the operation function set or configure the compilation file for the newly added codec or SmartPA. + +2. Perform build, debugging, and testing. + +### Development on a New Platform + +The following figure shows the driver development process if the ADM has not adapted to the platform. + +![](figures/development_flowchart_2.png) + +The codec (optional), DAI, DMA, DSP (optional), and SmartPA (optional) modules of the audio adapter need to be adapted to the new platform. + +1. Add register information of each module driver to the private configuration file of the respective module according to the chip description. + +2. Implement the operation function set of each module. + +3. Modify the compilation file of the audio module. + +4. Perform build, debugging, and testing. + + + +# Audio Driver Development Examples + +Code path: **drivers/peripheral/audio** + +The following uses Hi3516D V300 as an example to describe how to develop the audio codec driver, accessory driver, DAI driver, and platform driver. + +## Codec Driver Development Example +Code path: **drivers/peripheral/audio/chipsets/hi3516dv300/codec** + +The major steps for developing the codec driver are as follows: +1. Define and fill in a codec instance. +2. Implement callbacks for the codec instance. +3. Register and bind the codec instance to the HDF. +4. Configure the HCS and makefile. + +### Filling in Codec Data Structures + +Fill in the following data structures for the codec module: + +- **g_codecData**: operation function set and private data set of the codec device. + +- **g_codecDaiDeviceOps**: codec DAI device operation function set, including APIs for starting transmission and setting parameters. + +- **g_codecDaiData**: operation function set and private data set of the digital audio interface of the codec. + +```c +struct CodecData g_codecData = { + .Init = CodecDeviceInit, // Initialize the codec device (need to be implemented for a new platform). + .Read = AudioDeviceReadReg, // Read the register (already implemented in the existing framework and no adaptation needed). + .Write = AudioDeviceWriteReg, // Write the register (already implemented in the existing framework and no adaptation needed). +}; + +struct AudioDaiOps g_codecDaiDeviceOps = { + .Startup = CodecDaiStartup, // Start transmission (need to be implemented for a new platform). + .HwParams = CodecDaiHwParams, // Set parameters (need to be implemented for a new platform). +}; + +struct DaiData g_codecDaiData = { + .DaiInit = CodecDaiDeviceInit, // Initialize the codec DAI device (need to be implemented for a new platform). + .ops = &g_codecDaiDeviceOps, // codec DAI device operation function set. +}; +``` + +### Initializing the Codec Device and Codec DAI Device + +**CODECDeviceInit** sets audio input/audio output (AIAO), initializes registers, inserts **g_audioControls** into the controller linked list, initializes the power management, and selects a path. + +```c +int32_t CodecDeviceInit(struct AudioCard *audioCard, struct CodecDevice *codec) +{ + ... + /* Register set() and get() of the AIAO module on the Hi3516 platform. */ + CodecSetCtlFunc(codec->devData, AudioCodecAiaoGetCtrlOps, AudioCodecAiaoSetCtrlOps) + ... + /* Hi3516 codec register IoRemap */ + CodecHalSysInit(); + ... + /* Initialize the codec registers of the Hi3516 platform. */ + CodecRegDefaultInit(codec->devData->regCfgGroup); + ... + /* Insert g_audioControls of the Hi3516 platform to the controller linked list. */ + AudioAddControls(audioCard, codec->devData->controls, codec->devData->numControls); + ... + /* Load the codec of the Hi3516 platform to the SAPM. */ + AudioSapmNewComponents(audioCard, codec->devData->sapmComponents, codec->devData->numSapmComponent); + ... + /* Insert the codec of the Hi3516 platform to the audioRoutes linked list. */ + AudioSapmAddRoutes(audioCard, g_audioRoutes, HDF_ARRAY_SIZE(g_audioRoutes); + ... + AudioSapmNewControls(audioCard); + ... + /* Hi3516 codec power management */ + AudioSapmSleep(audioCard); + ... + return HDF_SUCCESS; +} +``` + +**CodecDaiDeviceInit** initializes the codec DAI device. This API is not used on the Hi3516 and is reserved. + +```c +int32_t CodecDaiDeviceInit(struct AudioCard *card, const struct DaiDevice *device) + +{ + ... + AUDIO_DRIVER_LOG_DEBUG("codec dai device name: %s\n", device->devDaiName); + (void)card; + return HDF_SUCCESS; +} +``` + +### Implementing the Codec Operation Function Set + +The codec module is encapsulated with the **read()** and **write()** functions of the read and write registers at the operating system abstraction layer (OSAL). + +If the new platform cannot use the OSAL **read()** and **write()** functions to operate registers, you should implement them. + +```c +int32_t AudioDeviceReadReg(unsigned long virtualAddress, uint32_t reg, uint32_t *val) +{ + ... + *val = OSAL_READL((void *)((uintptr_t)(virtualAddress + reg))); + return HDF_SUCCESS; +} + +int32_t AudioDeviceWriteReg(unsigned long virtualAddress, uint32_t reg, uint32_t value) +{ + OSAL_WRITEL(value, (void *)((uintptr_t)(virtualAddress + reg))); + return HDF_SUCCESS; +} +``` + +**CodecDaiStartup** completes startup settings. + +```c +int32_t CodecDaiStartup(const struct AudioCard *card, const struct DaiDevice *device) +{ + int32_t ret; + ... + (void)card; + ret = CodecSetAdcTuneEnable(device->devData->regCfgGroup); + ... + return HDF_SUCCESS; +} +``` + +**CodecDaiHwParams** sets parameters, including the sampling rate and bit width. + +```c +int32_t CodecDaiHwParams(const struct AudioCard *card, const struct AudioPcmHwParams *param) +{ + unsigned int bitWidth; + struct CodecDaiParamsVal codecDaiParamsVal; + ... + int ret = AudioFramatToBitWidth(param->format, &bitWidth); + ... + codecDaiParamsVal.frequencyVal = param->rate; + codecDaiParamsVal.formatVal = bitWidth; + ret = CodecDaiParamsUpdate(card->rtd->codecDai->devData->regCfgGroup, codecDaiParamsVal); + ... + return HDF_SUCCESS; +} +``` + +### Registering and Binding Codec to HDF + +This process depends on the driver implementation mode of the HDF. For details, see [HDF](https://gitee.com/openharmony/docs/blob/master/en/device-dev/driver/driver-hdf.md). + +Fill in the **g_codecDriverEntry** structure. Ensure that the value of **moduleName** is the same as that in **device_info.hcs**. Implement the pointers to the **Bind**, **Init**, and **Release** functions. + +drivers/peripheral/audio/chipsets/hi3516dv300/codec/src/hi3516_codec_adapter.c + +```c +struct HdfDriverEntry g_codecDriverEntry = { + .moduleVersion = 1, + .moduleName = "CODEC_HI3516", + .Bind = CodecDriverBind, + .Init = CodecDriverInit, + .Release = CodecDriverRelease, +}; +HDF_INIT(g_codecDriverEntry); +``` + +**CodecDriverBind** binds the device in the HDF to the codec and registers the codec service with the HDF. + +```c +static int32_t CodecDriverBind(struct HdfDeviceObject *device) +{ + struct CodecHost *codecHost = (struct CodecHost *)OsalMemCalloc(sizeof(*codecHost)); + ... + codecHost->device = device; + device->service = &codecHost->service; + return HDF_SUCCESS; +} +``` + +**CodecDriverInit** obtains the codec service name and private register configuration, and inserts them into the linked list by using **AudioRegisterCodec**. + +```c +static int32_t CodecDriverInit(struct HdfDeviceObject *device) +{ + ... + CodecGetConfigInfo(device, &g_codecData); + CodecSetConfigInfo(&g_codecData, &g_codecDaiData); + CodecGetServiceName(device, &g_codecData.drvCodecName); + CodecGetDaiName(device, &g_codecDaiData.drvDaiName); + AudioRegisterCodec(device, &g_codecData, &g_codecDaiData); + ... + return HDF_SUCCESS; +} +``` + +**CodecDriverRelease** releases driver resources. + +```c +static void CodecDriverRelease(struct HdfDeviceObject *device) +{ + codecHost = (struct CodecHost *)device->service; + OsalMemFree(codecHost); +} +``` + +### Configuring HCS + +Configure the driver node, loading sequence, and service name in the .hcs file. For details about the HCS syntax, see [Driver Configuration Management](https://gitee.com/openharmony/docs/blob/master/en/device-dev/driver/driver-hdf-manage.md) in the HDF. + +Path of the standard-system configuration file: + +**vendor/hisilicon/Hi3516DV300/hdf_config/khdf/** + +Path of the small-system configuration file: + +**vendor/hisilicon/hispark_taurus/hdf_config/** + +**Configuring Codec Device Information in device_info.hcs** + +Add codec node configuration. Modify **moduleName** in the configuration file. The value must be the same as **moduleName** in the **HdfDriverEntry** structure. Generally, the value should present the hardware platform, for example, **moduleName = "CODEC_HI3516"**. + +The code snippet is as follows: + +```c + audio :: host { + device_codec :: device { + device0 :: deviceNode { + policy = 1; // The codec module provides services only for the kernel. + priority = 50; // The codec module must be loaded before the load of the HDF_AUDIO module. + preload = 0; + permission = 0666; + moduleName = "CODEC_HI3516"; // The value must be the same as moduleName in HdfDriverEntry. + serviceName = "codec_service_0"; // Name of the service provided externally. + deviceMatchAttr = "hdf_codec_driver"; // Name of the private attribute, which is used to match the corresponding private data (including the register configuration). + } + } +``` + +**Configuring Dependencies in audio_config.hcs** + +Configure dependencies between the codec, platform, DAI, DSP, and accessory for the audio adapters. + +The code snippet is as follows: + +```c +root { + platfrom { + ... + controller_0x120c1001 :: card_controller { + // Set the private data attribute name, which must be the same as deviceMatchAttr in device_info.hcs. + match_attr = "hdf_audio_driver_1"; + serviceName = "hdf_audio_smartpa_dev0"; // Name of the service provided externally. + accessoryName = "codec_service_1"; // External codec service name. + platformName = "dma_service_0"; // DMA service. + cpuDaiName = "dai_service"; // CPU DAI service. + accessoryDaiName = "accessory_dai"; // External DAI. + dspName = "dsp_service_0"; // DSP service name. + dspDaiName = "dsp_dai"; // DSP DAI. + } + } +} +``` + +**Configuring Private Registers in codec_config.hcs** + +The configuration matches **deviceMatchAttr** of the codec configured in **device_info.hcs**. It includes the register configuration. + +Binding the control functionality configuration is to configure the control functionalities and their register parameters in the .hcs file according to unified structure specifications. The configuration can be obtained and parsed, and added to the controller linked list. + +- **regConfig**: register and control functionality configuration + +- **ctrlParamsSeqConfig**: control functionality register configuration + +- **daiStartupSeqConfig**: DAI startup configuration + +- **daiParamsSeqConfig**: playback parameter configuration + +- **resetSeqConfig**: reset process register configuration + +- **initSeqConfig**: initialization process register configuration + +- **controlsConfig**: control functionality configuration. The **array index** (specific service scenario) and **iface** (same as the HAL) are of fixed values. + +``` +array index +0: Main Playback Volume +1: Main Capture Volume +2: Playback Mute +3: Capture Mute +4: Mic Left Gain +5: Mic Right Gain +6: External Codec Enable +7: Internally Codec Enable +8: Render Channel Mode +9: Capture Channel Mode +iface +0: virtual dac device +1: virtual adc device +2: virtual adc device +3: virtual mixer device +4: Codec device +5: PGA device +6: AIAO device +``` + +**ctrlParamsSeqConfig**: control functionality register configuration. The sequence of the configuration items is the same as that in **controlsConfig**, indicating the register configuration corresponding to a functionality. + +```c + root { + platfrom { + template codec_controller { + match_attr = ""; + serviceName = ""; + codecDaiName = ""; + } + controller_0x120c1030 :: codec_controller { + match_attr = "hdf_codec_driver"; + serviceName = "codec_service_0"; + codecDaiName = "codec_dai"; + + /* Base address of the Hi3516 register*/ + idInfo { + chipName = "hi3516"; // Codec name + chipIdRegister = 0x113c0000; // Codec base address + chipIdSize = 0x1000; // Codec address offset + } + + /* Register configuration, including configuration of registers */ + regConfig { + /* reg: register address + rreg: register address + shift: shift bits + rshift: rshift bits + min: min value + max: max value + mask: mask of value + invert: enum InvertVal 0-uninvert 1-invert + value: value + */ + + /* reg, value */ + initSeqConfig = [ + 0x14, 0x04000002, + 0x18, 0xFD200004, + 0x1C, 0x00180018, + 0x20, 0x83830028, + 0x24, 0x00005C5C, + 0x28, 0x00130000, + 0x30, 0xFF035A00, + 0x34, 0x08000001, + 0x38, 0x06062424, + 0x3C, 0x1E1EC001, + 0x14, 0x04000002 + ]; + + /* Control functionality configuration + array index, iface, enable*/ + controlsConfig = [ + 0, 0, 0, + 1, 1, 1, + 2, 0, 1, + 3, 1, 1, + 4, 2, 1, + 5, 2, 1, + 8, 6, 0, + 9, 6, 0, + ]; + /* Control functionality register configuration + reg, rreg, shift, rshift, min, max, mask, invert, value */ + ctrlParamsSeqConfig = [ + 0x3c, 0x3c, 24, 24, 0x0, 0x57, 0x7F, 1, 0, //"Main Capture Volume" + 0x38, 0x38, 31, 31, 0x0, 0x1, 0x1, 0, 0, //"Playback Mute" + 0x3c, 0x3c, 31, 31, 0x0, 0x1, 0x1, 0, 0, //"Capture Mute" + 0x20, 0x20, 16, 16, 0x0, 0xF, 0x1F, 0, 0, //"Mic Left Gain" + 0x20, 0x20, 24, 24, 0x0, 0xF, 0x1F, 0, 0, // "Mic Right Gain" + 0x2000, 0x2000, 16, 16, 0x0, 0x7, 0x7, 0, 0, // "Render Channel Mode" + 0x1000, 0x1000, 16, 16, 0x0, 0x7, 0x7, 0, 0 // "Capture Channel Mode" + ]; + + /* After the upper layer delivers parameters, write audio-related data to registers. + reg, rreg, shift, rshift, min, max, mask, invert, value */ + daiParamsSeqConfig = [ + 0x30, 0x30, 13, 13, 0x0, 0x1F, 0x1F, 0, 0x0, // i2s_frequency + 0x1C, 0x1C, 6, 6, 0x0, 0x3, 0x3, 0, 0x0, // adc_mode_sel + 0x30, 0x30, 22, 22, 0x0, 0x3, 0x3, 0, 0x0, // i2s_datawith + ]; + + /* Configuration of the power management function register. + reg, rreg, shift, rshift, min, max, mask, invert, value */ + ctrlSapmParamsSeqConfig = [ + 0x20, 0x20, 23, 23, 0x0, 0x1, 0x1, 0, 0, //LPGA MIC 0 -- connect MIC + 0x20, 0x20, 31, 31, 0x0, 0x1, 0x1, 0, 0, //RPGA MIC 0 -- connect MIC + 0x30, 0x30, 27, 27, 0x0, 0x1, 0x1, 0, 0, //dacl to dacr mixer + 0x30, 0x30, 26, 26, 0x0, 0x1, 0x1, 0, 0 //dacr to dacl mixer + ]; + + /* + Power management component configuration + componentName: function name, {"ADCL", "ADCR", "DACL", "DACR", "LPGA", "RPGA", "SPKL", "SPKR", "MIC"} array index. + sapmType,compNameIndex,reg, mask,shift,invert, kcontrolNews,kcontrolsNum + */ + sapmComponent = [ + 10, 0, 0x20, 0x1, 15, 1, 0, 0, //ADCL + 10, 1, 0x20, 0x1, 14, 1, 0, 0, //ADCR + 11, 2, 0x14, 0x1, 11, 1, 0, 0, //DACL + 11, 3, 0x14, 0x1, 12, 1, 0, 0, //DACR + 8, 4, 0x20, 0x1, 13, 1, 1, 1, //LPGA + 8, 5, 0x20, 0x1, 12, 1, 2, 1, //RPGA + 15, 6, 0, 0x1, 0, 0, 3, 1, //SPKL + 15, 7, 0, 0x1, 0, 0, 4, 1, //SPKR + 0, 8, 0, 0x1, 0, 0, 0, 0 //MIC + ]; + + /* Power management function configuration + array index, iface, enable + */ + sapmConfig = [ + 0, 5, 1, + 1, 5, 1, + 2, 0, 1, + 3, 0, 1 + ]; + } + } + } +} +``` + +Read the .hcs files in the C code to obtain register configuration. + +```c +static int32_t CodecDriverInit(struct HdfDeviceObject *device) +{ + ... + CodecGetConfigInfo(device, &g_codecData) ; + CodecSetConfigInfo(&g_codecData, &g_codecDaiData); + ... + return HDF_SUCCESS; +} +``` + +When the codec is registered, the input parameter **device** contains controller_0x120c1030 node information. You only need to parse the node to obtain the configuration information. + +```c +int32_t CodecGetConfigInfo(const struct HdfDeviceObject *device, struct CodecData *codecData) +{ + codecData->regConfig = (struct AudioRegCfgData *)OsalMemCalloc(sizeof(*(codecData->regConfig))); + CodecGetRegConfig(device, codecData->regConfig); + return HDF_SUCCESS; +} +``` + +Obtain the node configuration to configure the node. + +```c +int32_t CodecGetRegConfig(const struct HdfDeviceObject *device, struct AudioRegCfgData *configData) +{ + ... + drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); + ... + idNode = drsOps->GetChildNode(root, "idInfo"); + ParseAudioAttr(drsOps, idNode, &configData->audioIdInfo); + regCfgNode = drsOps->GetChildNode(root, "regConfig"); + ... + DEV_RES_NODE_FOR_EACH_ATTR(regCfgNode, regAttr) { + ... + return HDF_SUCCESS; +} +``` + +Obtain and use the configuration of the **regConfig** node. After the configuration files are parsed, the register information in the code can be directly updated. + +```c +int32_t CodecDeviceInit(struct AudioCard *audioCard, struct CodecDevice *codec) +{ +... + if (CodecRegDefaultInit(codec->devData->regCfgGroup) != HDF_SUCCESS) { + AUDIO_DRIVER_LOG_ERR("CodecRegDefaultInit failed."); + return HDF_FAILURE; + } +... + return HDF_SUCCESS; +} +``` + + + +## Accessory Driver Development Example +Code path: **drivers/peripheral/audio/chipsets/tfa9879/accessory** + +SmartPA is a type of accessory driver. The SmartPA development procedure is similar to the codec development procedure. +1. Define and fill in an accessory instance. +2. Implement callbacks for the accessory instance. +3. Register and bind the accessory instance to the HDF. +4. Configure the HCS and makefile. + +### Filling in Accessory Data Structures + +Fill in the following data structures for the accessory module: + +- **g_tfa9879Data**: operation function set of the accessory device. It contains the configuration in the .hcs file, and defines and maps the functions for initializing the accessory device and reading and writing registers. + +- **g_tfa9879DaiDeviceOps**: data set of the accessory device DAI. It defines and maps the operation set of the accessory device DAI. + +- **g_tfa9879DaiData**: data set of the DAI of the accessory device. It defines and maps the driver name, initialization, and operation set of the data access interface of the accessory device. + +```c +struct AccessoryData g_tfa9879Data = { + .Init = Tfa9879DeviceInit, + .Read = AccessoryDeviceRegRead, + .Write = AccessoryDeviceRegWrite, +}; + +struct AudioDaiOps g_tfa9879DaiDeviceOps = { + .Startup = Tfa9879DaiStartup, + .HwParams = Tfa9879DaiHwParams, +}; + +struct DaiData g_tfa9879DaiData = { + .drvDaiName = "accessory_dai", + .DaiInit = Tfa9879DaiDeviceInit, + .ops = &g_tfa9879DaiDeviceOps, +}; +``` + +### Initializing the Accessory Device and Accessory DAI Device + +As the entry function for device initialization, **Tfa9879DeviceInit** sets the address of the SmartPA I2C device, obtains configuration data, initializes (including resets) the device registers, and adds the control functionality to the controller linked list. The current demo also includes the initialization of the registers related to the Hi3516D V300 device, such as initialization of GPIO pins. + +```c +int32_t Tfa9879DeviceInit(struct AudioCard *audioCard, const struct AccessoryDevice *device) +{ + int32_t ret; + ... + g_accessoryTransferData.i2cDevAddr = TFA9879_I2C_DEV_ADDR; // 0x6D + // Obtain configuration data. + ret = AccessoryDeviceCfgGet(device->devData, &g_accessoryTransferData); + ... + // Initialize GPIO pins. + ret = Hi35xxGpioPinInit(); + ... + // Initialize device registers. + ret = AccessoryDeviceCtrlRegInit(); + ... + // Bind the control functionality configuration. + ret = AudioAddControls(audioCard, g_accessoryTransferData.accessoryControls, + g_accessoryTransferData.accessoryCfgCtrlCount); + ... +} +``` + +**AccessoryI2cReadWrite** reads and writes I2C registers. + +```c +int32_t AccessoryI2cReadWrite(struct AudioAddrConfig *regAttr, uint16_t rwFlag) +{ + int32_t ret; + DevHandle i2cHandle; + int16_t transferMsgCount = 1; + uint8_t regs[I2C_REG_LEN]; + struct I2cMsg msgs[I2C_MSG_NUM]; + ... + i2cHandle = I2cOpen(I2C_BUS_NUM); + ... + if (rwFlag == I2C_FLAG_READ) { + transferMsgCount = I2C_MSG_NUM; + } + ret = AccessoryI2cMsgFill(regAttr, rwFlag, regs, msgs); + ... + ret = I2cTransfer(i2cHandle, msgs, transferMsgCount); + ... + AccessoryI2cRelease(msgs, transferMsgCount, i2cHandle); + return HDF_SUCCESS; +} +``` + +### Implementing the Accessory Operation Function Set + +The callbacks **AccessoryDeviceRegRead** and **AccessoryDeviceRegWrite** invoke **AccessoryI2cReadWrite** to read and write the control register values. + +```c +int32_t AccessoryDeviceRegRead(const struct AccessoryDevice *codec, uint32_t reg, uint32_t *val) +{ + int32_t ret; + struct AudioAddrConfig regAttr; + ... + (void)codec; + regAttr.addr = (uint8_t)reg; + regAttr.value = 0; + ret = AccessoryI2cReadWrite(®Attr, I2C_FLAG_READ); + if (ret != HDF_SUCCESS) { + AUDIO_DRIVER_LOG_ERR("failed."); + return HDF_FAILURE; + } + *val = regAttr.value; + ... + return HDF_SUCCESS; +} + +int32_t AccessoryDeviceRegWrite(const struct AccessoryDevice *codec, uint32_t reg, uint32_t value) +{ + int32_t ret; + struct AudioAddrConfig regAttr; + (void)codec; + regAttr.addr = (uint8_t)reg; + regAttr.value = (uint16_t)value; + ret = AccessoryI2cReadWrite(®Attr, 0); + ... + return HDF_SUCCESS; +} +``` + +**Tfa9879DaiStartup** performs startup settings. The code snippet is as follows: + +```c +int32_t Tfa9879DaiStartup(const struct AudioCard *card, const struct DaiDevice *device) +{ + int ret; + (void)card; + (void)device; + // Set the working status of SmartPA. + ret = Tfa9879WorkStatusEnable(); + ... + return HDF_SUCCESS; +} + +``` + +**Tfa9879DaiHwParams** delivers playback parameters. The code snippet is as follows: + +```c +int32_t Tfa9879DaiHwParams(const struct AudioCard *card, const struct AudioPcmHwParams *param) +{ + int32_t ret; + uint16_t frequency, bitWidth; + struct DaiParamsVal daiParamsVal; + (void)card; + ... + // Set the sampling rate. + ret = AcessoryDeviceFrequencyParse(param->rate, &frequency); + ... + // Set the bit width. + ret = Tfa9879FormatParse(param->format, &bitWidth); + ... + daiParamsVal.frequencyVal = frequency; + daiParamsVal.formatVal = bitWidth; + daiParamsVal.channelVal = param->channels; // Set the audio channel. + ret = AccessoryDaiParamsUpdate(daiParamsVal); + ... + return HDF_SUCCESS; +} +``` + +### Registering and Binding Accessory to HDF + +This process depends on the driver implementation mode of the HDF. For details, see [HDF](https://gitee.com/openharmony/docs/blob/master/en/device-dev/driver/driver-hdf.md). + +Fill in the **g_tfa9879DriverEntry** structure. Ensure that the value of **moduleName** is the same as that in **device_info.hcs**. Implement the pointers to the **Bind**, **Init**, and **Release** functions. + +drivers/peripheral/audio/chipsets/tfa9879/accessory/src/tfa9879_accessory_adapter.c + +```c +static int32_t Tfa9879DriverBind(struct HdfDeviceObject *device) +{ + (void)device; + AUDIO_DRIVER_LOG_INFO("success!"); + return HDF_SUCCESS; +} + +static int32_t Tfa9879DriverInit(struct HdfDeviceObject *device) +{ + int32_t ret; + ... + // Obtain configuration data from .hcs files. + ret = AccessoryGetConfigInfo(device, &g_tfa9879Data); + ... + ret = ret = GetServiceName(device); + ... + ret = AudioRegisterAccessory(device, &g_tfa9879Data, &g_tfa9879DaiData); + .... + return HDF_SUCCESS; +} + +/* HdfDriverEntry definitions */ +struct HdfDriverEntry g_tfa9879DriverEntry = { + .moduleVersion = 1, + .moduleName = "CODEC_TFA9879", + .Bind = Tfa9879DriverBind, + .Init = Tfa9879DriverInit, + .Release = NULL, +}; +HDF_INIT(g_tfa9879DriverEntry); +``` + +### Configuring HCS + +For details about the configuration process, see [Configuring HCS](#section4115) in **Codec Driver Development Example**. + + + +## Platform Driver Development Example +Code path: **drivers/peripheral/audio/chipsets/hi3516dv300/soc** + +In audio driver development, the Platform module is configured to adapt to the DMA driver. The major steps for developing the platform driver are as follows: +1. Define and fill in a platform instance. +2. Implement callbacks for the platform instance. +3. Register and bind the platform instance to the HDF. +4. Configure the HCS and makefile. + +### Filling in Platform Data Structures + +Fill in the following structures for the platform module: + +- **g_platformData**: private configuration of the platform device, including the initialization and operation functions of the platform device. + +- **g_dmaDeviceOps**: DMA device operation function set, including the encapsulation of some common DMA APIs. + +```c +struct AudioDmaOps g_dmaDeviceOps = { + .DmaBufAlloc = Hi3516DmaBufAlloc, // Apply for memory for the DMA device. + .DmaBufFree = Hi3516DmaBufFree, // Release the memory of the DMA device. + .DmaRequestChannel = Hi3516DmaRequestChannel, // Request a DMA channel. + .DmaConfigChannel = Hi3516DmaConfigChannel, // Configure the DMA channel. + .DmaPrep = Hi3516DmaPrep, // Prepare for DMA. + .DmaSubmit = Hi3516DmaSubmit, // Submit a DMA request. + .DmaPending = Hi3516DmaPending, // Pend DMA. + .DmaPause = Hi3516DmaPause, // Pause or stop DMA. + .DmaResume = Hi3516DmaResume, // Resume DMA. + .DmaPointer = Hi3516DmaPointer, // Obtain the current playing or recording position. +}; + +struct PlatformData g_platformData = { + .PlatformInit = AudioDmaDeviceInit, // Initialize the DMA device. + .ops = &g_dmaDeviceOps, +}; +``` + +### Initializing the DMA Device + +**AudioDmaDeviceInit** initializes the DMA device, including setting the Hi3516 AIAO module. + +```c +int32_t AudioDmaDeviceInit(const struct AudioCard *card, const struct PlatformDevice *platformDevice) +{ +... + AiaoHalSysInit(); + /* PIN MUX */ + AiaoSysPinMux(); + /* CLK reset */ + AiaoClockReset(); + /* AIAO initialization */ + AiaoDeviceInit(chnId); +... + return HDF_SUCCESS; +} +``` + +### Implementing the DMA Operation Function Set + +The DMA device operation function set includes the encapsulation of DMA common APIs. If the common APIs cannot meet development requirements, you can implement new DMA callbacks. + +```c +int32_t Hi3516DmaBufAlloc(struct PlatformData *data, const enum AudioStreamType streamType); +int32_t Hi3516DmaBufFree(struct PlatformData *data, const enum AudioStreamType streamType); +int32_t Hi3516DmaRequestChannel(const struct PlatformData *data); +int32_t Hi3516DmaConfigChannel(const struct PlatformData *data); +int32_t Hi3516DmaPrep(const struct PlatformData *data); +int32_t Hi3516DmaSubmit(const struct PlatformData *data); +int32_t Hi3516DmaPending(struct PlatformData *data); +int32_t Hi3516DmaPause(struct PlatformData *data); +int32_t Hi3516DmaResume(const struct PlatformData *data); +int32_t Hi3516DmaPointer(struct PlatformData *data, uint32_t *pointer); +``` + +### Registering and Binding Platform to HDF + +This process depends on the driver implementation mode of the HDF. For details, see [HDF](https://gitee.com/openharmony/docs/blob/master/en/device-dev/driver/driver-hdf.md). + +- Fill in the **g_platformDriverEntry** structure. +- Ensure that the value of **moduleName** is the same as that in **device_info.hcs**. +- Implement the pointers to the **Bind**, **Init**, and **Release** functions. + +drivers/peripheral/audio/chipsets/hi3516dv300/soc/src/hi3516_dma_adapter.c + +```c +static int32_t Hi3516DmaDriverInit(struct HdfDeviceObject *device) +{ +... + OsalMutexInit(&g_platformData.renderBufInfo.buffMutex); + OsalMutexInit(&g_platformData.captureBufInfo.buffMutex); + g_platformData.platformInitFlag = false; + ret = AudioSocRegisterPlatform(device, &g_platformData); +... + return HDF_SUCCESS; +} + +static void Hi3516DmaDriverRelease(struct HdfDeviceObject *device) +{ + struct PlatformHost *platformHost = NULL; +... + platformHost = (struct PlatformHost *)device->service; +... + OsalMutexDestroy(&g_platformData.renderBufInfo.buffMutex); + OsalMutexDestroy(&g_platformData.captureBufInfo.buffMutex); + OsalMemFree(platformHost); +} + +/* HdfDriverEntry definitions */ +struct HdfDriverEntry g_platformDriverEntry = { + .moduleVersion = 1, + .moduleName = "DMA_HI3516", + .Bind = Hi3516DmaDriverBind, + .Init = Hi3516DmaDriverInit, + .Release = Hi3516DmaDriverRelease, +}; +HDF_INIT(g_platformDriverEntry); +``` + +### Configuring HCS + +For details about the configuration process, see [Configuring HCS](#section4115) in **Codec Driver Development Example**. + + + +## DAI Driver Development Example +Code path: **drivers/peripheral/audio/chipsets/hi3516dv300/soc** + +The major steps for developing the DAI driver are as follows: +1. Define and fill in a DAI instance. +2. Implement callbacks for the DAI instance. +3. Register and bind the DAI instance to the HDF. +4. Configure the HCS and makefile. + +### Filling in DAI Data Structures + +Fill in the following structures for the DAI module: + +- **g_daiData**: private configuration of the DAI device, including the initialization of the DAI device, read/write of registers, and operation functions. + +- **g_daiDeviceOps**: DAI device operation function set, including setting DAI parameters and triggering and starting the DAI device. + +```c +struct AudioDaiOps g_daiDeviceOps = { + .HwParams = DaiHwParams, + .Trigger = DaiTrigger, + .Startup = DaiStartup, +}; + +struct DaiData g_daiData = { + .DaiInit = DaiDeviceInit, + .Read = AudioDeviceReadReg, + .Write = AudioDeviceWriteReg, + .ops = &g_daiDeviceOps, +}; +``` + +### Initializing the DAI Device + +**DaiDeviceInit** initializes DAI configuration and adds the information to the controller linked list. + +```c +int32_t DaiDeviceInit(struct AudioCard *audioCard, const struct DaiDevice *dai) +{ +... + struct DaiData *data = dai->devData; + struct AudioRegCfgData *regConfig = dai->devData->regConfig; +... + g_regCodecBase = OsalIoRemap(CODEC_REG_BASE, CODEC_MAX_REG_SIZE); +... + data->regVirtualAddr = (uintptr_t)g_regCodecBase; + DaiSetConfigInfo(data); + AudioAddControls(audioCard, data->controls, data->numControls); + I2c6PinInit(); +... + data->daiInitFlag = true; + return HDF_SUCCESS; +} +``` + +### Implementing the DAI Operation Function Set + +**AudioDeviceReadReg** and **AudioDeviceWriteReg** are not used on the Hi3516 and are reserved. + +**DaiHwParams** sets PCM stream information. + +```c +int32_t DaiHwParams(const struct AudioCard *card, const struct AudioPcmHwParams *param) +{ + uint32_t bitWidth; + struct DaiDevice *device = card->rtd->cpuDai; +... + DaiCheckSampleRate(param->rate); + struct DaiData *data = DaiDataFromCard(card); + data->pcmInfo.channels = param->channels; +... + AudioFramatToBitWidth(param->format, &bitWidth); +... + data->pcmInfo.bitWidth = bitWidth; + data->pcmInfo.rate = param->rate; + data->pcmInfo.streamType = param->streamType; + data->regVirtualAddr = (uintptr_t)g_regDaiBase; +... + DaiParamsUpdate(device); + data->regVirtualAddr = (uintptr_t)g_regCodecBase; + return HDF_SUCCESS; +} +``` + +**DaiTrigger** is not used on the Hi3516 and is reserved. + +**DaiStartup** updates the register configuration and configures the I2S. + +```c +int32_t DaiStartup(const struct AudioCard *card, const struct DaiDevice *device) +{ + struct AudioMixerControl *regCfgItem = NULL; +... + regCfgItem = device->devData->regConfig->audioRegParams[AUDIO_DAI_STARTUP_PATAM_GROUP]->regCfgItem; + itemNum = device->devData->regConfig->audioRegParams[AUDIO_DAI_STARTUP_PATAM_GROUP]->itemNum; + + device->devData->regVirtualAddr = (uintptr_t)g_regDaiBase; + for (int i = 0; i < itemNum; i++) { + int ret = AudioUpdateDaiRegBits(device, ®CfgItem[i], regCfgItem[i].value); + if (ret != HDF_SUCCESS) { + AUDIO_DRIVER_LOG_ERR("set frequency fail."); + return HDF_FAILURE; + } + } + device->devData->regVirtualAddr = (uintptr_t)g_regCodecBase; + + if (I2sPinInit() != HDF_SUCCESS) { + AUDIO_DRIVER_LOG_ERR("I2sPinInit fail."); + } + + return HDF_SUCCESS; +} +``` + +### Registering and Binding DAI to HDF + +This process depends on the driver implementation mode of the HDF. For details, see [HDF](https://gitee.com/openharmony/docs/blob/master/en/device-dev/driver/driver-hdf.md). + +- Fill in the **g_daiDriverEntry** structure. +- Ensure that the value of **moduleName** is the same as that in **device_info.hcs**. +- Implement the pointers to the **Bind**, **Init**, and **Release** functions. + +drivers/peripheral/audio/chipsets/hi3516dv300/soc/src/hi3516_dai_adapter.c + +```c +static int32_t DaiDriverBind(struct HdfDeviceObject *device) +{ +... + struct DaiHost *daiHost = (struct DaiHost *)OsalMemCalloc(sizeof(*daiHost)); +... + daiHost->device = device; + device->service = &daiHost->service; + g_daiData.daiInitFlag = false; +... + return HDF_SUCCESS; +} + +static int32_t DaiDriverInit(struct HdfDeviceObject *device) +{ +... + DaiGetConfigInfo(device, &g_daiData); + DaiGetServiceName(device); +... + OsalMutexInit(&g_daiData.mutex); + AudioSocRegisterDai(device, &g_daiData); +... + return HDF_SUCCESS; +} + +static void DaiDriverRelease(struct HdfDeviceObject *device) +{ +... + OsalMutexDestroy(&g_daiData.mutex); +... + struct DaiHost *daiHost = (struct DaiHost *)device->service; +... + OsalMemFree(daiHost); +} + +/* HdfDriverEntry definitions */ +struct HdfDriverEntry g_daiDriverEntry = { + .moduleVersion = 1, + .moduleName = "DAI_HI3516", + .Bind = DaiDriverBind, + .Init = DaiDriverInit, + .Release = DaiDriverRelease, +}; +HDF_INIT(g_daiDriverEntry); +``` + +### Configuring HCS + +For details about the configuration process, see [Configuring HCS](#section4115) in **Codec Driver Development Example**. + + + +## Adding Compilation Configuration to Makefile + +Add the newly added files to the **Makefile** file to link them to the kernel image. + +Standard system (Linux): **drivers/adapter/khdf/linux/model/audio/Makefile** + +```makefile +obj-$(CONFIG_DRIVERS_HDF_AUDIO_CODEC) += \ +$(KHDF_AUDIO_HI3516DV300_DIR)/../tfa9879/accessory/src/tfa9879_accessory_adapter.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/../tfa9879/accessory/src/tfa9879_accessory_impl.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_adapter.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_impl.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_ops.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/dsp/src/dsp_adapter.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dai_adapter.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dai_ops.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_aiao_impl.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dma_ops.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dma_adapter.o \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_adapter.o +``` + +Small system (LiteOS): **drivers/adapter/khdf/liteos/model/audio/Makefile** + +```makefile +LOCAL_SRCS += \ +$(KHDF_AUDIO_HI3516DV300_DIR)/../tfa9879/accessory/src/tfa9879_accessory_adapter.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/../tfa9879/accessory/src/tfa9879_accessory_impl.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_adapter.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_impl.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/codec/src/hi3516_codec_ops.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/dsp/src/dsp_adapter.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dai_adapter.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dai_ops.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_aiao_impl.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dma_ops.c \ +$(KHDF_AUDIO_HI3516DV300_DIR)/soc/src/hi3516_dma_adapter.c +``` + + + +## Source Code Structure and Directory + +The development example implements the functions in the header file of the driver interface. The following uses Hi3516 as an example to describe the directory structure. + +Path of the driver implementation sample code: **drivers/peripheral/audio/chipsets** + +``` +├── hi3516dv300 +│   ├── codec +│   │   ├── include +│   │   │   ├── hi3516_codec_impl.h +│   │   │   └── hi3516_codec_ops.h +│   │   ├── src +│ │ │ ├── hi3516_codec_adapter.c // Codec driver entry +│ │ │ ├── hi3516_codec_impl.c // Implement codec hardware operations. +│ │ │ └── hi3516_codec_ops.c // Implement codec driver APIs. +│   │   └── test +│   │   └── unittest +│   ├── dsp +│   │   └── include +│   │   └── dsp_ops.h +│   │   └── src +│ │ └── dsp_adapter.c // DSP driver entry +│   │   └── dsp_ops.c +│   └── soc +│   ├── include +│   │   ├── hi3516_aiao_impl.h +│   │   ├── hi3516_dai_ops.h +│   │   └── hi3516_dma_ops.h +│   ├── src +│   │   ├── hi3516_aiao_impl.c +│ │ ├── hi3516_dai_adapter.c // DAI driver entry +│   │   ├── hi3516_dai_ops.c +│ │ ├── hi3516_dma_adapter.c // DMA driver entry +│   │   └── hi3516_dma_ops.c +│   └── test +│   └── unittest +└── tfa9879 +    └── accessory +    ├── include +    │   └── tfa9879_accessory_impl.h +    └── src + ├── tfa9879_accessory_adapter.c // Accessory driver entry +    └── tfa9879_accessory_impl.c +``` + +HCS Files and Directory + +``` +Standard system: +vendor/hisilicon/Hi3516DV300/ +└── hdf_config + └── khdf + ├── audio + │   ├── audio_config.hcs + │   ├── codec_config.hcs + │   ├── dai_config.hcs + │   ├── dma_config.hcs + │   └── dsp_config.hcs + ├── device_info + │   └── device_info.hcs + └── hdf.hcs + +Small system: +vendor/hisilicon/hispark_taurus/ +├── config.json +└── hdf_config + ├── audio + │   ├── audio_config.hcs + │   ├── codec_config.hcs + │   ├── dai_config.hcs + │   ├── dma_config.hcs + │   └── dsp_config.hcs + ├── device_info + │   └── device_info.hcs + └── hdf.hcs +``` + + + +# HAL-based Development Procedure and Example +Code path: **drivers/peripheral/audio/hal** + +## Development Procedure + +![](figures/HAL_flowchart.png) + +1. Call **GetAudioManagerFuncs()** to obtain functions. + +2. Call **GetAllAdapters()** to obtain information about the supported audio adapters and call **LoadAdapter()** to load the corresponding audio adapter. + +3. Create an audio player class by calling **CreateRender()** or create a recorder class and deliver audio attributes. + +4. Call the methods mounted to the created audio player class to call **render->control.Start()** and **render->RenderFrame()** to dispatch the start instruction and deliver audio data cyclically. + +5. During the playback, call **render->control.Pause()**, **render->control.Resume()**, or **render->volume.SetVolume()** to control the audio player service, for example, pausing the playback, resuming the playback, and adjusting the volume. + +6. After the audio player service is complete, stop the playback, destroy the audio player class, and unload the audio adapter. + + 1. render->control.Stop(); + + 2. adapter->DestroyRender(); + + 3. manager->UnloadAdapter(); + +## Development Example + +```c +#include +#include +#include "audio_types.h" +#include +#include "audio_manager.h" + + /* Open the dynamic link to the so library. */ +char *soPathHdi = "/system/lib/libhdi_audio.z.so"; +void *g_handle = dlopen(soPathHdi , 1); + +int32_t FrameStart(void *param) +{ +... + /* Send audio data cyclically. */ + do { + readSize = (remainingDataSize > bufferSize) ? bufferSize : remainingDataSize; + numRead = fread(frame, 1, readSize, g_file); + if (numRead > 0) { + ret = render->RenderFrame(render, frame, numRead, &replyBytes); + if (ret == HDF_ERR_INVALID_OBJECT) { + LOG_FUN_ERR("Render already stop!"); + break; + } + remainingDataSize -= numRead; + } + /* Pause the playback and wait. */ + while (g_waitSleep) { + printf("music pause now.\n"); + pthread_cond_wait(&g_functionCond, &g_mutex); + printf("music resume now.\n"); + } + } while (!g_closeEnd && numRead > 0 && remainingDataSize > 0); +... +} + +static void *hal_main() +{ + /* Map and call the entry function. */ + struct AudioManager *(*getAudioManager)() = + (struct AudioManager *(*)())(dlsym(g_handle, "GetAudioManagerFuncs")); + struct AudioManager *manager = getAudioManager(); + + /* Obtain the audio adapter list. */ + struct AudioAdapterDescriptor *descs = NULL; + int32_t size = 0; + int32_t ret = manager->GetAllAdapters(manager, &descs, &size); + + /* Locate the audio adapter and port based on the specified audio adapter name and port description. */ + enum AudioPortDirection port = PORT_OUT; // The port type OUT means to play the audio. + struct AudioPort renderPort; + char * adapterNameCase = "usb"; + int32_t index = SwitchAdapter(descs, adapterNameCase, port, &renderPort, size); + + /* Load the audio adapter based on the matched audio adapter information. */ + struct AudioAdapter *adapter = NULL; + struct AudioAdapterDescriptor *desc = &descs[index]; // Obtain the device based on the matched audio adapter information. + manager->LoadAdapter(manager, desc, &adapter); // Load the audio adapter and obtain the audio adapter instance. + + /* Create an audio player class. */ + struct AudioRender *render; + struct AudioDeviceDescriptor devDesc; + struct AudioSampleAttributes attrs; + InitDevDesc(&devDesc, renderPort.portId); // Initialize device parameters. + WavHeadAnalysis(g_file, &attrs); // Parse the audio file to set attributes. + adapter->CreateRender(adapter, &devDesc, &attrs, &render); + + /* Deliver the audio data to play. */ + render->control.Start((AudioHandle)render); // Dispatch the start instruction and prepare for the action. + pthread_create(&g_tids, NULL, (void *)(&FrameStart), &g_str); // Start the thread to play the audio clip. + + /* Control instructions */ + render->control.Pause((AudioHandle)render); // Pause the playback. + render->control.Resume((AudioHandle)render); // Resume the playback. + render->volume.SetVolume((AudioHandle)render, 0.5); // Set the volume. + + /* Stop playback and destroy the audio player class. */ + render->control.Stop((AudioHandle)render); + adapter->DestroyRender(adapter, render); + /* Unload the audio adapter. */ + manager->UnloadAdapter(manager, adapter); +} +``` + + + +# Summary + +This document provides all the key adaptations involved in the driver development based on the audio driver architecture. It elaborates how to adapt the audio driver and use HDI APIs. You can easily develop your audio drivers based on the chip you use by referring to this document. diff --git a/en/device-dev/driver/driver-peripherals.md b/en/device-dev/driver/driver-peripherals.md index aee10257e65791a1c04ddea0bfd4e998544fc387..4b65137ea60186915ec84487a46d73e125b2b95c 100644 --- a/en/device-dev/driver/driver-peripherals.md +++ b/en/device-dev/driver/driver-peripherals.md @@ -2,10 +2,12 @@ - **[LCD](driver-peripherals-lcd-des.md)** -- **[TOUCHSCREEN](driver-peripherals-touch-des.md)** +- **[Touchscreen](driver-peripherals-touch-des.md)** - **[Sensor](driver-peripherals-sensor-des.md)** - **[WLAN](driver-peripherals-external-des.md)** +- **[Audio](driver-peripherals-audio-des.md)** + diff --git a/en/device-dev/driver/figures/ADM_control_flowchart.png b/en/device-dev/driver/figures/ADM_control_flowchart.png new file mode 100644 index 0000000000000000000000000000000000000000..5f0b075983cb6cea46c33e15c9abbeeb0ea7bdd0 Binary files /dev/null and b/en/device-dev/driver/figures/ADM_control_flowchart.png differ diff --git a/en/device-dev/driver/figures/ADM_playback_flowchart.png b/en/device-dev/driver/figures/ADM_playback_flowchart.png new file mode 100644 index 0000000000000000000000000000000000000000..ceed4237ad2033c06db504165a3f5fd75fbd46c2 Binary files /dev/null and b/en/device-dev/driver/figures/ADM_playback_flowchart.png differ diff --git a/en/device-dev/driver/figures/ADM_startup_flowchart.png b/en/device-dev/driver/figures/ADM_startup_flowchart.png new file mode 100644 index 0000000000000000000000000000000000000000..db07e421198faf154f30682c63e2b7b361ae3cf6 Binary files /dev/null and b/en/device-dev/driver/figures/ADM_startup_flowchart.png differ diff --git a/en/device-dev/driver/figures/Audio_architecture.png b/en/device-dev/driver/figures/Audio_architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..19c24f59eed43828f00f4bbff012b0e087fb927a Binary files /dev/null and b/en/device-dev/driver/figures/Audio_architecture.png differ diff --git a/en/device-dev/driver/figures/HAL_flowchart.png b/en/device-dev/driver/figures/HAL_flowchart.png new file mode 100644 index 0000000000000000000000000000000000000000..f477dbceaf5c76b29d3c40f3912e00dbdb617e86 Binary files /dev/null and b/en/device-dev/driver/figures/HAL_flowchart.png differ diff --git a/en/device-dev/driver/figures/development_flowchart_1.png b/en/device-dev/driver/figures/development_flowchart_1.png new file mode 100644 index 0000000000000000000000000000000000000000..16c6571b586b28f19ca8db4626c65fb3fcb65c1a Binary files /dev/null and b/en/device-dev/driver/figures/development_flowchart_1.png differ diff --git a/en/device-dev/driver/figures/development_flowchart_2.png b/en/device-dev/driver/figures/development_flowchart_2.png new file mode 100644 index 0000000000000000000000000000000000000000..bd820389e4e5f5e8ee39e3d5208513c20a64d494 Binary files /dev/null and b/en/device-dev/driver/figures/development_flowchart_2.png differ