/* * Copyright (C) 2025 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.android.tradefed.targetprep; import com.android.tradefed.build.IBuildInfo; import com.android.tradefed.build.IDeviceBuildInfo; import com.android.tradefed.build.VersionedFile; import com.android.tradefed.config.ConfigurationException; import com.android.tradefed.config.IConfiguration; import com.android.tradefed.config.IConfigurationReceiver; import com.android.tradefed.config.Option; import com.android.tradefed.config.OptionClass; import com.android.tradefed.device.DeviceNotAvailableException; import com.android.tradefed.device.ITestDevice; import com.android.tradefed.invoker.IInvocationContext; import com.android.tradefed.invoker.TestInformation; import com.android.tradefed.log.LogUtil.CLog; import com.android.tradefed.util.FileUtil; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.util.ArrayList; import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.zip.GZIPInputStream; /** A {@link ITargetPreparer} that allows to mix a radio image with the device image. */ @OptionClass(alias = "mix-radio-target-preparer") public class MixRadioTargetPreparer extends BaseTargetPreparer implements ILabPreparer, IConfigurationReceiver { @Option(name = "radio-file-key", description = "The key of the downloaded radio image file.") private String radioFileKey = "radio.img.gz"; @Option( name = "baseband-build-info-file-key", description = "The key of the baseband version file.") private String basebandBuildInfoFileKey = "BUILD_INFO"; private IConfiguration mConfig; @Override public void setConfiguration(IConfiguration configuration) { mConfig = configuration; } @Override public void setUp(TestInformation testInfo) throws TargetSetupError, BuildError, DeviceNotAvailableException { IInvocationContext context = testInfo.getContext(); ITestDevice device = testInfo.getDevice(); IBuildInfo buildInfo = testInfo.getBuildInfo(); IDeviceBuildInfo deviceBuild = (IDeviceBuildInfo) buildInfo; File tmpRadioDir = null; try { tmpRadioDir = FileUtil.createTempDir("radio_dir"); File downloadedRadioFile = new File(tmpRadioDir, "radio.img"); File srcFile; File basebandBuildInfoFile; String basebandVersion; if (buildInfo.getFile(basebandBuildInfoFileKey) != null) { CLog.i( "BUILD_INFO artifact fetched successfully: %s", buildInfo.getFile(basebandBuildInfoFileKey).getName()); basebandBuildInfoFile = buildInfo.getFile(basebandBuildInfoFileKey); basebandVersion = getBasebandVersionFromBuildInfo(basebandBuildInfoFile); CLog.i("Baseband version from build info file: %s", basebandVersion); } else { throw new TargetSetupError( "BUILD_INFO artifact not found, couldn't determine baseband version.", device.getDeviceDescriptor()); } if (buildInfo.getFile(radioFileKey) == null) { throw new TargetSetupError( radioFileKey + " is not provided in the gcl file. Can not generate radio image.", device.getDeviceDescriptor()); } else { srcFile = buildInfo.getFile(radioFileKey); } String suffix = FileUtil.getExtension(srcFile.getName()); if (suffix.contains("gz")) { CLog.i("File was requested to be ungzipped."); // File was requested to be ungzipped. try (FileInputStream stream = new FileInputStream(srcFile)) { try (GZIPInputStream gzip = new GZIPInputStream(stream)) { FileUtil.writeToFile(gzip, downloadedRadioFile, true); FileUtil.deleteFile(srcFile); } } } else { FileUtil.hardlinkFile(srcFile, downloadedRadioFile); FileUtil.deleteFile(srcFile); } if (tmpRadioDir.listFiles().length == 0) { throw new TargetSetupError( "Could not find radio images", device.getDeviceDescriptor()); } mixRadio(device, deviceBuild, basebandVersion, downloadedRadioFile); } catch (IOException e) { throw new TargetSetupError( "Could not mix device and radio images", e, device.getDeviceDescriptor()); } finally { FileUtil.recursiveDelete(tmpRadioDir); } } /** * Create new device image by mixing new radio image to device image. * * @param device the test device * @param deviceBuildInfo the device build info * @param basebandVersion the baseband version to replace in the device build info * @param downloadedRadioImage the downloaded radio image */ private void mixRadio( ITestDevice device, IDeviceBuildInfo deviceBuildInfo, String basebandVersion, File downloadedRadioImage) throws TargetSetupError, BuildError, DeviceNotAvailableException { try { try { mConfig.injectOptionValue("skip-baseband-version-check", "true"); mConfig.injectOptionValue("check-baseband-version-after-flash", "true"); CLog.i("Skip baseband version check"); } catch (ConfigurationException e) { CLog.e(e); } // Clean up radio image. String radioImageFilePath = deviceBuildInfo.getBasebandImageFile().getAbsolutePath(); File radioImageFile = deviceBuildInfo.getBasebandImageFile(); ArrayList doNotClean = new ArrayList(); for (VersionedFile fileRecord : deviceBuildInfo.getFiles()) { if (!radioImageFile.equals(fileRecord.getFile())) doNotClean.add(fileRecord.getFile()); } deviceBuildInfo.cleanUp(doNotClean); // Replace radio image of deviceBuildInfo w/ the new one and update version. radioImageFile.delete(); File testRadioImageFile = new File(radioImageFilePath); FileUtil.hardlinkFile(downloadedRadioImage, testRadioImageFile); // Set the baseband image of deviceBuildInfo to the new one. deviceBuildInfo.setBasebandImage(testRadioImageFile, basebandVersion); CLog.i( "Successfully mixed device %s and radio image %s", deviceBuildInfo, deviceBuildInfo.getBasebandVersion()); } catch (IOException e) { throw new TargetSetupError( "Could not mix device and radio images", e, device.getDeviceDescriptor()); } } private String getBasebandVersionFromBuildInfo(File basebandBuildInfoFile) throws TargetSetupError { try { String fileContent = FileUtil.readStringFromFile(basebandBuildInfoFile); // Regex to extract baseband version from build info file. // Lassen Example: g5400I-250721-250723-B-13820602,g5400I-250609-0715-P100516012 // Alcedo Example: a900a-ES2_250408-250414-MC-13351752 List patterns = new ArrayList<>(); patterns.add(Pattern.compile("g[a-zA-Z0-9]+-\\d+-\\d+(-[a-zA-Z0-9]+)?-(P?\\d+)")); patterns.add(Pattern.compile("[a-zA-Z0-9]+-[a-zA-Z0-9_]+-[0-9]+-[a-zA-Z]+-P?[0-9]+")); for (Pattern pattern : patterns) { Matcher versionMatcher = pattern.matcher(fileContent); if (versionMatcher.find()) { return versionMatcher.group(0); } } throw new TargetSetupError("Could not read baseband version from build info file"); } catch (IOException e) { throw new TargetSetupError("Could not read baseband version from build info file", e); } } }