Skip to content

Commit b4fcf23

Browse files
committed
doc fix: timeout is in microseconds
1 parent 7076639 commit b4fcf23

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

nrf52840-hal/src/ieee802154.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -264,27 +264,27 @@ impl<'c> Radio<'c> {
264264
}
265265
}
266266

267-
/// Listens for a packet for no longer than the specified amount of milliseconds
267+
/// Listens for a packet for no longer than the specified amount of microseconds
268268
///
269269
/// If no packet is received within the specified time then the `Timeout` error is returned
270270
///
271271
/// If a packet is received within the time span then the packet CRC is checked. If the CRC is
272272
/// incorrect then the `Crc` error is returned; otherwise the `Ok` variant is returned.
273273
///
274274
/// Note that the time it takes to switch the radio to RX mode is included in the timeout count.
275-
/// This transition may take up to a hundred of milliseconds; see the section 6.20.15.8 in the
275+
/// This transition may take up to a hundred of microseconds; see the section 6.20.15.8 in the
276276
/// Product Specification for more details about timing
277277
pub fn recv_timeout<I>(
278278
&mut self,
279279
packet: &mut Packet,
280280
timer: &mut Timer<I>,
281-
millis: u32,
281+
microseconds: u32,
282282
) -> Result<u16, Error>
283283
where
284284
I: timer::Instance,
285285
{
286286
// Start the timeout timer
287-
timer.start(millis);
287+
timer.start(microseconds);
288288

289289
// Start the read
290290
self.start_recv(packet);

0 commit comments

Comments
 (0)