blob: f2da3ff975c76aa2968e0a39a941f9bc4e661602 (
plain)
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
|
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
File: OCTVC1_FILE.h
Copyright (c) 2018 Octasic Inc. All rights reserved.
Description:
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Release: OCTSDR Software Development Kit OCTSDR_GSM-02.10.00-B1837 (2018/02/21)
$Revision: $
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
#ifndef __OCTVC1_FILE_H__
#define __OCTVC1_FILE_H__
/***************************** INCLUDE FILES *******************************/
#include "../octdev_types.h"
/************************ COMMON DEFINITIONS *******************************/
/*-------------------------------------------------------------------------------------
File Header magic - indicates if file should be swapped because
different endianness.
"\x7F""OCT".
0x7F4F4354 the magic word
0x54434F7F the magic word backwards ( file needs to be swapped)
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_ENDIAN_MAGIC_WORD 0x7F4F4354
#define cOCTVC1_FILE_ENDIAN_MAGIC_WORD_SWAPPED 0x54434F7F
/*-------------------------------------------------------------------------------------
File name string length restriction.
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_NAME_MAX_LENGTH 127
/*-------------------------------------------------------------------------------------
tOCTVC1_FILE_TYPE_ENUM : File Type description
-------------------------------------------------------------------------------------*/
#define tOCTVC1_FILE_TYPE_ENUM tOCT_UINT32
#define cOCTVC1_FILE_TYPE_ENUM_NONE 0
#define cOCTVC1_FILE_TYPE_ENUM_TEXT 1
#define cOCTVC1_FILE_TYPE_ENUM_BIN 2
#define cOCTVC1_FILE_TYPE_ENUM_SCRAMBLED 3
#define cOCTVC1_FILE_TYPE_ENUM_ENCRYPT_RSA_2048 4
#define cOCTVC1_FILE_TYPE_ENUM_SCRAMBLED_ENCRYPT_RSA_2048 5
/*-------------------------------------------------------------------------------------
tOCTVC1_FILE_FORMAT_ENUM : File Type description
-------------------------------------------------------------------------------------*/
#define tOCTVC1_FILE_FORMAT_ENUM tOCT_UINT32
#define cOCTVC1_FILE_FORMAT_ENUM_NONE 0
#define cOCTVC1_FILE_FORMAT_ENUM_LOG 1
#define cOCTVC1_FILE_FORMAT_ENUM_INFRACTION 2
/*-------------------------------------------------------------------------------------
File Header Type
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_TYPE_BIT_OFFSET 24
#define cOCTVC1_FILE_TYPE_BIT_MASK 0xFF000000
/*-------------------------------------------------------------------------------------
File Header Format Version
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_FORMAT_VERSION_BIT_OFFSET 16
#define cOCTVC1_FILE_FORMAT_VERSION_BIT_MASK 0x00FF0000
/*-------------------------------------------------------------------------------------
File Header Format
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_FORMAT_BIT_OFFSET 0
#define cOCTVC1_FILE_FORMAT_BIT_MASK 0x0000FFFF
/*-------------------------------------------------------------------------------------
File Header Size
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_HEADER_SIZE_BIT_OFFSET 0
#define cOCTVC1_FILE_HEADER_SIZE_BIT_MASK 0x0000FFFF
/*-------------------------------------------------------------------------------------
Minimum alignment in bytes.
-------------------------------------------------------------------------------------*/
#define cOCTVC1_FILE_MIN_ALIGN_BIT_OFFSET 16
#define cOCTVC1_FILE_MIN_ALIGN_BIT_MASK 0x00FF0000
/*-------------------------------------------------------------------------------------
tOCTVC1_FILE_HEADER
Generic file header
Members:
ulMagic
Default: cOCTVC1_FILE_ENDIAN_MAGIC_WORD
Magic file number.
"\x7F""OCT".
0x54434F7F on little endian machine.
0x7F4F4354 on big endian machine
ul_Type_Ver
bits[31:24] = File Type.
bits[23:16] = File Format Version.
bits[15:0] = File Format.
ulTimeStamp
Time Stamp of when file was first written.
ul_Align_HdrSize
Minimum alignment in bytes. This indicates the minumum size of a payload in the
file,
that was used to ensure proper alignment (depends on architecture).
Header size with padding. This indicate where the file payload start (in byte).
bits[31:24] = Reserved.
bits[23:16] = Minimum alignment in bytes.
bits[15:0] = Header Size with padding.
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_UINT32 ulMagic;
tOCT_UINT32 ul_Type_Ver;
tOCT_UINT32 ulTimeStamp;
tOCT_UINT32 ul_Align_HdrSize;
} tOCTVC1_FILE_HEADER;
#endif /* __OCTVC1_FILE_H__ */
|
