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
|
/* DTX DL AMR FSM */
/* (C) 2016 by sysmocom s.f.m.c. GmbH
*
* All Rights Reserved
*
* 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/>.
*
*/
#include <osmo-bts/dtx_dl_amr_fsm.h>
#include <osmo-bts/logging.h>
void dtx_fsm_voice(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_VOICE:
case E_FACCH:
break;
case E_SID_F:
case E_SID_U:
osmo_fsm_inst_state_chg(fi, ST_SID_F1, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Inexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_sid_f1(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_SID_F:
/* FIXME: what shall we do if we get SID-FIRST _again_ (twice in a row)?
Was observed during testing, let's just ignore it for now */
break;
case E_SID_U:
osmo_fsm_inst_state_chg(fi, ST_SID_U, 0, 0);
break;
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_ONSET_F, 0, 0);
break;
case E_COMPL:
osmo_fsm_inst_state_chg(fi, ST_SID_F2, 0, 0);
break;
case E_INHIB:
osmo_fsm_inst_state_chg(fi, ST_F1_INH, 0, 0);
break;
case E_ONSET:
osmo_fsm_inst_state_chg(fi, ST_ONSET_V, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_sid_f2(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_SID_U:
osmo_fsm_inst_state_chg(fi, ST_SID_U, 0, 0);
break;
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_ONSET_F, 0, 0);
break;
case E_ONSET:
osmo_fsm_inst_state_chg(fi, ST_ONSET_V, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_f1_inh(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_ONSET_V, 0, 0);
break;
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_ONSET_F, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_u_inh(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_FACCH, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_sid_upd(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_ONSET_F, 0, 0);
break;
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_INHIB:
osmo_fsm_inst_state_chg(fi, ST_U_INH, 0, 0);
break;
case E_SID_U:
case E_SID_F:
/* FIXME: what shall we do if we get SID-FIRST _after_ sending SID-UPDATE?
Was observed during testing, let's just ignore it for now */
break;
case E_ONSET:
osmo_fsm_inst_state_chg(fi, ST_ONSET_V, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_onset_v(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_SID_F:
case E_SID_U:
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_FACCH_V, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_onset_f(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_SID_F:
case E_SID_U:
break;
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_FACCH:
osmo_fsm_inst_state_chg(fi, ST_FACCH, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_facch_v(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_FACCH:
break;
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_SID_U:
break;
case E_SID_F:
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
void dtx_fsm_facch(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case E_FACCH:
break;
case E_VOICE:
osmo_fsm_inst_state_chg(fi, ST_VOICE, 0, 0);
break;
case E_SID_U:
case E_SID_F:
osmo_fsm_inst_state_chg(fi, ST_SID_F1, 0, 0);
break;
default:
LOGP(DL1P, LOGL_ERROR, "Unexpected event %d\n", event);
OSMO_ASSERT(0);
break;
}
}
static struct osmo_fsm_state dtx_dl_amr_fsm_states[] = {
/* default state for non-DTX and DTX when SPEECH is in progress */
[ST_VOICE] = {
.in_event_mask = X(E_SID_F) | X(E_SID_U) | X(E_VOICE) | X(E_FACCH),
.out_state_mask = X(ST_SID_F1),
.name = "Voice",
.action = dtx_fsm_voice,
},
/* SID-FIRST or SID-FIRST-P1 in case of AMR HR:
start of silence period (might be interrupted in case of AMR HR) */
[ST_SID_F1]= {
.in_event_mask = X(E_SID_F) | X(E_SID_U) | X(E_VOICE) | X(E_FACCH) | X(E_COMPL) | X(E_INHIB) | X(E_ONSET),
.out_state_mask = X(ST_SID_U) | X(ST_VOICE) | X(ST_ONSET_F) | X(ST_SID_F2) | X(ST_F1_INH) | X(ST_ONSET_V),
.name = "SID-FIRST (P1)",
.action = dtx_fsm_sid_f1,
},
/* SID-FIRST P2 (only for AMR HR):
actual start of silence period in case of AMR HR*/
[ST_SID_F2]= {
.in_event_mask = X(E_SID_U) | X(E_VOICE) | X(E_FACCH) | X(E_ONSET),
.out_state_mask = X(ST_SID_U) | X(ST_VOICE) | X(ST_ONSET_F) | X(ST_ONSET_V),
.name = "SID-FIRST (P2)",
.action = dtx_fsm_sid_f2,
},
/* SID-FIRST Inhibited:
incoming SPEECH or FACCH (only for AMR HR) */
[ST_F1_INH]= {
.in_event_mask = X(E_VOICE) | X(E_FACCH),
.out_state_mask = X(ST_VOICE) | X(ST_FACCH_V),
.name = "SID-FIRST (Inh)",
.action = dtx_fsm_f1_inh,
},
/* SID-UPDATE Inhibited:
incoming SPEECH or FACCH (only for AMR HR) */
[ST_U_INH]= {
.in_event_mask = X(E_VOICE) | X(E_FACCH),
.out_state_mask = X(ST_VOICE) | X(ST_FACCH),
.name = "SID-UPDATE (Inh)",
.action = dtx_fsm_u_inh,
},
/* Silence period with periodic comfort noise data updates */
[ST_SID_U]= {
.in_event_mask = X(E_FACCH) | X(E_VOICE) | X(E_INHIB) | X(E_SID_U) | X(E_SID_F) | X(E_ONSET),
.out_state_mask = X(ST_ONSET_F) | X(ST_VOICE) | X(ST_U_INH) | X(ST_SID_U) | X(ST_ONSET_V),
.name = "SID-UPDATE",
.action = dtx_fsm_sid_upd,
},
/* ONSET - end of silent period due to incoming SPEECH frame */
[ST_ONSET_V]= {
.in_event_mask = X(E_SID_F) | X(E_SID_U) | X(E_VOICE) | X(E_FACCH),
.out_state_mask = X(ST_VOICE) | X(ST_FACCH_V),
.name = "ONSET (SPEECH)",
.action = dtx_fsm_onset_v,
},
/* ONSET - end of silent period due to incoming FACCH frame */
[ST_ONSET_F]= {
.in_event_mask = X(E_VOICE) | X(E_FACCH) | X(E_SID_U) | X(E_SID_F),
.out_state_mask = X(ST_VOICE) | X(ST_FACCH),
.name = "ONSET (FACCH)",
.action = dtx_fsm_onset_f,
},
/* FACCH sending state: SPEECH was observed before so once we're done
FSM should get back to VOICE state */
[ST_FACCH_V]= {
.in_event_mask = X(E_FACCH) | X(E_VOICE) | X(E_SID_U) | X(E_SID_F),
.out_state_mask = X(ST_FACCH_V) | X(ST_VOICE) | X(ST_SID_F1),
.name = "FACCH (SPEECH)",
.action = dtx_fsm_facch_v,
},
/* FACCH sending state: no SPEECH was observed before so once we're done
FSM should get back to silent period via SID-FIRST */
[ST_FACCH]= {
.in_event_mask = X(E_FACCH) | X(E_VOICE) | X(E_SID_U) | X(E_SID_F),
.out_state_mask = X(ST_FACCH_V) | X(ST_VOICE) | X(ST_SID_F1),
.name = "FACCH",
.action = dtx_fsm_facch,
},
};
const struct value_string dtx_dl_amr_fsm_event_names[] = {
{ E_VOICE, "Voice" },
{ E_ONSET, "ONSET" },
{ E_FACCH, "FACCH" },
{ E_COMPL, "Complete P1 -> P2" },
{ E_INHIB, "Inhibit" },
{ E_SID_F, "SID-FIRST" },
{ E_SID_U, "SID-UPDATE" },
{ 0, NULL }
};
struct osmo_fsm dtx_dl_amr_fsm = {
.name = "DTX DL AMR FSM",
.states = dtx_dl_amr_fsm_states,
.num_states = ARRAY_SIZE(dtx_dl_amr_fsm_states),
.event_names = dtx_dl_amr_fsm_event_names,
.log_subsys = DL1C,
};
|
