zephyr/drivers/usb/bc12/bc12_pi3usb9201.c

623 lines
17 KiB
C

/*
* Copyright (c) 2022 Google LLC
*
* SPDX-License-Identifier: Apache-2.0
*/
/* PI3USB9201 USB BC 1.2 Charger Detector driver. */
#define DT_DRV_COMPAT diodes_pi3usb9201
#include <zephyr/device.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/drivers/usb/usb_bc12.h>
#include <zephyr/logging/log.h>
#include "bc12_pi3usb9201.h"
LOG_MODULE_REGISTER(PI3USB9201, CONFIG_USB_BC12_LOG_LEVEL);
/* Constant configuration data */
struct pi3usb9201_config {
struct i2c_dt_spec i2c;
struct gpio_dt_spec intb_gpio;
enum bc12_type charging_mode;
};
/* Run-time configuration data */
struct pi3usb9201_data {
const struct device *dev;
struct k_work work;
struct bc12_partner_state partner_state;
struct gpio_callback gpio_cb;
bc12_callback_t result_cb;
void *result_cb_data;
};
enum pi3usb9201_client_sts {
CHG_OTHER = 0,
CHG_2_4A = 1,
CHG_2_0A = 2,
CHG_1_0A = 3,
CHG_RESERVED = 4,
CHG_CDP = 5,
CHG_SDP = 6,
CHG_DCP = 7,
};
struct bc12_status {
enum bc12_type partner_type;
int current_limit;
};
/*
* 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.
*/
static const struct bc12_status bc12_chg_limits[] = {
/* For unknown chargers return Isusp. */
[CHG_OTHER] = {BC12_TYPE_PROPRIETARY, BC12_CURR_UA(BC12_CHARGER_MIN_CURR_UA)},
[CHG_2_4A] = {BC12_TYPE_PROPRIETARY, BC12_CURR_UA(2400000)},
[CHG_2_0A] = {BC12_TYPE_PROPRIETARY, BC12_CURR_UA(2000000)},
[CHG_1_0A] = {BC12_TYPE_PROPRIETARY, BC12_CURR_UA(1000000)},
[CHG_RESERVED] = {BC12_TYPE_NONE, 0},
[CHG_CDP] = {BC12_TYPE_CDP, BC12_CURR_UA(1500000)},
/* BC1.2 driver contract specifies to return Isusp for SDP ports. */
[CHG_SDP] = {BC12_TYPE_SDP, BC12_CURR_UA(BC12_CHARGER_MIN_CURR_UA)},
[CHG_DCP] = {BC12_TYPE_DCP, BC12_CURR_UA(1500000)},
};
static const enum pi3usb9201_mode charging_mode_to_host_mode[] = {
[BC12_TYPE_NONE] = PI3USB9201_POWER_DOWN,
[BC12_TYPE_SDP] = PI3USB9201_SDP_HOST_MODE,
[BC12_TYPE_DCP] = PI3USB9201_DCP_HOST_MODE,
[BC12_TYPE_CDP] = PI3USB9201_CDP_HOST_MODE,
/* Invalid modes configured to power down the device. */
[BC12_TYPE_PROPRIETARY] = PI3USB9201_POWER_DOWN,
[BC12_TYPE_UNKNOWN] = PI3USB9201_POWER_DOWN,
};
BUILD_ASSERT(ARRAY_SIZE(charging_mode_to_host_mode) == BC12_TYPE_COUNT);
static int pi3usb9201_interrupt_enable(const struct device *dev, const bool enable)
{
const struct pi3usb9201_config *cfg = dev->config;
/* Clear the interrupt mask bit to enable the interrupt */
return i2c_reg_update_byte_dt(&cfg->i2c, PI3USB9201_REG_CTRL_1,
PI3USB9201_REG_CTRL_1_INT_MASK,
enable ? 0 : PI3USB9201_REG_CTRL_1_INT_MASK);
}
static int pi3usb9201_bc12_detect_ctrl(const struct device *dev, const bool enable)
{
const struct pi3usb9201_config *cfg = dev->config;
return i2c_reg_update_byte_dt(&cfg->i2c, PI3USB9201_REG_CTRL_2,
PI3USB9201_REG_CTRL_2_START_DET,
enable ? PI3USB9201_REG_CTRL_2_START_DET : 0);
}
static int pi3usb9201_bc12_usb_switch(const struct device *dev, bool enable)
{
const struct pi3usb9201_config *cfg = dev->config;
/* USB data switch enabled when PI3USB9201_REG_CTRL_2_AUTO_SW is clear */
return i2c_reg_update_byte_dt(&cfg->i2c, PI3USB9201_REG_CTRL_2,
PI3USB9201_REG_CTRL_2_START_DET,
enable ? 0 : PI3USB9201_REG_CTRL_2_AUTO_SW);
}
static int pi3usb9201_set_mode(const struct device *dev, enum pi3usb9201_mode mode)
{
const struct pi3usb9201_config *cfg = dev->config;
return i2c_reg_update_byte_dt(&cfg->i2c, PI3USB9201_REG_CTRL_1,
PI3USB9201_REG_CTRL_1_MODE_MASK
<< PI3USB9201_REG_CTRL_1_MODE_SHIFT,
mode << PI3USB9201_REG_CTRL_1_MODE_SHIFT);
}
static int pi3usb9201_get_mode(const struct device *dev, enum pi3usb9201_mode *const mode)
{
const struct pi3usb9201_config *cfg = dev->config;
int rv;
uint8_t ctrl1;
rv = i2c_reg_read_byte_dt(&cfg->i2c, PI3USB9201_REG_CTRL_1, &ctrl1);
if (rv < 0) {
return rv;
}
ctrl1 >>= PI3USB9201_REG_CTRL_1_MODE_SHIFT;
ctrl1 &= PI3USB9201_REG_CTRL_1_MODE_MASK;
*mode = ctrl1;
return 0;
}
static int pi3usb9201_get_status(const struct device *dev, uint8_t *const client,
uint8_t *const host)
{
const struct pi3usb9201_config *cfg = dev->config;
uint8_t status;
int rv;
rv = i2c_reg_read_byte_dt(&cfg->i2c, PI3USB9201_REG_CLIENT_STS, &status);
if (rv < 0) {
return rv;
}
if (client != NULL) {
*client = status;
}
rv = i2c_reg_read_byte_dt(&cfg->i2c, PI3USB9201_REG_HOST_STS, &status);
if (rv < 0) {
return rv;
}
if (host != NULL) {
*host = status;
}
return 0;
}
static void pi3usb9201_notify_callback(const struct device *dev,
struct bc12_partner_state *const state)
{
struct pi3usb9201_data *pi3usb9201_data = dev->data;
if (pi3usb9201_data->result_cb) {
pi3usb9201_data->result_cb(dev, state, pi3usb9201_data->result_cb_data);
}
}
static bool pi3usb9201_partner_has_changed(const struct device *dev,
struct bc12_partner_state *const state)
{
struct pi3usb9201_data *pi3usb9201_data = dev->data;
/* Always notify when clearing out partner state */
if (!state) {
return true;
}
if (state->bc12_role != pi3usb9201_data->partner_state.bc12_role) {
return true;
}
if (state->bc12_role == BC12_PORTABLE_DEVICE &&
pi3usb9201_data->partner_state.type != state->type) {
return true;
}
if (state->bc12_role == BC12_CHARGING_PORT &&
pi3usb9201_data->partner_state.pd_partner_connected != state->pd_partner_connected) {
return true;
}
return false;
}
/**
* @brief Notify the application about changes to the BC1.2 partner.
*
* @param dev BC1.2 device instance
* @param state New partner state information. Set to NULL to indicate no
* partner is connected.
*/
static void pi3usb9201_update_charging_partner(const struct device *dev,
struct bc12_partner_state *const state)
{
struct pi3usb9201_data *pi3usb9201_data = dev->data;
if (!pi3usb9201_partner_has_changed(dev, state)) {
/* No change to the partner */
return;
}
if (state) {
/* Now update callback with the new partner type. */
pi3usb9201_data->partner_state = *state;
pi3usb9201_notify_callback(dev, state);
} else {
pi3usb9201_data->partner_state.bc12_role = BC12_DISCONNECTED;
pi3usb9201_notify_callback(dev, NULL);
}
}
static int pi3usb9201_client_detect_start(const struct device *dev)
{
int rv;
/*
* Read both status registers to ensure that all interrupt indications
* are cleared prior to starting bc1.2 detection.
*/
pi3usb9201_get_status(dev, NULL, NULL);
/* Put pi3usb9201 into client mode */
rv = pi3usb9201_set_mode(dev, PI3USB9201_CLIENT_MODE);
if (rv < 0) {
return rv;
}
/* Have pi3usb9201 start bc1.2 detection */
rv = pi3usb9201_bc12_detect_ctrl(dev, true);
if (rv < 0) {
return rv;
}
/* Enable interrupt to wake task when detection completes */
return pi3usb9201_interrupt_enable(dev, true);
}
static void pi3usb9201_client_detect_finish(const struct device *dev, const int status)
{
struct bc12_partner_state new_partner_state;
int bit_pos;
bool enable_usb_data;
new_partner_state.bc12_role = BC12_PORTABLE_DEVICE;
/* Set charge voltage to 5V */
new_partner_state.voltage_uv = BC12_CHARGER_VOLTAGE_UV;
/*
* Find set bit position. Note that this function is only called if a
* bit was set in client_status, so bit_pos won't be negative.
*/
bit_pos = __builtin_ffs(status) - 1;
new_partner_state.current_ua = bc12_chg_limits[bit_pos].current_limit;
new_partner_state.type = bc12_chg_limits[bit_pos].partner_type;
LOG_DBG("client status = 0x%x, current = %d mA, type = %d",
status, new_partner_state.current_ua, new_partner_state.type);
/* bc1.2 is complete and start bit does not auto clear */
if (pi3usb9201_bc12_detect_ctrl(dev, false) < 0) {
LOG_ERR("failed to clear client detect");
}
/* If DCP mode, disable USB swtich */
if (status & BIT(CHG_DCP)) {
enable_usb_data = false;
} else {
enable_usb_data = true;
}
if (pi3usb9201_bc12_usb_switch(dev, enable_usb_data) < 0) {
LOG_ERR("failed to set USB data mode");
}
/* Inform charge manager of new supplier type and current limit */
pi3usb9201_update_charging_partner(dev, &new_partner_state);
}
static void pi3usb9201_host_interrupt(const struct device *dev, uint8_t host_status)
{
const struct pi3usb9201_config *pi3usb9201_config = dev->config;
struct bc12_partner_state partner_state;
switch (pi3usb9201_config->charging_mode) {
case BC12_TYPE_NONE:
/*
* For USB-C connections, enable the USB data path
* TODO - Provide a devicetree property indicating
* whether the USB data path is supported.
*/
pi3usb9201_set_mode(dev, PI3USB9201_USB_PATH_ON);
break;
case BC12_TYPE_CDP:
if (IS_ENABLED(CONFIG_USB_BC12_PI3USB9201_CDP_ERRATA)) {
/*
* Switch to SDP after device is plugged in to avoid
* noise (pulse on D-) causing USB disconnect
*/
if (host_status & PI3USB9201_REG_HOST_STS_DEV_PLUG) {
pi3usb9201_set_mode(dev, PI3USB9201_SDP_HOST_MODE);
}
/*
* Switch to CDP after device is unplugged so we
* advertise higher power available for next device.
*/
if (host_status & PI3USB9201_REG_HOST_STS_DEV_UNPLUG) {
pi3usb9201_set_mode(dev, PI3USB9201_CDP_HOST_MODE);
}
}
__fallthrough;
case BC12_TYPE_SDP:
/* Plug/unplug events only valid for CDP and SDP modes */
if (host_status & PI3USB9201_REG_HOST_STS_DEV_PLUG) {
partner_state.bc12_role = BC12_CHARGING_PORT;
partner_state.pd_partner_connected = true;
pi3usb9201_update_charging_partner(dev, &partner_state);
}
if (host_status & PI3USB9201_REG_HOST_STS_DEV_UNPLUG) {
partner_state.bc12_role = BC12_CHARGING_PORT;
partner_state.pd_partner_connected = false;
pi3usb9201_update_charging_partner(dev, &partner_state);
}
break;
default:
break;
}
}
static int pi3usb9201_disconnect(const struct device *dev)
{
int rv;
/* Ensure USB switch auto-on is enabled */
rv = pi3usb9201_bc12_usb_switch(dev, true);
if (rv < 0) {
return rv;
}
/* Put pi3usb9201 into its power down mode */
rv = pi3usb9201_set_mode(dev, PI3USB9201_POWER_DOWN);
if (rv < 0) {
return rv;
}
/* The start bc1.2 bit does not auto clear */
rv = pi3usb9201_bc12_detect_ctrl(dev, false);
if (rv < 0) {
return rv;
}
/* Mask interrupts until next bc1.2 detection event */
rv = pi3usb9201_interrupt_enable(dev, false);
if (rv < 0) {
return rv;
}
/*
* Let the application know there's no more charge available for the
* supplier type that was most recently detected.
*/
pi3usb9201_update_charging_partner(dev, NULL);
return 0;
}
static int pi3usb9201_set_portable_device(const struct device *dev)
{
int rv;
/* Disable interrupts during mode change */
rv = pi3usb9201_interrupt_enable(dev, false);
if (rv < 0) {
return rv;
}
if (pi3usb9201_client_detect_start(dev) < 0) {
struct bc12_partner_state partner_state;
/*
* VBUS is present, but starting bc1.2 detection failed
* for some reason. Set the partner type to unknown limit
* current to the minimum allowed for a suspended USB device.
*/
partner_state.bc12_role = BC12_PORTABLE_DEVICE;
partner_state.voltage_uv = BC12_CHARGER_VOLTAGE_UV;
partner_state.current_ua = BC12_CHARGER_MIN_CURR_UA;
partner_state.type = BC12_TYPE_UNKNOWN;
/* Save supplier type and notify callbacks */
pi3usb9201_update_charging_partner(dev, &partner_state);
LOG_ERR("bc1.2 detection failed, using defaults");
return -EIO;
}
return 0;
}
static int pi3usb9201_set_charging_mode(const struct device *dev)
{
const struct pi3usb9201_config *pi3usb9201_config = dev->config;
struct bc12_partner_state partner_state;
enum pi3usb9201_mode current_mode;
enum pi3usb9201_mode desired_mode;
int rv;
if (pi3usb9201_config->charging_mode == BC12_TYPE_NONE) {
/*
* For USB-C connections, enable the USB data path when configured
* as a downstream facing port but charging is disabled.
*
* TODO - Provide a devicetree property indicating
* whether the USB data path is supported.
*/
return pi3usb9201_set_mode(dev, PI3USB9201_USB_PATH_ON);
}
/*
* When enabling charging mode for this port, clear out information
* regarding any charging partners.
*/
partner_state.bc12_role = BC12_CHARGING_PORT;
partner_state.pd_partner_connected = false;
pi3usb9201_update_charging_partner(dev, &partner_state);
rv = pi3usb9201_interrupt_enable(dev, false);
if (rv < 0) {
return rv;
}
rv = pi3usb9201_get_mode(dev, &current_mode);
if (rv < 0) {
return rv;
}
desired_mode = charging_mode_to_host_mode[pi3usb9201_config->charging_mode];
if (current_mode != desired_mode) {
LOG_DBG("Set host mode to %d", desired_mode);
/*
* Read both status registers to ensure that all
* interrupt indications are cleared prior to starting
* charging port (host) mode.
*/
rv = pi3usb9201_get_status(dev, NULL, NULL);
if (rv < 0) {
return rv;
}
rv = pi3usb9201_set_mode(dev, desired_mode);
if (rv < 0) {
return rv;
}
}
rv = pi3usb9201_interrupt_enable(dev, true);
if (rv < 0) {
return rv;
}
return 0;
}
static void pi3usb9201_isr_work(struct k_work *item)
{
struct pi3usb9201_data *pi3usb9201_data = CONTAINER_OF(item, struct pi3usb9201_data, work);
const struct device *dev = pi3usb9201_data->dev;
uint8_t client;
uint8_t host;
int rv;
rv = pi3usb9201_get_status(dev, &client, &host);
if (rv < 0) {
LOG_ERR("Failed to get host/client status");
return;
}
if (client != 0) {
/*
* Any bit set in client status register indicates that
* BC1.2 detection has completed.
*/
pi3usb9201_client_detect_finish(dev, client);
}
if (host != 0) {
pi3usb9201_host_interrupt(dev, host);
}
}
static void pi3usb9201_gpio_callback(const struct device *dev, struct gpio_callback *cb,
uint32_t pins)
{
struct pi3usb9201_data *pi3usb9201_data = CONTAINER_OF(cb, struct pi3usb9201_data, gpio_cb);
k_work_submit(&pi3usb9201_data->work);
}
static int pi3usb9201_set_role(const struct device *dev, const enum bc12_role role)
{
switch (role) {
case BC12_DISCONNECTED:
return pi3usb9201_disconnect(dev);
case BC12_PORTABLE_DEVICE:
return pi3usb9201_set_portable_device(dev);
case BC12_CHARGING_PORT:
return pi3usb9201_set_charging_mode(dev);
default:
LOG_ERR("unsupported BC12 role: %d", role);
return -EINVAL;
}
return 0;
}
int pi3usb9201_set_result_cb(const struct device *dev, bc12_callback_t cb, void *const user_data)
{
struct pi3usb9201_data *pi3usb9201_data = dev->data;
pi3usb9201_data->result_cb = cb;
pi3usb9201_data->result_cb_data = user_data;
return 0;
}
static const struct bc12_driver_api pi3usb9201_driver_api = {
.set_role = pi3usb9201_set_role,
.set_result_cb = pi3usb9201_set_result_cb,
};
static int pi3usb9201_init(const struct device *dev)
{
const struct pi3usb9201_config *cfg = dev->config;
struct pi3usb9201_data *pi3usb9201_data = dev->data;
int rv;
if (!i2c_is_ready_dt(&cfg->i2c)) {
LOG_ERR("Bus device is not ready.");
return -ENODEV;
}
if (!gpio_is_ready_dt(&cfg->intb_gpio)) {
LOG_ERR("intb_gpio device is not ready.");
return -ENODEV;
}
pi3usb9201_data->dev = dev;
/*
* Set most recent bc1.2 detection type result to
* BC12_DISCONNECTED for the port.
*/
pi3usb9201_data->partner_state.bc12_role = BC12_DISCONNECTED;
rv = gpio_pin_configure_dt(&cfg->intb_gpio, GPIO_INPUT);
if (rv < 0) {
LOG_DBG("Failed to set gpio callback.");
return rv;
}
gpio_init_callback(&pi3usb9201_data->gpio_cb, pi3usb9201_gpio_callback,
BIT(cfg->intb_gpio.pin));
k_work_init(&pi3usb9201_data->work, pi3usb9201_isr_work);
rv = gpio_add_callback(cfg->intb_gpio.port, &pi3usb9201_data->gpio_cb);
if (rv < 0) {
LOG_DBG("Failed to set gpio callback.");
return rv;
}
rv = gpio_pin_interrupt_configure_dt(&cfg->intb_gpio, GPIO_INT_EDGE_FALLING);
if (rv < 0) {
LOG_DBG("Failed to configure gpio interrupt.");
return rv;
}
/*
* The is no specific initialization required for the pi3usb9201 other
* than disabling the interrupt.
*/
return pi3usb9201_interrupt_enable(dev, false);
}
#define PI2USB9201_DEFINE(inst) \
static struct pi3usb9201_data pi3usb9201_data_##inst; \
\
static const struct pi3usb9201_config pi3usb9201_config_##inst = { \
.i2c = I2C_DT_SPEC_INST_GET(inst), \
.intb_gpio = GPIO_DT_SPEC_INST_GET(inst, intb_gpios), \
.charging_mode = DT_INST_STRING_UPPER_TOKEN(inst, charging_mode), \
}; \
\
DEVICE_DT_INST_DEFINE(inst, pi3usb9201_init, NULL, &pi3usb9201_data_##inst, \
&pi3usb9201_config_##inst, POST_KERNEL, \
CONFIG_APPLICATION_INIT_PRIORITY, &pi3usb9201_driver_api);
DT_INST_FOREACH_STATUS_OKAY(PI2USB9201_DEFINE)