path: root/board/taniks/board.h

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

/* Taniks board configuration */
#define CONFIG_BUTTONS_RUNTIME_CONFIG

#ifndef __CROS_EC_BOARD_H
#define __CROS_EC_BOARD_H

#include "compile_time_macros.h"

/*
 * Taniks boards are set up for vivaldi
 */
#define CONFIG_KEYBOARD_VIVALDI
#undef CONFIG_VOLUME_BUTTONS
#define NPCX_SELECT_KSI_TO_GPIO
#define CONFIG_KEYBOARD_REFRESH_ROW3
#define CONFIG_KEYBOARD_SCAN_ADC

/* Baseboard features */
#include "baseboard.h"

#undef CONFIG_CMD_POWERINDEBUG
#undef CONFIG_MKBP_INPUT_DEVICES
#undef CONFIG_TABLET_MODE
#undef CONFIG_GMR_TABLET_MODE
#undef CONFIG_TABLET_MODE_SWITCH
#undef CONFIG_VOLUME_BUTTONS

/*
 * This will happen automatically on NPCX9 ES2 and later. Do not remove
 * until we can confirm all earlier chips are out of service.
 */
#define CONFIG_HIBERNATE_PSL_VCC1_RST_WAKEUP

/* LED */
#define CONFIG_LED_ONOFF_STATES

/* Sensors */
#define CONFIG_DYNAMIC_MOTION_SENSOR_COUNT

/* Change Request (b/211078551)
 * GYRO sensor change from ST LSM6DSOETR3TR to ST LSM6DS3TR-C
 *	LSM6DSOETR3TR base accel/gyro if board id = 0
 *	LSM6DS3TR-C Base accel/gyro if board id > 0
 */
#define CONFIG_ACCELGYRO_LSM6DSO /* Base accel */
#define CONFIG_ACCEL_LSM6DSO_INT_EVENT \
	TASK_EVENT_MOTION_SENSOR_INTERRUPT(BASE_ACCEL)
#define CONFIG_ACCELGYRO_LSM6DSM
#define CONFIG_ACCEL_LSM6DSM_INT_EVENT \
	TASK_EVENT_MOTION_SENSOR_INTERRUPT(BASE_ACCEL)

/* Enable sensor fifo, must also define the _SIZE and _THRES */
#define CONFIG_ACCEL_FIFO
/* FIFO size is in power of 2. */
#define CONFIG_ACCEL_FIFO_SIZE 256
/* Depends on how fast the AP boots and typical ODRs */
#define CONFIG_ACCEL_FIFO_THRES (CONFIG_ACCEL_FIFO_SIZE / 3)

/* Sensors without hardware FIFO are in forced mode */
#define CONFIG_ACCEL_FORCE_MODE_MASK (BIT(LID_ACCEL))

/* Lid accel */
#define CONFIG_LID_ANGLE
#define CONFIG_LID_ANGLE_UPDATE
#define CONFIG_LID_ANGLE_SENSOR_BASE BASE_ACCEL
#define CONFIG_LID_ANGLE_SENSOR_LID LID_ACCEL
#define CONFIG_ACCEL_BMA4XX
#define CONFIG_ACCEL_LIS2DWL

/* Sensor console commands */
#define CONFIG_CMD_ACCELS
#define CONFIG_CMD_ACCEL_INFO

/* USB Type A Features */
#define USB_PORT_COUNT 1
#define CONFIG_USB_PORT_POWER_DUMB

#define CONFIG_IO_EXPANDER
#define CONFIG_IO_EXPANDER_NCT38XX
#define CONFIG_IO_EXPANDER_PORT_COUNT 1

/* USB Type C and USB PD defines */
#define CONFIG_USB_PD_TCPM_PS8815
#define CONFIG_USB_PD_TCPM_PS8815_FORCE_DID
#define CONFIG_USBC_PPC_SYV682X
#define CONFIG_USBC_PPC_NX20P3483
#define CONFIG_USBC_NX20P348X_RCP_5VSRC_MASK_ENABLE

#define CONFIG_USB_PD_FRS_PPC
#define CONFIG_USB_PD_FRS

/* I2C speed console command */
#define CONFIG_CMD_I2C_SPEED

/* I2C control host command */
#define CONFIG_HOSTCMD_I2C_CONTROL

/* TODO: b/177608416 - measure and check these values on brya */
#define PD_POWER_SUPPLY_TURN_ON_DELAY 30000 /* us */
#define PD_POWER_SUPPLY_TURN_OFF_DELAY 30000 /* us */
#define PD_VCONN_SWAP_DELAY 5000 /* us */

/*
 * Passive USB-C cables only support up to 60W.
 */
#define PD_OPERATING_POWER_MW 15000
#define PD_MAX_POWER_MW 45000
#define PD_MAX_CURRENT_MA 3000
#define PD_MAX_VOLTAGE_MV 20000

/* The lower the input voltage, the higher the power efficiency. */
#define PD_PREFER_LOW_VOLTAGE

/*
 * Macros for GPIO signals used in common code that don't match the
 * schematic names. Signal names in gpio.inc match the schematic and are
 * then redefined here to so it's more clear which signal is being used for
 * which purpose.
 */
#define GPIO_AC_PRESENT GPIO_ACOK_OD
#define GPIO_CPU_PROCHOT GPIO_EC_PROCHOT_ODL
#define GPIO_EC_INT_L GPIO_EC_PCH_INT_ODL
#define GPIO_ENABLE_BACKLIGHT GPIO_EC_EN_EDP_BL
#define GPIO_ENTERING_RW GPIO_EC_ENTERING_RW
#define GPIO_KSI_00 GPIO_EC_KSI_00
#define GPIO_KSI_01 GPIO_EC_KSI_01
#define GPIO_KSI_02 GPIO_EC_KSI_02
#define GPIO_KSI_03 GPIO_EC_KSI_03
#define GPIO_KSI_04 GPIO_EC_KSI_04
#define GPIO_KSI_05 GPIO_EC_KSI_05
#define GPIO_KSI_06 GPIO_EC_KSI_06
#define GPIO_KSI_07 GPIO_EC_KSI_07
#define GPIO_KSO_00 GPIO_EC_KSO_00
#define GPIO_KSO_01 GPIO_EC_KSO_01
#define GPIO_KSO_02 GPIO_EC_KSO_02_R
#define GPIO_KSO_03 GPIO_EC_KSO_03
#define GPIO_KSO_04 GPIO_EC_KSO_04
#define GPIO_KSO_05 GPIO_EC_KSO_05
#define GPIO_KSO_06 GPIO_EC_KSO_06_R
#define GPIO_KSO_07 GPIO_EC_KSO_07_R
#define GPIO_KSO_08 GPIO_EC_KSO_08
#define GPIO_KSO_09 GPIO_EC_KSO_09
#define GPIO_KSO_10 GPIO_EC_KSO_10
#define GPIO_KSO_11 GPIO_EC_KSO_11
#define GPIO_KSO_12 GPIO_EC_KSO_12
#define GPIO_KSO_13 GPIO_EC_KSO_13
#define GPIO_KSO_14 GPIO_EC_KSO_14
#define GPIO_RFR_KEY_L GPIO_EC_RFR_KEY_ODL_R
#define GPIO_PACKET_MODE_EN GPIO_EC_GSC_PACKET_MODE
#define GPIO_PCH_PWRBTN_L GPIO_EC_PCH_PWR_BTN_ODL
#define GPIO_PCH_RSMRST_L GPIO_EC_PCH_RSMRST_L
#define GPIO_PCH_RTCRST GPIO_EC_PCH_RTCRST
#define GPIO_PCH_SLP_S0_L GPIO_SYS_SLP_S0IX_L
#define GPIO_PCH_SLP_S3_L GPIO_SLP_S3_L

/*
 * GPIO_EC_PCH_INT_ODL is used for MKBP events as well as a PCH wakeup
 * signal.
 */
#define GPIO_PCH_WAKE_L GPIO_EC_PCH_INT_ODL
#define GPIO_PG_EC_ALL_SYS_PWRGD GPIO_SEQ_EC_ALL_SYS_PG
#define GPIO_PG_EC_DSW_PWROK GPIO_SEQ_EC_DSW_PWROK
#define GPIO_PG_EC_RSMRST_ODL GPIO_SEQ_EC_RSMRST_ODL
#define GPIO_POWER_BUTTON_L GPIO_GSC_EC_PWR_BTN_ODL
#define GPIO_SYS_RESET_L GPIO_SYS_RST_ODL
#define GPIO_WP_L GPIO_EC_WP_ODL

/* System has back-lit keyboard */
#define CONFIG_PWM
#define CONFIG_KEYBOARD_BACKLIGHT

/* I2C Bus Configuration */
#define I2C_PORT_SENSOR NPCX_I2C_PORT0_0
#define I2C_PORT_USB_C0_TCPC NPCX_I2C_PORT1_0
#define I2C_PORT_USB_C1_TCPC NPCX_I2C_PORT4_1
#define I2C_PORT_USB_C0_PPC NPCX_I2C_PORT2_0
#define I2C_PORT_USB_C1_PPC NPCX_I2C_PORT6_1
#define I2C_PORT_USB_C0_BC12 NPCX_I2C_PORT2_0
#define I2C_PORT_USB_C1_BC12 NPCX_I2C_PORT6_1
#define I2C_PORT_USB_C1_MUX NPCX_I2C_PORT6_1
#define I2C_PORT_BATTERY NPCX_I2C_PORT5_0
#define I2C_PORT_CHARGER NPCX_I2C_PORT7_0
#define I2C_PORT_EEPROM NPCX_I2C_PORT7_0
#define I2C_PORT_MP2964 NPCX_I2C_PORT7_0
#define I2C_PORT_KBMCU NPCX_I2C_PORT3_0

#define I2C_ADDR_EEPROM_FLAGS 0x50

#define I2C_ADDR_MP2964_FLAGS 0x20

/* Thermal features */
#define CONFIG_THERMISTOR
#define CONFIG_TEMP_SENSOR
#define CONFIG_TEMP_SENSOR_POWER_GPIO GPIO_SEQ_EC_DSW_PWROK
#define CONFIG_STEINHART_HART_3V3_30K9_47K_4050B

/* Fan */
#define CONFIG_FANS FAN_CH_COUNT

/* Charger defines */
#define CONFIG_CHARGER_BQ25720
#define CONFIG_CHARGER_BQ25720_VSYS_TH2_CUSTOM
/* 37h BIT7:2 VSYS_TH2 6.0V */
#define CONFIG_CHARGER_BQ25720_VSYS_TH2_DV 60
#define CONFIG_CHARGE_RAMP_SW
#define CONFIG_CHARGER_BQ25710_SENSE_RESISTOR 10
#define CONFIG_CHARGER_BQ25710_SENSE_RESISTOR_AC 10
/* 30h BIT13:12 Enable PSYS 00b */
#define CONFIG_CHARGER_BQ25710_PSYS_SENSING
/* 30h BIT7 1.2V enable*/
#define CONFIG_CHARGER_BQ25710_CMP_REF_1P2
/* 30h BIT6 external hysteresis */
#define CONFIG_CHARGER_BQ25710_CMP_POL_EXTERNAL
/* 31h BIT3 = 1 Enable ACOC */
#define CONFIG_CHARGER_BQ25710_EN_ACOC
/* 33h BIT15:11 ILIM2 TH 140% */
#define CONFIG_CHARGER_BQ257X0_ILIM2_VTH_CUSTOM
#define CONFIG_CHARGER_BQ257X0_ILIM2_VTH \
	BQ257X0_PROCHOT_OPTION_0_ILIM2_VTH__1P40
/* 34h BIT0 CONFIG_CHARGER_BQ25710_PP_ACOK */
#define CONFIG_CHARGER_BQ25710_PP_ACOK
/* 34h BIT3 and BIT15:10 IDCHG 9728mA, step is 512mA */
#define CONFIG_CHARGER_BQ25710_IDCHG_LIMIT_MA 9728
/* 34h BIT6 CONFIG_CHARGER_BQ25710_PP_COMP */
#define CONFIG_CHARGER_BQ25710_PP_COMP
/* 36h UVP 5600mV */
#define CONFIG_CHARGER_BQ25720_VSYS_UVP_CUSTOM
#define CONFIG_CHARGER_BQ25720_VSYS_UVP BQ25720_CHARGE_OPTION_4_VSYS_UVP__5P6
/* 3Eh BIT15:8 VSYS_MIN 6.1V */
#define CONFIG_CHARGER_BQ25710_VSYS_MIN_VOLTAGE_CUSTOM
#define CONFIG_CHARGER_BQ25710_VSYS_MIN_VOLTAGE_MV 6100

/* RGB Keyboard */
#define GPIO_RGBKBD_SDB_L GPIO_KBMCU_INT_ODL

#define CONFIG_RGB_KEYBOARD
#define CONFIG_LED_DRIVER_AW20198 /* Awinic AW20198 on I2C */

#define RGB_GRID0_COL 8
#define RGB_GRID0_ROW 6

#ifndef __ASSEMBLER__

#include "gpio_signal.h" /* needed by registers.h */
#include "registers.h"
#include "usbc_config.h"

enum adc_channel {
	ADC_TEMP_SENSOR_1_DDR_SOC,
	ADC_TEMP_SENSOR_3_CHARGER,
	ADC_TEMP_SENSOR_4_CPUCHOKE,
	ADC_KSI_00,
	ADC_KSI_01,
	ADC_KSI_02,
	ADC_KSI_03,
	ADC_KSI_04,
	ADC_KSI_05,
	ADC_KSI_06,
	ADC_KSI_07,
	ADC_CH_COUNT
};

enum temp_sensor_id {
	TEMP_SENSOR_1_DDR_SOC,
	TEMP_SENSOR_3_CHARGER,
	TEMP_SENSOR_4_CPUCHOKE,
	TEMP_SENSOR_COUNT
};

enum sensor_id { LID_ACCEL = 0, BASE_ACCEL, BASE_GYRO, SENSOR_COUNT };

enum ioex_port { IOEX_C0_NCT38XX = 0, IOEX_PORT_COUNT };

enum battery_type {
	BATTERY_SMP_51W,
	BATTERY_SMP_71W,
	BATTERY_LGC,
	BATTERY_TYPE_COUNT,
};

enum pwm_channel {
	PWM_CH_FAN, /* PWM5 */
	PWM_CH_COUNT
};

enum fan_channel { FAN_CH_0 = 0, FAN_CH_COUNT };

enum mft_channel { MFT_CH_0 = 0, MFT_CH_COUNT };

void motion_interrupt(enum gpio_signal signal);

#endif /* !__ASSEMBLER__ */

#endif /* __CROS_EC_BOARD_H */