Merge pull request #101 from prattmic/master

[fw/stlink] / README

diff --git a/README b/README
index 78858f2cab4819346705e5b91e0e35ab8156d8f2..cd4fc5af5cd119158cb27a2be418cceaac098c45 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,3 @@
-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
 =====
 
 HOWTO
 =====
 


@@ -22,8 +14,9 @@ called stlink and there are 2 versions:
 Common requirements
 ~~~~~~~~~~~~~~~~~~~
 
 Common requirements
 ~~~~~~~~~~~~~~~~~~~
 

-libusb-1.0  (You probably already have this, but you'll need the 
+. libusb-1.0  (You probably already have this, but you'll need the

 development version to compile)
 development version to compile)

+. pkg-config

 
 IF YOU HAVE AN STLINKv1
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 IF YOU HAVE AN STLINKv1
 ~~~~~~~~~~~~~~~~~~~~~~~


@@ -42,13 +35,25 @@ IF YOU HAVE AN STLINKv2
 
 You're ready to go :)
 
 
 You're ready to go :)
 

-To run the gdb server, do (you do not need sudo if you have set up
-permissions correctly):
-$ make && [sudo] ./gdbserver/st-util 
+COMPILING
+~~~~~~~~~
+This project was converted to Autotools by a well meaning individual. The
+following steps will build the project for you.
+
+$ ./autogen.sh
+$ ./configure
+$ make
+
+USING THE GDBSERVER
+~~~~~~~~~~~~~~~~~~~
+To run the gdb server: (you do not need sudo if you have set up
+permissions correctly)
+
+$ make && [sudo] ./st-util

 
 There are a few options:
 
 
 There are a few options:
 

-./gdbserver/st-util - usage:
+./st-util - usage:

 
   -h, --help        Print this help
   -vXX, --verbose=XX    specify a specific verbosity level (0..99)
 
   -h, --help        Print this help
   -vXX, --verbose=XX    specify a specific verbosity level (0..99)


@@ -59,8 +64,21 @@ There are a few options:
   -p 4242, --listen_port=1234
             Set the gdb server listen port. (default port: 4242)
 
   -p 4242, --listen_port=1234
             Set the gdb server listen port. (default port: 4242)
 

-Then, in gdb: (remember, you need to run an _ARM_ gdb, not an x86 gdb)
-(gdb) target remote :4242
+Then, in your project directory, someting like this...
+(remember, you need to run an _ARM_ gdb, not an x86 gdb)
+
+$ arm-none-eabi-gdb fancyblink.elf
+...
+(gdb) tar extended-remote :4242
+...
+(gdb) load
+Loading section .text, size 0x458 lma 0x8000000
+Loading section .data, size 0x8 lma 0x8000458
+Start address 0x80001c1, load size 1120
+Transfer rate: 1 KB/sec, 560 bytes/write.
+(gdb)
+...
+(gdb) continue

 
 Have fun!
 
 
 Have fun!
 


@@ -110,6 +128,7 @@ If you would link your executable to 0x08000000 and then do
 (gdb) load firmware.elf
 then it would be written to the memory.
 
 (gdb) load firmware.elf
 then it would be written to the memory.
 

+

 FAQ
 ===
 
 FAQ
 ===
 


@@ -135,16 +154,18 @@ STLink v1 (as found on the 32VL Discovery board)
 
 Known Working Targets:
 * STM32F100xx (Medium Density VL)
 
 Known Working Targets:
 * STM32F100xx (Medium Density VL)

-* STM32F103 (according to jpa- o n##stm32
+* STM32F103 (according to jpa- on ##stm32)

 
 No information:
 * everything else!
 
 
 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)
 STLink v2 (as found on the 32L and F4 Discovery boards)
 Known Working Targets:
 * STM32F100xx (Medium Density VL, as on the 32VL Discovery board)

-* ?
+* STM32L1xx (STM32L Discovery board)
+* STM32F107RC, STM32L151RB, STM32F205RE and  STM32F405RE  on a custom boards 
+  (https://github.com/UweBonnes/wiki_fuer_alex/layout/usps...)
+* STM32F407xx (STM32F4 Discovery board)

 
 Please report any and all known working combinations so I can update this!
 
 
 Please report any and all known working combinations so I can update this!