package/pkg-kconfig.mk

   1 ################################################################################
   2 # Kconfig package infrastructure
   3 #
   4 # This file implements an infrastructure that eases development of
   5 # package .mk files for packages that use kconfig for configuration files.
   6 # It is based on the generic-package infrastructure, and inherits all of its
   7 # features.
   8 #
   9 # See the Buildroot documentation for details on the usage of this
  10 # infrastructure.
  11 #
  12 ################################################################################
  13
  14 # Macro to update back the custom (def)config file
  15 # $(1): file to copy from
  16 define kconfig-package-update-config
  17         @$(if $($(PKG)_KCONFIG_FRAGMENT_FILES), \
  18                 echo "Unable to perform $(@) when fragment files are set"; exit 1)
  19         @$(if $($(PKG)_KCONFIG_DEFCONFIG), \
  20                 echo "Unable to perform $(@) when using a defconfig rule"; exit 1)
  21         $(Q)if [ -d $($(PKG)_KCONFIG_FILE) ]; then \
  22                 echo "Unable to perform $(@) when $($(PKG)_KCONFIG_FILE) is a directory"; \
  23                 exit 1; \
  24         fi
  25         $(Q)mkdir -p $(dir $($(PKG)_KCONFIG_FILE))
  26         cp -f $($(PKG)_DIR)/$(1) $($(PKG)_KCONFIG_FILE)
  27         $(Q)touch --reference $($(PKG)_DIR)/$($(PKG)_KCONFIG_DOTCONFIG) $($(PKG)_KCONFIG_FILE)
  28 endef
  29
  30 ################################################################################
  31 # inner-kconfig-package -- generates the make targets needed to support a
  32 # kconfig package
  33 #
  34 #  argument 1 is the lowercase package name
  35 #  argument 2 is the uppercase package name, including a HOST_ prefix
  36 #             for host packages
  37 #  argument 3 is the uppercase package name, without the HOST_ prefix
  38 #             for host packages
  39 #  argument 4 is the type (target or host)
  40 ################################################################################
  41
  42 define inner-kconfig-package
  43
  44 # Call the generic package infrastructure to generate the necessary
  45 # make targets.
  46 # Note: this must be done _before_ attempting to use $$($(2)_DIR) in a
  47 # dependency expression
  48 $(call inner-generic-package,$(1),$(2),$(3),$(4))
  49
  50 # Default values
  51 $(2)_KCONFIG_EDITORS ?= menuconfig
  52 $(2)_KCONFIG_OPTS ?=
  53 $(2)_KCONFIG_FIXUP_CMDS ?=
  54 $(2)_KCONFIG_FRAGMENT_FILES ?=
  55 $(2)_KCONFIG_DOTCONFIG ?= .config
  56
  57 # The config file as well as the fragments could be in-tree, so before
  58 # depending on them the package should be extracted (and patched) first.
  59 #
  60 # Since those files only have a order-only dependency, make would treat
  61 # any missing one as a "force" target:
  62 #   https://www.gnu.org/software/make/manual/make.html#Force-Targets
  63 # and would forcibly any rule that depend on those files, causing a
  64 # rebuild of the kernel each time make is called.
  65 #
  66 # So, we provide a recipe that checks all of those files exist, to
  67 # overcome that standard make behaviour.
  68 #
  69 $$($(2)_KCONFIG_FILE) $$($(2)_KCONFIG_FRAGMENT_FILES): | $(1)-patch
  70         for f in $$($(2)_KCONFIG_FILE) $$($(2)_KCONFIG_FRAGMENT_FILES); do \
  71                 if [ ! -f "$$$${f}" ]; then \
  72                         printf "Kconfig fragment '%s' for '%s' does not exist\n" "$$$${f}" "$(1)"; \
  73                         exit 1; \
  74                 fi; \
  75         done
  76
  77 $(2)_KCONFIG_MAKE = \
  78         $$($(2)_MAKE_ENV) $$(MAKE) -C $$($(2)_DIR) $$($(2)_KCONFIG_OPTS)
  79
  80 # $(2)_KCONFIG_MAKE may already rely on shell expansion. As the $() syntax
  81 # of the shell conflicts with Make's own syntax, this means that backticks
  82 # are used with those shell constructs. Unfortunately, the backtick syntax
  83 # does not nest, and we need to use Make instead of the shell to handle
  84 # conditions.
  85
  86 # A recursively expanded variable is necessary, to be sure that the shell
  87 # command is called when the rule is processed during the build and not
  88 # when the rule is created when parsing all packages.
  89 $(2)_KCONFIG_RULES = \
  90         $$(shell $$($(2)_KCONFIG_MAKE) -pn config 2>/dev/null | \
  91                 sed 's/^\([_0-9a-zA-Z]*config\):.*/\1/ p; d')
  92
  93 # The correct way to regenerate a .config file is to use 'make olddefconfig'.
  94 # For historical reasons, the target name is 'oldnoconfig' between Linux kernel
  95 # versions 2.6.36 and 3.6, and remains as an alias in later versions.
  96 # In older versions, and in some other projects that use kconfig, the target is
  97 # not supported at all, and we use 'yes "" | make oldconfig' as a fallback
  98 # only, as this can fail in complex cases.
  99 define $(2)_REGEN_DOT_CONFIG
 100         $$(if $$(filter olddefconfig,$$($(2)_KCONFIG_RULES)),
 101                 $$(Q)$$($(2)_KCONFIG_MAKE) olddefconfig,
 102                 $$(if $$(filter oldnoconfig,$$($(2)_KCONFIG_RULES)),
 103                         $$(Q)$$($(2)_KCONFIG_MAKE) oldnoconfig,
 104                         $$(Q)(yes "" | $$($(2)_KCONFIG_MAKE) oldconfig)))
 105 endef
 106
 107 # The specified source configuration file and any additional configuration file
 108 # fragments are merged together to .config, after the package has been patched.
 109 # Since the file could be a defconfig file it needs to be expanded to a
 110 # full .config first.
 111 $$($(2)_DIR)/$$($(2)_KCONFIG_DOTCONFIG): $$($(2)_KCONFIG_FILE) $$($(2)_KCONFIG_FRAGMENT_FILES)
 112         $$(Q)$$(if $$($(2)_KCONFIG_DEFCONFIG), \
 113                 $$($(2)_KCONFIG_MAKE) $$($(2)_KCONFIG_DEFCONFIG), \
 114                 $$(INSTALL) -m 0644 -D $$($(2)_KCONFIG_FILE) $$(@))
 115         $$(Q)support/kconfig/merge_config.sh -m -O $$(@D) \
 116                 $$(@) $$($(2)_KCONFIG_FRAGMENT_FILES)
 117         $$($(2)_REGEN_DOT_CONFIG)
 118
 119 # If _KCONFIG_FILE or _KCONFIG_FRAGMENT_FILES exists, this dependency is
 120 # already implied, but if we only have a _KCONFIG_DEFCONFIG we have to add
 121 # it explicitly. It doesn't hurt to always have it though.
 122 $$($(2)_DIR)/$$($(2)_KCONFIG_DOTCONFIG): | $(1)-patch
 123
 124 # In order to get a usable, consistent configuration, some fixup may be needed.
 125 # The exact rules are specified by the package .mk file.
 126 define $(2)_FIXUP_DOT_CONFIG
 127         $$($(2)_KCONFIG_FIXUP_CMDS)
 128         $$($(2)_REGEN_DOT_CONFIG)
 129         $$(Q)touch $$($(2)_DIR)/.stamp_kconfig_fixup_done
 130 endef
 131
 132 $$($(2)_DIR)/.stamp_kconfig_fixup_done: $$($(2)_DIR)/$$($(2)_KCONFIG_DOTCONFIG)
 133         $$($(2)_FIXUP_DOT_CONFIG)
 134
 135 # Before running configure, the configuration file should be present and fixed
 136 $$($(2)_TARGET_CONFIGURE): $$($(2)_DIR)/.stamp_kconfig_fixup_done
 137
 138 # Force olddefconfig again on -reconfigure
 139 $(1)-clean-for-reconfigure: $(1)-clean-kconfig-for-reconfigure
 140
 141 $(1)-clean-kconfig-for-reconfigure:
 142         rm -f $$($(2)_DIR)/.stamp_kconfig_fixup_done
 143
 144 # Only enable the foo-*config targets when the package is actually enabled.
 145 # Note: the variable $(2)_KCONFIG_VAR is not related to the kconfig
 146 # infrastructure, but defined by pkg-generic.mk. The generic infrastructure is
 147 # already called above, so we can effectively use this variable.
 148 ifeq ($$($$($(2)_KCONFIG_VAR)),y)
 149
 150 ifeq ($$(BR_BUILDING),y)
 151 # Either FOO_KCONFIG_FILE or FOO_KCONFIG_DEFCONFIG is required...
 152 ifeq ($$(or $$($(2)_KCONFIG_FILE),$$($(2)_KCONFIG_DEFCONFIG)),)
 153 $$(error Internal error: no value specified for $(2)_KCONFIG_FILE or $(2)_KCONFIG_DEFCONFIG)
 154 endif
 155 # ... but not both:
 156 ifneq ($$(and $$($(2)_KCONFIG_FILE),$$($(2)_KCONFIG_DEFCONFIG)),)
 157 $$(error Internal error: $(2)_KCONFIG_FILE and $(2)_KCONFIG_DEFCONFIG are mutually exclusive but both are defined)
 158 endif
 159 endif
 160
 161 # For the configurators, we do want to use the system-provided host
 162 # tools, not the ones we build. This is particularly true for
 163 # pkg-config; if we use our pkg-config (from host-pkgconf), then it
 164 # would not look for the .pc from the host, but we do need them,
 165 # especially to find ncurses, GTK+, Qt (resp. for menuconfig and
 166 # nconfig, gconfig, xconfig).
 167 # So we simply remove our PATH and PKG_CONFIG_* variables.
 168 $(2)_CONFIGURATOR_MAKE_ENV = \
 169         $$(filter-out PATH=% PKG_CONFIG=% PKG_CONFIG_SYSROOT_DIR=% PKG_CONFIG_LIBDIR=%,$$($(2)_MAKE_ENV)) \
 170         PKG_CONFIG_PATH="$(HOST_PKG_CONFIG_PATH)"
 171
 172 # Configuration editors (menuconfig, ...)
 173 #
 174 # We need to apply the configuration fixups right after a configuration
 175 # editor exits, so that it is possible to save the configuration right
 176 # after exiting an editor, and so the user always sees a .config file
 177 # that is clean wrt. our requirements.
 178 #
 179 # Because commands in $(1)_FIXUP_KCONFIG are probably using $(@D), we
 180 # need to have a valid @D set. But, because the configurators rules are
 181 # not real files and do not contain the path to the package build dir,
 182 # @D would be just '.' in this case. So, we use an intermediate rule
 183 # with a stamp-like file which path is in the package build dir, so we
 184 # end up having a valid @D.
 185 #
 186 $$(addprefix $(1)-,$$($(2)_KCONFIG_EDITORS)): $(1)-%: $$($(2)_DIR)/.kconfig_editor_%
 187 $$($(2)_DIR)/.kconfig_editor_%: $$($(2)_DIR)/.stamp_kconfig_fixup_done
 188         $$($(2)_CONFIGURATOR_MAKE_ENV) $$(MAKE) -C $$($(2)_DIR) \
 189                 $$($(2)_KCONFIG_OPTS) $$(*)
 190         rm -f $$($(2)_DIR)/.stamp_{kconfig_fixup_done,configured,built}
 191         rm -f $$($(2)_DIR)/.stamp_{target,staging,images}_installed
 192         $$($(2)_FIXUP_DOT_CONFIG)
 193
 194 # Saving back the configuration
 195 #
 196 # Ideally, that should directly depend on $$($(2)_DIR)/.stamp_kconfig_fixup_done,
 197 # but that breaks the use-case in PR-8156 (from a clean tree):
 198 #   make menuconfig           <- enable kernel, use an in-tree defconfig, save and exit
 199 #   make linux-menuconfig     <- enable/disable whatever option, save and exit
 200 #   make menuconfig           <- change to use a custom defconfig file, set a path, save and exit
 201 #   make linux-update-config  <- should save to the new custom defconfig file
 202 #
 203 # Because of that use-case, saving the configuration can *not* directly
 204 # depend on the stamp file, because it itself depends on the .config,
 205 # which in turn depends on the (newly-set an non-existent) custom
 206 # defconfig file.
 207 #
 208 # Instead, we use a PHONY rule that will catch that situation.
 209 #
 210 $(1)-check-configuration-done:
 211         @if [ ! -f $$($(2)_DIR)/.stamp_kconfig_fixup_done ]; then \
 212                 echo "$(1) is not yet configured"; \
 213                 exit 1; \
 214         fi
 215
 216 $(1)-savedefconfig: $(1)-check-configuration-done
 217         $$($(2)_MAKE_ENV) $$(MAKE) -C $$($(2)_DIR) \
 218                 $$($(2)_KCONFIG_OPTS) savedefconfig
 219
 220 # Target to copy back the configuration to the source configuration file
 221 # Even though we could use 'cp --preserve-timestamps' here, the separate
 222 # cp and 'touch --reference' is used for symmetry with $(1)-update-defconfig.
 223 $(1)-update-config: PKG=$(2)
 224 $(1)-update-config: $(1)-check-configuration-done
 225         $$(call kconfig-package-update-config,$$($(2)_KCONFIG_DOTCONFIG))
 226
 227 # Note: make sure the timestamp of the stored configuration is not newer than
 228 # the .config to avoid a useless rebuild. Note that, contrary to
 229 # $(1)-update-config, the reference for 'touch' is _not_ the file from which
 230 # we copy.
 231 $(1)-update-defconfig: PKG=$(2)
 232 $(1)-update-defconfig: $(1)-savedefconfig
 233         $$(call kconfig-package-update-config,defconfig)
 234
 235 endif # package enabled
 236
 237 .PHONY: \
 238         $(1)-update-config \
 239         $(1)-update-defconfig \
 240         $(1)-savedefconfig \
 241         $(1)-check-configuration-done \
 242         $$($(2)_DIR)/.kconfig_editor_% \
 243         $$(addprefix $(1)-,$$($(2)_KCONFIG_EDITORS))
 244
 245 endef # inner-kconfig-package
 246
 247 ################################################################################
 248 # kconfig-package -- the target generator macro for kconfig packages
 249 ################################################################################
 250
 251 kconfig-package = $(call inner-kconfig-package,$(pkgname),$(call UPPERCASE,$(pkgname)),$(call UPPERCASE,$(pkgname)),target)