# SHARP Brain (Brainux) 用 CPUクロック・コア電圧制御スクリプト 利用マニュアル

NXP i.MX28 (ARM926EJ-S) の電源管理モジュールおよびクロック制御レジスタを物理メモリ (`/dev/mem`) 経由で直接読み書きし、現在の動作状態の監視やオーバークロック／省電力化を行うシェルスクリプト群です。

* **`clkinfo.sh`**: 現在のコア電圧 (VDDD) および各システムクロックの実測値を表示するモニターツール
* **`clkset.sh`**: プリセットプロファイルや個別パラメータ指定により、安全にクロック・電圧を変更する設定ツール

---

## 1. 前提環境とセットアップ

### 動作要件
* SHARP Brain シリーズ（Brainux 環境）
* `busybox`（`devmem` および `usleep` アプレットが有効であること）
* `sudo` 権限（物理メモリ `/dev/mem` へのアクセスに必要。一般ユーザーから実行した場合は自動で `sudo` 昇格します）

### インストール手順
2つのスクリプトを同じディレクトリに配置し、実行権限を付与します。

```bash
chmod +x clkinfo.sh clkset.sh
```
※ `clkset.sh` は実行完了後（およびヘルプ表示時）に同一ディレクトリ内の `clkinfo.sh` を自動で呼び出して現在の状態を表示します。

---

## 2. `clkinfo.sh`（現在の電圧・クロック確認）

レジスタの値を読み出し、現在のコア電圧と各部の実周波数を計算して表示します。

### コマンド書式
```bash
./clkinfo.sh [オプション]
```

### オプション一覧

| オプション | 説明 |
| :--- | :--- |
| *(なし)* | 現在のコア電圧・CPU・AHBバス・メモリ・IOのサマリーのみ表示 |
| `-v`, `--verbose` | サマリーに加え、関連する全5レジスタの16進数生値と全ビットフィールドの内訳を表示 |
| `-h`, `--help` | ヘルプメッセージを表示 |

### 実行例（通常表示）
```text
\$ ./clkinfo.sh
==========================================================
 i.MX28 Power & Clock Summary
==========================================================
VDDD Core Voltage                   :1.550 V    (TRG=30, Brownout: 1.375 V)
CPU Clock (CLK_P)                   :454.74 MHz (CPUFRAC=19, ref_cpu: 454.74 MHz)
AHB Bus Clock (CLK_HBUS)            :198.95 MHz (HBUS=0x2E (14/32))
EMI Ref Clock (ref_emi)             :392.73 MHz
IO0 / IO1 Ref Clock                 :288.00 MHz / 288.00 MHz
```


## 3. `clkset.sh`（クロック・コア電圧の変更）

安全性を考慮し、クロックアップ時は **「①コア電圧昇圧 → ②AHBバス分周比調整 → ③CPUクロック上昇」**、クロックダウン時は逆の順序でレジスタを書き換えます。

### コマンド書式
```bash
./clkset.sh <プロファイル> [オプション]
./clkset.sh -c <CPUFRAC値> [オプション]
```
※ 引数なしで実行すると、プロファイル一覧・オプション一覧と現在のクロック状態（`clkinfo.sh` の結果）が表示されます。

### プリセットプロファイル一覧
初期設定の AHB バス上限 (`MAX_HBUS_MHZ=220`) に基づく各プロファイルの動作仕様です。

| プロファイル | CPU周波数 | CPUFRAC | コア電圧 (TRG) | HBUS設定 (分周比) | 計算上のAHBクロック | 用途・目安 |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| **`261`** | 261.82 MHz | 33 | 1.350 V (`22`) | `0x02` (1/2) | 130.91 MHz | 省電力・アイドル時向け |
| **`360`** | 360.00 MHz | 24 | 1.400 V (`24`) | `0x2C` (12/32) | 135.00 MHz | 低発熱・安定駆動 |
| **`454`** | 454.74 MHz | 19 | 1.550 V (`30`) | `0x2E` (14/32) | 198.95 MHz | **Brainux 標準定格** |
| **`480`** | 480.00 MHz | 18 | 1.550 V (`30`) | `0x2E` (14/32) | 210.00 MHz | 定格電圧での上限目安 |
| **`508`** | 508.24 MHz | 17 | 1.575 V (`31`) | `0x2E` (14/32) | 222.35 MHz ※ | 実用オーバークロック |
| **`540`** | 540.00 MHz | 16 | 1.575 V (`31`) | `0x2E` (14/32) | 236.25 MHz ※ | 高負荷・限界テスト1 |
| **`576`** | 576.00 MHz | 15 | 1.575 V (`31`) | `0x2D` (13/32) | 234.00 MHz ※ | 高負荷・限界テスト2 |
| **`617`** | 617.14 MHz | 14 | 1.575 V (`31`) | `0x2C` (12/32) | 231.43 MHz ※ | 高負荷・限界テスト3 |
| **`664`** | 664.62 MHz | 13 | 1.575 V (`31`) | `0x2B` (11/32) | 228.46 MHz ※ | 高負荷・限界テスト4 |
| **`720`** | 720.00 MHz | 12 | 1.575 V (`31`) | `0x2A` (10/32) | 225.00 MHz ※ | 高負荷・限界テスト5 |

※ デフォルトの `MAX_HBUS_MHZ=220` が有効な場合、AHBクロックが 220.00 MHz を超えるプロファイル（`508` 以上）は、自動リミッター機能により `HBUS` 分周比が安全な値へ自動調整されます。

### オプション一覧

| オプション | 引数 | 説明 |
| :--- | :--- | :--- |
| `-c` | `<12-63>` | プロファイル名の代わりに `CPUFRAC` 値を直接指定 (`480MHz × 18 ÷ CPUFRAC`) |
| `-v` | `<0-31>` | コア電圧 (`TRG` 値) を個別上書き (`0.800V + TRG × 0.025V`) |
| `-b` | `<0x01-0x3F>` | `HBUS` レジスタ値（Bit5:分数有効、Bit4-0:分周比）を個別上書き |
| `-d`, `--dry-run` | *(なし)* | レジスタの書き換えを行わず、計算結果と適用予定値のみ表示 |
| `-n` | *(なし)* | 設定変更後の `clkinfo.sh` 自動実行をスキップ |
| `-h`, `--help` | *(なし)* | ヘルプ（プロファイル・オプション一覧）と現在の状態を表示 |

### 実践的なコマンド例

```bash
# 1. 実用オーバークロック (508.24 MHz) に変更する
./clkset.sh 508

# 2. まずはドライラン (-d) で 576 MHz 時の計算結果・リミッター動作を確認する
./clkset.sh 576 -d

# 3. プロファイル 576 をベースに、電圧だけ TRG=30 (1.550 V) に下げてテストする
./clkset.sh 576 -v 30

# 4. CPUFRAC=15 (576 MHz) かつ HBUS=0x2D (13/32分周 = 234 MHz) を明示指定する
./clkset.sh -c 15 -v 31 -b 0x2D

# 5. 定格 (454.74 MHz) に戻す
./clkset.sh 454
```

---

## 4. カスタマイズと注意事項

### AHBバス上限 (`MAX_HBUS_MHZ`) の変更方法
`clkset.sh` 冒頭のユーザー設定変数を編集することで、自動リミッターが介入する AHB バス上限を変更できます。
```sh
MAX_HBUS_MHZ=220   # 例: 240 に変更すると 240.00 MHz まで自動調整されなくなります
```
※ `-b` オプションで `HBUS` を明示指定した場合は、自動リミッターによる上書きは行われず、警告表示のみで指定値が優先されます。

### 使用上の注意（免責事項）
* **自己責任での運用**: ハードウェア仕様の定格を超える電圧・周波数設定は、SoC の発熱増加、システムフリーズ、SDカードのデータ破損、および本体故障の原因となります。
* **個体差と周辺機器への影響**: 安定して動作する上限クロックには個体差があります。また、AHBバス (`CLK_HBUS`) を上げすぎると、USB機器の認識不良や画面表示の乱れが発生することがあります。
* **ZSWAP等との併用**: メモリ圧縮（ZSWAP）や高負荷な処理と極端なオーバークロックを併用すると、電圧降下やタイミング不整合によりフリーズしやすくなる場合があります。まずは `-d` で計算値を確認し、低いクロックから段階的に安定性を検証してください。





