sid/component/rtc/hw-rtc-sid.txt

   1 * Name
   2   hw-rtc-sid
   3
   4 * Synopsis
   5   This component is a fictional simplified high-precision real time clock.
   6
   7   Buses: registers
   8
   9   Library: librtc.la
  10   Symbol name: rtc_component_library
  11
  12 * Functionality
  13
  14   - Modelling
  15     * This component is similar to high-precision dedicated counters
  16       present as performance tuning aids in some microprocessors.  It
  17       supplies snapshots of the host systems' time to a target application.
  18
  19   - Behaviors
  20     * Timing
  21
  22       Whenever this component's bus is read with a valid address, it
  23       returns the addressed subset of two words of information.  The
  24       first word (address 0x0) contains the number of seconds since the
  25       host system's epoch.  The second word (address 0x4) contains the
  26       number of nanoseconds within that second.  Both words are supplied
  27       in big-endian order.
  28
  29   - SID conventions
  30
  31     * This is a functional component.
  32     * It has no state to save, and has no use for triggerpoints.
  33
  34 * Environment
  35
  36   - Related components
  37     * To use this component, map it into 8 bytes of address
  38       space, as in the following sample configuration file fragment:
  39
  40         new hw-rtc-sid rtc
  41         connect-bus mapper [0x1000,0x1007] rtc registers
  42
  43   - Host system
  44     * The component relies on the accuracy and precision of UTC time
  45       maintained by the host.
  46
  47 * SID interface reference
  48   - low level:
  49     * buses
  50       - registers | 0x0 - 0x7 | read | timing