Start documenting hardware, add OpenOCD config

ah- · Feb 28, 2018 · 7c7060b · 7c7060b
1 parent 5b0ce60
commit 7c7060b
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.DS_Store
+.gdb_history
+Cargo.lock
+*.bin
+*.dfu
+target/
diff --git a/anne.cfg b/anne.cfg
@@ -0,0 +1,4 @@
+source [find interface/stlink-v2-1.cfg]
+source [find board/st_nucleo_l1.cfg]
+reset_config none separate
+#reset_config srst_only srst_nogate connect_assert_srst
diff --git a/docs/hardware.md b/docs/hardware.md
@@ -0,0 +1,30 @@
+Hardware
+========
+
+![Anne](images/anne-white.jpg)
+
+The Anne Pro contains 3 MCUs to handle each of the Keyboard, LED and BLE operations:
+
+- Keyboard: STM32L151C8T6
+- LED: STM32L151C8T6
+- BLE: TI CC2541
+
+The USB charging circuit is a BQ24075.
+
+You can find some more information including pin assignments at https://github.com/hi-a/annepro-key
+
+Flashing and debugging
+----------------------
+
+To develop it's best to directly flash via the debug pins instead of DFU, so you get full debugging support and even working stdout to your host machine.
+
+Any ST-Link v2 programmer will do. You can find them cheap on ebay, or if you already have a STM32 Nucleo board you can use the programmer of that.
+
+All the debug pins are exposed and easily accessible. Just solder on some wires and connect to your programmer:
+
+![PCB](images/pcb.png)
+
+OpenOCD
+-------
+
+Once your programmer is connected start `openocd -f anne.cfg`.
diff --git a/docs/images/anne-white.jpg b/docs/images/anne-white.jpg
diff --git a/docs/images/pcb.png b/docs/images/pcb.png