// SPDX-License-Identifier: GPL-2.0 /* * Driver for TI TPS6598x USB Power Delivery controller family * * Copyright (C) 2017, Intel Corporation * Author: Heikki Krogerus */ #include #include #include #include #include #include #include #include #include #include #include #include #include "tps6598x.h" #include "trace.h" /* Register offsets */ #define TPS_REG_VID 0x00 #define TPS_REG_MODE 0x03 #define TPS_REG_CMD1 0x08 #define TPS_REG_DATA1 0x09 #define TPS_REG_INT_EVENT1 0x14 #define TPS_REG_INT_EVENT2 0x15 #define TPS_REG_INT_MASK1 0x16 #define TPS_REG_INT_MASK2 0x17 #define TPS_REG_INT_CLEAR1 0x18 #define TPS_REG_INT_CLEAR2 0x19 #define TPS_REG_SYSTEM_POWER_STATE 0x20 #define TPS_REG_STATUS 0x1a #define TPS_REG_SYSTEM_CONF 0x28 #define TPS_REG_CTRL_CONF 0x29 #define TPS_REG_BOOT_STATUS 0x2D #define TPS_REG_POWER_STATUS 0x3f #define TPS_REG_PD_STATUS 0x40 #define TPS_REG_RX_IDENTITY_SOP 0x48 #define TPS_REG_DATA_STATUS 0x5f #define TPS_REG_SLEEP_CONF 0x70 /* TPS_REG_SYSTEM_CONF bits */ #define TPS_SYSCONF_PORTINFO(c) ((c) & 7) /* * BPMs task timeout, recommended 5 seconds * pg.48 TPS2575 Host Interface Technical Reference * Manual (Rev. A) * https://www.ti.com/lit/ug/slvuc05a/slvuc05a.pdf */ #define TPS_BUNDLE_TIMEOUT 0x32 /* BPMs return code */ #define TPS_TASK_BPMS_INVALID_BUNDLE_SIZE 0x4 #define TPS_TASK_BPMS_INVALID_SLAVE_ADDR 0x5 #define TPS_TASK_BPMS_INVALID_TIMEOUT 0x6 /* PBMc data out */ #define TPS_PBMC_RC 0 /* Return code */ #define TPS_PBMC_DPCS 2 /* device patch complete status */ enum { TPS_PORTINFO_SINK, TPS_PORTINFO_SINK_ACCESSORY, TPS_PORTINFO_DRP_UFP, TPS_PORTINFO_DRP_UFP_DRD, TPS_PORTINFO_DRP_DFP, TPS_PORTINFO_DRP_DFP_DRD, TPS_PORTINFO_SOURCE, }; /* TPS_REG_RX_IDENTITY_SOP */ struct tps6598x_rx_identity_reg { u8 status; struct usb_pd_identity identity; } __packed; /* Standard Task return codes */ #define TPS_TASK_TIMEOUT 1 #define TPS_TASK_REJECTED 3 enum { TPS_MODE_APP, TPS_MODE_BOOT, TPS_MODE_BIST, TPS_MODE_DISC, TPS_MODE_PTCH, }; static const char *const modes[] = { [TPS_MODE_APP] = "APP ", [TPS_MODE_BOOT] = "BOOT", [TPS_MODE_BIST] = "BIST", [TPS_MODE_DISC] = "DISC", [TPS_MODE_PTCH] = "PTCH", }; /* Unrecognized commands will be replaced with "!CMD" */ #define INVALID_CMD(_cmd_) (_cmd_ == 0x444d4321) struct tps6598x; struct tipd_data { irq_handler_t irq_handler; int (*register_port)(struct tps6598x *tps, struct fwnode_handle *node); void (*trace_power_status)(u16 status); void (*trace_status)(u32 status); int (*apply_patch)(struct tps6598x *tps); }; struct tps6598x { struct device *dev; struct regmap *regmap; struct mutex lock; /* device lock */ u8 i2c_protocol:1; struct typec_port *port; struct typec_partner *partner; struct usb_pd_identity partner_identity; struct usb_role_switch *role_sw; struct typec_capability typec_cap; struct power_supply *psy; struct power_supply_desc psy_desc; enum power_supply_usb_type usb_type; int wakeup; u32 status; /* status reg */ u16 pwr_status; struct delayed_work wq_poll; const struct tipd_data *data; }; static enum power_supply_property tps6598x_psy_props[] = { POWER_SUPPLY_PROP_USB_TYPE, POWER_SUPPLY_PROP_ONLINE, }; static enum power_supply_usb_type tps6598x_psy_usb_types[] = { POWER_SUPPLY_USB_TYPE_C, POWER_SUPPLY_USB_TYPE_PD, }; static const char *tps6598x_psy_name_prefix = "tps6598x-source-psy-"; /* * Max data bytes for Data1, Data2, and other registers. See ch 1.3.2: * https://www.ti.com/lit/ug/slvuan1a/slvuan1a.pdf */ #define TPS_MAX_LEN 64 static int tps6598x_block_read(struct tps6598x *tps, u8 reg, void *val, size_t len) { u8 data[TPS_MAX_LEN + 1]; int ret; if (len + 1 > sizeof(data)) return -EINVAL; if (!tps->i2c_protocol) return regmap_raw_read(tps->regmap, reg, val, len); ret = regmap_raw_read(tps->regmap, reg, data, len + 1); if (ret) return ret; if (data[0] < len) return -EIO; memcpy(val, &data[1], len); return 0; } static int tps6598x_block_write(struct tps6598x *tps, u8 reg, const void *val, size_t len) { u8 data[TPS_MAX_LEN + 1]; if (len + 1 > sizeof(data)) return -EINVAL; if (!tps->i2c_protocol) return regmap_raw_write(tps->regmap, reg, val, len); data[0] = len; memcpy(&data[1], val, len); return regmap_raw_write(tps->regmap, reg, data, len + 1); } static inline int tps6598x_read8(struct tps6598x *tps, u8 reg, u8 *val) { return tps6598x_block_read(tps, reg, val, sizeof(u8)); } static inline int tps6598x_read16(struct tps6598x *tps, u8 reg, u16 *val) { return tps6598x_block_read(tps, reg, val, sizeof(u16)); } static inline int tps6598x_read32(struct tps6598x *tps, u8 reg, u32 *val) { return tps6598x_block_read(tps, reg, val, sizeof(u32)); } static inline int tps6598x_read64(struct tps6598x *tps, u8 reg, u64 *val) { return tps6598x_block_read(tps, reg, val, sizeof(u64)); } static inline int tps6598x_write8(struct tps6598x *tps, u8 reg, u8 val) { return tps6598x_block_write(tps, reg, &val, sizeof(u8)); } static inline int tps6598x_write64(struct tps6598x *tps, u8 reg, u64 val) { return tps6598x_block_write(tps, reg, &val, sizeof(u64)); } static inline int tps6598x_write_4cc(struct tps6598x *tps, u8 reg, const char *val) { return tps6598x_block_write(tps, reg, val, 4); } static int tps6598x_read_partner_identity(struct tps6598x *tps) { struct tps6598x_rx_identity_reg id; int ret; ret = tps6598x_block_read(tps, TPS_REG_RX_IDENTITY_SOP, &id, sizeof(id)); if (ret) return ret; tps->partner_identity = id.identity; return 0; } static void tps6598x_set_data_role(struct tps6598x *tps, enum typec_data_role role, bool connected) { enum usb_role role_val; if (role == TYPEC_HOST) role_val = USB_ROLE_HOST; else role_val = USB_ROLE_DEVICE; if (!connected) role_val = USB_ROLE_NONE; usb_role_switch_set_role(tps->role_sw, role_val); typec_set_data_role(tps->port, role); } static int tps6598x_connect(struct tps6598x *tps, u32 status) { struct typec_partner_desc desc; enum typec_pwr_opmode mode; int ret; if (tps->partner) return 0; mode = TPS_POWER_STATUS_PWROPMODE(tps->pwr_status); desc.usb_pd = mode == TYPEC_PWR_MODE_PD; desc.accessory = TYPEC_ACCESSORY_NONE; /* XXX: handle accessories */ desc.identity = NULL; if (desc.usb_pd) { ret = tps6598x_read_partner_identity(tps); if (ret) return ret; desc.identity = &tps->partner_identity; } typec_set_pwr_opmode(tps->port, mode); typec_set_pwr_role(tps->port, TPS_STATUS_TO_TYPEC_PORTROLE(status)); typec_set_vconn_role(tps->port, TPS_STATUS_TO_TYPEC_VCONN(status)); if (TPS_STATUS_TO_UPSIDE_DOWN(status)) typec_set_orientation(tps->port, TYPEC_ORIENTATION_REVERSE); else typec_set_orientation(tps->port, TYPEC_ORIENTATION_NORMAL); typec_set_mode(tps->port, TYPEC_STATE_USB); tps6598x_set_data_role(tps, TPS_STATUS_TO_TYPEC_DATAROLE(status), true); tps->partner = typec_register_partner(tps->port, &desc); if (IS_ERR(tps->partner)) return PTR_ERR(tps->partner); if (desc.identity) typec_partner_set_identity(tps->partner); power_supply_changed(tps->psy); return 0; } static void tps6598x_disconnect(struct tps6598x *tps, u32 status) { if (!IS_ERR(tps->partner)) typec_unregister_partner(tps->partner); tps->partner = NULL; typec_set_pwr_opmode(tps->port, TYPEC_PWR_MODE_USB); typec_set_pwr_role(tps->port, TPS_STATUS_TO_TYPEC_PORTROLE(status)); typec_set_vconn_role(tps->port, TPS_STATUS_TO_TYPEC_VCONN(status)); typec_set_orientation(tps->port, TYPEC_ORIENTATION_NONE); typec_set_mode(tps->port, TYPEC_STATE_SAFE); tps6598x_set_data_role(tps, TPS_STATUS_TO_TYPEC_DATAROLE(status), false); power_supply_changed(tps->psy); } static int tps6598x_exec_cmd_tmo(struct tps6598x *tps, const char *cmd, size_t in_len, u8 *in_data, size_t out_len, u8 *out_data, u32 cmd_timeout_ms, u32 res_delay_ms) { unsigned long timeout; u32 val; int ret; ret = tps6598x_read32(tps, TPS_REG_CMD1, &val); if (ret) return ret; if (val && !INVALID_CMD(val)) return -EBUSY; if (in_len) { ret = tps6598x_block_write(tps, TPS_REG_DATA1, in_data, in_len); if (ret) return ret; } ret = tps6598x_write_4cc(tps, TPS_REG_CMD1, cmd); if (ret < 0) return ret; timeout = jiffies + msecs_to_jiffies(cmd_timeout_ms); do { ret = tps6598x_read32(tps, TPS_REG_CMD1, &val); if (ret) return ret; if (INVALID_CMD(val)) return -EINVAL; if (time_is_before_jiffies(timeout)) return -ETIMEDOUT; } while (val); /* some commands require delay for the result to be available */ mdelay(res_delay_ms); if (out_len) { ret = tps6598x_block_read(tps, TPS_REG_DATA1, out_data, out_len); if (ret) return ret; val = out_data[0]; } else { ret = tps6598x_block_read(tps, TPS_REG_DATA1, &val, sizeof(u8)); if (ret) return ret; } switch (val) { case TPS_TASK_TIMEOUT: return -ETIMEDOUT; case TPS_TASK_REJECTED: return -EPERM; default: break; } return 0; } static int tps6598x_exec_cmd(struct tps6598x *tps, const char *cmd, size_t in_len, u8 *in_data, size_t out_len, u8 *out_data) { return tps6598x_exec_cmd_tmo(tps, cmd, in_len, in_data, out_len, out_data, 1000, 0); } static int tps6598x_dr_set(struct typec_port *port, enum typec_data_role role) { const char *cmd = (role == TYPEC_DEVICE) ? "SWUF" : "SWDF"; struct tps6598x *tps = typec_get_drvdata(port); u32 status; int ret; mutex_lock(&tps->lock); ret = tps6598x_exec_cmd(tps, cmd, 0, NULL, 0, NULL); if (ret) goto out_unlock; ret = tps6598x_read32(tps, TPS_REG_STATUS, &status); if (ret) goto out_unlock; if (role != TPS_STATUS_TO_TYPEC_DATAROLE(status)) { ret = -EPROTO; goto out_unlock; } tps6598x_set_data_role(tps, role, true); out_unlock: mutex_unlock(&tps->lock); return ret; } static int tps6598x_pr_set(struct typec_port *port, enum typec_role role) { const char *cmd = (role == TYPEC_SINK) ? "SWSk" : "SWSr"; struct tps6598x *tps = typec_get_drvdata(port); u32 status; int ret; mutex_lock(&tps->lock); ret = tps6598x_exec_cmd(tps, cmd, 0, NULL, 0, NULL); if (ret) goto out_unlock; ret = tps6598x_read32(tps, TPS_REG_STATUS, &status); if (ret) goto out_unlock; if (role != TPS_STATUS_TO_TYPEC_PORTROLE(status)) { ret = -EPROTO; goto out_unlock; } typec_set_pwr_role(tps->port, role); out_unlock: mutex_unlock(&tps->lock); return ret; } static const struct typec_operations tps6598x_ops = { .dr_set = tps6598x_dr_set, .pr_set = tps6598x_pr_set, }; static bool tps6598x_read_status(struct tps6598x *tps, u32 *status) { int ret; ret = tps6598x_read32(tps, TPS_REG_STATUS, status); if (ret) { dev_err(tps->dev, "%s: failed to read status\n", __func__); return false; } if (tps->data->trace_status) tps->data->trace_status(*status); return true; } static bool tps6598x_read_data_status(struct tps6598x *tps) { u32 data_status; int ret; ret = tps6598x_read32(tps, TPS_REG_DATA_STATUS, &data_status); if (ret < 0) { dev_err(tps->dev, "failed to read data status: %d\n", ret); return false; } trace_tps6598x_data_status(data_status); return true; } static bool tps6598x_read_power_status(struct tps6598x *tps) { u16 pwr_status; int ret; ret = tps6598x_read16(tps, TPS_REG_POWER_STATUS, &pwr_status); if (ret < 0) { dev_err(tps->dev, "failed to read power status: %d\n", ret); return false; } tps->pwr_status = pwr_status; if (tps->data->trace_power_status) tps->data->trace_power_status(pwr_status); return true; } static void tps6598x_handle_plug_event(struct tps6598x *tps, u32 status) { int ret; if (status & TPS_STATUS_PLUG_PRESENT) { ret = tps6598x_connect(tps, status); if (ret) dev_err(tps->dev, "failed to register partner\n"); } else { tps6598x_disconnect(tps, status); } } static irqreturn_t cd321x_interrupt(int irq, void *data) { struct tps6598x *tps = data; u64 event = 0; u32 status; int ret; mutex_lock(&tps->lock); ret = tps6598x_read64(tps, TPS_REG_INT_EVENT1, &event); if (ret) { dev_err(tps->dev, "%s: failed to read events\n", __func__); goto err_unlock; } trace_cd321x_irq(event); if (!event) goto err_unlock; if (!tps6598x_read_status(tps, &status)) goto err_clear_ints; if (event & APPLE_CD_REG_INT_POWER_STATUS_UPDATE) if (!tps6598x_read_power_status(tps)) goto err_clear_ints; if (event & APPLE_CD_REG_INT_DATA_STATUS_UPDATE) if (!tps6598x_read_data_status(tps)) goto err_clear_ints; /* Handle plug insert or removal */ if (event & APPLE_CD_REG_INT_PLUG_EVENT) tps6598x_handle_plug_event(tps, status); err_clear_ints: tps6598x_write64(tps, TPS_REG_INT_CLEAR1, event); err_unlock: mutex_unlock(&tps->lock); if (event) return IRQ_HANDLED; return IRQ_NONE; } static bool tps6598x_has_role_changed(struct tps6598x *tps, u32 status) { status ^= tps->status; return status & (TPS_STATUS_PORTROLE | TPS_STATUS_DATAROLE); } static irqreturn_t tps25750_interrupt(int irq, void *data) { struct tps6598x *tps = data; u64 event[2] = { }; u32 status; int ret; mutex_lock(&tps->lock); ret = tps6598x_block_read(tps, TPS_REG_INT_EVENT1, event, 11); if (ret) { dev_err(tps->dev, "%s: failed to read events\n", __func__); goto err_unlock; } trace_tps25750_irq(event[0]); if (!(event[0] | event[1])) goto err_unlock; if (!tps6598x_read_status(tps, &status)) goto err_clear_ints; if ((event[0] | event[1]) & TPS_REG_INT_POWER_STATUS_UPDATE) if (!tps6598x_read_power_status(tps)) goto err_clear_ints; if ((event[0] | event[1]) & TPS_REG_INT_DATA_STATUS_UPDATE) if (!tps6598x_read_data_status(tps)) goto err_clear_ints; /* * data/port roles could be updated independently after * a plug event. Therefore, we need to check * for pr/dr status change to set TypeC dr/pr accordingly. */ if ((event[0] | event[1]) & TPS_REG_INT_PLUG_EVENT || tps6598x_has_role_changed(tps, status)) tps6598x_handle_plug_event(tps, status); tps->status = status; err_clear_ints: tps6598x_block_write(tps, TPS_REG_INT_CLEAR1, event, 11); err_unlock: mutex_unlock(&tps->lock); if (event[0] | event[1]) return IRQ_HANDLED; return IRQ_NONE; } static irqreturn_t tps6598x_interrupt(int irq, void *data) { struct tps6598x *tps = data; u64 event1 = 0; u64 event2 = 0; u32 status; int ret; mutex_lock(&tps->lock); ret = tps6598x_read64(tps, TPS_REG_INT_EVENT1, &event1); ret |= tps6598x_read64(tps, TPS_REG_INT_EVENT2, &event2); if (ret) { dev_err(tps->dev, "%s: failed to read events\n", __func__); goto err_unlock; } trace_tps6598x_irq(event1, event2); if (!(event1 | event2)) goto err_unlock; if (!tps6598x_read_status(tps, &status)) goto err_clear_ints; if ((event1 | event2) & TPS_REG_INT_POWER_STATUS_UPDATE) if (!tps6598x_read_power_status(tps)) goto err_clear_ints; if ((event1 | event2) & TPS_REG_INT_DATA_STATUS_UPDATE) if (!tps6598x_read_data_status(tps)) goto err_clear_ints; /* Handle plug insert or removal */ if ((event1 | event2) & TPS_REG_INT_PLUG_EVENT) tps6598x_handle_plug_event(tps, status); err_clear_ints: tps6598x_write64(tps, TPS_REG_INT_CLEAR1, event1); tps6598x_write64(tps, TPS_REG_INT_CLEAR2, event2); err_unlock: mutex_unlock(&tps->lock); if (event1 | event2) return IRQ_HANDLED; return IRQ_NONE; } /* Time interval for Polling */ #define POLL_INTERVAL 500 /* msecs */ static void tps6598x_poll_work(struct work_struct *work) { struct tps6598x *tps = container_of(to_delayed_work(work), struct tps6598x, wq_poll); tps->data->irq_handler(0, tps); queue_delayed_work(system_power_efficient_wq, &tps->wq_poll, msecs_to_jiffies(POLL_INTERVAL)); } static int tps6598x_check_mode(struct tps6598x *tps) { char mode[5] = { }; int ret; ret = tps6598x_read32(tps, TPS_REG_MODE, (void *)mode); if (ret) return ret; ret = match_string(modes, ARRAY_SIZE(modes), mode); switch (ret) { case TPS_MODE_APP: case TPS_MODE_PTCH: return ret; case TPS_MODE_BOOT: dev_warn(tps->dev, "dead-battery condition\n"); return ret; case TPS_MODE_BIST: case TPS_MODE_DISC: default: dev_err(tps->dev, "controller in unsupported mode \"%s\"\n", mode); break; } return -ENODEV; } static const struct regmap_config tps6598x_regmap_config = { .reg_bits = 8, .val_bits = 8, .max_register = 0x7F, }; static int tps6598x_psy_get_online(struct tps6598x *tps, union power_supply_propval *val) { if (TPS_POWER_STATUS_CONNECTION(tps->pwr_status) && TPS_POWER_STATUS_SOURCESINK(tps->pwr_status)) { val->intval = 1; } else { val->intval = 0; } return 0; } static int tps6598x_psy_get_prop(struct power_supply *psy, enum power_supply_property psp, union power_supply_propval *val) { struct tps6598x *tps = power_supply_get_drvdata(psy); int ret = 0; switch (psp) { case POWER_SUPPLY_PROP_USB_TYPE: if (TPS_POWER_STATUS_PWROPMODE(tps->pwr_status) == TYPEC_PWR_MODE_PD) val->intval = POWER_SUPPLY_USB_TYPE_PD; else val->intval = POWER_SUPPLY_USB_TYPE_C; break; case POWER_SUPPLY_PROP_ONLINE: ret = tps6598x_psy_get_online(tps, val); break; default: ret = -EINVAL; break; } return ret; } static int cd321x_switch_power_state(struct tps6598x *tps, u8 target_state) { u8 state; int ret; ret = tps6598x_read8(tps, TPS_REG_SYSTEM_POWER_STATE, &state); if (ret) return ret; if (state == target_state) return 0; ret = tps6598x_exec_cmd(tps, "SSPS", sizeof(u8), &target_state, 0, NULL); if (ret) return ret; ret = tps6598x_read8(tps, TPS_REG_SYSTEM_POWER_STATE, &state); if (ret) return ret; if (state != target_state) return -EINVAL; return 0; } static int devm_tps6598_psy_register(struct tps6598x *tps) { struct power_supply_config psy_cfg = {}; const char *port_dev_name = dev_name(tps->dev); char *psy_name; psy_cfg.drv_data = tps; psy_cfg.fwnode = dev_fwnode(tps->dev); psy_name = devm_kasprintf(tps->dev, GFP_KERNEL, "%s%s", tps6598x_psy_name_prefix, port_dev_name); if (!psy_name) return -ENOMEM; tps->psy_desc.name = psy_name; tps->psy_desc.type = POWER_SUPPLY_TYPE_USB; tps->psy_desc.usb_types = tps6598x_psy_usb_types; tps->psy_desc.num_usb_types = ARRAY_SIZE(tps6598x_psy_usb_types); tps->psy_desc.properties = tps6598x_psy_props; tps->psy_desc.num_properties = ARRAY_SIZE(tps6598x_psy_props); tps->psy_desc.get_property = tps6598x_psy_get_prop; tps->usb_type = POWER_SUPPLY_USB_TYPE_C; tps->psy = devm_power_supply_register(tps->dev, &tps->psy_desc, &psy_cfg); return PTR_ERR_OR_ZERO(tps->psy); } static int tps6598x_register_port(struct tps6598x *tps, struct fwnode_handle *fwnode) { int ret; u32 conf; struct typec_capability typec_cap = { }; ret = tps6598x_read32(tps, TPS_REG_SYSTEM_CONF, &conf); if (ret) return ret; typec_cap.revision = USB_TYPEC_REV_1_2; typec_cap.pd_revision = 0x200; typec_cap.prefer_role = TYPEC_NO_PREFERRED_ROLE; typec_cap.driver_data = tps; typec_cap.ops = &tps6598x_ops; typec_cap.fwnode = fwnode; switch (TPS_SYSCONF_PORTINFO(conf)) { case TPS_PORTINFO_SINK_ACCESSORY: case TPS_PORTINFO_SINK: typec_cap.type = TYPEC_PORT_SNK; typec_cap.data = TYPEC_PORT_UFP; break; case TPS_PORTINFO_DRP_UFP_DRD: case TPS_PORTINFO_DRP_DFP_DRD: typec_cap.type = TYPEC_PORT_DRP; typec_cap.data = TYPEC_PORT_DRD; break; case TPS_PORTINFO_DRP_UFP: typec_cap.type = TYPEC_PORT_DRP; typec_cap.data = TYPEC_PORT_UFP; break; case TPS_PORTINFO_DRP_DFP: typec_cap.type = TYPEC_PORT_DRP; typec_cap.data = TYPEC_PORT_DFP; break; case TPS_PORTINFO_SOURCE: typec_cap.type = TYPEC_PORT_SRC; typec_cap.data = TYPEC_PORT_DFP; break; default: return -ENODEV; } tps->port = typec_register_port(tps->dev, &typec_cap); if (IS_ERR(tps->port)) return PTR_ERR(tps->port); return 0; } static int tps25750_write_firmware(struct tps6598x *tps, u8 bpms_addr, const u8 *data, size_t len) { struct i2c_client *client = to_i2c_client(tps->dev); int ret; u8 slave_addr; int timeout; slave_addr = client->addr; timeout = client->adapter->timeout; /* * binary configuration size is around ~16Kbytes * which might take some time to finish writing it */ client->adapter->timeout = msecs_to_jiffies(5000); client->addr = bpms_addr; ret = regmap_raw_write(tps->regmap, data[0], &data[1], len - 1); client->addr = slave_addr; client->adapter->timeout = timeout; return ret; } static int tps25750_exec_pbms(struct tps6598x *tps, u8 *in_data, size_t in_len) { int ret; u8 rc; ret = tps6598x_exec_cmd_tmo(tps, "PBMs", in_len, in_data, sizeof(rc), &rc, 4000, 0); if (ret) return ret; switch (rc) { case TPS_TASK_BPMS_INVALID_BUNDLE_SIZE: dev_err(tps->dev, "%s: invalid fw size\n", __func__); return -EINVAL; case TPS_TASK_BPMS_INVALID_SLAVE_ADDR: dev_err(tps->dev, "%s: invalid slave address\n", __func__); return -EINVAL; case TPS_TASK_BPMS_INVALID_TIMEOUT: dev_err(tps->dev, "%s: timed out\n", __func__); return -ETIMEDOUT; default: break; } return 0; } static int tps25750_abort_patch_process(struct tps6598x *tps) { int ret; ret = tps6598x_exec_cmd(tps, "PBMe", 0, NULL, 0, NULL); if (ret) return ret; ret = tps6598x_check_mode(tps); if (ret != TPS_MODE_PTCH) dev_err(tps->dev, "failed to switch to \"PTCH\" mode\n"); return ret; } static int tps25750_start_patch_burst_mode(struct tps6598x *tps) { int ret; const struct firmware *fw; const char *firmware_name; struct { u32 fw_size; u8 addr; u8 timeout; } __packed bpms_data; u32 addr; struct device_node *np = tps->dev->of_node; ret = device_property_read_string(tps->dev, "firmware-name", &firmware_name); if (ret) return ret; ret = request_firmware(&fw, firmware_name, tps->dev); if (ret) { dev_err(tps->dev, "failed to retrieve \"%s\"\n", firmware_name); return ret; } if (fw->size == 0) { ret = -EINVAL; goto release_fw; } ret = of_property_match_string(np, "reg-names", "patch-address"); if (ret < 0) { dev_err(tps->dev, "failed to get patch-address %d\n", ret); return ret; } ret = of_property_read_u32_index(np, "reg", ret, &addr); if (ret) return ret; if (addr == 0 || (addr >= 0x20 && addr <= 0x23)) { dev_err(tps->dev, "wrong patch address %u\n", addr); return -EINVAL; } bpms_data.addr = (u8)addr; bpms_data.fw_size = fw->size; bpms_data.timeout = TPS_BUNDLE_TIMEOUT; ret = tps25750_exec_pbms(tps, (u8 *)&bpms_data, sizeof(bpms_data)); if (ret) goto release_fw; ret = tps25750_write_firmware(tps, bpms_data.addr, fw->data, fw->size); if (ret) { dev_err(tps->dev, "Failed to write patch %s of %zu bytes\n", firmware_name, fw->size); goto release_fw; } /* * A delay of 500us is required after the firmware is written * based on pg.62 in tps6598x Host Interface Technical * Reference Manual * https://www.ti.com/lit/ug/slvuc05a/slvuc05a.pdf */ udelay(500); release_fw: release_firmware(fw); return ret; } static int tps25750_complete_patch_process(struct tps6598x *tps) { int ret; u8 out_data[40]; u8 dummy[2] = { }; /* * Without writing something to DATA_IN, this command would * return an error */ ret = tps6598x_exec_cmd_tmo(tps, "PBMc", sizeof(dummy), dummy, sizeof(out_data), out_data, 2000, 20); if (ret) return ret; if (out_data[TPS_PBMC_RC]) { dev_err(tps->dev, "%s: pbmc failed: %u\n", __func__, out_data[TPS_PBMC_RC]); return -EIO; } if (out_data[TPS_PBMC_DPCS]) { dev_err(tps->dev, "%s: failed device patch complete status: %u\n", __func__, out_data[TPS_PBMC_DPCS]); return -EIO; } return 0; } static int tps25750_apply_patch(struct tps6598x *tps) { int ret; unsigned long timeout; u64 status = 0; ret = tps6598x_block_read(tps, TPS_REG_BOOT_STATUS, &status, 5); if (ret) return ret; /* * Nothing to be done if the configuration * is being loaded from EERPOM */ if (status & TPS_BOOT_STATUS_I2C_EEPROM_PRESENT) goto wait_for_app; ret = tps25750_start_patch_burst_mode(tps); if (ret) { tps25750_abort_patch_process(tps); return ret; } ret = tps25750_complete_patch_process(tps); if (ret) return ret; wait_for_app: timeout = jiffies + msecs_to_jiffies(1000); do { ret = tps6598x_check_mode(tps); if (ret < 0) return ret; if (time_is_before_jiffies(timeout)) return -ETIMEDOUT; } while (ret != TPS_MODE_APP); /* * The dead battery flag may be triggered when the controller * port is connected to a device that can source power and * attempts to power up both the controller and the board it is on. * To restore controller functionality, it is necessary to clear * this flag */ if (status & TPS_BOOT_STATUS_DEAD_BATTERY_FLAG) { ret = tps6598x_exec_cmd(tps, "DBfg", 0, NULL, 0, NULL); if (ret) { dev_err(tps->dev, "failed to clear dead battery %d\n", ret); return ret; } } dev_info(tps->dev, "controller switched to \"APP\" mode\n"); return 0; }; static int tps25750_init(struct tps6598x *tps) { int ret; ret = tps->data->apply_patch(tps); if (ret) return ret; ret = tps6598x_write8(tps, TPS_REG_SLEEP_CONF, TPS_SLEEP_CONF_SLEEP_MODE_ALLOWED); if (ret) dev_warn(tps->dev, "%s: failed to enable sleep mode: %d\n", __func__, ret); return 0; } static int tps25750_register_port(struct tps6598x *tps, struct fwnode_handle *fwnode) { struct typec_capability typec_cap = { }; const char *data_role; u8 pd_status; int ret; ret = tps6598x_read8(tps, TPS_REG_PD_STATUS, &pd_status); if (ret) return ret; ret = fwnode_property_read_string(fwnode, "data-role", &data_role); if (ret) { dev_err(tps->dev, "data-role not found: %d\n", ret); return ret; } ret = typec_find_port_data_role(data_role); if (ret < 0) { dev_err(tps->dev, "unknown data-role: %s\n", data_role); return ret; } typec_cap.data = ret; typec_cap.revision = USB_TYPEC_REV_1_3; typec_cap.pd_revision = 0x300; typec_cap.driver_data = tps; typec_cap.ops = &tps6598x_ops; typec_cap.fwnode = fwnode; typec_cap.prefer_role = TYPEC_NO_PREFERRED_ROLE; switch (TPS_PD_STATUS_PORT_TYPE(pd_status)) { case TPS_PD_STATUS_PORT_TYPE_SINK_SOURCE: case TPS_PD_STATUS_PORT_TYPE_SOURCE_SINK: typec_cap.type = TYPEC_PORT_DRP; break; case TPS_PD_STATUS_PORT_TYPE_SINK: typec_cap.type = TYPEC_PORT_SNK; break; case TPS_PD_STATUS_PORT_TYPE_SOURCE: typec_cap.type = TYPEC_PORT_SRC; break; default: return -ENODEV; } tps->port = typec_register_port(tps->dev, &typec_cap); if (IS_ERR(tps->port)) return PTR_ERR(tps->port); return 0; } static int tps6598x_probe(struct i2c_client *client) { struct device_node *np = client->dev.of_node; struct tps6598x *tps; struct fwnode_handle *fwnode; u32 status; u32 vid; int ret; u64 mask1; bool is_tps25750; tps = devm_kzalloc(&client->dev, sizeof(*tps), GFP_KERNEL); if (!tps) return -ENOMEM; mutex_init(&tps->lock); tps->dev = &client->dev; tps->regmap = devm_regmap_init_i2c(client, &tps6598x_regmap_config); if (IS_ERR(tps->regmap)) return PTR_ERR(tps->regmap); is_tps25750 = device_is_compatible(tps->dev, "ti,tps25750"); if (!is_tps25750) { ret = tps6598x_read32(tps, TPS_REG_VID, &vid); if (ret < 0 || !vid) return -ENODEV; } /* * Checking can the adapter handle SMBus protocol. If it can not, the * driver needs to take care of block reads separately. */ if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) tps->i2c_protocol = true; if (np && of_device_is_compatible(np, "apple,cd321x")) { /* Switch CD321X chips to the correct system power state */ ret = cd321x_switch_power_state(tps, TPS_SYSTEM_POWER_STATE_S0); if (ret) return ret; /* CD321X chips have all interrupts masked initially */ mask1 = APPLE_CD_REG_INT_POWER_STATUS_UPDATE | APPLE_CD_REG_INT_DATA_STATUS_UPDATE | APPLE_CD_REG_INT_PLUG_EVENT; } else { /* Enable power status, data status and plug event interrupts */ mask1 = TPS_REG_INT_POWER_STATUS_UPDATE | TPS_REG_INT_DATA_STATUS_UPDATE | TPS_REG_INT_PLUG_EVENT; } tps->data = device_get_match_data(tps->dev); if (!tps->data) return -EINVAL; /* Make sure the controller has application firmware running */ ret = tps6598x_check_mode(tps); if (ret < 0) return ret; if (is_tps25750 && ret == TPS_MODE_PTCH) { ret = tps25750_init(tps); if (ret) return ret; } ret = tps6598x_write64(tps, TPS_REG_INT_MASK1, mask1); if (ret) goto err_reset_controller; if (!tps6598x_read_status(tps, &status)) { ret = -ENODEV; goto err_clear_mask; } /* * This fwnode has a "compatible" property, but is never populated as a * struct device. Instead we simply parse it to read the properties. * This breaks fw_devlink=on. To maintain backward compatibility * with existing DT files, we work around this by deleting any * fwnode_links to/from this fwnode. */ fwnode = device_get_named_child_node(&client->dev, "connector"); if (fwnode) fw_devlink_purge_absent_suppliers(fwnode); tps->role_sw = fwnode_usb_role_switch_get(fwnode); if (IS_ERR(tps->role_sw)) { ret = PTR_ERR(tps->role_sw); goto err_fwnode_put; } ret = devm_tps6598_psy_register(tps); if (ret) goto err_role_put; ret = tps->data->register_port(tps, fwnode); if (ret) goto err_role_put; if (status & TPS_STATUS_PLUG_PRESENT) { ret = tps6598x_read16(tps, TPS_REG_POWER_STATUS, &tps->pwr_status); if (ret < 0) { dev_err(tps->dev, "failed to read power status: %d\n", ret); goto err_unregister_port; } ret = tps6598x_connect(tps, status); if (ret) dev_err(&client->dev, "failed to register partner\n"); } if (client->irq) { ret = devm_request_threaded_irq(&client->dev, client->irq, NULL, tps->data->irq_handler, IRQF_SHARED | IRQF_ONESHOT, dev_name(&client->dev), tps); } else { dev_warn(tps->dev, "Unable to find the interrupt, switching to polling\n"); INIT_DELAYED_WORK(&tps->wq_poll, tps6598x_poll_work); queue_delayed_work(system_power_efficient_wq, &tps->wq_poll, msecs_to_jiffies(POLL_INTERVAL)); } if (ret) goto err_disconnect; i2c_set_clientdata(client, tps); fwnode_handle_put(fwnode); tps->wakeup = device_property_read_bool(tps->dev, "wakeup-source"); if (tps->wakeup && client->irq) { device_init_wakeup(&client->dev, true); enable_irq_wake(client->irq); } return 0; err_disconnect: tps6598x_disconnect(tps, 0); err_unregister_port: typec_unregister_port(tps->port); err_role_put: usb_role_switch_put(tps->role_sw); err_fwnode_put: fwnode_handle_put(fwnode); err_clear_mask: tps6598x_write64(tps, TPS_REG_INT_MASK1, 0); err_reset_controller: /* Reset PD controller to remove any applied patch */ if (is_tps25750) tps6598x_exec_cmd_tmo(tps, "GAID", 0, NULL, 0, NULL, 2000, 0); return ret; } static void tps6598x_remove(struct i2c_client *client) { struct tps6598x *tps = i2c_get_clientdata(client); if (!client->irq) cancel_delayed_work_sync(&tps->wq_poll); devm_free_irq(tps->dev, client->irq, tps); tps6598x_disconnect(tps, 0); typec_unregister_port(tps->port); usb_role_switch_put(tps->role_sw); /* Reset PD controller to remove any applied patch */ if (device_is_compatible(tps->dev, "ti,tps25750")) tps6598x_exec_cmd_tmo(tps, "GAID", 0, NULL, 0, NULL, 2000, 0); } static int __maybe_unused tps6598x_suspend(struct device *dev) { struct i2c_client *client = to_i2c_client(dev); struct tps6598x *tps = i2c_get_clientdata(client); if (tps->wakeup) { disable_irq(client->irq); enable_irq_wake(client->irq); } if (!client->irq) cancel_delayed_work_sync(&tps->wq_poll); return 0; } static int __maybe_unused tps6598x_resume(struct device *dev) { struct i2c_client *client = to_i2c_client(dev); struct tps6598x *tps = i2c_get_clientdata(client); int ret; ret = tps6598x_check_mode(tps); if (ret < 0) return ret; if (device_is_compatible(tps->dev, "ti,tps25750") && ret == TPS_MODE_PTCH) { ret = tps25750_init(tps); if (ret) return ret; } if (tps->wakeup) { disable_irq_wake(client->irq); enable_irq(client->irq); } if (!client->irq) queue_delayed_work(system_power_efficient_wq, &tps->wq_poll, msecs_to_jiffies(POLL_INTERVAL)); return 0; } static const struct dev_pm_ops tps6598x_pm_ops = { SET_SYSTEM_SLEEP_PM_OPS(tps6598x_suspend, tps6598x_resume) }; static const struct tipd_data cd321x_data = { .irq_handler = cd321x_interrupt, .register_port = tps6598x_register_port, .trace_power_status = trace_tps6598x_power_status, .trace_status = trace_tps6598x_status, }; static const struct tipd_data tps6598x_data = { .irq_handler = tps6598x_interrupt, .register_port = tps6598x_register_port, .trace_power_status = trace_tps6598x_power_status, .trace_status = trace_tps6598x_status, }; static const struct tipd_data tps25750_data = { .irq_handler = tps25750_interrupt, .register_port = tps25750_register_port, .trace_power_status = trace_tps25750_power_status, .trace_status = trace_tps25750_status, .apply_patch = tps25750_apply_patch, }; static const struct of_device_id tps6598x_of_match[] = { { .compatible = "ti,tps6598x", &tps6598x_data}, { .compatible = "apple,cd321x", &cd321x_data}, { .compatible = "ti,tps25750", &tps25750_data}, {} }; MODULE_DEVICE_TABLE(of, tps6598x_of_match); static const struct i2c_device_id tps6598x_id[] = { { "tps6598x" }, { } }; MODULE_DEVICE_TABLE(i2c, tps6598x_id); static struct i2c_driver tps6598x_i2c_driver = { .driver = { .name = "tps6598x", .pm = &tps6598x_pm_ops, .of_match_table = tps6598x_of_match, }, .probe = tps6598x_probe, .remove = tps6598x_remove, .id_table = tps6598x_id, }; module_i2c_driver(tps6598x_i2c_driver); MODULE_AUTHOR("Heikki Krogerus "); MODULE_LICENSE("GPL v2"); MODULE_DESCRIPTION("TI TPS6598x USB Power Delivery Controller Driver");