add make.mk and rules.mk to help new makefile example

4 files changed, 192 insertions, 357 deletions

diff --git a/examples/device/cdc_msc_hid/Makefile b/examples/device/cdc_msc_hid/Makefile
index 69bffaace..4ff3371dc 100644
--- a/examples/device/cdc_msc_hid/Makefile
+++ b/examples/device/cdc_msc_hid/Makefile
@@ -1,185 +1,15 @@
 include ../../../tools/top.mk
+include ../../make.mk
 
-# Select the board to build for.
-ifeq ($(BOARD),)
-  $(info You must provide a BOARD parameter with 'BOARD=')
-  $(info Possible values are:)
-  $(info $(sort $(subst /.,,$(subst $(TOP)/hw/bsp/,,$(wildcard $(TOP)/hw/bsp/*/.)))))
-  $(error BOARD not defined)
-else
-  ifeq ($(wildcard $(TOP)/hw/bsp/$(BOARD)/.),)
-    $(error Invalid BOARD specified)
-  endif
-endif
-
-# Verbose mode (V=). 0: default, 1: print out CFLAG, LDFLAG 2: print all compile command
-ifeq ("$(V)","2")
-  QUIET =
-else
-  QUIET = @
-endif
-
-# If the build directory is not given, make it reflect the board name.
-BUILD ?= build-$(BOARD)
-
-CROSS_COMPILE = arm-none-eabi-
-
-include $(TOP)/hw/bsp/$(BOARD)/board.mk
-
-CC = $(CROSS_COMPILE)gcc
-CXX = $(CROSS_COMPILE)g++
-OBJCOPY = $(CROSS_COMPILE)objcopy
-SIZE = $(CROSS_COMPILE)size
-MKDIR = mkdir
-SED = sed
-CP = cp
-RM = rm
-
-INC += -Isrc \
-	-I$(TOP)/hw \
-	-I$(TOP)/src
-
-CFLAGS += \
-	-fsingle-precision-constant \
-	-fno-strict-aliasing \
-	-Wdouble-promotion \
-	-Wno-endif-labels \
-	-Wstrict-prototypes \
-	-Werror-implicit-function-declaration \
-	-Wfloat-equal \
-	-Wundef \
-	-Wshadow \
-	-Wwrite-strings \
-	-Wsign-compare \
-	-Wmissing-format-attribute \
-	-Wno-deprecated-declarations \
-	-Wnested-externs \
-	-Wunreachable-code \
-	-Wno-error=lto-type-mismatch \
-	-ffunction-sections \
-	-fdata-sections
-
-# This causes lots of warning with nrf5x build due to nrfx code
-# CFLAGS += -Wcast-align
-
-#Debugging/Optimization
-ifeq ($(DEBUG), 1)
-  CFLAGS += -O0 -ggdb
-else
-  CFLAGS += -flto -Os
-endif
-
-CFLAGS += $(INC) -Wall -Werror -std=gnu11 -DBOARD_$(shell echo $(BOARD) | tr '[:lower:]' '[:upper:]')
-LDFLAGS += $(CFLAGS) -fshort-enums -Wl,-T,$(TOP)/$(LD_FILE) -Wl,[email protected] -Wl,-cref -Wl,-gc-sections -specs=nosys.specs -specs=nano.specs
-
-ifeq ("$(V)","1")
-$(info CFLAGS  $(CFLAGS))
-$(info )
-$(info LDFLAGS $(LDFLAGS))
-$(info )
-$(info ASFLAGS $(ASFLAGS))
-$(info )
-endif
-
-LIBS = -lgcc -lc -lm -lnosys
+INC += \
+	src \
+	$(TOP)/hw \
 
+# Example source
 EXAMPLE_SOURCE += $(wildcard src/*.c)
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
-LIB_SOURCE += \
-	hw/bsp/$(BOARD)/board_$(BOARD).c \
-	src/common/tusb_fifo.c \
-	src/device/usbd.c \
-	src/device/usbd_control.c \
-	src/class/msc/msc_device.c \
-	src/class/cdc/cdc_device.c \
-	src/class/hid/hid_device.c \
-	src/tusb.c \
-	src/portable/$(VENDOR)/$(CHIP_FAMILY)/dcd_$(CHIP_FAMILY).c
-
-SRC_C += $(LIB_SOURCE)
-
-# Assembly files can be name with upper case .S, convert it to .s 
-SRC_S := $(SRC_S:.S=.s)
-
-# Due to GCC LTO bug https://bugs.launchpad.net/gcc-arm-embedded/+bug/1747966
-# assembly file should be placed first in linking order
-OBJ += $(addprefix $(BUILD)/obj/, $(SRC_S:.s=.o))
-OBJ += $(addprefix $(BUILD)/obj/, $(SRC_C:.c=.o))
-
-# Set all as default goal
-.DEFAULT_GOAL := all
-all: $(BUILD)/$(BOARD)-firmware.bin size
-
-OBJ_DIRS = $(sort $(dir $(OBJ)))
-$(OBJ): | $(OBJ_DIRS)
-$(OBJ_DIRS):
-	@$(MKDIR) -p $@
-
-$(BUILD)/$(BOARD)-firmware.elf: $(OBJ)
-	@echo LINK $@
-	$(QUIET)$(CC) -o $@ $(LDFLAGS) $^ -Wl,--start-group $(LIBS) -Wl,--end-group
-
-$(BUILD)/$(BOARD)-firmware.bin: $(BUILD)/$(BOARD)-firmware.elf
-	@echo CREATE $@
-	@$(OBJCOPY) -O binary -j .vectors -j .text -j .data $^ $@
-	
-$(BUILD)/$(BOARD)-firmware.hex: $(BUILD)/$(BOARD)-firmware.elf	
-	@echo CREATE $@
-	@$(OBJCOPY) -O ihex $^ $@
-
-# We set vpath to point to the top of the tree so that the source files
-# can be located. By following this scheme, it allows a single build rule
-# to be used to compile all .c files.
-vpath %.c . $(TOP)
-$(BUILD)/obj/%.o: %.c
-	@echo CC $(notdir $@)
-	$(QUIET)$(CC) $(CFLAGS) -c -MD -o $@ $<
-	@# The following fixes the dependency file.
-	@# See http://make.paulandlesley.org/autodep.html for details.
-	@# Regex adjusted from the above to play better with Windows paths, etc.
-	@$(CP) $(@:.o=.d) $(@:.o=.P); \
-	  $(SED) -e 's/#.*//' -e 's/^.*:  *//' -e 's/ *\\$$//' \
-	      -e '/^$$/ d' -e 's/$$/ :/' < $(@:.o=.d) >> $(@:.o=.P); \
-	  $(RM) $(@:.o=.d)
-
-# ASM sources lower case .s
-vpath %.s . $(TOP)
-$(BUILD)/obj/%.o: %.s
-	@echo AS $(notdir $@)
-	$(QUIET)$(CC) -x assembler-with-cpp $(ASFLAGS) -c -o $@ $<
-
-# ASM sources upper case .S
-vpath %.S . $(TOP)
-$(BUILD)/obj/%.o: %.S
-	@echo AS $(notdir $@)
-	$(QUIET)$(CC) -x assembler-with-cpp $(ASFLAGS) -c -o $@ $<
-
-# Flash binary using Jlink, should be added into system path 
-ifeq ($(OS),Windows_NT)
-  JLINKEXE = JLink.exe
-else 
-  JLINKEXE = JLinkExe
-endif
-
-# default jlink interface is swd
-ifeq ($(JLINK_IF),)
-  JLINK_IF = swd
-endif
-
-# Flash using jlink
-flash-jlink: $(BUILD)/$(BOARD)-firmware.hex
-	@echo halt > $(BUILD)/$(BOARD).jlink
-	@echo loadfile $^ >> $(BUILD)/$(BOARD).jlink
-	@echo r >> $(BUILD)/$(BOARD).jlink
-	@echo go >> $(BUILD)/$(BOARD).jlink
-	@echo exit >> $(BUILD)/$(BOARD).jlink
-	$(JLINKEXE) -device $(JLINK_DEVICE) -if $(JLINK_IF) -speed auto -CommandFile $(BUILD)/$(BOARD).jlink
-
-size: $(BUILD)/$(BOARD)-firmware.elf
-	-@echo ''
-	@$(SIZE) $<
-	-@echo ''
+# Board source
+SRC_C += hw/bsp/$(BOARD)/board_$(BOARD).c
 
-clean:
-	rm -rf build-$(BOARD)
+include ../../rules.mk
diff --git a/examples/device/msc_dual_lun/Makefile b/examples/device/msc_dual_lun/Makefile
index 1a9f9d135..59eeacf4d 100644
--- a/examples/device/msc_dual_lun/Makefile
+++ b/examples/device/msc_dual_lun/Makefile
@@ -1,186 +1,15 @@
 include ../../../tools/top.mk
+include ../../make.mk
 
-# Select the board to build for.
-ifeq ($(BOARD),)
-  $(info You must provide a BOARD parameter with 'BOARD=')
-  $(info Possible values are:)
-  $(info $(sort $(subst /.,,$(subst $(TOP)/hw/bsp/,,$(wildcard $(TOP)/hw/bsp/*/.)))))
-  $(error BOARD not defined)
-else
-  ifeq ($(wildcard $(TOP)/hw/bsp/$(BOARD)/.),)
-    $(error Invalid BOARD specified)
-  endif
-endif
-
-# Verbose mode (V=). 0: default, 1: print out CFLAG, LDFLAG 2: print all compile command
-ifeq ("$(V)","2")
-  QUIET =
-else
-  QUIET = @
-endif
-
-# If the build directory is not given, make it reflect the board name.
-BUILD ?= build-$(BOARD)
-
-CROSS_COMPILE = arm-none-eabi-
-
-include $(TOP)/hw/bsp/$(BOARD)/board.mk
-
-CC = $(CROSS_COMPILE)gcc
-CXX = $(CROSS_COMPILE)g++
-OBJCOPY = $(CROSS_COMPILE)objcopy
-SIZE = $(CROSS_COMPILE)size
-MKDIR = mkdir
-SED = sed
-CP = cp
-RM = rm
-
-INC += -Isrc \
-	-I$(TOP)/hw \
-	-I$(TOP)/src
-
-CFLAGS += \
-	-fsingle-precision-constant \
-	-fno-strict-aliasing \
-	-Wdouble-promotion \
-	-Wno-endif-labels \
-	-Wstrict-prototypes \
-	-Werror-implicit-function-declaration \
-	-Wfloat-equal \
-	-Wundef \
-	-Wshadow \
-	-Wwrite-strings \
-	-Wsign-compare \
-	-Wmissing-format-attribute \
-	-Wno-deprecated-declarations \
-	-Wnested-externs \
-	-Wunreachable-code \
-	-Wno-error=lto-type-mismatch \
-	-ffunction-sections \
-	-fdata-sections
-
-# This causes lots of warning with nrf5x build due to nrfx code
-# CFLAGS += -Wcast-align
-
-#Debugging/Optimization
-ifeq ($(DEBUG), 1)
-  CFLAGS += -O0 -ggdb
-else
-  CFLAGS += -flto -Os
-endif
-
-CFLAGS += $(INC) -Wall -Werror -std=gnu11 -DBOARD_$(shell echo $(BOARD) | tr '[:lower:]' '[:upper:]')
-LDFLAGS += $(CFLAGS) -fshort-enums -Wl,-T,$(TOP)/$(LD_FILE) -Wl,[email protected] -Wl,-cref -Wl,-gc-sections -specs=nosys.specs -specs=nano.specs
-
-ifeq ("$(V)","1")
-$(info CFLAGS  $(CFLAGS))
-$(info )
-$(info LDFLAGS $(LDFLAGS))
-$(info )
-$(info ASFLAGS $(ASFLAGS))
-$(info )
-endif
-
-LIBS = -lgcc -lc -lm -lnosys
+INC += \
+  src \
+  $(TOP)/hw \
 
+# Example source
 EXAMPLE_SOURCE += $(wildcard src/*.c)
-
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
-LIB_SOURCE += \
-	hw/bsp/$(BOARD)/board_$(BOARD).c \
-	src/common/tusb_fifo.c \
-	src/device/usbd.c \
-	src/device/usbd_control.c \
-	src/class/msc/msc_device.c \
-	src/class/cdc/cdc_device.c \
-	src/class/hid/hid_device.c \
-	src/tusb.c \
-	src/portable/$(VENDOR)/$(CHIP_FAMILY)/dcd_$(CHIP_FAMILY).c
-
-SRC_C += $(LIB_SOURCE)
-
-# Assembly files can be name with upper case .S, convert it to .s 
-SRC_S := $(SRC_S:.S=.s)
-
-# Due to GCC LTO bug https://bugs.launchpad.net/gcc-arm-embedded/+bug/1747966
-# assembly file should be placed first in linking order
-OBJ += $(addprefix $(BUILD)/obj/, $(SRC_S:.s=.o))
-OBJ += $(addprefix $(BUILD)/obj/, $(SRC_C:.c=.o))
-
-# Set all as default goal
-.DEFAULT_GOAL := all
-all: $(BUILD)/$(BOARD)-firmware.bin size
-
-OBJ_DIRS = $(sort $(dir $(OBJ)))
-$(OBJ): | $(OBJ_DIRS)
-$(OBJ_DIRS):
-	@$(MKDIR) -p $@
-
-$(BUILD)/$(BOARD)-firmware.elf: $(OBJ)
-	@echo LINK $@
-	$(QUIET)$(CC) -o $@ $(LDFLAGS) $^ -Wl,--start-group $(LIBS) -Wl,--end-group
-
-$(BUILD)/$(BOARD)-firmware.bin: $(BUILD)/$(BOARD)-firmware.elf
-	@echo CREATE $@
-	@$(OBJCOPY) -O binary -j .vectors -j .text -j .data $^ $@
-	
-$(BUILD)/$(BOARD)-firmware.hex: $(BUILD)/$(BOARD)-firmware.elf	
-	@echo CREATE $@
-	@$(OBJCOPY) -O ihex $^ $@
-
-# We set vpath to point to the top of the tree so that the source files
-# can be located. By following this scheme, it allows a single build rule
-# to be used to compile all .c files.
-vpath %.c . $(TOP)
-$(BUILD)/obj/%.o: %.c
-	@echo CC $(notdir $@)
-	$(QUIET)$(CC) $(CFLAGS) -c -MD -o $@ $<
-	@# The following fixes the dependency file.
-	@# See http://make.paulandlesley.org/autodep.html for details.
-	@# Regex adjusted from the above to play better with Windows paths, etc.
-	@$(CP) $(@:.o=.d) $(@:.o=.P); \
-	  $(SED) -e 's/#.*//' -e 's/^.*:  *//' -e 's/ *\\$$//' \
-	      -e '/^$$/ d' -e 's/$$/ :/' < $(@:.o=.d) >> $(@:.o=.P); \
-	  $(RM) $(@:.o=.d)
-
-# ASM sources lower case .s
-vpath %.s . $(TOP)
-$(BUILD)/obj/%.o: %.s
-	@echo AS $(notdir $@)
-	$(QUIET)$(CC) -x assembler-with-cpp $(ASFLAGS) -c -o $@ $<
-
-# ASM sources upper case .S
-vpath %.S . $(TOP)
-$(BUILD)/obj/%.o: %.S
-	@echo AS $(notdir $@)
-	$(QUIET)$(CC) -x assembler-with-cpp $(ASFLAGS) -c -o $@ $<
-
-# Flash binary using Jlink, should be added into system path 
-ifeq ($(OS),Windows_NT)
-  JLINKEXE = JLink.exe
-else 
-  JLINKEXE = JLinkExe
-endif
-
-# default jlink interface is swd
-ifeq ($(JLINK_IF),)
-  JLINK_IF = swd
-endif
-
-# Flash using jlink
-flash-jlink: $(BUILD)/$(BOARD)-firmware.hex
-	@echo halt > $(BUILD)/$(BOARD).jlink
-	@echo loadfile $^ >> $(BUILD)/$(BOARD).jlink
-	@echo r >> $(BUILD)/$(BOARD).jlink
-	@echo go >> $(BUILD)/$(BOARD).jlink
-	@echo exit >> $(BUILD)/$(BOARD).jlink
-	$(JLINKEXE) -device $(JLINK_DEVICE) -if $(JLINK_IF) -speed auto -CommandFile $(BUILD)/$(BOARD).jlink
-
-size: $(BUILD)/$(BOARD)-firmware.elf
-	-@echo ''
-	@$(SIZE) $<
-	-@echo ''
+# Board source
+SRC_C += hw/bsp/$(BOARD)/board_$(BOARD).c
 
-clean:
-	rm -rf build-$(BOARD)
+include ../../rules.mk
diff --git a/examples/make.mk b/examples/make.mk
new file mode 100644
index 000000000..d76f611fb
--- /dev/null
+++ b/examples/make.mk
@@ -0,0 +1,65 @@
+#
+# Common make definition for all examples
+#
+
+# Compiler 
+CROSS_COMPILE = arm-none-eabi-
+CC = $(CROSS_COMPILE)gcc
+CXX = $(CROSS_COMPILE)g++
+OBJCOPY = $(CROSS_COMPILE)objcopy
+SIZE = $(CROSS_COMPILE)size
+MKDIR = mkdir
+SED = sed
+CP = cp
+RM = rm
+
+# Select the board to build for.
+ifeq ($(BOARD),)
+  $(info You must provide a BOARD parameter with 'BOARD=')
+  $(info Possible values are:)
+  $(info $(sort $(subst /.,,$(subst $(TOP)/hw/bsp/,,$(wildcard $(TOP)/hw/bsp/*/.)))))
+  $(error BOARD not defined)
+else
+  ifeq ($(wildcard $(TOP)/hw/bsp/$(BOARD)/.),)
+    $(error Invalid BOARD specified)
+  endif
+endif
+
+# Build directory
+BUILD = build-$(BOARD)
+
+# Board specific
+include $(TOP)/hw/bsp/$(BOARD)/board.mk
+
+# Compiler Flags
+CFLAGS += \
+	-fsingle-precision-constant \
+	-fno-strict-aliasing \
+	-Wdouble-promotion \
+	-Wno-endif-labels \
+	-Wstrict-prototypes \
+	-Wall \
+	-Werror \
+	-Werror-implicit-function-declaration \
+	-Wfloat-equal \
+	-Wundef \
+	-Wshadow \
+	-Wwrite-strings \
+	-Wsign-compare \
+	-Wmissing-format-attribute \
+	-Wno-deprecated-declarations \
+	-Wnested-externs \
+	-Wunreachable-code \
+	-Wno-error=lto-type-mismatch \
+	-ffunction-sections \
+	-fdata-sections
+
+# This causes lots of warning with nrf5x build due to nrfx code
+# CFLAGS += -Wcast-align
+
+# Debugging/Optimization
+ifeq ($(DEBUG), 1)
+  CFLAGS += -O0 -ggdb
+else
+  CFLAGS += -flto -Os
+endif
diff --git a/examples/rules.mk b/examples/rules.mk
new file mode 100644
index 000000000..df9ffb7e5
--- /dev/null
+++ b/examples/rules.mk
@@ -0,0 +1,111 @@
+#
+# Common make definition for all examples
+#
+
+# libc
+LIBS = -lgcc -lc -lm -lnosys
+
+# TinyUSB Stack source
+SRC_C += \
+	src/common/tusb_fifo.c \
+	src/device/usbd.c \
+	src/device/usbd_control.c \
+	src/class/msc/msc_device.c \
+	src/class/cdc/cdc_device.c \
+	src/class/hid/hid_device.c \
+	src/tusb.c \
+	src/portable/$(VENDOR)/$(CHIP_FAMILY)/dcd_$(CHIP_FAMILY).c
+
+# TinyUSB stack include
+INC += $(TOP)/src
+
+#
+CFLAGS += $(addprefix -I,$(INC))
+LDFLAGS += $(CFLAGS) -fshort-enums -Wl,-T,$(TOP)/$(LD_FILE) -Wl,[email protected] -Wl,-cref -Wl,-gc-sections -specs=nosys.specs -specs=nano.specs
+
+# Assembly files can be name with upper case .S, convert it to .s 
+SRC_S := $(SRC_S:.S=.s)
+
+# Due to GCC LTO bug https://bugs.launchpad.net/gcc-arm-embedded/+bug/1747966
+# assembly file should be placed first in linking order
+OBJ += $(addprefix $(BUILD)/obj/, $(SRC_S:.s=.o))
+OBJ += $(addprefix $(BUILD)/obj/, $(SRC_C:.c=.o))
+
+# Verbose mode
+ifeq ("$(V)","1")
+$(info CFLAGS  $(CFLAGS) ) $(info )
+$(info LDFLAGS $(LDFLAGS)) $(info )
+$(info ASFLAGS $(ASFLAGS)) $(info )
+endif
+
+# Set all as default goal
+.DEFAULT_GOAL := all
+all: $(BUILD)/$(BOARD)-firmware.bin size
+
+OBJ_DIRS = $(sort $(dir $(OBJ)))
+$(OBJ): | $(OBJ_DIRS)
+$(OBJ_DIRS):
+	@$(MKDIR) -p $@
+
+$(BUILD)/$(BOARD)-firmware.elf: $(OBJ)
+	@echo LINK $@
+	@$(CC) -o $@ $(LDFLAGS) $^ -Wl,--start-group $(LIBS) -Wl,--end-group
+
+$(BUILD)/$(BOARD)-firmware.bin: $(BUILD)/$(BOARD)-firmware.elf
+	@echo CREATE $@
+	@$(OBJCOPY) -O binary -j .vectors -j .text -j .data $^ $@
+	
+$(BUILD)/$(BOARD)-firmware.hex: $(BUILD)/$(BOARD)-firmware.elf	
+	@echo CREATE $@
+	@$(OBJCOPY) -O ihex $^ $@
+
+# We set vpath to point to the top of the tree so that the source files
+# can be located. By following this scheme, it allows a single build rule
+# to be used to compile all .c files.
+vpath %.c . $(TOP)
+$(BUILD)/obj/%.o: %.c
+	@echo CC $(notdir $@)
+	@$(CC) $(CFLAGS) -c -MD -o $@ $<
+	@# The following fixes the dependency file.
+	@# See http://make.paulandlesley.org/autodep.html for details.
+	@# Regex adjusted from the above to play better with Windows paths, etc.
+	@$(CP) $(@:.o=.d) $(@:.o=.P); \
+	  $(SED) -e 's/#.*//' -e 's/^.*:  *//' -e 's/ *\\$$//' \
+	      -e '/^$$/ d' -e 's/$$/ :/' < $(@:.o=.d) >> $(@:.o=.P); \
+	  $(RM) $(@:.o=.d)
+
+# ASM sources lower case .s
+vpath %.s . $(TOP)
+$(BUILD)/obj/%.o: %.s
+	@echo AS $(notdir $@)
+	@$(CC) -x assembler-with-cpp $(ASFLAGS) -c -o $@ $<
+
+# ASM sources upper case .S
+vpath %.S . $(TOP)
+$(BUILD)/obj/%.o: %.S
+	@echo AS $(notdir $@)
+	@$(CC) -x assembler-with-cpp $(ASFLAGS) -c -o $@ $<
+
+size: $(BUILD)/$(BOARD)-firmware.elf
+	-@echo ''
+	@$(SIZE) $<
+	-@echo ''
+
+clean:
+	rm -rf build-$(BOARD)
+	
+# Flash binary using Jlink
+ifeq ($(OS),Windows_NT)
+  JLINKEXE = JLink.exe
+else 
+  JLINKEXE = JLinkExe
+endif
+
+# Flash using jlink
+flash-jlink: $(BUILD)/$(BOARD)-firmware.hex
+	@echo halt > $(BUILD)/$(BOARD).jlink
+	@echo loadfile $^ >> $(BUILD)/$(BOARD).jlink
+	@echo r >> $(BUILD)/$(BOARD).jlink
+	@echo go >> $(BUILD)/$(BOARD).jlink
+	@echo exit >> $(BUILD)/$(BOARD).jlink
+	$(JLINKEXE) -device $(JLINK_DEVICE) -if $(JLINK_IF) -speed auto -CommandFile $(BUILD)/$(BOARD).jlink