最終更新日:2013.02.18

目次

1. はじめに
2. 要約
3. プログラム

1. はじめに

   本ドキュメントは、MIRS1301のI2C通信ライブラリの詳細設計書である。

2. 要約

   1. 構造体・列挙体

      構造体: I2CBus

      修飾子	名称	概要
      typedef struct I2CBus_	I2CBus	I2Cバス構造体

      構造体: I2CDevice

      修飾子	名称	概要
      typedef struct I2CDevice_	I2CDevice	I2Cデバイス構造体

   2. 定数

      修飾子・型	名称	概要
      #define	I2C_BAUD_RATE	I2Cマスターボードとの通信速度
      #define	I2C_ADDRESS_MAX	I2Cアドレスの最大値
      #define	I2C_DEVICE_FILE_NAME_MAX	I2Cマスターボードのデバイスファイル名の最大長

      修飾子・型	名称	概要
      #define	I2C_INVAL	不正な引数に対するエラー値
      #define	I2C_BUS_ERROR	CPUボードとI2Cマスターボードの間で問題が生じた場合のエラー値
      #define	I2C_DEVICE_ERROR	I2CマスターボードとI2Cデバイスの間で問題が生じた場合のエラー値

   3. 関数・関数型マクロ

      修飾子・戻値	名称・引数	概要
      I2CBus*	i2cBusOpen(char* fileName)	I2Cマスターボードとの通信を開始する
      void	i2cBusClose(I2CBus* bus)	I2Cマスターボードとの通信を終了する
      int	i2cBusReset(I2CBus* bus)	I2Cマスターボードのリセット
      int	i2cBusHasDevice(I2CBus* bus, uint8_t address)	指定したアドレスのデバイスが接続されているか判定する

      修飾子・戻値	名称・引数	概要
      I2CDevice	i2cDeviceOpen(I2CBus* bus, uint8_t address)	I2Cデバイスとの通信を開始する
      void	i2cDeviceClose(I2CDevice* device)	I2Cデバイスとの通信を終了する
      int	i2cWrite(I2CDevice* device, void* buf, uint8_t size)	I2Cデバイスにデータを送信する
      int	i2cRead(I2CDevice* device, void* buf, uint8_t size)	I2Cデバイスからデータを受信する

3. プログラム

   ダウンロード先: MIRS1301 ソフトウェア詳細設計書

▲上へ

MIRS1301 ドキュメント管理台帳へ