summaryrefslogtreecommitdiff
path: root/cesar/mac/pbproc/src/fsm_rx_sound.c
blob: 756d61dde82d64863ff3b14913cfadb2355eaeca (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
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
/* Cesar project {{{
 *
 * Copyright (C) 2009 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    mac/pbproc/src/fsm_rx_sound.c
 * \brief   FSM RX SOUND part.
 * \ingroup mac_pbproc
 */
#include "common/std.h"

#include "inc/context.h"
#include "inc/fc.h"
#include "inc/fsm_rx_sound.h"

#include "hal/phy/pbdma.h"

/**
 * Restart VCS for next MPDU.
 * \param  ctx  pbproc context
 */
static void
pbproc_frso_vcs_restart (pbproc_t *ctx);

void
pbproc_frso_init (pbproc_t *ctx)
{
    dbg_assert (ctx);
    ctx->fsm.states[PBPROC_FSM_STATE_RX_SOUND].pbdma_cb =
        CALLBACK (pbproc_frso__rx_sound__pbdma);
}

/**
 * Decrement sound counter and check if sound transmission is completed.
 * \param  ctx  pbproc context
 * \param  tei  source tei
 * \param  src  received sound reason code
 * \param  offset_tck  offset since the start of beacon period
 * \param  flp_tck  frame length, with preamble and IFS
 * \return  true if sound is completed
 */
static bool
pbproc_frso_sound_complete (pbproc_t *ctx, uint tei, uint src,
                            uint offset_tck, uint flp_tck)
{
    dbg_claim (ctx);
    sta_t *sta = mac_store_sta_get_noref (ctx->store, tei);
    if (sta)
    {
        u8 zero_counter = 0;
        u8 *counter;
        tonemaps_t *tms = sta->rx_tonemaps;
        if (src != TONEMAP_SRC_INTERVAL_UNAVAILABLE
            && src != TONEMAP_SRC_INTERVAL_UNUSABLE)
            counter = &tms->sound_frame_counter;
        else
        {
            uint interval = tonemap_interval_find (
                tms, MAC_TCK_TO_ATU (offset_tck + flp_tck / 2));
            if (interval >= tms->intervals->intervals_nb)
            {
                counter = &zero_counter;
            }
            else
            {
                uint interval_in_group = interval
                    % tms->intervals->group_intervals_nb;
                counter = &tms->group_interval_sound_frame_counter
                    [interval_in_group];
            }
        }
        if (*counter)
            (*counter)--;
        bool complete = *counter == 0;
        return complete;
    }
    else
        return true;
}

void ARCH_ILRAM_PRIO (2)
pbproc_frso__handle (pbproc_t *ctx, u32 rx_date,
                     const pbproc_fc_sound_t *sound)
{
    dbg_claim (ctx);
    dbg_claim (sound);
    /* Update stats. */
    ctx->stats.rx_sound++;
    /* Get tonemap. */
    tonemap_t *tm;
    phy_mod_t mod = sound->pbsz ? PHY_MOD_MINI_ROBO : PHY_MOD_ROBO;
    tm = &ctx->config->tonemask_info.tonemap_robo[mod];
    /* Compute symbol number. */
    phy_pb_size_t pb_size = sound->pbsz ? PHY_PB_SIZE_136 : PHY_PB_SIZE_520;
    uint fl_tck = MAC_FL_TO_TCK (sound->fl_av);
    uint bits_per_pb = tm->bits_per_pb[pb_size];
    uint symb_nb = (1 * bits_per_pb + tm->bits_per_symbol - 1) /
        tm->bits_per_symbol;
    /* Save early needed received MPDU parameters. */
    ctx->recv_mpdu.rx_params.mpdu_cnt = sound->mpdu_cnt;
    ctx->recv_mpdu.ack_date = rx_date + ctx->times.pre_fcs_tck + fl_tck;
    /* Ignore frames ending after the allocation, handle pool exhaustion. */
    bool pool_shortage = ctx->rx_pool_size < 1 + ctx->chandata_nb;
    if (pool_shortage
        || (!ctx->alloc.merge
            && less_mod2p32 (ctx->alloc.end_date + MAC_TOLERANCE_TCK,
                             rx_date + 2 * ctx->times.pre_fcs_tck + fl_tck)))
    {
        if (pool_shortage)
            ctx->stats.rx_pool_shortage++;
        else
            ctx->stats.rx_out_of_alloc++;
        /* Unblock hardware. */
        phy_rx_prepare_short (ctx->phy);
        /* Prepare for next. */
        pbproc_frso_vcs_restart (ctx);
        /* Return to IDLE state. */
        pbproc_fsm_change_state (ctx, PBPROC_FSM_STATE_IDLE);
        /* Stop now. */
        return;
    }
    /* May skip channel data reception. */
    bool chandata = ctx->chandata_nb != 0;
    /* Default to true to keep the sender to flood with SOUND frames. */
    bool sound_complete = true;
    if (chandata)
    {
        /* Unblock hardware. */
        phy_rx_prepare_sound (ctx->phy, 1, tm->phy_combo_params[pb_size],
                              tm->gil, symb_nb);
        /* Is sound completed? */
        sound_complete = pbproc_frso_sound_complete (
            ctx, sound->stei, sound->src,
            rx_date - ctx->alloc.beacon_period_start_date,
            ctx->times.pre_fcs_tck + fl_tck);
        /* Update stats. */
        if (sound_complete)
            ctx->stats.rx_sound_complete++;
    }
    else
    {
        /* Skip frame. */
        phy_rx_prepare_short (ctx->phy);
        /* Update stats. */
        ctx->stats.rx_sound_drop++;
    }
    /* Save received MPDU parameters. */
    ctx->recv_mpdu.rx_params.preamble_ntb = rx_date
        + ctx->config->ntb_offset_tck;
    ctx->recv_mpdu.rx_params.beacon_period_start_ntb =
        ctx->alloc.beacon_period_start_date + ctx->config->ntb_offset_tck;
    ctx->recv_mpdu.rx_params.fl_tck = fl_tck;
    ctx->recv_mpdu.rx_params.tei = sound->stei;
    ctx->recv_mpdu.rx_params.lid = sound->lid;
    ctx->recv_mpdu.rx_params.snid = sound->snid;
    ctx->recv_mpdu.rx_params.bcast = false;
    ctx->recv_mpdu.rx_params.cfp = sound->cfs;
    ctx->recv_mpdu.rx_params.multi_net_bcast = false;
    ctx->recv_mpdu.rx_params.sound = true;
    ctx->recv_mpdu.rx_params.eks = MAC_EKS_CLEAR;
    ctx->recv_mpdu.rx_params.pending_seg_info = sound->ppb;
    ctx->recv_mpdu.rx_params.ble = 0;
    ctx->recv_mpdu.rx_params.pb_size = pb_size;
    ctx->recv_mpdu.rx_params.tmi_av = mod;
    ctx->recv_mpdu.rx_params.bdf = sound->bdf;
    ctx->recv_mpdu.rx_params.hp10df = false;
    ctx->recv_mpdu.rx_params.hp11df = false;
    ctx->recv_mpdu.rx_params.mfs_cmd_data = MFS_FSM_CMD_NOP;
    ctx->recv_mpdu.rx_params.mfs_cmd_mme = MFS_FSM_CMD_NOP;
    ctx->recv_mpdu.rx_params.sound_src = sound->src;
    ctx->recv_mpdu.rx_params.sound_req_tm = sound->req_tm;
    ctx->recv_mpdu.rx_params.sound_complete = sound_complete;
    ctx->recv_mpdu.pb_nb = 0;
    /* Keep a block to store received MPDU parameters. */
    dbg_assert (ctx->rx_pool_size >= 1);
    pb_t *last = ctx->rx_pool_head;
    ctx->recv_mpdu.rx_desc = (pbproc_rx_desc_t *) last;
    /* Prepare channel data blocks and give them to PB DMA. */
    if (chandata)
    {
        uint i;
        /* Take from RX pool. */
        ctx->recv_mpdu.chandata_head = last->next;
        ctx->recv_mpdu.chandata_nb = ctx->chandata_nb;
        /* Fill configuration. */
        for (i = 0; i < ctx->chandata_nb; i++)
        {
            last = last->next;
            last->phy_pb.chandata.conf = ctx->chandata_conf[i];
        }
        /* Start PB DMA. */
        phy_pbdma_start_chandata (
            ctx->phy, &ctx->recv_mpdu.chandata_head->phy_pb.chandata);
        /* Unchain used blocks. */
        slist_slice (ctx->rx_pool_, last, 1 + ctx->recv_mpdu.chandata_nb,
                     paste_size);
    }
    else
    {
        ctx->recv_mpdu.chandata_head = NULL;
        ctx->recv_mpdu.chandata_nb = 0;
    }
    /* Program VCS. */
    pbproc_frso_vcs_restart (ctx);
    /* Wait end of frame if receiving channel data, else continue now. */
    if (chandata)
        pbproc_fsm_change_state (ctx, PBPROC_FSM_STATE_RX_SOUND);
    else
        pbproc_frso__rx_sound__pbdma (ctx);
}

void ARCH_ILRAM_PRIO (2)
pbproc_frso__rx_sound__pbdma (pbproc_t *ctx)
{
    dbg_claim (ctx);
    const bool hybrid = ctx->alloc.hybrid;
    if (ctx->recv_mpdu.rx_params.mpdu_cnt == 0)
    {
        /* Anticipate FC 1.0. */
        if (hybrid)
            phy_tx_fc10 (ctx->phy, ctx->recv_mpdu.ack_date, 0);
        /* Prepare SOUND acknowledgment. */
        pbproc_fc_t fc;
        fc.words[0] = BF_FILL (
            PBPROC_FC_SOUND_W0,
            (DT_AV, PBPROC_FC_DT_SOUND),
            (ACCESS, false),
            (SNID, ctx->alloc.snid),
            (STEI, ctx->config->tei),
            (DTEI, ctx->recv_mpdu.rx_params.tei),
            (LID, ctx->recv_mpdu.rx_params.lid));
        fc.words[1] = BF_FILL (
            PBPROC_FC_SOUND_W1,
            (CFS, ctx->recv_mpdu.rx_params.cfp),
            (PBSZ, false),
            (BDF, ctx->detect.beacon_detected),
            (SAF, true),
            (SCF, ctx->recv_mpdu.rx_params.sound_complete),
            (REQ_TM, 0),
            (FL_AV, 0),
            (MPDU_CNT, 0),
            (RESERVED0, 0),
            (PPB, 0));
        fc.words[2] = BF_FILL (
            PBPROC_FC_SOUND_W2,
            (SRC, 0),
            (RESERVED1, 0));
        fc.words[3] = BF_FILL (
            PBPROC_FC_SOUND_W3,
            (RESERVED2, 0));
        /* Send it. */
        phy_tx_param_short (ctx->phy,
                            PHY_FC_MODE (hybrid, ctx->config->fc_symbols_nb));
        phy_tx_frame (ctx->phy, ctx->recv_mpdu.ack_date, false, true,
                      fc.words);
    }
    /* Received frame is given to upper layer in DSR. */
    if (ctx->recv_mpdu.chandata_nb)
    {
        pbproc_rx_desc_t *rx = ctx->recv_mpdu.rx_desc;
        rx->rx->params = ctx->recv_mpdu.rx_params;
        rx->rx->mfs = NULL;
        rx->rx->mfs_mme = NULL;
        rx->rx->pb_first = NULL;
        rx->rx->pb_last = NULL;
        rx->rx->pb_nb = 0;
        rx->rx->chandata_first = ctx->recv_mpdu.chandata_head;
        rx->rx->chandata_nb = ctx->recv_mpdu.chandata_nb;
        slist_push_back (ctx->commit.rx_, rx);
        pbproc_fsm_schedule_deferred (ctx);
        dbg_invalid_ptr (ctx->recv_mpdu.chandata_head);
    }
    /* Return to IDLE. */
    pbproc_fsm_change_state (ctx, PBPROC_FSM_STATE_IDLE);
}

static void ARCH_ILRAM_PRIO (2)
pbproc_frso_vcs_restart (pbproc_t *ctx)
{
    dbg_claim (ctx);
    /* Restart VCS. */
    if (ctx->recv_mpdu.rx_params.mpdu_cnt == 0)
    {
        ca_access_vcs_restart (ctx->ca, ctx->recv_mpdu.ack_date
                               + ctx->times.pre_fcs_tck + MAC_CIFS_TCK);
    }
    else
    {
        ca_access_vcs_restart_eifs (ctx->ca, ctx->recv_mpdu.ack_date);
        phy_rx_activate (ctx->phy, false, ctx->recv_mpdu.ack_date
                         + PHY_RX_ACTIVATE_DELAY_AFTER_BURST_TCK, true);
    }
}