Source code for data_specification.enums.commands

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from enum import Enum
from data_specification.data_specification_executor_functions import (
    DataSpecificationExecutorFunctions)


[docs]class Commands(Enum): """ Set of opcodes for the spec executor""" #: Halts spec execution with an error. BREAK = ( 0x00, DataSpecificationExecutorFunctions.execute_break, "Halts spec execution with an error") #: No operation. Can be used as a filler. NOP = ( 0x01, DataSpecificationExecutorFunctions.execute_nop, "No operation. Can be used as a filler") #: Reserves a block of memory ready for filling. RESERVE = ( 0x02, DataSpecificationExecutorFunctions.execute_reserve, "Reserves a block of memory ready for filling") FREE = ( 0x03, DataSpecificationExecutorFunctions.execute_free, "Releases previously reserved memory") DECLARE_RNG = ( 0x05, DataSpecificationExecutorFunctions.execute_declare_rng, "Declares a new random number generator") DECLARE_RANDOM_DIST = ( 0x06, DataSpecificationExecutorFunctions.execute_random_dist, "Declares a new random distribution") GET_RANDOM_NUMBER = ( 0x07, DataSpecificationExecutorFunctions.execute_get_random_rumber, "Returns a random number drawn from the given distribution") START_STRUCT = ( 0x10, DataSpecificationExecutorFunctions.execute_start_struct, "Begins declaration of new structure") STRUCT_ELEM = ( 0x11, DataSpecificationExecutorFunctions.execute_struct_elem, "Declare single element in a structure") END_STRUCT = ( 0x12, DataSpecificationExecutorFunctions.execute_end_struct, "Ends declaration of new structure") START_CONSTRUCTOR = ( 0x20, DataSpecificationExecutorFunctions.execute_start_constructor, "Begins definition of a function to write data structures to memory") END_CONSTRUCTOR = ( 0x25, DataSpecificationExecutorFunctions.execute_end_constructor, "Ends definition of the write function") CONSTRUCT = ( 0x40, DataSpecificationExecutorFunctions.execute_construct, "Invokes a constructor to build a data structure") READ = ( 0x41, DataSpecificationExecutorFunctions.execute_read, "Performs a simple read operation") #: Performs a simple write or block write operation. WRITE = ( 0x42, DataSpecificationExecutorFunctions.execute_write, "Performs a simple write or block write operation") #: Performs a write from an array. WRITE_ARRAY = ( 0x43, DataSpecificationExecutorFunctions.execute_write_array, "Performs a write from an array") WRITE_STRUCT = ( 0x44, DataSpecificationExecutorFunctions.execute_write_struct, "Performs a write from a predefined structure") BLOCK_COPY = ( 0x45, DataSpecificationExecutorFunctions.execute_block_copy, "Copies a block of data from one area to another") #: Swap between different reserved memory regions to work on several at #: the same time. SWITCH_FOCUS = ( 0x50, DataSpecificationExecutorFunctions.execute_switch_focus, "Swap between different reserved memory regions to work on several at" " the same time") LOOP = ( 0x51, DataSpecificationExecutorFunctions.execute_loop, "Set-up a loop") BREAK_LOOP = ( 0x52, DataSpecificationExecutorFunctions.execute_break_loop, "Early exit from a loop") END_LOOP = ( 0x53, DataSpecificationExecutorFunctions.execute_end_loop, "End of a loop") IF = ( 0x55, DataSpecificationExecutorFunctions.execute_if, "Perform a condition and execute the following instructions only if" " the condition is true") ELSE = ( 0x56, DataSpecificationExecutorFunctions.execute_else, "Else clause for associated IF statement") END_IF = ( 0x57, DataSpecificationExecutorFunctions.execute_end_if, "Close block of instructions begun with the IF instruction") #: Place a value in a register, from an immediate or another register. MV = ( 0x60, DataSpecificationExecutorFunctions.execute_mv, "Place a value in a register, from an immediate or another register") GET_WR_PTR = ( 0x63, DataSpecificationExecutorFunctions.execute_get_wr_ptr, "Copy current write address to a register") #: Move the write pointer to a new location, either relative to the #: start of this reserved memory area or relative to the current #: write pointer. SET_WR_PTR = ( 0x64, DataSpecificationExecutorFunctions.execute_set_wr_ptr, "Move the write pointer to a new location, either relative to the" " start of this reserved memory area or relative to the current" " write pointer") ALIGN_WR_PTR = ( 0x65, DataSpecificationExecutorFunctions.execute_align_wr_ptr, "Moves the write pointer so that it points to the next block with a" " given address granularity") ARITH_OP = ( 0x67, DataSpecificationExecutorFunctions.execute_arith_op, "Perform arithmetic operation with operand 2 coming from a register") LOGIC_OP = ( 0x68, DataSpecificationExecutorFunctions.execute_logic_op, "Perform logical operation with operand 2 coming from a register") REFORMAT = ( 0x6A, DataSpecificationExecutorFunctions.execute_reformat, "Reformats a value in an internal register") COPY_STRUCT = ( 0x70, DataSpecificationExecutorFunctions.execute_copy_struct, "Create an identical copy of a structure") COPY_PARAM = ( 0x71, DataSpecificationExecutorFunctions.execute_copy_param, "Copy a parameter from one structure to another") WRITE_PARAM = ( 0x72, DataSpecificationExecutorFunctions.execute_write_param, "Modify a single parameter in a structure using an immediate value or" " register held-value") READ_PARAM = ( 0x73, DataSpecificationExecutorFunctions.execute_read_param, "Load the value of a structure parameter in a register") WRITE_PARAM_COMPONENT = ( 0x74, DataSpecificationExecutorFunctions.execute_write_param_component, "Modify a single parameter in a structure") PRINT_VAL = ( 0x80, DataSpecificationExecutorFunctions.execute_print_val, "Output the value of a register to the screen") PRINT_TXT = ( 0X81, DataSpecificationExecutorFunctions.execute_print_txt, "Print a text string to the screen") PRINT_STRUCT = ( 0X82, DataSpecificationExecutorFunctions.execute_print_struct, "Print the current state of one structure to the screen") END_SPEC = ( 0XFF, DataSpecificationExecutorFunctions.execute_end_spec, "Cleanly ends the parsing of the data specs") def __new__(cls, value, exec_function, doc=""): # pylint: disable=protected-access obj = object.__new__(cls) obj._value_ = value obj.exec_function = exec_function obj.__doc__ = doc return obj def __init__(self, value, exec_function, doc=""): self._value_ = value self.exec_function = exec_function self.__doc__ = doc