com.oracle.deviceaccess.mmio

Interface RawBlock

All Superinterfaces:

RawMemory

public interface RawBlock
extends RawMemory

The RawBlock interface provides methods to access a continuous range of physical memory (raw memory). A RawBlock instance can be obtained from a MMIODevice instance.

The index values map to physical memory addresses. The index values are measured in bytes. The index values are relative to the base address of the raw memory area. The index value 0 corresponds to the base address of raw memory area.

The byte ordering of the underlying raw memory area can be retrieved using the MMIODevice.getByteOrdering() method.

Method Summary

Methods

Modifier and Type	Method and Description
byte	getByte(int index) Reads the byte at the given index in the raw memory area associated with this object.
void	getBytes(int index, byte[] dst, int offset, int length) Reads bytes starting at the given index in the raw memory area associated with this object.
int	getInt(int index) Reads the int at the given index in the raw memory area associated with this object.
void	getInts(int index, int[] dst, int offset, int length) Reads ints starting at the given index in the raw memory area associated with this object.
short	getShort(int index) Reads the short at the given index in the raw memory area associated with this object.
void	getShorts(int index, short[] dst, int offset, int length) Reads shorts starting at the given index in the raw memory area associated with this object.
int	getSize() Gets the size in bytes of the raw memory area associated with this object.
void	setByte(int index, byte value) Writes the given byte at the given index in the raw memory area associated with this object.
void	setBytes(int index, byte[] src, int offset, int length) Writes bytes starting at the given index in the raw memory area associated with this object.
void	setInt(int index, int value) Writes the given int at the given index in the raw memory area associated with this object.
void	setInts(int index, int[] src, int offset, int length) Writes ints starting at the given index in the raw memory area associated with this object.
void	setShort(int index, short value) Writes the given short at the given index in the raw memory area associated with this object.
void	setShorts(int index, short[] src, int offset, int length) Writes shorts starting at the given index in the raw memory area associated with this object.

Methods inherited from interface com.oracle.deviceaccess.mmio.RawMemory

getName

Method Detail

getByte

byte getByte(int index)
             throws java.io.IOException,
                    PeripheralNotAvailableException

Reads the byte at the given index in the raw memory area associated with this object.

Parameters:

index - the byte index in the raw memory area from which the byte will be read.

Returns:

The byte at the given index in the raw memory area.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.io.IOException - if the associated memory area is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getBytes

void getBytes(int index,
            byte[] dst,
            int offset,
            int length)
              throws java.io.IOException,
                     PeripheralNotAvailableException

Reads bytes starting at the given index in the raw memory area associated with this object. This method transfers bytes from the raw memory area into the given destination array. Each byte is loaded from memory in a single atomic operation.

Parameters:

index - the byte index in the raw memory area from which the bytes will be read.

dst - the array into which bytes are to be written

offset - the offset within the array of the first byte to be written; must be non-negative and no larger than dst.length.

length - the maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.lang.IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold.

java.io.IOException - if the associated memory area is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getInt

int getInt(int index)
           throws java.io.IOException,
                  PeripheralNotAvailableException

Reads the int at the given index in the raw memory area associated with this object.

Parameters:

index - the byte index in the raw memory area from which the int will be read.

Returns:

The int at the given index in the raw memory area.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.io.IOException - if the associated memory area is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getInts

void getInts(int index,
           int[] dst,
           int offset,
           int length)
             throws java.io.IOException,
                    PeripheralNotAvailableException

Reads ints starting at the given index in the raw memory area associated with this object. This method transfers ints from the raw memory area into the given destination array. Each byte is loaded from memory in a single atomic operation.

If the ints are aligned on natural boundaries each int is loaded from memory in a single atomic operation. Groups of ints may be loaded together, but this is unspecified.

Parameters:

index - the byte index in the raw memory area from which the ints will be read.

dst - the array into which ints are to be written

offset - the offset within the array of the first int to be written; must be non-negative and no larger than dst.length.

length - the maximum number of ints to be written to the given array; must be non-negative and no larger than dst.length - offset.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.lang.IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold.

java.io.IOException - if the associated memory area is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getShort

short getShort(int index)
               throws java.io.IOException,
                      PeripheralNotAvailableException

Reads the short at the given index in the raw memory area associated with this object.

Parameters:

index - the byte index in the raw memory area from which the short will be read.

Returns:

The short at the given index in the raw memory area.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.io.IOException - if the associated memory area is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getShorts

void getShorts(int index,
             short[] dst,
             int offset,
             int length)
               throws java.io.IOException,
                      PeripheralNotAvailableException

Reads shorts starting at the given index in the raw memory area associated with this object. This method transfers shorts from the raw memory area into the given destination array. Each byte is loaded from memory in a single atomic operation.

If the shorts are aligned on natural boundaries each short is loaded from memory in a single atomic operation. Groups of shorts may be loaded together, but this is unspecified.

Parameters:

index - the byte index in the raw memory area from which the shorts will be read.

dst - the array into which shorts are to be written

offset - the offset within the array of the first short to be written; must be non-negative and no larger than dst.length.

length - the maximum number of shorts to be written to the given array; must be non-negative and no larger than dst.length - offset.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.lang.IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold.

java.io.IOException - if the associated memory area is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getSize

int getSize()
            throws PeripheralNotAvailableException

Gets the size in bytes of the raw memory area associated with this object.

Returns:

the size in bytes of the raw memory area associated with this object.

Throws:

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

setByte

void setByte(int index,
           byte value)
             throws java.io.IOException,
                    PeripheralNotAvailableException

Writes the given byte at the given index in the raw memory area associated with this object.

This memory access may involve a load and a store, and it may have unspecified effects on surrounding bytes in the presence of concurrent access.

Parameters:

index - the byte index in the raw memory area at which the byte will be written.

value - the byte to be written at the given index in the raw memory area.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.io.IOException - if the associated memory area is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

setBytes

void setBytes(int index,
            byte[] src,
            int offset,
            int length)
              throws java.io.IOException,
                     PeripheralNotAvailableException

Writes bytes starting at the given index in the raw memory area associated with this object. This method transfers bytes from the given source array into the raw memory area.

This memory access may involve multiple load and a store operations, and it may have unspecified effects on surrounding bytes (even bytes in the range being stored) in the presence of concurrent access.

Parameters:

index - the byte index in the raw memory area at which the bytes will be written.

src - the array from which bytes are to be read.

offset - the offset within the array of the first byte to be read; must be non-negative and no larger than src.length.

length - the maximum number of bytes to be written to the given array; must be non-negative and no larger than src.length - offset.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.lang.IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold.

java.io.IOException - if the associated memory area is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

setInt

void setInt(int index,
          int value)
            throws java.io.IOException,
                   PeripheralNotAvailableException

Writes the given int at the given index in the raw memory area associated with this object.

This memory access may involve a load and a store, and it may have unspecified effects on surrounding bytes in the presence of concurrent access.

Parameters:

index - the byte index in the raw memory area from which the int will be written.

value - the int to be written at the given index in the raw memory area.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.io.IOException - if the associated memory area is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

setInts

void setInts(int index,
           int[] src,
           int offset,
           int length)
             throws java.io.IOException,
                    PeripheralNotAvailableException

Writes ints starting at the given index in the raw memory area associated with this object. This method transfers ints from the given source array into the raw memory area.

This memory access may involve multiple load and a store operations, and it may have unspecified effects on surrounding bytes (even bytes in the range being stored) in the presence of concurrent access.

Parameters:

index - the byte index in the raw memory area at which the int s will be written.

src - the array from which ints are to be read.

offset - the offset within the array of the first int to be read; must be non-negative and no larger than src.length.

length - the maximum number of ints to be written to the given array; must be non-negative and no larger than src.length - offset.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.lang.IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold.

java.io.IOException - if the associated memory area is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

setShort

void setShort(int index,
            short value)
              throws java.io.IOException,
                     PeripheralNotAvailableException

Writes the given short at the given index in the raw memory area associated with this object.

This memory access may involve a load and a store, and it may have unspecified effects on surrounding bytes in the presence of concurrent access.

Parameters:

index - the byte index in the raw memory area from which the short will be written.

value - the short to be written at the given index in the raw memory area.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.io.IOException - if the associated memory area is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

setShorts

void setShorts(int index,
             short[] src,
             int offset,
             int length)
               throws java.io.IOException,
                      PeripheralNotAvailableException

Writes shorts starting at the given index in the raw memory area associated with this object. This method transfers shorts from the given source array into the raw memory area.

This memory access may involve multiple load and a store operations, and it may have unspecified effects on surrounding bytes (even bytes in the range being stored) in the presence of concurrent access.

Parameters:

index - the byte index in the raw memory area at which the shorts will be written.

src - the array from which shorts are to be read.

offset - the offset within the array of the first short to be read; must be non-negative and no larger than src.length.

length - the maximum number of shorts to be written to the given array; must be non-negative and no larger than src.length - offset.

Throws:

AccessOutOfBoundsException - if index would result in pointing outside the raw memory area associated with this object.

java.lang.IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold.

java.io.IOException - if the associated memory area is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).