core/product.mk

   1 #
   2 # Copyright (C) 2007 The Android Open Source Project
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #      http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 #
  16
  17 #
  18 # Functions for including AndroidProducts.mk files
  19 #
  20
  21 #
  22 # Returns the list of all AndroidProducts.mk files.
  23 # $(call ) isn't necessary.
  24 #
  25 define _find-android-products-files
  26 $(shell test -d device && find device -maxdepth 6 -name AndroidProducts.mk) \
  27   $(shell test -d vendor && find vendor -maxdepth 6 -name AndroidProducts.mk) \
  28   $(SRC_TARGET_DIR)/product/AndroidProducts.mk
  29 endef
  30
  31 #
  32 # Returns the sorted concatenation of all PRODUCT_MAKEFILES
  33 # variables set in all AndroidProducts.mk files.
  34 # $(call ) isn't necessary.
  35 #
  36 define get-all-product-makefiles
  37 $(sort \
  38   $(foreach f,$(_find-android-products-files), \
  39     $(eval PRODUCT_MAKEFILES :=) \
  40     $(eval LOCAL_DIR := $(patsubst %/,%,$(dir $(f)))) \
  41     $(eval include $(f)) \
  42     $(PRODUCT_MAKEFILES) \
  43    ) \
  44   $(eval PRODUCT_MAKEFILES :=) \
  45   $(eval LOCAL_DIR :=) \
  46  )
  47 endef
  48
  49 #
  50 # Functions for including product makefiles
  51 #
  52
  53 _product_var_list := \
  54     PRODUCT_NAME \
  55     PRODUCT_MODEL \
  56     PRODUCT_LOCALES \
  57     PRODUCT_PACKAGES \
  58     PRODUCT_DEVICE \
  59     PRODUCT_MANUFACTURER \
  60     PRODUCT_BRAND \
  61     PRODUCT_PROPERTY_OVERRIDES \
  62     PRODUCT_COPY_FILES \
  63     PRODUCT_OTA_PUBLIC_KEYS \
  64     PRODUCT_POLICY \
  65     PRODUCT_PACKAGE_OVERLAYS \
  66     DEVICE_PACKAGE_OVERLAYS \
  67     PRODUCT_CONTRIBUTORS_FILE \
  68     PRODUCT_TAGS \
  69     PRODUCT_SDK_ADDON_NAME \
  70     PRODUCT_SDK_ADDON_COPY_FILES \
  71     PRODUCT_SDK_ADDON_COPY_MODULES \
  72     PRODUCT_SDK_ADDON_DOC_MODULE \
  73     PRODUCT_DEFAULT_WIFI_CHANNELS
  74
  75 define dump-product
  76 $(info ==== $(1) ====)\
  77 $(foreach v,$(_product_var_list),\
  78 $(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
  79 $(info --------)
  80 endef
  81
  82 define dump-products
  83 $(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
  84 endef
  85
  86 #
  87 # $(1): product to inherit
  88 #
  89 # Does three things:
  90 #  1. Inherits all of the variables from $1.
  91 #  2. Records the inheritance in the .INHERITS_FROM variable
  92 #  3. Records that we've visited this node, in ALL_PRODUCTS
  93 #
  94 define inherit-product
  95   $(foreach v,$(_product_var_list), \
  96       $(eval $(v) := $($(v)) $(INHERIT_TAG)$(strip $(1)))) \
  97   $(eval inherit_var := \
  98       PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
  99   $(eval $(inherit_var) := $(sort $($(inherit_var)) $(strip $(1)))) \
 100   $(eval inherit_var:=) \
 101   $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
 102 endef
 103
 104 #
 105 # $(1): product makefile list
 106 #
 107 #TODO: check to make sure that products have all the necessary vars defined
 108 define import-products
 109 $(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
 110 endef
 111
 112
 113 #
 114 # Does various consistency checks on all of the known products.
 115 # Takes no parameters, so $(call ) is not necessary.
 116 #
 117 define check-all-products
 118 $(if ,, \
 119   $(eval _cap_names :=) \
 120   $(foreach p,$(PRODUCTS), \
 121     $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
 122     $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
 123     $(if $(filter $(pn),$(_cap_names)), \
 124       $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
 125           $(foreach \
 126             pp,$(PRODUCTS),
 127               $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
 128                 $(pp) \
 129                ))) \
 130        ) \
 131      ) \
 132     $(eval _cap_names += $(pn)) \
 133     $(if $(call is-c-identifier,$(pn)),, \
 134       $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
 135      ) \
 136     $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
 137     $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
 138     $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
 139       $(if $(filter 2,$(words $(subst :,$(space),$(cf)))),, \
 140         $(error $(p): malformed COPY_FILE "$(cf)") \
 141        ) \
 142      ) \
 143    ) \
 144 )
 145 endef
 146
 147
 148 #
 149 # Returns the product makefile path for the product with the provided name
 150 #
 151 # $(1): short product name like "generic"
 152 #
 153 define _resolve-short-product-name
 154   $(eval pn := $(strip $(1)))
 155   $(eval p := \
 156       $(foreach p,$(PRODUCTS), \
 157           $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
 158             $(p) \
 159        )) \
 160    )
 161   $(eval p := $(sort $(p)))
 162   $(if $(filter 1,$(words $(p))), \
 163     $(p), \
 164     $(if $(filter 0,$(words $(p))), \
 165       $(error No matches for product "$(pn)"), \
 166       $(error Product "$(pn)" ambiguous: matches $(p)) \
 167     ) \
 168   )
 169 endef
 170 define resolve-short-product-name
 171 $(strip $(call _resolve-short-product-name,$(1)))
 172 endef