Skip to content

Commit ee446ee

Browse files
Jake-CarterJake-Carter
committed
Sync up the VS Code starter projects with the upgraded Makefile system
1 parent 4395d7b commit ee446ee

File tree

6 files changed

+470
-102
lines changed

6 files changed

+470
-102
lines changed

‎MaximSDK/Inject/Makefile

+223-50
Original file line numberDiff line numberDiff line change
@@ -30,84 +30,257 @@
3030
# * ownership rights.
3131
# *******************************************************************************
3232

33-
###############################################################################
34-
# Main configuration
35-
# Below are the most commonly needed configuration options for this Makefile.
36-
# You shouldn't need to touch anything else unless advanced configuration is required.
33+
# ** Readme! **
34+
# Don't edit this file! Edit "project.mk" instead...
3735

38-
# Source files to compile for this project (add path to VPATH below)
39-
SRCS += main.c
36+
# This is the core Makefile for a MaximSDK project. The configuration below
37+
# is made to be suitable for most use-cases, and you normally shouldn't ever
38+
# need to edit this file directly. Instead, if you do need to modify the build system
39+
# for your project use the "project.mk" file to override and/or add to the
40+
# various "API"-like configuration variables that are available.
4041

41-
# Where to find source files for this project
42-
VPATH += ./src
42+
# You can also set most configuration variables on the command-line or in your
43+
# system's environment variables. If you're using a supported IDE, it will
44+
# offer its own options for overriding the available configuration variables.
4345

44-
# Where to find header files for this project
45-
IPATH += ./src
46+
# For more details on what configuration variables are available, see the sections
47+
# of this Makefile below. Each section contains a description and a list of
48+
# options.
4649

47-
# Set compiler flags
48-
PROJ_CFLAGS+=-Wall # Enable warnings
49-
PROJ_CFLAGS+=-DMXC_ASSERT_ENABLE # Enable assertion checking for development
50+
# For a more comprehensive overview of Make itself, see https://www.gnu.org/software/make/manual/
5051

51-
# Set compiler optimization level
52-
MXC_OPTIMIZE_CFLAGS=-Og
5352

54-
###############################################################################
53+
# *******************************************************************************
54+
# Set the target microcontroller and board to compile for.
55+
56+
# Every TARGET microcontroller has some Board Support Packages (BSPs) that are available
57+
# for it under the MaximSDK/Libraries/Boards/TARGET folder. The BSP that gets
58+
# selected is MaximSDK/Libraries/Boards/TARGET/BOARD.
59+
60+
# Configuration Variables:
61+
# - TARGET : Override the default target microcontroller. Ex: TARGET=MAX78000
62+
# - BOARD : Override the default BSP (case sensitive). Ex: BOARD=EvKit_V1, BOARD=FTHR_RevA
5563

56-
# Set the MAKE variable. This eliminates issues with some setups
57-
MAKE=make
5864

5965
ifeq "$(TARGET)" ""
60-
$(error target must be specified! Set the TARGET variable.)
66+
# Default target microcontroller
67+
TARGET := MAX78000
68+
TARGET_UC := MAX78000
69+
TARGET_LC := max78000
70+
else
71+
# "TARGET" has been overridden in the environment or on the command-line.
72+
# We need to calculate an upper and lowercase version of the part number,
73+
# because paths on Linux and MacOS are case-sensitive.
74+
TARGET_UC := $(subst m,M,$(subst a,A,$(subst x,X,$(TARGET))))
75+
TARGET_LC := $(subst M,m,$(subst A,a,$(subst X,x,$(TARGET))))
6176
endif
6277

63-
# Default board used. This is overridden in settings.json
64-
ifeq "$(BOARD)" ""
65-
$(error board must be specified! Set the BOARD variable.)
66-
endif
78+
# Default board.
79+
BOARD ?= EvKit_V1
6780

68-
# Set output filename
69-
ifeq "$(PROJECT)" ""
70-
PROJECT=$(TARGET)
81+
# *******************************************************************************
82+
# Locate the MaximSDK
83+
84+
# This Makefile needs to know where to find the MaximSDK, and the MAXIM_PATH variable
85+
# should point to the root directory of the MaximSDK installation. Setting this manually
86+
# is usually only required if you're working on the command-line.
87+
88+
# If MAXIM_PATH is not specified, we assume the project still lives inside of the MaximSDK
89+
# and move up from this project's original location.
90+
91+
# Configuration Variables:
92+
# - MAXIM_PATH : Tell this Makefile where to find the MaximSDK. Ex: MAXIM_PATH=C:/MaximSDK
93+
94+
95+
ifneq "$(MAXIM_PATH)" ""
96+
# Sanitize MAXIM_PATH for backslashes
97+
MAXIM_PATH := $(subst \,/,$(MAXIM_PATH))
98+
# Locate some other useful paths...
99+
LIBS_DIR := $(abspath $(MAXIM_PATH)/Libraries)
100+
CMSIS_ROOT := $(LIBS_DIR)/CMSIS
71101
endif
72102

73-
# Create Target name variables
74-
TARGET_UC:=$(shell echo $(TARGET) | tr a-z A-Z)
75-
TARGET_LC:=$(shell echo $(TARGET) | tr A-Z a-z)
103+
# *******************************************************************************
104+
# Include project Makefile. We do this after formulating TARGET, BOARD, and MAXIM_PATH
105+
# in case project.mk needs to reference those values. However, we also include
106+
# this as early as possible in the Makefile so that it can append to or override
107+
# the variables below.
108+
76109

77-
# Select 'GCC' or 'IAR' compiler
78-
COMPILER=GCC
110+
include ./project.mk
111+
$(info Loaded project.mk)
112+
113+
# *******************************************************************************
114+
# Final path sanitization and re-calculation. No options here.
79115

80-
# This is the path to the CMSIS root directory
81116
ifeq "$(MAXIM_PATH)" ""
82-
LIBS_DIR=../../../Libraries
117+
# MAXIM_PATH is still not defined...
118+
DEPTH := ../../../
119+
MAXIM_PATH := $(abspath $(DEPTH))
120+
$(warning Warning: MAXIM_PATH is not set! It's recommended to set MAXIM_PATH in your environment or in project.mk)
121+
$(warning Warning: Attempting to use $(MAXIM_PATH) calculated from relative path)
83122
else
84-
LIBS_DIR=/$(subst \,/,$(subst :,,$(MAXIM_PATH))/Libraries)
123+
# Sanitize MAXIM_PATH for backslashes
124+
MAXIM_PATH := $(subst \,/,$(MAXIM_PATH))
85125
endif
86-
#LIBS_DIR = ./Libraries
87126

88-
CMSIS_ROOT=$(LIBS_DIR)/CMSIS
127+
# Final recalculation of LIBS_DIR/CMSIS_ROOT
128+
LIBS_DIR := $(abspath $(MAXIM_PATH)/Libraries)
129+
CMSIS_ROOT := $(LIBS_DIR)/CMSIS
89130

90-
#Use this for other library make files so they are all based off the same as root as the project
131+
# One final UC/LC check in case user set TARGET in project.mk
132+
TARGET_UC := $(subst m,M,$(subst a,A,$(subst x,X,$(TARGET))))
133+
TARGET_LC := $(subst M,m,$(subst A,a,$(subst X,x,$(TARGET))))
134+
135+
export TARGET
136+
export TARGET_UC
137+
export TARGET_LC
91138
export CMSIS_ROOT
139+
# TODO: Remove dependency on exports for these variables.
140+
141+
# *******************************************************************************
142+
# Set up search paths, and auto-detect all source code on those paths.
143+
144+
# The following paths are searched by default, where "./" is the project directory.
145+
# ./
146+
# ├─ *.h
147+
# ├─ *.c
148+
# ├─include (optional)
149+
# └─ *.h
150+
# ├─src (optional)
151+
# └─ *.c
152+
153+
# Configuration Variables:
154+
# - VPATH : Tell this Makefile to search additional locations for source (.c) files.
155+
# You should use the "+=" operator with this option.
156+
# Ex: VPATH += your/new/path
157+
# - IPATH : Tell this Makefile to search additional locations for header (.h) files.
158+
# You should use the "+=" operator with this option.
159+
# Ex: VPATH += your/new/path
160+
# - SRCS : Tell this Makefile to explicitly add a source (.c) file to the build.
161+
# This is really only useful if you want to add a source file that isn't
162+
# on any VPATH, in which case you can add the full path to the file here.
163+
# You should use the "+=" operator with this option.
164+
# Ex: SRCS += your/specific/source/file.c
165+
# - AUTOSEARCH : Set whether this Makefile should automatically detect .c files on
166+
# VPATH and add them to the build. This is enabled by default. Set
167+
# to 0 to disable. If autosearch is disabled, source files must be
168+
# manually added to SRCS.
169+
# Ex: AUTOSEARCH = 0
170+
171+
172+
# Where to find source files for this project.
173+
VPATH += .
174+
VPATH := $(VPATH)
175+
176+
# Where to find header files for this project
177+
IPATH += .
178+
IPATH := $(IPATH)
179+
180+
AUTOSEARCH ?= 1
181+
ifeq ($(AUTOSEARCH), 1)
182+
# Auto-detect all C source files on VPATH
183+
SRCS += $(wildcard $(addsuffix /*.c, $(VPATH)))
184+
endif
185+
186+
# Collapse SRCS before passing them on to the next stage
187+
SRCS := $(SRCS)
188+
189+
# *******************************************************************************
190+
# Set the output filename
191+
192+
# Configuration Variables:
193+
# - PROJECT : Override the default output filename. Ex: PROJECT=MyProject
194+
195+
196+
# The default value creates a file named after the target micro. Ex: MAX78000.elf
197+
PROJECT ?= $(TARGET_UC)
198+
199+
# *******************************************************************************
200+
# Compiler options
201+
202+
# Configuration Variables:
203+
# - MXC_OPTIMIZE_CFLAGS : Override the default compiler optimization level.
204+
# Ex: MXC_OPTIMIZE_CFLAGS = -O2
205+
# - PROJ_CFLAGS : Add additional compiler flags to the build.
206+
# You should use the "+=" operator with this option.
207+
# Ex: PROJ_CFLAGS += -Wextra
208+
# - MFLOAT_ABI : Set the floating point acceleration level.
209+
# The only options are "hard", "soft", or "softfp".
210+
# Ex: MFLOAT_ABI = hard
211+
# - LINKERFILE : Override the default linkerfile.
212+
# Ex: LINKERFILE = customlinkerfile.ld
213+
214+
215+
# Select 'GCC' or 'IAR' compiler
216+
ifeq "$(COMPILER)" ""
217+
COMPILER := GCC
218+
endif
219+
220+
# Set compiler optimization level
221+
ifeq "$(MAKECMDGOALS)" "release"
222+
# Optimization level for "release" builds
223+
MXC_OPTIMIZE_CFLAGS := -O2
224+
else
225+
# Optimization level for default builds
226+
MXC_OPTIMIZE_CFLAGS := -Og
227+
endif
228+
229+
# Set compiler flags
230+
PROJ_CFLAGS += -Wall # Enable warnings
231+
PROJ_CFLAGS += -DMXC_ASSERT_ENABLE
232+
233+
# Set hardware floating point acceleration.
234+
# Options are:
235+
# - hard
236+
# - soft
237+
# - softfp (default if MFLOAT_ABI is not set)
238+
MFLOAT_ABI ?= softfp
239+
# MFLOAT_ABI must be exported to other Makefiles, who check this too
240+
export MFLOAT_ABI
241+
242+
# Set the default linkerfile. Since the core Makefiles later add the location of Maxim's
243+
# linkerfiles to VPATH, and the local project directory has also been added to VPATH, Make
244+
# will search both locations for the specified linkerfile if it can't find it by its path alone.
245+
# The result is that overriding LINKERFILE with the filename of one of Maxim's alternate linkerfiles
246+
# (ex: LINKERFILE=max78000_arm.ld) will work just the same as LINKERFILE=mycustom.ld
247+
# even if mycustom.ld lives locally to this project.
248+
249+
ifeq "$(RISCV_CORE)" ""
250+
# Default linkerfile is only specified for standard Arm-core projects.
251+
# Otherwise, gcc_riscv.mk sets the appropriate riscv linkerfile.
252+
LINKERFILE ?= $(CMSIS_ROOT)/Device/Maxim/$(TARGET_UC)/Source/GCC/$(TARGET_LC).ld
253+
endif
254+
255+
# This path contains system-level intialization files for the target micro. Add to the build.
92256
VPATH += $(CMSIS_ROOT)/Device/Maxim/$(TARGET_UC)/Source
93257

94-
# Point this variable to a linker file to override the default file
95-
LINKER=$(TARGET_LC).ld
96-
LINKERFILE=$(CMSIS_ROOT)/Device/Maxim/$(TARGET_UC)/Source/GCC/$(LINKER)
258+
# *******************************************************************************
259+
# Libraries
260+
261+
# This section offers "toggle switches" to include or exclude the libraries that
262+
# are available in the MaximSDK. Set a configuration variable to 1 to include the
263+
# library in the build, or 0 to exclude.
97264

98-
################################################################################
99-
# Include external library makefiles here
265+
# Each library may also have its own library specific configuration variables. See
266+
# Libraries/libs.mk for more details.
100267

101-
# Include the BSP
102-
BOARD_DIR=$(LIBS_DIR)/Boards/$(TARGET_UC)/$(BOARD)
103-
include $(BOARD_DIR)/board.mk
268+
# Configuration variables:
269+
# - LIB_BOARD : Include the Board-Support Package (BSP) library. (Enabled by default)
270+
# - LIB_PERIPHDRIVERS : Include the peripheral driver library. (Enabled by default)
271+
# - LIB_CMSIS_DSP : Include the CMSIS-DSP library.
272+
# - LIB_CORDIO : Include the Cordio BLE library
273+
# - LIB_FCL : Include the Free Cryptographic Library (FCL)
274+
# - LIB_FREERTOS : Include the FreeRTOS and FreeRTOS-Plus-CLI libraries
275+
# - LIB_LC3 : Include the Low Complexity Communication Codec (LC3) library
276+
# - LIB_LTTLEFS : Include the "little file system" (littleFS) library
277+
# - LIB_LWIP : Include the lwIP library
278+
# - LIB_MAXUSB : Include the MAXUSB library
279+
# - LIB_SDHC : Include the SDHC library
104280

105-
# Include the peripheral driver
106-
PERIPH_DRIVER_DIR=$(LIBS_DIR)/PeriphDrivers
107-
include $(PERIPH_DRIVER_DIR)/periphdriver.mk
108-
export PERIPH_DRIVER_DIR
281+
include $(LIBS_DIR)/libs.mk
109282

110-
################################################################################
283+
# *******************************************************************************
111284
# Include the rules for building for this target. All other makefiles should be
112285
# included before this one.
113286
include $(CMSIS_ROOT)/Device/Maxim/$(TARGET_UC)/Source/$(COMPILER)/$(TARGET_LC).mk

‎MaximSDK/Inject/project.mk

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# This file can be used for project configuration.
2+
# It's a sibling to the core "Makefile", which offers
3+
# various configuration variables that you can set here
4+
# if the default setup isn't suitable.
5+
6+
# See the comments in the "Makefile" for a detailed
7+
# description of the default behavior and the full list of
8+
# available options.
9+
10+
11+

‎MaximSDK/New_Project/.vscode/c_cpp_properties.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"intelliSenseMode": "gcc-arm",
1212
"compilerPath": "${config:ARM_GCC_path}/bin/arm-none-eabi-gcc.exe",
1313
"browse": {
14-
"path": [
14+
"path": [
1515
"${default}"
1616
]
1717
}

0 commit comments

Comments
 (0)