Merge pull request #2516 from jepler/runcpm

code for the runcpm guide

Author: TheKitty

runcpm-rp2040-dvi-usb/keyboard-copro/.feather_rp2040_tinyusb.test.only

@@ -0,0 +1,248 @@
+// SPDX-FileCopyrightText: 2023 Jeff Epler for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+// pio-usb is required for rp2040 host
+#include "pio_usb.h"
+#include "Adafruit_TinyUSB.h"
+
+// Pin D+ for host, D- = D+ + 1
+#ifndef PIN_USB_HOST_DP
+#define PIN_USB_HOST_DP       16
+#endif
+
+// Pin for enabling Host VBUS. comment out if not used
+#ifndef PIN_5V_EN
+#define PIN_5V_EN        18
+#endif
+
+#ifndef PIN_5V_EN_STATE
+#define PIN_5V_EN_STATE  1
+#endif
+
+// USB Host object
+Adafruit_USBH_Host USBHost;
+
+// Serial output for RunCPM
+SerialPIO pio_serial(1 /* RX of the sibling board */, SerialPIO::NOPIN);
+
+void setup() {
+}
+
+void loop() {
+}
+
+void setup1() {
+
+#if 0
+  while ( !Serial ) delay(10);   // wait for native usb
+  Serial.println("Core1 setup to run TinyUSB host with pio-usb");
+#endif
+
+  // Check for CPU frequency, must be multiple of 120Mhz for bit-banging USB
+  uint32_t cpu_hz = clock_get_hz(clk_sys);
+  if ( cpu_hz != 120000000UL && cpu_hz != 240000000UL ) {
+    while ( !Serial ) delay(10);   // wait for native usb
+    Serial.printf("Error: CPU Clock = %lu, PIO USB require CPU clock must be multiple of 120 Mhz\r\n", cpu_hz);
+    Serial.printf("Change your CPU Clock to either 120 or 240 Mhz in Menu->CPU Speed \r\n");
+    while (1) delay(1);
+  }
+
+#ifdef PIN_5V_EN
+  pinMode(PIN_5V_EN, OUTPUT);
+  digitalWrite(PIN_5V_EN, PIN_5V_EN_STATE);
+#endif
+
+  pio_usb_configuration_t pio_cfg = PIO_USB_DEFAULT_CONFIG;
+  pio_cfg.pin_dp = PIN_USB_HOST_DP;
+  USBHost.configure_pio_usb(1, &pio_cfg);
+
+  // run host stack on controller (rhport) 1
+  // Note: For rp2040 pico-pio-usb, calling USBHost.begin() on core1 will have most of the
+  // host bit-banging processing works done in core1 to free up core0 for other works
+  USBHost.begin(1);
+
+  // this `begin` is a void function, no way to check for failure!
+  pio_serial.begin(115200);
+}
+
+int old_ascii = -1;
+uint32_t repeat_timeout;
+const uint32_t repeat_time = 150;
+
+void send_ascii(uint8_t code) {
+  old_ascii = code;
+  repeat_timeout = millis() + repeat_time;
+  if (code > 32 && code < 127) {
+    Serial.printf("'%c'\r\n", code);
+  } else {
+    Serial.printf("'\\x%02x'\r\n", code);
+  }
+  pio_serial.write(code);
+}
+
+void loop1()
+{
+  uint32_t now = millis();
+  uint32_t deadline = repeat_timeout - now;
+  if (old_ascii >= 0 && deadline > INT32_MAX) {
+    repeat_timeout += repeat_time;
+    deadline = repeat_timeout - now;
+    send_ascii(old_ascii);
+  } else if (old_ascii < 0) {
+    deadline = UINT32_MAX;
+  }
+  tuh_task_ext(deadline, false);
+}
+
+// Invoked when device with hid interface is mounted
+// Report descriptor is also available for use.
+// tuh_hid_parse_report_descriptor() can be used to parse common/simple enough
+// descriptor. Note: if report descriptor length > CFG_TUH_ENUMERATION_BUFSIZE,
+// it will be skipped therefore report_desc = NULL, desc_len = 0
+void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const *desc_report, uint16_t desc_len) {
+  (void)desc_report;
+  (void)desc_len;
+  uint16_t vid, pid;
+  tuh_vid_pid_get(dev_addr, &vid, &pid);
+
+  Serial.printf("HID device address = %d, instance = %d is mounted\r\n", dev_addr, instance);
+  Serial.printf("VID = %04x, PID = %04x\r\n", vid, pid);
+
+  uint8_t const itf_protocol = tuh_hid_interface_protocol(dev_addr, instance);
+  if (itf_protocol == HID_ITF_PROTOCOL_KEYBOARD) {
+    Serial.printf("HID Keyboard\r\n");
+    if (!tuh_hid_receive_report(dev_addr, instance)) {
+      Serial.printf("Error: cannot request to receive report\r\n");
+    }
+  }
+}
+
+// Invoked when device with hid interface is un-mounted
+void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance) {
+  Serial.printf("HID device address = %d, instance = %d is unmounted\r\n", dev_addr, instance);
+}
+
+#define FLAG_ALPHABETIC (1)
+#define FLAG_SHIFT (2)
+#define FLAG_NUMLOCK (4)
+#define FLAG_CTRL (8)
+#define FLAG_LUT (16)
+
+const char * const lut[] = {
+  "!@#$%^&*()",                              /* 0 - shifted numeric keys */
+  "\r\x1b\10\t -=[]\\#;'`,./",               /* 1 - symbol keys */
+  "\n\x1b\177\t _+{}|~:\"~<>?",              /* 2 - shifted */
+  "\3\4\2\1",                                /* 3 - arrow keys RLDU */
+  "/*-+\n1234567890.",                       /* 4 - keypad w/numlock */
+  "/*-+\n\xff\2\xff\4\xff\3\xff\1\xff\xff.", /* 5 - keypad w/o numlock */
+};
+
+struct keycode_mapper {
+  uint8_t first, last, code, flags;
+} keycode_to_ascii[] = {
+  { HID_KEY_A, HID_KEY_Z, 'a', FLAG_ALPHABETIC, },
+
+  { HID_KEY_1, HID_KEY_9, 0, FLAG_SHIFT | FLAG_LUT, },
+  { HID_KEY_1, HID_KEY_9, '1', 0, },
+  { HID_KEY_0, HID_KEY_0, ')', FLAG_SHIFT, },
+  { HID_KEY_0, HID_KEY_0, '0', 0, },
+
+  { HID_KEY_ENTER, HID_KEY_ENTER, '\n', FLAG_CTRL },
+  { HID_KEY_ENTER, HID_KEY_SLASH, 2, FLAG_SHIFT | FLAG_LUT, },
+  { HID_KEY_ENTER, HID_KEY_SLASH, 1, FLAG_LUT, },
+
+  { HID_KEY_F1, HID_KEY_F1, 0x1e, 0, }, // help key on xerox 820 kbd
+
+  { HID_KEY_ARROW_RIGHT, HID_KEY_ARROW_UP, 3, FLAG_LUT },
+
+  { HID_KEY_KEYPAD_DIVIDE, HID_KEY_KEYPAD_DECIMAL, 4, FLAG_NUMLOCK | FLAG_LUT },
+  { HID_KEY_KEYPAD_DIVIDE, HID_KEY_KEYPAD_DECIMAL, 5, FLAG_LUT },
+};
+
+
+bool report_contains(const hid_keyboard_report_t &report, uint8_t key) {
+  for (int i = 0; i < 6; i++) {
+    if (report.keycode[i] == key) return true;
+  }
+  return false;
+}
+
+hid_keyboard_report_t old_report;
+
+void process_event(uint8_t dev_addr, uint8_t instance, const hid_keyboard_report_t &report) {
+  bool alt = report.modifier & 0x44;
+  bool shift = report.modifier & 0x22;
+  bool ctrl = report.modifier & 0x11;
+  bool caps = old_report.reserved & 1;
+  bool num = old_report.reserved & 2;
+  uint8_t code = 0;
+
+  if (report.keycode[0] == 1 && report.keycode[1] == 1) {
+    // keyboard says it has exceeded max kro
+    return;
+  }
+
+  // something was pressed or release, so cancel any key repeat
+  old_ascii = -1;
+
+  for (auto keycode : report.keycode) {
+    if (keycode == 0) continue;
+    if (report_contains(old_report, keycode)) continue;
+
+    /* key is newly pressed */
+    if (keycode == HID_KEY_NUM_LOCK) {
+      num = !num;
+    } else if (keycode == HID_KEY_CAPS_LOCK) {
+      caps = !caps;
+    } else {
+      for (const auto &mapper : keycode_to_ascii) {
+        if (!(keycode >= mapper.first && keycode <= mapper.last))
+          continue;
+        if (mapper.flags & FLAG_SHIFT && !shift)
+          continue;
+        if (mapper.flags & FLAG_NUMLOCK && !num)
+          continue;
+        if (mapper.flags & FLAG_CTRL && !ctrl)
+          continue;
+        if (mapper.flags & FLAG_LUT) {
+          code = lut[mapper.code][keycode - mapper.first];
+        } else {
+          code = keycode - mapper.first + mapper.code;
+        }
+        if (mapper.flags & FLAG_ALPHABETIC) {
+          if (shift ^ caps) {
+            code ^= ('a' ^ 'A');
+          }
+        }
+        if (ctrl) code &= 0x1f;
+        if (alt) code ^= 0x80;
+        send_ascii(code);
+        break;
+      }
+    }
+  }
+
+  uint8_t leds = (caps | (num << 1));
+  if (leds != old_report.reserved) {
+    Serial.printf("Send LEDs report %d (dev:instance = %d:%d)\r\n", leds, dev_addr, instance);
+    // no worky
+    auto r = tuh_hid_set_report(dev_addr, instance/*idx*/, 0/*report_id*/, HID_REPORT_TYPE_OUTPUT/*report_type*/, &leds, sizeof(leds));
+    Serial.printf("set_report() -> %d\n", (int)r);
+  }
+  old_report = report;
+  old_report.reserved = leds;
+}
+
+// Invoked when received report from device via interrupt endpoint
+void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t const *report, uint16_t len) {
+  if ( len != sizeof(hid_keyboard_report_t) ) {
+    Serial.printf("report len = %u NOT 8, probably something wrong !!\r\n", len);
+  } else {
+    process_event(dev_addr, instance, *(hid_keyboard_report_t*)report);
+  }
+  // continue to request to receive report
+  if (!tuh_hid_receive_report(dev_addr, instance)) {
+    Serial.printf("Error: cannot request to receive report\r\n");
+  }
+}

runcpm-rp2040-dvi-usb/keyboard-copro/keyboard-copro.ino

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mockba the Borg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

runcpm-rp2040-dvi-usb/runcpm-pico/.feather_rp2040_tinyusb.test.only

@@ -0,0 +1,31 @@
+<!--
+SPDX-FileCopyrightText: 2023 Jeff Epler for Adafruit Industries
+
+SPDX-License-Identifier: MIT
+-->
+
+This is a port of runcpm to the raspberry pi pico.
+
+It is based on:
+ * [RunCPM](https://github.com/MockbaTheBorg/RunCPM/)
+ * [RunCPM_RPi_Pico](https://github.com/guidol70/RunCPM_RPi_Pico)
+
+It works on a Raspberry Pi Pico (or Pico W). It uses the internal flash
+for storage, and can be mounted as USB storage.
+
+If your Pico is placed on the Pico DV carrier board, you also get a 100x30
+character screen to enjoy your CP/M output on!
+
+First, build for your device. You must
+ * Use the Philhower Pico Core
+ * In the Tools menu, select
+   * A flash size option that includes at least 512kB for filesystem
+   * USB Stack: Adafruit TinyUSB
+
+After it boots the first time, you need to
+ * Format the flash device on your host computer
+ * Create the folder "<DEVICE>/A/0"
+ * Put something useful in that folder, such as [Zork](http://www.retroarchive.org/cpm/games/zork123_80.zip)
+   * Files must respect the "8.3" naming convention (8 letters filename + 3 letters extension) and be all uppercase
+ * Safely eject the drive, then reset the emulator.
+ * Now at the "A0>" prompt you can run "ZORK1".