adding credit to @datdenkikniet (Johannes Draaijer)

stm32-rs · Sep 21, 2023 · 0f0c47c · 0f0c47c
1 parent 98597be
commit 0f0c47c
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 0 deletions.
diff --git a/src/ethernet/cache.rs b/src/ethernet/cache.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 #[cfg(feature = "ptp")]
 use crate::ptp::Timestamp;
 

diff --git a/src/ethernet/eth.rs b/src/ethernet/eth.rs
@@ -19,6 +19,10 @@
 //! > want to enable the cache, the simplest method would be to mark SRAM3
 //! > as uncacheable via the MPU.
 //!
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+//!
 //! [quartiq/stabilizer]: https://github.com/quartiq/stabilizer
 //! [notes]: https://github.com/quartiq/stabilizer/commit/ab1735950b2108eaa8d51eb63efadcd2e25c35c4
 

diff --git a/src/ethernet/mod.rs b/src/ethernet/mod.rs
@@ -5,6 +5,10 @@
 //! - SMSC LAN8742a
 //! - Micrel KSZ8081R
 //!
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+//!
 //! # Examples
 //!
 //! - [Simple link checker for the Nucleo-H743ZI2](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/ethernet-nucleo-h743zi2.rs)

diff --git a/src/ethernet/packet_id.rs b/src/ethernet/packet_id.rs
@@ -3,6 +3,10 @@
 /// This packet ID can be used to obtain information about a specific
 /// ethernet frame (either sent or received) from the DMA.
 ///
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 #[cfg_attr(
     feature = "ptp",
     doc = "

diff --git a/src/ethernet/raw_descriptor.rs b/src/ethernet/raw_descriptor.rs
@@ -1,3 +1,8 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
+
 //TODO remove
 // this is raw_descriptor
 use volatile_register::{RO, RW};

diff --git a/src/ethernet/rx/descriptor.rs b/src/ethernet/rx/descriptor.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 use core::sync::atomic::{self, Ordering};
 
 use crate::ethernet::{raw_descriptor::RawDescriptor, Cache, PacketId};

diff --git a/src/ethernet/rx/mod.rs b/src/ethernet/rx/mod.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 pub use descriptor::RxDescriptor;
 
 use super::{raw_descriptor::DescriptorRing, PacketId};

diff --git a/src/ethernet/tx/descriptor.rs b/src/ethernet/tx/descriptor.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 use core::sync::atomic::{self, Ordering};
 
 use crate::ethernet::{raw_descriptor::RawDescriptor, Cache, PacketId};

diff --git a/src/ethernet/tx/mod.rs b/src/ethernet/tx/mod.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 use super::{raw_descriptor::DescriptorRing, PacketId};
 use crate::stm32::ETHERNET_DMA;
 

diff --git a/src/ptp/mod.rs b/src/ptp/mod.rs
@@ -1,6 +1,9 @@
 //! PTP access and configuration.
 //!
 //! See [`EthernetPTP`] for a more details.
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
 
 use crate::ethernet::EthernetDMA;
 use crate::rcc::CoreClocks;

diff --git a/src/ptp/subseconds.rs b/src/ptp/subseconds.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 /// The amount of nanoseconds per second.
 pub const NANOS_PER_SECOND: u32 = 1_000_000_000;
 

diff --git a/src/ptp/timestamp.rs b/src/ptp/timestamp.rs
@@ -1,3 +1,7 @@
+//! This implementation is derived from 0BSD-relicensed work done by 
+//! Johannes Draaijer <[email protected]> for the 
+//! [`stm32-eth`](https://github.com/stm32-rs/stm32-eth) project
+
 use super::{Subseconds, NANOS_PER_SECOND};
 
 /// A timestamp produced by the PTP periperhal