Annotation of nono/vm/mk48t02.h, revision 1.1.1.14

1.1       root        1: //
                      2: // nono
1.1.1.3   root        3: // Copyright (C) 2020 nono project
                      4: // Licensed under nono-license.txt
1.1       root        5: //
                      6: 
1.1.1.12  root        7: //
                      8: // NVRAM/RTC (MK48T02)
                      9: //
                     10: 
1.1       root       11: #pragma once
                     12: 
1.1.1.14! root       13: #include "rtc.h"
1.1.1.3   root       14: #include "mappedfile.h"
1.1.1.9   root       15: #include "monitor.h"
1.1       root       16: 
                     17: // MK48T02 の時計部分のレジスタと内部状態
                     18: struct MK48T02Clock
                     19: {
1.1.1.12  root       20:        // MK48T02 の場合:
                     21:        //
1.1.1.10  root       22:        //       b7   b6   b5   b4   b3   b2   b1   b0
                     23:        //     +----+----+----+----+----+----+----+----+
                     24:        // 7ff |              YEAR (4+4bit)            |  (YEAR: 00..99)
                     25:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       26:        // 7fe | XX   XX   XX |      MONTH (1+4bit)    |  (MONTH: 01..12)
1.1.1.10  root       27:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       28:        // 7fd | XX   XX |         DATE (2+4bit)       |  (DATE: 01..31)
1.1.1.10  root       29:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       30:        // 7fc | XX | FT | XX   XX   XX |WEEKDAY (3bit)|  (WEEKDAY: 1..7)
1.1.1.10  root       31:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       32:        // 7fb | KS | XX |         HOUR (2+4bit)       |  (HOURS: 00..23)
1.1.1.10  root       33:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       34:        // 7fa | XX |           MINUTES (3+4bit)       |  (MINUTES: 00..59)
1.1.1.10  root       35:        //     +----+----+----+----+----+----+----+----+
                     36:        // 7f9 | ST |           SECONDS (3+4bit)       |  (SECONDS: 00..59)
                     37:        //     +----+----+----+----+----+----+----+----+
                     38:        // 7f8 |  W |  R |        CALIBRATION          |  (CONTROL)
                     39:        //     +----+----+----+----+----+----+----+----+
                     40:        //
1.1.1.12  root       41:        // 'XX' はデータシートでは '0' だが書き込んだ値が読み返せるようだ。
                     42:        // SPARCstation2 の PROM で少なくとも +7fa の b7 はそう観測されている
                     43:        // ように思える(Issue#75)。他のビットも全部同じ挙動をするかは確認手段
                     44:        // が手元にないので分からないが、内部構造的にはただの SRAM が見えてそう
                     45:        // な気もするので、とりあえずデータシートで '0' になっているところは
                     46:        // 全てメモリとして扱うことにする。何か分かったらまた対応する。
1.1.1.11  root       47:        //
                     48:        //
1.1.1.12  root       49:        // (参考までに) M48T02 の場合:
                     50:        //
                     51:        // 互換チップ M48T02 は、そのデータシート上 '0' のところでも、常に %0
                     52:        // しか読み出せないところ (以下表中 '0')と、書き込んだ値が読み出せる
                     53:        // ところ (以下表中 'XX') とがあるようだ。
                     54:        // また機種によっては以下の位置に BLE/BE 拡張と CEB/CB 拡張がある。
                     55:        // BLE, BL は Battery Low Enable, Battery Low。(BL は Read Only)
1.1.1.11  root       56:        // CEB, CB は Century Enable Bit, Century Bit。
                     57:        //
1.1.1.12  root       58:        //       b7   b6   b5   b4   b3   b2   b1   b0
                     59:        //     +----+----+----+----+----+----+----+----+
                     60:        // 7ff |                  YEAR                 |
                     61:        //     +----+----+----+----+----+----+----+----+
                     62:        // 7fe |  0    0    0 |       MONTH            |
                     63:        //     +----+----+----+----+----+----+----+----+
                     64:        // 7fd | BLE| BL |            DATE             |
1.1.1.11  root       65:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       66:        // 7fc | XX | FT | CEB| CB |  0 |   WEEKDAY    |
1.1.1.11  root       67:        //     +----+----+----+----+----+----+----+----+
1.1.1.12  root       68:        // 7fb | KS |  0 |            HOUR             |
                     69:        //     +----+----+----+----+----+----+----+----+
                     70:        // 7fa |  0 |               MINUTES            |
                     71:        //     +----+----+----+----+----+----+----+----+
                     72:        // 7f9 | ST |               SECONDS            |
                     73:        //     +----+----+----+----+----+----+----+----+
                     74:        // 7f8 |  W |  R |        CALIBRATION          |
1.1.1.11  root       75:        //     +----+----+----+----+----+----+----+----+
1.1.1.10  root       76: 
                     77:        // コントロールレジスタは全ビットを保持。
                     78:        // ただし b5-b0 のキャリブレーションは未実装。
1.1       root       79:        static const uint8 WRITE        = 0x80; // WRITE BIT
                     80:        static const uint8 READ         = 0x40; // READ BIT
                     81: 
1.1.1.10  root       82:        // 内部のカウンタと毎秒ラッチされるレジスタの2ステージ構成になっている
                     83:        // ここには制御ビット部分は含まない。
                     84:        struct calendar {
                     85:                uint8 sec;              // BCD 秒(00-59)
                     86:                uint8 min;              // BCD 分(00-59)
                     87:                uint8 hour;             // BCD 時(00-23)
                     88:                uint8 wday;             // 曜日(1-7; 7=日曜)
                     89:                uint8 mday;             // BCD 日(01-31)
                     90:                uint8 mon;              // BCD 月(01-12)
                     91:                uint8 year;             // BCD 年(00-99; 西暦年の下二桁)
                     92:        };
                     93:        calendar in {}; // 内部カウンタ
                     94: 
1.1       root       95:        // 秒カウンタの bit7 が STOP ビット
1.1.1.10  root       96:        static const uint8 STOP = 0x80;
1.1       root       97:        // STOP 状態を保持
1.1.1.10  root       98:        uint8 stop {};
1.1       root       99: 
                    100:        // 時カウンタの bit7 が KICKSTART ビット
1.1.1.10  root      101:        // KICKSTART は内部発振器のスタートに使用するが、改良版である
                    102:        //  M48T02 (K なし)では廃止された。動作は実装しない。
                    103:        static const uint8 KICKSTART = 0x80;
1.1       root      104:        // KICKSTART 状態を保持
1.1.1.10  root      105:        uint8 kickstart {};
1.1       root      106: 
1.1.1.10  root      107:        // 曜日カウンタの bit6 が Frequency Test ビット
                    108:        // 動作は実装しない。
                    109:        static const uint8 FREQTEST = 0x40;
                    110:        // FreqTest 状態を保持
                    111:        uint8 freqtest {};
1.1       root      112: };
                    113: 
                    114: class MK48T02Device : public RTCDevice
                    115: {
1.1.1.3   root      116:        using inherited = RTCDevice;
1.1       root      117:  public:
                    118:        MK48T02Device();
1.1.1.14! root      119:        ~MK48T02Device() override;
1.1       root      120: 
1.1.1.3   root      121:        bool Init() override;
1.1       root      122: 
1.1.1.12  root      123:        void StartTime() override;
                    124: 
1.1.1.2   root      125:        // 指定したアドレスからの文字列を読み出す (内蔵 ROM からのアクセス用)
                    126:        std::string PeekString(uint32 addr) const;
                    127:        // 指定したアドレスに文字列を書き込む (内蔵 ROM からのアクセス用)
                    128:        bool WriteString(uint32 addr, const std::string& data);
1.1.1.9   root      129:        // 全域をゼロクリアする (内蔵 ROM からのアクセス用)
                    130:        void ClearAll();
1.1.1.2   root      131: 
                    132:        // BusIO インタフェース
                    133:        // (内蔵 ROM からのアクセス用に特別に public にしてある)
1.1.1.14! root      134:        busdata Read(uint32 offset);
        !           135:        busdata Write(uint32 offset, uint32 data);
        !           136:        busdata Peek(uint32 offset);
        !           137:        bool Poke(uint32 offset, uint32 data) override;
1.1.1.7   root      138: 
1.1.1.10  root      139:        // 内蔵カウンタへのアクセス。
                    140:        // ラッチカウンタではないことに注意。
                    141:        uint GetSec() const override;   // 秒(0-59)
                    142:        uint GetMin() const override;   // 分(0-59)
                    143:        uint GetHour() const override;  // 時(0-23)
                    144:        uint GetWday() const override;  // 曜日(0が日曜)
                    145:        uint GetMday() const override;  // 日(1-31)
                    146:        uint GetMon() const override;   // 月(1-12)
                    147:        uint GetYear() const override;  // 年(西暦)
                    148:        uint GetLeap() const override;  // うるう年カウンタ(0..3)
                    149: 
1.1.1.2   root      150:  protected:
                    151:        // BusIO インタフェース
                    152:        static const uint32 NPORT = 2048;
                    153: 
1.1.1.10  root      154:        // 仮想RTCからのクロック
                    155:        void Tick1Hz() override;
                    156: 
                    157:        // 内蔵カウンタへのアクセス。
                    158:        void SetSec(uint v) override;
                    159:        void SetMin(uint v) override;
                    160:        void SetHour(uint v) override;
                    161:        void SetWday(uint v) override;
                    162:        void SetMday(uint v) override;
                    163:        void SetMon(uint v) override;
                    164:        void SetYear(uint v) override;
                    165:        void SetLeap(uint v) override;
                    166: 
1.1       root      167:  private:
                    168:        // バイナリ <-> BCD 変換
                    169:        static inline uint8 num2BCD(uint8);
                    170:        static inline uint8 BCD2num(uint8);
                    171: 
1.1.1.10  root      172:        // 年のデコード。
                    173:        uint DecodeYear(uint bcd_year) const;
                    174: 
1.1       root      175:        // コントロールレジスタへの書き込み
                    176:        void WriteCtrl(uint32 data);
                    177: 
1.1.1.12  root      178:        // NVRAM からカレンダへロード
                    179:        MK48T02Clock::calendar Load() const;
                    180: 
                    181:        // カレンダを NVRAM にストア
                    182:        void Store(const MK48T02Clock::calendar& cal);
                    183: 
1.1.1.9   root      184:        DECLARE_MONITOR_CALLBACK(MonitorUpdate);
                    185: 
1.1.1.3   root      186:        // ファイル
1.1       root      187:        std::string filename {};
1.1.1.3   root      188:        MappedFile file {};
                    189:        uint8 *mem {};
1.1       root      190: 
                    191:        // 時計
                    192:        MK48T02Clock reg {};
                    193: 
1.1.1.10  root      194:        // うるう年補正量
                    195:        uint adjust_leap {};
                    196: 
                    197:        // 外部レジスタをホールド(更新停止)しているときは true
                    198:        bool hold {};
1.1.1.9   root      199: 
                    200:        Monitor monitor { this };
1.1       root      201: };
1.1.1.13  root      202: 
                    203: static inline MK48T02Device *GetMK48T02Device() {
                    204:        return Object::GetObject<MK48T02Device>(OBJ_RTC);
                    205: }

unix.superglobalmegacorp.com

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