-
Notifications
You must be signed in to change notification settings - Fork 25
/
cs_tbldefs.h
407 lines (384 loc) · 16.8 KB
/
cs_tbldefs.h
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/************************************************************************
* NASA Docket No. GSC-18,915-1, and identified as “cFS Checksum
* Application version 2.5.1”
*
* Copyright (c) 2021 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
* Specification for the CFS Checksum tables.
*/
#ifndef CS_TBLDEFS_H
#define CS_TBLDEFS_H
/**************************************************************************
**
** Include section
**
**************************************************************************/
#include <cfe.h>
/**************************************************************************
**
** Macro definitions
**
**************************************************************************/
/**
* \brief table names for definition tables
* \{
*/
#define CS_DEF_EEPROM_TABLE_NAME "DefEepromTbl"
#define CS_DEF_MEMORY_TABLE_NAME "DefMemoryTbl"
#define CS_DEF_TABLES_TABLE_NAME "DefTablesTbl"
#define CS_DEF_APP_TABLE_NAME "DefAppTbl"
/**\}*/
/**
* \brief names for the results tables
* \{
*/
#define CS_RESULTS_EEPROM_TABLE_NAME "ResEepromTbl"
#define CS_RESULTS_MEMORY_TABLE_NAME "ResMemoryTbl"
#define CS_RESULTS_TABLES_TABLE_NAME "ResTablesTbl"
#define CS_RESULTS_APP_TABLE_NAME "ResAppTbl"
/**\}*/
/**************************************************************************
**
** Type definitions
**
**************************************************************************/
/**
* \brief Data structure for the EEPROM or Memory definition table
*/
typedef struct
{
cpuaddr StartAddress; /**< \brief The Start address to Checksum */
uint16 State; /**< \brief Uses the CS_STATE_... defines from above */
uint16 Filler16; /** <\brief Padding */
uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */
} CS_Def_EepromMemory_Table_Entry_t;
/**
* \brief Data structure for the Eeporom or Memory results table
*/
typedef struct
{
cpuaddr StartAddress; /**< \brief The Start address to Checksum */
uint16 State; /**< \brief Uses the CS_STATE_... defines from above */
uint16 ComputedYet; /**< \brief Have we computed an Integrity value yet */
uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */
uint32 ComparisonValue; /**< \brief The Memory Integrity Value */
uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */
uint32 TempChecksumValue; /**< \brief The unfinished caluculation */
uint32 Filler32; /**< \brief Padding */
} CS_Res_EepromMemory_Table_Entry_t;
/**
* \brief Data structure for the Tables definition table
*/
typedef struct
{
uint16 State; /**< \brief Uses the CS_STATE_... defines from above */
char Name[CFE_TBL_MAX_FULL_NAME_LEN]; /**< \brief name of the table */
} CS_Def_Tables_Table_Entry_t;
/**
* \brief Data structure for the App definition table
*/
typedef struct
{
uint16 State; /**< \brief Uses the CS_STATE_... defines from above */
char Name[OS_MAX_API_NAME]; /**< \brief name of the app */
} CS_Def_App_Table_Entry_t;
/**
* \brief Data structure for the Tables result table
*/
typedef struct
{
cpuaddr StartAddress; /**< \brief The Start address to Checksum */
uint16 State; /**< \brief Uses the CS_STATE_... defines from above */
uint16 ComputedYet; /**< \brief Have we computed an Integrity value yet */
uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */
uint32 ComparisonValue; /**< \brief The Memory Integrity Value */
uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */
uint32 TempChecksumValue; /**< \brief The unfinished caluculation */
CFE_TBL_Handle_t TblHandle; /**< \brief handle recieved from CFE_TBL */
bool IsCSOwner; /**< \brief Is CS the original owner of this table */
bool Filler8; /**< \brief Padding */
char Name[CFE_TBL_MAX_FULL_NAME_LEN]; /**< \brief name of the table */
} CS_Res_Tables_Table_Entry_t;
/**
* \brief Data structure for the app result table
*/
typedef struct
{
cpuaddr StartAddress; /**< \brief The Start address to Checksum */
uint16 State; /**< \brief Uses the CS_STATE_... defines from above */
uint16 ComputedYet; /**< \brief Have we computed an Integrity value yet */
uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */
uint32 ComparisonValue; /**< \brief The Memory Integrity Value */
uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */
uint32 TempChecksumValue; /**< \brief The unfinished caluculation */
char Name[OS_MAX_API_NAME]; /**< \brief name of the app */
} CS_Res_App_Table_Entry_t;
/**************************************************************************
**
** Function Prototypes
**
**************************************************************************/
/**
* \brief Validate EEPROM definition table
*
* \par Description
* This function is a callback to cFE Table Services that gets called
* when a validation is requested.
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] TblPtr A pointer to the table to be validated
*
* \return Execution status see \ref CFEReturnCodes
* \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
* \retval #CS_TABLE_ERROR \copydoc CS_TABLE_ERROR
*/
CFE_Status_t CS_ValidateEepromChecksumDefinitionTable(void *TblPtr);
/**
* \brief Validate Memory definition table
*
* \par Description
* This function is a callback to cFE Table Services that gets called
* when a validation is requested.
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] TblPtr A pointer to the table to be validated
*
* \return Execution status see \ref CFEReturnCodes
* \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
* \retval #CS_TABLE_ERROR \copydoc CS_TABLE_ERROR
*/
CFE_Status_t CS_ValidateMemoryChecksumDefinitionTable(void *TblPtr);
/**
* \brief Validate Tables definition table
*
* \par Description
* This function is a callback to cFE Table Services that gets called
* when a validation is requested.
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] TblPtr A pointer to the table to be validated
*
* \return Execution status see \ref CFEReturnCodes
* \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
* \retval #CS_TABLE_ERROR \copydoc CS_TABLE_ERROR
*/
CFE_Status_t CS_ValidateTablesChecksumDefinitionTable(void *TblPtr);
/**
* \brief Validate App definition table
*
* \par Description
* This function is a callback to cFE Table Services that gets called
* when a validation is requested.
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] TblPtr A pointer to the table to be validated
*
* \return Execution status see \ref CFEReturnCodes
* \retval #CFE_SUCCESS \copydoc CFE_SUCCESS
* \retval #CS_TABLE_ERROR \copydoc CS_TABLE_ERROR
*/
CFE_Status_t CS_ValidateAppChecksumDefinitionTable(void *TblPtr);
/**
* \brief Processes a new definition table for EEPROM or Memory tables
*
* \par Description
* Copies data from the definition table to the results table
* because the results table is where CS keeps all of its
* checksum data
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] DefinitionTblPtr A pointer to the definiton table
* (#CS_Def_EepromMemory_Table_Entry_t)
* that we are operating on
*
* \param [in] ResultsTblPtr A pointer to the result table
* (#CS_Res_EepromMemory_Table_Entry_t)
* to operate on
* \param [in] NumEntries The number of entries in the table
* \param [in] Table The specific table we are operating on
*/
void CS_ProcessNewEepromMemoryDefinitionTable(const CS_Def_EepromMemory_Table_Entry_t *DefinitionTblPtr,
const CS_Res_EepromMemory_Table_Entry_t *ResultsTblPtr,
const uint16 NumEntries, const uint16 Table);
/**
* \brief Processes a new definition table for the Tables table
*
* \par Description
* Copies data from the definition table to the results table
* because the results table is where CS keeps all of its
* checksum data
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] DefinitionTblPtr A pointer to the definiton table
* (#CS_Def_Tables_Table_Entry_t)
* that we are operating on
*
* \param [in] ResultsTblPtr A pointer to the result table
* (#CS_Res_Tables_Table_Entry_t)
* to operate on
*/
void CS_ProcessNewTablesDefinitionTable(const CS_Def_Tables_Table_Entry_t *DefinitionTblPtr,
const CS_Res_Tables_Table_Entry_t *ResultsTblPtr);
/**
* \brief Processes a new definition table for the App table
*
* \par Description
* Copies data from the definition table to the results table
* because the results table is where CS keeps all of its
* checksum data
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] DefinitionTblPtr A pointer to the definiton table
* (#CS_Def_App_Table_Entry_t)
* that we are operating on
*
* \param [in] ResultsTblPtr A pointer to the result table
* (#CS_Res_App_Table_Entry_t)
* to operate on
*/
void CS_ProcessNewAppDefinitionTable(const CS_Def_App_Table_Entry_t *DefinitionTblPtr,
const CS_Res_App_Table_Entry_t *ResultsTblPtr);
/**
* \brief Initializes the results and definition table on startup
*
* \par Description
* Completes the Table Services registration and table load for
* the definition table and the registration for the results table
*
* \par Assumptions, External Events, and Notes:
* This function is used on all four type of tables individally.
* Also, if the default table file is not found for the definitionm
* table, this function loads a 'blank' table from memory
*
* \param [in] DefinitionTableHandle A #CFE_TBL_Handle_t pointer
* that will get filled in with the
* table handle to the definition
* table
*
* \param [in] ResultsTableHandle A #CFE_TBL_Handle_t pointer
* that will get filled in with the
* table handle to the results
* table
*
* \param [in] DefinitionTblPtr A pointer to the definiton table
* that we are operating on, it
* will get assigned during this
* call
*
* \param [in] ResultsTblPtr A pointer to the result table
* to operate on , it will get
* assigned during this call
*
* \param [in] Table The specific table we are
* operating on
*
* \param [in] DefinitionTableName The name of the definition table
*
* \param [in] ResultsTableName The name of the results table
*
* \param [in] NumEntries The number of entries in the
* table
*
* \param [in] DefinitionTableFileName The name of the file to load the
* definition table from
*
* \param [in] DefaultDefTableAddress The address of the default
* definition table that we may
* have to load from memory if
* the file is absent
*
* \param [in] SizeofDefinitionTableEntry The sizeof an entry in the
* definition table
*
* \param [in] SizeofResultsTableEntry The size of an enrty in the
* results table
*
* \param [in] CallBackFunction A pointer to a function used to
* validate the definition table
*
* \param [out] * DefinitionTableHandle A #CFE_TBL_Handle_t pointer that
* will get filled in with the tbl
* handle to the definition table
*
* \param [out] * ResultsTableHandle A #CFE_TBL_Handle_t pointer that
* will get filled in with the tbl
* handle to the results table
*
* \param [out] * DefinitionTblPtr A pointer to the definiton table
* that we are operating on
*
* \param [in] * ResultsTblPtr A pointer to the result table
* to operate on , it will get
* be used to access the table
*
* \return Execution status, see \ref CFEReturnCodes
* \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
*/
CFE_Status_t CS_TableInit(CFE_TBL_Handle_t *DefinitionTableHandle, CFE_TBL_Handle_t *ResultsTableHandle,
void *DefinitionTblPtr, void *ResultsTblPtr, const uint16 Table,
const char *DefinitionTableName, const char *ResultsTableName, const uint16 NumEntries,
const char *DefinitionTableFileName, const void *DefaultDefTableAddress,
const uint16 SizeofDefinitionTableEntry, const uint16 SizeofResultsTableEntry,
const CFE_TBL_CallbackFuncPtr_t CallBackFunction);
/**
* \brief Handles table updates for all CS tables
*
* \par Description
* Completes the handshake with Table Services that releases
* Addresses for the tables and checks for updates
*
* \par Assumptions, External Events, and Notes:
* None
*
* \param [in] DefinitionTblPtr A pointer to the definiton table
* that we are operating on
*
* \param [in] ResultsTblPtr A pointer to the result table
* to operate on
* \param [in] DefinitionTableHandle A table handle to the definition
* table
*
* \param [in] ResultsTableHandle A table handle to the results
* table
*
* \param [in] NumEntries The number of entries in the table
*
* \param [in] Table The specific table we are operating
* on
*
* \return Execution status, see \ref CFEReturnCodes
* \retval #CFE_SUCCESS \copybrief CFE_SUCCESS
*/
CFE_Status_t CS_HandleTableUpdate(void *DefinitionTblPtr, void *ResultsTblPtr,
const CFE_TBL_Handle_t DefinitionTableHandle,
const CFE_TBL_Handle_t ResultsTableHandle, const uint16 Table,
const uint16 NumEntries);
#endif