product.mk revision 1a031e411ef5eca621c1958103407a6dc40a5114 
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_PACKAGES \
67    PRODUCT_DEVICE \
68    PRODUCT_MANUFACTURER \
69    PRODUCT_BRAND \
70    PRODUCT_PROPERTY_OVERRIDES \
71    PRODUCT_COPY_FILES \
72    PRODUCT_OTA_PUBLIC_KEYS \
73    PRODUCT_PACKAGE_OVERLAYS \
74    DEVICE_PACKAGE_OVERLAYS \
75    PRODUCT_CONTRIBUTORS_FILE \
76    PRODUCT_TAGS \
77    PRODUCT_SDK_ADDON_NAME \
78    PRODUCT_SDK_ADDON_COPY_FILES \
79    PRODUCT_SDK_ADDON_COPY_MODULES \
80    PRODUCT_SDK_ADDON_DOC_MODULE \
81    PRODUCT_DEFAULT_WIFI_CHANNELS
82
83define dump-product
84$(info ==== $(1) ====)\
85$(foreach v,$(_product_var_list),\
86$(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
87$(info --------)
88endef
89
90define dump-products
91$(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
92endef
93
94#
95# $(1): product to inherit
96#
97# Does three things:
98#  1. Inherits all of the variables from $1.
99#  2. Records the inheritance in the .INHERITS_FROM variable
100#  3. Records that we've visited this node, in ALL_PRODUCTS
101#
102define inherit-product
103  $(foreach v,$(_product_var_list), \
104      $(eval $(v) := $($(v)) $(INHERIT_TAG)$(strip $(1)))) \
105  $(eval inherit_var := \
106      PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
107  $(eval $(inherit_var) := $(sort $($(inherit_var)) $(strip $(1)))) \
108  $(eval inherit_var:=) \
109  $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
110endef
111
112
113#
114# Do inherit-product only if $(1) exists
115#
116define inherit-product-if-exists
117  $(if $(wildcard $(1)),$(call inherit-product,$(1)),)
118endef
119
120#
121# $(1): product makefile list
122#
123#TODO: check to make sure that products have all the necessary vars defined
124define import-products
125$(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
126endef
127
128
129#
130# Does various consistency checks on all of the known products.
131# Takes no parameters, so $(call ) is not necessary.
132#
133define check-all-products
134$(if ,, \
135  $(eval _cap_names :=) \
136  $(foreach p,$(PRODUCTS), \
137    $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
138    $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
139    $(if $(filter $(pn),$(_cap_names)), \
140      $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
141          $(foreach \
142            pp,$(PRODUCTS),
143              $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
144                $(pp) \
145               ))) \
146       ) \
147     ) \
148    $(eval _cap_names += $(pn)) \
149    $(if $(call is-c-identifier,$(pn)),, \
150      $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
151     ) \
152    $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
153    $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
154    $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
155      $(if $(filter 2,$(words $(subst :,$(space),$(cf)))),, \
156        $(error $(p): malformed COPY_FILE "$(cf)") \
157       ) \
158     ) \
159   ) \
160)
161endef
162
163
164#
165# Returns the product makefile path for the product with the provided name
166#
167# $(1): short product name like "generic"
168#
169define _resolve-short-product-name
170  $(eval pn := $(strip $(1)))
171  $(eval p := \
172      $(foreach p,$(PRODUCTS), \
173          $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
174            $(p) \
175       )) \
176   )
177  $(eval p := $(sort $(p)))
178  $(if $(filter 1,$(words $(p))), \
179    $(p), \
180    $(if $(filter 0,$(words $(p))), \
181      $(error No matches for product "$(pn)"), \
182      $(error Product "$(pn)" ambiguous: matches $(p)) \
183    ) \
184  )
185endef
186define resolve-short-product-name
187$(strip $(call _resolve-short-product-name,$(1)))
188endef
189