aboutsummaryrefslogtreecommitdiff
path: root/docs/ja/i2c_driver.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja/i2c_driver.md')
-rw-r--r--docs/ja/i2c_driver.md135
1 files changed, 135 insertions, 0 deletions
diff --git a/docs/ja/i2c_driver.md b/docs/ja/i2c_driver.md
new file mode 100644
index 000000000..1d8f70e16
--- /dev/null
+++ b/docs/ja/i2c_driver.md
@@ -0,0 +1,135 @@
1# I2C マスタドライバ :id=i2c-master-driver
2
3<!---
4 grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
5 original document: 0.10.33:docs/i2c_driver.md
6 git diff 0.10.33 HEAD -- docs/i2c_driver.md | cat
7-->
8
9QMK で使われる I2C マスタドライバには、MCU 間のポータビリティを提供するための一連の関数が用意されています。
10
11## I2C アドレスについての重要なメモ :id=note-on-i2c-addresses
12
13このドライバが期待する全てのアドレスは、アドレスバイトの上位7ビットにプッシュする必要があります。最下位ビットの設定(読み込み/書き込みを示す)は、それぞれの関数によって行われます。データシートやインターネットで列挙されているほとんど全ての I2C アドレスは、下位7ビットを占める7ビットとして表され、1ビット左(より上位)にシフトする必要があります。これは、ビット単位のシフト演算子 `<< 1` を使用して簡単に実行できます。
14
15これは、呼び出しごとに以下の関数を実行するか、アドレスの定義で1度だけ実行するかどちらかで行うことができます。例えば、デバイスのアドレスが `0x18` の場合:
16
17`#define MY_I2C_ADDRESS (0x18 << 1)`
18
19I2C アドレスと他の技術詳細について、さらなる情報を得るためには https://www.robot-electronics.co.uk/i2c-tutorial を見てください。
20
21## 使用できる関数 :id=available-functions
22
23| 関数 | 説明 |
24|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
25| `void i2c_init(void);` | I2C ドライバを初期化します。他のあらゆるトランザクションを開始する前に、この関数を一度だけ呼ぶ必要があります。 |
26| `i2c_status_t i2c_start(uint8_t address, uint16_t timeout);` | I2C トランザクションを開始します。アドレスは方向ビットのない7ビットスレーブアドレスです。 |
27| `i2c_status_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` | I2C 経由でデータを送信します。アドレスは方向ビットのない7ビットスレーブアドレスです。トランザクションのステータスを返します。 |
28| `i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` | I2C 経由でデータを受信します。アドレスは方向ビットのない7ビットスレーブアドレスです。 `length` で指定した長さのバイト列を `data` に保存し、トランザクションのステータスを返します。 |
29| `i2c_status_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` | `i2c_transmit` と同様ですが、 `regaddr` でスレーブのデータ書き込み先のレジスタを指定します。 |
30| `i2c_status_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` | `i2c_receive` と同様ですが、 `regaddr` でスレーブのデータ読み込み先のレジスタを指定します。 |
31| `i2c_status_t i2c_stop(void);` | I2C トランザクションを終了します。 |
32
33### 関数の戻り値 :id=function-return
34
35`void i2c_init(void)` を除く上にあるすべての関数は、次の真理値表にある値を返します。
36
37|戻り値の定数 |値 |説明 |
38|--------------------|---|----------------------------|
39|`I2C_STATUS_SUCCESS`|0 |処理が正常に実行されました。|
40|`I2C_STATUS_ERROR` |-1 |処理に失敗しました。 |
41|`I2C_STATUS_TIMEOUT`|-2 |処理がタイムアウトしました。|
42
43## AVR :id=avr
44
45### 設定 :id=avr-configuration
46
47I2Cマスタドライバを設定するために、次の定義が使えます。
48
49| 変数 | 説明 | 既定値 |
50|---------|---------------------|--------|
51| `F_SCL` | クロック周波数 (Hz) | 400KHz |
52
53
54AVR は通常 I2C ピンとして使う GPIO が設定されているので、これ以上の設定は必要ありません。
55
56## ARM :id=arm
57
58ARM の場合は、内部に ChibiOS I2C HAL ドライバがあります。この節では STM32 MCU を使用していると仮定します。
59
60### 設定 :id=arm-configuration
61
62ARM MCU 用の設定はしばしば非常に複雑です。これは、多くの場合複数の I2C ドライバをさまざまなポートに対して割り当てられるためです。
63
64最初に、必要なハードウェアドライバを有効にするために `mcuconf.h` ファイルをセットアップします。
65
66| 変数 | 説明 | 既定値 |
67|-------------------------------|------------------------------------------------------------------------------------------------|--------|
68| `#STM32_I2C_USE_XXX` | ハードウェアドライバ XXX の有効化/無効化（すべてのドライバを明示的にリストアップする必要あり） | FALSE |
69| `#STM32_I2C_BUSY_TIMEOUT` | レスポンスの受信がない場合に I2C コマンドを中断するまでの時間 (ms) | 50 |
70| `#STM32_I2C_XXX_IRQ_PRIORITY` | ハードウェアドライバ XXX の割り込み優先度（上級者向けの設定） | 10 |
71| `#STM32_I2C_USE_DMA` | MCU がデータ送信を DMA ユニットにオフロードする機能の有効化/無効化 | TRUE |
72| `#STM32_I2C_XXX_DMA_PRIORITY` | ハードウェアドライバ XXX に使用する DMA ユニットの優先度（上級者向けの設定） | 1 |
73
74次に `halconf.h` ファイル内で `#define HAL_USE_I2C` を `TRUE` にします。これにより ChibiOS が I2C ドライバを読み込みます。
75
76最後に、使用したい I2C ハードウェアドライバに応じて正しい GPIO ピンを割り当てます。
77
78標準では I2C1 ハードウェアドライバが使われます。もし他のハードウェアドライバを使う場合、 `config.h` ファイルに `#define I2C_DRIVER I2CDX` を追加します（ X は使用するハードウェアドライバの番号です）。例えば I2C3 を有効化する場合、`config.h` ファイルに `#define I2C_DRIVER I2CD3` と定義します。これにより QMK I2C ドライバと ChibiOS I2C driver が同期されます。
79
80STM32 MCU では、使用するハードウェアドライバにより、さまざまなピンを I2C ピンとして設定できます。標準では `B6`, `B7` ピンが I2C 用のピンです。 I2C 用のピンを設定するために次の定義が使えます：
81
82| 変数 | 説明 | 既定値 |
83|-----------------------|-------------------------------------------------------------------------------------------|---------|
84| `I2C1_SCL_PIN` | SCL のピン番号 | `B6` |
85| `I2C1_SDA_PIN` | SDA のピン番号 | `B7` |
86
87ChibiOS I2C ドライバの設定項目は STM32 MCU の種類に依存します。
88
89 STM32F1xx, STM32F2xx, STM32F4xx, STM32L0xx, STM32L1xx では I2Cv1 が使われます。
90 STM32F0xx, STM32F3xx, STM32F7xx, STM32L4xx では I2Cv2 が使われます。
91
92#### I2Cv1 :id=i2cv1
93
94STM32 MCU の I2Cv1 では、クロック周波数とデューティ比を次の変数で変更できます。詳しくは <https://www.playembedded.org/blog/stm32-i2c-chibios/#I2Cv1_configuration_structure> を参照してください。
95
96| 変数 | 既定値 |
97|--------------------|------------------|
98| `I2C1_OPMODE` | `OPMODE_I2C` |
99| `I2C1_CLOCK_SPEED` | `100000` |
100| `I2C1_DUTY_CYCLE` | `STD_DUTY_CYCLE` |
101
102#### I2Cv2 :id=i2cv2
103
104STM32 MCU の I2Cv2 では、信号のタイミングパラメータを次の変数で変更できます。詳しくは <https://www.st.com/en/embedded-software/stsw-stm32126.html> を参照してください。
105
106| 変数 | 既定値 |
107|-----------------------|--------|
108| `I2C1_TIMINGR_PRESC` | `15U` |
109| `I2C1_TIMINGR_SCLDEL` | `4U` |
110| `I2C1_TIMINGR_SDADEL` | `2U` |
111| `I2C1_TIMINGR_SCLH` | `15U` |
112| `I2C1_TIMINGR_SCLL` | `21U` |
113
114STM32 MCU では GPIO ピンを設定するとき、別の「代替機能」モードを使うことができます。これは I2Cv2 モードで使われるピンを変更するために必要です。適切な設定値は、使用している MCU のデータシートを参照してください。
115
116| 変数 | 既定値 |
117|---------------------|--------|
118| `I2C1_SCL_PAL_MODE` | `4` |
119| `I2C1_SDA_PAL_MODE` | `4` |
120
121#### その他 :id=other
122
123`void i2c_init(void)` 関数は `weak` 属性が付いており、オーバーロードすることができます。この場合、上記で設定した変数は使用されません。可能な GPIO の設定については、 MCU のデータシートを参照してください。次に示すのは初期化関数の例です：
124
125```c
126void i2c_init(void)
127{
128 setPinInput(B6); // Try releasing special pins for a short time
129 setPinInput(B7);
130 wait_ms(10); // Wait for the release to happen
131
132 palSetPadMode(GPIOB, 6, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B6 to I2C function
133 palSetPadMode(GPIOB, 7, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B7 to I2C function
134}
135```
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-27 18:34:55 +0100