path: root/driver/bc12/pi3usb9281.c

/* Copyright 2014 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.
 *
 * Pericom PI3USB3281 USB port switch driver.
 */

#include "builtin/assert.h"
#include "charge_manager.h"
#include "common.h"
#include "console.h"
#include "ec_commands.h"
#include "gpio.h"
#include "hooks.h"
#include "i2c.h"
#include "pi3usb9281.h"
#include "task.h"
#include "timer.h"
#include "usb_charge.h"
#include "usb_pd.h"
#include "util.h"

/* Console output macros */
#define CPUTS(outstr) cputs(CC_USBCHARGE, outstr)
#define CPRINTS(format, args...) cprints(CC_USBCHARGE, format, ##args)

/* I2C address */
#define PI3USB9281_I2C_ADDR_FLAGS 0x25

/* Delay values */
#define PI3USB9281_SW_RESET_DELAY 20

/* Wait after a charger is detected to debounce pin contact order */
#define PI3USB9281_DETECT_DEBOUNCE_MS 1000
#define PI3USB9281_RESET_DEBOUNCE_MS 100
#define PI3USB9281_RESET_STARTUP_DELAY (200 * MSEC)
#define PI3USB9281_RESET_STARTUP_DELAY_INTERVAL_MS 40

/* Store the state of our USB data switches so that they can be restored. */
static int usb_switch_state[CONFIG_USB_PD_PORT_MAX_COUNT];

static int pi3usb9281_reset(int port);
static int pi3usb9281_get_interrupts(int port);

static void select_chip(int port)
{
	struct pi3usb9281_config *chip = &pi3usb9281_chips[port];
	ASSERT(port < CONFIG_BC12_DETECT_PI3USB9281_CHIP_COUNT);

	if (chip->mux_lock) {
		mutex_lock(chip->mux_lock);
		gpio_set_level(chip->mux_gpio, chip->mux_gpio_level);
	}
}

static void unselect_chip(int port)
{
	struct pi3usb9281_config *chip = &pi3usb9281_chips[port];

	if (chip->mux_lock)
		/* Just release the mutex, no need to change the mux gpio */
		mutex_unlock(chip->mux_lock);
}

static uint8_t pi3usb9281_do_read(int port, uint8_t reg, int with_lock)
{
	struct pi3usb9281_config *chip = &pi3usb9281_chips[port];
	int res, val;

	if (with_lock)
		select_chip(port);

	res = i2c_read8(chip->i2c_port, PI3USB9281_I2C_ADDR_FLAGS, reg, &val);

	if (with_lock)
		unselect_chip(port);

	if (res)
		return 0xee;

	return val;
}

static uint8_t pi3usb9281_read_u(int port, uint8_t reg)
{
	return pi3usb9281_do_read(port, reg, 0);
}

static uint8_t pi3usb9281_read(int port, uint8_t reg)
{
	return pi3usb9281_do_read(port, reg, 1);
}

static int pi3usb9281_do_write(int port, uint8_t reg, uint8_t val,
			       int with_lock)
{
	struct pi3usb9281_config *chip = &pi3usb9281_chips[port];
	int res;

	if (with_lock)
		select_chip(port);

	res = i2c_write8(chip->i2c_port, PI3USB9281_I2C_ADDR_FLAGS, reg, val);

	if (with_lock)
		unselect_chip(port);

	if (res)
		CPRINTS("PI3USB9281 I2C write failed");
	return res;
}

static int pi3usb9281_write(int port, uint8_t reg, uint8_t val)
{
	return pi3usb9281_do_write(port, reg, val, 1);
}

/* Write control register, taking care to correctly set reserved bits. */
static int pi3usb9281_do_write_ctrl(int port, uint8_t ctrl, int with_lock)
{
	return pi3usb9281_do_write(port, PI3USB9281_REG_CONTROL,
				   (ctrl & PI3USB9281_CTRL_MASK) |
					   PI3USB9281_CTRL_RSVD_1,
				   with_lock);
}

static int pi3usb9281_write_ctrl(int port, uint8_t ctrl)
{
	return pi3usb9281_do_write_ctrl(port, ctrl, 1);
}

static int pi3usb9281_write_ctrl_u(int port, uint8_t ctrl)
{
	return pi3usb9281_do_write_ctrl(port, ctrl, 0);
}

/*
 * Mask particular interrupts (e.g. attach, detach, ovp, ocp).
 * 1: UnMask (enable). 0: Mask (disable)
 */
static int pi3usb9281_set_interrupt_mask(int port, uint8_t mask)
{
	return pi3usb9281_write(port, PI3USB9281_REG_INT_MASK, ~mask);
}

static void pi3usb9281_init(int port)
{
	uint8_t dev_id;

	dev_id = pi3usb9281_read(port, PI3USB9281_REG_DEV_ID);

	if (dev_id != PI3USB9281_DEV_ID && dev_id != PI3USB9281_DEV_ID_A)
		CPRINTS("PI3USB9281 invalid ID 0x%02x", dev_id);

	pi3usb9281_reset(port);
	pi3usb9281_enable_interrupts(port);
}

int pi3usb9281_enable_interrupts(int port)
{
	uint8_t ctrl;
	pi3usb9281_set_interrupt_mask(port, PI3USB9281_INT_ATTACH_DETACH);
	ctrl = pi3usb9281_read(port, PI3USB9281_REG_CONTROL);
	if (ctrl == 0xee)
		return EC_ERROR_UNKNOWN;

	return pi3usb9281_write_ctrl(port, ctrl & ~PI3USB9281_CTRL_INT_DIS);
}

static int pi3usb9281_disable_interrupts(int port)
{
	uint8_t ctrl = pi3usb9281_read(port, PI3USB9281_REG_CONTROL);
	int rv;

	if (ctrl == 0xee)
		return EC_ERROR_UNKNOWN;

	rv = pi3usb9281_write_ctrl(port, ctrl | PI3USB9281_CTRL_INT_DIS);
	pi3usb9281_get_interrupts(port);
	return rv;
}

static int pi3usb9281_get_interrupts(int port)
{
	return pi3usb9281_read(port, PI3USB9281_REG_INT);
}

int pi3usb9281_get_device_type(int port)
{
	return pi3usb9281_read(port, PI3USB9281_REG_DEV_TYPE) & 0x77;
}

static int pi3usb9281_get_charger_status(int port)
{
	return pi3usb9281_read(port, PI3USB9281_REG_CHG_STATUS) & 0x1f;
}

static int pi3usb9281_get_ilim(int device_type, int charger_status)
{
	/* Limit USB port current. 500mA for not listed types. */
	int current_limit_ma = 500;

	/*
	 * The USB Type-C specification limits the maximum amount of current
	 * from BC 1.2 suppliers to 1.5A.  Technically, proprietary methods are
	 * not allowed, but we will continue to allow those.
	 */
	if (charger_status & PI3USB9281_CHG_CAR_TYPE1 ||
	    charger_status & PI3USB9281_CHG_CAR_TYPE2)
		current_limit_ma = USB_CHARGER_MAX_CURR_MA;
	else if (charger_status & PI3USB9281_CHG_APPLE_1A)
		current_limit_ma = 1000;
	else if (charger_status & PI3USB9281_CHG_APPLE_2A)
		current_limit_ma = USB_CHARGER_MAX_CURR_MA;
	else if (charger_status & PI3USB9281_CHG_APPLE_2_4A)
		current_limit_ma = USB_CHARGER_MAX_CURR_MA;
	else if (device_type & PI3USB9281_TYPE_CDP)
		current_limit_ma = USB_CHARGER_MAX_CURR_MA;
	else if (device_type & PI3USB9281_TYPE_DCP)
		current_limit_ma = 500;

	return current_limit_ma;
}

static int pi3usb9281_reset(int port)
{
	int rv = pi3usb9281_write(port, PI3USB9281_REG_RESET, 0x1);

	if (!rv)
		/* Reset takes ~15ms. Wait for 20ms to be safe. */
		msleep(PI3USB9281_SW_RESET_DELAY);

	return rv;
}

static int pi3usb9281_set_switch_manual(int port, int val)
{
	int res = EC_ERROR_UNKNOWN;
	uint8_t ctrl;

	select_chip(port);
	ctrl = pi3usb9281_read_u(port, PI3USB9281_REG_CONTROL);

	if (ctrl != 0xee) {
		if (val)
			ctrl &= ~PI3USB9281_CTRL_AUTO;
		else
			ctrl |= PI3USB9281_CTRL_AUTO;
		res = pi3usb9281_write_ctrl_u(port, ctrl);
	}

	unselect_chip(port);
	return res;
}

static int pi3usb9281_set_pins(int port, uint8_t val)
{
	return pi3usb9281_write(port, PI3USB9281_REG_MANUAL, val);
}

static int pi3usb9281_set_switches_impl(int port, int open)
{
	int res = EC_ERROR_UNKNOWN;
	uint8_t ctrl;

	select_chip(port);
	ctrl = pi3usb9281_read_u(port, PI3USB9281_REG_CONTROL);

	if (ctrl != 0xee) {
		if (open)
			ctrl &= ~PI3USB9281_CTRL_SWITCH_AUTO;
		else
			ctrl |= PI3USB9281_CTRL_SWITCH_AUTO;
		res = pi3usb9281_write_ctrl_u(port, ctrl);
	}

	unselect_chip(port);
	return res;
}

static void pi3usb9281_set_switches(int port, enum usb_switch setting)
{
	/* If switch is not changing then return */
	if (setting == usb_switch_state[port])
		return;
	if (setting != USB_SWITCH_RESTORE)
		usb_switch_state[port] = setting;
	CPRINTS("USB MUX %d", usb_switch_state[port]);
	usb_charger_task_set_event(port, USB_CHG_EVENT_MUX);
}

static int pc3usb9281_read_interrupt(int port)
{
	timestamp_t timeout;
	timeout.val = get_time().val + PI3USB9281_RESET_STARTUP_DELAY;
	do {
		/* Read (& clear) possible attach & detach interrupt */
		if (pi3usb9281_get_interrupts(port) &
		    PI3USB9281_INT_ATTACH_DETACH)
			return EC_SUCCESS;
		msleep(PI3USB9281_RESET_STARTUP_DELAY_INTERVAL_MS);
	} while (get_time().val < timeout.val);
	return EC_ERROR_TIMEOUT;
}

/*
 * Handle BC 1.2 attach & detach event
 *
 * On attach, it resets pi3usb9281 for debounce. This reset should immediately
 * trigger another attach or detach interrupt. If other (unexpected) event is
 * observed, it forwards the event so that the caller can handle it.
 */
static uint32_t bc12_detect(int port)
{
	int device_type, chg_status;
	uint32_t evt = 0;

	if (usb_charger_port_is_sourcing_vbus(port)) {
		/* If we're sourcing VBUS then we're not charging */
		device_type = PI3USB9281_TYPE_NONE;
		chg_status = PI3USB9281_CHG_NONE;
	} else {
		/* Set device type */
		device_type = pi3usb9281_get_device_type(port);
		chg_status = pi3usb9281_get_charger_status(port);
	}

	/* Debounce pin plug order if we detect a charger */
	if (device_type || PI3USB9281_CHG_STATUS_ANY(chg_status)) {
		/* next operation might trigger a detach interrupt */
		pi3usb9281_disable_interrupts(port);
		/*
		 * Ensure D+/D- are open before resetting
		 * Note: we can't simply call pi3usb9281_set_switches() because
		 * another task might override it and set the switches closed.
		 */
		pi3usb9281_set_switch_manual(port, 1);
		pi3usb9281_set_pins(port, 0);

		/* Delay to debounce pin attach order */
		msleep(PI3USB9281_DETECT_DEBOUNCE_MS);

		/*
		 * Reset PI3USB9281 to refresh detection registers. After reset,
		 * - Interrupt is globally disabled
		 * - All interrupts are unmasked (=enabled)
		 *
		 * WARNING: This reset is acceptable for samus_pd,
		 * but may not be acceptable for devices that have
		 * an OTG / device mode, as we may be interrupting
		 * the connection.
		 */
		pi3usb9281_reset(port);

		/*
		 * Restore data switch settings - switches return to
		 * closed on reset until restored.
		 */
		pi3usb9281_set_switches(port, USB_SWITCH_RESTORE);

		/*
		 * Wait after reset, before re-enabling interrupt, so that
		 * spurious interrupts from this port are ignored.
		 */
		msleep(PI3USB9281_RESET_DEBOUNCE_MS);

		/* Re-enable interrupts */
		pi3usb9281_enable_interrupts(port);

		/*
		 * Consume interrupt (expectedly) triggered by the reset.
		 * If it's other event (e.g. VBUS), return immediately.
		 */
		evt = task_wait_event(PI3USB9281_RESET_DEBOUNCE_MS * MSEC);
		if (evt & USB_CHG_EVENT_BC12)
			evt &= ~USB_CHG_EVENT_BC12;
		else if (evt & USB_CHG_EVENT_INTR)
			evt &= ~USB_CHG_EVENT_INTR;
		else
			return evt;

		/* Debounce is done. Registers should have trustworthy values */
		device_type = PI3USB9281_TYPE_NONE;
		chg_status = PI3USB9281_CHG_NONE;
		if (pc3usb9281_read_interrupt(port) == EC_SUCCESS) {
			device_type = pi3usb9281_get_device_type(port);
			chg_status = pi3usb9281_get_charger_status(port);
		}
	}

	/* Attachment: decode + update available charge */
	if (device_type || PI3USB9281_CHG_STATUS_ANY(chg_status)) {
		struct charge_port_info chg;
		int type;

		if (PI3USB9281_CHG_STATUS_ANY(chg_status))
			type = CHARGE_SUPPLIER_PROPRIETARY;
		else if (device_type & PI3USB9281_TYPE_CDP)
			type = CHARGE_SUPPLIER_BC12_CDP;
		else if (device_type & PI3USB9281_TYPE_DCP)
			type = CHARGE_SUPPLIER_BC12_DCP;
		else if (device_type & PI3USB9281_TYPE_SDP)
			type = CHARGE_SUPPLIER_BC12_SDP;
		else
			type = CHARGE_SUPPLIER_OTHER;

		chg.voltage = USB_CHARGER_VOLTAGE_MV;
		chg.current = pi3usb9281_get_ilim(device_type, chg_status);
		charge_manager_update_charge(type, port, &chg);
	} else {
		/* Detachment: update available charge to 0 */
		usb_charger_reset_charge(port);
	}

	return evt;
}

static void pi3usb9281_usb_charger_task_event(const int port, uint32_t evt)
{
	/* Interrupt from the Pericom chip, determine charger type */
	if (evt & USB_CHG_EVENT_BC12) {
		/* Read interrupt register to clear on chip */
		pi3usb9281_get_interrupts(port);
		evt = bc12_detect(port);
	} else if (evt & USB_CHG_EVENT_INTR) {
		/* USB_CHG_EVENT_INTR & _BC12 are mutually exclusive */
		/* Check the interrupt register, and clear on chip */
		if (pi3usb9281_get_interrupts(port) &
		    PI3USB9281_INT_ATTACH_DETACH)
			evt = bc12_detect(port);
	}

	if (evt & USB_CHG_EVENT_MUX)
		pi3usb9281_set_switches_impl(port, usb_switch_state[port]);

	/*
	 * Re-enable interrupts on pericom charger detector since the chip may
	 * periodically reset itself, and come back up with registers in
	 * default state. TODO(crosbug.com/p/33823): Fix these unwanted resets.
	 */
	if (evt & USB_CHG_EVENT_VBUS) {
		pi3usb9281_enable_interrupts(port);
		if (!IS_ENABLED(CONFIG_USB_PD_VBUS_DETECT_TCPC))
			CPRINTS("VBUS p%d %d", port,
				pd_snk_is_vbus_provided(port));
	}
}

static void pi3usb9281_usb_charger_task_init(const int port)
{
	uint32_t evt;

	/* Initialize chip and enable interrupts */
	pi3usb9281_init(port);

	/* Set the initial state */
	evt = bc12_detect(port);
	pi3usb9281_usb_charger_task_event(port, evt);
}

#if defined(CONFIG_CHARGE_RAMP_SW) || defined(CONFIG_CHARGE_RAMP_HW)
static int pi3usb9281_ramp_allowed(int supplier)
{
	return supplier == CHARGE_SUPPLIER_BC12_DCP ||
	       supplier == CHARGE_SUPPLIER_BC12_SDP ||
	       supplier == CHARGE_SUPPLIER_BC12_CDP ||
	       supplier == CHARGE_SUPPLIER_PROPRIETARY;
}

static int pi3usb9281_ramp_max(int supplier, int sup_curr)
{
	switch (supplier) {
	case CHARGE_SUPPLIER_BC12_DCP:
		return USB_CHARGER_MAX_CURR_MA;
	case CHARGE_SUPPLIER_BC12_SDP:
		return 500;
	case CHARGE_SUPPLIER_BC12_CDP:
	case CHARGE_SUPPLIER_PROPRIETARY:
		return sup_curr;
	default:
		return 500;
	}
}
#endif /* CONFIG_CHARGE_RAMP_SW || CONFIG_CHARGE_RAMP_HW */

const struct bc12_drv pi3usb9281_drv = {
	.usb_charger_task_init = pi3usb9281_usb_charger_task_init,
	.usb_charger_task_event = pi3usb9281_usb_charger_task_event,
	.set_switches = pi3usb9281_set_switches,
#if defined(CONFIG_CHARGE_RAMP_SW) || defined(CONFIG_CHARGE_RAMP_HW)
	.ramp_allowed = pi3usb9281_ramp_allowed,
	.ramp_max = pi3usb9281_ramp_max,
#endif /* CONFIG_CHARGE_RAMP_SW || CONFIG_CHARGE_RAMP_HW */
};

#ifdef CONFIG_BC12_SINGLE_DRIVER
/* provide a default bc12_ports[] for backward compatibility */
struct bc12_config bc12_ports[CHARGE_PORT_COUNT] = {
	[0 ... (CHARGE_PORT_COUNT - 1)] = {
		.drv = &pi3usb9281_drv,
	},
};
#endif /* CONFIG_BC12_SINGLE_DRIVER */