Skip to content

Commit fdf3670

Browse files
committed
Document critical section
1 parent 31123ff commit fdf3670

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,10 @@ impl<'rx, 'tx> Eth<'rx, 'tx> {
8888
///
8989
/// Make sure that the buffers reside in a memory region that is
9090
/// accessible by the peripheral. Core-Coupled Memory (CCM) is
91-
/// usually not accessible. Also, HCLK must be between 25MHz and 168MHz to use the ethernet
92-
/// peripheral.
91+
/// usually not accessible. HCLK must be between 25MHz and 168MHz for STM32F4xx
92+
/// or 25MHz to 216MHz for STM32F7xx.
93+
///
94+
/// Uses an interrupt free critical section to turn on the ethernet clock for STM32F7xx.
9395
///
9496
/// Other than that, initializes and starts the Ethernet hardware
9597
/// so that you can [`send()`](#method.send) and

0 commit comments

Comments
 (0)