Annotation of nono/vm/mk48t02.cpp, revision 1.1.1.13

1.1       root        1: //
                      2: // nono
1.1.1.4   root        3: // Copyright (C) 2020 nono project
                      4: // Licensed under nono-license.txt
1.1       root        5: //
                      6: 
                      7: //
1.1.1.12  root        8: // NVRAM/RTC (MK48T02)
1.1       root        9: //
1.1.1.12  root       10: 
1.1       root       11: // SRAM 部分はビッグエンディアンのままメモリに置かれるので、
                     12: // 必要ならアクセス時に都度変換すること。
                     13: //
                     14: // 仕様は 0x45000000 から 2KB だが、
1.1.1.13! root       15: // LUNA-I   では 0x44000000 から 0x47ffffff まで 2KB 単位でミラーが見える。
        !            16: // LUNA-88K では 0x44000000 から 0x45ffffff までが
        !            17: // (こちらはロングワード配置なので) 8KB 単位のミラーに見える。
1.1       root       18: 
1.1.1.12  root       19: #include "mk48t02.h"
                     20: #include "bitops.h"
                     21: #include "config.h"
                     22: #include "mainapp.h"
                     23: #include "mpu.h"
                     24: #include <fcntl.h>
                     25: #include <unistd.h>
                     26: #include <sys/stat.h>
                     27: #include <array>
                     28: 
                     29: // コンストラクタ
1.1       root       30: MK48T02Device::MK48T02Device()
1.1.1.13! root       31:        : inherited()
1.1       root       32: {
1.1.1.13! root       33:        SetName("MK48T02");
1.1.1.9   root       34: 
1.1.1.13! root       35:        AddAlias("MK48T02");
        !            36:        AddAlias("NVRAM");
1.1.1.9   root       37: 
1.1.1.12  root       38:        // 今の所 UTC として使うケースだけのようだ。
1.1.1.10  root       39:        use_localtime = false;
                     40: 
1.1.1.12  root       41:        monitor.func = ToMonitorCallback(&MK48T02Device::MonitorUpdate);
1.1.1.10  root       42:        monitor.SetSize(40, 13);
1.1.1.9   root       43:        monitor.Regist(ID_MONITOR_MK48T02);
1.1       root       44: }
                     45: 
1.1.1.12  root       46: // デストラクタ
1.1       root       47: MK48T02Device::~MK48T02Device()
                     48: {
                     49: }
                     50: 
1.1.1.13! root       51: // 初期化
1.1       root       52: bool
                     53: MK48T02Device::Init()
                     54: {
1.1.1.13! root       55:        if (inherited::Init() == false) {
        !            56:                return false;
        !            57:        }
        !            58: 
1.1.1.12  root       59:        struct stat st;
                     60: 
                     61:        // NetBSD/luna68k, OpenBSD/luna88k ともに epoch を 1970年としている
                     62:        // (2021/07 現在) 一方、4.4BSD (luna68k 版?) は 1900年としている。
                     63:        // MK48T02 本来定義は 0 というか 1900 というか。DecodeYear() も参照。
                     64:        const ConfigItem& item = gConfig->Find("rtc-epoch-year");
                     65:        int year_epoch_val;
                     66:        if (item.TryInt(&year_epoch_val) == false) {
                     67:                item.Err();
1.1.1.10  root       68:                return false;
                     69:        }
1.1.1.12  root       70:        // 雑にチェック
                     71:        if (year_epoch_val < 1900) {
1.1.1.13! root       72:                item.Err("Must be >= 1900");
1.1.1.12  root       73:                return false;
                     74:        }
                     75:        year_epoch = (uint)year_epoch_val;
1.1.1.10  root       76: 
                     77:        // MK48T02 のデータシートには年には西暦年の下位2桁を設定するように
1.1.1.12  root       78:        // 指示されており、4.4BSD (luna68k) はこの通りになっている。
1.1.1.10  root       79:        // しかし CMU Mach luna88k, NetBSD/luna68k, OpenBSD/luna88k はいずれも
                     80:        // 西暦年から 1970 引いた値を設定するようになっている (2021/07 現在)。
                     81:        // このため、うるう年が2年ずれた状態になる。
                     82:        //
                     83:        // NetBSD で MK48T02 を採用している luna68k 以外の port は
                     84:        // ソースコード上の変数 year0 もしくは YEAR0 に
                     85:        //  newsmips, news68k: 1900 (データシート規定通り)
                     86:        //  sun3, sparc, mvme68k: 1968 (1968 はうるう年なので問題ない)
                     87:        // を採用しており、バグっていない。
                     88:        // この year0 は UNIX EPOCH とは直接関係がない RTC ハードウェアに
                     89:        // 依存する値なのだが、LUNA では混同したのだろうか?
                     90:        //
                     91:        // たぶんこのバグはもう修正されることはないだろうから、こちらで補正する
                     92:        // スイッチを用意した。
1.1.1.13! root       93:        if (gMainApp.Has(VMCap::LUNA)) {
        !            94:                if (gConfig->Find("luna-adjust-misused-epoch").AsInt()) {
        !            95:                        // エポック年のうるう年カウンタ相当を補正項として持つ
        !            96:                        adjust_leap = year_epoch % 4;
        !            97:                } else {
        !            98:                        adjust_leap = 0;
        !            99:                }
        !           100:        }
1.1.1.10  root      101: 
1.1.1.13! root      102:        // MSX-DOS モードなら NVRAM 不要なのでここでダミーのメモリだけ用意。
        !           103:        if (gMainApp.msxdos_mode) {
        !           104:                // XXX アプリケーション寿命まで解放してないけど、まあいいか
        !           105:                mem = (uint8 *)malloc(16 * 1024);
        !           106:                return true;
1.1.1.10  root      107:        }
                    108: 
1.1.1.12  root      109:        // ファイルサイズを更新。
                    110:        // ver 0.2.3 までの NVRAM.DAT は 2040 バイトだったが、ver 0.2.4 以降は
                    111:        // 2048 バイトになるため、ここでファイルがあって 2040 バイトなら 2048
                    112:        // バイトに拡張する。失敗したらここでは何もしない。
1.1.1.3   root      113:        filename = gMainApp.GetVMDir() + "NVRAM.DAT";
1.1.1.12  root      114:        std::string dispname = string_format("NVRAM \"%s\"", filename.c_str());
                    115:        if (stat(filename.c_str(), &st) == 0 && st.st_size == 2040) {
                    116:                int fd;
                    117:                fd = open(filename.c_str(), O_WRONLY | O_APPEND);
                    118:                if (fd >= 0) {
                    119:                        std::array<uint8, 8> zerobuf {};
                    120:                        write(fd, &zerobuf[0], zerobuf.size());
                    121:                        close(fd);
                    122:                        stat(filename.c_str(), &st);
                    123:                        warnx("%s extended to %jd bytes",
                    124:                                dispname.c_str(), (intmax_t)st.st_size);
                    125:                }
                    126:        }
                    127: 
                    128:        // ファイルのロード
1.1.1.4   root      129:        file.SetFilename(filename);
1.1.1.12  root      130:        file.SetDispname(dispname);
                    131:        mem = file.OpenCreate(2048);
1.1.1.4   root      132:        if (mem == NULL) {
1.1       root      133:                return false;
                    134:        }
                    135: 
1.1.1.13! root      136:        return true;
1.1.1.12  root      137: }
                    138: 
                    139: void
                    140: MK48T02Device::StartTime()
                    141: {
                    142:        inherited::StartTime();
                    143: 
                    144:        // 内部カレンダをメモリに反映
                    145:        Store(reg.in);
1.1       root      146: }
                    147: 
                    148: // バイナリ表現を BCD 表現に変換する
                    149: /*static*/ inline uint8
                    150: MK48T02Device::num2BCD(uint8 num)
                    151: {
                    152:        return ((num / 10) << 4) + (num % 10);
                    153: }
                    154: 
                    155: // BCD 表現をバイナリ表現に変換する
                    156: /*static*/ inline uint8
                    157: MK48T02Device::BCD2num(uint8 bcd)
                    158: {
                    159:        return (bcd >> 4) * 10 + (bcd & 0x0f);
                    160: }
                    161: 
                    162: uint64
1.1.1.7   root      163: MK48T02Device::Read(uint32 offset)
1.1       root      164: {
                    165:        uint32 data;
                    166: 
1.1.1.12  root      167:        data = mem[offset];
1.1.1.13! root      168:        putlog(3, "$%08x -> $%02x", mpu->GetPaddr(), data);
1.1       root      169: 
                    170:        return data;
                    171: }
                    172: 
                    173: uint64
1.1.1.7   root      174: MK48T02Device::Write(uint32 offset, uint32 data)
1.1       root      175: {
1.1.1.13! root      176:        putlog(3, "$%08x <- $%02x", mpu->GetPaddr(), data);
1.1.1.10  root      177: 
1.1.1.12  root      178:        switch (offset - 2040) {
                    179:         case 0:        // コントロール
                    180:                WriteCtrl(data);
                    181:                break;
                    182:         case 1:        // 秒 (b7 は STOP BIT)
                    183:                reg.stop = data & MK48T02Clock::STOP;
                    184:                break;
                    185:         case 2:        // 分
                    186:                break;
                    187:         case 3:        // 時 (b7 は KICK START)
                    188:                reg.kickstart = data & MK48T02Clock::KICKSTART;
                    189:                break;
                    190:         case 4:        // 曜日 (b6 は Frequency Test (未実装))
                    191:                // データシートでは b7, b5, b4 は '0' とあるが実際には '1' が
                    192:                // 書き込める。書き込んだ '1' が内部クロックの更新でどうなるか
                    193:                // 未確認のため、とりあえず放置。
                    194:                reg.freqtest = data & MK48T02Clock::FREQTEST;
                    195:                break;
                    196:         case 5:        // 日
                    197:                // データシートでは b7, b6 は '0' とあるが実際には b7 には '1' が
                    198:                // 書き込める (b6 には書き込めない)。b7 に書き込んだ '1' が内部
                    199:                // クロックの更新でどうなるか未確認のため、とりあえずは放置。
                    200:                break;
                    201:         case 6:        // 月
                    202:                break;
                    203:         case 7:        // 年
                    204:                break;
                    205:         default:
                    206:                break;
1.1       root      207:        }
1.1.1.12  root      208: 
                    209:        mem[offset] = data;
                    210: 
1.1       root      211:        return 0;
                    212: }
                    213: 
                    214: uint64
1.1.1.7   root      215: MK48T02Device::Peek(uint32 offset)
1.1       root      216: {
1.1.1.12  root      217:        return mem[offset];
1.1       root      218: }
                    219: 
1.1.1.13! root      220: uint64
        !           221: MK48T02Device::Poke(uint32 offset, uint32 data)
        !           222: {
        !           223:        // 時計部分にはコントロールレジスタもあるので書き込み不可。
        !           224:        if (offset >= 2040) {
        !           225:                return (uint64)-1;
        !           226:        } else {
        !           227:                if ((int32)data >= 0) {
        !           228:                        mem[offset] = data;
        !           229:                }
        !           230:                return 0;
        !           231:        }
        !           232: }
        !           233: 
1.1.1.5   root      234: void
1.1.1.9   root      235: MK48T02Device::MonitorUpdate(Monitor *, TextScreen& screen)
1.1       root      236: {
1.1.1.10  root      237:        uint32 addr;
                    238:        uint32 v;
                    239:        int y = 0;
                    240: 
1.1.1.9   root      241:        screen.Clear();
1.1       root      242: 
1.1.1.10  root      243:        // BCD なので %x で表示する
                    244:        screen.Print(0, y++,
                    245:                "Internal: %04d[%02x]/%02x/%02x(%s) %02x:%02x:%02x.%1x",
                    246:                DecodeYear(reg.in.year), reg.in.year,
                    247:                reg.in.mon, reg.in.mday, wdays[reg.in.wday],
                    248:                reg.in.hour, reg.in.min, reg.in.sec, (uint32)((cnt >> 1) & 0xf));
1.1.1.12  root      249: 
                    250:        auto ex = Load();
1.1.1.10  root      251:        screen.Print(0, y++,
                    252:                "Register: %04d[%02x]/%02x/%02x(%s) %02x:%02x:%02x",
1.1.1.12  root      253:                DecodeYear(ex.year), ex.year,
                    254:                ex.mon, ex.mday, wdays[ex.wday],
                    255:                ex.hour, ex.min, ex.sec);
                    256: 
1.1.1.10  root      257:        screen.Print(0, y++, "TimeZone: %s",
                    258:                use_localtime ? "Local" : "UTC");
                    259:        screen.Print(0, y++, "Epoch   : %4d  (Adjust Leap: %d)",
                    260:                year_epoch, adjust_leap);
                    261:        y++;
                    262: 
                    263:        addr = 0x800;
                    264:        v = Peek(--addr);
                    265:        screen.Print(0, y++, "$%3x: $%02x (year=%02x)", addr, v, v);
                    266:        v = Peek(--addr);
                    267:        screen.Print(0, y++, "$%3x: $%02x (mon =%02x)", addr, v, v);
                    268:        v = Peek(--addr);
                    269:        screen.Print(0, y++, "$%3x: $%02x (date=%02x)", addr, v, v);
                    270:        v = Peek(--addr);
                    271:        screen.Print(0, y++, "$%3x: $%02x (wday=%02x  FT=%d)",
                    272:                addr, v, (v & 0x07), (v & MK48T02Clock::FREQTEST) ? 1 : 0);
                    273:        v = Peek(--addr);
                    274:        screen.Print(0, y++, "$%3x: $%02x (hour=%02x  KS=%d)",
                    275:                addr, v, (v & 0x3f), (v & MK48T02Clock::KICKSTART) ? 1 : 0);
                    276:        v = Peek(--addr);
                    277:        screen.Print(0, y++, "$%3x: $%02x (min =%02x)", addr, v, (v & 0x7f));
                    278:        v = Peek(--addr);
                    279:        screen.Print(0, y++, "$%3x: $%02x (sec =%02x  ST=%d)",
                    280:                addr, v, (v & 0x7f), (v & MK48T02Clock::STOP) ? 1 : 0);
                    281:        v = Peek(--addr);
                    282:        screen.Print(0, y++, "$%3x: $%02x (W=%d R=%d)",
                    283:                addr, v,
                    284:                (v & MK48T02Clock::WRITE) ? 1 : 0,
                    285:                (v & MK48T02Clock::READ)  ? 1 : 0);
1.1       root      286: }
                    287: 
                    288: // コントロールレジスタへの書き込み
                    289: void
                    290: MK48T02Device::WriteCtrl(uint32 data)
                    291: {
1.1.1.12  root      292:        uint8 old = mem[0x7f8];
1.1.1.10  root      293: 
1.1.1.12  root      294:        bool write_fall = bit_falling(old, data, MK48T02Clock::WRITE);
1.1       root      295: 
1.1.1.10  root      296:        // ホールドしているかどうかは状態なのでエッジではない
1.1.1.12  root      297:        hold = (data & (MK48T02Clock::READ | MK48T02Clock::WRITE));
1.1.1.10  root      298: 
                    299:        if (write_fall) {
1.1.1.12  root      300:                // WRITE ビットの立ち下がりエッジでメモリから内部カウンタへロード
                    301:                reg.in = Load();
                    302: 
1.1.1.10  root      303:                // 分周段は規定されていないが意味的にクリアするほうが良いだろう
                    304:                cnt = 0;
1.1       root      305:        }
                    306: }
                    307: 
1.1.1.12  root      308: // NVRAM からカレンダをロード
                    309: MK48T02Clock::calendar
                    310: MK48T02Device::Load() const
                    311: {
                    312:        MK48T02Clock::calendar cal;
                    313: 
                    314:        cal.sec = mem[0x7f9] & 0x7f;
                    315:        cal.min = mem[0x7fa] & 0x7f;
                    316:        cal.hour = mem[0x7fb] & 0x3f;
                    317:        cal.wday = mem[0x7fc] & 0x07;
                    318:        cal.mday = mem[0x7fd] & 0x3f;
                    319:        cal.mon = mem[0x7fe] & 0x1f;
                    320:        cal.year = mem[0x7ff];
                    321: 
                    322:        return cal;
                    323: }
                    324: 
                    325: // カレンダを NVRAM にストア
                    326: void
                    327: MK48T02Device::Store(const MK48T02Clock::calendar& cal)
                    328: {
                    329:        mem[0x7f9] = (mem[0x7f9] & ~0x7f) | cal.sec;
                    330:        mem[0x7fa] = (mem[0x7fa] & ~0x7f) | cal.min;
                    331:        mem[0x7fb] = (mem[0x7fb] & ~0x3f) | cal.hour;
                    332:        mem[0x7fc] = (mem[0x7fc] & ~0x07) | cal.wday;
                    333:        mem[0x7fd] = (mem[0x7fd] & ~0x3f) | cal.mday;
                    334:        mem[0x7fe] = (mem[0x7fe] & ~0x1f) | cal.mon;
                    335:        mem[0x7ff] = cal.year;
                    336: }
                    337: 
1.1.1.10  root      338: uint
                    339: MK48T02Device::GetSec() const
                    340: {
                    341:        return BCD2num(reg.in.sec);
                    342: }
                    343: 
                    344: void
                    345: MK48T02Device::SetSec(uint v)
                    346: {
                    347:        reg.in.sec = num2BCD(v);
                    348: }
                    349: 
                    350: uint
                    351: MK48T02Device::GetMin() const
                    352: {
                    353:        return BCD2num(reg.in.min);
                    354: }
                    355: 
                    356: void
                    357: MK48T02Device::SetMin(uint v)
                    358: {
                    359:        reg.in.min = num2BCD(v);
                    360: }
                    361: 
                    362: uint
                    363: MK48T02Device::GetHour() const
                    364: {
                    365:        return BCD2num(reg.in.hour);
                    366: }
                    367: 
                    368: void
                    369: MK48T02Device::SetHour(uint v)
                    370: {
                    371:        reg.in.hour = num2BCD(v);
                    372: }
                    373: 
                    374: uint
                    375: MK48T02Device::GetWday() const
                    376: {
                    377:        // データシートの正規の値範囲は 1..7 だが 0 も問題なく保持できて、
                    378:        // NetBSD/luna68k, OpenBSD/luna88k は日付を日曜に変更する際には 0 を
                    379:        // レジスタに書き込んでいる。そのためレジスタ値は 0 と 7 を日曜、
                    380:        // 1を月曜…という運用ということにする。
                    381:        // 戻り値は 0..6 (0が日曜)。
                    382: 
                    383:        int v = reg.in.wday;
                    384:        if (v == 7) {
                    385:                v = 0;
                    386:        }
                    387:        return v;
                    388: }
                    389: 
                    390: void
                    391: MK48T02Device::SetWday(uint v)
                    392: {
                    393:        // 引数は 0..6 (0が日曜)、MK48T02 の正規の範囲は 1..7 で曜日との対応は
                    394:        // 運用依存のようだ。NetBSD/luna68k, OpenBSD/luna88k は 0 を日曜、1 を
                    395:        // 月曜…と扱っているが、MK48T02 の曜日レジスタは 7 の翌日 1 に繰り上がる
                    396:        // 動作なので、ここでもレジスタには 1..7 (1が月曜、7が日曜) をセットする。
                    397:        if (v == 0)
                    398:                v = 7;
                    399:        reg.in.wday = v;
                    400: }
                    401: 
                    402: uint
                    403: MK48T02Device::GetMday() const
                    404: {
                    405:        return BCD2num(reg.in.mday);
                    406: }
                    407: 
                    408: void
                    409: MK48T02Device::SetMday(uint v)
                    410: {
                    411:        reg.in.mday = num2BCD(v);
                    412: }
                    413: 
                    414: uint
                    415: MK48T02Device::GetMon() const
                    416: {
                    417:        return BCD2num(reg.in.mon);
                    418: }
                    419: 
                    420: void
                    421: MK48T02Device::SetMon(uint v)
                    422: {
                    423:        reg.in.mon = num2BCD(v);
                    424: }
                    425: 
                    426: uint
                    427: MK48T02Device::DecodeYear(uint bcd_year) const
                    428: {
                    429:        uint y = BCD2num(bcd_year);
                    430:        y += year_epoch;
                    431: 
                    432:        // 1970年より前を 2000 年代とみなすのはシステム依存だが
                    433:        // UNIX 系はみんなこう(?)
                    434:        // XXX ここの 1970 と RTC エポックを一致させれば端折れるじゃん!と
                    435:        //     思いついたのかしら?
                    436:        if (y < 1970) {
                    437:                y += 100;
                    438:        }
                    439:        return y;
                    440: }
                    441: 
                    442: uint
                    443: MK48T02Device::GetYear() const
                    444: {
                    445:        // see DecodeYear()
                    446:        return DecodeYear(reg.in.year);
                    447: }
                    448: 
                    449: void
                    450: MK48T02Device::SetYear(uint v)
                    451: {
                    452:        // see DecodeYear()
                    453:        v -= year_epoch;
                    454:        reg.in.year = num2BCD(v % 100);
                    455: }
                    456: 
                    457: uint
                    458: MK48T02Device::GetLeap() const
                    459: {
                    460:        // 補正項込みで計算
                    461:        return (BCD2num(reg.in.year) + adjust_leap) & 3;
                    462: }
                    463: 
                    464: void
                    465: MK48T02Device::SetLeap(uint v)
                    466: {
                    467:        // nop
                    468:        // MK48T02 ではうるう年カウンタはなく、西暦年でうるう年を判断している。
                    469: }
                    470: 
                    471: // 1Hz 仮想 RTC からのコール
1.1.1.12  root      472: // (分周段 0/32 秒でコールされる)
1.1.1.10  root      473: void
                    474: MK48T02Device::Tick1Hz()
                    475: {
                    476:        if (reg.stop) {
                    477:                // 実機は電力消費を抑えるため発振器ごと止めるが、
                    478:                // 分周段が規定されていないので秒カウントを止めれば十分なはず
                    479:                //nop
                    480:        } else {
                    481:                CountUpSec();
                    482:        }
                    483: 
                    484:        if (hold == false) {
1.1.1.12  root      485:                // 秒の更新でメモリにコピーする (Datasheet p2)
                    486:                Store(reg.in);
1.1.1.10  root      487:        }
1.1       root      488: }
1.1.1.3   root      489: 
                    490: // 指定したアドレスからのゼロ終端文字列を返す
                    491: // (内蔵 ROM からのアクセス用)
                    492: std::string
                    493: MK48T02Device::PeekString(uint32 addr) const
                    494: {
                    495:        std::string rv = "";
                    496: 
1.1.1.7   root      497:        addr &= 0x7ff;
                    498:        for (; mem[addr]; addr++) {
                    499:                rv += mem[addr];
1.1.1.3   root      500:        }
                    501:        return rv;
                    502: }
                    503: 
                    504: // 指定したアドレスに文字列を書き込み、
                    505: // 16 バイトに満たないところはゼロでパディングする。
                    506: // 書き込めれば true を、書き込めなければ false を返す。
                    507: // (内蔵 ROM からの書き込み用)
                    508: bool
                    509: MK48T02Device::WriteString(uint32 addr, const std::string& data)
                    510: {
                    511:        int i = 0;
                    512: 
1.1.1.9   root      513:        // ここの文字列は16バイト未満なら一見ゼロ終端のようだが、
                    514:        // 16バイトならゼロ終端せず16文字とするフォーマット。
                    515: 
                    516:        if (data.length() > 16) {
1.1.1.3   root      517:                return false;
                    518:        }
                    519: 
                    520:        addr &= 0x7ff;
                    521:        for (; i < data.length(); i++) {
1.1.1.9   root      522:                mem[addr + i] = data[i];
1.1.1.3   root      523:        }
                    524:        for (; i < 16; i++) {
1.1.1.9   root      525:                mem[addr + i] = 0;
1.1.1.3   root      526:        }
                    527:        return true;
                    528: }
1.1.1.9   root      529: 
                    530: // 全域をゼロクリアする。
                    531: // クリアするだけなので、その後何か書いたりチェックサムを計算したりする
                    532: // 必要はある。
                    533: // (内蔵 ROM からの書き込み用)
                    534: void
                    535: MK48T02Device::ClearAll()
                    536: {
                    537:        for (int i = 0, sz = file.GetMemSize(); i < sz; i++) {
                    538:                mem[i] = 0;
                    539:        }
                    540: }

unix.superglobalmegacorp.com

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