Initial commit with goal file in mind

4 files changed, 210 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4dd3ca8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# Fiddle
+
+Fiddle is a Hardware Memory Address Layout Description Language. From fiddle
+files one can generate code for different languages that provide a thin
+abstraction over the hardware memory addresses.
diff --git a/goal.fiddle b/goal.fiddle
new file mode 100644
index 0000000..1289c87
--- /dev/null
+++ b/goal.fiddle
@@ -0,0 +1,174 @@
+// package for the GPIO system.
+package gpio {
+
+  location gpio_a_base = 0x4800_0000;
+  location gpio_b_base = 0x4800_0400;
+  location gpio_c_base = 0x4800_0400;
+
+  /** IO Data. This is just an expressive boolean. */
+  bittype data_t : enum(1) {
+    low = 0,
+    high = 1,
+  }
+
+  /**
+   * Structure of the GPIO port on an stm32l432
+   */
+  objtype gpio_t {
+    assert_pos(0);
+    reg (32) : {
+      /** The mode for each pin. */
+      mode_r : enum(2) {
+        /** The GPIO pin is used for input. */
+        input = 0b0,
+
+        /** The GPIO pin is used for general output. */
+        general_output = 0b1,
+
+        /**
+         * The GPIO pin is used for whatever the altername function
+         * is defined as (refer to manual).
+         */
+        alternate_function = 0b10,
+
+        /**
+         * The GPIO pin is set to analog.
+         */
+        analog = 0b11,
+      } [16];
+    };
+
+    /** 
+     * The output type.
+     */
+    assert_pos(0x04);
+    reg (32) : {
+      otype_r : enum(1) {
+        /**
+         * The GPIO pin is capable of sinking to ground (for LOW) or providing
+         * power (for HIGH).
+         */
+        push_pull = 0,
+
+        /**
+         * The GPIO pin is only able to sink current (for LOW), or nothing (for
+         * HIGH).
+         */
+        open_drain = 1,
+      }[16];
+
+      reserved(16); // Have to pad out the remaining 16 bits.
+    };
+
+    /**
+     * Sets the speed of the provided GPIO pin.
+     */
+    assert_pos(0x08);
+    reg (32) : {
+      ospeed_r : enum(2) {
+        low = 0,
+        medium = 1,
+        high = 2,
+        very_high = 3,
+      } [16];
+    };
+
+    /**
+     * Pullup/Pulldown type
+     */
+    assert_pos(0x0c);
+    wo reg (32) : {
+      pupd_r : enum(2) {
+        none = 0b0,
+        // Compiles to Gpio::PupdR::PullUp
+        pull_up = 0b1,
+        // Compiles to Gpio::PupdR::PullDown
+        pull_down = 0b10,
+        // Not used, but has to be included to fill out the enum.
+        reserved = 0b11,
+      } [16];
+    };
+
+    /**
+     * Input data register.
+     * 
+     * Reading form the provided pin will yield high if the pin is on, or low if
+     * the pin is low.
+     */
+    assert_pos(0x10);
+    ro reg (32) : {
+      id_r : data_t[16];
+      reserved(16);
+    };
+
+    /**
+     * Output data register.
+     *
+     * Writing to this register sets the appropriate register to low/high.
+     */
+    assert_pos(0x14);
+    wo reg (32) : {
+      rw od_r : data_t[16];
+      reserved(16);
+    };
+
+    /**
+     * The GPIO port bit set/reset register.
+     */
+    assert_pos(0x18);
+    reg bsr_r(32) : {
+      /**
+       * Sets the pins associated with the bits. Like od_r, but can be used to
+       * turn on multiple pins at once.
+       */
+      wo set : (16);
+
+      /**
+       * Resets the pins written to this register.
+       */
+      wo reset : (16);
+    };
+
+    assert_pos(0x1c);
+    reg(32) : {
+      lock : enum(1) {
+        unlocked = 0
+        locked = 1;
+      } [16];
+
+      lockk : (1);
+
+      reserved(15);
+    };
+
+    /**
+     * Alternate function registers (both low/high).
+     * Each nybble refers to a pin.
+     */
+    assert_pos(0x20);
+    reg(64) : {
+      afn : (4)[16];
+    }
+
+    /**
+     * The bit reset register.
+     */
+    assert_pos(0x28);
+    reg(32) : {
+      wo br_r : (16);
+      reserved (16);
+    }
+
+    /**
+     * Analog switch control for the pin.
+     */
+    reg(32) : {
+      asc_r : (16);
+      reserved (16);
+    }
+  }
+
+  object gpio_a at gpio_a_base : gpio_t;
+  object gpio_b at gpio_b_base : gpio_t;
+  object gpio_c at gpio_c_base : gpio_t;
+}
diff --git a/vim/ftplugin/fiddle.vim b/vim/ftplugin/fiddle.vim
new file mode 100644
index 0000000..fc98e3c
--- /dev/null
+++ b/vim/ftplugin/fiddle.vim
@@ -0,0 +1,3 @@
+setlocal comments& comments^=sO:*\ -,mO:*\ \ ,exO:*/
+setlocal fo-=t fo+=croql
+setlocal commentstring=//%s
diff --git a/vim/syntax/fiddle.vim b/vim/syntax/fiddle.vim
new file mode 100644
index 0000000..4bd192c
--- /dev/null
+++ b/vim/syntax/fiddle.vim
@@ -0,0 +1,28 @@
+syn keyword FiddlePackage package nextgroup=FiddleIdent skipwhite
+syn keyword FiddleDecl reg object at location reserved nextgroup=FiddleIdent skipwhite
+syn keyword FiddleTypeDecl objtype regtype bittype nextgroup=FiddleIdent skipwhite
+syn keyword FiddleEnum enum
+syn keyword FiddleBuiltin assert_pos
+syn keyword FiddleModifier wo ro rw
+
+syn match FiddleColon +:+ skipwhite nextgroup=FiddleContainedType
+syn match FiddleContainedType +[a-zA-Z0-9_]\++ contained
+
+syn match FiddleIdent +[A-Za-z0-9_]\++ contained
+
+syn match FiddleComment +\/\/.*$+
+syn region FiddleDocComment start=+/\*\*+ end=+*/+
+
+syn match FiddleNumber +[0-9_]\+\([xb]\)\@!\|0x[0-9A-Fa-f_]\+\|0b[01]\++
+
+hi! link FiddleContainedType Type
+hi! link FiddleModifier StorageClass
+hi! link FiddleBuiltin Function
+hi! link FiddleEnum StorageClass
+hi! link FiddleDecl Type
+hi! link FiddleNumber Number
+hi! link FiddleDocComment Comment
+hi! link FiddleComment Comment
+hi! link FiddlePackage Include
+hi! link FiddleTypeDecl StorageClass
+hi! link FiddleIdent Identifier