org.lsst.ccs.drivers.auxelex

Class Srp

java.lang.Object

org.lsst.ccs.drivers.auxelex.Srp

Direct Known Subclasses:

Bfr, BfrComCam, BfrPathFinder, HeaterPS, IonPump, PduCommon, RebBulkPS, RebPS

public class Srp
extends Object

Routines for implementing the SLAC register protocol

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Srp.BoardType

Field Summary

Fields

Modifier and Type	Field and Description
protected Srp.BoardType	boardType
static int	DEFAULT_PORT Constants and data.
static int	PORT_0 Constants and data.
static int	PORT_1 Constants and data.
static int	PORT_2 Constants and data.
static int	PORT_3 Constants and data.

Constructor Summary

Constructors

Constructor and Description
Srp() For backwards compatibility
Srp(String logName) Create an SRP and give a name to be included in log messages and exceptions

Method Summary

Modifier and Type	Method and Description
protected void	clearSimRegMap() Clears the simulated register map.
void	close() Closes the connection.
Srp.BoardType	getBoardType() Gets the board type.
String	getBuildStamp() Gets the build stamp
byte[]	getIpAddress() Gets the IP address.
int	getNumSeqErr() Gets the sequence error count.
int	getNumTimeout() Gets the socket timeout count.
int	getReadTimeout() Gets the read timeout
int	getReadWarning() Gets the read warning time.
protected int	getSimRegMap(int addr) Gets from the simulated register map.
boolean	isSimulated() Gets whether simulated
void	open(int node) Opens a connection to a board.
void	open(int node, int port) Opens a connection to a board.
void	open(String host) Opens a connection to a board.
void	open(String host, int port) Opens a connection to a board.
protected void	putSimRegMap(int addr, int value) Puts to the simulated register map.
int	readReg(int addr) Reads a register.
int[]	readRegs(int addr, int count) Reads registers.
void	setDebug(Boolean on) Sets the debug state.
void	setLogName(String logName)
void	setReadTimeout(int timeout) Sets the read timeout.
void	setReadWarning(int time) Sets the read warning time.
void	setSrpVersion(int version) Sets the SRP protocol version.
void	setValidBoardTypes(Collection types) Sets the collection of valid board types.
protected void	simInitialize() Initializes the simulation.
protected int[]	simReadRegs(int addr, int count) Reads simulated registers.
protected void	simWriteRegs(int addr, int[] value, int count) Writes simulated registers.
int	updateReg(int addr, int mask, int value) Updates a register.
void	writeReg(int addr, int value) Writes a register.
void	writeRegs(int addr, int[] value) Writes registers.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Constants and data.

See Also:

Constant Field Values

PORT_0

public static final int PORT_0

Constants and data.

See Also:

Constant Field Values

PORT_1

public static final int PORT_1

Constants and data.

See Also:

Constant Field Values

PORT_2

public static final int PORT_2

Constants and data.

See Also:

Constant Field Values

PORT_3

public static final int PORT_3

Constants and data.

See Also:

Constant Field Values

boardType

protected Srp.BoardType boardType

Constructor Detail

Srp

public Srp(String logName)

Create an SRP and give a name to be included in log messages and exceptions

Parameters:

logName -

Srp

public Srp()

For backwards compatibility

Method Detail

setLogName

public void setLogName(String logName)

setValidBoardTypes

public void setValidBoardTypes(Collection types)

Sets the collection of valid board types.

Parameters:

types - The collection of valid types

setSrpVersion

public void setSrpVersion(int version)

Sets the SRP protocol version.

Parameters:

version - The protocol version

open

public void open(String host,
                 int port)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a board.

Parameters:

host - The host name or IP address, or null or empty for simulation

port - The port number, or 0 for default

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(String host)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a board.

Parameters:

host - The IP address, or null or empty for simulation

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(int node,
                 int port)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a board.

Parameters:

node - The IP private network node number, or 0 for simulation

port - The port number, or 0 for default

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(int node)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a board.

Parameters:

node - The IP private network node number, or 0 for simulation

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

public void close()
           throws org.lsst.ccs.drivers.commons.DriverException

Closes the connection. This method isn't synchronized in order to allow a connection to be closed while another thread is waiting for a read to complete. But some synchronization does need to be implemented to avoid race conditions leading to null pointer exceptions..

Throws:

org.lsst.ccs.drivers.commons.DriverException

setReadTimeout

public void setReadTimeout(int timeout)

Sets the read timeout.

Parameters:

timeout - The timeout (ms)

getReadTimeout

public int getReadTimeout()

Gets the read timeout

Returns:

The read timeout (ms)

setReadWarning

public void setReadWarning(int time)

Sets the read warning time.

Parameters:

time - The time (ms)

getReadWarning

public int getReadWarning()

Gets the read warning time.

Returns:

The time (ms)

getBoardType

public Srp.BoardType getBoardType()

Gets the board type.

Returns:

The board type

getBuildStamp

public String getBuildStamp()
                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the build stamp

Returns:

The build stamp

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDebug

public void setDebug(Boolean on)

Sets the debug state.

Parameters:

on - The debug on state, true or false

getIpAddress

public byte[] getIpAddress()

Gets the IP address.

Returns:

The IP address byte array

isSimulated

public boolean isSimulated()

Gets whether simulated

Returns:

Whether simulated

writeReg

public void writeReg(int addr,
                     int value)
              throws org.lsst.ccs.drivers.commons.DriverException

Writes a register.

Parameters:

addr - The register address

value - The value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeRegs

public void writeRegs(int addr,
                      int[] value)
               throws org.lsst.ccs.drivers.commons.DriverException

Writes registers.

Parameters:

addr - The first register address

value - The array of values to write. If it contains more than the allowed maximum number (1024 for SRP V3, 64 otherwise) of values, only the allowed number are written.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readReg

public int readReg(int addr)
            throws org.lsst.ccs.drivers.commons.DriverException

Reads a register.

Parameters:

addr - The register address

Returns:

The read value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readRegs

public int[] readRegs(int addr,
                      int count)
               throws org.lsst.ccs.drivers.commons.DriverException

Reads registers.

Parameters:

addr - The first register address

count - The number of registers to read. If greater than the allowed maximum number (1024 for SRP V3, 64 otherwise) of registers, only the allowed number are read.

Returns:

The array of read values

Throws:

org.lsst.ccs.drivers.commons.DriverException

updateReg

public int updateReg(int addr,
                     int mask,
                     int value)
              throws org.lsst.ccs.drivers.commons.DriverException

Updates a register.

Parameters:

addr - The register address

mask - The mask of bits to be updated

value - The value to use for updating

Returns:

Previous register value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getNumSeqErr

public int getNumSeqErr()

Gets the sequence error count.

Returns:

The number of sequence errors

getNumTimeout

public int getNumTimeout()

Gets the socket timeout count.

Returns:

The number of socket timeouts

simInitialize

protected void simInitialize()

Initializes the simulation.

simWriteRegs

protected void simWriteRegs(int addr,
                            int[] value,
                            int count)

Writes simulated registers.

Parameters:

addr - The first register address

value - The array of values to write.

count - The number of values to write.

simReadRegs

protected int[] simReadRegs(int addr,
                            int count)

Reads simulated registers.

Parameters:

addr - The first register address

count - The number of registers to read.

Returns:

The array of read values

clearSimRegMap

protected final void clearSimRegMap()

Clears the simulated register map.

putSimRegMap

protected final void putSimRegMap(int addr,
                                  int value)

Puts to the simulated register map.

Parameters:

addr - The register address

value - The array of values to write.

getSimRegMap

protected final int getSimRegMap(int addr)

Gets from the simulated register map.

Parameters:

addr - The register address

Returns:

The array of read values