Change some names to libopencm3.

This commit is contained in:
Uwe Hermann 2010-12-30 03:09:35 +01:00
parent deb3db7623
commit 079dc05c73
3 changed files with 19 additions and 12 deletions

View File

@ -18,7 +18,7 @@ Development guidelines
existing files for examples. existing files for examples.
- In general, please try to keep the register and bit naming as close - 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 makes it easier for users to find what they're looking for in the
datasheets, programming manuals, and application notes. datasheets, programming manuals, and application notes.

27
README
View File

@ -2,20 +2,25 @@
README README
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
The libopenstm32 project aims to create an open-source firmware library for The libopencm3 project aims to create an open-source firmware library for
STM32 microcontrollers. 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 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 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 Status and API
-------------- --------------
The libopenstm32 project is currently work in progress. Not all subsystems The libopencm3 project is currently work in progress. Not all subsystems
of the STM32 are supported, yet. of the microcontrollers are supported, yet.
IMPORTANT: The API of the library is NOT yet considered stable! Please do 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. 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 The library ships with a few small example projects which illustrate how
individual subsystems of the SMT32 can be configured and used with individual subsystems of the microcontrollers can be configured and used with
libopenstm32. 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: 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 $ make flash
The Makefiles of the examples are configured to use a certain OpenOCD The Makefiles of the examples are configured to use a certain OpenOCD
@ -85,7 +90,7 @@ See HACKING.
License 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. Public License (GPL), version 3 or later.
See COPYING for details. See COPYING for details.

View File

@ -36,6 +36,7 @@ OBJS += $(BINARY).o
OOCD ?= openocd OOCD ?= openocd
OOCD_INTERFACE ?= flossjtag OOCD_INTERFACE ?= flossjtag
OOCD_BOARD ?= olimex_stm32_h103 OOCD_BOARD ?= olimex_stm32_h103
# FIXME
# Be silent per default, but 'make V=1' will show all compiler calls. # Be silent per default, but 'make V=1' will show all compiler calls.
ifneq ($(V),1) ifneq ($(V),1)
@ -89,6 +90,7 @@ clean:
$(Q)rm -f *.srec $(Q)rm -f *.srec
$(Q)rm -f *.list $(Q)rm -f *.list
# FIXME: Replace STM32 stuff with proper LPC13XX OpenOCD support later.
ifeq ($(OOCD_SERIAL),) ifeq ($(OOCD_SERIAL),)
%.flash: %.hex %.flash: %.hex
@printf " FLASH $<\n" @printf " FLASH $<\n"