Print undecode chip_id too
[fw/stlink] / README
diff --git a/README b/README
index 109aa25003a298fffa36e4e4412823ff98ef42dd..1eb6d26173fa48103d0036d284afa27889eb22c1 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,11 @@
+IMPORTANT SHORT TERM NOTICE:
+If you are targetting F1 devices, with either stlinkv1 or v2 hardware, you
+_need_ to use karlp's libwork2 branch.  
+
+If you are targetting F4, you _need_ to use texane's master
+
+If you are targetting F2 or L1, please let us know how it goes!
+
 HOWTO
 =====
 
@@ -75,13 +83,13 @@ for GDB.
 Setting up udev rules
 =====================
 
-For convenience, you may install udev rules file, 49-stlinkv2.rules, located
+For convenience, you may install udev rules file, 49-stlinkv*.rules, located
 in the root of repository. You will need to copy it to /etc/udev/rules.d,
 and then either reboot or execute
 $ udevadm control --reload-rules
 
-Udev will now create a /dev/stlinkv2_XX file, with the appropriate permissions.
-This is currently all the device is for, (only one stlinkv2 is supported at 
+Udev will now create a /dev/stlinkv2_XX or /dev/stlinkv1_XX file, with the appropriate permissions.
+This is currently all the device is for, (only one stlink of each version is supported at 
 any time presently)
 
 Running programs from SRAM
@@ -102,6 +110,7 @@ If you would link your executable to 0x08000000 and then do
 (gdb) load firmware.elf
 then it would be written to the memory.
 
+
 FAQ
 ===
 
@@ -119,3 +128,24 @@ Q: At some point I use GDB command `next', and it hangs.
 A: Sometimes when you will try to use GDB `next' command to skip a loop,
 it will use a rather inefficient single-stepping way of doing that.
 Set up a breakpoint manually in that case and do `continue'.
+
+Currently known working combinations of programmer and target
+=============================================================
+
+STLink v1 (as found on the 32VL Discovery board)
+
+Known Working Targets:
+* STM32F100xx (Medium Density VL)
+* STM32F103 (according to jpa- o n##stm32
+
+No information:
+* everything else!
+
+
+STLink v2 (as found on the 32L and F4 Discovery boards)
+Known Working Targets:
+* STM32F100xx (Medium Density VL, as on the 32VL Discovery board)
+* ?
+
+Please report any and all known working combinations so I can update this!
+