netlist: update documenation on noise sources.

This commit is contained in:
couriersud 2020-07-05 21:50:14 +02:00
parent d71717e75b
commit c4b9b2a3ac
2 changed files with 30 additions and 7 deletions

View File

@ -582,12 +582,35 @@ namespace devices
state_var<netlist_sig_t> m_last_state;
};
///
/// \brief noise source
///
/// An externally clocked noise source. The noise acts as a voltage source
/// with internal resistance RI.
///
/// Typical application:
///
/// VCC
/// |
/// R
/// R
/// R
/// |
/// +-----> Output
/// |
/// +-------+
/// | 1 |
/// --->| I |
/// | 2 |
/// +-------+
/// |
/// R
/// R
/// R
/// |
/// GND
///
// -----------------------------------------------------------------------------
// nld_sys_noise - noise source
//
// An externally clocked noise source.
// -----------------------------------------------------------------------------
template <typename E, template<class> class D>
NETLIB_OBJECT(sys_noise)
{

View File

@ -9,7 +9,7 @@
//! [noise_example]
#include "netlist/devices/net_lib.h"
// ./nltool -t 1 -l X.3 -l X.4 -n oscillator src/lib/netlist/examples/noise.cpp
// ./nltool -t 1 -l R1.2 -n noise src/lib/netlist/examples/noise.cpp
// X.3 : Square out
// X.4 : Triangle out
@ -19,7 +19,7 @@ NETLIST_START(noise)
CLOCK(nclk, 2000)
SYS_NOISE_MT_N(noise, 0.5)
SYS_NOISE_MT_U(noise, 2.5)
RES(R1,1000)
RES(R2,1000)