Package uk.ac.manchester.spinnaker.messages.scp

Enum Class SCPCommand

java.lang.Object
java.lang.Enum<SCPCommand>
uk.ac.manchester.spinnaker.messages.scp.SCPCommand
All Implemented Interfaces:
Serializable, Comparable<SCPCommand>, Constable, CommandCode
public enum SCPCommand extends Enum<SCPCommand> implements CommandCode
The SCP Command codes.

  • Enum Constant Details

    • CMD_VER

      public static final SCPCommand CMD_VER
      Get SCAMP Version.

    • CMD_RUN

      @Deprecated(forRemoval=true) public static final SCPCommand CMD_RUN
      Deprecated, for removal: This API element is subject to removal in a future version.
      see CMD_AS, which has a superior API
      Run at PC.

    • CMD_READ

      public static final SCPCommand CMD_READ
      Read SDRAM.

    • CMD_WRITE

      public static final SCPCommand CMD_WRITE
      Write SDRAM.

    • CMD_APLX

      @Deprecated(forRemoval=true) public static final SCPCommand CMD_APLX
      Deprecated, for removal: This API element is subject to removal in a future version.
      see CMD_AS, which has a superior API
      Run via APLX.

    • CMD_FILL

      public static final SCPCommand CMD_FILL
      Fill memory.

    • CMD_REMAP

      public static final SCPCommand CMD_REMAP
      Remap application core.

    • CMD_AR

      public static final SCPCommand CMD_AR
      Application core reset.

    • CMD_NNP

      public static final SCPCommand CMD_NNP
      Send a broadcast Nearest-Neighbour packet.

    • CMD_SIG

      public static final SCPCommand CMD_SIG
      Send a Signal.

    • CMD_FFD

      public static final SCPCommand CMD_FFD
      Send Flood-Fill Data.

    • CMD_AS

      public static final SCPCommand CMD_AS
      Application core APLX start.

    • CMD_LED

      public static final SCPCommand CMD_LED
      Control the LEDs.

    • CMD_IPTAG

      public static final SCPCommand CMD_IPTAG
      Set an IP tag.

    • CMD_SROM

      public static final SCPCommand CMD_SROM
      Read/write/erase serial ROM.

    • CMD_ALLOC

      public static final SCPCommand CMD_ALLOC
      Allocate or Free SDRAM or Routing entries.

    • CMD_RTR

      public static final SCPCommand CMD_RTR
      Initialise the router.

    • CMD_DPRI

      public static final SCPCommand CMD_DPRI
      Dropped Packet Reinjection setup.

    • CMD_INFO

      public static final SCPCommand CMD_INFO
      Get Chip Summary Information.

    • CMD_BMP_INFO

      public static final SCPCommand CMD_BMP_INFO
      Get BMP info structures.

    • CMD_FLASH_COPY

      public static final SCPCommand CMD_FLASH_COPY
      Copy working buffer to flash memory. BMP-only operation.

    • CMD_FLASH_ERASE

      public static final SCPCommand CMD_FLASH_ERASE
      Erase part of flash memory. BMP-only operation.

    • CMD_FLASH_WRITE

      public static final SCPCommand CMD_FLASH_WRITE
      Write to flash memory. BMP-only operation.

    • CMD_BMP_SF

      public static final SCPCommand CMD_BMP_SF
      Serial flash access. BMP-only operation.

    • CMD_BMP_EE

      @Deprecated public static final SCPCommand CMD_BMP_EE
      Deprecated.
      This message is under-documented. See cmd_ee() in bmp_cmd.c for what it does.
      EEPROM access. BMP-only operation.

    • CMD_RESET

      public static final SCPCommand CMD_RESET
      BMP-only operation.

    • CMD_XILINX

      public static final SCPCommand CMD_XILINX
      FPGA control. BMP-only operation.

    • CMD_BMP_POWER

      public static final SCPCommand CMD_BMP_POWER
      Turns on or off the machine via BMP.

    • CMD_BMP_I2C

      @Deprecated public static final SCPCommand CMD_BMP_I2C
      Deprecated.
      This message is under-documented. See cmd_i2c() in bmp_cmd.c for what it does.
      Access I2C bus. BMP-only operation.

    • CMD_BMP_PWM

      @Deprecated public static final SCPCommand CMD_BMP_PWM
      Deprecated.
      This message is under-documented. See configure_pwm() in bmp_hw.c for what it does.
      Configure pulse-width modulation hardware. BMP-only operation.

  • Field Details

    • CMD_FPGA_READ

      public static final SCPCommand CMD_FPGA_READ
      Read FPGA's memory/registers. BMP-only operation.

      Same as CMD_LINK_READ but used differently.

    • CMD_FPGA_WRITE

      public static final SCPCommand CMD_FPGA_WRITE
      Write FPGA's memory/registers. BMP-only operation.

      Same as CMD_LINK_WRITE but used differently.

    • value

      public final short value
      The SCAMP encoding.

  • Method Details

    • values

      public static SCPCommand[] 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 SCPCommand 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

    • get

      public static SCPCommand get(short value)
      Convert an encoded value into an enum element.
      Parameters:
      value - The value to convert
      Returns:
      The enum element

    • getValue

      public short getValue()
      Description copied from interface: CommandCode
      Get the value of this command.
      Specified by:
      getValue in interface CommandCode
      Returns:
      The encoded value.