common/ec_features.c

/* Copyright 2017 The ChromiumOS Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

/* Present Chrome EC device features to the outside world */

#include "board_config.h"
#include "common.h"
#include "config.h"
#include "console.h"
#include "ec_commands.h"
#include "motion_sense.h"

/* LCOV_EXCL_START */
uint32_t get_feature_flags0(void)
{
	uint32_t result = 0
#ifdef CONFIG_FW_LIMITED_IMAGE
			  | EC_FEATURE_MASK_0(EC_FEATURE_LIMITED)
#endif
#ifdef CONFIG_FLASH_CROS
			  | EC_FEATURE_MASK_0(EC_FEATURE_FLASH)
#endif
#ifdef CONFIG_FANS
			  | EC_FEATURE_MASK_0(EC_FEATURE_PWM_FAN)
#endif
#ifdef CONFIG_KEYBOARD_BACKLIGHT
			  | EC_FEATURE_MASK_0(EC_FEATURE_PWM_KEYB)
#endif
#ifdef HAS_TASK_LIGHTBAR
			  | EC_FEATURE_MASK_0(EC_FEATURE_LIGHTBAR)
#endif
#ifdef CONFIG_LED_COMMON
			  | EC_FEATURE_MASK_0(EC_FEATURE_LED)
#endif
#ifdef HAS_TASK_MOTIONSENSE
			  | EC_FEATURE_MASK_0(EC_FEATURE_MOTION_SENSE)
#endif
#ifdef HAS_TASK_KEYSCAN
			  | EC_FEATURE_MASK_0(EC_FEATURE_KEYB)
#endif
#ifdef CONFIG_PSTORE
			  | EC_FEATURE_MASK_0(EC_FEATURE_PSTORE)
#endif
#ifdef CONFIG_HOSTCMD_X86
			  | EC_FEATURE_MASK_0(EC_FEATURE_PORT80)
#endif
#ifdef CONFIG_TEMP_SENSOR
			  | EC_FEATURE_MASK_0(EC_FEATURE_THERMAL)
#endif
#if (defined CONFIG_BACKLIGHT_LID) || (defined CONFIG_BACKLIGHT_REQ_GPIO)
			  | EC_FEATURE_MASK_0(EC_FEATURE_BKLIGHT_SWITCH)
#endif
#ifdef CONFIG_WIRELESS
			  | EC_FEATURE_MASK_0(EC_FEATURE_WIFI_SWITCH)
#endif
#ifdef CONFIG_HOSTCMD_EVENTS
			  | EC_FEATURE_MASK_0(EC_FEATURE_HOST_EVENTS)
#endif
#ifdef CONFIG_COMMON_GPIO
			  | EC_FEATURE_MASK_0(EC_FEATURE_GPIO)
#endif
#ifdef CONFIG_I2C_CONTROLLER
			  | EC_FEATURE_MASK_0(EC_FEATURE_I2C)
#endif
#ifdef CONFIG_CHARGER
			  | EC_FEATURE_MASK_0(EC_FEATURE_CHARGER)
#endif
#if (defined CONFIG_BATTERY)
			  | EC_FEATURE_MASK_0(EC_FEATURE_BATTERY)
#endif
#ifdef CONFIG_BATTERY_SMART
			  | EC_FEATURE_MASK_0(EC_FEATURE_SMART_BATTERY)
#endif
#ifdef CONFIG_AP_HANG_DETECT
			  | EC_FEATURE_MASK_0(EC_FEATURE_HANG_DETECT)
#endif
#if 0
		| EC_FEATURE_MASK_0(EC_FEATURE_PMU) /* Obsolete */
#endif
#ifdef CONFIG_HOSTCMD_PD
			  | EC_FEATURE_MASK_0(EC_FEATURE_SUB_MCU)
#endif
#ifdef CONFIG_CHARGE_MANAGER
			  | EC_FEATURE_MASK_0(EC_FEATURE_USB_PD)
#endif
#ifdef CONFIG_ACCEL_FIFO
			  | EC_FEATURE_MASK_0(EC_FEATURE_MOTION_SENSE_FIFO)
#endif
#ifdef CONFIG_VSTORE
			  | EC_FEATURE_MASK_0(EC_FEATURE_VSTORE)
#endif
#ifdef CONFIG_USB_MUX_VIRTUAL
			  | EC_FEATURE_MASK_0(EC_FEATURE_USBC_SS_MUX_VIRTUAL)
#endif
#ifdef CONFIG_HOSTCMD_RTC
			  | EC_FEATURE_MASK_0(EC_FEATURE_RTC)
#endif
#if defined(CONFIG_SPI_FP_PORT) || defined(CONFIG_BOARD_FINGERPRINT)
			  | EC_FEATURE_MASK_0(EC_FEATURE_FINGERPRINT)
#endif
#ifdef HAS_TASK_CENTROIDING
			  | EC_FEATURE_MASK_0(EC_FEATURE_TOUCHPAD)
#endif
#if defined(HAS_TASK_RWSIG) || defined(HAS_TASK_RWSIG_RO) || \
	defined(CONFIG_PLATFORM_EC_RWSIG)
			  | EC_FEATURE_MASK_0(EC_FEATURE_RWSIG)
#endif
#ifdef CONFIG_DEVICE_EVENT
			  | EC_FEATURE_MASK_0(EC_FEATURE_DEVICE_EVENT)
#endif
		;
	return board_override_feature_flags0(result);
}
/* LCOV_EXCL_STOP */

/* LCOV_EXCL_START */
uint32_t get_feature_flags1(void)
{
	uint32_t result =
		EC_FEATURE_MASK_1(EC_FEATURE_UNIFIED_WAKE_MASKS) |
		EC_FEATURE_MASK_1(EC_FEATURE_HOST_EVENT64)
#ifdef CONFIG_EXTERNAL_STORAGE
/*
 * TODO: b/304839481 Workaround for crosec-legacy-drv/flashrom -p ec,
 * we need to report not executing in RAM to get the utility to execute
 * reboot to RO prior to RW flashing
 */
#ifndef CONFIG_FINGERPRINT_MCU
		| EC_FEATURE_MASK_1(EC_FEATURE_EXEC_IN_RAM)
#endif
#endif
#ifdef CONFIG_CEC
		| EC_FEATURE_MASK_1(EC_FEATURE_CEC)
#endif
#ifdef CONFIG_SENSOR_TIGHT_TIMESTAMPS
		| EC_FEATURE_MASK_1(EC_FEATURE_MOTION_SENSE_TIGHT_TIMESTAMPS)
#endif
#if defined(CONFIG_LID_ANGLE) && defined(CONFIG_TABLET_MODE)
		| (sensor_board_is_lid_angle_available() ?
			   EC_FEATURE_MASK_1(
				   EC_FEATURE_REFINED_TABLET_MODE_HYSTERESIS) :
			   0)
#endif
#ifdef CONFIG_VBOOT_EFS2
		| EC_FEATURE_MASK_1(EC_FEATURE_EFS2)
#endif
#ifdef CONFIG_IPI
#if defined(SCP_CORE_SN) && SCP_CORE_SN == 1
		| EC_FEATURE_MASK_1(EC_FEATURE_SCP_C1)
#else
		| EC_FEATURE_MASK_1(EC_FEATURE_SCP)
#endif
#endif
#ifdef CHIP_ISH
		| EC_FEATURE_MASK_1(EC_FEATURE_ISH)
#endif
#if defined(CONFIG_USB_PD_TCPMV2) || \
	defined(CONFIG_PLATFORM_EC_USB_PD_CONTROLLER)
		| EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_CMD)
#endif
#ifdef CONFIG_USB_PD_REQUIRE_AP_MODE_ENTRY
		| EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_REQUIRE_AP_MODE_ENTRY)
#endif
#ifdef CONFIG_USB_MUX_AP_ACK_REQUEST
		| EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_MUX_REQUIRE_AP_ACK)
#endif
#ifdef CONFIG_POWER_S4_RESIDENCY
		| EC_FEATURE_MASK_1(EC_FEATURE_S4_RESIDENCY)
#endif
#ifdef CONFIG_USB_MUX_AP_CONTROL
		| EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_AP_MUX_SET)
#endif
#ifdef CONFIG_USB_PD_VDM_AP_CONTROL
		| EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_AP_VDM_SEND)
#endif
#ifdef CONFIG_SYSTEM_SAFE_MODE
		| EC_FEATURE_MASK_1(EC_FEATURE_SYSTEM_SAFE_MODE)
#endif
#ifdef CONFIG_DEBUG_ASSERT_REBOOTS
		| EC_FEATURE_MASK_1(EC_FEATURE_ASSERT_REBOOTS)
#endif
#ifdef CONFIG_PIGWEED_LOG_TOKENIZED_LIB
		| EC_FEATURE_MASK_1(EC_FEATURE_TOKENIZED_LOGGING)
#endif
#ifdef CONFIG_PLATFORM_EC_AMD_STB_DUMP
		| EC_FEATURE_MASK_1(EC_FEATURE_AMD_STB_DUMP)
#endif
#ifdef CONFIG_HOST_COMMAND_MEMORY_DUMP
		| EC_FEATURE_MASK_1(EC_FEATURE_MEMORY_DUMP)
#endif
#ifdef CONFIG_USB_PD_DP21_MODE
		| EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_DP2_1)
#endif
#ifdef CONFIG_UCSI_PPM
		| EC_FEATURE_MASK_1(EC_FEATURE_UCSI_PPM)
#endif
		;
	return board_override_feature_flags1(result);
}
/* LCOV_EXCL_STOP */

__overridable uint32_t board_override_feature_flags0(uint32_t flags0)
{
	return flags0;
}

__overridable uint32_t board_override_feature_flags1(uint32_t flags1)
{
	return flags1;
}

static int cc_feat(int argc, const char **argv)
{
	ccprintf(" 0-31: 0x%08x\n", get_feature_flags0());
	ccprintf("32-63: 0x%08x\n", get_feature_flags1());

	return EC_SUCCESS;
}
DECLARE_CONSOLE_COMMAND(feat, cc_feat, "", "Print feature flags");