M5: commonalized API swipe/keycode implementation

twystd · twystd · commit 6c4e48443232 · 2025-07-24T13:12:20.000-07:00
diff --git a/m5-stack/Rev.0/TODO.md b/m5-stack/Rev.0/TODO.md
@@ -4,8 +4,7 @@
 ## [x] PCB
 ## [x] Design Review
 ## [x] CoreS3
-
-## [ ] Firmware
+## [x] Firmware
    - [x] CLI
    - [x] LED
    - [x] SK6812
@@ -14,17 +13,13 @@
    - [x] UART
    - [x] sys: memory usage
    - [x] USB
-      - [x] bootsel
-      - [x] card
-      - [x] keycode
-      - [x] card + keycode
-      - [x] error/ok
-   - [ ] api.c
+   - [x] api.c
 
-- [ ] Check power module
 - [x] README 
    - [x] photos
 
+- [ ] Check power module
+
 - [ ] USB + MacOS
 
 
diff --git a/m5-stack/Rev.0/firmware/core/include/api.h b/m5-stack/Rev.0/firmware/core/include/api.h
@@ -0,0 +1,4 @@
+#pragma once
+
+const char *swipe(const char *);
+const char *keycode(const char *);
diff --git a/m5-stack/Rev.0/firmware/core/src/api.c b/m5-stack/Rev.0/firmware/core/src/api.c
@@ -0,0 +1,65 @@
+#include <stdint.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <M5.h>
+#include <log.h>
+#include <wiegand.h>
+
+#define LOGTAG "API"
+
+const char *swipe(char *msg) {
+    char *token = strtok(msg, " ,");
+
+    if (token != NULL) {
+        uint32_t u32;
+
+        if (sscanf(msg, "%u", &u32) < 1) {
+            return ERR_BAD_REQUEST;
+        }
+
+        uint32_t facility_code = u32 / 100000;
+        uint32_t card = u32 % 100000;
+        char *code;
+
+        if (facility_code < 1 || facility_code > 255 || card > 65535) {
+            return ERR_BAD_REQUEST;
+        }
+
+        if (!write_card(facility_code, card)) {
+            debugf(LOGTAG, "card %u%05u error", facility_code, card);
+            return ERR_WRITE;
+        }
+
+        if ((code = strtok(NULL, " ,")) != NULL) {
+            int N = strlen(code);
+            for (int i = 0; i < N; i++) {
+                if (!write_keycode(code[i])) {
+                    debugf(LOGTAG, "keycode %c error", code[i]);
+                    return ERR_WRITE;
+                }
+            }
+        }
+
+        return ERR_OK;
+    }
+
+    return "";
+}
+
+const char *keycode(char *msg) {
+    int N = strlen(msg);
+
+    if (N > 0) {
+        for (int i = 0; i < N; i++) {
+            if (!write_keycode(msg[i])) {
+                debugf(LOGTAG, "keycode %c error", msg[i]);
+                return ERR_WRITE;
+            }
+        }
+
+        return ERR_OK;
+    }
+
+    return "";
+}
diff --git a/m5-stack/Rev.0/firmware/core/src/cli.c b/m5-stack/Rev.0/firmware/core/src/cli.c
@@ -27,8 +27,8 @@ void exec(char *cmd);
 
 void set_LED(const char *);
 void blink_LED(const char *);
-void swipe(char *);
-void keypad(const char *);
+void cli_swipe(char *);
+void cli_keypad(const char *);
 void set_keypad_mode(const char *);
 void reboot();
 void bootsel();
@@ -346,9 +346,9 @@ void exec(char *cmd) {
     cli.last.ix = cli.buffer.ix;
 
     if (strncasecmp(cmd, "card ", 5) == 0) {
-        swipe(&cmd[5]);
+        cli_swipe(&cmd[5]);
     } else if (strncasecmp(cmd, "code ", 5) == 0) {
-        keypad(&cmd[5]);
+        cli_keypad(&cmd[5]);
     } else if (strncasecmp(cmd, "set LED ", 8) == 0) {
         set_LED(&cmd[8]);
     } else if (strncasecmp(cmd, "blink ", 6) == 0) {
@@ -397,7 +397,7 @@ void bootsel() {
  *  the command and writes the card and keycode (if present) to the Wiegand
  *  interface.
  */
-void swipe(char *cmd) {
+void cli_swipe(char *cmd) {
     uint32_t facility_code = FACILITY_CODE;
     uint32_t card = 0;
     char *token = strtok(cmd, " ,");
@@ -458,7 +458,7 @@ void swipe(char *cmd) {
  *  Sends the keycode code as 4-bit/8-bit burst mode Wiegand.
  *
  */
-void keypad(const char *cmd) {
+void cli_keypad(const char *cmd) {
     int N = strlen(cmd);
 
     if (N > 0) {
diff --git a/m5-stack/Rev.0/firmware/core/src/uart.c b/m5-stack/Rev.0/firmware/core/src/uart.c
@@ -6,6 +6,7 @@
 #include <tusb.h>
 
 #include <M5.h>
+#include <api.h>
 #include <buffer.h>
 #include <log.h>
 #include <sys.h>
@@ -83,7 +84,7 @@ void uart_exec(const uart_inst_t *, char *);
 void uart_write(const uart_inst_t *, const char *);
 
 void uart_swipe(const uart_inst_t *uart, char *msg);
-void uart_keypad(const uart_inst_t *uart, char *msg);
+void uart_keycode(const uart_inst_t *uart, char *msg);
 
 void uart0_rx(buffer *);
 void uart1_rx(buffer *);
@@ -235,64 +236,23 @@ void uart_exec(const uart_inst_t *uart, char *msg) {
     if (strncasecmp(msg, "swipe ", 6) == 0) {
         uart_swipe(uart, &msg[6]);
     } else if (strncasecmp(msg, "code ", 5) == 0) {
-        uart_keypad(uart, &msg[5]);
+        uart_keycode(uart, &msg[5]);
     }
 }
 
 void uart_swipe(const uart_inst_t *uart, char *msg) {
-    char *token = strtok(msg, " ,");
+    const char *reply = swipe(msg);
 
-    if (token != NULL) {
-        uint32_t u32;
-
-        if (sscanf(msg, "%u", &u32) < 1) {
-            uart_write(uart, ERR_BAD_REQUEST);
-            return;
-        }
-
-        uint32_t facility_code = u32 / 100000;
-        uint32_t card = u32 % 100000;
-        char *code;
-
-        if (facility_code < 1 || facility_code > 255 || card > 65535) {
-            uart_write(uart, ERR_BAD_REQUEST);
-            return;
-        }
-
-        if (!write_card(facility_code, card)) {
-            uart_write(uart, ERR_WRITE);
-            debugf(LOGTAG, "card %u%05u error", facility_code, card);
-            return;
-        }
-
-        if ((code = strtok(NULL, " ,")) != NULL) {
-            int N = strlen(code);
-            for (int i = 0; i < N; i++) {
-                if (!write_keycode(code[i])) {
-                    uart_write(uart, ERR_WRITE);
-                    debugf(LOGTAG, "keycode %c error", code[i]);
-                    return;
-                }
-            }
-        }
-
-        uart_write(uart, ERR_OK);
+    if (strlen(reply) > 0) {
+        uart_write(uart, reply);
     }
 }
 
-void uart_keypad(const uart_inst_t *uart, char *msg) {
-    int N = strlen(msg);
-
-    if (N > 0) {
-        for (int i = 0; i < N; i++) {
-            if (!write_keycode(msg[i])) {
-                uart_write(uart, ERR_WRITE);
-                debugf(LOGTAG, "keycode %c error", msg[i]);
-                return;
-            }
-        }
+void uart_keycode(const uart_inst_t *uart, char *msg) {
+    const char *reply = keycode(msg);
 
-        uart_write(uart, ERR_OK);
+    if (strlen(reply) > 0) {
+        uart_write(uart, reply);
     }
 }
 
diff --git a/m5-stack/Rev.0/firmware/core/src/usb.c b/m5-stack/Rev.0/firmware/core/src/usb.c
@@ -1,6 +1,7 @@
 #include <tusb.h>
 
 #include <M5.h>
+#include <api.h>
 #include <buffer.h>
 #include <log.h>
 #include <sys.h>
@@ -58,8 +59,8 @@ struct {
 void usb_rx(buffer *);
 void usb_rxchar(uint8_t);
 void usb_exec(char *);
-void usb_keypad(char *);
-void usb_swipe(char *);
+void usb_keycode(const char *);
+void usb_swipe(const char *);
 bool usb_write(const char *);
 
 struct rxh RXH = {
@@ -180,64 +181,23 @@ void usb_exec(char *msg) {
     if (strncasecmp(msg, "swipe ", 6) == 0) {
         usb_swipe(&msg[6]);
     } else if (strncasecmp(msg, "code ", 5) == 0) {
-        usb_keypad(&msg[5]);
+        usb_keycode(&msg[5]);
     }
 }
 
-void usb_swipe(char *msg) {
-    char *token = strtok(msg, " ,");
+void usb_swipe(const char *msg) {
+    const char *reply = swipe(msg);
 
-    if (token != NULL) {
-        uint32_t u32;
-
-        if (sscanf(msg, "%u", &u32) < 1) {
-            usb_write(ERR_BAD_REQUEST);
-            return;
-        }
-
-        uint32_t facility_code = u32 / 100000;
-        uint32_t card = u32 % 100000;
-        char *code;
-
-        if (facility_code < 1 || facility_code > 255 || card > 65535) {
-            usb_write(ERR_BAD_REQUEST);
-            return;
-        }
-
-        if (!write_card(facility_code, card)) {
-            usb_write(ERR_WRITE);
-            debugf(LOGTAG, "card %u%05u error", facility_code, card);
-            return;
-        }
-
-        if ((code = strtok(NULL, " ,")) != NULL) {
-            int N = strlen(code);
-            for (int i = 0; i < N; i++) {
-                if (!write_keycode(code[i])) {
-                    usb_write(ERR_WRITE);
-                    debugf(LOGTAG, "keycode %c error", code[i]);
-                    return;
-                }
-            }
-        }
-
-        usb_write(ERR_OK);
+    if (strlen(reply) > 0) {
+        usb_write(reply);
     }
 }
 
-void usb_keypad(char *msg) {
-    int N = strlen(msg);
-
-    if (N > 0) {
-        for (int i = 0; i < N; i++) {
-            if (!write_keycode(msg[i])) {
-                usb_write(ERR_WRITE);
-                debugf(LOGTAG, "keycode %c error", msg[i]);
-                return;
-            }
-        }
+void usb_keycode(const char *msg) {
+    const char *reply = keycode(msg);
 
-        usb_write(ERR_OK);
+    if (strlen(reply) > 0) {
+        usb_write(reply);
     }
 }
 
diff --git a/m5-stack/Rev.0/firmware/tiny-coreS3/CMakeLists.txt b/m5-stack/Rev.0/firmware/tiny-coreS3/CMakeLists.txt
@@ -40,6 +40,7 @@ add_executable(${TARGET_NAME}
   ${CORE}/src/LED.c
   ${CORE}/src/GPIO.c
   ${CORE}/src/wiegand.c
+  ${CORE}/src/api.c
 )
 
 pico_generate_pio_header(
diff --git a/m5-stack/Rev.0/firmware/tiny-usb/CMakeLists.txt b/m5-stack/Rev.0/firmware/tiny-usb/CMakeLists.txt
@@ -41,6 +41,7 @@ add_executable(${TARGET_NAME}
   ${CORE}/src/LED.c
   ${CORE}/src/GPIO.c
   ${CORE}/src/wiegand.c
+  ${CORE}/src/api.c
 )
 
 pico_generate_pio_header(

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ add_executable(${TARGET_NAME}`
`40`	`40`	`${CORE}/src/LED.c`
`41`	`41`	`${CORE}/src/GPIO.c`
`42`	`42`	`${CORE}/src/wiegand.c`
	`43`	`+ ${CORE}/src/api.c`
`43`	`44`	`)`
`44`	`45`
`45`	`46`	`pico_generate_pio_header(`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ add_executable(${TARGET_NAME}`
`41`	`41`	`${CORE}/src/LED.c`
`42`	`42`	`${CORE}/src/GPIO.c`
`43`	`43`	`${CORE}/src/wiegand.c`
	`44`	`+ ${CORE}/src/api.c`
`44`	`45`	`)`
`45`	`46`
`46`	`47`	`pico_generate_pio_header(`