Add RTC speed control in the IGM

Author: davidgfnet

res/messages.py

@@ -295,6 +295,15 @@
   "IMENU_PLD_ERR":          "Corrupted savestate!",      # igm-alertmsg
 
   "IMENU_SAVING_BLOCKED":   "Saving in progress!",
+
+  "IMENU_RTCSPD": "~main.MSG_DEF_SPEED",
+  "IMENU_SPD0": "~main.MSG_UIS_SPD0",
+  "IMENU_SPD1": "~main.MSG_UIS_SPD1",
+  "IMENU_SPD2": "~main.MSG_UIS_SPD2",
+  "IMENU_SPD3": "~main.MSG_UIS_SPD3",
+  "IMENU_SPD4": "~main.MSG_UIS_SPD4",
+  "IMENU_FRZRTC": "~main.MSG_STILLRTC",
+
   }),
 ]
 
@@ -303,19 +312,31 @@
   allentries = {}
   for e in [en_strings, en_menu_strings]:
     for _, d in e:
-      allentries |= d
+      for k, v in d.items():
+        if not v.startswith("~"):
+          allentries[k] = v
   print(json.dumps(allentries, indent=2))
 elif len(sys.argv) > 1 and sys.argv[1] == "h":
-  todump = en_menu_strings if sys.argv[2] == "menu" else en_strings
-
-  strlist = []
-  for c, entries in todump:
-    for k, v in entries.items():
-      strlist.append((k, v, c))
-  strlist = sorted(strlist)
+  all_entries = {
+    "main": en_strings,
+    "menu": en_menu_strings,
+  }
+
+  strlist = {}
+  strall = {}
+
+  # Flatten all strings
+  for mname, smenu in all_entries.items():
+    tmp = {}
+    for c, entries in smenu:
+      for k, v in entries.items():
+        if mname == sys.argv[2]:
+          strlist[k] = (v, c)
+        tmp[k] = (v, c)
+    strall[mname] = tmp
 
   print("enum TranslationID {")
-  for k, _, c in strlist:
+  for k, (_, c) in sorted(strlist.items()):
     if c:
       print("#ifdef %s" % c)
     print("  %s," % k)
@@ -324,9 +345,13 @@
   print("};")
 
   print("const char * const msg_en[] = {")
-  for k, v, c in strlist:
+  for k, (v, c) in sorted(strlist.items()):
     if c:
       print("#ifdef %s" % c)
+    # Could be a reference to another menu, resolve it
+    if v.startswith("~"):
+      mn, mk = v[1:].split(".")
+      v = strall[mn][mk][0]
     print('  /* %s */ "%s",' % (k.ljust(20), v))
     if c:
       print("#endif")
@@ -337,10 +362,14 @@
   for l in OTHER_LANGS:
     d = json.load(open(os.path.join(langdir, "%s.json" % l)))
     print("const char * const msg_%s[] = {" % l)
-    for k, en_v, c in strlist:
+    for k, (en_v, c) in sorted(strlist.items()):
       if c:
         print("#ifdef %s" % c)
-      v = d[k] if k in d and d[k] else en_v
+      if en_v.startswith("~"):
+        mn, mk = en_v[1:].split(".")
+        v = d[mk] if mk in d and d[mk] else en_v
+      else:
+        v = d[k] if k in d and d[k] else en_v
       print('  /* %s */ "%s",' % (k.ljust(20), v))
       if c:
         print("#endif")

src/common.h

@@ -212,7 +212,7 @@ typedef struct {
 // RTC config data
 typedef struct {
   uint32_t timestamp;                  // RTC current (boot) timestamp.
-  uint32_t ts_step;                    // Number of seconds to advance the RTC on events.
+  uint32_t ts_step;                    // Speed factor to advance the RTC on events.
 } t_rtc_info;
 
 
@@ -245,12 +245,6 @@ static inline unsigned savetype_size(EnumSavetype st) {
   return 1 << lut[st];
 }
 
-static inline unsigned rtc_speed(unsigned speed_class) {
-  const uint8_t lut[] = {
-    0, 4, 8, 16, 24, 36
-  };
-  return lut[speed_class];
-}
 static inline unsigned rtc_speed_cnt() {
   return 6;
 }

src/ingame_menu.c

@@ -60,6 +60,8 @@ void fast_mem_clr_256(void *addr, uint32_t value, unsigned count);
 void set_entrypoint_hook(bool process_cheats);
 uint32_t *get_cheat_table();
 
+#define MAX_SPEED_OPTS      6   // Sync with common.h
+
 #define MAX_DISK_SLOTS      5
 #define MAX_MEM_SLOTS      32
 
@@ -85,6 +87,7 @@ uint32_t *get_cheat_table();
 static unsigned submenu;
 static unsigned copt;
 static t_dec_date rtc_date;
+static unsigned rtc_speed;
 static struct {
   const char *msg;
   void (*callback)();
@@ -630,24 +633,33 @@ void draw_rtc_menu(uint8_t *fb, unsigned framen) {
   char tmont[3] = {'0' + rtc_date.month/10, '0' + rtc_date.month%10, 0};
   char tyear[5] = {'2', '0', '0' + rtc_date.year/10, '0' + rtc_date.year%10, 0};
 
-  draw_text(tyear, fb,  54, 70, copt == 0 ? HI_COLOR : FG_COLOR);
-  draw_text("-",   fb,  86, 70, FG_COLOR);
-  draw_text(tmont, fb,  95, 70, copt == 1 ? HI_COLOR : FG_COLOR);
-  draw_text("-",   fb, 111, 70, FG_COLOR);
-  draw_text(tdays, fb, 120, 70, copt == 2 ? HI_COLOR : FG_COLOR);
-  draw_text(thour, fb, 148, 70, copt == 3 ? HI_COLOR : FG_COLOR);
-  draw_text(":",   fb, 165, 70, FG_COLOR);
-  draw_text(tmins, fb, 170, 70, copt == 4 ? HI_COLOR : FG_COLOR);
+  draw_text(tyear, fb,  54, 56, copt == 0 ? HI_COLOR : FG_COLOR);
+  draw_text("-",   fb,  86, 56, FG_COLOR);
+  draw_text(tmont, fb,  95, 56, copt == 1 ? HI_COLOR : FG_COLOR);
+  draw_text("-",   fb, 111, 56, FG_COLOR);
+  draw_text(tdays, fb, 120, 56, copt == 2 ? HI_COLOR : FG_COLOR);
+  draw_text(thour, fb, 148, 56, copt == 3 ? HI_COLOR : FG_COLOR);
+  draw_text(":",   fb, 165, 56, FG_COLOR);
+  draw_text(tmins, fb, 170, 56, copt == 4 ? HI_COLOR : FG_COLOR);
 
   if (copt < 5) {
     const uint8_t cox[] = {
       68, 103, 127, 156, 178
     };
-    draw_text_center("⯅", fb, cox[copt], 54, HI_COLOR);
-    draw_text_center("⯆", fb, cox[copt], 84, HI_COLOR);
+    draw_text_center("⯅", fb, cox[copt], 40, HI_COLOR);
+    draw_text_center("⯆", fb, cox[copt], 70, HI_COLOR);
+  } else if (copt == 5) {
+    draw_text_center("⯅", fb, SCREEN_WIDTH/2, 77, HI_COLOR);
+    draw_text_center("⯆", fb, SCREEN_WIDTH/2, 107, HI_COLOR);
   }
 
-  draw_text_center(msgs[ingame_menu_lang][IMENU_UPDAT_RTC], fb, SCREEN_WIDTH/2, 120, copt == 5 ? HI_COLOR : FG_COLOR);
+  char tmp[64];
+  npf_snprintf(tmp, sizeof(tmp), "%s: %s",
+    msgs[ingame_menu_lang][IMENU_RTCSPD],
+    msgs[ingame_menu_lang][rtc_speed ? (IMENU_SPD0 + rtc_speed - 1) : IMENU_FRZRTC]);
+  draw_text_center(tmp, fb, SCREEN_WIDTH/2, 92, copt == 5 ? HI_COLOR : FG_COLOR);
+
+  draw_text_center(msgs[ingame_menu_lang][IMENU_UPDAT_RTC], fb, SCREEN_WIDTH/2, 130, copt == 6 ? HI_COLOR : FG_COLOR);
 }
 
 void draw_cheats_menu(uint8_t *fb, unsigned framen) {
@@ -1031,13 +1043,19 @@ void rtckey(uint16_t keyp) {
       rval[copt]--;
 
     fixdate(&rtc_date);
+  } else if (copt == 5) {
+    if (keyp & KEY_BUTTUP)
+      rtc_speed++;
+    if (keyp & KEY_BUTTDOWN)
+      rtc_speed--;
+
+    rtc_speed = rtc_speed % MAX_SPEED_OPTS;
   }
 }
 
 bool action_write_rtc() {
   // Write to the emulated RTC register
-  // TODO: Allow changing the RTC speed.
-  set_undef_lrsp(date2timestamp(&rtc_date), get_undef_sp());
+  set_undef_lrsp(date2timestamp(&rtc_date), rtc_speed);
 
   submenu = MenuMain;
   copt = 0;
@@ -1078,6 +1096,7 @@ const menu_action_fn rtcacts[] = {
   NULL,
   NULL,
   NULL,
+  NULL,
   action_write_rtc,  // Apply RTC time.
 };
 
@@ -1103,7 +1122,7 @@ const t_menu_def menudata [] = {
   { draw_reset_menu,  resetacts,  NULL,   4, NULL,  true },
   { draw_save_menu,   saveacts,   NULL,   4, NULL,  true },
   { draw_states_menu, statesacts, sstkey, 3, NULL,  true },
-  { draw_rtc_menu,    rtcacts,    rtckey, 6, NULL, false },
+  { draw_rtc_menu,    rtcacts,    rtckey, 7, NULL, false },
   { draw_cheats_menu, cheatsacts, NULL,   0, cheats_cnt,  true },
 };
 
@@ -1191,8 +1210,9 @@ void ingame_menu_loop(uint32_t *use_cheats_hook) {
   num_mem_savestates = MIN(MAX_MEM_SLOTS, (scratch_size >> 10) / SAVESTATE_SIZE_KB);
   num_dsk_savestates = savestate_pattern[0] ? MAX_DISK_SLOTS : 0;
 
-  // Read RTC values
+  // Read RTC values and speed
   timestamp2date(get_undef_lr(), &rtc_date);
+  rtc_speed = get_undef_sp();
 
   // Lazy intialization of the SD card, to avoid blocking the menu
   FATFS fs;

src/menu.c

@@ -2481,7 +2481,7 @@ static void keypress_popup_loadgba(unsigned newkeys) {
 
       t_rtc_info rtci = {
         .timestamp = spop.p.load.l.rtcval,
-        .ts_step = rtc_speed(rtcspeed_default)
+        .ts_step = rtcspeed_default
       };
 
       unsigned err = load_gba_rom(
@@ -2738,7 +2738,7 @@ static void keypress_popup_norload(unsigned newkeys) {
       }
       t_rtc_info rtci = {
         .timestamp = spop.p.norld.l.rtcval,
-        .ts_step = rtc_speed(rtcspeed_default)
+        .ts_step = rtcspeed_default
       };
 
       // TODO Handle errors, finish missing stuff.

src/patches.S

@@ -674,7 +674,7 @@ START_FUNC(patch_rtc_gettimedate)
 1:
   mrs r3, CPSR                 // Save the current CPSR
   msr CPSR_c, $(0x1B | 0x80)   // Move to undefined mode, no interrupts
-  add lr, lr, sp               // UNDEF[SP] contains the read-increment
+  add lr, lr, sp, lsl #3       // UNDEF[SP] contains the RTC speed (0 to 5 -> 0,8,16,24,32,40)
   mov r5, lr                   // Read UNDEF[LR]
   msr CPSR_c, r3               // Restore original model and CPSR