> ## Documentation Index > Fetch the complete documentation index at: https://dragonwingdocs-staging.qualcomm.com/llms.txt > Use this file to discover all available pages before exploring further. # ACDB > Contains the public interface definitions for the Audio Calibration Database (ACDB) module. **Header:** `acdb/api/acdb.h` ## Structures ### `_acdb_key_value_t` Generic response structure. **Members** Key ID ### `_acdb_blob_t` Maintains buffer context information. **Members** Buffer size. ### `_acdb_buffer_context_t` Request structure used to query for AMDB bootup modules, registration, and deregistration data. **Members** ### `_acdb_amdb_proc_id_t` Request structure used to query for AMDB bootup modules, registration, and deregistration data. **Members** The the ID of processor domain that the AMDB modules operate under ### `_acdb_amdb_db_handle_t` A Key Vector with a zero sized array. **Members** The the ID of processor domain that the AMDB modules operate under. ### `_acdb_key_vector_t` A Tag Key Vector with a zero sized array. **Members** number of keys ### `_acdb_tag_key_vector_t` List of uint32\_t with a pointer to an array of uint32\_t. **Members** The module tag identifier Graph key vector. ### `_acdb_uint_list_t` List of uint32\_t with a zero sized array. **Members** number of elemts in the list ### `_acdb_uint_list_zs_t` **Members** number of elemts in the list ### `_acdb_file_t` **Members** Full file path name length ### `_acdb_data_files_t` **Members** Number of ACDB files ### `_acdb_database_files_t` **Members** Number of database files ### `_acdb_subgraph_t` **Members** src Subgraph ID dst subgraph IDs ### `_acdb_graph_key_vector_t` **Members** number of keys ### `_acdb_get_graph_rsp_t` **Members** Number of SubGraphs for a given key combination Pointer to array of SubGraphs data for a given key combination. ### `_acdb_sgid_graph_key_vector_t` **Members** number of SubGraph ID Graph key vector ### `_acdb_property_data_t` **Members** Property ID ### `_acdb_sub_graph_property_data_t` **Members** SubGraph ID Array of prop\_data of type AcdbPropertyData. ### `_acdb_driver_property_data_t` **Members** number of SubGraph ID ### `_acdb_get_subgraph_data_rsp_t` **Members** Size of container data. ### `_acdb_subgraph_list_t` **Members** Number of SubGraphs for a given key combination ### `_acdb_sgid_calkey_vector_t` **Members** Number of Subgraphs Calibration Key vector prior. Calibration Key vector new. ### `_acdb_sgid_persist_data_t` **Members** Subgraph ID persist cal data. ### `_acdb_sgid_persist_cal_data_t` **Members** Number of Subgraphs Persist cal data. ### `_acdb_global_persistent_cal_info_t` **Members** cal identifier iid list ### `_acdb_get_blb_psist_identifier_t` **Members** number of global-persistent cal info entries Size of container data. ### `_acdb_get_subgraph_glb_persist_cal_data_cmd_type` **Members** Cal Identifier> ### `_acdb_driver_data_t` **Members** Key Vector associated with the driver data ### `_acdb_module_tag_t` **Members** Module tag ID ### `_acdb_sgid_module_tag_t` **Members** Num of Subgraph IDs Module tag. ### `_acdb_get_tagged_modules_req_t` **Members** Num of Subgraph IDs tag ID ### `_acdb_module_instance_t` **Members** Module ID ### `_acdb_get_tagged_modules_t` **Members** Number of tagged modules ### `_acdb_get_key_capabilities_t` **Members** Number of modules. Pointer to array of Module instances. ### `_acdb_set_cal_data_t` **Members** The graph keys that describe the usecase the modules are under cal blob size cal blob ### `_acdb_sg_proc_id_map_t` Request structure that contains the list of subgraphs to retrieve processor lists for. **Members** Subgraph ID Array of Processor IDs. ### `_acdb_get_subgraph_proc_ids_req_t` Response structure that contains a list of mappings between subgraphs and their associated processors. **Members** Number of subgraphs ### `_acdb_get_subgraph_proc_ids_rsp_t` **Members** Number of subgraphs Array of maps that associate a subgraph to a list of processors. ### `_acdb_cmd_get_tags_from_gkv_req` Contains a Modules ID and Instance ID. **Members** Graph Key Vector representing the usecase ### `_acdb_module` Contains the mapping beween a Tag and one or more module. **Members** Module ID ### `_acdb_tag_module` Response structure that contains a list of Tag + Module(s) mapping. **Members** Tag ID associated with the module(s) List of modules associated with this tag. ### `_acdb_cmd_get_tags_from_gkv_rsp` **Members** Number of tags found List of Tags plus their associated module(s) ### `_acdb_key_vector_list_t` **Members** Number of key vectors in the key vector list List of Key Vectors in the format of \[#keys, kvPair+,..., #keys, kvPair+]. ### `_acdb_tag_key_vector_list_t` **Members** Number of tag key vectors in the key vector list List of Tag Key Vectors in the format of \[#keys, kvPair+,..., #keys, kvPair+]. ### `_acdb_module_param_list` Request structure for retrieving cal data for modules under a usecase. **Members** The module instance to get parameter data from ### `_acdb_get_cal_data_req_t` **Members** The graph keys that describe the usecase the modules are under The number of module instances in the instance\_param\_list. List of module instances plus their parameters to get data for. ### `_acdb_get_tag_data_req_t` **Members** The graph keys that describe the usecase the modules are under The number of module instances in the instance\_param\_list. List of module instances plus their parameters to get data for. ### `_acdb_set_tag_data_t` **Members** The graph keys that describe the usecase the modules are under Size of the tag data blob. Pointer to blob containing tag data. ### `_acdb_set_temp_path_req_t` **Members** The length of the path including the null terminating character ### `_acdb_hw_accel_subgraphs_info_req_t` **Members** List of Subgraph IDs ### `_acdb_hw_accel_subgraph_t` **Members** Subgraph ID ### `_acdb_hw_accel_subgraph_info_rsp_t` **Members** Number of Subgraphs Subgraph IDs. ### `_acdb_subgraph_proc_pair_t` Request structure for retrieving persistent calibration based on processor. **Members** The ID of the subgraph to get calibration for ### `_acdb_proc_subgraph_persist_cal_req_t` **Members** Number of subgraphs Calibration Key vector prior. Calibration Key vector new. ### `_acdb_string_t` **Members** The length of the string including the null terminating character ### `_acdb_get_proc_tagged_modules_req_t` Maps tagged modules to a processor domain. **Members** Number of Subgraphs The tag to search for. ### `_acdb_proc_tagged_modules_t` Response struture containing a mapping of tagged modules to processor domain ID. **Members** Number of tagged modules. Pointer to array of tagged modules. ### `_acdb_get_proc_tagged_modules_rsp_t` **Members** Number of tagged modules A pointer to contiguous block of memory containing tagged module ID and IID ordered by processor domain. ## Functions ### `acdb_init` ```cpp theme={null} int32_t acdb_init(AcdbDataFiles *acdb_data_files, AcdbFile *delta_file_path) ``` ### `acdb_flash_init` ```cpp theme={null} int32_t acdb_flash_init(uint32_t *acdbdata_base_addr) ``` ### `acdb_deinit` ```cpp theme={null} int32_t acdb_deinit(void) ``` ### `acdbCmdIsPersistenceSupported` ```cpp theme={null} int32_t acdbCmdIsPersistenceSupported(uint32_t *resp) ``` ### `acdb_add_database` Extends the database by adding database files (\*.acdb and \*.qwsp) at runtime. ```cpp theme={null} int32_t acdb_add_database(AcdbDatabaseFiles *acdb_files, AcdbFile *writable_file_path, acdb_handle_t *acdb_handle) ``` **Parameters** A list of database file paths containing \*.acdb and \*.qwsp The delta data file path and temp files acdb\_handle: A handle to the database provided **Returns** 0 on success, non-zero on failure ### `acdb_remove_database` Shrinks the database by removing all data associated with the given database handle at runtime. ```cpp theme={null} int32_t acdb_remove_database(const acdb_handle_t *acdb_handle) ``` **Parameters** A handle to the database to remove **Returns** 0 on success, non-zero on failure ### `acdb_get_handle` Retrieves a handle associated with the given acdb file which can be used in APIs to retrieve information from a database. ```cpp theme={null} int32_t acdb_get_handle(AcdbFile *acdb_file, acdb_handle_t *acdb_handle) ``` **Parameters** The file to get the handle for acdb\_handle: The acdb hande for the given file **Returns** 0 on success, non-zero on failure ### `acdb_ioctl` Main entry function to the ACDB. This entry function takes any supported ACDB IOCTL and provides the appropriate response. See the individual command documentation for more details on the expectations of the command. ```cpp theme={null} int32_t acdb_ioctl(uint32_t cmd_id, const void *cmd_struct, uint32_t cmd_struct_size, void *rsp_struct, uint32_t rsp_struct_size) ``` **Parameters** Command ID to execute on the Audio Calibration Database. The cmd and the rsp must match the expected structures for that command. If not, the command fails. Pointer to the command structure. Size of the command structure. Pointer to the response structure. Size of the response structure. **Returns** The result of the call as defined by the command. ## Type Definitions ### `acdb_handle_t` A handle to a database ```cpp theme={null} typedef void * acdb_handle_t ``` ### `AcdbFile` ```cpp theme={null} typedef struct _acdb_file_t AcdbFile ``` ### `AcdbDataFiles` ```cpp theme={null} typedef struct _acdb_data_files_t AcdbDataFiles ``` ### `AcdbDatabaseFiles` ```cpp theme={null} typedef struct _acdb_database_files_t AcdbDatabaseFiles ``` ## Macros ### `ACDB_SOFTWARE_VERSION_MAJOR` The ACDB Software Major Version ```c theme={null} #define ACDB_SOFTWARE_VERSION_MAJOR 0x00000001 ``` ### `ACDB_SOFTWARE_VERSION_MINOR` The ACDB Software Revision. ```c theme={null} #define ACDB_SOFTWARE_VERSION_MINOR 0x00000030 ``` ### `ACDB_SOFTWARE_VERSION_REVISION` The ACDB Software CPL Info. ```c theme={null} #define ACDB_SOFTWARE_VERSION_REVISION 0x00000000 ``` ### `ACDB_SOFTWARE_VERSION_CPLINFO` The max character length of a file name string. ```c theme={null} #define ACDB_SOFTWARE_VERSION_CPLINFO 0x00000000 ``` ### `MAX_FILENAME_LENGTH` The max allowed number databases to manage. ```c theme={null} #define MAX_FILENAME_LENGTH 256 ``` ### `MAX_ACDB_FILE_COUNT` The max number of files that can be init'ed/added to the database. ```c theme={null} #define MAX_ACDB_FILE_COUNT 16 ``` ### `ACDB_MAX_FILE_ADD_LIMIT` ```c theme={null} #define ACDB_MAX_FILE_ADD_LIMIT 2 ``` ### `INF` ```c theme={null} #define INF 4294967295U ``` ### `ACDB_CMD_ID` ```c theme={null} #define ACDB_CMD_ID ((0xACDBUL << 16) | (0xFFFFUL & x)) ``` ### `ACDB_MEM_CPY` ```c theme={null} #define ACDB_MEM_CPY memcpy((uint8_t *)dst, (uint8_t *)src, src_size) ``` ### `ACDB_MEM_CMP` ```c theme={null} #define ACDB_MEM_CMP memcmp(x,y,len) ``` ### `ACDB_CLEAR_BUFFER` ```c theme={null} #define ACDB_CLEAR_BUFFER memset(&x, 0, sizeof(x)) ```