| ▼Framework Signals | State machine abstraction, array of record signals passed to every procedure call |
| state_reg_rec | Sequential logic portion of state machine configured by procedure calls (input to application modules) |
| next_state_rec | Combinatorial logic portion of state machine configured by procedure calls (output from application modules) |
| ▼HELPER API | |
| Timing Functions | Helper functions that calculate an integer number of clock cycles lapsed based on the resource clock frequency |
| Read From File Functions | Helper functions to read an array of data from a .dat file |
| DISABLE_FILE | Procedure to disable an application module from being incorporated at the top level and connected to the framework |
| RESOURCE_SELECT | Procedure for selecting clock domain and framework resource for components (overloaded) |
| ▼COUNTER API | |
| CONFIGURE_COUNTER | Procedure to count clock cycles, signal edges or transitions. (overloaded) |
| RESET_COUNTER | Procedure to reset a general purpose counter back to count zero. (overloaded) |
| TIME_COUNTER | Procedure to set hardware timeouts and generate timing patterns (overloaded) |
| ▼COMMUNICATIONS API | |
| WRITE_FIFO_DATA | Procedure to write data to a fifo buffer (or register) for 'data path' communications (overloaded) |
| READ_FIFO_DATA | Procedure to read data from a fifo buffer (or register) for 'data path' communications (overloaded) |
| RESET_FIFO | Procedure to reset a fifo buffer on a resource clock domain |
| SHARED_REGISTER | Procedure to read/write data to a shared register for 'control path' communications (overloaded) |
| ▼EDGE DETECTION API | |
| MONITOR_FALLING_EDGES | Procedure for detecting a falling edge of an input signal (overloaded) |
| MONITOR_RISING_EDGES | Procedure for detecting a rising edge of an input signal (overloaded) |
| ▼STATE MACHINE API | |
| TRANSITION | Procedure to schedule a state machine transition (overloaded) |
| CONDITIONAL_TRANSITION | Procedure for transitioning to a state machine state in response to signal change (overloaded) |
| FIRE_EVENT | Procedure for firing a framework event signal (overloaded) |
| REGISTER_FOR_EVENT | Procedure receiving a framework event signal (overloaded) |
| ▼SHIFT REGISTER API | |
| SHIFT_DATA_LEFT | Procedure to shift input data to the left (overloaded) |
| SHIFT_DATA_RIGHT | Procedure to shift input data to the right (overloaded) |
| RESET_LEFT_SHIFTER | Procedure to reset left shift register (overloaded) |
| RESET_RIGHT_SHIFTER | Procedure to reset right shift register (overloaded) |
| ▼other docs | |
| APPLICATION MODULE STRUCTURE | Structure of Application Module |
| NAMING CONVENTIONS | Naming conventions |
| ▼PRODUCTIVITY | |
| AXI STREAM INTERFACE | Productivity using AXI Stream Interface Components |
| ▼VHDL CODING CONSTRUCTS | |
| ALIASES AND CONSTANTS | Syntax and commands for declaring VHDL constants and signals |
| SIGNAL ASSIGNMENTS | Syntax for signal assignment supporting both combinatorial and registered logic |
| COMPONENT INSTANTIATION | Syntax for components |
| STATE MACHINE CONSTRUCTION | Syntax for setting up the state register states |
| CONFIGURATION_FILE | [auto-generated]: Configuration file containing the sys_clk frequency, VHDL constants, aliases, and application module pinout information |