sid/component/glue/hw-glue-sequence.txt

   1             hw-glue-sequence (libglue.la :: glue_component_library)
   2
   3 Synopsis:
   4
   5    This component family distributes pin signals from a source to a sequence
   6    of sinks.
   7
   8      ----------------------------------------------------------------------
   9
  10 Functionality:
  11
  12   Modelling:
  13
  14      * This component resembles a fan-out net in a circuit, or a very fast
  15        shift register.
  16      * The number of outputs is a matter of configuration. For the -1, -2,
  17        and -8 family members, the num-outputs is initialized.
  18
  19    +-------------------------------------------------+
  20    |                    Behaviors                    |
  21    |-------------------------------------------------|
  22    |   configuration | When the num-outputs is       |
  23    |                 | written-to, this component    |
  24    |                 | adjusts its list of output    |
  25    |                 | pins, named output-0,         |
  26    |                 | output-1, and so on. New ones |
  27    |                 | may be generated or old ones  |
  28    |                 | may disappear.                |
  29    |-----------------+-------------------------------|
  30    | data forwarding | Each input signal on the      |
  31    |                 | input pin is forwarded to all |
  32    |                 | external pins connected to    |
  33    |                 | the output-0 pin, then        |
  34    |                 | output-1, and so on, in       |
  35    |                 | sequence, for all configured  |
  36    |                 | outputs.                      |
  37    +-------------------------------------------------+
  38
  39    +-------------------------------------------------+
  40    |                 SID Conventions                 |
  41    |-------------------------------------------------|
  42    |    functional | supported | This is a           |
  43    |               |           | functional          |
  44    |               |           | component.          |
  45    |---------------+-----------+---------------------|
  46    |         state | supported | This component      |
  47    |  save/restore |           | supports state      |
  48    |               |           | save/restore,       |
  49    |               |           | though state is     |
  50    |               |           | minimal (the number |
  51    |               |           | of outputs).        |
  52    |---------------+-----------+---------------------|
  53    | triggerpoints | supported | This component      |
  54    |               |           | supports            |
  55    |               |           | triggerpoints by    |
  56    |               |           | watching the input  |
  57    |               |           | pin and the         |
  58    |               |           | num-outputs         |
  59    |               |           | attribute.          |
  60    |---------------+-----------+---------------------|
  61    |     Recursion | supported | This component      |
  62    |       Control |           | limits recursion on |
  63    |               |           | the input pin.      |
  64    |---------------+-----------+---------------------|
  65    |  presentation | supported | This component      |
  66    |               |           | presents attributes |
  67    |               |           | in the "pin",       |
  68    |               |           | "setting", and      |
  69    |               |           | "watchable"         |
  70    |               |           | categories.         |
  71    +-------------------------------------------------+
  72
  73      ----------------------------------------------------------------------
  74
  75 Environment:
  76
  77    Related components
  78
  79    This component may be used as an initialization sequencer in a scenario
  80    with ordering dependencies. See this configuration fragment:
  81
  82          new hw-glue-sequence reset-manager
  83          new SOME_KIND_OF_CPU cpu
  84          new SOME_KIND_OF_LOADER loader
  85          set reset-manager num-outputs 3
  86          connect-pin reset-manager input <- main running
  87          connect-pin reset-manager output-0 -> cpu reset
  88          connect-pin reset-manager output-1 -> loader load!
  89
  90    It could be used as a central point to distribute a many-to-many broadcast
  91    signal.
  92
  93      ----------------------------------------------------------------------
  94
  95 Component Reference:
  96
  97   Component: hw-glue-sequence (Abstract)
  98
  99    +---------------------------------------------------+
 100    |                       pins                        |
 101    |---------------------------------------------------|
 102    |    name    | direction | legalvalues | behaviors  |
 103    |------------+-----------+-------------+------------|
 104    |input       |in         |any          |data        |
 105    |            |           |             |forwarding  |
 106    |------------+-----------+-------------+------------|
 107    |output-NNN  |out        |any          |data        |
 108    |            |           |             |forwarding  |
 109    +---------------------------------------------------+
 110
 111    +------------------------------------------------------------------+
 112    |                            attributes                            |
 113    |------------------------------------------------------------------|
 114    |     name     | category  | legal values |default|   behaviors   ||
 115    |              |           |              | value |               ||
 116    |--------------+-----------+--------------+-------+---------------||
 117    |state-snapshot|no category|opaque string |-      |state          ||
 118    |              |           |              |       |save/restore   ||
 119    |--------------+-----------+--------------+-------+---------------||
 120    |num-outputs   |setting,   |small positive|0      |configuration  ||
 121    |              |watchable  |number        |       |               ||
 122    |--------------+-----------+--------------+-------+---------------||
 123    |input         |pin,       |-             |-      |data forwarding||
 124    |              |watchable  |              |       |               ||
 125    +------------------------------------------------------------------+
 126
 127   Variant: hw-glue-sequence-1
 128
 129    Same as hw-glue-sequence
 130
 131   Variant: hw-glue-sequence-2
 132
 133    Same as hw-glue-sequence
 134
 135   Variant: hw-glue-sequence-8
 136
 137    Same as hw-glue-sequence