src/chromiumos/tast/remote/bundles/cros/firmware/ap_bmpblk.go

// Copyright 2022 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package firmware

import (
	"context"
	"io/ioutil"
	"path/filepath"
	"strings"

	"chromiumos/tast/common/firmware/bios"
	"chromiumos/tast/remote/firmware/fixture"
	pb "chromiumos/tast/services/cros/firmware"
	"chromiumos/tast/testing"
)

func init() {
	testing.AddTest(&testing.Test{
		Func: APBmpblk,
		Desc: "Inspects coreboot contents for configuration indicators for the bitmaps used in firmware UI",
		Contacts: []string{
			"jwerner@chromium.org",       // Test author
			"kmshelton@chromium.org",     // Test porter (from TAuto)
			"chromeos-faft@chromium.org", // Backup mailing list
		},
		// TODO(kmshelton): Move to firmware_bios after firmware_unstable verification
		Attr:        []string{"group:firmware", "firmware_unstable"},
		Fixture:     fixture.NormalMode,
		ServiceDeps: []string{"tast.cros.firmware.BiosService"},
	})
}

//APBmpblk inspects coreboot contents for indicators of bitmap block configuration.  See https://chromium.googlesource.com/chromiumos/platform/bmpblk for more context.
func APBmpblk(ctx context.Context, s *testing.State) {
	const validityIndicator string = "romstage"
	const applicabilityIndicator string = "vbgfx.bin"
	const misconfigurationIndicator string = "vbgfx_not_scaled"

	h := s.FixtValue().(*fixture.Value).Helper

	if err := h.RequireBiosServiceClient(ctx); err != nil {
		s.Fatal("Requiring BiosServiceClient: ", err)
	}
	bs := h.BiosServiceClient

	coreboot, err := bs.BackupImageSection(ctx, &pb.FWBackUpSection{
		Programmer: pb.Programmer_BIOSProgrammer,
		Section:    pb.ImageSection_COREBOOTImageSection,
	})
	region := bios.COREBOOTImageSection
	if err != nil {
		s.Log("Failed to backup the COREBOOT region.  Older devices may store coreboot in a region named BOOT_STUB: ", err)
		coreboot, err = bs.BackupImageSection(ctx, &pb.FWBackUpSection{
			Programmer: pb.Programmer_BIOSProgrammer,
			Section:    pb.ImageSection_BOOTSTUBImageSection,
		})
		if err != nil {
			s.Fatal("Failed to backup the BOOT_STUB region")
		}
		region = bios.BOOTSTUBImageSection
	}
	s.Log("A portion of the firmware ROM containing Coreboot is stored at: ", coreboot.Path)

	out, err := h.DUT.Conn().CommandContext(ctx, "cbfstool", coreboot.Path, "print", "-r", string(region)).Output()
	if err != nil {
		s.Log(out)
		s.Fatal("Failed to execute cbfstool: ", err)
	}
	outs := string(out)
	path := filepath.Join(s.OutDir(), "cbfs.txt")
	if err := ioutil.WriteFile(path, out, 0644); err != nil {
		s.Error("Failed to save cbfstool output: ", err)
	}

	if !strings.Contains(outs, validityIndicator) {
		s.Fatalf("Failed validity check.  Output of cbfstool did not contain %q (saved output to %s)",
			validityIndicator, filepath.Base(path))
	}

	if !strings.Contains(outs, applicabilityIndicator) {
		s.Log("This board appears to have no firmware screens")
		return
	}

	if strings.Contains(outs, misconfigurationIndicator) {
		s.Fatalf("Failed inspection for generic configuration.  This build was configured for a generic "+
			"1366x768 display resolution.  Images will get scaled up at runtime and look blurry.  You need to "+
			"explicitly set the panel resolution for this board in bmpblk/images/boards.yaml and add it to "+
			"CROS_BOARDS in the sys-boot/chromeos-bmpblk .ebuild.  Do *not* do this until you are certain of "+
			"the panel resolution that the final product will ship with!  Output of cbfstool did not contain %q "+
			"(saved output to %s).", misconfigurationIndicator, filepath.Base(path))
	}
}