Pulled interrupts into an optional module.

Author: flagxor

Makefile

@@ -167,15 +167,15 @@ clean-esp32:
 
 vet:
 	$(MAKE) clean
-	$(MAKE) all
+	$(MAKE)
 	$(MAKE) esp32-build
 	$(MAKE) esp32s2-build
 	$(MAKE) esp32c3-build
 	$(MAKE) clean-esp32
 	$(MAKE) add-optional
 	$(MAKE) esp32-build
 	$(MAKE) clean
-	$(MAKE) all
+	$(MAKE)
 
 clean:
 	rm -rf $(OUT)
@@ -292,7 +292,7 @@ ESP32_BOOT = $(COMMON_PHASE1) \
              $(COMMON_PHASE2) $(COMMON_FILETOOLS) \
              esp32/platform.fs \
              posix/httpd.fs posix/web_interface.fs esp32/web_interface.fs \
-             esp32/registers.fs esp32/timers.fs \
+             esp32/registers.fs \
              posix/telnetd.fs \
              esp32/optionals.fs \
              esp32/autoboot.fs common/fini.fs
@@ -325,6 +325,14 @@ $(GEN)/esp32_camera.h: \
     esp32/optional/camera/camera.fs \
     esp32/optional/camera/camera_server.fs >$@
 
+$(GEN)/esp32_interrupts.h: \
+    tools/source_to_string.js \
+    esp32/optional/interrupts/interrupts.fs \
+    esp32/optional/interrupts/timers.fs | $(GEN)
+	$< interrupts_source $(VERSION) $(REVISION) \
+    esp32/optional/interrupts/interrupts.fs \
+    esp32/optional/interrupts/timers.fs >$@
+
 $(GEN)/esp32_oled.h: \
     tools/source_to_string.js esp32/optional/oled/oled.fs | $(GEN)
 	$< oled_source $(VERSION) $(REVISION) \
@@ -347,6 +355,7 @@ OPTIONAL_MODULES = \
   $(ESP32)/ESP32forth/assemblers.h \
   $(ESP32)/ESP32forth/camera.h \
   $(ESP32)/ESP32forth/oled.h \
+  $(ESP32)/ESP32forth/interrupts.h \
   $(ESP32)/ESP32forth/rmt.h \
   $(ESP32)/ESP32forth/serial-bluetooth.h \
   $(ESP32)/ESP32forth/spi-flash.h
@@ -650,6 +659,15 @@ $(ESP32)/ESP32forth/optional/camera.h: \
      camera=@$(GEN)/esp32_camera.h \
      >$@
 
+$(ESP32)/ESP32forth/optional/interrupts.h: \
+    esp32/optional/interrupts/interrupts.h \
+    $(GEN)/esp32_interrupts.h | $(ESP32)/ESP32forth/optional
+	cat esp32/optional/interrupts/interrupts.h | tools/replace.js \
+     VERSION=$(VERSION) \
+     REVISION=$(REVISION) \
+     interrupts=@$(GEN)/esp32_interrupts.h \
+     >$@
+
 $(ESP32)/ESP32forth/optional/oled.h: \
     esp32/optional/oled/oled.h \
     $(GEN)/esp32_oled.h | $(ESP32)/ESP32forth/optional
@@ -784,6 +802,7 @@ $(ESP32)/ESP32forth.zip: \
     $(ESP32)/ESP32forth/optional/assemblers.h \
     $(ESP32)/ESP32forth/optional/camera.h \
     $(ESP32)/ESP32forth/optional/oled.h \
+    $(ESP32)/ESP32forth/optional/interrupts.h \
     $(ESP32)/ESP32forth/optional/rmt.h \
     $(ESP32)/ESP32forth/optional/serial-bluetooth.h \
     $(ESP32)/ESP32forth/optional/spi-flash.h

common/bits.h

@@ -37,3 +37,6 @@ typedef struct {
   void *DOCREATE_OP;
   const BUILTIN_WORD *builtins;
 } G_SYS;
+
+static G_SYS *g_sys = 0;
+static cell_t *forth_run(cell_t *init_rp);

common/core.h

@@ -43,8 +43,6 @@ enum {
 #undef V
 };
 
-static G_SYS *g_sys = 0;
-
 static cell_t convert(const char *pos, cell_t n, cell_t base, cell_t *ret) {
   *ret = 0;
   cell_t negate = 0;

common/forth_namespace_tests.fs

@@ -623,7 +623,6 @@ e: test-esp32-forth-voclist
   out: streams 
   out: tasks 
   out: rtos 
-  out: interrupts 
   out: sockets 
   out: Serial 
   out: ledc 
@@ -682,7 +681,6 @@ e: check-esp32-builtins
 
 e: check-esp32-bindings
   out: rtos 
-  out: interrupts 
   out: sockets 
   out: Serial 
   out: ledc 
@@ -699,7 +697,6 @@ e: test-esp32-forth-namespace
   ' forth list-from
   out: FORTH 
   out: telnetd 
-  out: timers 
   out: registers 
   out: webui 
   out: login 

esp32/ESP32forth.ino

@@ -26,6 +26,7 @@
 {{tier2_opcodes}}
 {{floats}}
 {{calls}}
+{{bits}}
 {{builtins.h}}
 {{builtins.cpp}}
 {{main.cpp}}

esp32/bindings.fs

@@ -79,30 +79,6 @@ transfer sockets-builtins
 : ip. ( n -- ) ip# ip# ip# 255 and n. ;
 forth definitions
 
-vocabulary interrupts   interrupts definitions
-transfer interrupts-builtins
-DEFINED? gpio_config [IF]
-0 constant ESP_INTR_FLAG_DEFAULT
-: ESP_INTR_FLAG_LEVELn ( n=1-6 -- n ) 1 swap lshift ;
-1 7 lshift constant ESP_INTR_FLAG_NMI
-1 8 lshift constant ESP_INTR_FLAG_SHARED
-1 9 lshift constant ESP_INTR_FLAG_EDGE
-1 10 lshift constant ESP_INTR_FLAG_IRAM
-1 11 lshift constant ESP_INTR_FLAG_INTRDISABLED
-( Prefix these with # because GPIO_INTR_DISABLE conflicts with a function. )
-0 constant #GPIO_INTR_DISABLE
-1 constant #GPIO_INTR_POSEDGE
-2 constant #GPIO_INTR_NEGEDGE
-3 constant #GPIO_INTR_ANYEDGE
-4 constant #GPIO_INTR_LOW_LEVEL
-5 constant #GPIO_INTR_HIGH_LEVEL
-( Easy word to trigger on any change to a pin )
-ESP_INTR_FLAG_DEFAULT gpio_install_isr_service drop
-: pinchange ( xt pin ) dup #GPIO_INTR_ANYEDGE gpio_set_intr_type throw
-                       swap 0 gpio_isr_handler_add throw ;
-[THEN]
-forth definitions
-
 vocabulary rtos   rtos definitions
 transfer rtos-builtins
 forth definitions

esp32/builtins.cpp

@@ -15,7 +15,6 @@
 static char filename[PATH_MAX];
 static char filename2[PATH_MAX];
 
-{{bits}}
 {{core}}
 {{faults}}
 {{calling}}
@@ -52,63 +51,3 @@ static cell_t ResizeFile(cell_t fd, cell_t size) {
   if (t < 0) { return errno; }
   return 0;
 }
-
-#ifdef ENABLE_INTERRUPTS_SUPPORT
-struct handle_interrupt_args {
-  cell_t xt;
-  cell_t arg;
-};
-
-static void IRAM_ATTR HandleInterrupt(void *arg) {
-  struct handle_interrupt_args *args = (struct handle_interrupt_args *) arg;
-  cell_t code[2];
-  code[0] = args->xt;
-  code[1] = g_sys->YIELD_XT;
-  cell_t fstack[INTERRUPT_STACK_CELLS];
-  cell_t rstack[INTERRUPT_STACK_CELLS];
-  cell_t stack[INTERRUPT_STACK_CELLS];
-  stack[0] = args->arg;
-  cell_t *rp = rstack;
-  *++rp = (cell_t) code;
-  *++rp = (cell_t) (fstack + 1);
-  *++rp = (cell_t) (stack + 1);
-  forth_run(rp);
-}
-
-static bool IRAM_ATTR HandleInterruptAndRet(void *arg) {
-  HandleInterrupt(arg);
-  return true;
-}
-
-static cell_t EspIntrAlloc(cell_t source, cell_t flags, cell_t xt, cell_t arg, void *ret) {
-  // NOTE: Leaks memory.
-  struct handle_interrupt_args *args = (struct handle_interrupt_args *) malloc(sizeof(struct handle_interrupt_args));
-  args->xt = xt;
-  args->arg = arg;
-  return esp_intr_alloc(source, flags, HandleInterrupt, args, (intr_handle_t *) ret);
-}
-
-static cell_t GpioIsrHandlerAdd(cell_t pin, cell_t xt, cell_t arg) {
-  // NOTE: Leaks memory.
-  struct handle_interrupt_args *args = (struct handle_interrupt_args *) malloc(sizeof(struct handle_interrupt_args));
-  args->xt = xt;
-  args->arg = arg;
-  return gpio_isr_handler_add((gpio_num_t) pin, HandleInterrupt, args);
-}
-
-static void TimerInitNull(cell_t group, cell_t timer) {
-  // Seems to be required starting in the 2.0 IDE.
-  timer_config_t config;
-  memset(&config, 0, sizeof(config));
-  config.divider = 2;
-  timer_init((timer_group_t) group, (timer_idx_t) timer, &config);
-}
-
-static cell_t TimerIsrCallbackAdd(cell_t group, cell_t timer, cell_t xt, cell_t arg, cell_t flags) {
-  // NOTE: Leaks memory.
-  struct handle_interrupt_args *args = (struct handle_interrupt_args *) malloc(sizeof(struct handle_interrupt_args));
-  args->xt = xt;
-  args->arg = arg;
-  return timer_isr_callback_add((timer_group_t) group, (timer_idx_t) timer, HandleInterruptAndRet, args, flags);
-}
-#endif

esp32/builtins.h

@@ -36,6 +36,14 @@
 #  define OPTIONAL_ASSEMBLERS_SUPPORT
 # endif
 
+// Hook to pull in optional interrupts and timers support.
+# if __has_include("interrupts.h")
+#  include "interrupts.h"
+# else
+#  define OPTIONAL_INTERRUPTS_VOCABULARIES
+#  define OPTIONAL_INTERRUPTS_SUPPORT
+# endif
+
 // Hook to pull in optional Oled support.
 # if __has_include("oled.h")
 #  include "oled.h"
@@ -101,13 +109,13 @@ static cell_t ResizeFile(cell_t fd, cell_t size);
   OPTIONAL_I2C_SUPPORT \
   OPTIONAL_SOCKETS_SUPPORT \
   OPTIONAL_FREERTOS_SUPPORT \
-  OPTIONAL_INTERRUPTS_SUPPORT \
   CALLING_OPCODE_LIST \
   FLOATING_POINT_LIST
 
 #define EXTERNAL_OPTIONAL_MODULE_SUPPORT \
   OPTIONAL_ASSEMBLERS_SUPPORT \
   OPTIONAL_CAMERA_SUPPORT \
+  OPTIONAL_INTERRUPTS_SUPPORT \
   OPTIONAL_OLED_SUPPORT \
   OPTIONAL_RMT_SUPPORT \
   OPTIONAL_SERIAL_BLUETOOTH_SUPPORT \
@@ -278,85 +286,6 @@ static cell_t ResizeFile(cell_t fd, cell_t size);
   YV(rtos, xPortGetCoreID, PUSH xPortGetCoreID())
 #endif
 
-#ifndef ENABLE_INTERRUPTS_SUPPORT
-# define OPTIONAL_INTERRUPTS_SUPPORT
-#else
-# ifndef SIM_PRINT_ONLY
-#  include "esp_intr_alloc.h"
-#  include "driver/timer.h"
-#  include "driver/gpio.h"
-static cell_t EspIntrAlloc(cell_t source, cell_t flags, cell_t xt, cell_t arg, void *ret);
-static cell_t GpioIsrHandlerAdd(cell_t pin, cell_t xt, cell_t arg);
-static cell_t TimerIsrCallbackAdd(cell_t group, cell_t timer, cell_t xt, cell_t arg, cell_t flags);
-static void TimerInitNull(cell_t group, cell_t timer);
-# endif
-# define OPTIONAL_INTERRUPTS_SUPPORT \
-  YV(interrupts, gpio_config, n0 = gpio_config((const gpio_config_t *) a0)) \
-  YV(interrupts, gpio_reset_pin, n0 = gpio_reset_pin((gpio_num_t) n0)) \
-  YV(interrupts, gpio_set_intr_type, n0 = gpio_set_intr_type((gpio_num_t) n1, (gpio_int_type_t) n0); NIP) \
-  YV(interrupts, gpio_intr_enable, n0 = gpio_intr_enable((gpio_num_t) n0)) \
-  YV(interrupts, gpio_intr_disable, n0 = gpio_intr_disable((gpio_num_t) n0)) \
-  YV(interrupts, gpio_set_level, n0 = gpio_set_level((gpio_num_t) n1, n0); NIP) \
-  YV(interrupts, gpio_get_level, n0 = gpio_get_level((gpio_num_t) n0)) \
-  YV(interrupts, gpio_set_direction, n0 = gpio_set_direction((gpio_num_t) n1, (gpio_mode_t) n0); NIP) \
-  YV(interrupts, gpio_set_pull_mode, n0 = gpio_set_pull_mode((gpio_num_t) n1, (gpio_pull_mode_t) n0); NIP) \
-  YV(interrupts, gpio_wakeup_enable, n0 = gpio_wakeup_enable((gpio_num_t) n1, (gpio_int_type_t) n0); NIP) \
-  YV(interrupts, gpio_wakeup_disable, n0 = gpio_wakeup_disable((gpio_num_t) n0)) \
-  YV(interrupts, gpio_pullup_en, n0 = gpio_pullup_en((gpio_num_t) n0)) \
-  YV(interrupts, gpio_pullup_dis, n0 = gpio_pullup_dis((gpio_num_t) n0)) \
-  YV(interrupts, gpio_pulldown_en, n0 = gpio_pulldown_en((gpio_num_t) n0)) \
-  YV(interrupts, gpio_pulldown_dis, n0 = gpio_pulldown_dis((gpio_num_t) n0)) \
-  YV(interrupts, gpio_hold_en, n0 = gpio_hold_en((gpio_num_t) n0)) \
-  YV(interrupts, gpio_hold_dis, n0 = gpio_hold_dis((gpio_num_t) n0)) \
-  YV(interrupts, gpio_deep_sleep_hold_en, gpio_deep_sleep_hold_en()) \
-  YV(interrupts, gpio_deep_sleep_hold_dis, gpio_deep_sleep_hold_dis()) \
-  YV(interrupts, gpio_install_isr_service, n0 = gpio_install_isr_service(n0)) \
-  YV(interrupts, gpio_uninstall_isr_service, gpio_uninstall_isr_service()) \
-  YV(interrupts, gpio_isr_handler_add, n0 = GpioIsrHandlerAdd(n2, n1, n0); NIPn(2)) \
-  YV(interrupts, gpio_isr_handler_remove, n0 = gpio_isr_handler_remove((gpio_num_t) n0)) \
-  YV(interrupts, gpio_set_drive_capability, n0 = gpio_set_drive_capability((gpio_num_t) n1, (gpio_drive_cap_t) n0); NIP) \
-  YV(interrupts, gpio_get_drive_capability, n0 = gpio_get_drive_capability((gpio_num_t) n1, (gpio_drive_cap_t *) a0); NIP) \
-  YV(interrupts, esp_intr_alloc, n0 = EspIntrAlloc(n4, n3, n2, n1, a0); NIPn(4)) \
-  YV(interrupts, esp_intr_free, n0 = esp_intr_free((intr_handle_t) n0)) \
-  YV(timers, timer_isr_callback_add, n0 = TimerIsrCallbackAdd(n4, n3, n2, n1, n0); NIPn(4)) \
-  YV(timers, timer_init_null, TimerInitNull(n1, n0); DROPn(2)) \
-  YV(timers, timer_get_counter_value, \
-      n0 = timer_get_counter_value((timer_group_t) n2, (timer_idx_t) n1, \
-                                   (uint64_t *) a0); NIPn(2)) \
-  YV(timers, timer_set_counter_value, \
-      uint64_t val = *(uint64_t *) a0; \
-      n0 = timer_set_counter_value((timer_group_t) n2, (timer_idx_t) n1, val); NIPn(2)) \
-  YV(timers, timer_start, \
-      n0 = timer_start((timer_group_t) n1, (timer_idx_t) n0); NIP) \
-  YV(timers, timer_pause, \
-      n0 = timer_pause((timer_group_t) n1, (timer_idx_t) n0); NIP) \
-  YV(timers, timer_set_counter_mode, \
-      n0 = timer_set_counter_mode((timer_group_t) n2, (timer_idx_t) n1, \
-                                  (timer_count_dir_t) n0); NIPn(2)) \
-  YV(timers, timer_set_auto_reload, \
-      n0 = timer_set_auto_reload((timer_group_t) n2, (timer_idx_t) n1, \
-                                 (timer_autoreload_t) n0); NIPn(2)) \
-  YV(timers, timer_set_divider, \
-      n0 = timer_set_divider((timer_group_t) n2, (timer_idx_t) n1, n0); NIPn(2)) \
-  YV(timers, timer_set_alarm_value, uint64_t val = *(uint64_t *) a0; \
-      n0 = timer_set_alarm_value((timer_group_t) n2, (timer_idx_t) n1, val); NIPn(2)) \
-  YV(timers, timer_get_alarm_value, \
-      n0 = timer_get_alarm_value((timer_group_t) n2, (timer_idx_t) n1, \
-                                 (uint64_t *) a0); NIPn(2)) \
-  YV(timers, timer_set_alarm, \
-      n0 = timer_set_alarm((timer_group_t) n2, (timer_idx_t) n1, \
-                           (timer_alarm_t) n0); NIPn(2)) \
-  YV(timers, timer_group_intr_enable, \
-      n0 = timer_group_intr_enable((timer_group_t) n1, (timer_intr_t) n0); NIP) \
-  YV(timers, timer_group_intr_disable, \
-      n0 = timer_group_intr_disable((timer_group_t) n1, (timer_intr_t) n0); NIP) \
-  YV(timers, timer_enable_intr, \
-      n0 = timer_enable_intr((timer_group_t) n1, (timer_idx_t) n0); NIP) \
-  YV(timers, timer_disable_intr, \
-      n0 = timer_disable_intr((timer_group_t) n1, (timer_idx_t) n0); NIP)
-
-#endif
-
 #ifndef ENABLE_SOCKETS_SUPPORT
 # define OPTIONAL_SOCKETS_SUPPORT
 #else

esp32/optional/interrupts/interrupts.fs

@@ -0,0 +1,37 @@
+\ Copyright 2023 Bradley D. Nelson
+\
+\ Licensed under the Apache License, Version 2.0 (the "License");
+\ you may not use this file except in compliance with the License.
+\ You may obtain a copy of the License at
+\
+\     http://www.apache.org/licenses/LICENSE-2.0
+\
+\ Unless required by applicable law or agreed to in writing, software
+\ distributed under the License is distributed on an "AS IS" BASIS,
+\ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+\ See the License for the specific language governing permissions and
+\ limitations under the License.
+
+vocabulary interrupts   interrupts definitions
+transfer interrupts-builtins
+DEFINED? gpio_config [IF]
+0 constant ESP_INTR_FLAG_DEFAULT
+: ESP_INTR_FLAG_LEVELn ( n=1-6 -- n ) 1 swap lshift ;
+1 7 lshift constant ESP_INTR_FLAG_NMI
+1 8 lshift constant ESP_INTR_FLAG_SHARED
+1 9 lshift constant ESP_INTR_FLAG_EDGE
+1 10 lshift constant ESP_INTR_FLAG_IRAM
+1 11 lshift constant ESP_INTR_FLAG_INTRDISABLED
+( Prefix these with # because GPIO_INTR_DISABLE conflicts with a function. )
+0 constant #GPIO_INTR_DISABLE
+1 constant #GPIO_INTR_POSEDGE
+2 constant #GPIO_INTR_NEGEDGE
+3 constant #GPIO_INTR_ANYEDGE
+4 constant #GPIO_INTR_LOW_LEVEL
+5 constant #GPIO_INTR_HIGH_LEVEL
+( Easy word to trigger on any change to a pin )
+ESP_INTR_FLAG_DEFAULT gpio_install_isr_service drop
+: pinchange ( xt pin ) dup #GPIO_INTR_ANYEDGE gpio_set_intr_type throw
+                       swap 0 gpio_isr_handler_add throw ;
+[THEN]
+forth definitions