/* Copyright 2021 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.
 */

#ifndef __BOARD_ANAHERA_FW_CONFIG_H_
#define __BOARD_ANAHERA_FW_CONFIG_H_

#include <stdint.h>

/****************************************************************************
 * CBI FW_CONFIG layout for Anahera board.
 *
 * Source of truth is the project/brya/anahera/config.star configuration file.
 */

enum ec_cfg_keyboard_backlight_type {
	KEYBOARD_BACKLIGHT_DISABLED = 0,
	KEYBOARD_BACKLIGHT_ENABLED = 1
};

enum ec_cfg_eps_type {
	EPS_DISABLED = 0,
	EPS_ENABLED = 1
};

enum ec_cfg_ite_type {
	LTE_NOT_PRESENT = 0,
	LTE_PRESENT = 1,
};

union anahera_cbi_fw_config {
	struct {
		uint32_t				sd_db : 2;
		enum ec_cfg_keyboard_backlight_type	kb_bl : 1;
		uint32_t				audio : 3;
		enum ec_cfg_ite_type			lte_db : 2;
		uint32_t				ufc : 2;
		enum ec_cfg_eps_type			eps : 1;
		uint32_t				boot_device : 2;
		uint32_t				reserved_1 : 19;
	};
	uint32_t raw_value;
};

/**
 * Read the cached FW_CONFIG.  Guaranteed to have valid values.
 *
 * @return the FW_CONFIG for the board.
 */
union anahera_cbi_fw_config get_fw_config(void);

/**
 * Check if the FW_CONFIG has enabled privacy screen.
 *
 * @return true if board supports privacy screen, false if the board
 * doesn't support it.
 */
bool ec_cfg_has_eps(void);

/**
 * Check if the FW_CONFIG has enabled keyboard backlight.
 *
 * @return true if board supports keyboard backlight, false if the board
 * doesn't support it.
 */
bool ec_cfg_has_kblight(void);

/**
 * Check if the FW_CONFIG has LTE present.
 *
 * @return true if board supports LTE, false if the board
 * doesn't support it.
 */
bool ec_cfg_has_lte(void);

#endif /* __BOARD_ANAHERA_FW_CONFIG_H_ */