com.oracle.deviceaccess.mmio

Class MMIODeviceConfig

java.lang.Object

com.oracle.deviceaccess.mmio.MMIODeviceConfig

All Implemented Interfaces:

PeripheralConfig<MMIODevice>, PeripheralConfig.HardwareAddressing

public final class MMIODeviceConfig
extends java.lang.Object
implements PeripheralConfig<MMIODevice>, PeripheralConfig.HardwareAddressing

The MMIODeviceConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of an MMIO device.

Some hardware addressing parameter, and static and dynamic configuration parameters may be set to PeripheralConfig.DEFAULT. Whether such default settings are supported is platform- as well as peripheral driver-dependent.

An instance of MMIODeviceConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated MMIO device with the specified configuration. A PeripheralConfigInvalidException is thrown when attempting to open a peripheral device with an invalid or unsupported configuration.

See Also:

PeripheralManager.open(PeripheralConfig), PeripheralManager.open(Class, PeripheralConfig)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MMIODeviceConfig.RawBlockConfig The RawBlockConfig class encapsulates the configuration parameters of a memory block.
static class	MMIODeviceConfig.RawMemoryConfig The RawMemoryConfig class encapsulates the configuration parameters of a generic raw memory area.
static class	MMIODeviceConfig.RawRegisterConfig<T extends java.lang.Number> The RawRegisterConfig class encapsulates the configuration parameters of a register.

Nested classes/interfaces inherited from interface com.oracle.deviceaccess.PeripheralConfig

PeripheralConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	REGISTER_TYPE_BYTE Type for a register holding a byte value.
static int	REGISTER_TYPE_INT Type for a register holding an integer value.
static int	REGISTER_TYPE_SHORT Type for a register holding a short integer value.

Fields inherited from interface com.oracle.deviceaccess.PeripheralConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
MMIODeviceConfig(long address, int size, int byteOrdering, MMIODeviceConfig.RawMemoryConfig... memConfigs) Creates a new MMIODeviceConfig with the specified hardware addressing information and configuration parameters.
MMIODeviceConfig(java.lang.String deviceName, long address, int size, int byteOrdering, MMIODeviceConfig.RawMemoryConfig... memConfigs) Creates a new MMIODeviceConfig with the specified hardware addressing information and configuration parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two MMIODeviceConfig objects for equality.
long	getAddress() Gets the configured memory address of the MMIO device.
int	getByteOrdering() Gets the configured byte ordering of the MMIO device.
java.lang.String	getDeviceName() Gets the configured device name (such as to its device file name on UNIX systems).
int	getDeviceNumber() Gets the configured device number.
MMIODeviceConfig.RawMemoryConfig[]	getRawMemoryConfigs() Gets the set of configured registers and memory blocks.
int	getSize() Gets the configured size of the memory-mapped area of the MMIO device.
int	hashCode() Returns the hash code value for this object.

Methods inherited from class java.lang.Object

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

Field Detail

REGISTER_TYPE_BYTE

public static final int REGISTER_TYPE_BYTE

Type for a register holding a byte value.

See Also:

Constant Field Values

REGISTER_TYPE_INT

public static final int REGISTER_TYPE_INT

Type for a register holding an integer value.

See Also:

Constant Field Values

REGISTER_TYPE_SHORT

public static final int REGISTER_TYPE_SHORT

Type for a register holding a short integer value.

See Also:

Constant Field Values

Constructor Detail

MMIODeviceConfig

public MMIODeviceConfig(long address,
                int size,
                int byteOrdering,
                MMIODeviceConfig.RawMemoryConfig... memConfigs)

Creates a new MMIODeviceConfig with the specified hardware addressing information and configuration parameters.

Note that if no raw block and raw register configuration is provided, the specified memory area will be mapped to the RawBlock instance returned by a call to MMIODevice.getAsRawBlock().

Parameters:

address - the memory address of the device (a positive or zero integer).

size - the size of the memory-mapped area of the device (a positive integer).

byteOrdering - the byte ordering of the device, one of: Peripheral.BIG_ENDIAN, Peripheral.LITTLE_ENDIAN, Peripheral.MIXED_ENDIAN or PeripheralConfig.DEFAULT.

memConfigs - the raw block and raw register configurations (may be null or empty).

Throws:

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

• address is not in the defined range;
• size is not in the defined range;
• byteOrdering is not one of the defined values.

java.lang.IndexOutOfBoundsException - if any of the memConfigs elements is pointing outside of the defined address range ([ 0-size]).

MMIODeviceConfig

public MMIODeviceConfig(java.lang.String deviceName,
                long address,
                int size,
                int byteOrdering,
                MMIODeviceConfig.RawMemoryConfig... memConfigs)

Creates a new MMIODeviceConfig with the specified hardware addressing information and configuration parameters.

Note that if no raw block and raw register configuration is provided, the specified memory area will be mapped to the RawBlock instance returned by a call to MMIODevice.getAsRawBlock().

Parameters:

deviceName - the device name (such as to its device file name on UNIX systems).

address - the memory address of the device (a positive or zero integer)or PeripheralConfig.DEFAULT.

size - the size of the memory-mapped area of the device (a positive integer).

byteOrdering - the byte ordering of the device, one of: Peripheral.BIG_ENDIAN, Peripheral.LITTLE_ENDIAN, Peripheral.MIXED_ENDIAN or PeripheralConfig.DEFAULT.

memConfigs - the raw block and raw register configurations (may be null or empty).

Throws:

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

• address is not in the defined range;
• size is not in the defined range;
• byteOrdering is not one of the defined values.

java.lang.NullPointerException - if deviceName is null.

java.lang.IndexOutOfBoundsException - if any of the memConfigs elements is pointing outside of the defined address range ([ 0-size]).

Method Detail

getAddress

public long getAddress()

Gets the configured memory address of the MMIO device.

Returns:

the memory address of the MMIO device (a positive or zero integer) or PeripheralConfig.DEFAULT..

getDeviceName

public java.lang.String getDeviceName()

Gets the configured device name (such as to its device file name on UNIX systems).

Specified by:

getDeviceName in interface PeripheralConfig.HardwareAddressing

Returns:

the device name or null.

getDeviceNumber

public int getDeviceNumber()

Gets the configured device number.

Specified by:

getDeviceNumber in interface PeripheralConfig.HardwareAddressing

Returns:

PeripheralConfig.DEFAULT.

getByteOrdering

public int getByteOrdering()

Gets the configured byte ordering of the MMIO device.

Returns:

the byte ordering of the MMIO device, one of: Peripheral.BIG_ENDIAN, Peripheral.LITTLE_ENDIAN, Peripheral.MIXED_ENDIAN or PeripheralConfig.DEFAULT.

getRawMemoryConfigs

public MMIODeviceConfig.RawMemoryConfig[] getRawMemoryConfigs()

Gets the set of configured registers and memory blocks.

Returns:

an array (a defensive copy thereof) containing the set of configured registers and memory blocks or null if none is defined.

getSize

public int getSize()

Gets the configured size of the memory-mapped area of the MMIO device.

Returns:

the size of the memory-mapped area of the device (a positive integer).

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Checks two MMIODeviceConfig objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to test for equality with this object.

Returns:

true if obj is a MMIODeviceConfig and has the same hardware addressing information and configuration parameter values as this MMIODeviceConfig object.