Package uk.ac.manchester.spinnaker.messages.model

Enum Class SystemVariableDefinition

java.lang.Object
java.lang.Enum<SystemVariableDefinition>
uk.ac.manchester.spinnaker.messages.model.SystemVariableDefinition
All Implemented Interfaces:
Serializable, Comparable<SystemVariableDefinition>, Constable
public enum SystemVariableDefinition extends Enum<SystemVariableDefinition>
Defines the system variables available.

  • Enum Constant Details

    • y

      public static final SystemVariableDefinition y
      The y-coordinate of the chip.

    • x

      public static final SystemVariableDefinition x
      The x-coordinate of the chip.

    • y_size

      public static final SystemVariableDefinition y_size
      The number of chips in the y-dimension.

    • x_size

      public static final SystemVariableDefinition x_size
      The number of chips in the x-dimension.

    • debug_y

      public static final SystemVariableDefinition debug_y
      The y-coordinate of the chip to send debug messages to.

    • debug_x

      public static final SystemVariableDefinition debug_x
      The x-coordinate of the chip to send debug messages to.

    • is_peer_to_peer_available

      public static final SystemVariableDefinition is_peer_to_peer_available
      Indicates if peer-to-peer is working on the chip.

    • nearest_neighbour_last_id

      public static final SystemVariableDefinition nearest_neighbour_last_id
      The last ID used in nearest neighbour transaction.

    • nearest_ethernet_y

      public static final SystemVariableDefinition nearest_ethernet_y
      The x-coordinate of the nearest chip with Ethernet.

    • nearest_ethernet_x

      public static final SystemVariableDefinition nearest_ethernet_x
      The y-coordinate of the nearest chip with Ethernet.

    • hardware_version

      public static final SystemVariableDefinition hardware_version
      The version of the hardware in use.

    • is_ethernet_available

      public static final SystemVariableDefinition is_ethernet_available
      Indicates if Ethernet is available on this chip.

    • p2p_b_repeats

      public static final SystemVariableDefinition p2p_b_repeats
      Number of times to send out P2PB packets.

    • log_peer_to_peer_sequence_length

      public static final SystemVariableDefinition log_peer_to_peer_sequence_length
      Log (base 2) of the peer-to-peer sequence length.

    • clock_divisor

      public static final SystemVariableDefinition clock_divisor
      The clock divisors for system & router clocks.

    • time_phase_scale

      public static final SystemVariableDefinition time_phase_scale
      The time-phase scaling factor.

    • clock_milliseconds

      public static final SystemVariableDefinition clock_milliseconds
      The time since startup in milliseconds.

    • time_milliseconds

      public static final SystemVariableDefinition time_milliseconds
      The number of milliseconds in the current second.

    • ltpc_period

      @Deprecated public static final SystemVariableDefinition ltpc_period
      Deprecated.
      UNTESTED part of SCAMP
      Local time phase control packet send period (in units of 10ms). Set to zero to disable.

    • unix_timestamp

      public static final SystemVariableDefinition unix_timestamp
      The time in seconds since midnight, 1st January 1970.

    • router_time_phase_timer

      public static final SystemVariableDefinition router_time_phase_timer
      The router time-phase timer.

    • cpu_clock_mhz

      public static final SystemVariableDefinition cpu_clock_mhz
      The CPU clock frequency in MHz.

    • sdram_clock_frequency_mhz

      public static final SystemVariableDefinition sdram_clock_frequency_mhz
      The SDRAM clock frequency in MHz.

    • nearest_neighbour_forward

      public static final SystemVariableDefinition nearest_neighbour_forward
      Nearest-Neighbour forward parameter.

    • nearest_neighbour_retry

      public static final SystemVariableDefinition nearest_neighbour_retry
      Nearest-Neighbour retry parameter.

    • led_half_period_10_ms

      public static final SystemVariableDefinition led_half_period_10_ms
      The LED half-period in 10 ms units, or 1 to show load.

    • netinit_bc_wait_time

      public static final SystemVariableDefinition netinit_bc_wait_time
      The time to wait after last BC during network initialisation, in 10 ms units.

    • netinit_phase

      public static final SystemVariableDefinition netinit_phase
      The phase of boot process (see enum netinit_phase_e).

    • p2p_root_y

      public static final SystemVariableDefinition p2p_root_y
      The y-coordinate of the chip from which the system was booted.

    • p2p_root_x

      public static final SystemVariableDefinition p2p_root_x
      The x-coordinate of the chip from which the system was booted.

    • led_0

      public static final SystemVariableDefinition led_0
      The first part of the LED definitions.

    • led_1

      public static final SystemVariableDefinition led_1
      The last part of the LED definitions.

    • random_seed

      public static final SystemVariableDefinition random_seed
      The random seed.

    • is_root_chip

      public static final SystemVariableDefinition is_root_chip
      Indicates if this is the root chip.

    • n_shared_message_buffers

      public static final SystemVariableDefinition n_shared_message_buffers
      The number of shared message buffers.

    • nearest_neighbour_delay_us

      public static final SystemVariableDefinition nearest_neighbour_delay_us
      The delay between nearest-neighbour packets in microseconds.

    • software_watchdog_count

      public static final SystemVariableDefinition software_watchdog_count
      The number of watch dog timeouts before an error is raised.

    • system_ram_heap_address

      public static final SystemVariableDefinition system_ram_heap_address
      The base address of the system SDRAM heap.

    • sdram_heap_address

      public static final SystemVariableDefinition sdram_heap_address
      The base address of the user SDRAM heap.

    • iobuf_size

      public static final SystemVariableDefinition iobuf_size
      The size of the iobuf buffer in bytes.

    • system_sdram_bytes

      public static final SystemVariableDefinition system_sdram_bytes
      The size of the system SDRAM in bytes.

    • system_buffer_words

      public static final SystemVariableDefinition system_buffer_words
      The size of the system buffer in words.

    • boot_signature

      public static final SystemVariableDefinition boot_signature
      The boot signature.

    • nearest_neighbour_memory_pointer

      public static final SystemVariableDefinition nearest_neighbour_memory_pointer
      The memory pointer for nearest neighbour global operations.

    • lock

      public static final SystemVariableDefinition lock
      The lock.

    • last_biff_id

      public static final SystemVariableDefinition last_biff_id
      Last ID used in BIFF packet.

    • board_test_flags

      public static final SystemVariableDefinition board_test_flags
      Board testing flags.

    • shared_message_first_free_address

      public static final SystemVariableDefinition shared_message_first_free_address
      Pointer to the first free shared message buffer.

    • shared_message_count_in_use

      public static final SystemVariableDefinition shared_message_count_in_use
      The number of shared message buffers in use.

    • shared_message_maximum_used

      public static final SystemVariableDefinition shared_message_maximum_used
      The maximum number of shared message buffers used.

    • user_temp_0

      public static final SystemVariableDefinition user_temp_0
      The first user variable.

    • user_temp_1

      public static final SystemVariableDefinition user_temp_1
      The second user variable.

    • user_temp_2

      public static final SystemVariableDefinition user_temp_2
      The third user variable.

    • user_temp_4

      public static final SystemVariableDefinition user_temp_4
      The fourth user variable.

    • status_map

      public static final SystemVariableDefinition status_map
      The status map set during SCAMP boot.

    • physical_to_virtual_core_map

      public static final SystemVariableDefinition physical_to_virtual_core_map
      The physical core ID to virtual core ID map.

    • virtual_to_physical_core_map

      public static final SystemVariableDefinition virtual_to_physical_core_map
      The virtual core ID to physical core ID map.

    • n_working_cores

      public static final SystemVariableDefinition n_working_cores
      The number of working cores.

    • n_scamp_working_cores

      public static final SystemVariableDefinition n_scamp_working_cores
      The number of SCAMP working cores.

    • sdram_base_address

      public static final SystemVariableDefinition sdram_base_address
      The base address of SDRAM.

    • system_ram_base_address

      public static final SystemVariableDefinition system_ram_base_address
      The base address of System RAM.

    • system_sdram_base_address

      public static final SystemVariableDefinition system_sdram_base_address
      The base address of System SDRAM.

    • cpu_information_base_address

      public static final SystemVariableDefinition cpu_information_base_address
      The base address of the CPU information blocks.

    • system_sdram_heap_address

      public static final SystemVariableDefinition system_sdram_heap_address
      The base address of the system SDRAM heap.

    • router_table_copy_address

      public static final SystemVariableDefinition router_table_copy_address
      The address of the copy of the routing tables.

    • peer_to_peer_hop_table_address

      public static final SystemVariableDefinition peer_to_peer_hop_table_address
      The address of the peer-to-peer hop tables.

    • allocated_tag_table_address

      public static final SystemVariableDefinition allocated_tag_table_address
      The address of the allocated tag table.

    • first_free_router_entry

      public static final SystemVariableDefinition first_free_router_entry
      The ID of the first free router entry.

    • n_active_peer_to_peer_addresses

      public static final SystemVariableDefinition n_active_peer_to_peer_addresses
      The number of active peer-to-peer addresses.

    • app_data_table_address

      public static final SystemVariableDefinition app_data_table_address
      The address of the application data table.

    • shared_message_buffer_address

      public static final SystemVariableDefinition shared_message_buffer_address
      The address of the shared message buffers.

    • monitor_mailbox_flags

      public static final SystemVariableDefinition monitor_mailbox_flags
      The monitor incoming mailbox flags.

    • ethernet_ip_address

      public static final SystemVariableDefinition ethernet_ip_address
      The IP address of the chip.

    • fixed_route_copy

      public static final SystemVariableDefinition fixed_route_copy
      A (virtual) copy of the router FR register.

    • board_info

      public static final SystemVariableDefinition board_info
      A pointer to the board information structure.

  • Field Details

    • type

      public final DataType type
      The data type of the variable.

    • offset

      public final int offset
      The offset from the start of the system variable structure where the variable is found.

  • Method Details

    • values

      public static SystemVariableDefinition[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SystemVariableDefinition valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDefault

      public Object getDefault()
      The default value assigned to the variable if not overridden; this can be an integer, a byte array or a memory location.
      Returns:
      The default value, or a copy of it if the type of the value is an array.

    • isDefaultSpecified

      public boolean isDefaultSpecified()
      Returns:
      Whether this is a variable with a usefully-defined default.

    • addToBuffer

      public void addToBuffer(Object value, ByteBuffer buffer)
      Writes an object described by this field into the given buffer at the position as a contiguous range of bytes. This assumes that the buffer has been configured to be little-endian and that its position is at the point where this method should begin writing. Once it has finished, the position will be immediately after the last byte written by this method.
      Parameters:
      value - The value to write.
      buffer - The buffer to write into.

    • variables

      public static List<SystemVariableDefinition> variables()
      Get the list of all variables in order.
      Returns:
      The list of all variables.