Package uk.ac.manchester.spinnaker.messages.bmp

Class ReadFPGARegister

java.lang.Object

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

uk.ac.manchester.spinnaker.messages.scp.SCPRequest<T>

uk.ac.manchester.spinnaker.messages.bmp.BMPRequest<ReadFPGARegister.Response>

uk.ac.manchester.spinnaker.messages.bmp.ReadFPGARegister

All Implemented Interfaces:

SerializableMessage

public class ReadFPGARegister
extends BMPRequest<ReadFPGARegister.Response>

A request for the data from a FPGA's register. The response payload is the 32-bit integer contents of the register.

Calls cmd_fpga_read() in bmp_cmd.c.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected final class	ReadFPGARegister.Response	An SCP response to a request for the contents of an FPGA register.

Nested classes/interfaces inherited from class uk.ac.manchester.spinnaker.messages.bmp.BMPRequest

BMPRequest.BMPResponse, BMPRequest.PayloadedResponse<T>

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
ReadFPGARegister(FPGA fpga, MemoryLocation register, BMPBoard board)

Method Summary

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

Methods inherited from class uk.ac.manchester.spinnaker.messages.bmp.BMPRequest

toString

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, wait, wait, wait

Constructor Details

ReadFPGARegister

public ReadFPGARegister(FPGA fpga,
 MemoryLocation register,
 BMPBoard board)

Parameters:

fpga - FPGA (0, 1 or 2 on SpiNN-5 board) to communicate with.

register - Register address to read to. Must be aligned

board - which board to request the ADC register from

Throws:

IllegalArgumentException - If FPGA.FPGA_ALL is used or the register address is not aligned.

Method Details

getSCPResponse

public ReadFPGARegister.Response getSCPResponse(ByteBuffer buffer)
                                         throws Exception

Description copied from class: SCPRequest

Parse the response to this message.

Specified by:

getSCPResponse in class SCPRequest<ReadFPGARegister.Response>

Parameters:

buffer - The buffer to parse.

Returns:

The message response.

Throws:

Exception - If anything goes wrong with parsing.