4 This document explains the Espressif IoT Development Framework build system and the
5 concept of "components"
7 Read this document if you want to know how to organise a new ESP-IDF project.
9 We recommend using the esp-idf-template_ project as a starting point for your project.
11 Using the Build System
12 ======================
14 The esp-idf README file contains a description of how to use the build system to build your project.
19 An ESP-IDF project can be seen as an amalgamation of a number of components.
20 For example, for a webserver that shows the current humidity, there could be:
22 - The ESP32 base libraries (libc, rom bindings etc)
25 - The FreeRTOS operating system
27 - A driver for the humidity sensor
28 - Main code tying it all together
30 ESP-IDF makes these components explicit and configurable. To do that,
31 when a project is compiled, the build environment will look up all the
32 components in the ESP-IDF directories, the project directories and
33 (optionally) in additional custom component directories. It then
34 allows the user to configure the ESP-IDF project using a a text-based
35 menu system to customize each component. After the components in the
36 project are configured, the build process will compile the project.
41 - A "project" is a directory that contains all the files and configuration to build a single "app" (executable), as well as additional supporting output such as a partition table, data/filesystem partitions, and a bootloader.
43 - "Project configuration" is held in a single file called sdkconfig in the root directory of the project. This configuration file is modified via ``make menuconfig`` to customise the configuration of the project. A single project contains exactly one project configuration.
45 - An "app" is an executable which is built by esp-idf. A single project will usually build two apps - a "project app" (the main executable, ie your custom firmware) and a "bootloader app" (the initial bootloader program which launches the project app).
47 - "components" are modular pieces of standalone code which are compiled into static libraries (.a files) and linked into an app. Some are provided by esp-idf itself, others may be sourced from other places.
49 Some things are not part of the project:
51 - "ESP-IDF" is not part of the project. Instead it is standalone, and linked to the project via the ``IDF_PATH`` environment variable which holds the path of the ``esp-idf`` directory. This allows the IDF framework to be decoupled from your project.
53 - The toolchain for compilation is not part of the project. The toolchain should be installed in the system command line PATH, or the path to the toolchain can be set as part of the compiler prefix in the project configuration.
59 An example project directory tree might look like this::
63 - components/ - component1/ - component.mk
66 - component2/ - component.mk
76 This example "myProject" contains the following elements:
78 - A top-level project Makefile. This Makefile set the ``PROJECT_NAME`` variable and (optionally) defines
79 other project-wide make variables. It includes the core ``$(IDF_PATH)/make/project.mk`` makefile which
80 implements the rest of the ESP-IDF build system.
82 - "sdkconfig" project configuration file. This file is created/updated when "make menuconfig" runs, and holds configuration for all of the components in the project (including esp-idf itself). The "sdkconfig" file may or may not be added to the source control system of the project.
84 - Optional "components" directory contains components that are part of the project. A project does not have to contain custom components of this kind, but it can be useful for structuring reusable code or including third party components that aren't part of ESP-IDF.
86 - "main" directory is a special "pseudo-component" that contains source code for the project itself. "main" is a default name, the Makefile variable ``SRCDIRS`` defaults to this but can be set to look for pseudo-components in other directories.
88 - "build" directory is where build output is created. After the make process is run, this directory will contain interim object files and libraries as well as final binary output files. This directory is usually not added to source control or distributed with the project source code.
90 Component directories contain a component makefile - ``component.mk``. This may contain variable definitions
91 to control the build process of the component, and its integration into the overall project. See `Component Makefiles` for more details.
93 Each component may also include a ``Kconfig`` file defining the `component configuration` options that can be set via the project configuration. Some components may also include ``Kconfig.projbuild`` and ``Makefile.projbuild`` files, which are special files for `overriding parts of the project`.
98 Each project has a single Makefile that contains build settings for the entire project. By default, the project Makefile can be quite minimal.
100 Minimal Example Makefile
101 ^^^^^^^^^^^^^^^^^^^^^^^^
104 PROJECT_NAME := myProject
106 include $(IDF_PATH)/make/project.mk
109 Mandatory Project Variables
110 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
112 - ``PROJECT_NAME``: Name of the project. Binary output files will use this name - ie myProject.bin, myProject.elf.
114 Optional Project Variables
115 ^^^^^^^^^^^^^^^^^^^^^^^^^^
117 These variables all have default values that can be overridden for custom behaviour. Look in ``make/project.mk`` for all of the implementation details.
119 - ``PROJECT_PATH``: Top-level project directory. Defaults to the directory containing the Makefile. Many other project variables are based on this variable. The project path cannot contain spaces.
120 - ``BUILD_DIR_BASE``: The build directory for all objects/libraries/binaries. Defaults to ``$(PROJECT_PATH)/build``.
121 - ``COMPONENT_DIRS``: Directories to search for components. Defaults to `$(IDF_PATH)/components`, `$(PROJECT_PATH)/components` and ``EXTRA_COMPONENT_DIRS``. Override this variable if you don't want to search for components in the esp-idf & project ``components`` directories.
122 - ``EXTRA_COMPONENT_DIRS``: Optional list of additional directories to search for components. Components themselves are in sub-directories of these directories, this is a top-level directory containing the component directories.
123 - ``COMPONENTS``: A list of component names to build into the project. Defaults to all components found in the COMPONENT_DIRS directories.
124 - ``SRCDIRS``: Directories under the main project directory which contain project-specific "pseudo-components". Defaults to 'main'. The difference between specifying a directory here and specifying it under ``EXTRA_COMPONENT_DIRS`` is that a directory in ``SRCDIRS`` is a component itself (contains a file "component.mk"), whereas a directory in ``EXTRA_COMPONENT_DIRS`` contains component directories which contain a file "component.mk". See the `Example Project` for a concrete case of this.
130 Each project contains one or more components, which can either be part of esp-idf or added from other component directories.
132 A component is any sub-directory that contains a `component.mk` file.[#f1]_.
134 Minimal Component Makefile
135 ^^^^^^^^^^^^^^^^^^^^^^^^^^
137 The minimal ``component.mk`` file is an empty file(!). If the file is empty, the default component behaviour is set:
138 - All source files in the same directory as the makefile (*.c, *.cpp, *.S) will be compiled into the component library
139 - A sub-directory "include" will be added to the global include search path for all other components.
140 - The component library will be linked into the project app.
142 See `example component makefiles` for more complete component makefile examples.
144 Note that there is a different between an empty ``component.mk`` file (which invokes default component build behaviour) and no ``component.mk`` file (which means no default component build behaviour will occur.) It is possible for a component to have no `component.mk` file, if it only contains other files which influence the project configuration or build process.
146 .. component variables:
148 Preset Component Variables
149 ^^^^^^^^^^^^^^^^^^^^^^^^^^
151 The following component-specific variables are available for use inside ``component.mk``, but should not be modified:
153 - ``COMPONENT_PATH``: The component directory. Evaluates to the absolute path of the directory containing ``component.mk``. The component path cannot contain spaces.
154 - ``COMPONENT_NAME``: Name of the component. Defaults to the name of the component directory.
155 - ``COMPONENT_BUILD_DIR``: The component build directory. Evaluates to the absolute path of a directory inside `$(BUILD_DIR_BASE)` where this component's source files are to be built. This is also the Current Working Directory any time the component is being built, so relative paths in make targets, etc. will be relative to this directory.
156 - ``COMPONENT_LIBRARY``: Name of the static library file (relative to the component build directory) that will be built for this component. Defaults to ``$(COMPONENT_NAME).a``.
158 The following variables are set at the project level, but exported for use in the component build:
160 - ``PROJECT_NAME``: Name of the project, as set in project Makefile
161 - ``PROJECT_PATH``: Absolute path of the project directory containing the project Makefile.
162 - ``COMPONENTS``: Name of all components that are included in this build.
163 - ``CONFIG_*``: Each value in the project configuration has a corresponding variable available in make. All names begin with ``CONFIG_``.
164 - ``CC``, ``LD``, ``AR``, ``OBJCOPY``: Full paths to each tool from the gcc xtensa cross-toolchain.
165 - ``HOSTCC``, ``HOSTLD``, ``HOSTAR``: Full names of each tool from the host native toolchain.
167 If you modify any of these variables inside ``component.mk`` then this will not prevent other components from building but it may make your component hard to build and/or debug.
169 Optional Project-Wide Component Variables
170 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
172 The following variables can be set inside ``component.mk`` to control build settings across the entire project:
174 - ``COMPONENT_ADD_INCLUDEDIRS``: Paths, relative to the component
175 directory, which will be added to the include search path for
176 all components in the project. Defaults to ``include`` if not overridden. If an include directory is only needed to compile
177 this specific component, add it to ``COMPONENT_PRIV_INCLUDEDIRS`` instead.
178 - ``COMPONENT_ADD_LDFLAGS``: Add linker arguments to the LDFLAGS for
179 the app executable. Defaults to ``-l$(COMPONENT_NAME)``. If
180 adding pre-compiled libraries to this directory, add them as
181 absolute paths - ie $(COMPONENT_PATH)/libwhatever.a
182 - ``COMPONENT_DEPENDS``: Optional list of component names that should
183 be compiled before this component. This is not necessary for
184 link-time dependencies, because all component include directories
185 are available at all times. It is necessary if one component
186 generates an include file which you then want to include in another
187 component. Most components do not need to set this variable.
189 The following variable only works for components that are part of esp-idf itself:
191 - ``COMPONENT_SUBMODULES``: Optional list of git submodule paths
192 (relative to COMPONENT_PATH) used by the component. These will be
193 checked (and initialised if necessary) by the build process. This
194 variable is ignored if the component is outside the IDF_PATH
198 Optional Component-Specific Variables
199 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
201 The following variables can be set inside ``component.mk`` to control the build of that component:
203 - ``COMPONENT_PRIV_INCLUDEDIRS``: Directory paths, must be relative to
204 the component directory, which will be added to the include search
205 path for this component's source files only.
206 - ``COMPONENT_EXTRA_INCLUDES``: Any extra include paths used when
207 compiling the component's source files. These will be prefixed with
208 '-I' and passed as-is to the compiler. Similar to the
209 ``COMPONENT_PRIV_INCLUDEDIRS`` variable, except these paths are not
210 expanded relative to the component directory.
211 - ``COMPONENT_SRCDIRS``: Directory paths, must be relative to the
212 component directory, which will be searched for source files (*.cpp,
213 *.c, *.S). Defaults to '.', ie the component directory
214 itself. Override this to specify a different list of directories
215 which contain source files.
216 - ``COMPONENT_OBJS``: Object files to compile. Default value is a .o
217 file for each source file that is found in ``COMPONENT_SRCDIRS``.
218 Overriding this list allows you to exclude source files in
219 ``COMPONENT_SRCDIRS`` that would otherwise be compiled. See
220 `Specifying source files`
221 - ``COMPONENT_EXTRA_CLEAN``: Paths, relative to the component build
222 directory, of any files that are generated using custom make rules
223 in the component.mk file and which need to be removed as part of
224 ``make clean``. See `Source Code Generation` for an example.
225 - ``COMPONENT_OWNBUILDTARGET`` & `COMPONENT_OWNCLEANTARGET`: These
226 targets allow you to fully override the default build behaviour for
227 the component. See `Fully Overriding The Component Makefile` for
229 - ``CFLAGS``: Flags passed to the C compiler. A default set of
230 ``CFLAGS`` is defined based on project settings. Component-specific
231 additions can be made via ``CFLAGS +=``. It is also possible
232 (although not recommended) to override this variable completely for
234 - ``CPPFLAGS``: Flags passed to the C preprocessor (used for .c, .cpp
235 and .S files). A default set of ``CPPFLAGS`` is defined based on
236 project settings. Component-specific additions can be made via
237 ``CPPFLAGS +=``. It is also possible (although not recommended) to
238 override this variable completely for a component.
239 - ``CXXFLAGS``: Flags passed to the C++ compiler. A default set of
240 ``CXXFLAGS`` is defined based on project
241 settings. Component-specific additions can be made via ``CXXFLAGS
242 +=``. It is also possible (although not recommended) to override
243 this variable completely for a component.
245 Component Configuration
246 -----------------------
248 Each component can also have a Kconfig file, alongside ``component.mk``. This contains contains
249 configuration settings to add to the "make menuconfig" for this component.
251 These settings are found under the "Component Settings" menu when menuconfig is run.
253 To create a component KConfig file, it is easiest to start with one of the KConfig files distributed with esp-idf.
255 For an example, see `Adding conditional configuration`.
257 Build Process Internals
258 -----------------------
260 Top Level: Project Makefile
261 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
263 - "make" is always run from the project directory and the project makefile, typically named Makefile.
264 - The project makefile sets ``PROJECT_NAME`` and optionally customises other `optional project variables`
265 - The project makefile includes ``$(IDF_PATH)/make/project.mk`` which contains the project-level Make logic.
266 - ``project.mk`` fills in default project-level make variables and includes make variables from the project configuration. If the generated makefile containing project configuration is out of date, then it is regenerated (via targets in ``project_config.mk``) and then the make process restarts from the top.
267 - ``project.mk`` builds a list of components to build, based on the default component directories or a custom list of components set in `optional project variables`.
268 - Each component can set some `optional project-wide component variables`. These are included via generated makefiles named ``component_project_vars.mk`` - there is one per component. These generated makefiles are included into ``project.mk``. If any are missing or out of date, they are regenerated (via a recursive make call to the component makefile) and then the make process restarts from the top.
269 - `Makefile.projbuild` files from components are included into the make process, to add extra targets or configuration.
270 - By default, the project makefile also generates top-level build & clean targets for each component and sets up `app` and `clean` targets to invoke all of these sub-targets.
271 - In order to compile each component, a recursive make is performed for the component makefile.
273 To better understand the project make process, have a read through the ``project.mk`` file itself.
275 Second Level: Component Makefiles
276 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
278 - Each call to a component makefile goes via the ``$(IDF_PATH)/make/component_wrapper.mk`` wrapper makefile.
279 - The ``component_wrapper.mk`` is called with the current directory set to the component build directory, and the ``COMPONENT_MAKEFILE`` variable is set to the absolute path to ``component.mk``.
280 - ``component_wrapper.mk`` sets default values for all `component variables`, then includes the `component.mk` file which can override or modify these.
281 - If ``COMPONENT_OWNBUILDTARGET`` and ``COMPONENT_OWNCLEANTARGET`` are not defined, default build and clean targets are created for the component's source files and the prerequisite ``COMPONENT_LIBRARY`` static library file.
282 - The ``component_project_vars.mk`` file has its own target in ``component_wrapper.mk``, which is evaluated from ``project.mk`` if this file needs to be rebuilt due to changes in the component makefile or the project configuration.
284 To better understand the component make process, have a read through the ``component_wrapper.mk`` file and some of the ``component.mk`` files included with esp-idf.
286 Debugging The Make Process
287 --------------------------
289 Some tips for debugging the esp-idf build system:
291 - Appending ``V=1`` to the make arguments (or setting it as an environment variable) will cause make to echo all commands executed, and also each directory as it is entered for a sub-make.
292 - Running ``make -w`` will cause make to echo each directory as it is entered for a sub-make - same as ``V=1`` but without also echoing all commands.
293 - Running ``make --trace`` (possibly in addition to one of the above arguments) will print out every target as it is built, and the dependency which caused it to be built.
294 - Running ``make -p`` prints a (very verbose) summary of every generated target in each makefile.
296 For more debugging tips and general make information, see the `GNU Make Manual`.
298 Overriding Parts of the Project
299 -------------------------------
304 For components that have build requirements that must be evaluated in the top-level
305 project make pass, you can create a file called ``Makefile.projbuild`` in the
306 component directory. This makefile is included when ``project.mk`` is evaluated.
308 For example, if your component needs to add to CFLAGS for the entire
309 project (not just for its own source files) then you can set
310 ``CFLAGS +=`` in Makefile.projbuild.
312 ``Makefile.projbuild`` files are used heavily inside esp-idf, for defining project-wide build features such as ``esptool.py`` command line arguments and the ``bootloader`` "special app".
314 Note that ``Makefile.projbuild`` isn't necessary for the most common component uses - such as adding include directories to the project, or LDFLAGS to the final linking step. These values can be customised via the ``component.mk`` file itself. See `Optional Project-Wide Component Variables` for details.
316 Take care when setting variables or targets in this file. As the values are included into the top-level project makefile pass, they can influence or break functionality across all components!
321 This is an equivalent to `Makefile.projbuild` for `component configuration` KConfig files. If you want to include
322 configuration options at the top-level of menuconfig, rather than inside the "Component Configuration" sub-menu, then these can be defined in the KConfig.projbuild file alongside the ``component.mk`` file.
324 Take care when adding configuration values in this file, as they will be included across the entire project configuration. Where possible, it's generally better to create a KConfig file for `component configuration`.
327 Example Component Makefiles
328 ---------------------------
330 Because the build environment tries to set reasonable defaults that will work most
331 of the time, component.mk can be very small or even empty (see `Minimal Component Makefile`). However, overriding `component variables` is usually required for some functionality.
333 Here are some more advanced examples of ``component.mk`` makefiles:
336 Adding source directories
337 ^^^^^^^^^^^^^^^^^^^^^^^^^
339 By default, sub-directories are ignored. If your project has sources in sub-directories
340 instead of in the root of the component then you can tell that to the build
341 system by setting ``COMPONENT_SRCDIRS``::
343 COMPONENT_SRCDIRS := src1 src2
345 This will compile all source files in the src1/ and src2/ sub-directories
348 Specifying source files
349 ^^^^^^^^^^^^^^^^^^^^^^^
351 The standard component.mk logic adds all .S and .c files in the source
352 directories as sources to be compiled unconditionally. It is possible
353 to circumvent that logic and hard-code the objects to be compiled by
354 manually setting the ``COMPONENT_OBJS`` variable to the name of the
355 objects that need to be generated::
357 COMPONENT_OBJS := file1.o file2.o thing/filea.o thing/fileb.o anotherthing/main.o
358 COMPONENT_SRCDIRS := . thing anotherthing
360 Note that ``COMPONENT_SRCDIRS`` must be set as well.
362 Adding conditional configuration
363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
365 The configuration system can be used to conditionally compile some files
366 depending on the options selected in ``make menuconfig``:
369 config FOO_ENABLE_BAR
370 bool "Enable the BAR feature."
372 This enables the BAR feature of the FOO component.
375 COMPONENT_OBJS := foo_a.o foo_b.o
378 COMPONENT_OBJS += foo_bar.o foo_bar_interface.o
381 See the `GNU Make Manual` for conditional syntax that can be used use in makefiles.
384 Source Code Generation
385 ^^^^^^^^^^^^^^^^^^^^^^
387 Some components will have a situation where a source file isn't
388 supplied with the component itself but has to be generated from
389 another file. Say our component has a header file that consists of the
390 converted binary data of a BMP file, converted using a hypothetical
391 tool called bmp2h. The header file is then included in as C source
392 file called graphics_lib.c::
394 COMPONENT_EXTRA_CLEAN := logo.h
396 graphics_lib.o: logo.h
398 logo.h: $(COMPONENT_PATH)/logo.bmp
402 In this example, graphics_lib.o and logo.h will be generated in the
403 current directory (the build directory) while logo.bmp comes with the
404 component and resides under the component path. Because logo.h is a
405 generated file, it needs to be cleaned when make clean is called which
406 why it is added to the COMPONENT_EXTRA_CLEAN variable.
408 Cosmetic Improvements
409 ^^^^^^^^^^^^^^^^^^^^^
411 Because logo.h is a generated file, it needs to be cleaned when make
412 clean is called which why it is added to the COMPONENT_EXTRA_CLEAN
415 Adding logo.h to the ``graphics_lib.o`` dependencies causes it to be
416 generated before ``graphics_lib.c`` is compiled.
418 If a a source file in another component included ``logo.h``, then this
419 component's name would have to be added to the other component's
420 ``COMPONENT_DEPENDS`` list to ensure that the components were built
423 Embedding Binary Data
424 ^^^^^^^^^^^^^^^^^^^^^
426 Sometimes you have a file with some binary or text data that you'd like to make available to your component - but you don't want to reformat the file as C source.
428 You can set a variable COMPONENT_EMBED_FILES in component.mk, giving the names of the files to embed in this way::
430 COMPONENT_EMBED_FILES := server_root_cert.der
432 Or if the file is a string, you can use the variable COMPONENT_EMBED_TXTFILES. This will embed the contents of the text file as a null-terminated string::
434 COMPONENT_EMBED_TXTFILES := server_root_cert.pem
436 The file's contents will be added to the .rodata section in flash, and are available via symbol names as follows::
438 extern const uint8_t server_root_cert_pem_start[] asm("_binary_server_root_cert_pem_start");
439 extern const uint8_t server_root_cert_pem_end[] asm("_binary_server_root_cert_pem_end");
441 The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files.
443 For an example of using this technique, see examples/04_https_request - the certificate file contents are loaded from the text .pem file at compile time.
446 Fully Overriding The Component Makefile
447 ---------------------------------------
449 Obviously, there are cases where all these recipes are insufficient for a
450 certain component, for example when the component is basically a wrapper
451 around another third-party component not originally intended to be
452 compiled under this build system. In that case, it's possible to forego
453 the esp-idf build system entirely by setting COMPONENT_OWNBUILDTARGET and
454 possibly COMPONENT_OWNCLEANTARGET and defining your own targets named ``build`` and ``clean`` in ``component.mk``
455 target. The build target can do anything as long as it creates
456 $(COMPONENT_LIBRARY) for the project make process to link into the app binary.
458 (Actually, even this is not strictly necessary - if the COMPONENT_ADD_LDFLAGS variable
459 is set then the component can instruct the linker to link other binaries instead.)
462 .. _esp-idf-template: https://github.com/espressif/esp-idf-template
463 .. _GNU Make Manual: https://www.gnu.org/software/make/manual/make.html
464 .. _[_f1]: Actually, some components in esp-idf are "pure configuration" components that don't have a component.mk file, only a Makefile.projbuild and/or Kconfig.projbuild file. However, these components are unusual and most components have a component.mk file.
projects / esp-idf / blob