blob: 2b9081f5487eb15e1beb39beb74ff743b21fe815 (
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
File: OCTVC1_HW_API_PRIV.h
Copyright (c) 2017 Octasic Inc. All rights reserved.
Description: Contains the definition of the HW API.
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.09.00-B1607 (2017/08/29)
$Revision: $
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
#ifndef __OCTVC1_HW_API_PRIV_H__
#define __OCTVC1_HW_API_PRIV_H__
/***************************** INCLUDE FILES *******************************/
#include "octvc1_hw_api.h"
#include "octvc1_hw_id_priv.h"
#include "octvc1_hw_rc_priv.h"
/************************ COMMON DEFINITIONS *******************************/
/*-------------------------------------------------------------------------------------
MAIN API private definitions
-------------------------------------------------------------------------------------*/
#define cOCTVC1_HW_PRIVATE_API_CMD_PASSWORD 0x1FE75CB2
/***************************** METHODS *************************************/
/*-------------------------------------------------------------------------------------
tOCTVC1_HW_MSG_ETH_PORT_RESTRICTED_UNBLOCK_CMD
Private restricted api unblock command and response structure.
Members:
Header
OCTVC1 Message Header
ulPortIndex
Unique ETH port identifier
ulPassword
Default: cOCTVC1_HW_PRIVATE_API_CMD_PASSWORD
Command password!
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_MSG_HEADER Header;
tOCTVC1_INDEX ulPortIndex;
tOCT_UINT32 ulPassword;
} tOCTVC1_HW_MSG_ETH_PORT_RESTRICTED_UNBLOCK_CMD;
/*-------------------------------------------------------------------------------------
tOCTVC1_HW_MSG_ETH_PORT_RESTRICTED_UNBLOCK_RSP
Members:
Header
OCTVC1 Message Header
ulPortIndex
Unique ETH port identifier
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_MSG_HEADER Header;
tOCTVC1_INDEX ulPortIndex;
} tOCTVC1_HW_MSG_ETH_PORT_RESTRICTED_UNBLOCK_RSP;
/*-------------------------------------------------------------------------------------
tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_START_SYNCHRO_CMD
Members:
Header
OCTVC1 Message Header
ulDacInitValue
Default: 0x00007600
DAC initial value.
ulSyncWindowSize
Default: 7
Number of consecutive values within iSyncThreshold to consider that the clock
manager is synchronized to its reference.
lSyncThreshold
Default: 10
Maximum allowed delta to consider that the clock manager is synchronized to its
reference.
ulFrequencyCorrectionFlag
Set to cOCT_TRUE when frequency correction should be applied.
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_MSG_HEADER Header;
tOCT_UINT32 ulDacInitValue;
tOCT_UINT32 ulSyncWindowSize;
tOCT_INT32 lSyncThreshold;
tOCT_BOOL32 ulFrequencyCorrectionFlag;
} tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_START_SYNCHRO_CMD;
/*-------------------------------------------------------------------------------------
tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_START_SYNCHRO_RSP
Members:
Header
OCTVC1 Message Header
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_MSG_HEADER Header;
} tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_START_SYNCHRO_RSP;
/*-------------------------------------------------------------------------------------
tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_STOP_SYNCHRO_CMD
Members:
Header
OCTVC1 Message Header
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_MSG_HEADER Header;
} tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_STOP_SYNCHRO_CMD;
/*-------------------------------------------------------------------------------------
tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_STOP_SYNCHRO_RSP
Members:
Header
OCTVC1 Message Header
-------------------------------------------------------------------------------------*/
typedef struct
{
tOCTVC1_MSG_HEADER Header;
} tOCTVC1_HW_MSG_CLOCK_SYNC_MGR_STOP_SYNCHRO_RSP;
/*************** INCLUDE FILES WITH DEPENDENCIES ON THIS FILE **************/
#include "octvc1_hw_evt_priv.h"
#endif /* __OCTVC1_HW_API_PRIV_H__ */
|
