Enum SystemVariableDefinition
java.lang.Object
java.lang.Enum<SystemVariableDefinition>
uk.ac.manchester.spinnaker.messages.model.SystemVariableDefinition
- All Implemented Interfaces:
Serializable,Comparable<SystemVariableDefinition>
public enum SystemVariableDefinition extends Enum<SystemVariableDefinition>
Defines the system variables available.
-
Enum Constant Summary
Enum Constants Enum Constant Description allocated_tag_table_addressThe address of the allocated tag table.app_data_table_addressThe address of the application data table.board_infoA pointer to the board information structure.board_test_flagsBoard testing flags.boot_signatureThe boot signature.clock_divisorThe clock divisors for system & router clocks.clock_millisecondsThe time since startup in milliseconds.cpu_clock_mhzThe CPU clock frequency in MHz.cpu_information_base_addressThe base address of the CPU information blocks.debug_xThe x-coordinate of the chip to send debug messages to.debug_yThe y-coordinate of the chip to send debug messages to.ethernet_ip_addressThe IP address of the chip.first_free_router_entryThe ID of the first free router entry.fixed_route_copyA (virtual) copy of the router FR register.hardware_versionThe version of the hardware in use.iobuf_sizeThe size of the iobuf buffer in bytes.is_ethernet_availableIndicates if Ethernet is available on this chip.is_peer_to_peer_availableIndicates if peer-to-peer is working on the chip.is_root_chipIndicates if this is the root chip.last_biff_idLast ID used in BIFF packet.led_0The first part of the LED definitions.led_1The last part of the LED definitions.led_half_period_10_msThe LED half-period in 10 ms units, or 1 to show load.link_peek_timeout_microsecondsThe link peek/poke timeout in microseconds.links_availableBit mask (6 bits) of links enabled.lockThe lock.log_peer_to_peer_sequence_lengthLog (base 2) of the peer-to-peer sequence length.ltpc_periodDeprecated.UNTESTED part of SCAMPmonitor_mailbox_flagsThe monitor incoming mailbox flags.n_active_peer_to_peer_addressesThe number of active peer-to-peer addresses.n_scamp_working_coresThe number of SCAMP working cores.n_shared_message_buffersThe number of shared message buffers.n_working_coresThe number of working cores.nearest_ethernet_xThe y-coordinate of the nearest chip with Ethernet.nearest_ethernet_yThe x-coordinate of the nearest chip with Ethernet.nearest_neighbour_delay_usThe delay between nearest-neighbour packets in microseconds.nearest_neighbour_forwardNearest-Neighbour forward parameter.nearest_neighbour_last_idThe last ID used in nearest neighbour transaction.nearest_neighbour_memory_pointerThe memory pointer for nearest neighbour global operations.nearest_neighbour_retryNearest-Neighbour retry parameter.netinit_bc_wait_timeThe time to wait after last BC during network initialisation, in 10 ms units.netinit_phaseThe phase of boot process (see enum netinit_phase_e).p2p_b_repeatsNumber of times to send out P2PB packets.p2p_root_xThe x-coordinate of the chip from which the system was booted.p2p_root_yThe y-coordinate of the chip from which the system was booted.peer_to_peer_hop_table_addressThe address of the peer-to-peer hop tables.physical_to_virtual_core_mapThe physical core ID to virtual core ID map.random_seedThe random seed.router_table_copy_addressThe address of the copy of the routing tables.router_time_phase_timerThe router time-phase timer.sdram_base_addressThe base address of SDRAM.sdram_clock_frequency_mhzThe SDRAM clock frequency in MHz.sdram_heap_addressThe base address of the user SDRAM heap.shared_message_buffer_addressThe address of the shared message buffers.shared_message_count_in_useThe number of shared message buffers in use.shared_message_first_free_addressPointer to the first free shared message buffer.shared_message_maximum_usedThe maximum number of shared message buffers used.software_watchdog_countThe number of watch dog timeouts before an error is raised.status_mapThe status map set during SCAMP boot.system_buffer_wordsThe size of the system buffer in words.system_ram_base_addressThe base address of System RAM.system_ram_heap_addressThe base address of the system SDRAM heap.system_sdram_base_addressThe base address of System SDRAM.system_sdram_bytesThe size of the system SDRAM in bytes.system_sdram_heap_addressThe base address of the system SDRAM heap.time_millisecondsThe number of milliseconds in the current second.time_phase_scaleThe time-phase scaling factor.unix_timestampThe time in seconds since midnight, 1st January 1970.user_temp_0The first user variable.user_temp_1The second user variable.user_temp_2The third user variable.user_temp_4The fourth user variable.virtual_to_physical_core_mapThe virtual core ID to physical core ID map.xThe x-coordinate of the chip.x_sizeThe number of chips in the x-dimension.yThe y-coordinate of the chip.y_sizeThe number of chips in the y-dimension. -
Field Summary
-
Method Summary
Modifier and Type Method Description voidaddToBuffer(Object value, ByteBuffer buffer)Writes an object described by this field into the given buffer at the position as a contiguous range of bytes.ObjectgetDefault()The default value assigned to the variable if not overridden; this can be an integer, a byte array or a memory location.booleanisDefaultSpecified()static SystemVariableDefinitionvalueOf(String name)Returns the enum constant of this type with the specified name.static SystemVariableDefinition[]values()Returns an array containing the constants of this enum type, in the order they are declared.static List<SystemVariableDefinition>variables()Get the list of all variables in order.
-
Enum Constant Details
-
y
The y-coordinate of the chip. -
x
The x-coordinate of the chip. -
y_size
The number of chips in the y-dimension. -
x_size
The number of chips in the x-dimension. -
debug_y
The y-coordinate of the chip to send debug messages to. -
debug_x
The x-coordinate of the chip to send debug messages to. -
is_peer_to_peer_available
Indicates if peer-to-peer is working on the chip. -
nearest_neighbour_last_id
The last ID used in nearest neighbour transaction. -
nearest_ethernet_y
The x-coordinate of the nearest chip with Ethernet. -
nearest_ethernet_x
The y-coordinate of the nearest chip with Ethernet. -
hardware_version
The version of the hardware in use. -
is_ethernet_available
Indicates if Ethernet is available on this chip. -
p2p_b_repeats
Number of times to send out P2PB packets. -
log_peer_to_peer_sequence_length
Log (base 2) of the peer-to-peer sequence length. -
clock_divisor
The clock divisors for system & router clocks. -
time_phase_scale
The time-phase scaling factor. -
clock_milliseconds
The time since startup in milliseconds. -
time_milliseconds
The number of milliseconds in the current second. -
ltpc_period
Deprecated.UNTESTED part of SCAMPLocal time phase control packet send period (in units of 10ms). Set to zero to disable. -
unix_timestamp
The time in seconds since midnight, 1st January 1970. -
router_time_phase_timer
The router time-phase timer. -
cpu_clock_mhz
The CPU clock frequency in MHz. -
sdram_clock_frequency_mhz
The SDRAM clock frequency in MHz. -
nearest_neighbour_forward
Nearest-Neighbour forward parameter. -
nearest_neighbour_retry
Nearest-Neighbour retry parameter. -
link_peek_timeout_microseconds
The link peek/poke timeout in microseconds. -
led_half_period_10_ms
The LED half-period in 10 ms units, or 1 to show load. -
netinit_bc_wait_time
The time to wait after last BC during network initialisation, in 10 ms units. -
netinit_phase
The phase of boot process (see enum netinit_phase_e). -
p2p_root_y
The y-coordinate of the chip from which the system was booted. -
p2p_root_x
The x-coordinate of the chip from which the system was booted. -
led_0
The first part of the LED definitions. -
led_1
The last part of the LED definitions. -
random_seed
The random seed. -
is_root_chip
Indicates if this is the root chip. -
n_shared_message_buffers
The number of shared message buffers. -
nearest_neighbour_delay_us
The delay between nearest-neighbour packets in microseconds. -
software_watchdog_count
The number of watch dog timeouts before an error is raised. -
system_ram_heap_address
The base address of the system SDRAM heap. -
sdram_heap_address
The base address of the user SDRAM heap. -
iobuf_size
The size of the iobuf buffer in bytes. -
system_sdram_bytes
The size of the system SDRAM in bytes. -
system_buffer_words
The size of the system buffer in words. -
boot_signature
The boot signature. -
nearest_neighbour_memory_pointer
The memory pointer for nearest neighbour global operations. -
lock
The lock. -
links_available
Bit mask (6 bits) of links enabled. -
last_biff_id
Last ID used in BIFF packet. -
board_test_flags
Board testing flags. -
shared_message_first_free_address
Pointer to the first free shared message buffer. -
shared_message_count_in_use
The number of shared message buffers in use. -
shared_message_maximum_used
The maximum number of shared message buffers used. -
user_temp_0
The first user variable. -
user_temp_1
The second user variable. -
user_temp_2
The third user variable. -
user_temp_4
The fourth user variable. -
status_map
The status map set during SCAMP boot. -
physical_to_virtual_core_map
The physical core ID to virtual core ID map. -
virtual_to_physical_core_map
The virtual core ID to physical core ID map. -
n_working_cores
The number of working cores. -
n_scamp_working_cores
The number of SCAMP working cores. -
sdram_base_address
The base address of SDRAM. -
system_ram_base_address
The base address of System RAM. -
system_sdram_base_address
The base address of System SDRAM. -
cpu_information_base_address
The base address of the CPU information blocks. -
system_sdram_heap_address
The base address of the system SDRAM heap. -
router_table_copy_address
The address of the copy of the routing tables. -
peer_to_peer_hop_table_address
The address of the peer-to-peer hop tables. -
allocated_tag_table_address
The address of the allocated tag table. -
first_free_router_entry
The ID of the first free router entry. -
n_active_peer_to_peer_addresses
The number of active peer-to-peer addresses. -
app_data_table_address
The address of the application data table. -
shared_message_buffer_address
The address of the shared message buffers. -
monitor_mailbox_flags
The monitor incoming mailbox flags. -
ethernet_ip_address
The IP address of the chip. -
fixed_route_copy
A (virtual) copy of the router FR register. -
board_info
A pointer to the board information structure.
-
-
Field Details
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException- if the argument is null
-
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
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
Get the list of all variables in order.- Returns:
- The list of all variables.
-