com.oracle.deviceaccess.spibus

Class SPIDeviceConfig

java.lang.Object

com.oracle.deviceaccess.spibus.SPIDeviceConfig

All Implemented Interfaces:

PeripheralConfig<SPIDevice>, PeripheralConfig.HardwareAddressing

public final class SPIDeviceConfig
extends java.lang.Object
implements PeripheralConfig<SPIDevice>, PeripheralConfig.HardwareAddressing

The SPIDeviceConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of an SPI slave 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.

SPI Clock Modes

The clock mode is a number from 0 to 3 which represents the combination of the CPOL (SPI Clock Polarity Bit) and CPHA (SPI Clock Phase Bit) signals where CPOL is the high order bit and CPHA is the low order bit:

Mode	CPOL	CPHA
0	0 = Active-high clocks selected.	0 = Sampling of data occurs at odd edges of the SCK clock
1	0 = Active-high clocks selected.	1 = Sampling of data occurs at even edges of the SCK clock
2	1 = Active-low clocks selected.	0 = Sampling of data occurs at odd edges of the SCK clock
3	1 = Active-low clocks selected.	1 = Sampling of data occurs at even edges of the SCK clock

An instance of SPIDeviceConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated SPI slave 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/interfaces inherited from interface com.oracle.deviceaccess.PeripheralConfig

PeripheralConfig.HardwareAddressing

Field Summary

Fields inherited from interface com.oracle.deviceaccess.PeripheralConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
SPIDeviceConfig(int deviceNumber, int address, int clockFrequency, int clockMode, int wordLength, int bitOrdering) Creates a new SPIDeviceConfig with the specified hardware addressing information and configuration parameters.
SPIDeviceConfig(java.lang.String deviceName, int address, int clockFrequency, int clockMode, int wordLength, int bitOrdering) Creates a new SPIDeviceConfig 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 SPIDeviceConfig objects for equality.
int	getAddress() Gets the configured address of the SPI slave device.
int	getBitOrdering() Gets the configured bit (shifting) ordering of the SPI slave device.
int	getClockFrequency() Gets the clock frequency (in Hz) supported by the SPI slave device.
int	getClockMode() Gets the configured clock mode (combining clock polarity and phase) for communicating with the SPI slave 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 (the device number of the SPI bus adapter the slave device is connected to).
int	getWordLength() Gets the configured word length for communicating with the SPI slave 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

Constructor Detail

SPIDeviceConfig

public SPIDeviceConfig(int deviceNumber,
               int address,
               int clockFrequency,
               int clockMode,
               int wordLength,
               int bitOrdering)

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

Parameters:

deviceNumber - the number of the bus the slave device is connected to (a positive or zero integer) or PeripheralConfig.DEFAULT.

address - the Chip Select address of the slave device on the bus (a positive or zero integer).

clockFrequency - the clock frequency of the slave device in Hz (a positive integer) or PeripheralConfig.DEFAULT.

clockMode - the clock mode, one of: 0, 1, 2 or 4 (see SPI Clock Modes).

wordLength - the word length of the slave device (a positive integer) or PeripheralConfig.DEFAULT.

bitOrdering - the bit (shifting) ordering of the slave device, one of: Peripheral.BIG_ENDIAN, Peripheral.LITTLE_ENDIAN, Peripheral.MIXED_ENDIAN or PeripheralConfig.DEFAULT.

Throws:

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

• deviceNumber is not in the defined range;
• address is not in the defined range;
• clockFrequency is not in the defined range;
• clockMode is not one of the defined values;
• wordLength is not in the defined range;
• bitOrdering is not one of the defined values.

SPIDeviceConfig

public SPIDeviceConfig(java.lang.String deviceName,
               int address,
               int clockFrequency,
               int clockMode,
               int wordLength,
               int bitOrdering)

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

Parameters:

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

address - the Chip Select address of the slave device on the bus (a positive or zero integer).

clockFrequency - the clock frequency of the slave device in Hz (a positive integer) or PeripheralConfig.DEFAULT.

clockMode - the clock mode, one of: 0, 1, 2 or 4 (see SPI Clock Modes).

wordLength - the word length of the slave device (a positive integer) or PeripheralConfig.DEFAULT.

bitOrdering - the bit (shifting) ordering of the slave device, one of: Peripheral.BIG_ENDIAN, Peripheral.LITTLE_ENDIAN, Peripheral.MIXED_ENDIAN or PeripheralConfig.DEFAULT.

Throws:

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

• address is not in the defined range;
• clockFrequency is not in the defined range;
• clockMode is not one of the defined values;
• wordLength is not in the defined range;
• bitOrdering is not one of the defined values.

java.lang.NullPointerException - if deviceName is null.

Method Detail

getAddress

public int getAddress()

Gets the configured address of the SPI slave device.

Returns:

the Chip Select address of the slave device on the bus (a positive or zero integer).

getDeviceNumber

public int getDeviceNumber()

Gets the configured device number (the device number of the SPI bus adapter the slave device is connected to).

Specified by:

getDeviceNumber in interface PeripheralConfig.HardwareAddressing

Returns:

the device number (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.

getBitOrdering

public int getBitOrdering()

Gets the configured bit (shifting) ordering of the SPI slave device.

Returns:

the bit ordering of the slave device, one of: Peripheral.BIG_ENDIAN, Peripheral.LITTLE_ENDIAN, Peripheral.MIXED_ENDIAN or PeripheralConfig.DEFAULT.

getClockFrequency

public int getClockFrequency()

Gets the clock frequency (in Hz) supported by the SPI slave device.

Returns:

the clock frequency of the slave device in Hz (a positive integer) or PeripheralConfig.DEFAULT.

getClockMode

public int getClockMode()

Gets the configured clock mode (combining clock polarity and phase) for communicating with the SPI slave device.

Returns:

the clock mode, one of: 0, 1, 2 or 4 (see SPI Clock Modes).

getWordLength

public int getWordLength()

Gets the configured word length for communicating with the SPI slave device.

Returns:

the word length of the slave device (a positive integer) or PeripheralConfig.DEFAULT.

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 SPIDeviceConfig 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 SPIDeviceConfig and has the same hardware addressing information and configuration parameter values as this SPIDeviceConfig object.