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