Improved README Updated with current lpcprog command line Added supported features
authorNathael Pajani <nathael.pajani@ed3l.fr>
Wed, 6 Nov 2013 00:36:51 +0000 (01:36 +0100)
committerNathael Pajani <nathael.pajani@ed3l.fr>
Tue, 8 Nov 2022 16:03:04 +0000 (17:03 +0100)
README

diff --git a/README b/README
index f50cab5..c0000cc 100644 (file)
--- a/README
+++ b/README
@@ -23,25 +23,59 @@ In order to get the emdebian ARM gcc cross-toolchain you should add this
 repository to your apt sources :
    deb http://www.emdebian.org/debian/ unstable main
 and then update and install package gcc-4.7-arm-linux-gnueabi
-It may be requiered that you create a symlink in /usr/bin for the arm gcc
+It may be required that you create a symlink in /usr/bin for the arm gcc
    cd /usr/bin && ln -s arm-linux-gnueabi-gcc-4.7 arm-linux-gnueabi-gcc
+
 There's no need for the related libc package here, the libc does not fit
-in our microcontroler memory. Instead have a look at the content of the
+in our micro-controller memory. Instead have a look at the content of the
 lib/ directory, and add stuff there.
 
 Once done you should build using the provided makefile by running the
 simple "make" command.
 
 To flash the binary (the one with .bin) to the LPC Flash you will need
-our lpctool package (not yet packaged for Debian as of 2013-03-07)
+our lpctool package (not yet packaged for Debian as of 2013-11-06)
 available in our git repository : http://git.techno-innov.fr/lpctools
 Clone using :
    git clone http://gitclone.techno-innov.fr/lpctools
 Then build (make) and use :)
 Usual command lines :
-   ./lpcprog /dev/ttyUSB0 id
-   ./lpcprog /dev/ttyUSB0 flash mod_gpio.bin -u
-See lpctools readme and lpcprog or isp help (-h) for more info.
+   ./lpcprog -d /dev/ttyUSB0 -c id
+   ./lpcprog -d /dev/ttyUSB0 -c flash mod_gpio.bin
+See lpctools readme and lpcprog or isp help (-h) or manpages for more
+information.
+
+
+********************
+SUPPORTED FEATURES and INTERFACES
+
+- LPC1224 micro-controller definitions
+   - Cortex-M0 specific definitions
+   - Cortex-M0 and LPC1224 Registers
+   - Interrupts
+   - ROM based division routines
+
+- Bootstrap
+   - vector table
+   - reset handler
+
+- System
+   - flash accelerator configuration
+   - watchdog (stop)
+   - clock / PLL config
+   - call of existing/used drivers configuration routines
+
+- Simple C Library
+   - memcpy and memset
+   - strcpy, strncpy, strcmp, strncmp, strchr, strrchr, strlen, strnlen
+   - snprintf, vsnprintf
+
+- Interface drivers
+   - UART
+   - I²C
+   - I²C EEPROM
+   - TMP101 temperature sensor
+   - GPIO
 
 
 ********************