com.oracle.deviceaccess.mmio

Class MMIODeviceConfig.RawRegisterConfig

java.lang.Object

com.oracle.deviceaccess.mmio.MMIODeviceConfig.RawMemoryConfig

com.oracle.deviceaccess.mmio.MMIODeviceConfig.RawRegisterConfig

Enclosing class:

MMIODeviceConfig

public static final class MMIODeviceConfig.RawRegisterConfig
extends MMIODeviceConfig.RawMemoryConfig

The RawRegisterConfig class encapsulates the configuration parameters of a register.

Constructor Summary

Constructors

Constructor and Description
MMIODeviceConfig.RawRegisterConfig(int offset, java.lang.String name, int type) Constructs a new RawRegisterConfig with the provided parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	getType() Gets the configured type of the value held by the register.

Methods inherited from class com.oracle.deviceaccess.mmio.MMIODeviceConfig.RawMemoryConfig

getName, getOffset

Methods inherited from class java.lang.Object

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

Constructor Detail

MMIODeviceConfig.RawRegisterConfig

public MMIODeviceConfig.RawRegisterConfig(int offset,
                                  java.lang.String name,
                                  int type)

Constructs a new RawRegisterConfig with the provided parameters.

Parameters:

offset - the offset of the register from the base address (a positive or null integer).

name - the name for the register.

type - the type of the value held by the register, one of: MMIODeviceConfig.REGISTER_TYPE_BYTE, MMIODeviceConfig.REGISTER_TYPE_SHORT or MMIODeviceConfig.REGISTER_TYPE_INT.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• offset is lesser than 0;
• type is not one of the defined values.

java.lang.NullPointerException - if name is null.

Method Detail

getType

public int getType()

Gets the configured type of the value held by the register.

Returns:

the type of the value held by the register, one of: MMIODeviceConfig.REGISTER_TYPE_BYTE, MMIODeviceConfig.REGISTER_TYPE_SHORT or MMIODeviceConfig.REGISTER_TYPE_INT.