Annotation of nono/vm/device.h, revision 1.1.1.4

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: #pragma once
                      8: 
                      9: #include "object.h"
                     10: #include <vector>
                     11: 
                     12: #if BYTE_ORDER == LITTLE_ENDIAN
                     13: #define HB(addr)       ((addr) ^ 1)
                     14: #define HLB(addr)      ((addr) ^ 3)
                     15: #define HLW(addr)      ((addr) ^ 2)
                     16: #else
                     17: #define HB(addr)       (addr)
                     18: #endif
                     19: 
                     20: class Device : public Object
                     21: {
1.1.1.4 ! root       22:        using inherited = Object;
1.1       root       23:  protected:
                     24:        Device();
                     25:  public:
1.1.1.4 ! root       26:        ~Device() override;
1.1       root       27: 
                     28:  public:
                     29:        // 初期化は以下の手順で行う。
                     30:        // 1. コンストラクタ
                     31:        //      メンバ変数の初期値代入などを行う。失敗するケースは考慮していない。
1.1.1.4 ! root       32:        //      gConfig の内部変数の追加はここ(か2.の動的コンストラクション)で
        !            33:        //      行うこと。この時点ですでに gConfig の設定内容の参照は可能だが、
        !            34:        //      エラーが出るものはここではなく Init() で処理すること。
1.1       root       35:        //
                     36:        // 2. Create() ... 動的コンストラクション
                     37:        //      必要なら設定ファイルによって可変なオブジェクトのコンストラクトを行う。
                     38:        //      例えば SCSI ドライブなどが該当する。
1.1.1.4 ! root       39:        //      ここでも gConfig の参照および内部変数の登録は可能。
1.1       root       40:        //
                     41:        // 3. parse_logopt() ... -L オプションの処理
                     42:        //      この時点で Object 由来のオブジェクトはすべて出揃っている必要がある。
1.1.1.4 ! root       43:        //      またここで --show-config も行うため、この時点で gConfig の内容は確定し
        !            44:        //      以降 gConfig の変更は出来ない。
1.1       root       45:        //
                     46:        // 4. Init() ... 初期化
1.1.1.3   root       47:        //      ここでは ROM などのファイルの読み込み、またスレッドの起動などを行う。
1.1       root       48:        //      Object 由来のオブジェクトはすべて揃っているため、相互にアクセス可能。
                     49:        //      ただしその際の依存関係については、vm.cpp (や xiospace.cpp) 内の
                     50:        //      コンストラクタの順序で調整すること (循環参照不可)。
                     51:        //      またここから putlog() が使える (Scheduler::Init() のコメントも参照)。
                     52:        //
                     53:        // 5. Apply() ... 動的設定の適用
                     54:        //      実行中に変更可能なパラメータもここで一度適用する。
                     55:        //
                     56:        // 6. PowerOn(), ResetHard() ... VM 起動
                     57: 
                     58:        // 動的コンストラクション。
                     59:        // この時点で設定ファイルは読める。putlog() は使えない。
                     60:        // 成功すれば true を返す、
                     61:        // 失敗なら warn()/warnx() でエラーメッセージを表示して false を返すこと。
                     62:        virtual bool Create();
                     63: 
                     64:        // 初期化。
                     65:        // 起動時設定の適用、ファイルの読み込み、スレッド作成を行う。
1.1.1.3   root       66:        // Object 由来のオブジェクトはすべて揃っており、設定ファイルは読める。
                     67:        // putlog() も使える。
1.1       root       68:        // 成功すれば true を返すこと。
1.1.1.3   root       69:        // 失敗なら warn()/warnx()、あるいは ConfigItem::Err() 系 (実態は warnx)
                     70:        // でエラーメッセージを表示して false を返すこと。
1.1       root       71:        virtual bool Init();
                     72: 
                     73:        // 現在の設定を VM に反映させる。
                     74:        // ここで適用するのは実行中に変更可能なパラメータのみ。
                     75:        // 適用内容を表示したい時は putlog(1) が妥当か。
                     76:        // 成功すれば true を返すこと。
                     77:        // 失敗なら warn()/warnx()、あるいは gConfig->Err() 系 (実態は warnx) で
                     78:        // エラーメッセージを表示して false を返すこと。
                     79:        // といっても false が返されたらどうするんだろうか。
                     80:        virtual bool Apply();
                     81: 
                     82:        virtual bool PowerOn();
                     83:        virtual bool PowerOff();
                     84: 
                     85:        // ResetHard() は本体リセットスイッチによるリセット。
                     86:        // ResetSoft() は MPU の RESET 命令によるリセット。
                     87:        //
                     88:        // X680x0 では、
1.1.1.4 ! root       89:        // o PowerOn でリセット  : VIPS, VideoCtlr, OSCIAN2
1.1       root       90:        // o ResetHard でリセット: YUKI, MPU, FPU および ResetSoft の全員
                     91:        // o ResetSoft でリセット: PPI, PEDEC, SPC, ADPCM, FDC, MFP, SAKI,
                     92:        //                         CYNTHIA, DMAC らしい
                     93:        // o いずれでもリセットされないもの: CACHY, YM2151, RTC
                     94:        // o 分からないけどたぶん ResetHard でリセット: SCC
                     95:        //
                     96:        // LUNA では、詳細分からないので全員 ResetHard にしとくか。
                     97:        virtual void ResetHard();
                     98:        virtual void ResetSoft();
                     99: 
                    100: };
                    101: 
                    102: class IODevice : public Device
                    103: {
1.1.1.4 ! root      104:        using inherited = Device;
1.1       root      105:  protected:
                    106:        IODevice();
                    107:  public:
1.1.1.4 ! root      108:        ~IODevice() override;
1.1       root      109: 
                    110:  public:
                    111:        // アクセス関数。
                    112:        // Read*() は読み込んだ値を (uint32) で返す。
                    113:        // Write*() は書き込めたら 0 を返す。
                    114:        // Peek8() はデバッガアクセスで読み込んだ値を (uint32) で返す。
                    115:        // いずれもバスエラーなら (uint64)-1 を返す。
                    116:        // (signed) int64 を使ってないのはノーマルパスで signed/unsigned の
                    117:        // キャスト事故を防ぐため。
                    118:        virtual uint64 Read8(uint32 addr);
                    119:        virtual uint64 Read16(uint32 addr);
                    120:        virtual uint64 Read32(uint32 addr);
                    121:        virtual uint64 Write8(uint32 addr, uint32 data);
                    122:        virtual uint64 Write16(uint32 addr, uint32 data);
                    123:        virtual uint64 Write32(uint32 addr, uint32 data);
                    124:        virtual uint64 Peek8(uint32 addr);
                    125: 
                    126:        uint32 devaddr = 0;                     // このデバイスの先頭アドレス
                    127: 
                    128:        // (必要なら)このデバイスの占めるバイト数。
                    129:        // 今のところ XIOSpace、MuxDevice では必要。それ以外では不要。
                    130:        uint32 devlen = 0;
                    131: };
                    132: 
                    133: class BusErrDevice : public IODevice
                    134: {
1.1.1.4 ! root      135:        using inherited = IODevice;
1.1       root      136:  public:
                    137:        BusErrDevice();
1.1.1.4 ! root      138:        ~BusErrDevice() override;
1.1       root      139: 
                    140:  public:
1.1.1.4 ! root      141:        uint64 Read8(uint32 addr) override;
        !           142:        uint64 Read16(uint32 addr) override;
        !           143:        uint64 Read32(uint32 addr) override;
        !           144:        uint64 Write8(uint32 addr, uint32 data) override;
        !           145:        uint64 Write16(uint32 addr, uint32 data) override;
        !           146:        uint64 Write32(uint32 addr, uint32 data) override;
        !           147:        uint64 Peek8(uint32 addr) override;
1.1       root      148: };
                    149: 
                    150: // 何もしないデバイス。
                    151: // 読み込むと全域で 0xff が読めて、書き込んでも何も起きない。
                    152: class NullDevice : public IODevice
                    153: {
1.1.1.4 ! root      154:        using inherited = IODevice;
1.1       root      155:  public:
                    156:        NullDevice();
1.1.1.4 ! root      157:        ~NullDevice() override;
1.1       root      158: 
                    159:  public:
1.1.1.4 ! root      160:        uint64 Read8(uint32 addr) override;
        !           161:        uint64 Write8(uint32 addr, uint32 data) override;
        !           162:        uint64 Peek8(uint32 addr) override;
1.1       root      163: };
                    164: 
                    165: // 前方参照
                    166: class BitmapDevice;
1.1.1.3   root      167: class CRTC2Device;
                    168: class DMACDevice;
                    169: class FuseROMDevice;
1.1       root      170: class Human68k;
                    171: class IODevice;
                    172: class LanceDevice;
                    173: class MK48T02Device;
                    174: class MPUDevice;
                    175: class PIO0Device;
                    176: class PIO1Device;
                    177: class PROMDevice;
                    178: class RAMDevice;
1.1.1.2   root      179: class SCSIDevice;
1.1       root      180: class SCSIHD;
                    181: class SCSIHostDevice;
                    182: class SCSITarget;
                    183: class SIODevice;
                    184: class SPCDevice;
                    185: class SysClkDevice;
                    186: class VM;
                    187: class XIOSpaceDevice;
                    188: class ZRAMDevice;
                    189: 
                    190: extern std::vector<Device *> gDevices;

unix.superglobalmegacorp.com

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