blob: 4dd383d77e5520c92f53244a34def48d3b8f39ca [file] [log] [blame]
Jiyong Parkc678ad32018-04-10 13:07:10 +09001// Copyright 2016 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Jaewoong Jung4b79e982020-06-01 10:45:49 -070015package etc
Jiyong Parkc678ad32018-04-10 13:07:10 +090016
Yo Chiang803c40d2020-11-16 20:32:51 +080017// This file implements module types that install prebuilt artifacts.
18//
19// There exist two classes of prebuilt modules in the Android tree. The first class are the ones
20// based on `android.Prebuilt`, such as `cc_prebuilt_library` and `java_import`. This kind of
21// modules may exist both as prebuilts and source at the same time, though only one would be
22// installed and the other would be marked disabled. The `prebuilt_postdeps` mutator would select
23// the actual modules to be installed. More details in android/prebuilt.go.
24//
25// The second class is described in this file. Unlike `android.Prebuilt` based module types,
26// `prebuilt_etc` exist only as prebuilts and cannot have a same-named source module counterpart.
27// This makes the logic of `prebuilt_etc` to be much simpler as they don't need to go through the
28// various `prebuilt_*` mutators.
Jaewoong Jung4b79e982020-06-01 10:45:49 -070029
Yo Chiang803c40d2020-11-16 20:32:51 +080030import (
Jiyong Park76a42f52021-02-16 06:50:37 +090031 "fmt"
Inseob Kim27408bf2021-04-06 21:00:17 +090032 "strings"
Jiyong Park76a42f52021-02-16 06:50:37 +090033
Jaewoong Jung4b79e982020-06-01 10:45:49 -070034 "github.com/google/blueprint/proptools"
35
36 "android/soong/android"
37)
38
39var pctx = android.NewPackageContext("android/soong/etc")
Jiyong Parkc678ad32018-04-10 13:07:10 +090040
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -080041// TODO(jungw): Now that it handles more than the ones in etc/, consider renaming this file.
Jiyong Parkc678ad32018-04-10 13:07:10 +090042
43func init() {
Jaewoong Jung4b79e982020-06-01 10:45:49 -070044 pctx.Import("android/soong/android")
Jooyung Han0703fd82020-08-26 22:11:53 +090045 RegisterPrebuiltEtcBuildComponents(android.InitRegistrationContext)
46}
Jaewoong Jung4b79e982020-06-01 10:45:49 -070047
Jooyung Han0703fd82020-08-26 22:11:53 +090048func RegisterPrebuiltEtcBuildComponents(ctx android.RegistrationContext) {
49 ctx.RegisterModuleType("prebuilt_etc", PrebuiltEtcFactory)
50 ctx.RegisterModuleType("prebuilt_etc_host", PrebuiltEtcHostFactory)
Inseob Kim27408bf2021-04-06 21:00:17 +090051 ctx.RegisterModuleType("prebuilt_root", PrebuiltRootFactory)
Jooyung Han0703fd82020-08-26 22:11:53 +090052 ctx.RegisterModuleType("prebuilt_usr_share", PrebuiltUserShareFactory)
53 ctx.RegisterModuleType("prebuilt_usr_share_host", PrebuiltUserShareHostFactory)
54 ctx.RegisterModuleType("prebuilt_font", PrebuiltFontFactory)
55 ctx.RegisterModuleType("prebuilt_firmware", PrebuiltFirmwareFactory)
56 ctx.RegisterModuleType("prebuilt_dsp", PrebuiltDSPFactory)
Colin Cross83ebf232021-04-09 09:41:23 -070057 ctx.RegisterModuleType("prebuilt_rfsa", PrebuiltRFSAFactory)
Inseob Kim1e27a142021-05-06 11:46:11 +000058
59 ctx.RegisterModuleType("prebuilt_defaults", defaultsFactory)
Jiyong Parkc678ad32018-04-10 13:07:10 +090060}
61
Paul Duffin1172fed2021-03-08 11:28:18 +000062var PrepareForTestWithPrebuiltEtc = android.FixtureRegisterWithContext(RegisterPrebuiltEtcBuildComponents)
63
Jiyong Parkc678ad32018-04-10 13:07:10 +090064type prebuiltEtcProperties struct {
Yo Chiang803c40d2020-11-16 20:32:51 +080065 // Source file of this prebuilt. Can reference a genrule type module with the ":module" syntax.
Colin Cross27b922f2019-03-04 22:35:41 -080066 Src *string `android:"path,arch_variant"`
Jiyong Parkc678ad32018-04-10 13:07:10 +090067
Yo Chiangf0e19fe2020-11-18 15:28:42 +080068 // Optional name for the installed file. If unspecified, name of the module is used as the file
69 // name.
Jiyong Park139a2e62018-10-26 21:49:39 +090070 Filename *string `android:"arch_variant"`
71
Yo Chiangf0e19fe2020-11-18 15:28:42 +080072 // When set to true, and filename property is not set, the name for the installed file
Jiyong Park1a7cf082018-11-13 11:59:12 +090073 // is the same as the file name of the source file.
74 Filename_from_src *bool `android:"arch_variant"`
75
Yifan Hong1b3348d2020-01-21 15:53:22 -080076 // Make this module available when building for ramdisk.
Yifan Hong39143a92020-10-26 12:43:12 -070077 // On device without a dedicated recovery partition, the module is only
78 // available after switching root into
79 // /first_stage_ramdisk. To expose the module before switching root, install
80 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -080081 Ramdisk_available *bool
82
Yifan Hong60e0cfb2020-10-21 15:17:56 -070083 // Make this module available when building for vendor ramdisk.
Yifan Hong39143a92020-10-26 12:43:12 -070084 // On device without a dedicated recovery partition, the module is only
85 // available after switching root into
86 // /first_stage_ramdisk. To expose the module before switching root, install
87 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -070088 Vendor_ramdisk_available *bool
89
Inseob Kim08758f02021-04-08 21:13:22 +090090 // Make this module available when building for debug ramdisk.
91 Debug_ramdisk_available *bool
92
Tao Bao0ba5c942018-08-14 22:20:22 -070093 // Make this module available when building for recovery.
94 Recovery_available *bool
95
Jiyong Parkad9ce042018-10-31 22:49:57 +090096 // Whether this module is directly installable to one of the partitions. Default: true.
97 Installable *bool
Yo Chiang3d64d492020-05-27 17:56:39 +080098
99 // Install symlinks to the installed file.
100 Symlinks []string `android:"arch_variant"`
Jiyong Parkc678ad32018-04-10 13:07:10 +0900101}
102
Inseob Kim27408bf2021-04-06 21:00:17 +0900103type prebuiltSubdirProperties struct {
104 // Optional subdirectory under which this file is installed into, cannot be specified with
105 // relative_install_path, prefer relative_install_path.
106 Sub_dir *string `android:"arch_variant"`
107
108 // Optional subdirectory under which this file is installed into, cannot be specified with
109 // sub_dir.
110 Relative_install_path *string `android:"arch_variant"`
111}
112
Jooyung Han39edb6c2019-11-06 16:53:07 +0900113type PrebuiltEtcModule interface {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700114 android.Module
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800115
116 // Returns the base install directory, such as "etc", "usr/share".
Jooyung Han0703fd82020-08-26 22:11:53 +0900117 BaseDir() string
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800118
119 // Returns the sub install directory relative to BaseDir().
Jooyung Han39edb6c2019-11-06 16:53:07 +0900120 SubDir() string
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800121
122 // Returns an android.OutputPath to the intermeidate file, which is the renamed prebuilt source
123 // file.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700124 OutputFile() android.OutputPath
Jooyung Han39edb6c2019-11-06 16:53:07 +0900125}
126
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900127type PrebuiltEtc struct {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700128 android.ModuleBase
Inseob Kim1e27a142021-05-06 11:46:11 +0000129 android.DefaultableModuleBase
Jiyong Parkc678ad32018-04-10 13:07:10 +0900130
Inseob Kim27408bf2021-04-06 21:00:17 +0900131 properties prebuiltEtcProperties
132 subdirProperties prebuiltSubdirProperties
Jiyong Parkc678ad32018-04-10 13:07:10 +0900133
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700134 sourceFilePath android.Path
135 outputFilePath android.OutputPath
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -0800136 // The base install location, e.g. "etc" for prebuilt_etc, "usr/share" for prebuilt_usr_share.
Patrice Arruda057a8b12019-06-03 15:29:27 -0700137 installDirBase string
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800138 // The base install location when soc_specific property is set to true, e.g. "firmware" for
139 // prebuilt_firmware.
Patrice Arruda057a8b12019-06-03 15:29:27 -0700140 socInstallDirBase string
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700141 installDirPath android.InstallPath
142 additionalDependencies *android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900143}
144
Inseob Kim1e27a142021-05-06 11:46:11 +0000145type Defaults struct {
146 android.ModuleBase
147 android.DefaultsModuleBase
148}
149
Yifan Hong1b3348d2020-01-21 15:53:22 -0800150func (p *PrebuiltEtc) inRamdisk() bool {
151 return p.ModuleBase.InRamdisk() || p.ModuleBase.InstallInRamdisk()
152}
153
154func (p *PrebuiltEtc) onlyInRamdisk() bool {
155 return p.ModuleBase.InstallInRamdisk()
156}
157
158func (p *PrebuiltEtc) InstallInRamdisk() bool {
159 return p.inRamdisk()
160}
161
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700162func (p *PrebuiltEtc) inVendorRamdisk() bool {
163 return p.ModuleBase.InVendorRamdisk() || p.ModuleBase.InstallInVendorRamdisk()
164}
165
166func (p *PrebuiltEtc) onlyInVendorRamdisk() bool {
167 return p.ModuleBase.InstallInVendorRamdisk()
168}
169
170func (p *PrebuiltEtc) InstallInVendorRamdisk() bool {
171 return p.inVendorRamdisk()
172}
173
Inseob Kim08758f02021-04-08 21:13:22 +0900174func (p *PrebuiltEtc) inDebugRamdisk() bool {
175 return p.ModuleBase.InDebugRamdisk() || p.ModuleBase.InstallInDebugRamdisk()
176}
177
178func (p *PrebuiltEtc) onlyInDebugRamdisk() bool {
179 return p.ModuleBase.InstallInDebugRamdisk()
180}
181
182func (p *PrebuiltEtc) InstallInDebugRamdisk() bool {
183 return p.inDebugRamdisk()
184}
185
Tao Bao0ba5c942018-08-14 22:20:22 -0700186func (p *PrebuiltEtc) inRecovery() bool {
Colin Cross7228ecd2019-11-18 16:00:16 -0800187 return p.ModuleBase.InRecovery() || p.ModuleBase.InstallInRecovery()
Tao Bao0ba5c942018-08-14 22:20:22 -0700188}
189
190func (p *PrebuiltEtc) onlyInRecovery() bool {
191 return p.ModuleBase.InstallInRecovery()
192}
193
194func (p *PrebuiltEtc) InstallInRecovery() bool {
195 return p.inRecovery()
196}
197
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700198var _ android.ImageInterface = (*PrebuiltEtc)(nil)
Colin Cross7228ecd2019-11-18 16:00:16 -0800199
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700200func (p *PrebuiltEtc) ImageMutatorBegin(ctx android.BaseModuleContext) {}
Colin Cross7228ecd2019-11-18 16:00:16 -0800201
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700202func (p *PrebuiltEtc) CoreVariantNeeded(ctx android.BaseModuleContext) bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700203 return !p.ModuleBase.InstallInRecovery() && !p.ModuleBase.InstallInRamdisk() &&
Inseob Kim08758f02021-04-08 21:13:22 +0900204 !p.ModuleBase.InstallInVendorRamdisk() && !p.ModuleBase.InstallInDebugRamdisk()
Yifan Hong1b3348d2020-01-21 15:53:22 -0800205}
206
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700207func (p *PrebuiltEtc) RamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
208 return proptools.Bool(p.properties.Ramdisk_available) || p.ModuleBase.InstallInRamdisk()
Colin Cross7228ecd2019-11-18 16:00:16 -0800209}
210
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700211func (p *PrebuiltEtc) VendorRamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
212 return proptools.Bool(p.properties.Vendor_ramdisk_available) || p.ModuleBase.InstallInVendorRamdisk()
213}
214
Inseob Kim08758f02021-04-08 21:13:22 +0900215func (p *PrebuiltEtc) DebugRamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
216 return proptools.Bool(p.properties.Debug_ramdisk_available) || p.ModuleBase.InstallInDebugRamdisk()
217}
218
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700219func (p *PrebuiltEtc) RecoveryVariantNeeded(ctx android.BaseModuleContext) bool {
220 return proptools.Bool(p.properties.Recovery_available) || p.ModuleBase.InstallInRecovery()
Colin Cross7228ecd2019-11-18 16:00:16 -0800221}
222
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700223func (p *PrebuiltEtc) ExtraImageVariations(ctx android.BaseModuleContext) []string {
Colin Cross7228ecd2019-11-18 16:00:16 -0800224 return nil
225}
226
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700227func (p *PrebuiltEtc) SetImageVariation(ctx android.BaseModuleContext, variation string, module android.Module) {
Colin Cross7228ecd2019-11-18 16:00:16 -0800228}
229
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700230func (p *PrebuiltEtc) SourceFilePath(ctx android.ModuleContext) android.Path {
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800231 return android.PathForModuleSrc(ctx, proptools.String(p.properties.Src))
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900232}
233
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700234func (p *PrebuiltEtc) InstallDirPath() android.InstallPath {
Jooyung Hana0171822019-07-22 15:48:36 +0900235 return p.installDirPath
236}
237
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900238// This allows other derivative modules (e.g. prebuilt_etc_xml) to perform
239// additional steps (like validating the src) before the file is installed.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700240func (p *PrebuiltEtc) SetAdditionalDependencies(paths android.Paths) {
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900241 p.additionalDependencies = &paths
242}
243
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700244func (p *PrebuiltEtc) OutputFile() android.OutputPath {
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900245 return p.outputFilePath
246}
247
Jiyong Park76a42f52021-02-16 06:50:37 +0900248var _ android.OutputFileProducer = (*PrebuiltEtc)(nil)
249
250func (p *PrebuiltEtc) OutputFiles(tag string) (android.Paths, error) {
251 switch tag {
252 case "":
253 return android.Paths{p.outputFilePath}, nil
254 default:
255 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
256 }
257}
258
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900259func (p *PrebuiltEtc) SubDir() string {
Inseob Kim27408bf2021-04-06 21:00:17 +0900260 if subDir := proptools.String(p.subdirProperties.Sub_dir); subDir != "" {
Liz Kammer0449a632020-06-26 10:12:36 -0700261 return subDir
262 }
Inseob Kim27408bf2021-04-06 21:00:17 +0900263 return proptools.String(p.subdirProperties.Relative_install_path)
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900264}
265
Jooyung Han0703fd82020-08-26 22:11:53 +0900266func (p *PrebuiltEtc) BaseDir() string {
Jooyung Han8e5685d2020-09-21 11:02:57 +0900267 return p.installDirBase
Jooyung Han0703fd82020-08-26 22:11:53 +0900268}
269
Jiyong Parkad9ce042018-10-31 22:49:57 +0900270func (p *PrebuiltEtc) Installable() bool {
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800271 return p.properties.Installable == nil || proptools.Bool(p.properties.Installable)
Jiyong Parkad9ce042018-10-31 22:49:57 +0900272}
273
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700274func (p *PrebuiltEtc) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800275 if p.properties.Src == nil {
276 ctx.PropertyErrorf("src", "missing prebuilt source file")
277 return
278 }
279 p.sourceFilePath = android.PathForModuleSrc(ctx, proptools.String(p.properties.Src))
Yo Chiang803c40d2020-11-16 20:32:51 +0800280
281 // Determine the output file basename.
282 // If Filename is set, use the name specified by the property.
283 // If Filename_from_src is set, use the source file name.
284 // Otherwise use the module name.
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800285 filename := proptools.String(p.properties.Filename)
286 filenameFromSrc := proptools.Bool(p.properties.Filename_from_src)
287 if filename != "" {
288 if filenameFromSrc {
289 ctx.PropertyErrorf("filename_from_src", "filename is set. filename_from_src can't be true")
290 return
Jiyong Park1a7cf082018-11-13 11:59:12 +0900291 }
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800292 } else if filenameFromSrc {
293 filename = p.sourceFilePath.Base()
294 } else {
295 filename = ctx.ModuleName()
Jiyong Park139a2e62018-10-26 21:49:39 +0900296 }
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700297 p.outputFilePath = android.PathForModuleOut(ctx, filename).OutputPath
Patrice Arruda057a8b12019-06-03 15:29:27 -0700298
Inseob Kim27408bf2021-04-06 21:00:17 +0900299 if strings.Contains(filename, "/") {
300 ctx.PropertyErrorf("filename", "filename cannot contain separator '/'")
301 return
302 }
303
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800304 // Check that `sub_dir` and `relative_install_path` are not set at the same time.
Inseob Kim27408bf2021-04-06 21:00:17 +0900305 if p.subdirProperties.Sub_dir != nil && p.subdirProperties.Relative_install_path != nil {
Liz Kammer0449a632020-06-26 10:12:36 -0700306 ctx.PropertyErrorf("sub_dir", "relative_install_path is set. Cannot set sub_dir")
307 }
308
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800309 // If soc install dir was specified and SOC specific is set, set the installDirPath to the
310 // specified socInstallDirBase.
Jooyung Han8e5685d2020-09-21 11:02:57 +0900311 installBaseDir := p.installDirBase
312 if p.SocSpecific() && p.socInstallDirBase != "" {
313 installBaseDir = p.socInstallDirBase
314 }
315 p.installDirPath = android.PathForModuleInstall(ctx, installBaseDir, p.SubDir())
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900316
Dan Willemsenb0552672019-01-25 16:04:11 -0800317 // This ensures that outputFilePath has the correct name for others to
318 // use, as the source file may have a different name.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700319 ctx.Build(pctx, android.BuildParams{
320 Rule: android.Cp,
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900321 Output: p.outputFilePath,
322 Input: p.sourceFilePath,
323 })
Jiyong Parkf9f68052020-09-29 20:15:08 +0900324
Inseob Kim916901e2021-02-17 15:48:53 +0900325 if !p.Installable() {
326 p.SkipInstall()
327 }
328
329 // Call InstallFile even when uninstallable to make the module included in the package
330 installPath := ctx.InstallFile(p.installDirPath, p.outputFilePath.Base(), p.outputFilePath)
331 for _, sl := range p.properties.Symlinks {
332 ctx.InstallSymlink(p.installDirPath, sl, installPath)
Jiyong Parkf9f68052020-09-29 20:15:08 +0900333 }
Jiyong Parkc678ad32018-04-10 13:07:10 +0900334}
335
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700336func (p *PrebuiltEtc) AndroidMkEntries() []android.AndroidMkEntries {
Jaewoong Jung9aa3ab12019-04-03 15:47:29 -0700337 nameSuffix := ""
Yifan Hong1b3348d2020-01-21 15:53:22 -0800338 if p.inRamdisk() && !p.onlyInRamdisk() {
339 nameSuffix = ".ramdisk"
340 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700341 if p.inVendorRamdisk() && !p.onlyInVendorRamdisk() {
342 nameSuffix = ".vendor_ramdisk"
343 }
Inseob Kim08758f02021-04-08 21:13:22 +0900344 if p.inDebugRamdisk() && !p.onlyInDebugRamdisk() {
345 nameSuffix = ".debug_ramdisk"
346 }
Jaewoong Jung9aa3ab12019-04-03 15:47:29 -0700347 if p.inRecovery() && !p.onlyInRecovery() {
348 nameSuffix = ".recovery"
349 }
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700350 return []android.AndroidMkEntries{android.AndroidMkEntries{
Jaewoong Jung9aa3ab12019-04-03 15:47:29 -0700351 Class: "ETC",
352 SubName: nameSuffix,
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700353 OutputFile: android.OptionalPathForPath(p.outputFilePath),
354 ExtraEntries: []android.AndroidMkExtraEntriesFunc{
Colin Crossaa255532020-07-03 13:18:24 -0700355 func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700356 entries.SetString("LOCAL_MODULE_TAGS", "optional")
Colin Crossff6c33d2019-10-02 16:01:35 -0700357 entries.SetString("LOCAL_MODULE_PATH", p.installDirPath.ToMakePath().String())
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700358 entries.SetString("LOCAL_INSTALLED_MODULE_STEM", p.outputFilePath.Base())
Yo Chiang3d64d492020-05-27 17:56:39 +0800359 if len(p.properties.Symlinks) > 0 {
360 entries.AddStrings("LOCAL_MODULE_SYMLINKS", p.properties.Symlinks...)
361 }
Yo Chiang803c40d2020-11-16 20:32:51 +0800362 entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !p.Installable())
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700363 if p.additionalDependencies != nil {
Yo Chiang803c40d2020-11-16 20:32:51 +0800364 entries.AddStrings("LOCAL_ADDITIONAL_DEPENDENCIES", p.additionalDependencies.Strings()...)
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900365 }
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700366 },
Jiyong Parkc678ad32018-04-10 13:07:10 +0900367 },
Jiyong Park0b0e1b92019-12-03 13:24:29 +0900368 }}
Jiyong Parkc678ad32018-04-10 13:07:10 +0900369}
370
Jooyung Hana0171822019-07-22 15:48:36 +0900371func InitPrebuiltEtcModule(p *PrebuiltEtc, dirBase string) {
372 p.installDirBase = dirBase
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900373 p.AddProperties(&p.properties)
Inseob Kim27408bf2021-04-06 21:00:17 +0900374 p.AddProperties(&p.subdirProperties)
375}
376
377func InitPrebuiltRootModule(p *PrebuiltEtc) {
378 p.installDirBase = "."
379 p.AddProperties(&p.properties)
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900380}
Jiyong Parkc678ad32018-04-10 13:07:10 +0900381
Patrice Arruda9e14b962019-03-11 15:58:50 -0700382// prebuilt_etc is for a prebuilt artifact that is installed in
383// <partition>/etc/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700384func PrebuiltEtcFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900385 module := &PrebuiltEtc{}
386 InitPrebuiltEtcModule(module, "etc")
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900387 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700388 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Inseob Kim1e27a142021-05-06 11:46:11 +0000389 android.InitDefaultableModule(module)
390 return module
391}
392
393func defaultsFactory() android.Module {
394 return DefaultsFactory()
395}
396
397func DefaultsFactory(props ...interface{}) android.Module {
398 module := &Defaults{}
399
400 module.AddProperties(props...)
401 module.AddProperties(
402 &prebuiltEtcProperties{},
403 &prebuiltSubdirProperties{},
404 )
405
406 android.InitDefaultsModule(module)
407
Jiyong Parkc678ad32018-04-10 13:07:10 +0900408 return module
409}
Tao Bao0ba5c942018-08-14 22:20:22 -0700410
Patrice Arruda9e14b962019-03-11 15:58:50 -0700411// prebuilt_etc_host is for a host prebuilt artifact that is installed in
412// $(HOST_OUT)/etc/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700413func PrebuiltEtcHostFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900414 module := &PrebuiltEtc{}
415 InitPrebuiltEtcModule(module, "etc")
Jaewoong Jung24788182019-02-04 14:34:10 -0800416 // This module is host-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700417 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommon)
Jaewoong Jung24788182019-02-04 14:34:10 -0800418 return module
419}
420
Inseob Kim27408bf2021-04-06 21:00:17 +0900421// prebuilt_root is for a prebuilt artifact that is installed in
422// <partition>/ directory. Can't have any sub directories.
423func PrebuiltRootFactory() android.Module {
424 module := &PrebuiltEtc{}
425 InitPrebuiltRootModule(module)
426 // This module is device-only
427 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
428 return module
429}
430
Patrice Arruda9e14b962019-03-11 15:58:50 -0700431// prebuilt_usr_share is for a prebuilt artifact that is installed in
432// <partition>/usr/share/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700433func PrebuiltUserShareFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900434 module := &PrebuiltEtc{}
435 InitPrebuiltEtcModule(module, "usr/share")
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -0800436 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700437 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -0800438 return module
439}
440
Patrice Arruda9e14b962019-03-11 15:58:50 -0700441// prebuild_usr_share_host is for a host prebuilt artifact that is installed in
442// $(HOST_OUT)/usr/share/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700443func PrebuiltUserShareHostFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900444 module := &PrebuiltEtc{}
445 InitPrebuiltEtcModule(module, "usr/share")
Patrice Arruda300cef92019-02-22 15:47:57 -0800446 // This module is host-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700447 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommon)
Patrice Arruda300cef92019-02-22 15:47:57 -0800448 return module
449}
450
Patrice Arruda61583eb2019-05-14 08:20:45 -0700451// prebuilt_font installs a font in <partition>/fonts directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700452func PrebuiltFontFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900453 module := &PrebuiltEtc{}
454 InitPrebuiltEtcModule(module, "fonts")
Patrice Arruda61583eb2019-05-14 08:20:45 -0700455 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700456 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Patrice Arruda61583eb2019-05-14 08:20:45 -0700457 return module
458}
Patrice Arruda057a8b12019-06-03 15:29:27 -0700459
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800460// prebuilt_firmware installs a firmware file to <partition>/etc/firmware directory for system
461// image.
462// If soc_specific property is set to true, the firmware file is installed to the
463// vendor <partition>/firmware directory for vendor image.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700464func PrebuiltFirmwareFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900465 module := &PrebuiltEtc{}
466 module.socInstallDirBase = "firmware"
467 InitPrebuiltEtcModule(module, "etc/firmware")
Patrice Arruda057a8b12019-06-03 15:29:27 -0700468 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700469 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Patrice Arruda057a8b12019-06-03 15:29:27 -0700470 return module
471}
Patrice Arruda0f688002020-06-08 21:40:25 +0000472
473// prebuilt_dsp installs a DSP related file to <partition>/etc/dsp directory for system image.
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800474// If soc_specific property is set to true, the DSP related file is installed to the
475// vendor <partition>/dsp directory for vendor image.
Patrice Arruda0f688002020-06-08 21:40:25 +0000476func PrebuiltDSPFactory() android.Module {
477 module := &PrebuiltEtc{}
478 module.socInstallDirBase = "dsp"
479 InitPrebuiltEtcModule(module, "etc/dsp")
480 // This module is device-only
481 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
482 return module
483}
Colin Cross83ebf232021-04-09 09:41:23 -0700484
485// prebuilt_rfsa installs a firmware file that will be available through Qualcomm's RFSA
486// to the <partition>/lib/rfsa directory.
487func PrebuiltRFSAFactory() android.Module {
488 module := &PrebuiltEtc{}
489 // Ideally these would go in /vendor/dsp, but the /vendor/lib/rfsa paths are hardcoded in too
490 // many places outside of the application processor. They could be moved to /vendor/dsp once
491 // that is cleaned up.
492 InitPrebuiltEtcModule(module, "lib/rfsa")
493 // This module is device-only
494 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
495 return module
496}