• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2024, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef OT_POSIX_PLATFORM_TMP_STORAGE_HPP_
30 #define OT_POSIX_PLATFORM_TMP_STORAGE_HPP_
31 
32 #include "openthread-posix-config.h"
33 #include "platform-posix.h"
34 
35 #include "settings_file.hpp"
36 
37 #if OPENTHREAD_POSIX_CONFIG_TMP_STORAGE_ENABLE
38 namespace ot {
39 namespace Posix {
40 
41 class TmpStorage
42 {
43 public:
TmpStorage(void)44     TmpStorage(void)
45         : mStorageFile()
46     {
47     }
48 
49     /**
50      * Performs the initialization for the temporary storage.
51      */
52     void Init(void);
53 
54     /**
55      * Performs the de-initialization for the temporary storage.
56      */
57     void Deinit(void);
58 
59     /**
60      * Saves the radio spinel metrics to the temporary storage.
61      *
62      * @param[in]  aMetrics   A reference to the radio spinel metrics.
63      */
64     void SaveRadioSpinelMetrics(const otRadioSpinelMetrics &aMetrics);
65 
66     /**
67      * Restores the radio spinel metrics from the temporary storage.
68      *
69      * @param[out]  aMetrics   A reference to the radio spinel metrics.
70      *
71      * @retval OT_ERROR_NONE        The radio spinel metrics was found and fetched successfully.
72      * @retval OT_ERROR_NOT_FOUND   The radio spinel metrics was not found in the setting store.
73      */
74     otError RestoreRadioSpinelMetrics(otRadioSpinelMetrics &aMetrics);
75 
76 private:
77     enum
78     {
79         kKeyBootTime           = 1,
80         kKeyRadioSpinelMetrics = 2,
81     };
82 
83     otError SettingsFileInit(void);
84     time_t  GetBootTime(void);
85     bool    BootTimeMatch(time_t aBootTimeA, time_t aBootTimeB);
86 
87     SettingsFile mStorageFile;
88 };
89 
90 } // namespace Posix
91 } // namespace ot
92 #endif // OPENTHREAD_POSIX_CONFIG_TMP_STORAGE_ENABLE
93 #endif // OT_POSIX_PLATFORM_TMP_STORAGE_HPP_
94