1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* 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.
*/
//////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_NPPService
/// \brief This file contains the declaration for methods to retrieve and store data for NOR storage
///
///
///
//////////////////////////////////////////////////////////////////////////////////////////////////
/**
* @file ns_np_service_nor_persistence.h
* @brief This file contains the declaration for methods to retrieve and store data for NOR storage
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup notification_persistent_service
* @ingroup native_service
* @{
*/
#ifndef __NATIVESERVICES_NP_NOR_SERVICE_H__ // NOLINT (build/header_guard)
#define __NATIVESERVICES_NP_NOR_SERVICE_H__
///////////////////////////////////////////////////////////////////////////////
// Include Files
///////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_types.h>
#ifdef __cplusplus
extern "C" {
#endif
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NPSynchronousReadPersistentData
/// \~english @par Brief
/// API to synchronously read persistent data corresponding to a notification before NPPService is available
/// \~english @param[in] pAppName
/// PCSTR - Application/ thread name
/// \~english @param[in] notif_name
// PCSTR - Name of Notification
/// \~english @param[in] pData
/// PVOID - Pointer to the buffer where read data will be written.
/// \~english @param[in] uiDataSize
/// UI_32 - Length of the data buffer.
/// \~english @param[in] ePersistCategory
/// const EFrameworkunifiedPersistCategory - Persist Category of Notification.
/// \~english @retval eFrameworkunifiedStatusOK
/// \~english @retval eFrameworkunifiedStatusInvldParam
/// \~english @retval eFrameworkunifiedStatusFail
/// \~english @par Preconditons
/// none
/// \~english @par Change of internal status
/// - Change of internal state according to the API does not occur.
/// \~english @par Conditions of processing failure
/// - NULL handle specified in the argument(pAppName).[eFrameworkunifiedStatusInvldParam]
/// - NULL handle specified in the argument(notif_name).[eFrameworkunifiedStatusInvldParam]
/// - NULL handle specified in the argument(pData).[eFrameworkunifiedStatusInvldParam]
/// - 0 specified in the argument(uiDataSize).[eFrameworkunifiedStatusFail]
/// - Handle of the application [eFrameworkunifiedStatusFail]
/// - If the file access process fails,.... [eFrameworkunifiedStatusFail]
/// \~english @par Detail
/// API to synchronously read persistent data corresponding to a notification before NPPService is available
/// \~english @par
/// File reading by this API is exclusive control by semaphore,
/// and writing to non-voatie area is to use NPSynchronousWritePersistentData().
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Set Get
/// \~english @see NPSynchronousWritePersistentData
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus NPSynchronousReadPersistentData(PCSTR pAppName,
PCSTR notif_name,
PVOID pData,
UI_32 uiDataSize,
const EFrameworkunifiedPersistCategory ePersistCategory = eFrameworkunifiedUserData);
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NPSynchronousWritePersistentData
/// \~english @par Brief
/// API to synchronously write persistent data corresponding to a notification before NPPService is available
/// \~english @param[in] pAppName
/// PCSTR - Application/ thread name
/// \~english @param[in] notif_name
// PCSTR - Name of Notification
/// \~english @param[in] pData
/// PVOID - Pointer to the buffer where read data will be written.
/// \~english @param[in] uiDataSize
/// UI_32 - Length of the data buffer.
/// \~english @param[in] ePersistCategory
/// const EFrameworkunifiedPersistCategory - Persist Category of Notification.
/// \~english @retval eFrameworkunifiedStatusOK
/// \~english @retval eFrameworkunifiedStatusInvldParam
/// \~english @retval eFrameworkunifiedStatusFail
/// \~english @par Preconditons
/// none
/// \~english @par Change of internal status
/// - Change of internal state according to the API does not occur.
/// \~english @par Conditions of processing failure
/// - NULL handle specified in the argument(pAppName).[eFrameworkunifiedStatusInvldParam]
/// - NULL handle specified in the argument(notif_name).[eFrameworkunifiedStatusInvldParam]
/// - NULL handle specified in the argument(pData).[eFrameworkunifiedStatusInvldParam]
/// - 0 specified in the argument(uiDataSize).[eFrameworkunifiedStatusFail]
/// - Handle of the application [eFrameworkunifiedStatusFail]
/// - If the file access process fails,.... [eFrameworkunifiedStatusFail]
/// \~english @par Detail
/// API to synchronously read persistent data corresponding to a notification before NPPService is available
/// \~english @par
/// File reading by this API is exclusive control by semaphore,
/// and writing to non-voatie area is to use NPSynchronousWritePersistentData().
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Set Get
/// \~english @see NPSynchronousWritePersistentData
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus NPSynchronousWritePersistentData(PCSTR pAppName,
PCSTR notif_name,
PVOID pData,
const UI_32 uiDataSize,
const EFrameworkunifiedPersistCategory ePersistCategory = eFrameworkunifiedUserData);
#ifdef __cplusplus
}
#endif
#endif /* __NATIVESERVICES_NP_NOR_SERVICE_H__ */ // NOLINT (build/header_guard)
/** @}*/ // end of notification_persistent_service
/** @}*/ // end of native_service
/** @}*/ // end of BaseSystem
// EOF
|
