SKELETON NAME (emulator)

Skeleton outline: Single line description.

Function

Skeleton outline: The functionality of the component: how it should produce outputs and volatile property values based on inputs and parameter/initial/writable property values (not how it is implemented, as that belongs in worker documentation).

The mathematical representation of the component function is given in (1).

(1)\[y[n] = \alpha * x[n]\]

In (1):

  • \(x[n]\) is the input values.

  • \(y[n]\) is the output values.

  • Skeleton, etc.,

A block diagram representation of the component function is given in Figure 3:.

Skeleton alternative text.

Figure 3: Caption text.

Interface

Opcode Handling

Skeleton outline: Description of how the non-stream opcodes are handled.

Properties

  • violation

    • Type: bool

    • Access:

      • Parameter: False

      • Writable: True

      • Initial: False

      • Volatile: True

    • Default value: None

Ports

Inputs:

None.

Outputs:

None.

Implementations

Example Application

<?xml version="1.0"?>
<application done="file_write">
  <instance component="ocpi.core.file_read" connect="emulator">
    <property name="filename" value="input.bin"/>
  </instance>
  <instance component="ocpi.core.components.emulator" connect="file_write">
    <!-- Skeleton application outline, set properties here. Or change this
         example application to do something more real-world appropriate if
         file-read, then component, then file-write is too artifical to be a
         useful example. -->
  </instance>
  <instance component="ocpi.core.file_write">
    <property name="filename" value="output.bin"/>
  </instance>
</application>

Dependencies

The dependencies to other elements in OpenCPI are:

  • Skeleton outline: List primitives or other files within OpenCPI that are used (no need to list protocols).

There is also a dependency on:

  • ieee.std_logic_1164

  • ieee.numeric_std

  • Skeleton outline: Any other standard C++ or HDL packages.

Limitations

Limitations of emulator are:

  • Skeleton outline: List any limitations, or state “None.” if there are none.

Testing

Tested platforms: None