cfe_config.h

/************************************************************************
 * NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
 *
 * Copyright (c) 2020 United States Government as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ************************************************************************/

/**
 * @file
 *
 *  Title:    cFE Status Code Definition Header File
 *
 *  Purpose:
 *            Common source of cFE API return status codes.
 *
 *  Design Notes:
 *
 *  References:
 *     Flight Software Branch C Coding Standard Version 1.0a
 *
 */

#ifndef CFE_CONFIG_H
#define CFE_CONFIG_H

/* Include Files */
#include "common_types.h"
#include "cfe_config_api_typedefs.h"
#include "cfe_config_ids.h"

/**
 * @brief Obtain an integer value correlating to an CFE configuration ID
 *
 * Retrieves the integer value associated with the specified key.
 *
 * If no value has been set, or the key is not valid, this returns 0.
 *
 * @param[in]   ConfigId  Configuration ID/Key to look up
 *
 * @return Value associated with key
 * @retval 0 if key is not defined or not set
 */
uint32 CFE_Config_GetValue(CFE_ConfigId_t ConfigId);

/**
 * @brief Obtain a pointer value correlating to an CFE configuration ID
 *
 * Retrieves the pointer value associated with the specified key.
 *
 * If no value has been set, or the key is not valid, this returns NULL.
 *
 * @param[in]   ConfigId  Configuration ID/Key to look up
 *
 * @return Value associated with key
 * @retval NULL if key is not defined or not set
 */
const void *CFE_Config_GetObjPointer(CFE_ConfigId_t ConfigId);

/**
 * @brief Obtain an array correlating to an CFE configuration ID
 *
 * Retrieves the CFE_Config_ArrayValue_t value associated with the specified key.
 * This combines an array length (number of elements) and a pointer to the first element.
 *
 * If no value has been set, or the key is not valid, this returns 0 / NULL.
 *
 * @param[in]   ConfigId  Configuration ID/Key to look up
 *
 * @return Value associated with key
 * @retval NULL if key is not defined or not set
 */
CFE_Config_ArrayValue_t CFE_Config_GetArrayValue(CFE_ConfigId_t ConfigId);

/**
 * @brief Obtain a string value correlating to an CFE configuration ID
 *
 * Retrieves the string value associated with the specified key.
 *
 * If no value has been set, or the key is not valid, this returns the
 * special string "UNDEFINED"
 *
 * @note This function does not return NULL, so it can be used directly
 * in printf-style calls.
 *
 * @param[in]   ConfigId  Configuration ID/Key to look up
 *
 * @return String value associated with key
 */
const char *CFE_Config_GetString(CFE_ConfigId_t ConfigId);

/**
 * @brief Obtain the name of a CFE configuration ID
 *
 * Retrieves the printable name associated with the specified key.
 *
 * @note  This function does not return NULL.
 *
 * If the ID is not valid/known, then the implementation returns the
 * special string '[unknown]' rather than NULL, so this function may
 * be more easily used in printf() style calls.
 *
 * @param[in]   ConfigId  Configuration ID/Key to look up
 *
 * @return Name associated with key
 */
const char *CFE_Config_GetName(CFE_ConfigId_t ConfigId);

/**
 * @brief Obtain the ID value associated with a configuration name
 *
 * @param[in]   Name  The name of the ID to look up
 *
 * @return ID associated with name
 * @retval CFE_CONFIGID_UNDEFINED if the name did not correspond to a key
 */
CFE_ConfigId_t CFE_Config_GetIdByName(const char *Name);

/**
 * @brief Iterate all known name/ID value pairs
 *
 * @param[in]   Arg       User-supplied opaque argument to pass to callback
 * @param[in]   Callback  User-supplied callback function to invoke for each ID
 */
void CFE_Config_IterateAll(void *Arg, CFE_Config_Callback_t Callback);

/**
 * @brief Obtain the version string for a cFS component or app
 *
 * Assembles a standardized version string associated with the specified
 * component/app.
 *
 * @param[in]   Buf         Buffer to place version string in. Will be populated
 *                          with standard version string containing the provided
                            parameters (i.e.:
 *                          "cFE DEVELOPMENT BUILD equuleus-rc1+dev0 (Codename
                            equuleus), Last Official Release: cFE 6.7.0"
 * @param[in]   Size        Size of the provided buffer
 * @param[in]   Component   Component for which to get version string
 *                          (i.e. "cFE")
 * @param[in]   SrcVersion  Source version identifier (i.e. "equuleus-rc1+dev0")
 * @param[in]   CodeName    Code name for the build (i.e. "equuleus")
 * @param[in]   LastOffcRel Last official release (i.e. "6.7.0")
 */
void CFE_Config_GetVersionString(char *Buf, size_t Size, const char *Component, const char *SrcVersion,
                                 const char *CodeName, const char *LastOffcRel);

#endif /* CFE_CONFIG_H */