product.mk revision 0d23fec792d2bc92417d2b2e716be73704efc240 
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#
25define _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
29endef
30
31#
32# Returns the sorted concatenation of PRODUCT_MAKEFILES
33# variables set in the given AndroidProducts.mk files.
34# $(1): the list of AndroidProducts.mk files.
35#
36define get-product-makefiles
37$(sort \
38  $(foreach f,$(1), \
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 )
47endef
48
49#
50# Returns the sorted concatenation of all PRODUCT_MAKEFILES
51# variables set in all AndroidProducts.mk files.
52# $(call ) isn't necessary.
53#
54define get-all-product-makefiles
55$(call get-product-makefiles,$(_find-android-products-files))
56endef
57
58#
59# Functions for including product makefiles
60#
61
62_product_var_list := \
63    PRODUCT_NAME \
64    PRODUCT_MODEL \
65    PRODUCT_LOCALES \
66    PRODUCT_AAPT_CONFIG \
67    PRODUCT_PACKAGES \
68    PRODUCT_DEVICE \
69    PRODUCT_MANUFACTURER \
70    PRODUCT_BRAND \
71    PRODUCT_PROPERTY_OVERRIDES \
72    PRODUCT_DEFAULT_PROPERTY_OVERRIDES \
73    PRODUCT_CHARACTERISTICS \
74    PRODUCT_COPY_FILES \
75    PRODUCT_OTA_PUBLIC_KEYS \
76    PRODUCT_EXTRA_RECOVERY_KEYS \
77    PRODUCT_PACKAGE_OVERLAYS \
78    DEVICE_PACKAGE_OVERLAYS \
79    PRODUCT_CONTRIBUTORS_FILE \
80    PRODUCT_TAGS \
81    PRODUCT_SDK_ADDON_NAME \
82    PRODUCT_SDK_ADDON_COPY_FILES \
83    PRODUCT_SDK_ADDON_COPY_MODULES \
84    PRODUCT_SDK_ADDON_DOC_MODULE \
85    PRODUCT_DEFAULT_WIFI_CHANNELS
86
87define dump-product
88$(info ==== $(1) ====)\
89$(foreach v,$(_product_var_list),\
90$(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
91$(info --------)
92endef
93
94define dump-products
95$(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
96endef
97
98#
99# $(1): product to inherit
100#
101# Does three things:
102#  1. Inherits all of the variables from $1.
103#  2. Records the inheritance in the .INHERITS_FROM variable
104#  3. Records that we've visited this node, in ALL_PRODUCTS
105#
106define inherit-product
107  $(foreach v,$(_product_var_list), \
108      $(eval $(v) := $($(v)) $(INHERIT_TAG)$(strip $(1)))) \
109  $(eval inherit_var := \
110      PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
111  $(eval $(inherit_var) := $(sort $($(inherit_var)) $(strip $(1)))) \
112  $(eval inherit_var:=) \
113  $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
114endef
115
116
117#
118# Do inherit-product only if $(1) exists
119#
120define inherit-product-if-exists
121  $(if $(wildcard $(1)),$(call inherit-product,$(1)),)
122endef
123
124#
125# $(1): product makefile list
126#
127#TODO: check to make sure that products have all the necessary vars defined
128define import-products
129$(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
130endef
131
132
133#
134# Does various consistency checks on all of the known products.
135# Takes no parameters, so $(call ) is not necessary.
136#
137define check-all-products
138$(if ,, \
139  $(eval _cap_names :=) \
140  $(foreach p,$(PRODUCTS), \
141    $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
142    $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
143    $(if $(filter $(pn),$(_cap_names)), \
144      $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
145          $(foreach \
146            pp,$(PRODUCTS),
147              $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
148                $(pp) \
149               ))) \
150       ) \
151     ) \
152    $(eval _cap_names += $(pn)) \
153    $(if $(call is-c-identifier,$(pn)),, \
154      $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
155     ) \
156    $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
157    $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
158    $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
159      $(if $(filter 2,$(words $(subst :,$(space),$(cf)))),, \
160        $(error $(p): malformed COPY_FILE "$(cf)") \
161       ) \
162     ) \
163   ) \
164)
165endef
166
167
168#
169# Returns the product makefile path for the product with the provided name
170#
171# $(1): short product name like "generic"
172#
173define _resolve-short-product-name
174  $(eval pn := $(strip $(1)))
175  $(eval p := \
176      $(foreach p,$(PRODUCTS), \
177          $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
178            $(p) \
179       )) \
180   )
181  $(eval p := $(sort $(p)))
182  $(if $(filter 1,$(words $(p))), \
183    $(p), \
184    $(if $(filter 0,$(words $(p))), \
185      $(error No matches for product "$(pn)"), \
186      $(error Product "$(pn)" ambiguous: matches $(p)) \
187    ) \
188  )
189endef
190define resolve-short-product-name
191$(strip $(call _resolve-short-product-name,$(1)))
192endef
193
194
195_product_stash_var_list := $(_product_var_list) \
196	TARGET_ARCH \
197	TARGET_ARCH_VARIANT \
198	TARGET_BOARD_PLATFORM \
199	TARGET_BOARD_PLATFORM_GPU \
200	TARGET_BOOTLOADER_BOARD_NAME \
201	TARGET_COMPRESS_MODULE_SYMBOLS \
202	TARGET_NO_BOOTLOADER \
203	TARGET_NO_KERNEL \
204	TARGET_NO_RECOVERY \
205	TARGET_NO_RADIOIMAGE \
206	TARGET_HARDWARE_3D \
207	TARGET_PROVIDES_INIT_RC \
208	TARGET_CPU_ABI \
209	TARGET_CPU_ABI2 \
210	TARGET_CPU_SMP \
211
212
213_product_stash_var_list += \
214	BOARD_WPA_SUPPLICANT_DRIVER \
215	BOARD_WLAN_DEVICE \
216	BOARD_USES_GENERIC_AUDIO \
217	BOARD_KERNEL_CMDLINE \
218	BOARD_KERNEL_BASE \
219	BOARD_HAVE_BLUETOOTH \
220	BOARD_HAVE_BLUETOOTH_BCM \
221	BOARD_VENDOR_QCOM_AMSS_VERSION \
222	BOARD_VENDOR_USE_AKMD \
223	BOARD_EGL_CFG \
224	BOARD_BOOTIMAGE_PARTITION_SIZE \
225	BOARD_RECOVERYIMAGE_PARTITION_SIZE \
226	BOARD_SYSTEMIMAGE_PARTITION_SIZE \
227	BOARD_USERDATAIMAGE_PARTITION_SIZE \
228	BOARD_FLASH_BLOCK_SIZE \
229	BOARD_SYSTEMIMAGE_PARTITION_SIZE \
230	BOARD_VENDOR_QCOM_GPS_LOC_API_HARDWARE \
231	BOARD_VENDOR_QCOM_GPS_LOC_API_AMSS_VERSION \
232	BOARD_INSTALLER_CMDLINE \
233
234
235#
236# Stash vaues of the variables in _product_stash_var_list.
237# $(1): Renamed prefix
238#
239define stash-product-vars
240$(foreach v,$(_product_stash_var_list), \
241        $(eval $(strip $(1))_$(call rot13,$(v)):=$$($$(v))) \
242 )
243endef
244
245#
246# Assert that the the variable stashed by stash-product-vars remains untouched.
247# $(1): The prefix as supplied to stash-product-vars
248#
249define assert-product-vars
250$(strip \
251  $(eval changed_variables:=)
252  $(foreach v,$(_product_stash_var_list), \
253    $(if $(call streq,$($(v)),$($(strip $(1))_$(call rot13,$(v)))),, \
254        $(eval $(warning $(v) has been modified: $($(v)))) \
255        $(eval $(warning previous value: $($(strip $(1))_$(call rot13,$(v))))) \
256        $(eval changed_variables := $(changed_variables) $(v))) \
257   ) \
258  $(if $(changed_variables),\
259    $(eval $(error The following variables have been changed: $(changed_variables))),)
260)
261endef
262