Initial Example Project with Readme.

Author: jameswalmsley

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "bitthunder"]
+	path = bitthunder
+	url = git://github.com/jameswalmsley/bitthunder.git

Kconfig

@@ -0,0 +1,9 @@
+comment "Example Project Configuration"
+
+# Add as many dependencies as this BSP requires. I.e. MUST haves for this board.
+# E.g. select SHELL etc.
+
+config PROJECT_DEPENDENCIES
+           bool
+           default      y
+           select       SHELL

Makefile

@@ -0,0 +1,30 @@
+#
+#	Example Makefile for a BitThunder Project.
+#
+
+# Get a clean make.
+MAKEFLAGS += --no-print-directory
+
+# Set the APP_DIR path (i.e. the current directory).
+APP_DIR="$(shell pwd)/"
+
+# Ensure a .config file has been created and copied to the bitthunder root.
+# APP_DIR is passed to the sub-make, and APP_CONFIG is set (allowing use of application config).
+all: .config
+	@cp .config bitthunder/.config
+	@$(MAKE) -C bitthunder APP_DIR=$(APP_DIR) APP_CONFIG=y
+
+# Proxy command to invoke the menuconfig correctly etc.
+# APP_BSP_CONFIG allows a separate BSP Kconfig to be used, and APP_BSP_DIR is the path to it.
+menuconfig:
+	-@cp -f .config bitthunder/.config
+	@$(MAKE) -C bitthunder APP_DIR=$(APP_DIR) APP_CONFIG=y menuconfig APP_BSP_CONFIG=y APP_BSP_DIR=../bsp
+	@cp bitthunder/.config .config
+
+# Call make with menuconfig to produce a valid configuration file.
+.config:
+	@$(MAKE) menuconfig APP_DIR=$(APP_DIR)
+
+# Proxy command for cleaning.
+clean:
+	@$(MAKE) -C bitthunder APP_DIR=$(APP_DIR) APP_CONFIG=y clean

README.md

@@ -0,0 +1,46 @@
+This is an example BitThunder project.
+
+To build follow the steps below:
+
+# 1. Create a valid configuration
+
+    make menuconfig
+
+## Compiler
+
+Be sure to set the compiler location under Build System -> Toolchain Prefix
+e.g. if your compiler is located at:
+
+/opt/codesourcery/bin
+
+Then your prefix is /opt/codesourcery/bin/arm-none-eabi- or something similar.
+
+## Select Architecture and CPU
+Just the relevent architecture under the System Architecture menu. E.g. for STM32 choose ARM
+and STM32 :)
+
+## Linking / Memory Definitions
+
+BitThunder generates a linker description file automatically, but it needs to know
+what memories are available on your device.
+
+Under the System Architecture menu, configure the Linking (new versions call this Memory)
+parameters.
+
+Currently BT supports 3 different kinds of memories. Simply enable at least one of them,
+and define the start address and length in HEX. (One must be Read/Writable, e.g. at least an SRAM).
+
+You can also request different sections to placed in different memories.
+For micro-controllers you will usually have a FLASH and SRAM. Enable both, and ensure that
+INIT and TEXT reside in FLASH, where Data and BSS reside in SRAM.
+
+Leave the initial stack sizes as default.
+
+## Exit and Save the configuration
+
+# 2. Compile your kernel.
+
+    make
+
+This should compile a valid bitthunder kernel for your platform.
+Files are output in the bsp folder, e.g. example.elf and example.list ...

bitthunder

@@ -0,0 +1,9 @@
+comment "Example BSP options"
+
+config BSP_DIR
+           string
+           default "../bsp/"
+
+config BSP_NAME
+           string
+           default "Example"

bsp/.config.mk

@@ -0,0 +1,40 @@
+#
+#   BSP Makefile for Example project.
+#
+
+BINARY_NAME=example
+BASE=$(shell pwd)/../bitthunder/
+BUILD_BASE=$(BASE)
+MODULE_NAME="example"
+
+TARGETS=$(BINARY_NAME).img
+TARGET_DEPS=$(BINARY_NAME).elf
+
+BUILD_DIR=$(shell pwd)/build/
+
+include $(BASE).dbuild/dbuild.mk
+
+tool:
+	@echo $(BASE)
+	@echo $(BT_CONFIG_SUBARCH)
+	@echo $(BT_CONFIG_TOOLCHAIN)
+	@echo $(TOOLCHAIN)
+
+all: $(BINARY_NAME).elf $(BINARY_NAME).list $(BINARY_NAME).img $(BINARY_NAME).syms
+	$(Q)$(SIZE) $(BINARY_NAME).elf
+
+$(BINARY_NAME).img: $(BINARY_NAME).elf
+	$(Q)$(PRETTY) IMAGE $(MODULE_NAME) $@
+	$(Q)$(OBJCOPY) $(BINARY_NAME).elf -O binary $@
+
+$(BINARY_NAME).list: $(BINARY_NAME).elf
+	$(Q)$(PRETTY) LIST $(MODULE_NAME) $@
+	$(Q)$(OBJDUMP) -D $(BINARY_NAME).elf > $@
+
+$(BINARY_NAME).syms: $(BINARY_NAME).elf
+	$(Q)$(PRETTY) SYMS $(MODULE_NAME) $@
+	$(Q)$(OBJDUMP) -t $(BINARY_NAME).elf > $@
+
+$(BINARY_NAME).elf: $(OBJECTS)
+	$(Q)$(PRETTY) --dbuild "LD" $(MODULE_NAME) $@
+	$(Q)$(CC) -o $@ -T $(LINKER_SCRIPT) -Wl,-Map=$(BINARY_NAME).map -Wl,--gc-sections $(OBJECTS) -nostdlib -lc -lgcc

bsp/Kconfig

@@ -0,0 +1,19 @@
+#include <bitthunder.h>
+
+int main(void) {
+
+	// This is a kernel thread with FULL priviliges.
+
+	// Use the BT_CreateThread() function to create other threads,
+
+	// Use the BT_CreateProcess() function to create a full-blown process.
+
+	// Use the GPIO API:
+
+	BT_GpioSetDirection(0, BT_GPIO_DIR_OUTPUT);	// Set GPIO 0 as output.
+	BT_GpioSet(0, BT_TRUE);						// Set GPIO 0 high.
+
+	while(1);
+
+	return 0;
+}

bsp/Makefile

@@ -0,0 +1,13 @@
+#
+#	Add application objects to be build to the objs variable.
+#	You may also use objs-y also and therfore config based objects:
+#
+#	e.g. objs-$(BT_CONFIG_MY_CONFIG_VARIABLE) += $(APP)object.o
+#
+
+objs += $(APP)example.o
+
+#include $(APP_DIR)common/objects.mk
+
+$(objs): MODULE_NAME="Example"
+$(objs): CFLAGS += -I $(APP_DIR)include