tijos.framework.devicecenter

Class TiSPIMaster

java.lang.Object

tijos.framework.devicecenter.TiSPIMaster

public class TiSPIMaster
extends Object

The TiSPIMaster for devicecenter of framework.

Author:

Andy.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE0 MODE0, CPOL=0,CPHA=0
static int	MODE1 MODE1, CPOL=0,CPHA=1
static int	MODE2 MODE2, CPOL=1,CPHA=0
static int	MODE3 MODE3, CPOL=1,CPHA=1
static int	ORDER_LSB Low bit first transmission order
static int	ORDER_MSB High bit first transmission order
static int	TYPE_DIO double io type, 16bits
static int	TYPE_PIO Parallel io type
static int	TYPE_QIO Quad io type, 32bits
static int	TYPE_SIO Single io type, 8bits

Method Summary

Modifier and Type	Method and Description
void	close() Close the port of current object
int	getPort() Gets the port id of current object
static TiSPIMaster	open(int portID) Open the TiSPIMaster port by port id, and return the object NOTE: remapID is 0, that is default location
static TiSPIMaster	openRemap(int portID, int remapID) Open the TiSPIMaster port by port id and remap id, and return the object
static int	portNumber() Maximum number of port supported
int	read(byte[] data, int offset, int len) Read the data from salve
void	selectSlave(boolean enable) Select the slave or not
void	setWorkParameters(int mode, int type, int order, int baudRate) Set work parameters
int	write(byte[] data, int offset, int len) Write the data to salve

Methods inherited from class java.lang.Object

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

Field Detail

MODE0

public static final int MODE0

MODE0, CPOL=0,CPHA=0

See Also:

Constant Field Values

MODE1

public static final int MODE1

MODE1, CPOL=0,CPHA=1

See Also:

Constant Field Values

MODE2

public static final int MODE2

MODE2, CPOL=1,CPHA=0

See Also:

Constant Field Values

MODE3

public static final int MODE3

MODE3, CPOL=1,CPHA=1

See Also:

Constant Field Values

ORDER_LSB

public static final int ORDER_LSB

Low bit first transmission order

See Also:

Constant Field Values

ORDER_MSB

public static final int ORDER_MSB

High bit first transmission order

See Also:

Constant Field Values

TYPE_DIO

public static final int TYPE_DIO

double io type, 16bits

See Also:

Constant Field Values

TYPE_PIO

public static final int TYPE_PIO

Parallel io type

See Also:

Constant Field Values

TYPE_QIO

public static final int TYPE_QIO

Quad io type, 32bits

See Also:

Constant Field Values

TYPE_SIO

public static final int TYPE_SIO

Single io type, 8bits

See Also:

Constant Field Values

Method Detail

close

public void close()
           throws IOException

Close the port of current object

Throws:

IOException - If a TiSPIMaster error occurs

getPort

public int getPort()

Gets the port id of current object

Returns:

the port id

open

public static TiSPIMaster open(int portID)
                        throws IOException

Open the TiSPIMaster port by port id, and return the object
NOTE: remapID is 0, that is default location

Parameters:

portID - port id

Returns:

TiSPIMaster object

Throws:

IOException - If a TiSPIMaster error occurs

openRemap

public static TiSPIMaster openRemap(int portID,
                                    int remapID)
                             throws IOException

Open the TiSPIMaster port by port id and remap id, and return the object

Parameters:

portID - port id

remapID - the remap Id, range:0-3

Returns:

TiSPIMaster object

Throws:

IOException - If a TiSPIMaster error occurs

portNumber

public static int portNumber()

Maximum number of port supported

Returns:

number

read

public int read(byte[] data,
                int offset,
                int len)
         throws IOException

Read the data from salve

Parameters:

data - data array

offset - data offset

len - data length

Returns:

read length

Throws:

IOException - If a TiSPIMaster error occurs

NullPointerException - If data is null

ArrayIndexOutOfBoundsException - If array index out of range

selectSlave

public void selectSlave(boolean enable)
                 throws IOException

Select the slave or not

Parameters:

enable - true - select slave, false - release slave

Throws:

IOException - If a TiSPIMaster error occurs

setWorkParameters

public void setWorkParameters(int mode,
                              int type,
                              int order,
                              int baudRate)
                       throws IOException

Set work parameters

Parameters:

mode - work mode,
MODE0: CPOL=0,CPHA=0
MODE1: CPOL=0,CPHA=1
MODE2: CPOL=1,CPHA=0
MODE3: CPOL=1,CPHA=1, default

type - type mode,
TYPE_SIO: single - I/O mode, default
TYPE_DIO: two - I/O mode
TYPE_QIO: four - I/O mode TYPE_PIO: parallel - I/O mode

order - bit order mode,
ORDER_MSB: high bit first transmission, default
ORDER_LSB: low bit first transmission

baudRate - baud rate,
1:1Mbps, default
2:2Mbps
3:3Mbps
4:4Mbps
...:...

Throws:

IOException - If a TiSPIMaster error occurs

write

public int write(byte[] data,
                 int offset,
                 int len)
          throws IOException

Write the data to salve

Parameters:

data - data array

offset - data offset

len - data length

Returns:

write length

Throws:

IOException - If a TiSPIMaster error occurs

NullPointerException - If data is null

ArrayIndexOutOfBoundsException - If array index out of range