blob: 802136507d22772a506b1a47da0f5e8d13120608 [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/**
2* @file cfg_api.h
3* @brief nv½Ó¿ÚÍ·Îļþ
4*
5* Copyright (C) 2017 Sanechips Technology Co., Ltd.
6*
7*/
8
9#ifndef _CFG_API_H
10#define _CFG_API_H
11
12/*******************************************************************************
13 * Include header files *
14 ******************************************************************************/
15
16/*******************************************************************************
17 * Macro definitions *
18 ******************************************************************************/
19
20
21/*******************************************************************************
22 * Type definitions *
23 ******************************************************************************/
24
25
26/*******************************************************************************
27 * Global variable declarations *
28 ******************************************************************************/
29
30
31/*******************************************************************************
32 * Global function declarations *
33 ******************************************************************************/
34/**
35* @brief »ñȡָ¶¨×ֶζÔÓ¦µÄÖµ
36* @param name Èë²Î£¬×Ö¶ÎÃû
37* @param buf ³ö²Î£¬´æ·Å×ֶζÔÓ¦Êý¾ÝµÄ»º³åÇøÖ¸Õë
38* @param len Èë²Î£¬»º³åÇøbuf³¤¶È
39* @return 0£º³É¹¦£¬-1£ºÊ§°Ü
40* @retval 0 ³É¹¦
41* @retval -1 ʧ°Ü
42* @note
43* @warning
44*/
45int sc_cfg_get(char *name, char *buf, int bufLen);
46
47/**
48 * @brief ÉèÖÃÖ¸¶¨×ֶζÔÓ¦µÄÖµ
49 * @param name Èë²Î£¬×Ö¶ÎÃû
50 * @param value Èë²Î£¬ÏëÒª´æ´¢µÄÊý¾Ý
51 * @return 0£º³É¹¦£¬-1£ºÊ§°Ü
52 * @retval 0 ³É¹¦
53 * @retval -1 ʧ°Ü
54 * @note cfg_set½öÉèÖõ½Äڴ棬µ÷ÓÃcfg_save²Å»á±£´æµ½Îļþ£¬²Å»áÖØÆôÉúЧ
55 * @warning ½öÔÚparameterÖеÄnv²Å»áµôµç±£´æ£¬ÆäËû½ÔÊÓΪÁÙʱnv
56 */
57int sc_cfg_set(char *name, char *value);
58
59/**
60 * @brief ɾ³ýÖ¸¶¨×Ö¶Î
61 * @param name Èë²Î£¬×Ö¶ÎÃû
62 * @return 0£º³É¹¦£¬-1£ºÊ§°Ü
63 * @retval 0 ³É¹¦
64 * @retval -1 ʧ°Ü
65 * @note
66 * @warning
67 */
68int sc_cfg_unset(char *name);
69
70/**
71 * @brief Çå¿ÕÈ«²¿×ֶδ洢ÐÅÏ¢
72 * @param
73 * @return 0£º³É¹¦£¬-1£ºÊ§°Ü
74 * @retval 0 ³É¹¦
75 * @retval -1 ʧ°Ü
76 * @note
77 * @warning »Ö¸´³ö³§ÐÅϢʱµ÷ÓÃ
78 */
79int sc_cfg_reset(void);
80
81/**
82 * @brief ´òÓ¡ÏÔʾËùÓÐÅäÖÃÏîÐÅÏ¢µ½¿ØÖÆÌ¨
83 * @param
84 * @return 0£º³É¹¦£¬-1£ºÊ§°Ü
85 * @retval 0 ³É¹¦
86 * @retval -1 ʧ°Ü
87 * @note
88 * @warning
89 */
90int sc_cfg_show(void);
91
92/**
93 * @brief ±£´æÈ«²¿ÅäÖÃÊý¾Ýµ½Îļþ
94 * @param
95 * @return 0£º³É¹¦£¬-1£ºÊ§°Ü
96 * @retval 0 ³É¹¦
97 * @retval -1 ʧ°Ü
98 * @note cfg_saveµ÷Óúó£¬ÅäÖõÄÊý¾ÝÖØÆôºó»¹ÄÜÉúЧ
99 * @warning
100 */
101int sc_cfg_save(void);
102
103#ifndef LIBNVRAM_API_NEW
104int cfg_get_item(char *name, char *buf, int bufLen);
105int cfg_set(char *name, char *value);
106int cfg_unset(char *name);
107int cfg_reset(void);
108int cfg_show(void);
109int cfg_save(void);
110#endif
111
112/**
113 * @brief systemϵͳµ÷Ó÷â×°½Ó¿Ú
114 * @param cmd Èë²Î ÃüÁî
115 * @return 0£º³É¹¦£¬-1£ºÊ§°Ü
116 * @retval 0 ³É¹¦
117 * @retval -1 ʧ°Ü
118 * @note
119 * @warning
120 */
121extern int zxic_system(const char *cmd);
122
123extern int zxic_system_outdata(const char *cmd, const char *outfile, char *out_data, int out_len);
124/*******************************************************************************
125 * Inline function implementations *
126 ******************************************************************************/
127
128#endif // #ifndef _CFG_API_H
129