NTT DOCOMO and Hitachi Kokusai Electric Know-how & Confidential

com.docomo_um.module.connection
クラス SPIMasterSettingInfo

java.lang.Object
  上位を拡張 com.docomo_um.module.connection.SPIMasterSettingInfo

public class SPIMasterSettingInfo
extends java.lang.Object

SPIマスタへの設定情報を表すクラスです。

関連項目:
SPIMaster

フィールドの概要
static int DELAY_TYPE_CS_HEAD
          遅延時間の種別の一つで、CSアサートからフレーム転送開始までの時間を表します。
static int DELAY_TYPE_CS_TAIL
          遅延時間の種別の一つで、フレーム転送完了からCSデアサートまでの時間を表します。
static int DELAY_TYPE_NEXT_TRANSMIT
          遅延時間の種別の一つで、フレーム送受信間隔時間を表します。
static int SPI_RAW_CLOCK_MODE_HIGH_FALLING
          クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブHIGHであり、サンプリングを立ち下がりで行うことを表します。
static int SPI_RAW_CLOCK_MODE_HIGH_RISING
          クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブHIGHであり、サンプリングを立ち上がりで行うことを表します。
static int SPI_RAW_CLOCK_MODE_LOW_FALLING
          クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブLOWであり、サンプリングを立ち下がりで行うことを表します。
static int SPI_RAW_CLOCK_MODE_LOW_RISING
          クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブLOWであり、サンプリングを立ち上がりで行うことを表します。
static int SPI_RAW_CS_MODE_FORCED
          チップセレクト動作モードの一つで、 SPIMaster.sendCombinedFormat(SPICombinedFormatData[])、 およびSPIMaster.sendFullduplexFormat(byte[])による、 連続したフレーム送受信の間、アクティブを継続することを表します。
static int SPI_RAW_CS_MODE_FRAME
          チップセレクト動作モードの一つで、フレームの送信、または受信毎に一度、非アクティブに戻すことを表します。
static int SPI_RAW_FRAME_SIZE_16_BITS
          フレームビット数の種別の一つで、16bit/1フレームを表します。
static int SPI_RAW_FRAME_SIZE_32_BITS
          フレームビット数の種別の一つで、32bit/1フレームを表します。
static int SPI_RAW_FRAME_SIZE_64_BITS
          フレームビット数の種別の一つで、64bit/1フレームを表します。
static int SPI_RAW_FRAME_SIZE_8_BITS
          フレームビット数の種別の一つで、8bit/1フレームを表します。
 
コンストラクタの概要
SPIMasterSettingInfo()
          インスタンスを生成します。
 
メソッドの概要
 void setBitsPerFrame(int bitsperframe)
          フレームビット数の種別を設定します。
 void setClockFrequency(long frequency)
          クロック周波数(kHz)を設定します。
 void setClockMode(int clockmode)
          クロック極性と、サンプリングのタイミングを表すモードを設定します。
 void setCsMode(int csmode)
          チップセレクト動作モードを設定します。
 void setDelay(int delayType, int delayTime)
          デバイスとのフレーム送受信に必要な遅延時間を設定します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait
 

フィールドの詳細

SPI_RAW_CS_MODE_FORCED

public static final int SPI_RAW_CS_MODE_FORCED
チップセレクト動作モードの一つで、 SPIMaster.sendCombinedFormat(SPICombinedFormatData[])、 およびSPIMaster.sendFullduplexFormat(byte[])による、 連続したフレーム送受信の間、アクティブを継続することを表します。

以下の図はアクティブLOWの場合の例です。
MODE_FORCED

関連項目:
setCsMode(int csmode), 定数フィールド値

SPI_RAW_CS_MODE_FRAME

public static final int SPI_RAW_CS_MODE_FRAME
チップセレクト動作モードの一つで、フレームの送信、または受信毎に一度、非アクティブに戻すことを表します。

以下の図はアクティブLOWの場合の例です。
MODE_FRAME

関連項目:
setCsMode(int csmode), 定数フィールド値

SPI_RAW_CLOCK_MODE_HIGH_RISING

public static final int SPI_RAW_CLOCK_MODE_HIGH_RISING
クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブHIGHであり、サンプリングを立ち上がりで行うことを表します。

HIGH_RISING

関連項目:
setClockMode(int clockmode), 定数フィールド値

SPI_RAW_CLOCK_MODE_HIGH_FALLING

public static final int SPI_RAW_CLOCK_MODE_HIGH_FALLING
クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブHIGHであり、サンプリングを立ち下がりで行うことを表します。

HIGH_FALLING

関連項目:
setClockMode(int clockmode), 定数フィールド値

SPI_RAW_CLOCK_MODE_LOW_RISING

public static final int SPI_RAW_CLOCK_MODE_LOW_RISING
クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブLOWであり、サンプリングを立ち上がりで行うことを表します。

LOW_RISING

関連項目:
setClockMode(int clockmode), 定数フィールド値

SPI_RAW_CLOCK_MODE_LOW_FALLING

public static final int SPI_RAW_CLOCK_MODE_LOW_FALLING
クロック極性と、サンプリングのタイミングを表すモードの一つで、 クロック信号がアクティブLOWであり、サンプリングを立ち下がりで行うことを表します。

LOW_FALLING

関連項目:
setClockMode(int clockmode), 定数フィールド値

SPI_RAW_FRAME_SIZE_8_BITS

public static final int SPI_RAW_FRAME_SIZE_8_BITS
フレームビット数の種別の一つで、8bit/1フレームを表します。

関連項目:
setBitsPerFrame(int bitsperframe), 定数フィールド値

SPI_RAW_FRAME_SIZE_16_BITS

public static final int SPI_RAW_FRAME_SIZE_16_BITS
フレームビット数の種別の一つで、16bit/1フレームを表します。

関連項目:
setBitsPerFrame(int bitsperframe), 定数フィールド値

SPI_RAW_FRAME_SIZE_32_BITS

public static final int SPI_RAW_FRAME_SIZE_32_BITS
フレームビット数の種別の一つで、32bit/1フレームを表します。

関連項目:
setBitsPerFrame(int bitsperframe), 定数フィールド値

SPI_RAW_FRAME_SIZE_64_BITS

public static final int SPI_RAW_FRAME_SIZE_64_BITS
フレームビット数の種別の一つで、64bit/1フレームを表します。

関連項目:
setBitsPerFrame(int bitsperframe), 定数フィールド値

DELAY_TYPE_CS_HEAD

public static final int DELAY_TYPE_CS_HEAD
遅延時間の種別の一つで、CSアサートからフレーム転送開始までの時間を表します。

関連項目:
setDelay(int delayType, int delayTime), 定数フィールド値

DELAY_TYPE_CS_TAIL

public static final int DELAY_TYPE_CS_TAIL
遅延時間の種別の一つで、フレーム転送完了からCSデアサートまでの時間を表します。

関連項目:
setDelay(int delayType, int delayTime), 定数フィールド値

DELAY_TYPE_NEXT_TRANSMIT

public static final int DELAY_TYPE_NEXT_TRANSMIT
遅延時間の種別の一つで、フレーム送受信間隔時間を表します。

関連項目:
setDelay(int delayType, int delayTime), 定数フィールド値
コンストラクタの詳細

SPIMasterSettingInfo

public SPIMasterSettingInfo()
インスタンスを生成します。 インスタンス生成時に保持される設定値は通信モジュールの実装に依存します。

メソッドの詳細

setClockFrequency

public void setClockFrequency(long frequency)
クロック周波数(kHz)を設定します。

パラメータ:
frequency - 利用するクロック周波数(kHz)を指定します。
例外:
java.lang.IllegalArgumentException - 利用出来ないクロック周波数(kHz)を指定した場合に発生します。
関連項目:
SPISpec.getClockFrequencyList()

setClockMode

public void setClockMode(int clockmode)
クロック極性と、サンプリングのタイミングを表すモードを設定します。

パラメータ:
clockmode - 利用するクロック極性とサンプリングのタイミングを表すモードを指定します。
例外:
java.lang.IllegalArgumentException - クロック極性とサンプリングのタイミングを表すモードとして、定義されていない値もしくは通信モジュールの実装がサポートしていない値を指定した場合に発生します。
関連項目:
SPI_RAW_CLOCK_MODE_HIGH_RISING, SPI_RAW_CLOCK_MODE_HIGH_FALLING, SPI_RAW_CLOCK_MODE_LOW_RISING, SPI_RAW_CLOCK_MODE_LOW_FALLING

setCsMode

public void setCsMode(int csmode)
チップセレクト動作モードを設定します。

パラメータ:
csmode - 利用するチップセレクト動作モードを指定します。
例外:
java.lang.IllegalArgumentException - チップセレクト動作モードとして定義されていない値もしくは通信モジュールの実装がサポートしていない値を指定した場合に発生します。
関連項目:
SPI_RAW_CS_MODE_FORCED, SPI_RAW_CS_MODE_FRAME

setBitsPerFrame

public void setBitsPerFrame(int bitsperframe)
フレームビット数の種別を設定します。

パラメータ:
bitsperframe - フレームビット数の種別を指定します。
例外:
java.lang.IllegalArgumentException - フレームビット数の種別として定義されていない値もしくは通信モジュールの実装がサポートしていない値を指定した場合に発生します。
関連項目:
SPI_RAW_FRAME_SIZE_8_BITS, SPI_RAW_FRAME_SIZE_16_BITS, SPI_RAW_FRAME_SIZE_32_BITS, SPI_RAW_FRAME_SIZE_64_BITS

setDelay

public void setDelay(int delayType,
                     int delayTime)
              throws ConnectionException
デバイスとのフレーム送受信に必要な遅延時間を設定します。 単位は通信モジュールの実装に依存します。

以下の図はアクティブLOWの場合の例です。
チップセレクト動作モードがSPI_RAW_CS_MODE_FORCEDの場合は以下の図のようになります。

Delay

チップセレクト動作モードがSPI_RAW_CS_MODE_FRAMEの場合は以下の図のようになります。

DelayFrame

パラメータ:
delayType - 遅延時間の種別を指定します。
delayTime - 遅延時間を指定します。
例外:
java.lang.IllegalArgumentException - 遅延時間の種別として定義されていない値を指定した場合に発生します。
java.lang.IllegalArgumentException - 遅延時間として、負の値または通信モジュールの実装がサポートしていない値を指定した場合に発生します。
ConnectionException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
DELAY_TYPE_CS_HEAD, DELAY_TYPE_CS_TAIL, DELAY_TYPE_NEXT_TRANSMIT

Copyright © 2013 NTT DOCOMO, INC. and Hitachi Kokusai Electric Inc. All Rights Reserved.