/*
 * libkysdk-system's Library
 *
 * Copyright (C) 2023-2025, KylinSoft Co., Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this library.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Authors: Yunhe Liu <liuyunhe@kylinos.cn>
 *
 */

#ifndef LIBKYBOARDINFO_H
#define LIBKYBOARDINFO_H

/**
 * @file libkyboard.h
 * @author liuyunhe (liuyunhe@kylinos.cn)
 * @brief 主板信息
 * @version 0.1
 * @date 2023-2-17
 * 
 * @copyright Copyright (c) 2023
 * @defgroup libkysdk-hardware
 * @{
 * @since 2.0.0.0
 */

#ifdef __cplusplus
extern "C"
{
#endif

/**
 * @brief 获取主板型号
 * 
 * @return const char* 主板型号，返回的字符串需要被 free 释放
 */
extern const char *kdk_board_get_name();

/**
 * @brief 获取主板生产日期
 * 
 * @return const char* 日期，返回的字符串需要被 free 释放
 */
extern const char *kdk_board_get_date();

/**
 * @brief 获取主板序列号
 * 
 * @return const char* 序列号，返回的字符串需要被 free 释放
 */
extern const char *kdk_board_get_serial();

/**
 * @brief 获取主板厂商
 * 
 * @return const char* 厂商名，返回的字符串需要被 free 释放
 */
extern const char *kdk_board_get_vendor();

/**
 * @brief 释放内存
 * 
 * @param info 本模块其他接口返回的字符串
 */
extern void kdk_board_free(char *info);

#ifdef __cplusplus
}
#endif

#endif

/**
 * \example kysdk-system/src/hardware/test/kyboard-test.c
 * 
 */
