#!/bin/sh
# ==============================================================================
# i.MX28 Power & Clock Information Script (for SHARP Brain / Brainux)
# ==============================================================================
# 【概要】
# NXP i.MX28 (ARM926EJ-S) の電源管理モジュール (POWER) およびクロック制御
# モジュール (CLKCTRL) の主要5レジスタを物理メモリ (/dev/mem) から読み出し、
# 各ビットの解析結果と現在の実電圧 (V)・実周波数 (MHz) を計算して表示します。
#
# 【AHBバス (Advanced High-performance Bus) とは】
# ARM AMBA規格における高速データ転送用の基幹システムバス（内部の大動脈）です。
# i.MX28では多層バススイッチ（AHBマトリクス）として実装されており、CPUコア・
# 外部メモリ(DDR/EMI)・内蔵SRAM・DMAコントローラ、およびUSB・LCD・SDカード等の
# 高速周辺機器を相互に接続しています。また、UARTやI2C等の低速ペリフェラルも
# AHB-to-APBブリッジを介してこのバスにぶら下がっています。
# 動作クロック (CLK_HBUS) は CPUクロック (CLK_P) から分周して生成されるため、
# CPUオーバークロック時に CLK_HBUS が上がりすぎると、USBの切断やLCD画面の崩れ
# といった周辺機器の同期エラーを引き起こすボトルネックになります。
# ==============================================================================

# ==============================================================================
# 【使い方】
#   sudo ./clkinfo.sh       : サマリー（電圧・各部の実周波数）のみ表示
#   sudo ./clkinfo.sh -v    : サマリー ＋ 全5レジスタのビット詳細内訳を表示
#   ./clkinfo.sh -h         : ヘルプを表示
# ==============================================================================


# 現在の実行ユーザー（UID）を確認し、root（UID=0）でなければ exec sudo でスクリプト自身を再実行する
if [ "$(id -u)" -ne 0 ]; then
    exec sudo "$0" "$@"
fi


VERBOSE=0

while [ $# -gt 0 ]; do
    case "$1" in
        -v|--verbose)
            VERBOSE=1
            shift
            ;;
        -h|--help)
            echo "Usage: $0 [-v]"
            echo "  -v, --verbose : Show detailed bit breakdown for each register"
            echo "  -h, --help    : Show this help message"
            exit 0
            ;;
        *)
            echo "Error: Unknown option '$1' (use -h for help)."
            exit 1
            ;;
    esac
done


# ------------------------------------------------------------------------------
# 1. 各レジスタの物理アドレスと読み出し
# ------------------------------------------------------------------------------

# [1] HW_POWER_VDDDCTRL (オフセット 0x040 / 物理アドレス 0x80044040)
# CPUコア電源 (VDDD) の目標電圧 (TRG)、ブラウンアウト検出オフセット (BO_OFFSET)、
# および内蔵DC-DCコンバータとリニアレギュレータの供給方式を制御するレジスタ。
# ・電圧計算式: 0.800 V + (TRG × 0.025 V)  ※推奨上限: 1.550 V (TRG=30) / 物理上限: 1.575 V (TRG=31)
# ・低電圧保護: 目標電圧から (BO_OFFSET × 25 mV) 低下するとブラウンアウトを検出。
VAL1=$(busybox devmem 0x80044040)

# [2] HW_CLKCTRL_FRAC0 (オフセット 0x1B0 / 物理アドレス 0x800401B0)
# システムPLL (PLL0: 480 MHz) の出力から、CPU・メモリ(EMI)・I/O(IO0/IO1) の
# 4系統の基準クロック (ref_cpu, ref_emi, ref_io1, ref_io0) をフラクショナル分周で生成し、
# 各系統のクロックゲート (CLKGATE*) と安定フラグ (*_STABLE) を管理するレジスタ。
# ・周波数計算式: 480 MHz × (18 / *FRAC)  ※推奨設定範囲: 18 ～ 35
VAL2=$(busybox devmem 0x800401B0)

# [3] HW_CLKCTRL_CPU (オフセット 0x050 / 物理アドレス 0x80040050)
# CPUコアへ供給される最終クロック (CLK_P) の分周比と、割り込み待機時 (WFI) の
# 自動クロック停止 (INTERRUPT_WAIT) を制御するレジスタ。
# ・通常時 (BYPASS_CPU=0): ref_cpu ÷ DIV_CPU (Bit 5:0, 整数分周 1～63)
# ・バイパス時 (BYPASS_CPU=1): 24 MHz ÷ DIV_XTAL (または 24 MHz × DIV_XTAL ÷ 1024)
VAL3=$(busybox devmem 0x80040050)

# [4] HW_CLKCTRL_HBUS (オフセット 0x060 / 物理アドレス 0x80040060)
# CPUクロック (CLK_P) から AHBバス (CLK_HBUS) を生成する分周比と、バスアイドル時の
# 自動減速機能 (Auto Slow Mode: ASM_ENABLE / SLOW_DIV) を制御するレジスタ。
# ・整数分周 (DIV_FRAC_EN=0): CLK_P ÷ DIV
# ・分数分周 (DIV_FRAC_EN=1): CLK_P × DIV ÷ 32
VAL4=$(busybox devmem 0x80040060)

# [5] HW_CLKCTRL_CLKSEQ (オフセット 0x1D0 / 物理アドレス 0x800401D0)
# 各モジュール (CPU・メモリ・LCD・SDカード等) のクロック供給元を、PLL (高速側: 0) と
# 24 MHz 水晶発振器 (ref_xtal・バイパス側: 1) のどちらにするか切り替える選択レジスタ。
VAL5=$(busybox devmem 0x800401D0)


# 主要パラメータの抽出
TRG=$(( VAL1 & 0x1F ))
BO_OFF=$(( (VAL1 >> 8) & 0x07 ))

IO0FRAC=$(( (VAL2 >> 24) & 0x3F ))
IO1FRAC=$(( (VAL2 >> 16) & 0x3F ))
EMIFRAC=$(( (VAL2 >> 8) & 0x3F ))
CPUFRAC=$(( VAL2 & 0x3F ))

DIV_XTAL_FRAC=$(( (VAL3 >> 26) & 0x01 ))
DIV_XTAL=$(( (VAL3 >> 16) & 0x3FF ))
DIV_CPU=$(( VAL3 & 0x3F ))

HBUS_FRAC_EN=$(( (VAL4 >> 5) & 0x01 ))
HBUS_DIV=$(( VAL4 & 0x1F ))

BYPASS_CPU=$(( (VAL5 >> 18) & 0x01 ))
BYPASS_EMI=$(( (VAL5 >> 7) & 0x01 ))

# 電圧の計算 (mV単位で計算し、小数点以下3桁のV表記に整形)
VDDD_MV=$(( 800 + TRG * 25 ))
BO_MV=$(( VDDD_MV - BO_OFF * 25 ))
VDDD_STR="$(( VDDD_MV / 1000 )).$(printf '%03d' $(( VDDD_MV % 1000 )))"
BO_STR="$(( BO_MV / 1000 )).$(printf '%03d' $(( BO_MV % 1000 )))"

# 周波数の計算 (kHz単位で整数演算し、小数点以下2桁のMHz表記に整形)
# 1. ref_cpu / CLK_P (CPUクロック)
REF_CPU_KHZ=$(( 480000 * 18 / CPUFRAC ))
if [ "$BYPASS_CPU" -eq 0 ]; then
    CLK_P_KHZ=$(( REF_CPU_KHZ / DIV_CPU ))
else
    if [ "$DIV_XTAL_FRAC" -eq 0 ]; then
        CLK_P_KHZ=$(( 24000 / DIV_XTAL ))
    else
        CLK_P_KHZ=$(( 24000 * DIV_XTAL / 1024 ))
    fi
fi

# 2. CLK_HBUS (AHBバス)
if [ "$HBUS_FRAC_EN" -eq 1 ]; then
    CLK_HBUS_KHZ=$(( CLK_P_KHZ * HBUS_DIV / 32 ))
else
    CLK_HBUS_KHZ=$(( CLK_P_KHZ / HBUS_DIV ))
fi

# 3. ref_emi (メモリ基準クロック)
if [ "$BYPASS_EMI" -eq 0 ]; then
    REF_EMI_KHZ=$(( 480000 * 18 / EMIFRAC ))
else
    REF_EMI_KHZ=24000
fi

# 4. ref_io0 / ref_io1
REF_IO0_KHZ=$(( 480000 * 18 / IO0FRAC ))
REF_IO1_KHZ=$(( 480000 * 18 / IO1FRAC ))

# kHz -> "XXX.XX MHz" 変換関数
fmt_mhz() {
    mh=$(( $1 / 1000 ))
    kh=$(( ($1 % 1000 + 5) / 10 ))
    if [ "$kh" -ge 100 ]; then
        mh=$(( mh + 1 ))
        kh=0
    fi
    printf "%d.%02d MHz" "$mh" "$kh"
}


# HBUS 表示用文字列の作成
HBUS_HEX=$(printf "0x%02X" $(( VAL4 & 0x3F )))
if [ "$HBUS_FRAC_EN" -eq 1 ]; then
    HBUS_STR="${HBUS_HEX} (${HBUS_DIV}/32)"
else
    HBUS_STR="${HBUS_HEX} (1/${HBUS_DIV})"
fi


echo "=========================================================="
echo " i.MX28 Power & Clock Summary"
echo "=========================================================="
echo "VDDD Core Voltage         :${VDDD_STR} V    (TRG=${TRG}, Brownout: ${BO_STR} V)"
echo "CPU Clock (CLK_P)         :$(fmt_mhz $CLK_P_KHZ) (CPUFRAC=${CPUFRAC}, ref_cpu: $(fmt_mhz $REF_CPU_KHZ))"
echo "AHB Bus Clock (CLK_HBUS)  :$(fmt_mhz $CLK_HBUS_KHZ) (HBUS=${HBUS_STR})"
echo "EMI Ref Clock (ref_emi)   :$(fmt_mhz $REF_EMI_KHZ)"
echo "IO0 / IO1 Ref Clock       :$(fmt_mhz $REF_IO0_KHZ) / $(fmt_mhz $REF_IO1_KHZ)"
echo ""


if [ "$VERBOSE" -eq 1 ]; then
	echo "----------------------------------------------------------"
	echo "HW_POWER_VDDDCTRL(0x80044040)       :$VAL1"                        #0x0002071E
	                                                                              #HW_POWER_VDDDCTRL(オフセット 0x040 / 物理アドレス 0x80044040)は、
										      #i.MX28のCPUコアおよびデジタル論理回路へ供給する電源(VDDD)の目標電圧、
										      #低電圧保護(ブラウンアウト)閾値、および電源供給経路(DC-DCコンバータとリニアレギュレータ)を制御するレジスタです。
	echo "ADJTN (Bit31-28)                    :$(( (VAL1 >> 28) & 0x0F ))"   #0   #内部リニアレギュレータのトリミング調整値(通常は変更不要)。
	echo "PWDN_BRNOUT (Bit23)                 :$(( (VAL1 >> 23) & 0x01 ))"   #0   #1 にすると VDDD ブラウンアウト(低電圧)検出回路をパワーダウンします。
	echo "DISABLE_STEPPING (Bit22)            :$(( (VAL1 >> 22) & 0x01 ))"   #0   #0 のとき、電圧変更時に急激な変動を防ぐため段階的(ステッピング)に電圧を変化させます。
	echo "ENABLE_LINREG (Bit21)               :$(( (VAL1 >> 21) & 0x01 ))"   #0   #内部リニアレギュレータの有効化(DC-DCコンバータ有効時は通常 0 に設定)。
	echo "DISABLE_FET (Bit20)                 :$(( (VAL1 >> 20) & 0x01 ))"   #0   #1 にすると DC-DC コンバータ用の内部 FET を無効化します。
	echo "LINREG_OFFSET (Bit17-16)            :$(( (VAL1 >> 16) & 0x03 ))"   #2   #リニアレギュレータの出力オフセット設定(0～3、通常は 2 = -50 mV 等で DC-DC と競合しないよう調整)。
	echo "BO_OFFSET (Bit10-8)                 :$BO_OFF"                      #7   #ブラウンアウト検出オフセット。目標電圧(TRG)からどれだけ電圧が下がったらブラウンアウトを検出するかを指定します(値×25 mV)。7 の場合は 175 mV 下がると検出します。
	echo "TRG [CPU Core Voltage] (Bit4-0)     :$TRG"                         #30  #VDDD 目標電圧(ターゲット)。0.800 V + (TRG × 0.025 V) で計算します(範囲：0 ～ 31)。0x1E(30)は 1.550 V です。
	echo ""
	echo "----------------------------------------------------------"
	echo "HW_CLKCTRL_FRAC0(0x800401B0)        :$VAL2"                        #0x1E5E1653
	                                                                              #HW_CLKCTRL_FRAC0(オフセット 0x1B0 / 物理アドレス 0x800401B0)は、
										      #PLL0(480 MHz)から 4つの主要周辺機器・コア向けのフラクショナルクロック
										      #(ref_io0、ref_io1、ref_emi、ref_cpu)を一括生成するレジスタです。
	echo "CLKGATEIO0 (Bit31)                  :$(( (VAL2 >> 31) & 0x01 ))"   #0   #ref_io0(SD/MMC0 等向け)のクロックゲート(0: 有効 / 1: 停止)
	echo "IO0_STABLE (Bit30)                  :$(( (VAL2 >> 30) & 0x01 ))"   #0   #ref_io0 の安定フラグ(1: 安定 / 0: 遷移中)
	echo "IO0FRAC (Bit29-24)                  :$IO0FRAC"                     #30  #ref_io0 分周比(480 MHz × 18 / 30 = 288.00 MHz)
	echo "CLKGATEIO1 (Bit23)                  :$(( (VAL2 >> 23) & 0x01 ))"   #0   #ref_io1(SD/MMC1 等向け）のクロックゲート(0: 有効 / 1: 停止)
	echo "IO1_STABLE (Bit22)                  :$(( (VAL2 >> 22) & 0x01 ))"   #1   #ref_io1 の安定フラグ(1: 安定 / 0: 遷移中)
	echo "IO1FRAC (Bit21-16)                  :$IO1FRAC"                     #30  #ref_io1 分周比(480 MHz × 18 / 30 = 288.00 MHz)
	echo "CLKGATEEMI (Bit15)                  :$(( (VAL2 >> 15) & 0x01 ))"   #0   #ref_emi(外部メモリ DDR2 / mDDR 向け)のクロックゲート(0: 有効 / 1: 停止)
	echo "EMI_STABLE (Bit14)                  :$(( (VAL2 >> 14) & 0x01 ))"   #0   #ref_emi の安定フラグ(1: 安定 / 0: 遷移中)
	echo "EMIFRAC (Bit13-8)                   :$EMIFRAC"                     #22  #ref_emi 分周比(480 MHz × 18 / 22 = 392.73 MHz、DDR クロックの基準)
	echo "CLKGATECPU (Bit7)                   :$(( (VAL2 >> 7) & 0x01 ))"    #0   #ref_cpu(CPUコア向け)のクロックゲート(0: 有効 / 1: 停止)
	echo "CPU_STABLE (Bit6)                   :$(( (VAL2 >> 6) & 0x01 ))"    #1   #ref_cpu の安定フラグ(1: 安定 / 0: 遷移中)
	echo "CPUFRAC (Bit5-0)                    :$CPUFRAC"                     #19  #ref_cpu 分周比(480 MHz × 18 / 19 = 454.74 MHz)
	echo ""
	echo "----------------------------------------------------------"
	echo "HW_CLKCTRL_CPU(0x80040050)          :$VAL3"                        #0x00011001
	                                                                              #HW_CLKCTRL_CPU(オフセット 0x050 / 物理アドレス 0x80040050)は、
	                                                                              #CPUコアへの最終クロック(CLK_P）の分周比、バイパス時の水晶側分周比、
	                                                                              #および割り込み待機時のクロック停止制御を行うレジスタです
	echo "BUSY_REF_XTAL (Bit29)               :$(( (VAL3 >> 29) & 0x01 ))"   #0   #水晶側分周器(DIV_XTAL）のビジーフラグ(1: 変更中 / 0: 完了・安定)。
	echo "BUSY_REF_CPU (Bit28)                :$(( (VAL3 >> 28) & 0x01 ))"   #0   #PLL側分周器(DIV_CPU）のビジーフラグ(1: 変更中 / 0: 完了・安定)。
	echo "DIV_XTAL_FRAC_EN (Bit26)            :$DIV_XTAL_FRAC"               #0   #水晶側のフラクショナル分周有効化(BYPASS_CPU = 1 の時のみ有効)。
	echo "DIV_XTAL (Bit25-16)                 :$DIV_XTAL"                    #1   #バイパスモード(BYPASS_CPU = 1)時の水晶(24 MHz)分周比(10ビット、1～1023)。
	echo "INTERRUPT_WAIT (Bit12)              :$(( (VAL3 >> 12) & 0x01 ))"   #1   #1 のとき、WFI(割り込み待機）命令実行中に CPUクロックを自動停止して省電力化します。
	echo "DIV_CPU (Bit5-0)                    :$DIV_CPU"                     #1   #通常モード(BYPASS_CPU = 0)時の整数分周比(6ビット、1～63、0は禁止)。CLK_P = ref_cpu / DIV_CPU。
	echo ""
	echo "----------------------------------------------------------"
	echo "HW_CLKCTRL_HBUS(0x80040060)         :$VAL4"                        #0x0000002E
	                                                                              #i.MX28 において AHBバス(CLK_HBUS / 内部システムバス)には、
										      #CPUコアとメインメモリ(DDR)・内蔵SRAM・および主要な高速周辺機器
										      #(USB、LCD、DMA、SDカードなど)をつなぐ「大動脈」となるバススイッチ
										      #(AHBマトリクス)が接続されています。
	echo "BUSY (Bit31)                        :$(( (VAL4 >> 31) & 0x01 ))"   #0   #HBUS 分周器のビジーフラグ(1: クロック変更中 / 0: 完了・安定)。
	echo "AUTO_CLEAR_DIV_ENABLE (Bit28-26)    :$(( (VAL4 >> 26) & 0x07 ))"   #0   #割り込み等のイベント発生時に SLOW_DIV を自動解除する条件設定。
	echo "SLOW_DIV (Bit25-21)                 :$(( (VAL4 >> 21) & 0x1F ))"   #0   #オートスローダウン有効時の低速側分周比(5ビット)。
	echo "ASM_ENABLE (Bit20)                  :$(( (VAL4 >> 20) & 0x01 ))"   #0   #オートスローダウン(Auto Slow Mode）の有効化(1: 有効 / 0: 無効)。
	echo "ASM_EMIPORT_MODE (Bit19-16)         :$(( (VAL4 >> 16) & 0x0F ))"   #0   #EMIポート(メモリ）のアイドル検出条件設定。
	echo "DIV_FRAC_EN (Bit5)                  :$HBUS_FRAC_EN"                #1   #分周モード選択(0: 整数分周 CLK_P / DIV / 1: フラクショナル分周 CLK_P × DIV / 32)。
	echo "DIV (Bit4-0)                        :$HBUS_DIV"                    #14  #AHBバス分周比(5ビット、1～31、0は禁止)。実機では CLK_P × 14 / 32 に設定されています。
	
	echo ""
	echo "----------------------------------------------------------"
	echo "HW_CLKCTRL_CLKSEQ(0x800401D0)       :$VAL5"                        #0x00000104
	                                                                              #基本的に各ビットとも 0 が PLL 側（通常・高速動作）、1 が 24MHz水晶側(バイパス動作) を意味します。
										      #(一部のオーディオ・ビデオ系のみ選択対象が異なります)
	echo "BYPASS_CPU (Bit18)                  :$BYPASS_CPU"                  #0   #CPUクロックソース(0: PLL0由来 ref_cpu / 1: 24 MHz ref_xtal)
	echo "BYPASS_DIS_LCDIF (Bit16)            :$(( (VAL5 >> 16) & 0x01 ))"   #0   #LCDコントローラ(LCDIF）ソース(0: PLL由来 ref_pix / 1: ref_xtal）
	echo "BYPASS_ETM (Bit14)                  :$(( (VAL5 >> 14) & 0x01 ))"   #0   #トレースモジュール(ETM）ソース(0: ref_cpu / 1: ref_xtal）
	echo "BYPASS_GPMI (Bit12)                 :$(( (VAL5 >> 12) & 0x01 ))"   #0   #NANDフラッシュ(GPMI）ソース(0: PLL由来 ref_gpmi / 1: ref_xtal）
	echo "BYPASS_EMI (Bit7)                   :$BYPASS_EMI"                  #0   #外部メモリ(DDR/EMI）ソース(0: PLL0由来 ref_emi / 1: ref_xtal）
	echo "BYPASS_SAIF1 (Bit6)                 :$(( (VAL5 >> 6) & 0x01 ))"    #0   #オーディオインターフェース1(SAIF1）ソース(0: PLL由来 / 1: ref_xtal）
	echo "BYPASS_SAIF0 (Bit5)                 :$(( (VAL5 >> 5) & 0x01 ))"    #0   #オーディオインターフェース0(SAIF0）ソース(0: PLL由来 / 1: ref_xtal）
	echo "BYPASS_SSP3 (Bit3)                  :$(( (VAL5 >> 3) & 0x01 ))"    #0   #SSP3（SD/SPI3）ソース(0: ref_io1 / 1: ref_xtal）
	echo "BYPASS_SSP2 (Bit2)                  :$(( (VAL5 >> 2) & 0x01 ))"    #1   #SSP2（SD/SPI2）ソース(0: ref_io1 / 1: ref_xtal）
	echo "BYPASS_SSP1 (Bit1)                  :$(( (VAL5 >> 1) & 0x01 ))"    #0   #SSP1（SD/SPI1）ソース(0: ref_io0 / 1: ref_xtal）
	echo "BYPASS_SSP0 (Bit0)                  :$(( VAL5 & 0x01 ))"           #0   #SSP0（SD/SPI0）ソース(0: ref_io0 / 1: ref_xtal）
	echo "=========================================================="
fi


