|
|
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:
1.1.1.14! root 162: busdata
1.1.1.7 root 163: MK48T02Device::Read(uint32 offset)
1.1 root 164: {
1.1.1.14! root 165: busdata data;
1.1 root 166:
1.1.1.12 root 167: data = mem[offset];
1.1.1.14! root 168: putlog(3, "$%08x -> $%02x", mpu->GetPaddr(), data.Data());
1.1 root 169:
1.1.1.14! root 170: // XXX wait?
1.1 root 171: return data;
172: }
173:
1.1.1.14! root 174: busdata
1.1.1.7 root 175: MK48T02Device::Write(uint32 offset, uint32 data)
1.1 root 176: {
1.1.1.13 root 177: putlog(3, "$%08x <- $%02x", mpu->GetPaddr(), data);
1.1.1.10 root 178:
1.1.1.12 root 179: switch (offset - 2040) {
180: case 0: // コントロール
181: WriteCtrl(data);
182: break;
183: case 1: // 秒 (b7 は STOP BIT)
184: reg.stop = data & MK48T02Clock::STOP;
185: break;
186: case 2: // 分
187: break;
188: case 3: // 時 (b7 は KICK START)
189: reg.kickstart = data & MK48T02Clock::KICKSTART;
190: break;
191: case 4: // 曜日 (b6 は Frequency Test (未実装))
192: // データシートでは b7, b5, b4 は '0' とあるが実際には '1' が
193: // 書き込める。書き込んだ '1' が内部クロックの更新でどうなるか
194: // 未確認のため、とりあえず放置。
195: reg.freqtest = data & MK48T02Clock::FREQTEST;
196: break;
197: case 5: // 日
198: // データシートでは b7, b6 は '0' とあるが実際には b7 には '1' が
199: // 書き込める (b6 には書き込めない)。b7 に書き込んだ '1' が内部
200: // クロックの更新でどうなるか未確認のため、とりあえずは放置。
201: break;
202: case 6: // 月
203: break;
204: case 7: // 年
205: break;
206: default:
207: break;
1.1 root 208: }
1.1.1.12 root 209:
210: mem[offset] = data;
211:
1.1.1.14! root 212: // XXX wait?
1.1 root 213: return 0;
214: }
215:
1.1.1.14! root 216: busdata
1.1.1.7 root 217: MK48T02Device::Peek(uint32 offset)
1.1 root 218: {
1.1.1.12 root 219: return mem[offset];
1.1 root 220: }
221:
1.1.1.14! root 222: bool
1.1.1.13 root 223: MK48T02Device::Poke(uint32 offset, uint32 data)
224: {
225: // 時計部分にはコントロールレジスタもあるので書き込み不可。
226: if (offset >= 2040) {
1.1.1.14! root 227: return false;
1.1.1.13 root 228: } else {
229: if ((int32)data >= 0) {
230: mem[offset] = data;
231: }
1.1.1.14! root 232: return true;
1.1.1.13 root 233: }
234: }
235:
1.1.1.5 root 236: void
1.1.1.9 root 237: MK48T02Device::MonitorUpdate(Monitor *, TextScreen& screen)
1.1 root 238: {
1.1.1.10 root 239: uint32 addr;
240: uint32 v;
241: int y = 0;
242:
1.1.1.9 root 243: screen.Clear();
1.1 root 244:
1.1.1.10 root 245: // BCD なので %x で表示する
246: screen.Print(0, y++,
247: "Internal: %04d[%02x]/%02x/%02x(%s) %02x:%02x:%02x.%1x",
248: DecodeYear(reg.in.year), reg.in.year,
249: reg.in.mon, reg.in.mday, wdays[reg.in.wday],
250: reg.in.hour, reg.in.min, reg.in.sec, (uint32)((cnt >> 1) & 0xf));
1.1.1.12 root 251:
252: auto ex = Load();
1.1.1.10 root 253: screen.Print(0, y++,
254: "Register: %04d[%02x]/%02x/%02x(%s) %02x:%02x:%02x",
1.1.1.12 root 255: DecodeYear(ex.year), ex.year,
256: ex.mon, ex.mday, wdays[ex.wday],
257: ex.hour, ex.min, ex.sec);
258:
1.1.1.10 root 259: screen.Print(0, y++, "TimeZone: %s",
260: use_localtime ? "Local" : "UTC");
261: screen.Print(0, y++, "Epoch : %4d (Adjust Leap: %d)",
262: year_epoch, adjust_leap);
263: y++;
264:
265: addr = 0x800;
266: v = Peek(--addr);
267: screen.Print(0, y++, "$%3x: $%02x (year=%02x)", addr, v, v);
268: v = Peek(--addr);
269: screen.Print(0, y++, "$%3x: $%02x (mon =%02x)", addr, v, v);
270: v = Peek(--addr);
271: screen.Print(0, y++, "$%3x: $%02x (date=%02x)", addr, v, v);
272: v = Peek(--addr);
273: screen.Print(0, y++, "$%3x: $%02x (wday=%02x FT=%d)",
274: addr, v, (v & 0x07), (v & MK48T02Clock::FREQTEST) ? 1 : 0);
275: v = Peek(--addr);
276: screen.Print(0, y++, "$%3x: $%02x (hour=%02x KS=%d)",
277: addr, v, (v & 0x3f), (v & MK48T02Clock::KICKSTART) ? 1 : 0);
278: v = Peek(--addr);
279: screen.Print(0, y++, "$%3x: $%02x (min =%02x)", addr, v, (v & 0x7f));
280: v = Peek(--addr);
281: screen.Print(0, y++, "$%3x: $%02x (sec =%02x ST=%d)",
282: addr, v, (v & 0x7f), (v & MK48T02Clock::STOP) ? 1 : 0);
283: v = Peek(--addr);
284: screen.Print(0, y++, "$%3x: $%02x (W=%d R=%d)",
285: addr, v,
286: (v & MK48T02Clock::WRITE) ? 1 : 0,
287: (v & MK48T02Clock::READ) ? 1 : 0);
1.1 root 288: }
289:
290: // コントロールレジスタへの書き込み
291: void
292: MK48T02Device::WriteCtrl(uint32 data)
293: {
1.1.1.12 root 294: uint8 old = mem[0x7f8];
1.1.1.10 root 295:
1.1.1.12 root 296: bool write_fall = bit_falling(old, data, MK48T02Clock::WRITE);
1.1 root 297:
1.1.1.10 root 298: // ホールドしているかどうかは状態なのでエッジではない
1.1.1.12 root 299: hold = (data & (MK48T02Clock::READ | MK48T02Clock::WRITE));
1.1.1.10 root 300:
301: if (write_fall) {
1.1.1.12 root 302: // WRITE ビットの立ち下がりエッジでメモリから内部カウンタへロード
303: reg.in = Load();
304:
1.1.1.10 root 305: // 分周段は規定されていないが意味的にクリアするほうが良いだろう
306: cnt = 0;
1.1 root 307: }
308: }
309:
1.1.1.12 root 310: // NVRAM からカレンダをロード
311: MK48T02Clock::calendar
312: MK48T02Device::Load() const
313: {
314: MK48T02Clock::calendar cal;
315:
316: cal.sec = mem[0x7f9] & 0x7f;
317: cal.min = mem[0x7fa] & 0x7f;
318: cal.hour = mem[0x7fb] & 0x3f;
319: cal.wday = mem[0x7fc] & 0x07;
320: cal.mday = mem[0x7fd] & 0x3f;
321: cal.mon = mem[0x7fe] & 0x1f;
322: cal.year = mem[0x7ff];
323:
324: return cal;
325: }
326:
327: // カレンダを NVRAM にストア
328: void
329: MK48T02Device::Store(const MK48T02Clock::calendar& cal)
330: {
331: mem[0x7f9] = (mem[0x7f9] & ~0x7f) | cal.sec;
332: mem[0x7fa] = (mem[0x7fa] & ~0x7f) | cal.min;
333: mem[0x7fb] = (mem[0x7fb] & ~0x3f) | cal.hour;
334: mem[0x7fc] = (mem[0x7fc] & ~0x07) | cal.wday;
335: mem[0x7fd] = (mem[0x7fd] & ~0x3f) | cal.mday;
336: mem[0x7fe] = (mem[0x7fe] & ~0x1f) | cal.mon;
337: mem[0x7ff] = cal.year;
338: }
339:
1.1.1.10 root 340: uint
341: MK48T02Device::GetSec() const
342: {
343: return BCD2num(reg.in.sec);
344: }
345:
346: void
347: MK48T02Device::SetSec(uint v)
348: {
349: reg.in.sec = num2BCD(v);
350: }
351:
352: uint
353: MK48T02Device::GetMin() const
354: {
355: return BCD2num(reg.in.min);
356: }
357:
358: void
359: MK48T02Device::SetMin(uint v)
360: {
361: reg.in.min = num2BCD(v);
362: }
363:
364: uint
365: MK48T02Device::GetHour() const
366: {
367: return BCD2num(reg.in.hour);
368: }
369:
370: void
371: MK48T02Device::SetHour(uint v)
372: {
373: reg.in.hour = num2BCD(v);
374: }
375:
376: uint
377: MK48T02Device::GetWday() const
378: {
379: // データシートの正規の値範囲は 1..7 だが 0 も問題なく保持できて、
380: // NetBSD/luna68k, OpenBSD/luna88k は日付を日曜に変更する際には 0 を
381: // レジスタに書き込んでいる。そのためレジスタ値は 0 と 7 を日曜、
382: // 1を月曜…という運用ということにする。
383: // 戻り値は 0..6 (0が日曜)。
384:
385: int v = reg.in.wday;
386: if (v == 7) {
387: v = 0;
388: }
389: return v;
390: }
391:
392: void
393: MK48T02Device::SetWday(uint v)
394: {
395: // 引数は 0..6 (0が日曜)、MK48T02 の正規の範囲は 1..7 で曜日との対応は
396: // 運用依存のようだ。NetBSD/luna68k, OpenBSD/luna88k は 0 を日曜、1 を
397: // 月曜…と扱っているが、MK48T02 の曜日レジスタは 7 の翌日 1 に繰り上がる
398: // 動作なので、ここでもレジスタには 1..7 (1が月曜、7が日曜) をセットする。
399: if (v == 0)
400: v = 7;
401: reg.in.wday = v;
402: }
403:
404: uint
405: MK48T02Device::GetMday() const
406: {
407: return BCD2num(reg.in.mday);
408: }
409:
410: void
411: MK48T02Device::SetMday(uint v)
412: {
413: reg.in.mday = num2BCD(v);
414: }
415:
416: uint
417: MK48T02Device::GetMon() const
418: {
419: return BCD2num(reg.in.mon);
420: }
421:
422: void
423: MK48T02Device::SetMon(uint v)
424: {
425: reg.in.mon = num2BCD(v);
426: }
427:
428: uint
429: MK48T02Device::DecodeYear(uint bcd_year) const
430: {
431: uint y = BCD2num(bcd_year);
432: y += year_epoch;
433:
434: // 1970年より前を 2000 年代とみなすのはシステム依存だが
435: // UNIX 系はみんなこう(?)
436: // XXX ここの 1970 と RTC エポックを一致させれば端折れるじゃん!と
437: // 思いついたのかしら?
438: if (y < 1970) {
439: y += 100;
440: }
441: return y;
442: }
443:
444: uint
445: MK48T02Device::GetYear() const
446: {
447: // see DecodeYear()
448: return DecodeYear(reg.in.year);
449: }
450:
451: void
452: MK48T02Device::SetYear(uint v)
453: {
454: // see DecodeYear()
455: v -= year_epoch;
456: reg.in.year = num2BCD(v % 100);
457: }
458:
459: uint
460: MK48T02Device::GetLeap() const
461: {
462: // 補正項込みで計算
463: return (BCD2num(reg.in.year) + adjust_leap) & 3;
464: }
465:
466: void
467: MK48T02Device::SetLeap(uint v)
468: {
469: // nop
470: // MK48T02 ではうるう年カウンタはなく、西暦年でうるう年を判断している。
471: }
472:
473: // 1Hz 仮想 RTC からのコール
1.1.1.12 root 474: // (分周段 0/32 秒でコールされる)
1.1.1.10 root 475: void
476: MK48T02Device::Tick1Hz()
477: {
478: if (reg.stop) {
479: // 実機は電力消費を抑えるため発振器ごと止めるが、
480: // 分周段が規定されていないので秒カウントを止めれば十分なはず
481: //nop
482: } else {
483: CountUpSec();
484: }
485:
486: if (hold == false) {
1.1.1.12 root 487: // 秒の更新でメモリにコピーする (Datasheet p2)
488: Store(reg.in);
1.1.1.10 root 489: }
1.1 root 490: }
1.1.1.3 root 491:
492: // 指定したアドレスからのゼロ終端文字列を返す
493: // (内蔵 ROM からのアクセス用)
494: std::string
495: MK48T02Device::PeekString(uint32 addr) const
496: {
497: std::string rv = "";
498:
1.1.1.7 root 499: addr &= 0x7ff;
500: for (; mem[addr]; addr++) {
501: rv += mem[addr];
1.1.1.3 root 502: }
503: return rv;
504: }
505:
506: // 指定したアドレスに文字列を書き込み、
507: // 16 バイトに満たないところはゼロでパディングする。
508: // 書き込めれば true を、書き込めなければ false を返す。
509: // (内蔵 ROM からの書き込み用)
510: bool
511: MK48T02Device::WriteString(uint32 addr, const std::string& data)
512: {
513: int i = 0;
514:
1.1.1.9 root 515: // ここの文字列は16バイト未満なら一見ゼロ終端のようだが、
516: // 16バイトならゼロ終端せず16文字とするフォーマット。
517:
518: if (data.length() > 16) {
1.1.1.3 root 519: return false;
520: }
521:
522: addr &= 0x7ff;
523: for (; i < data.length(); i++) {
1.1.1.9 root 524: mem[addr + i] = data[i];
1.1.1.3 root 525: }
526: for (; i < 16; i++) {
1.1.1.9 root 527: mem[addr + i] = 0;
1.1.1.3 root 528: }
529: return true;
530: }
1.1.1.9 root 531:
532: // 全域をゼロクリアする。
533: // クリアするだけなので、その後何か書いたりチェックサムを計算したりする
534: // 必要はある。
535: // (内蔵 ROM からの書き込み用)
536: void
537: MK48T02Device::ClearAll()
538: {
539: for (int i = 0, sz = file.GetMemSize(); i < sz; i++) {
540: mem[i] = 0;
541: }
542: }
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.