1#
2# Copyright (C) 2008 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#
19# Handle various build version information.
20#
21# Guarantees that the following are defined:
22#     PLATFORM_VERSION
23#     PLATFORM_DISPLAY_VERSION
24#     PLATFORM_SDK_VERSION
25#     PLATFORM_SDK_EXTENSION_VERSION
26#     PLATFORM_VERSION_CODENAME
27#     DEFAULT_APP_TARGET_SDK
28#     BUILD_ID
29#     BUILD_NUMBER
30#     PLATFORM_SECURITY_PATCH
31#     PLATFORM_SYSTEMSDK_VERSIONS
32#     PLATFORM_VERSION_LAST_STABLE
33#     PLATFORM_VERSION_KNOWN_CODENAMES
34#
35
36# Look for an optional file containing overrides of the defaults,
37# but don't cry if we don't find it.  We could just use -include, but
38# the build.prop target also wants INTERNAL_BUILD_ID_MAKEFILE to be set
39# if the file exists.
40#
41INTERNAL_BUILD_ID_MAKEFILE := $(wildcard $(BUILD_SYSTEM)/build_id.mk)
42ifdef INTERNAL_BUILD_ID_MAKEFILE
43  include $(INTERNAL_BUILD_ID_MAKEFILE)
44endif
45
46ifdef TARGET_PLATFORM_VERSION
47  $(error Do not set TARGET_PLATFORM_VERSION directly. Use RELEASE_PLATFORM_VERSION. value: $(TARGET_PLATFORM_VERSION))
48endif
49TARGET_PLATFORM_VERSION := $(RELEASE_PLATFORM_VERSION)
50.KATI_READONLY := TARGET_PLATFORM_VERSION
51
52ifdef PLATFORM_SECURITY_PATCH
53  $(error Do not set PLATFORM_SECURITY_PATCH directly. Use RELEASE_PLATFORM_SECURITY_PATCH. value: $(PLATFORM_SECURITY_PATCH))
54endif
55PLATFORM_SECURITY_PATCH := $(RELEASE_PLATFORM_SECURITY_PATCH)
56.KATI_READONLY := PLATFORM_SECURITY_PATCH
57
58ifdef PLATFORM_SDK_VERSION
59  $(error Do not set PLATFORM_SDK_VERSION directly. Use RELEASE_PLATFORM_SDK_VERSION. value: $(PLATFORM_SDK_VERSION))
60endif
61PLATFORM_SDK_VERSION := $(RELEASE_PLATFORM_SDK_VERSION)
62.KATI_READONLY := PLATFORM_SDK_VERSION
63
64ifdef PLATFORM_SDK_EXTENSION_VERSION
65  $(error Do not set PLATFORM_SDK_EXTENSION_VERSION directly. Use RELEASE_PLATFORM_SDK_EXTENSION_VERSION. value: $(PLATFORM_SDK_EXTENSION_VERSION))
66endif
67PLATFORM_SDK_EXTENSION_VERSION := $(RELEASE_PLATFORM_SDK_EXTENSION_VERSION)
68.KATI_READONLY := PLATFORM_SDK_EXTENSION_VERSION
69
70# This is the sdk extension version that PLATFORM_SDK_VERSION ships with.
71PLATFORM_BASE_SDK_EXTENSION_VERSION := $(PLATFORM_SDK_EXTENSION_VERSION)
72.KATI_READONLY := PLATFORM_BASE_SDK_EXTENSION_VERSION
73
74ifdef PLATFORM_VERSION_CODENAME
75  $(error Do not set PLATFORM_VERSION_CODENAME directly. Use RELEASE_PLATFORM_VERSION. value: $(PLATFORM_VERSION_CODENAME))
76endif
77PLATFORM_VERSION_CODENAME := $(RELEASE_PLATFORM_VERSION_CODENAME)
78.KATI_READONLY := PLATFORM_VERSION_CODENAME
79
80ifdef PLATFORM_VERSION_ALL_CODENAMES
81  $(error Do not set PLATFORM_VERSION_ALL_CODENAMES directly. Use RELEASE_PLATFORM_VERSION_ALL_CODENAMES. value: $(PLATFORM_VERSION_ALL_CODENAMES))
82endif
83PLATFORM_VERSION_ALL_CODENAMES := $(RELEASE_PLATFORM_VERSION_ALL_CODENAMES)
84.KATI_READONLY := PLATFORM_VERSION_ALL_CODENAMES
85
86ifdef PLATFORM_VERSION_ALL_PREVIEW_CODENAMES
87  $(error Do not set PLATFORM_VERSION_ALL_PREVIEW_CODENAMES directly. Use RELEASE_PLATFORM_VERSION_ALL_PREVIEW_CODENAMES. value: $(PLATFORM_VERSION_ALL_PREVIEW_CODENAMES))
88endif
89PLATFORM_VERSION_ALL_PREVIEW_CODENAMES := $(RELEASE_PLATFORM_VERSION_ALL_PREVIEW_CODENAMES)
90.KATI_READONLY := PLATFORM_VERSION_ALL_PREVIEW_CODENAMES
91
92ifdef PLATFORM_VERSION_LAST_STABLE
93  $(error Do not set PLATFORM_VERSION_LAST_STABLE directly. Use RELEASE_PLATFORM_VERSION_LAST_STABLE. value: $(PLATFORM_VERSION_CODENAME))
94endif
95PLATFORM_VERSION_LAST_STABLE := $(RELEASE_PLATFORM_VERSION_LAST_STABLE)
96.KATI_READONLY := PLATFORM_VERSION_LAST_STABLE
97
98ifdef PLATFORM_VERSION_KNOWN_CODENAMES
99  $(error Do not set PLATFORM_VERSION_KNOWN_CODENAMES directly. Use RELEASE_PLATFORM_VERSION_KNOWN_CODENAMES. value: $(PLATFORM_VERSION_KNOWN_CODENAMES))
100endif
101PLATFORM_VERSION_KNOWN_CODENAMES := $(RELEASE_PLATFORM_VERSION_KNOWN_CODENAMES)
102.KATI_READONLY := PLATFORM_VERSION_KNOWN_CODENAMES
103
104ifndef PLATFORM_VERSION
105  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
106      PLATFORM_VERSION := $(PLATFORM_VERSION_LAST_STABLE)
107  else
108      PLATFORM_VERSION := $(PLATFORM_VERSION_CODENAME)
109  endif
110endif
111.KATI_READONLY := PLATFORM_VERSION
112
113ifndef PLATFORM_DISPLAY_VERSION
114  PLATFORM_DISPLAY_VERSION := $(PLATFORM_VERSION)
115endif
116.KATI_READONLY := PLATFORM_DISPLAY_VERSION
117
118ifeq (REL,$(PLATFORM_VERSION_CODENAME))
119  PLATFORM_PREVIEW_SDK_VERSION := 0
120else
121  ifndef PLATFORM_PREVIEW_SDK_VERSION
122    # This is the definition of a preview SDK version over and above the current
123    # platform SDK version. Unlike the platform SDK version, a higher value
124    # for preview SDK version does NOT mean that all prior preview APIs are
125    # included. Packages reading this value to determine compatibility with
126    # known APIs should check that this value is precisely equal to the preview
127    # SDK version the package was built for, otherwise it should fall back to
128    # assuming the device can only support APIs as of the previous official
129    # public release.
130    # This value will always be forced to 0 for release builds by the logic
131    # in the "ifeq" block above, so the value below will be used on any
132    # non-release builds, and it should always be at least 1, to indicate that
133    # APIs may have changed since the claimed PLATFORM_SDK_VERSION.
134    PLATFORM_PREVIEW_SDK_VERSION := 1
135  endif
136endif
137.KATI_READONLY := PLATFORM_PREVIEW_SDK_VERSION
138
139ifndef DEFAULT_APP_TARGET_SDK
140  # This is the default minSdkVersion and targetSdkVersion to use for
141  # all .apks created by the build system.  It can be overridden by explicitly
142  # setting these in the .apk's AndroidManifest.xml.  It is either the code
143  # name of the development build or, if this is a release build, the official
144  # SDK version of this release.
145  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
146    DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
147  else
148    DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
149  endif
150endif
151.KATI_READONLY := DEFAULT_APP_TARGET_SDK
152
153ifndef PLATFORM_SYSTEMSDK_MIN_VERSION
154  # This is the oldest version of system SDK that the platform supports. Contrary
155  # to the public SDK where platform essentially supports all previous SDK versions,
156  # platform supports only a few number of recent system SDK versions as some of
157  # old system APIs are gradually deprecated, removed and then deleted.
158  PLATFORM_SYSTEMSDK_MIN_VERSION := 29
159endif
160.KATI_READONLY := PLATFORM_SYSTEMSDK_MIN_VERSION
161
162# This is the list of system SDK versions that the current platform supports.
163PLATFORM_SYSTEMSDK_VERSIONS :=
164ifneq (,$(PLATFORM_SYSTEMSDK_MIN_VERSION))
165  $(if $(call math_is_number,$(PLATFORM_SYSTEMSDK_MIN_VERSION)),,\
166    $(error PLATFORM_SYSTEMSDK_MIN_VERSION must be a number, but was $(PLATFORM_SYSTEMSDK_MIN_VERSION)))
167  PLATFORM_SYSTEMSDK_VERSIONS := $(call int_range_list,$(PLATFORM_SYSTEMSDK_MIN_VERSION),$(PLATFORM_SDK_VERSION))
168endif
169# Platform always supports the current version
170ifeq (REL,$(PLATFORM_VERSION_CODENAME))
171  PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_SDK_VERSION)
172else
173  PLATFORM_SYSTEMSDK_VERSIONS += $(subst $(comma),$(space),$(PLATFORM_VERSION_ALL_CODENAMES))
174endif
175PLATFORM_SYSTEMSDK_VERSIONS := $(strip $(sort $(PLATFORM_SYSTEMSDK_VERSIONS)))
176.KATI_READONLY := PLATFORM_SYSTEMSDK_VERSIONS
177
178.KATI_READONLY := PLATFORM_SECURITY_PATCH
179
180ifndef PLATFORM_SECURITY_PATCH_TIMESTAMP
181  # Used to indicate the matching timestamp for the security patch string in PLATFORM_SECURITY_PATCH.
182  PLATFORM_SECURITY_PATCH_TIMESTAMP := $(shell date -d 'TZ="GMT" $(PLATFORM_SECURITY_PATCH)' +%s)
183endif
184.KATI_READONLY := PLATFORM_SECURITY_PATCH_TIMESTAMP
185
186ifndef PLATFORM_BASE_OS
187  # Used to indicate the base os applied to the device.
188  # Can be an arbitrary string, but must be a single word.
189  #
190  # If there is no $PLATFORM_BASE_OS set, keep it empty.
191  PLATFORM_BASE_OS :=
192endif
193.KATI_READONLY := PLATFORM_BASE_OS
194
195ifndef BUILD_ID
196  # Used to signify special builds.  E.g., branches and/or releases,
197  # like "M5-RC7".  Can be an arbitrary string, but must be a single
198  # word and a valid file name.
199  #
200  # If there is no BUILD_ID set, make it obvious.
201  BUILD_ID := UNKNOWN
202endif
203.KATI_READONLY := BUILD_ID
204
205ifndef BUILD_DATETIME
206  # Used to reproduce builds by setting the same time. Must be the number
207  # of seconds since the Epoch.
208  BUILD_DATETIME := $(shell date +%s)
209endif
210
211DATE := date -d @$(BUILD_DATETIME)
212.KATI_READONLY := DATE
213
214# Everything should be using BUILD_DATETIME_FROM_FILE instead.
215# BUILD_DATETIME and DATE can be removed once BUILD_NUMBER moves
216# to soong_ui.
217$(KATI_obsolete_var BUILD_DATETIME,Use BUILD_DATETIME_FROM_FILE)
218
219ifndef HAS_BUILD_NUMBER
220  HAS_BUILD_NUMBER := false
221endif
222.KATI_READONLY := HAS_BUILD_NUMBER
223
224ifdef PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION
225  $(error Do not set PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION directly. Use RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION. value: $(PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION))
226endif
227PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION := $(RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION)
228.KATI_READONLY := PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION
229