kv_config.h

00001 /*
00002  * Copyright (c) 2018 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef _KV_CONFIG
00017 #define _KV_CONFIG
00018 
00019 #ifdef __cplusplus
00020 extern "C" {
00021 #endif
00022 
00023 #ifndef MBED_CONF_STORAGE_STORAGE
00024 #define MBED_CONF_STORAGE_STORAGE USER_DEFINED
00025 #endif
00026 
00027 #define _STORAGE_CONFIG_concat(dev) _storage_config_##dev()
00028 #define _STORAGE_CONFIG(dev) _STORAGE_CONFIG_concat(dev)
00029 
00030 /**
00031  * @brief This function initializes one of the configuration that exists in Mbed OS. To overwrite
00032  *        the default configuration, please overwrite this function.
00033  *
00034  * @returns 0 on success or negative value on failure.
00035  */
00036 int kv_init_storage_config();
00037 
00038 /**
00039  * @brief A getter for filesystemstore folder path configuration
00040  *
00041  * @returns string with the file folder path or NULL if not set
00042  */
00043 const char *get_filesystemstore_folder_path();
00044 
00045 #ifdef __cplusplus
00046 } // closing brace for extern "C"
00047 #endif
00048 #endif