/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2019 Intel Corporation.
 *
 * Taken from coreboot intelblocks/nvs.h
 * Copyright 2019 Google LLC
 */

#ifndef _INTEL_GNVS_H_
#define _INTEL_GNVS_H_

#include <linux/bitops.h>
/*
 * The chromeos_acpi portion of ACPI GNVS is assumed to live from offset
 * 0x100 - 0x1000.  When defining acpi_global_nvs, use check_member
 * to ensure that it is properly aligned:
 *
 *   check_member(acpi_global_nvs, chromeos, GNVS_CHROMEOS_ACPI_OFFSET);
 */
#define GNVS_CHROMEOS_ACPI_OFFSET 0x100

enum {
	BOOT_REASON_OTHER = 0,
	BOOT_REASON_S3DIAG = 9
};

enum {
	CHSW_RECOVERY_X86 =		BIT(1),
	CHSW_RECOVERY_EC =		BIT(2),
	CHSW_DEVELOPER_SWITCH =		BIT(5),
	CHSW_FIRMWARE_WP =		BIT(9),
};

enum {
	RECOVERY_REASON_NONE = 0,
	RECOVERY_REASON_ME = 1
};

enum {
	ACTIVE_ECFW_RO = 0,
	ACTIVE_ECFW_RW = 1
};

enum {
	BINF_RECOVERY = 0,
	BINF_RW_A = 1,
	BINF_RW_B = 2
};

/**
 * enum cros_fw_type_t - Used to indicate Chromium OS firmware type
 *
 * Chromium OS uses a region of the GNVS starting at offset 0x100 to store
 * various bits of information, including the type of firmware being booted
 */
enum cros_fw_type_t {
	FIRMWARE_TYPE_AUTO_DETECT = -1,
	FIRMWARE_TYPE_RECOVERY = 0,
	FIRMWARE_TYPE_NORMAL = 1,
	FIRMWARE_TYPE_DEVELOPER = 2,
	FIRMWARE_TYPE_NETBOOT = 3,
	FIRMWARE_TYPE_LEGACY = 4,
};

struct __packed chromeos_acpi_gnvs {
	/* ChromeOS-specific */
	u32	boot_reason;	/* 00 boot reason */
	u32	active_main_fw;	/* 04 (0=recovery, 1=A, 2=B) */
	u32	activeec_fw;	/* 08 (0=RO, 1=RW) */
	u16	switches;	/* 0c CHSW */
	u8	hwid[256];	/* 0e HWID */
	u8	fwid[64];	/* 10e FWID */
	u8	frid[64];	/* 14e FRID - 275 */
	u32	main_fw_type;	/* 18e (2 = developer mode) */
	u32	recovery_reason; /* 192 recovery reason */
	u32	fmap_base;	/* 196 fmap base address */
	u8	vdat[3072];	/* 19a VDAT space filled by verified boot */
	u32	fwid_ptr;	/* d9a smbios bios version */
	u32	mehh[8];	/* d9e management engine hash */
	u32	ramoops_base;	/* dbe ramoops base address */
	u32	ramoops_len;	/* dc2 ramoops length */
	u32	vpd_ro_base;	/* dc6 pointer to RO_VPD */
	u32	vpd_ro_size;	/* dca size of RO_VPD */
	u32	vpd_rw_base;	/* dce pointer to RW_VPD */
	u32	vpd_rw_size;	/* dd2 size of RW_VPD */
	u8	pad[298];	/* dd6-eff */
};

struct __packed acpi_global_nvs {
	/* Miscellaneous */
	u8	pcnt; /* 0x00 - Processor Count */
	u8	ppcm; /* 0x01 - Max PPC State */
	u8	lids; /* 0x02 - LID State */
	u8	pwrs; /* 0x03 - AC Power State */
	u8	dpte; /* 0x04 - Enable DPTF */
	u32	cbmc; /* 0x05 - 0x08 - coreboot Memory Console */
	u64	pm1i; /* 0x09 - 0x10 - System Wake Source - PM1 Index */
	u64	gpei; /* 0x11 - 0x18 - GPE Wake Source */
	u64	nhla; /* 0x19 - 0x20 - NHLT Address */
	u32	nhll; /* 0x21 - 0x24 - NHLT Length */
	u32	prt0; /* 0x25 - 0x28 - PERST_0 Address */
	u8	scdp; /* 0x29 - SD_CD GPIO portid */
	u8	scdo; /* 0x2a - GPIO pad offset relative to the community */
	u8	uior; /* 0x2b - UART debug controller init on S3 resume */
	u8	ecps; /* 0x2c - SGX Enabled status */
	u64	emna; /* 0x2d - 0x34 EPC base address */
	u64	elng; /* 0x35 - 0x3C EPC Length */
	u8	unused1[0x100 - 0x3d];		/* Pad out to 256 bytes */
#ifdef CONFIG_CHROMEOS
	/* ChromeOS-specific (0x100 - 0xfff) */
	struct chromeos_acpi_gnvs chromeos;
#else
	u8	unused2[0x1000 - 0x100];	/* Pad out to 4096 bytes */
#endif
};
#ifdef CONFIG_CHROMEOS
check_member(acpi_global_nvs, chromeos, GNVS_CHROMEOS_ACPI_OFFSET);
#else
check_member(acpi_global_nvs, unused2, GNVS_CHROMEOS_ACPI_OFFSET);
#endif

#endif /* _INTEL_GNVS_H_ */