blob: a62eb0642ab740fdf653910679f50eddb9d56cb3 (
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
|
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
File: OCTVC1_API.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_API_H__
#define __OCTVC1_API_H__
/***************************** INCLUDE FILES *******************************/
#include "../octdev_types.h"
#include "octvc1_module.h"
/************************ COMMON DEFINITIONS *******************************/
#define cOCTVC1_API_SESSION_INDEX_CURRENT_TRANSPORT 0xF0000000 /* Select the session used by the current transport. */
/*-------------------------------------------------------------------------------------
tOCTVC1_API_SESSION_INFO
API SESSION information
Members:
ulActiveFlag
Session active flag
ulSessionId
Session id
ulTransportSessionIndex
Session Index use to transport this command
ulTransportSessionId
Session ID use to transport this command
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_BOOL32 ulActiveFlag;
tOCT_UINT32 ulSessionId;
tOCTVC1_INDEX ulTransportSessionIndex;
tOCT_UINT32 ulTransportSessionId;
} tOCTVC1_API_SESSION_INFO;
/*-------------------------------------------------------------------------------------
tOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK : API SYSTEM event module mask.
-------------------------------------------------------------------------------------*/
#define tOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK tOCT_UINT32
#define cOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK_NONE 0x00000000
#define cOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK_MAIN ((tOCT_UINT32)(0x00000001<<cOCTVC1_MODULE_ID_ENUM_MAIN) )
#define cOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK_JOB ((tOCT_UINT32)(0x00000001<<cOCTVC1_MODULE_ID_ENUM_JOB) )
#define cOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK_HW ((tOCT_UINT32)(0x00000001<<cOCTVC1_MODULE_ID_ENUM_HW) )
#define cOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK_IRSC ((tOCT_UINT32)(0x00000001<<cOCTVC1_MODULE_ID_ENUM_IRSC) )
/*-------------------------------------------------------------------------------------
tOCTVC1_API_SESSION_EVT_INFO
API SESSION Event Info
Members:
ulEvtActiveFlag
Host event activate flag
lEvtEnablerCnt
The number of entities that have enabled events on this session
ulSystemEvtMask
System module enabled events on this session
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCT_BOOL32 ulEvtActiveFlag;
tOCT_INT32 lEvtEnablerCnt;
tOCTVC1_API_SESSION_EVT_SYSTEM_MODULE_MASK ulSystemEvtMask;
} tOCTVC1_API_SESSION_EVT_INFO;
/*-------------------------------------------------------------------------------------
API Version Format
-------------------------------------------------------------------------------------*/
/*-------------------------------------------------------------------------------------
tOCTVC1_API_VERSION_MASK :
-------------------------------------------------------------------------------------*/
#define tOCTVC1_API_VERSION_MASK tOCT_UINT32
#define cOCTVC1_API_VERSION_MASK_MAJOR_BIT_MASK 0x0000001F
#define cOCTVC1_API_VERSION_MASK_MAJOR_BIT_OFFSET 27
#define cOCTVC1_API_VERSION_MASK_MAJOR ((tOCT_UINT32)(cOCTVC1_API_VERSION_MASK_MAJOR_BIT_MASK<<cOCTVC1_API_VERSION_MASK_MAJOR_BIT_OFFSET) )
#define cOCTVC1_API_VERSION_MASK_MINOR_BIT_MASK 0x0000003F
#define cOCTVC1_API_VERSION_MASK_MINOR_BIT_OFFSET 21
#define cOCTVC1_API_VERSION_MASK_MINOR ((tOCT_UINT32)(cOCTVC1_API_VERSION_MASK_MINOR_BIT_MASK<<cOCTVC1_API_VERSION_MASK_MINOR_BIT_OFFSET) )
#define cOCTVC1_API_VERSION_MASK_MAINTENANCE_BIT_MASK 0x0000003F
#define cOCTVC1_API_VERSION_MASK_MAINTENANCE_BIT_OFFSET 15
#define cOCTVC1_API_VERSION_MASK_MAINTENANCE ((tOCT_UINT32)(cOCTVC1_API_VERSION_MASK_MAINTENANCE_BIT_MASK<<cOCTVC1_API_VERSION_MASK_MAINTENANCE_BIT_OFFSET) )
#define cOCTVC1_API_VERSION_MASK_BUILD_BIT_MASK 0x00007FFF
#define cOCTVC1_API_VERSION_MASK_BUILD_BIT_OFFSET 0
#define cOCTVC1_API_VERSION_MASK_BUILD ((tOCT_UINT32)(cOCTVC1_API_VERSION_MASK_BUILD_BIT_MASK<<cOCTVC1_API_VERSION_MASK_BUILD_BIT_OFFSET) )
#endif /* __OCTVC1_API_H__ */
|