futuresdr 0.0.39

An Experimental Async SDR Runtime for Heterogeneous Architectures.
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
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
use serde::ser::SerializeTuple;
use serde::ser::Serializer;
use wasm_bindgen::prelude::*;
use wasm_bindgen_futures::JsFuture;
use web_sys::WorkerGlobalScope;

use crate::prelude::*;

const TRANSFER_SIZE: usize = 262144;

#[allow(dead_code)]
#[repr(u8)]
enum Request {
    SetTransceiverMode = 1,
    Max2837Write = 2,
    Max2837Read = 3,
    Si5351CWrite = 4,
    Si5351CRead = 5,
    SampleRateSet = 6,
    BasebandFilterBandwidthSet = 7,
    Rffc5071Write = 8,
    Rffc5071Read = 9,
    SpiflashErase = 10,
    SpiflashWrite = 11,
    SpiflashRead = 12,
    BoardIdRead = 14,
    VersionStringRead = 15,
    SetFreq = 16,
    AmpEnable = 17,
    BoardPartidSerialnoRead = 18,
    SetLnaGain = 19,
    SetVgaGain = 20,
    SetTxvgaGain = 21,
    AntennaEnable = 23,
    SetFreqExplicit = 24,
    UsbWcidVendorReq = 25,
    InitSweep = 26,
    OperacakeGetBoards = 27,
    OperacakeSetPorts = 28,
    SetHwSyncMode = 29,
    Reset = 30,
    OperacakeSetRanges = 31,
    ClkoutEnable = 32,
    SpiflashStatus = 33,
    SpiflashClearStatus = 34,
    OperacakeGpioTest = 35,
    CpldChecksum = 36,
    UiEnable = 37,
}

impl From<Request> for u8 {
    fn from(r: Request) -> Self {
        r as u8
    }
}

#[allow(dead_code)]
#[repr(u8)]
enum TransceiverMode {
    Off = 0,
    Receive = 1,
    Transmit = 2,
    SS = 3,
    CpldUpdate = 4,
    RxSweep = 5,
}

#[derive(thiserror::Error, Debug, Clone)]
pub enum Error {
    #[error("Argument")]
    Argument,
    #[error("Browser error")]
    BrowserError(String),
}

impl From<TransceiverMode> for u8 {
    fn from(m: TransceiverMode) -> Self {
        m as u8
    }
}

impl From<TransceiverMode> for u16 {
    fn from(m: TransceiverMode) -> Self {
        m as u16
    }
}

impl From<JsValue> for Error {
    fn from(e: JsValue) -> Self {
        Self::BrowserError(format!("{e:?}"))
    }
}

/// WASM-native HackRf Source
#[derive(Block)]
#[message_inputs(freq, vga, lna, amp, sample_rate)]
pub struct HackRf {
    #[output]
    output: slab::Writer<Complex32>,
    buffer: [i8; TRANSFER_SIZE],
    offset: usize,
    device: Option<web_sys::UsbDevice>,
}

unsafe impl Send for HackRf {}

impl Default for HackRf {
    fn default() -> Self {
        Self::new()
    }
}

impl HackRf {
    /// Create HackRf Source
    pub fn new() -> Self {
        Self {
            output: slab::Writer::default(),
            buffer: [0; TRANSFER_SIZE],
            offset: TRANSFER_SIZE,
            device: None,
        }
    }

    async fn freq(
        &mut self,
        _io: &mut WorkIo,
        _mio: &mut MessageOutputs,
        _meta: &mut BlockMeta,
        p: Pmt,
    ) -> Result<Pmt> {
        let res = match &p {
            Pmt::F32(v) => self.set_freq(*v as u64).await,
            Pmt::F64(v) => self.set_freq(*v as u64).await,
            Pmt::U32(v) => self.set_freq(*v as u64).await,
            Pmt::U64(v) => self.set_freq(*v).await,
            _ => return Ok(Pmt::InvalidValue),
        };
        if res.is_ok() {
            Ok(Pmt::Ok)
        } else {
            Ok(Pmt::InvalidValue)
        }
    }

    async fn lna(
        &mut self,
        _io: &mut WorkIo,
        _mio: &mut MessageOutputs,
        _meta: &mut BlockMeta,
        p: Pmt,
    ) -> Result<Pmt> {
        let res = match &p {
            Pmt::F32(v) => self.set_lna_gain(*v as u16).await,
            Pmt::F64(v) => self.set_lna_gain(*v as u16).await,
            Pmt::U32(v) => self.set_lna_gain(*v as u16).await,
            Pmt::U64(v) => self.set_lna_gain(*v as u16).await,
            _ => return Ok(Pmt::InvalidValue),
        };
        if res.is_ok() {
            Ok(Pmt::Ok)
        } else {
            Ok(Pmt::InvalidValue)
        }
    }

    async fn vga(
        &mut self,
        _io: &mut WorkIo,
        _mio: &mut MessageOutputs,
        _meta: &mut BlockMeta,
        p: Pmt,
    ) -> Result<Pmt> {
        let res = match &p {
            Pmt::F32(v) => self.set_vga_gain(*v as u16).await,
            Pmt::F64(v) => self.set_vga_gain(*v as u16).await,
            Pmt::U32(v) => self.set_vga_gain(*v as u16).await,
            Pmt::U64(v) => self.set_vga_gain(*v as u16).await,
            _ => return Ok(Pmt::InvalidValue),
        };
        if res.is_ok() {
            Ok(Pmt::Ok)
        } else {
            Ok(Pmt::InvalidValue)
        }
    }

    async fn amp(
        &mut self,
        _io: &mut WorkIo,
        _mio: &mut MessageOutputs,
        _meta: &mut BlockMeta,
        p: Pmt,
    ) -> Result<Pmt> {
        let res = match &p {
            Pmt::Bool(b) => self.set_amp_enable(*b).await,
            _ => return Ok(Pmt::InvalidValue),
        };
        if res.is_ok() {
            Ok(Pmt::Ok)
        } else {
            Ok(Pmt::InvalidValue)
        }
    }

    async fn sample_rate(
        &mut self,
        _io: &mut WorkIo,
        _mio: &mut MessageOutputs,
        _meta: &mut BlockMeta,
        p: Pmt,
    ) -> Result<Pmt> {
        let res = match &p {
            Pmt::F32(v) => self.set_sample_rate_auto(*v as f64).await,
            Pmt::F64(v) => self.set_sample_rate_auto(*v).await,
            Pmt::U32(v) => self.set_sample_rate_auto(*v as f64).await,
            Pmt::U64(v) => self.set_sample_rate_auto(*v as f64).await,
            _ => return Ok(Pmt::InvalidValue),
        };
        if res.is_ok() {
            Ok(Pmt::Ok)
        } else {
            Ok(Pmt::InvalidValue)
        }
    }
    async fn read_control<const N: usize>(
        &self,
        request: Request,
        value: u16,
        index: u16,
    ) -> Result<[u8; N], Error> {
        let mut buf: [u8; N] = [0; N];
        let parameter = web_sys::UsbControlTransferParameters::new(
            index,
            web_sys::UsbRecipient::Device,
            request.into(),
            web_sys::UsbRequestType::Vendor,
            value,
        );

        let transfer = self
            .device
            .as_ref()
            .unwrap()
            .control_transfer_in(&parameter, N as u16);

        let data = JsFuture::from(transfer)
            .await?
            .dyn_into::<web_sys::UsbInTransferResult>()
            .unwrap()
            .data()
            .unwrap()
            .dyn_into::<js_sys::DataView>()
            .unwrap();

        for (i, b) in buf.iter_mut().enumerate().take(N) {
            *b = data.get_uint8(i);
        }

        Ok(buf)
    }

    async fn write_control(
        &mut self,
        request: Request,
        value: u16,
        index: u16,
        buf: &mut [u8],
    ) -> Result<(), Error> {
        let parameter = web_sys::UsbControlTransferParameters::new(
            index,
            web_sys::UsbRecipient::Device,
            request.into(),
            web_sys::UsbRequestType::Vendor,
            value,
        );

        let transfer = self
            .device
            .as_ref()
            .unwrap()
            .control_transfer_out_with_u8_slice(&parameter, buf)
            .unwrap();

        let _ = JsFuture::from(transfer)
            .await?
            .dyn_into::<web_sys::UsbOutTransferResult>()
            .unwrap();

        Ok(())
    }

    // Helper for set_freq
    fn freq_params(hz: u64) -> [u8; 8] {
        const MHZ: u64 = 1_000_000;

        let l_freq_mhz: u32 = u32::try_from(hz / MHZ).unwrap_or(u32::MAX).to_le();
        let l_freq_hz: u32 = u32::try_from(hz - u64::from(l_freq_mhz) * MHZ)
            .unwrap_or(u32::MAX)
            .to_le();

        [
            (l_freq_mhz & 0xFF) as u8,
            ((l_freq_mhz >> 8) & 0xFF) as u8,
            ((l_freq_mhz >> 16) & 0xFF) as u8,
            ((l_freq_mhz >> 24) & 0xFF) as u8,
            (l_freq_hz & 0xFF) as u8,
            ((l_freq_hz >> 8) & 0xFF) as u8,
            ((l_freq_hz >> 16) & 0xFF) as u8,
            ((l_freq_hz >> 24) & 0xFF) as u8,
        ]
    }

    async fn set_freq(&mut self, hz: u64) -> Result<(), Error> {
        let mut buf: [u8; 8] = Self::freq_params(hz);
        self.write_control(Request::SetFreq, 0, 0, &mut buf).await
    }

    async fn set_hw_sync_mode(&mut self, value: u8) -> Result<(), Error> {
        self.write_control(Request::SetHwSyncMode, value.into(), 0, &mut [])
            .await
    }

    async fn set_amp_enable(&mut self, en: bool) -> Result<(), Error> {
        self.write_control(Request::AmpEnable, en.into(), 0, &mut [])
            .await
    }

    async fn set_baseband_filter_bandwidth(&mut self, hz: u32) -> Result<(), Error> {
        self.write_control(
            Request::BasebandFilterBandwidthSet,
            (hz & 0xFFFF) as u16,
            (hz >> 16) as u16,
            &mut [],
        )
        .await
    }

    const MAX_N: usize = 32;

    #[allow(unused_assignments)]
    async fn set_sample_rate_auto(&mut self, freq: f64) -> Result<(), Error> {
        let freq_frac = 1.0 + freq - freq.trunc();

        let mut d = freq;
        let u = unsafe { &mut *(&mut d as *mut f64 as *mut u64) };
        let e = (*u >> 52) - 1023;
        let mut m = (1u64 << 52) - 1;

        d = freq_frac;
        *u &= m;
        m &= !((1 << (e + 4)) - 1);
        let mut a = 0;

        let mut i = 1;
        for _ in 1..Self::MAX_N {
            a += *u;
            if ((a & m) == 0) || ((!a & m) == 0) {
                break;
            }
            i += 1;
        }

        if i == Self::MAX_N {
            i = 1;
        }

        let freq_hz = (freq * i as f64 + 0.5).trunc() as u32;
        let divider = i as u32;

        self.set_sample_rate(freq_hz, divider).await
    }

    async fn set_sample_rate(&mut self, hz: u32, div: u32) -> Result<(), Error> {
        let hz: u32 = hz.to_le();
        let div: u32 = div.to_le();
        let mut buf: [u8; 8] = [
            (hz & 0xFF) as u8,
            ((hz >> 8) & 0xFF) as u8,
            ((hz >> 16) & 0xFF) as u8,
            ((hz >> 24) & 0xFF) as u8,
            (div & 0xFF) as u8,
            ((div >> 8) & 0xFF) as u8,
            ((div >> 16) & 0xFF) as u8,
            ((div >> 24) & 0xFF) as u8,
        ];
        self.write_control(Request::SampleRateSet, 0, 0, &mut buf)
            .await?;
        self.set_baseband_filter_bandwidth((0.75 * (hz as f32) / (div as f32)) as u32)
            .await
    }

    async fn set_transceiver_mode(&mut self, mode: TransceiverMode) -> Result<(), Error> {
        self.write_control(Request::SetTransceiverMode, mode.into(), 0, &mut [])
            .await
    }

    async fn set_lna_gain(&mut self, gain: u16) -> Result<(), Error> {
        if gain > 40 {
            Err(Error::Argument)
        } else {
            let buf: [u8; 1] = self
                .read_control(Request::SetLnaGain, 0, gain & !0x07)
                .await?;
            if buf[0] == 0 {
                Err(Error::Argument)
            } else {
                Ok(())
            }
        }
    }

    async fn set_vga_gain(&mut self, gain: u16) -> Result<(), Error> {
        if gain > 62 {
            Err(Error::Argument)
        } else {
            let buf: [u8; 1] = self
                .read_control(Request::SetVgaGain, 0, gain & !0b1)
                .await?;
            if buf[0] == 0 {
                Err(Error::Argument)
            } else {
                Ok(())
            }
        }
    }

    async fn fill_buffer(&mut self) -> Result<(), Error> {
        let transfer = self
            .device
            .as_ref()
            .unwrap()
            .transfer_in(1, TRANSFER_SIZE as u32);

        let data = JsFuture::from(transfer)
            .await?
            .dyn_into::<web_sys::UsbInTransferResult>()
            .unwrap()
            .data()
            .unwrap()
            .dyn_into::<js_sys::DataView>()
            .unwrap();

        debug_assert_eq!(data.byte_length(), TRANSFER_SIZE);
        for i in 0..TRANSFER_SIZE {
            self.buffer[i] = data.get_int8(i);
        }
        self.offset = 0;

        Ok(())
    }
}

#[doc(hidden)]
impl Kernel for HackRf {
    async fn init(&mut self, _m: &mut MessageOutputs, _b: &mut BlockMeta) -> Result<()> {
        let usb = {
            if let Some(window) = web_sys::window() {
                let navigator: web_sys::Navigator = window.navigator();
                navigator.usb()
            } else {
                let scope: WorkerGlobalScope = js_sys::global()
                    .dyn_into()
                    .expect("Neither window nor Worker context exists.");
                let navigator = scope.navigator();
                navigator.usb()
            }
        };

        let filter: serde_json::Value = serde_json::from_str(r#"{ "vendorId": 7504 }"#).unwrap();
        let s = serde_wasm_bindgen::Serializer::new().serialize_maps_as_objects(true);
        let mut tup = s.serialize_tuple(1).unwrap();
        tup.serialize_element(&filter).unwrap();
        let filter = tup.end().unwrap();
        let filter = web_sys::UsbDeviceRequestOptions::new(filter.as_ref());

        let devices: js_sys::Array = JsFuture::from(usb.get_devices())
            .await
            .map_err(Error::from)?
            .into();

        for i in 0..devices.length() {
            let d: web_sys::UsbDevice = devices.get(0).dyn_into().unwrap();
            println!("dev {}   {:?}", i, &d);
        }
        // Open radio if one is already paired and plugged
        // Otherwise ask the user to pair a new radio
        let device: web_sys::UsbDevice = if devices.length() > 0 {
            info!("device already connected");
            devices.get(0).dyn_into().unwrap()
        } else {
            info!("requesting device: {:?}", &filter);
            JsFuture::from(usb.request_device(&filter))
                .await
                .map_err(Error::from)?
                .dyn_into()
                .map_err(Error::from)?
        };

        info!("opening device");
        JsFuture::from(device.open()).await.map_err(Error::from)?;
        info!("selecting configuration");
        JsFuture::from(device.select_configuration(1))
            .await
            .map_err(Error::from)?;

        info!("claiming device");
        JsFuture::from(device.claim_interface(0))
            .await
            .map_err(Error::from)?;

        self.device = Some(device);
        self.set_sample_rate(8_000_000, 2).await.unwrap();
        self.set_hw_sync_mode(0).await.unwrap();
        self.set_freq(2_480_000_000).await.unwrap();
        self.set_vga_gain(4).await.unwrap();
        self.set_lna_gain(24).await.unwrap();
        self.set_amp_enable(true).await.unwrap();
        self.set_transceiver_mode(TransceiverMode::Receive)
            .await
            .unwrap();

        Ok(())
    }

    async fn work(
        &mut self,
        io: &mut WorkIo,
        _mio: &mut MessageOutputs,
        _meta: &mut BlockMeta,
    ) -> Result<()> {
        let o = self.output.slice();

        let n = std::cmp::min(o.len(), (TRANSFER_SIZE - self.offset) / 2);

        for (i, out) in o.iter_mut().enumerate().take(n) {
            *out = Complex32::new(
                (self.buffer[self.offset + i * 2] as f32) / 128.0,
                (self.buffer[self.offset + i * 2 + 1] as f32) / 128.0,
            );
        }

        self.output.produce(n);
        self.offset += n * 2;
        if self.offset == TRANSFER_SIZE {
            self.fill_buffer().await.unwrap();
            io.call_again = true;
        }

        Ok(())
    }
}