libbladerf-rs 0.5.0

Fully Rust native BladeRF driver
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

//! Timestamp read access for RX and TX channels.
//!
//! Exposes the per-channel NIOS timestamp counter, which tickts at the
//! reference clock rate. Timestamps are used for stream sample alignment
//! and latency measurement.

use crate::bladerf1::board::RfLinkSession;
use crate::channel::Channel;
use crate::error::Result;
use crate::maybe_future::Op;
use nusb::MaybeFuture;

impl RfLinkSession<'_> {
    /// Reads the 64-bit timestamp counter for the given channel.
    ///
    /// The counter increments at the reference clock rate. Use this value
    /// alongside stream metadata timestamps to compute latency or correlate
    /// RX/TX samples.
    ///
    /// Returns `Error::BoardState` if the board is not initialized.
    pub fn get_timestamp(&mut self, channel: Channel) -> impl MaybeFuture<Output = Result<u64>> {
        Op::new(async move {
            self.require_initialized().await?;
            self.nios.nios_get_timestamp(channel).await
        })
    }
}