diff --git a/HACKING b/HACKING index 755b3386..daffdb2d 100644 --- a/HACKING +++ b/HACKING @@ -18,7 +18,7 @@ Development guidelines existing files for examples. - In general, please try to keep the register and bit naming as close - as possible to the official ST datasheets. Among other reasons, this + as possible to the official vendor datasheets. Among other reasons, this makes it easier for users to find what they're looking for in the datasheets, programming manuals, and application notes. diff --git a/README b/README index 1a3784c4..33fb3d5a 100644 --- a/README +++ b/README @@ -2,20 +2,25 @@ README ------------------------------------------------------------------------------ -The libopenstm32 project aims to create an open-source firmware library for -STM32 microcontrollers. +The libopencm3 project aims to create an open-source firmware library for +various ARM Cortex-M3 microcontrollers. -It is written completely from scratch based on the STM32 datasheets, +Currently (at least partly) supported microcontrollers: + + - ST STM32 + - NXP LPC1311/13/42/43 + +The library is written completely from scratch based on the vendor datasheets, programming manuals, and application notes. The code is meant to be used with a GCC toolchain for ARM (arm-elf or arm-none-eabi), flashing of the -code to an STM32 device can be done using the OpenOCD ARM JTAG software. +code to a microcontroller can be done using the OpenOCD ARM JTAG software. Status and API -------------- -The libopenstm32 project is currently work in progress. Not all subsystems -of the STM32 are supported, yet. +The libopencm3 project is currently work in progress. Not all subsystems +of the microcontrollers are supported, yet. IMPORTANT: The API of the library is NOT yet considered stable! Please do not rely on it, yet! Changes to function names, macro names etc. @@ -39,13 +44,13 @@ Example projects ---------------- The library ships with a few small example projects which illustrate how -individual subsystems of the SMT32 can be configured and used with -libopenstm32. +individual subsystems of the microcontrollers can be configured and used with +libopencm3. -For flashing the 'miniblink' example (after you built libopenstm32 and the +For flashing the 'miniblink' example (after you built libopencm3 and the examples by typing 'make' at the top-level directory) you can execute: - $ cd examples/stm32-h103/miniblink + $ cd examples/stm32/stm32-h103/miniblink $ make flash The Makefiles of the examples are configured to use a certain OpenOCD @@ -85,7 +90,7 @@ See HACKING. License ------- -The libopenstm32 code is released under the terms of the GNU General +The libopencm3 code is released under the terms of the GNU General Public License (GPL), version 3 or later. See COPYING for details. diff --git a/examples/lpc13xx/Makefile.include b/examples/lpc13xx/Makefile.include index 63a2633d..c6ac67c1 100644 --- a/examples/lpc13xx/Makefile.include +++ b/examples/lpc13xx/Makefile.include @@ -36,6 +36,7 @@ OBJS += $(BINARY).o OOCD ?= openocd OOCD_INTERFACE ?= flossjtag OOCD_BOARD ?= olimex_stm32_h103 +# FIXME # Be silent per default, but 'make V=1' will show all compiler calls. ifneq ($(V),1) @@ -89,6 +90,7 @@ clean: $(Q)rm -f *.srec $(Q)rm -f *.list +# FIXME: Replace STM32 stuff with proper LPC13XX OpenOCD support later. ifeq ($(OOCD_SERIAL),) %.flash: %.hex @printf " FLASH $<\n"