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

Class ReadLink

java.lang.Object

uk.ac.manchester.spinnaker.messages.sdp.SpinnakerRequest

uk.ac.manchester.spinnaker.messages.scp.SCPRequest<ReadLink.Response>

uk.ac.manchester.spinnaker.messages.scp.ReadLink

All Implemented Interfaces:

SerializableMessage

public class ReadLink
extends SCPRequest<ReadLink.Response>

A request to read a region of memory via a link on a chip. The response payload is a read-only little-endian ByteBuffer intended to be read once.

Calls cmd_link_read() in scamp-cmd.c.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected final class	ReadLink.Response	An SCP response to a request to read a region of memory via a link on a chip.

Field Summary

Fields inherited from class uk.ac.manchester.spinnaker.messages.scp.SCPRequest

argument1, argument2, argument3, BOOT_CHIP, BOOT_MONITOR_CORE, data, NO_DATA, scpRequestHeader

Fields inherited from class uk.ac.manchester.spinnaker.messages.sdp.SpinnakerRequest

sdpHeader

Constructor Summary

Constructors

Constructor	Description
ReadLink(HasChipLocation chip, Direction link, MemoryLocation baseAddress, int size)
ReadLink(HasCoreLocation core, Direction link, MemoryLocation baseAddress, int size)

Method Summary

Modifier and Type	Method	Description
ReadLink.Response	getSCPResponse(ByteBuffer buffer)	Parse the response to this message.

Methods inherited from class uk.ac.manchester.spinnaker.messages.scp.SCPRequest

addToBuffer

Methods inherited from class uk.ac.manchester.spinnaker.messages.sdp.SpinnakerRequest

getMessageData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReadLink

public ReadLink(HasCoreLocation core,
 Direction link,
 MemoryLocation baseAddress,
 int size)

Parameters:

core - the core to read via

link - The direction of the link down which to send the query

baseAddress - The positive base address to start the read from

size - The number of bytes to read, between 1 and 256

ReadLink

public ReadLink(HasChipLocation chip,
 Direction link,
 MemoryLocation baseAddress,
 int size)

Parameters:

chip - the chip to read via

link - The direction of the link down which to send the query

baseAddress - The positive base address to start the read from

size - The number of bytes to read, between 1 and 256

Method Details

getSCPResponse

public ReadLink.Response getSCPResponse(ByteBuffer buffer)
                                 throws UnexpectedResponseCodeException

Description copied from class: SCPRequest

Parse the response to this message.

Specified by:

getSCPResponse in class SCPRequest<ReadLink.Response>

Parameters:

buffer - The buffer to parse.

Returns:

The message response.

Throws:

UnexpectedResponseCodeException