Annotation of nono/vm/goldfish_timer.cpp, revision 1.1.1.2

1.1       root        1: //
                      2: // nono
                      3: // Copyright (C) 2024 nono project
                      4: // Licensed under nono-license.txt
                      5: //
                      6: 
                      7: //
                      8: // Goldfish (Qemu) RTC+Timer (の Timer のほう)
                      9: //
                     10: 
                     11: // Google Goldfish RTC/Timer 仕様と QEMU 実装の仕様には互換性がない。
                     12: // オリジナルもまあまあ首をかしげる仕様だったので、それを QEMU が跡形なく
                     13: // 変更して使っているのかも知れない。知らんけど。
                     14: // ここで実装しているのは QEMU 仕様のほう。
                     15: //
                     16: // デバイスには 2 種類あり、Timer と RTC という名前で区別する。
                     17: // で、これはどこの仕様なのか QEMU の実装なのか分からないが、何故か
                     18: // RTC デバイスのベースアドレスは Timer デバイスのベースアドレス + 0x1000 の
                     19: // 位置らしい。
                     20: // どうして別デバイスにして BootInfo で別々に渡すよう設計しなかったのか…。
                     21: //
                     22: // 元仕様書にエンディアンのエの字もないので、たぶん何の考察もしてないのだと
                     23: // 思うが、ここではゲストエンディアン (ビッグエンディアン) デバイスに見せる。
                     24: // NetBSD/virt68k もそのように動いているようなので。
                     25: 
                     26: // Timer デバイスのレジスタは次の通り。
                     27: //
                     28: //  +$00.L TIME_LOW            R-: ホスト時刻 [nsec] の下位 32 ビット
                     29: //  +$04.L TIME_HIGH   R-: ホスト時刻 [nsec] の上位 32 ビット
                     30: //  +$08.L ALARM_LOW   -W: アラーム時刻 [nsec] の下位 32 ビットとアラーム開始
                     31: //  +$0c.L ALARM_HIGH  -W: アラーム時刻 [nsec] の上位 32 ビット
                     32: //  +$10.L INTR_STATUS RW: 割り込み許可禁止の取得(R)/設定(W)
                     33: //  +$14.L ALARM_CLEAR -W: 動作中のアラームクリア
                     34: //  +$18.L ALARM_STATUS        R-: アラーム動作中なら $1、そうでなければ $0
                     35: //  +$1c.L INTR_CLEAR  -W: 割り込みクリア
                     36: //
                     37: // TIME_LOW、TIME_HIGH はホスト時刻を [nsec] で返す。
                     38: // TIME_LOW 読み込み時に 64 ビットをラッチするので必ず TIME_LOW、HIGH の順で
                     39: // 読み出すこと。ここでいうホスト時刻は、ホストのある時点 (大抵は VM の開始
                     40: // 時点) からの相対時刻。
                     41: //
                     42: // ALARM_LOW、ALARM_HIGH はアラーム時刻 [nsec] の設定。
                     43: // 現時刻からの間隔ではなくこのホスト時間軸上の時刻。
                     44: // 過去の時刻だったらどうなるとかの定義は一切ない…。
                     45: // ALARM_LOW がアラーム開始を兼ねているので必ず HIGH、LOW の順で書き込むこと。
                     46: //
                     47: // INTR_STATUS は書き込み時は最下位ビットが %1 なら割り込み許可、%0 なら禁止。
                     48: // 読み込み時は割り込み許可なら $1、禁止なら $0。
                     49: 
                     50: #include "goldfish_timer.h"
                     51: #include "goldfish_pic.h"
                     52: #include "goldfish_rtc.h"
1.1.1.2 ! root       53: #include "mpu.h"
1.1       root       54: #include "scheduler.h"
                     55: #include "syncer.h"
                     56: 
                     57: //
                     58: // GFTimer
                     59: //
                     60: 
                     61: // コンストラクタ
                     62: GFTimerDevice::GFTimerDevice()
                     63:        : inherited(OBJ_GFTIMER)
                     64: {
                     65:        // モニタは GFRTC + GFTimer で共有。
                     66:        monitor.func = ToMonitorCallback(&GFTimerDevice::MonitorUpdate);
                     67:        monitor.SetSize(38, 7);
                     68:        monitor.Regist(ID_MONITOR_RTC);
                     69: }
                     70: 
                     71: // デストラクタ
                     72: GFTimerDevice::~GFTimerDevice()
                     73: {
                     74: }
                     75: 
                     76: // 初期化
                     77: bool
                     78: GFTimerDevice::Init()
                     79: {
                     80:        if (inherited::Init() == false) {
                     81:                return false;
                     82:        }
                     83: 
                     84:        // 割り込み信号線の接続先
                     85:        auto gfpic = GetGFPICDevice(6);
                     86:        gfpic->RegistIRQ(1, "GFTimer", this);
                     87:        interrupt = gfpic;
                     88: 
                     89:        gfrtc = dynamic_cast<GFRTCDevice *>(GetRTCDevice());
                     90:        syncer = GetSyncer();
                     91: 
                     92:        // クロックの同期方法
                     93:        sync_rt = GetRTCDevice()->GetSyncRealtime();
1.1.1.2 ! root       94: 
1.1       root       95:        // それによってイベントを分けてある。(time はどちらも都度セットする)
                     96:        if (sync_rt) {
                     97:                event.func = ToEventCallback(&GFTimerDevice::CallbackRT);
                     98:        } else {
                     99:                event.func = ToEventCallback(&GFTimerDevice::CallbackVT);
                    100:        }
1.1.1.2 ! root      101:        event.SetName("Goldfish Timer");
        !           102:        scheduler->RegistEvent(event);
1.1       root      103: 
                    104:        return true;
                    105: }
                    106: 
                    107: // 電源オン/リセット
                    108: void
                    109: GFTimerDevice::ResetHard(bool poweron)
                    110: {
                    111:        scheduler->StopEvent(event);
                    112:        elapsed = 0;
                    113:        alarm = 0;
                    114:        mtime = 0;
                    115:        mtime_epoch = 0;
                    116: 
                    117:        intr_enable = false;
                    118:        intr_assert = false;
                    119:        ChangeInterrupt();
                    120: }
                    121: 
                    122: busdata
1.1.1.2 ! root      123: GFTimerDevice::ReadPort(uint32 offset)
1.1       root      124: {
                    125:        busdata data;
                    126: 
                    127:        switch (offset) {
                    128:         case GFRTC::TIME_LOW:
                    129:                elapsed = Now();
                    130:                data = (uint32)elapsed;
                    131:                if (__predict_false(loglevel >= 2)) {
                    132:                        if (loglevel >= 3) {
                    133:                                putlogn("TIME_LOW  -> $%08x", data.Data());
                    134:                        } else {
                    135:                                putlogn("TIME -> $%08x'%08x",
                    136:                                        (uint32)(elapsed >> 32), data.Data());
                    137:                        }
                    138:                }
                    139:                break;
                    140: 
                    141:         case GFRTC::TIME_HIGH:
                    142:                data = (uint32)(elapsed >> 32);
                    143:                putlog(3, "TIME_HIGH -> $%08x", data.Data());
                    144:                break;
                    145: 
                    146:         case GFRTC::INTR_STATUS:
                    147:                data = intr_enable ? 1 : 0;
                    148:                putlog(2, "INTR_STATUS -> $%08x", data.Data());
                    149:                break;
                    150: 
                    151:         case GFRTC::ALARM_STATUS:
                    152:                data = event.IsRunning() ? 1 : 0;
                    153:                putlog(2, "ALARM_STATUS -> $%08x", data.Data());
                    154:                break;
                    155: 
                    156:         default:
1.1.1.2 ! root      157:                putlog(1, "Read unknown $%08x", mpu->GetPaddr());
1.1       root      158:                data.SetBusErr();
                    159:                break;
                    160:        }
1.1.1.2 ! root      161: 
        !           162:        data |= BusData::Size4;
1.1       root      163:        return data;
                    164: }
                    165: 
                    166: busdata
1.1.1.2 ! root      167: GFTimerDevice::WritePort(uint32 offset, uint32 data)
1.1       root      168: {
                    169:        busdata r;
                    170: 
                    171:        switch (offset) {
                    172:         case GFRTC::ALARM_LOW:
                    173:                alarm = alarm_high | data;
                    174:                alarm_high = 0;
                    175:                if (__predict_false(loglevel >= 2)) {
                    176:                        if (loglevel >= 3) {
                    177:                                putlogn("ALARM_LOW  <- $%08x", data);
                    178:                        } else {
                    179:                                putlogn("ALARM <- $%08x'%08x",
                    180:                                        (uint32)(alarm >> 32), (uint32)alarm);
                    181:                        }
                    182:                }
                    183:                StartAlarm();
                    184:                break;
                    185: 
                    186:         case GFRTC::ALARM_HIGH:
                    187:                putlog(3, "ALARM_HIGH <- $%08x", data);
                    188:                alarm_high = (uint64)data << 32;
                    189:                break;
                    190: 
                    191:         case GFRTC::INTR_STATUS:
                    192:                intr_enable = data & 1;
                    193:                if (__predict_false(loglevel >= 1)) {
                    194:                        if (intr_enable) {
                    195:                                putlogn("Enable interrupt");
                    196:                        } else {
                    197:                                putlogn("Disable interrupt");
                    198:                        }
                    199:                }
                    200:                ChangeInterrupt();
                    201:                break;
                    202: 
                    203:         case GFRTC::ALARM_CLEAR:
                    204:                putlog(1, "Clear alarm");
                    205:                alarm = 0;
                    206:                break;
                    207: 
                    208:         case GFRTC::INTR_CLEAR:
                    209:                putlog(2, "Clear interrupt");
                    210:                intr_assert = false;
                    211:                ChangeInterrupt();
                    212:                break;
                    213: 
                    214:         default:
1.1.1.2 ! root      215:                putlog(1, "Write unknown $%08x <- $%08x", mpu->GetPaddr(), data);
        !           216:                r = BusData::BusErr;
1.1       root      217:                break;
                    218:        }
                    219: 
1.1.1.2 ! root      220:        r |= BusData::Size4;
1.1       root      221:        return r;
                    222: }
                    223: 
                    224: busdata
1.1.1.2 ! root      225: GFTimerDevice::PeekPort(uint32 offset)
1.1       root      226: {
                    227:        switch (offset) {
1.1.1.2 ! root      228:         case GFRTC::TIME_LOW:
        !           229:                return Now() & 0xffffffffU;
        !           230:         case GFRTC::TIME_HIGH:
        !           231:                return Now() >> 32;
        !           232:         case GFRTC::INTR_STATUS:
1.1       root      233:                return intr_assert ? 1 : 0;
1.1.1.2 ! root      234:         case GFRTC::ALARM_STATUS:
1.1       root      235:                return event.IsRunning() ? 1 : 0;
                    236:         default:
1.1.1.2 ! root      237:                return BusData::BusErr;
1.1       root      238:        }
                    239: }
                    240: 
                    241: void
                    242: GFTimerDevice::MonitorUpdate(Monitor *, TextScreen& screen)
                    243: {
                    244:        int y = 0;
                    245: 
                    246:        screen.Clear();
                    247: 
                    248:        uint64 now = Now();
                    249: 
                    250:        screen.Puts(0, y++, "<Timer>");
                    251:        screen.Print(0, y++, "Time:  %26s", TimeToStr(now).c_str());
                    252:        screen.Print(0, y++, "Alarm: %26s", TimeToStr(alarm).c_str());
                    253:        y++;
                    254: 
                    255:        gfrtc->MonitorUpdateRTC(screen, y);
                    256: }
                    257: 
                    258: // 現在時刻を返す
                    259: uint64
                    260: GFTimerDevice::Now() const
                    261: {
                    262:        uint64 now;
                    263: 
                    264:        if (sync_rt) {
                    265:                now = syncer->GetRealTime();
                    266:        } else {
                    267:                now = scheduler->GetVirtTime();
                    268:        }
                    269:        return now;
                    270: }
                    271: 
                    272: // アラーム開始。(ALARM_LOW の書き込みで呼ばれる)
                    273: void
                    274: GFTimerDevice::StartAlarm()
                    275: {
                    276:        if (__predict_false(mtime_epoch == 0)) {
                    277:                // 最初のアラーム書き込み時を修正実時間軸の基準点にする。
                    278:                mtime_epoch = syncer->GetRealTime();
                    279:                mtime = mtime_epoch;
                    280:        }
                    281: 
                    282:        // 仮想時間モードなら ALARM 時刻に発火するイベントをセットするだけ。
                    283:        // 実時間モードならひとまず仮に本来の仮想時刻にイベントは起こすが、
                    284:        // 割り込みを上げるかどうかは向こうで調整する。
                    285:        // event.code は VT モードの時には不要だが気にせず立てる。
1.1.1.2 ! root      286:        // 指定されたアラームがすでに過去の時刻なら QEMU は即発火するようだ。
        !           287:        uint64 now = Now();
        !           288:        if (__predict_true(alarm > now)) {
        !           289:                event.time = alarm - now;
        !           290:        } else {
        !           291:                if (__predict_false(loglevel >= 1)) {
        !           292:                        uint64 delta = now - alarm;
        !           293:                        putlogn("ALARM: past alarm -%s", TimeToStr(delta).c_str());
        !           294:                }
        !           295:                event.time = 0;
        !           296:        }
1.1       root      297:        event.code = 1;
                    298:        scheduler->RestartEvent(event);
                    299: }
                    300: 
                    301: // 実時間モードでのコールバック。
                    302: void
                    303: GFTimerDevice::CallbackRT(Event& ev)
                    304: {
                    305:        // アラーム開始後最初の1回だけ自分の時間軸をアラーム分だけ進める。
                    306:        if (event.code) {
                    307:                mtime += ev.time;
                    308:                event.code = 0;
                    309:        }
                    310: 
                    311:        uint64 mnow = syncer->GetRealTime() - mtime_epoch;
                    312:        if (mtime >= mnow) {
                    313:                // システムの実時間軸を追い越していたら一回休んで
                    314:                // もう一度このイベントに来る。
                    315:                scheduler->RestartEvent(event);
                    316:        } else {
1.1.1.2 ! root      317:                // システムの実時間軸に追い付いてなければ(通常動作)、アラーム発報。
1.1       root      318:                intr_assert = true;
                    319:                ChangeInterrupt();
                    320:        }
                    321: }
                    322: 
                    323: // 仮想時間モードでのコールバック。
                    324: void
                    325: GFTimerDevice::CallbackVT(Event& ev)
                    326: {
                    327:        // 仮想時間モードなら、イベントが起きたここがゴール。
                    328:        // アラームは単発イベントなのでリスタート不要。
                    329:        intr_assert = true;
                    330:        ChangeInterrupt();
                    331: }
                    332: 
                    333: void
                    334: GFTimerDevice::ChangeInterrupt()
                    335: {
                    336:        bool irq = (intr_enable && intr_assert);
                    337:        interrupt->ChangeINT(this, irq);
                    338: }

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.