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
|
/*************************************************************************************************************
Copyright (c) 2012-2015, Symphony Teleca Corporation, a Harman International Industries, Incorporated company
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS LISTED "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS LISTED BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Attributions: The inih library portion of the source code is licensed from
Brush Technology and Ben Hoyt - Copyright (c) 2009, Brush Technology and Copyright (c) 2009, Ben Hoyt.
Complete license and copyright information can be found at
https://github.com/benhoyt/inih/commit/74d2ca064fb293bc60a77b0bd068075b293cf175.
*************************************************************************************************************/
/*
* MODULE SUMMARY : NULL interface module.
*
* This NULL interface module neither sends or receives data but will
* exercise the various functions and callback and can be used as an example
* or a template for new interfaces.
*/
#include <stdlib.h>
#include <string.h>
#include "openavb_types_pub.h"
#include "openavb_trace_pub.h"
#include "openavb_mediaq_pub.h"
#include "openavb_intf_pub.h"
#define AVB_LOG_COMPONENT "Null Interface"
#include "openavb_log_pub.h"
typedef struct {
/////////////
// Config data
/////////////
// Ignore timestamp at listener.
bool ignoreTimestamp;
/////////////
// Variable data
/////////////
} pvt_data_t;
// Each configuration name value pair for this mapping will result in this callback being called.
void openavbIntfNullCfgCB(media_q_t *pMediaQ, const char *name, const char *value)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
if (pMediaQ) {
char *pEnd;
long tmp;
pvt_data_t *pPvtData = pMediaQ->pPvtIntfInfo;
if (!pPvtData) {
AVB_LOG_ERROR("Private interface module data not allocated.");
return;
}
if (strcmp(name, "intf_nv_ignore_timestamp") == 0) {
tmp = strtol(value, &pEnd, 10);
if (*pEnd == '\0' && tmp == 1) {
pPvtData->ignoreTimestamp = (tmp == 1);
}
}
}
AVB_TRACE_EXIT(AVB_TRACE_INTF);
}
void openavbIntfNullGenInitCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
AVB_TRACE_EXIT(AVB_TRACE_INTF);
}
// A call to this callback indicates that this interface module will be
// a talker. Any talker initialization can be done in this function.
void openavbIntfNullTxInitCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
AVB_TRACE_EXIT(AVB_TRACE_INTF);
}
// This callback will be called for each AVB transmit interval. Commonly this will be
// 4000 or 8000 times per second.
bool openavbIntfNullTxCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF_DETAIL);
if (pMediaQ) {
//pvt_data_t *pPvtData = pMediaQ->pPvtIntfInfo;
media_q_item_t *pMediaQItem = openavbMediaQHeadLock(pMediaQ);
if (pMediaQItem) {
openavbAvtpTimeSetToWallTime(pMediaQItem->pAvtpTime);
// Set 1 byte
*(U8 *)(pMediaQItem->pPubData) = 0xff;
pMediaQItem->dataLen = 1;
openavbMediaQHeadPush(pMediaQ);
AVB_TRACE_EXIT(AVB_TRACE_INTF_DETAIL);
return TRUE;
}
else {
AVB_TRACE_EXIT(AVB_TRACE_INTF_DETAIL);
return FALSE; // Media queue full
}
}
AVB_TRACE_EXIT(AVB_TRACE_INTF_DETAIL);
return FALSE;
}
// A call to this callback indicates that this interface module will be
// a listener. Any listener initialization can be done in this function.
void openavbIntfNullRxInitCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
AVB_TRACE_EXIT(AVB_TRACE_INTF);
}
// This callback is called when acting as a listener.
bool openavbIntfNullRxCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF_DETAIL);
if (pMediaQ) {
bool moreItems = TRUE;
pvt_data_t *pPvtData = pMediaQ->pPvtIntfInfo;
if (!pPvtData) {
AVB_LOG_ERROR("Private interface module data not allocated.");
return FALSE;
}
while (moreItems) {
media_q_item_t *pMediaQItem = openavbMediaQTailLock(pMediaQ, pPvtData->ignoreTimestamp);
if (pMediaQItem) {
openavbMediaQTailPull(pMediaQ);
}
else {
moreItems = FALSE;
}
}
}
AVB_TRACE_EXIT(AVB_TRACE_INTF_DETAIL);
return FALSE;
}
// This callback will be called when the interface needs to be closed. All shutdown should
// occur in this function.
void openavbIntfNullEndCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
AVB_TRACE_EXIT(AVB_TRACE_INTF);
}
void openavbIntfNullGenEndCB(media_q_t *pMediaQ)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
AVB_TRACE_EXIT(AVB_TRACE_INTF);
}
// Main initialization entry point into the interface module
extern DLL_EXPORT bool openavbIntfNullInitialize(media_q_t *pMediaQ, openavb_intf_cb_t *pIntfCB)
{
AVB_TRACE_ENTRY(AVB_TRACE_INTF);
if (pMediaQ) {
pMediaQ->pPvtIntfInfo = calloc(1, sizeof(pvt_data_t)); // Memory freed by the media queue when the media queue is destroyed.
if (!pMediaQ->pPvtIntfInfo) {
AVB_LOG_ERROR("Unable to allocate memory for AVTP interface module.");
return FALSE;
}
pvt_data_t *pPvtData = pMediaQ->pPvtIntfInfo;
pIntfCB->intf_cfg_cb = openavbIntfNullCfgCB;
pIntfCB->intf_gen_init_cb = openavbIntfNullGenInitCB;
pIntfCB->intf_tx_init_cb = openavbIntfNullTxInitCB;
pIntfCB->intf_tx_cb = openavbIntfNullTxCB;
pIntfCB->intf_rx_init_cb = openavbIntfNullRxInitCB;
pIntfCB->intf_rx_cb = openavbIntfNullRxCB;
pIntfCB->intf_end_cb = openavbIntfNullEndCB;
pIntfCB->intf_gen_end_cb = openavbIntfNullGenEndCB;
pPvtData->ignoreTimestamp = FALSE;
}
AVB_TRACE_EXIT(AVB_TRACE_INTF);
return TRUE;
}
|
