esb-ng 0.1.0

Implementation of Nordic's Enhanced ShockBurst communication protocol
Documentation 
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

use crate::{
    app::{Addresses, EsbApp},
    irq::{Disabled, EsbIrq, IrqTimer},
    peripherals::{EsbRadio, EsbTimer},
    Config, Error,
};
use core::{
    marker::PhantomData,
    sync::atomic::{AtomicBool, Ordering},
};
use bbq2::{nicknames::Texas, traits::notifier::maitake::MaiNotSpsc};
use nrf_pac::radio::Radio;

/// This is the backing structure for the ESB interface
///
/// It is intended to live at `'static` scope, and provides
/// storage for the `EsbApp` and `EsbIrq` interfaces
///
/// ## Creating at static scope
///
/// Currently due to lacking const generics, the UX for this
/// isn't great. You'll probably want something like this:
///
/// ## NOTE
///
/// Although the members of this struct are public, due to const
/// generic limitations, they are not intended to be used directly,
/// outside of `static` creation.
///
/// This could cause unintended, though not undefined, behavior.
///
/// TL;DR: It's not unsafe, but it's also not going to work correctly.
///
/// ```rust
/// // This creates an ESB storage structure with room for
/// // 512 bytes of outgoing packets (including headers),
/// // and 256 bytes of incoming packets (including
/// // headers).
/// # use esb::{BBBuffer, consts::*, ConstBBBuffer, EsbBuffer};
/// # use core::sync::atomic::AtomicBool;
/// static BUFFER: EsbBuffer<U512, U256> = EsbBuffer {
///     app_to_radio_buf: BBBuffer( ConstBBBuffer::new() ),
///     radio_to_app_buf: BBBuffer( ConstBBBuffer::new() ),
///     timer_flag: AtomicBool::new(false),
/// };
/// ```
pub struct EsbBuffer<const OUT: usize, const IN: usize>
{
    pub app_to_radio_buf: Texas<OUT, MaiNotSpsc>,
    pub radio_to_app_buf: Texas<IN, MaiNotSpsc>,
    pub timer_flag: AtomicBool,
}

impl<const OUT: usize, const IN: usize> EsbBuffer<OUT, IN>
{
    /// Attempt to split the `static` buffer into handles for Interrupt and App context
    ///
    /// This function will only succeed once. If the underlying buffers have also
    /// been split directly, this function will also fail.
    ///
    /// Upon splitting, the Radio will be initialized and set to
    /// [IdleTx](enum.State.html#variant.IdleTx).
    #[allow(clippy::type_complexity)]
    pub fn try_split<T: EsbTimer>(
        &'static self,
        timer: T,
        radio: Radio,
        addresses: Addresses,
        config: Config,
    ) -> Result<
        (
            EsbApp<OUT, IN>,
            EsbIrq<OUT, IN, T, Disabled>,
            IrqTimer<T>,
        ),
        Error,
    > {
        let (atr_prod, atr_cons) = (
            self.app_to_radio_buf.framed_producer(),
            self.app_to_radio_buf.framed_consumer(),
        );
        let (rta_prod, rta_cons) = (
            self.radio_to_app_buf.framed_producer(),
            self.radio_to_app_buf.framed_consumer(),
        );

        // Clear the timer flag
        self.timer_flag.store(false, Ordering::Release);

        let app = EsbApp {
            prod_to_radio: atr_prod,
            cons_from_radio: rta_cons,
            maximum_payload: config.maximum_payload_size,
        };

        let mut irq = EsbIrq {
            prod_to_app: rta_prod,
            cons_from_app: atr_cons,
            timer,
            radio: EsbRadio::new(radio),
            state: Disabled,
            addresses,
            attempts: 0,
            timer_flag: &self.timer_flag,
            config,
        };

        let irq_timer = IrqTimer {
            timer_flag: &self.timer_flag,
            _timer: PhantomData,
        };

        irq.radio.init(
            irq.config.maximum_payload_size,
            irq.config.tx_power,
            &irq.addresses,
        );
        irq.timer.init();

        Ok((app, irq, irq_timer))
    }
}