path: root/board/spring/board.c

/* Copyright (c) 2012 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.
 */
/* Spring board-specific configuration */

#include "adc.h"
#include "chipset.h"
#include "common.h"
#include "console.h"
#include "dma.h"
#include "ec_commands.h"
#include "gpio.h"
#include "hooks.h"
#include "host_command.h"
#include "i2c.h"
#include "lp5562.h"
#include "pmu_tpschrome.h"
#include "registers.h"
#include "smart_battery.h"
#include "stm32_adc.h"
#include "timer.h"
#include "util.h"

#define GPIO_KB_INPUT  (GPIO_INPUT | GPIO_PULL_UP | GPIO_INT_BOTH)
#define GPIO_KB_OUTPUT (GPIO_OUTPUT | GPIO_OPEN_DRAIN)

#define INT_BOTH_FLOATING	(GPIO_INPUT | GPIO_INT_BOTH)
#define INT_BOTH_PULL_UP	(GPIO_INPUT | GPIO_PULL_UP | GPIO_INT_BOTH)

#define HARD_RESET_TIMEOUT_MS 5

/* We use yellow LED instead of blue LED. Re-map colors here. */
#define LED_COLOR_NONE   LP5562_COLOR_NONE
#define LED_COLOR_GREEN  LP5562_COLOR_GREEN
#define LED_COLOR_YELLOW LP5562_COLOR_BLUE
#define LED_COLOR_RED    LP5562_COLOR_RED

/* LED states */
enum led_state_t {
	LED_STATE_SOLID_RED,
	LED_STATE_SOLID_GREEN,
	LED_STATE_SOLID_YELLOW,
	LED_STATE_TRANSITION_ON,  /* Solid yellow -> breathing */
	LED_STATE_TRANSITION_OFF, /* Breathing -> solid yellow */
	LED_STATE_BREATHING,

	/* Not an actual state */
	LED_STATE_OFF,
};

/* LED breathing program */
uint8_t breathing_prog[] = {0x41, 0xff,  /* 0x80 -> 0x0 */
			    0x41, 0x7f,  /* 0x0 -> 0x80 */
			    0x7f, 0x00,  /* Wait ~4s */
			    0x7f, 0x00,
			    0x7f, 0x00,
			    0x7f, 0x00,
			    0x00, 0x00,  /* Go to start */
			    0x40, 0x80,  /* Set PWM = 0x80 */
			    0x00, 0x00}; /* Go to start */
#define BREATHING_PROG_ENTRY 7

/* GPIO interrupt handlers prototypes */
#ifndef CONFIG_TASK_GAIAPOWER
#define gaia_power_event NULL
#define gaia_suspend_event NULL
#define gaia_lid_event NULL
#else
void gaia_power_event(enum gpio_signal signal);
void gaia_suspend_event(enum gpio_signal signal);
void gaia_lid_event(enum gpio_signal signal);
#endif
#ifndef CONFIG_TASK_KEYSCAN
#define matrix_interrupt NULL
#endif
void usb_charge_interrupt(enum gpio_signal signal);

/* GPIO signal list.  Must match order from enum gpio_signal. */
const struct gpio_info gpio_list[GPIO_COUNT] = {
	/* Inputs with interrupt handlers are first for efficiency */
	{"KB_PWR_ON_L", GPIO_B, (1<<5),  GPIO_INT_BOTH, gaia_power_event},
	{"PP1800_LDO2", GPIO_A, (1<<1),  GPIO_INT_BOTH, gaia_power_event},
	{"XPSHOLD",     GPIO_A, (1<<3),  GPIO_INT_BOTH, gaia_power_event},
	{"CHARGER_INT", GPIO_C, (1<<4),  GPIO_INT_FALLING, pmu_irq_handler},
	{"LID_OPEN",    GPIO_C, (1<<13), GPIO_INT_RISING, gaia_lid_event},
	{"SUSPEND_L",   GPIO_A, (1<<7),  INT_BOTH_FLOATING, gaia_suspend_event},
	{"WP_L",        GPIO_A, (1<<13), GPIO_INPUT, NULL},
	{"KB_IN00",     GPIO_C, (1<<8),  GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN01",     GPIO_C, (1<<9),  GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN02",     GPIO_C, (1<<10), GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN03",     GPIO_C, (1<<11), GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN04",     GPIO_C, (1<<12), GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN05",     GPIO_C, (1<<14), GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN06",     GPIO_C, (1<<15), GPIO_KB_INPUT, matrix_interrupt},
	{"KB_IN07",     GPIO_D, (1<<2),  GPIO_KB_INPUT, matrix_interrupt},
	{"USB_CHG_INT", GPIO_A, (1<<6),  GPIO_INT_FALLING,
		usb_charge_interrupt},
	/* Other inputs */
	{"BCHGR_VACG",  GPIO_A, (1<<0), GPIO_INT_BOTH, NULL},
	/*
	 * I2C pins should be configured as inputs until I2C module is
	 * initialized. This will avoid driving the lines unintentionally.
	 */
	{"I2C1_SCL",    GPIO_B, (1<<6),  GPIO_INPUT, NULL},
	{"I2C1_SDA",    GPIO_B, (1<<7),  GPIO_INPUT, NULL},
	{"I2C2_SCL",    GPIO_B, (1<<10), GPIO_INPUT, NULL},
	{"I2C2_SDA",    GPIO_B, (1<<11), GPIO_INPUT, NULL},
	/* Outputs */
	{"EN_PP1350",   GPIO_A, (1<<14), GPIO_OUT_LOW, NULL},
	{"EN_PP5000",   GPIO_A, (1<<11),  GPIO_OUT_LOW, NULL},
	{"EN_PP3300",   GPIO_A, (1<<8),  GPIO_OUT_LOW, NULL},
	{"PMIC_PWRON_L",GPIO_A, (1<<12), GPIO_OUT_HIGH, NULL},
	{"PMIC_RESET",  GPIO_A, (1<<15), GPIO_OUT_LOW, NULL},
	{"ENTERING_RW", GPIO_D, (1<<0),  GPIO_OUT_LOW, NULL},
	{"CHARGER_EN",  GPIO_B, (1<<2),  GPIO_OUT_LOW, NULL},
	{"EC_INT",      GPIO_B, (1<<9),  GPIO_HI_Z, NULL},
	{"ID_MUX",      GPIO_D, (1<<1),  GPIO_OUT_LOW, NULL},
	{"KB_OUT00",    GPIO_B, (1<<0),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT01",    GPIO_B, (1<<8),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT02",    GPIO_B, (1<<12), GPIO_KB_OUTPUT, NULL},
	{"KB_OUT03",    GPIO_B, (1<<13), GPIO_KB_OUTPUT, NULL},
	{"KB_OUT04",    GPIO_B, (1<<14), GPIO_KB_OUTPUT, NULL},
	{"KB_OUT05",    GPIO_B, (1<<15), GPIO_KB_OUTPUT, NULL},
	{"KB_OUT06",    GPIO_C, (1<<0),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT07",    GPIO_C, (1<<1),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT08",    GPIO_C, (1<<2),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT09",    GPIO_B, (1<<1),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT10",    GPIO_C, (1<<5),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT11",    GPIO_C, (1<<6),  GPIO_KB_OUTPUT, NULL},
	{"KB_OUT12",    GPIO_C, (1<<7),  GPIO_KB_OUTPUT, NULL},
	{"BOOST_EN",    GPIO_B, (1<<3),  GPIO_OUT_HIGH, NULL},
	{"ILIM",	GPIO_B, (1<<4),  GPIO_OUT_LOW, NULL},
};

/* ADC channels */
const struct adc_t adc_channels[ADC_CH_COUNT] = {
	/*
	 * VBUS voltage sense pin.
	 * Sense pin 3.3V is converted to 4096. Accounting for the 2x
	 * voltage divider, the conversion factor is 6600mV/4096.
	 */
	[ADC_CH_USB_VBUS_SNS] = {"USB_VBUS_SNS", 6600, 4096, 0, STM32_AIN(5)},
	/* Micro USB D+ sense pin. Converted to mV (3300mV/4096). */
	[ADC_CH_USB_DP_SNS] = {"USB_DP_SNS", 3300, 4096, 0, STM32_AIN(2)},
	/* Micro USB D- sense pin. Converted to mV (3300mV/4096). */
	[ADC_CH_USB_DN_SNS] = {"USB_DN_SNS", 3300, 4096, 0, STM32_AIN(4)},
};

void configure_board(void)
{
	uint32_t val;

	dma_init();

	/* Enable all GPIOs clocks
	 * TODO: more fine-grained enabling for power saving
	 */
	STM32_RCC_APB2ENR |= 0x1fd;

	/* remap OSC_IN/OSC_OUT to PD0/PD1 */
	STM32_GPIO_AFIO_MAPR |= 1 << 15;

	/*
	 * use PA13, PA14, PA15, PB3, PB4 as a GPIO,
	 * so disable JTAG and SWD
	 */
	STM32_GPIO_AFIO_MAPR = (STM32_GPIO_AFIO_MAPR & ~(0x7 << 24))
			       | (4 << 24);

	/* remap TIM3_CH1 to PB4 */
	STM32_GPIO_AFIO_MAPR = (STM32_GPIO_AFIO_MAPR & ~(0x3 << 10))
			       | (2 << 10);

	/* Analog input for ADC pins (PA2, PA4, PA5) */
	STM32_GPIO_CRL_OFF(GPIO_A) &= ~0x00ff0f00;

	/*
	 * Set alternate function for USART1. For alt. function input
	 * the port is configured in either floating or pull-up/down
	 * input mode (ref. section 7.1.4 in datasheet RM0041):
	 * PA9:  Tx, alt. function output
	 * PA10: Rx, input with pull-down
	 *
	 * note: see crosbug.com/p/12223 for more info
	 */
	val = STM32_GPIO_CRH_OFF(GPIO_A) & ~0x00000ff0;
	val |= 0x00000890;
	STM32_GPIO_CRH_OFF(GPIO_A) = val;

	/* EC_INT is output, open-drain */
	val = STM32_GPIO_CRH_OFF(GPIO_B) & ~0xf0;
	val |= 0x50;
	STM32_GPIO_CRH_OFF(GPIO_B) = val;
	/* put GPIO in Hi-Z state */
	gpio_set_level(GPIO_EC_INT, 1);
}

/* GPIO configuration to be done after I2C module init */
void board_i2c_post_init(int port)
{
	uint32_t val;

	/* enable alt. function (open-drain) */
	if (port == STM32_I2C1_PORT) {
		/* I2C1 is on PB6-7 */
		val = STM32_GPIO_CRL_OFF(GPIO_B) & ~0xff000000;
		val |= 0xdd000000;
		STM32_GPIO_CRL_OFF(GPIO_B) = val;
	} else if (port == STM32_I2C2_PORT) {
		/* I2C2 is on PB10-11 */
		val = STM32_GPIO_CRH_OFF(GPIO_B) & ~0x0000ff00;
		val |= 0x0000dd00;
		STM32_GPIO_CRH_OFF(GPIO_B) = val;
	}
}

void board_interrupt_host(int active)
{
	/* interrupt host by using active low EC_INT signal */
	gpio_set_level(GPIO_EC_INT, !active);
}

static void board_startup_hook(void)
{
	gpio_set_flags(GPIO_SUSPEND_L, INT_BOTH_PULL_UP);

#ifdef CONFIG_PMU_FORCE_FET
	/* Enable 3G modem power */
	pmu_enable_fet(FET_WWAN, 1, NULL);
#endif /* CONFIG_PMU_FORCE_FET */
}
DECLARE_HOOK(HOOK_CHIPSET_STARTUP, board_startup_hook, HOOK_PRIO_DEFAULT);

static void board_shutdown_hook(void)
{
#ifdef CONFIG_PMU_FORCE_FET
	/* Power off backlight power */
	pmu_enable_fet(FET_BACKLIGHT, 0, NULL);
	/* Power off lcd panel */
	pmu_enable_fet(FET_LCD_PANEL, 0, NULL);
#endif /* CONFIG_PMU_FORCE_FET */

	/* Disable pull-up on SUSPEND_L during shutdown to prevent leakage */
	gpio_set_flags(GPIO_SUSPEND_L, INT_BOTH_FLOATING);
}
DECLARE_HOOK(HOOK_CHIPSET_SHUTDOWN, board_shutdown_hook, HOOK_PRIO_DEFAULT);

/*
 * Force the pmic to reset completely.  This forces an entire system reset,
 * and therefore should never return
 */
void board_hard_reset(void)
{
	/* Force a hard reset of tps Chrome */
	gpio_set_level(GPIO_PMIC_RESET, 1);

	/* Delay while the power is cut */
	udelay(HARD_RESET_TIMEOUT_MS * 1000);

	/* Shouldn't get here unless the board doesn't have this capability */
	panic_puts("Hard reset failed! (this board may not be capable)\n");
}

#ifdef CONFIG_PMU_BOARD_INIT

/**
 * Initialize PMU register settings
 *
 * PMU init settings depend on board configuration. This function should be
 * called inside PMU init function.
 */
int board_pmu_init(void)
{
	int failure = 0;

	/*
	 * Adjust charging parameters to match the expectations
	 * of the hardware fixing the cap ringing on DVT+ machines.
	 */
	failure |= pmu_set_term_current(RANGE_T01, TERM_I0875);
	failure |= pmu_set_term_current(RANGE_T12, TERM_I0875);
	failure |= pmu_set_term_current(RANGE_T23, TERM_I0875);
	failure |= pmu_set_term_current(RANGE_T34, TERM_I0875);
	failure |= pmu_set_term_current(RANGE_T40, TERM_I1000);
	failure |= pmu_set_term_voltage(RANGE_T01, TERM_V2100);
	failure |= pmu_set_term_voltage(RANGE_T12, TERM_V2100);
	failure |= pmu_set_term_voltage(RANGE_T23, TERM_V2100);
	failure |= pmu_set_term_voltage(RANGE_T34, TERM_V2100);
	failure |= pmu_set_term_voltage(RANGE_T40, TERM_V2100);

	/* Set fast charging timeout to 6 hours*/
	if (!failure)
		failure = pmu_set_fastcharge(TIMEOUT_6HRS);
	/* Enable external gpio CHARGER_EN control */
	if (!failure)
		failure = pmu_enable_ext_control(1);
	/* Disable force charging */
	if (!failure)
		failure = pmu_enable_charger(0);

	/* Set NOITERM bit */
	if (!failure)
		failure = pmu_low_current_charging(1);

	return failure ? EC_ERROR_UNKNOWN : EC_SUCCESS;
}
#endif /* CONFIG_BOARD_PMU_INIT */

int board_get_ac(void)
{
	static int last_vbus;
	int vbus, vbus_good;

	if (!gpio_get_level(GPIO_BOOST_EN))
		return 0;

	/*
	 * UVLO is 4.1V. We consider AC bad when its voltage drops below 4.2V
	 * for two consecutive samples. This is to give PWM a chance to bring
	 * voltage up.
	 */
	vbus = adc_read_channel(ADC_CH_USB_VBUS_SNS);
	vbus_good = (vbus >= 4200 || last_vbus >= 4200);
	last_vbus = vbus;

	return vbus_good;
}

static int stop_led_engine(void)
{
	int pc;
	if (lp5562_get_engine_state(LP5562_ENG_SEL_1) == LP5562_ENG_STEP)
		return 0; /* Not stopped */
	pc = lp5562_get_pc(LP5562_ENG_SEL_1);
	if (pc == 1) {
		/* LED currently off. Ramp up. */
		lp5562_engine_control(LP5562_ENG_STEP,
				      LP5562_ENG_HOLD,
				      LP5562_ENG_HOLD);
		return 0;
	}

	lp5562_set_engine(LP5562_ENG_SEL_NONE,
			  LP5562_ENG_SEL_NONE,
			  LP5562_ENG_SEL_NONE);
	lp5562_set_color(LED_COLOR_YELLOW);
	return 1;
}

static int set_led_color(enum led_state_t state)
{
	ASSERT(state != LED_STATE_TRANSITION_ON &&
	       state != LED_STATE_TRANSITION_OFF);

	switch (state) {
	case LED_STATE_SOLID_RED:
		return lp5562_set_color(LED_COLOR_RED);
	case LED_STATE_SOLID_GREEN:
		return lp5562_set_color(LED_COLOR_GREEN);
	case LED_STATE_SOLID_YELLOW:
	case LED_STATE_BREATHING:
		return lp5562_set_color(LED_COLOR_YELLOW);
	default:
		return EC_ERROR_UNKNOWN;
	}
}

static void board_stablize_led(enum led_state_t desired_state)
{
	static enum led_state_t current_state = LED_STATE_OFF;
	enum led_state_t next_state = LED_STATE_OFF;

	/* TRANSITIONs are internal states */
	ASSERT(desired_state != LED_STATE_TRANSITION_ON &&
	       desired_state != LED_STATE_TRANSITION_OFF);

	if (desired_state == LED_STATE_OFF) {
		current_state = LED_STATE_OFF;
		return;
	}

	/* Determine next state */
	switch (current_state) {
	case LED_STATE_OFF:
	case LED_STATE_SOLID_RED:
	case LED_STATE_SOLID_GREEN:
		if (desired_state == LED_STATE_BREATHING)
			next_state = LED_STATE_SOLID_YELLOW;
		else
			next_state = desired_state;
		set_led_color(next_state);
		break;
	case LED_STATE_SOLID_YELLOW:
		if (desired_state == LED_STATE_BREATHING) {
			next_state = LED_STATE_TRANSITION_ON;
			lp5562_set_pc(LP5562_ENG_SEL_1, BREATHING_PROG_ENTRY);
			lp5562_engine_control(LP5562_ENG_STEP,
					      LP5562_ENG_HOLD,
					      LP5562_ENG_HOLD);
		} else {
			next_state = desired_state;
			set_led_color(next_state);
		}
		break;
	case LED_STATE_BREATHING:
		if (desired_state != LED_STATE_BREATHING) {
			next_state = LED_STATE_TRANSITION_OFF;
			lp5562_engine_control(LP5562_ENG_STEP,
					      LP5562_ENG_HOLD,
					      LP5562_ENG_HOLD);
		} else {
			next_state = LED_STATE_BREATHING;
		}
		break;
	case LED_STATE_TRANSITION_ON:
		if (desired_state == LED_STATE_BREATHING) {
			next_state = LED_STATE_BREATHING;
			lp5562_set_engine(LP5562_ENG_SEL_NONE,
					  LP5562_ENG_SEL_NONE,
					  LP5562_ENG_SEL_1);
			lp5562_engine_control(LP5562_ENG_RUN,
					      LP5562_ENG_HOLD,
					      LP5562_ENG_HOLD);
		} else {
			next_state = LED_STATE_SOLID_YELLOW;
			lp5562_engine_control(LP5562_ENG_HOLD,
					      LP5562_ENG_HOLD,
					      LP5562_ENG_HOLD);
		}
		break;
	case LED_STATE_TRANSITION_OFF:
		if (stop_led_engine())
			next_state = LED_STATE_SOLID_YELLOW;
		else
			next_state = LED_STATE_TRANSITION_OFF;
		break;
	}

	current_state = next_state;
}

static void board_battery_led_update(void)
{
	int current;
	int desired_current;
	enum led_state_t state = LED_STATE_OFF;

	/* Current states and next states */
	static int led_power = -1;
	int new_led_power;

	/* Determine LED power */
	new_led_power = board_get_ac();
	if (new_led_power != led_power) {
		led_power = new_led_power;
		if (new_led_power) {
			lp5562_poweron();
			lp5562_engine_load(LP5562_ENG_SEL_1,
					   breathing_prog,
					   sizeof(breathing_prog));
		} else {
			lp5562_poweroff();
			board_stablize_led(LED_STATE_OFF);
		}
	}
	if (!new_led_power)
		return;

	/*
	 * LED power is controlled by accessory detection. We only
	 * set color here.
	 */
	switch (charge_get_state()) {
	case ST_IDLE:
		state = LED_STATE_SOLID_GREEN;
		break;
	case ST_DISCHARGING:
		/* Discharging with AC, must be battery assist */
		state = LED_STATE_BREATHING;
		break;
	case ST_REINIT:
	case ST_BAD_COND:
	case ST_PRE_CHARGING:
		state = LED_STATE_SOLID_YELLOW;
		break;
	case ST_CHARGING:
		if (battery_current(&current) ||
		    battery_desired_current(&desired_current)) {
			/* Cannot talk to the battery. Set LED to red. */
			state = LED_STATE_SOLID_RED;
			break;
		}

		if (current < 0 && desired_current > 0) { /* Battery assist */
			state = LED_STATE_BREATHING;
			break;
		}

		if (current && desired_current)
			state = LED_STATE_SOLID_YELLOW;
		else
			state = LED_STATE_SOLID_GREEN;
		break;
	case ST_CHARGING_ERROR:
		state = LED_STATE_SOLID_RED;
		break;
	}

	board_stablize_led(state);
}
DECLARE_HOOK(HOOK_SECOND, board_battery_led_update, HOOK_PRIO_DEFAULT);

/*****************************************************************************/
/* Host commands */

static int power_command_info(struct host_cmd_handler_args *args)
{
	struct ec_response_power_info *r = args->response;

	r->voltage_ac = adc_read_channel(ADC_CH_USB_VBUS_SNS);
	r->voltage_system = pmu_adc_read(ADC_VAC, ADC_FLAG_KEEP_ON)
			  * 17000 / 1024;
	r->current_system = pmu_adc_read(ADC_IAC, 0)
			  * (1000 / R_INPUT_MOHM) * 33 / 1024;
	r->usb_dev_type = board_get_usb_dev_type();
	r->usb_current_limit = board_get_usb_current_limit();
	args->response_size = sizeof(*r);

	return EC_RES_SUCCESS;
}
DECLARE_HOST_COMMAND(EC_CMD_POWER_INFO, power_command_info, EC_VER_MASK(0));