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

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: 
                     13: #include "device.h"
1.1.1.3   root       14: #include "mappedfile.h"
1.1.1.9   root       15: #include "monitor.h"
1.1       root       16: #include "rtc.h"
                     17: 
                     18: // MK48T02 の時計部分のレジスタと内部状態
                     19: struct MK48T02Clock
                     20: {
1.1.1.12! root       21:        // MK48T02 の場合:
        !            22:        //
1.1.1.10  root       23:        //       b7   b6   b5   b4   b3   b2   b1   b0
                     24:        //     +----+----+----+----+----+----+----+----+
                     25:        // 7ff |              YEAR (4+4bit)            |  (YEAR: 00..99)
                     26:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       27:        // 7fe | XX   XX   XX |      MONTH (1+4bit)    |  (MONTH: 01..12)
1.1.1.10  root       28:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       29:        // 7fd | XX   XX |         DATE (2+4bit)       |  (DATE: 01..31)
1.1.1.10  root       30:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       31:        // 7fc | XX | FT | XX   XX   XX |WEEKDAY (3bit)|  (WEEKDAY: 1..7)
1.1.1.10  root       32:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       33:        // 7fb | KS | XX |         HOUR (2+4bit)       |  (HOURS: 00..23)
1.1.1.10  root       34:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       35:        // 7fa | XX |           MINUTES (3+4bit)       |  (MINUTES: 00..59)
1.1.1.10  root       36:        //     +----+----+----+----+----+----+----+----+
                     37:        // 7f9 | ST |           SECONDS (3+4bit)       |  (SECONDS: 00..59)
                     38:        //     +----+----+----+----+----+----+----+----+
                     39:        // 7f8 |  W |  R |        CALIBRATION          |  (CONTROL)
                     40:        //     +----+----+----+----+----+----+----+----+
                     41:        //
1.1.1.12! root       42:        // 'XX' はデータシートでは '0' だが書き込んだ値が読み返せるようだ。
        !            43:        // SPARCstation2 の PROM で少なくとも +7fa の b7 はそう観測されている
        !            44:        // ように思える(Issue#75)。他のビットも全部同じ挙動をするかは確認手段
        !            45:        // が手元にないので分からないが、内部構造的にはただの SRAM が見えてそう
        !            46:        // な気もするので、とりあえずデータシートで '0' になっているところは
        !            47:        // 全てメモリとして扱うことにする。何か分かったらまた対応する。
1.1.1.11  root       48:        //
                     49:        //
1.1.1.12! root       50:        // (参考までに) M48T02 の場合:
        !            51:        //
        !            52:        // 互換チップ M48T02 は、そのデータシート上 '0' のところでも、常に %0
        !            53:        // しか読み出せないところ (以下表中 '0')と、書き込んだ値が読み出せる
        !            54:        // ところ (以下表中 'XX') とがあるようだ。
        !            55:        // また機種によっては以下の位置に BLE/BE 拡張と CEB/CB 拡張がある。
        !            56:        // BLE, BL は Battery Low Enable, Battery Low。(BL は Read Only)
1.1.1.11  root       57:        // CEB, CB は Century Enable Bit, Century Bit。
                     58:        //
1.1.1.12! root       59:        //       b7   b6   b5   b4   b3   b2   b1   b0
        !            60:        //     +----+----+----+----+----+----+----+----+
        !            61:        // 7ff |                  YEAR                 |
        !            62:        //     +----+----+----+----+----+----+----+----+
        !            63:        // 7fe |  0    0    0 |       MONTH            |
        !            64:        //     +----+----+----+----+----+----+----+----+
        !            65:        // 7fd | BLE| BL |            DATE             |
1.1.1.11  root       66:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       67:        // 7fc | XX | FT | CEB| CB |  0 |   WEEKDAY    |
1.1.1.11  root       68:        //     +----+----+----+----+----+----+----+----+
1.1.1.12! root       69:        // 7fb | KS |  0 |            HOUR             |
        !            70:        //     +----+----+----+----+----+----+----+----+
        !            71:        // 7fa |  0 |               MINUTES            |
        !            72:        //     +----+----+----+----+----+----+----+----+
        !            73:        // 7f9 | ST |               SECONDS            |
        !            74:        //     +----+----+----+----+----+----+----+----+
        !            75:        // 7f8 |  W |  R |        CALIBRATION          |
1.1.1.11  root       76:        //     +----+----+----+----+----+----+----+----+
1.1.1.10  root       77: 
                     78:        // コントロールレジスタは全ビットを保持。
                     79:        // ただし b5-b0 のキャリブレーションは未実装。
1.1       root       80:        static const uint8 WRITE        = 0x80; // WRITE BIT
                     81:        static const uint8 READ         = 0x40; // READ BIT
                     82: 
1.1.1.10  root       83:        // 内部のカウンタと毎秒ラッチされるレジスタの2ステージ構成になっている
                     84:        // ここには制御ビット部分は含まない。
                     85:        struct calendar {
                     86:                uint8 sec;              // BCD 秒(00-59)
                     87:                uint8 min;              // BCD 分(00-59)
                     88:                uint8 hour;             // BCD 時(00-23)
                     89:                uint8 wday;             // 曜日(1-7; 7=日曜)
                     90:                uint8 mday;             // BCD 日(01-31)
                     91:                uint8 mon;              // BCD 月(01-12)
                     92:                uint8 year;             // BCD 年(00-99; 西暦年の下二桁)
                     93:        };
                     94:        calendar in {}; // 内部カウンタ
                     95: 
1.1       root       96:        // 秒カウンタの bit7 が STOP ビット
1.1.1.10  root       97:        static const uint8 STOP = 0x80;
1.1       root       98:        // STOP 状態を保持
1.1.1.10  root       99:        uint8 stop {};
1.1       root      100: 
                    101:        // 時カウンタの bit7 が KICKSTART ビット
1.1.1.10  root      102:        // KICKSTART は内部発振器のスタートに使用するが、改良版である
                    103:        //  M48T02 (K なし)では廃止された。動作は実装しない。
                    104:        static const uint8 KICKSTART = 0x80;
1.1       root      105:        // KICKSTART 状態を保持
1.1.1.10  root      106:        uint8 kickstart {};
1.1       root      107: 
1.1.1.10  root      108:        // 曜日カウンタの bit6 が Frequency Test ビット
                    109:        // 動作は実装しない。
                    110:        static const uint8 FREQTEST = 0x40;
                    111:        // FreqTest 状態を保持
                    112:        uint8 freqtest {};
1.1       root      113: };
                    114: 
                    115: class MK48T02Device : public RTCDevice
                    116: {
1.1.1.3   root      117:        using inherited = RTCDevice;
1.1       root      118:  public:
                    119:        MK48T02Device();
1.1.1.6   root      120:        virtual ~MK48T02Device() override;
1.1       root      121: 
1.1.1.3   root      122:        bool Init() override;
1.1       root      123: 
1.1.1.12! root      124:        void StartTime() override;
        !           125: 
1.1.1.2   root      126:        // 指定したアドレスからの文字列を読み出す (内蔵 ROM からのアクセス用)
                    127:        std::string PeekString(uint32 addr) const;
                    128:        // 指定したアドレスに文字列を書き込む (内蔵 ROM からのアクセス用)
                    129:        bool WriteString(uint32 addr, const std::string& data);
1.1.1.9   root      130:        // 全域をゼロクリアする (内蔵 ROM からのアクセス用)
                    131:        void ClearAll();
1.1.1.2   root      132: 
                    133:        // BusIO インタフェース
                    134:        // (内蔵 ROM からのアクセス用に特別に public にしてある)
1.1.1.7   root      135:        uint64 Read(uint32 offset);
                    136:        uint64 Write(uint32 offset, uint32 data);
                    137:        uint64 Peek(uint32 offset);
                    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: };

unix.superglobalmegacorp.com

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