1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2015-2017 Google, Inc
5 * USB Type-C Port Controller Interface.
8 #include <linux/delay.h>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/i2c.h>
12 #include <linux/interrupt.h>
13 #include <linux/property.h>
14 #include <linux/regmap.h>
15 #include <linux/usb/pd.h>
16 #include <linux/usb/tcpm.h>
17 #include <linux/usb/typec.h>
21 #define PD_RETRY_COUNT 3
26 struct tcpm_port *port;
28 struct regmap *regmap;
33 struct tcpci_data *data;
38 struct tcpci_data data;
41 static inline struct tcpci *tcpc_to_tcpci(struct tcpc_dev *tcpc)
43 return container_of(tcpc, struct tcpci, tcpc);
46 static int tcpci_read16(struct tcpci *tcpci, unsigned int reg, u16 *val)
48 return regmap_raw_read(tcpci->regmap, reg, val, sizeof(u16));
51 static int tcpci_write16(struct tcpci *tcpci, unsigned int reg, u16 val)
53 return regmap_raw_write(tcpci->regmap, reg, &val, sizeof(u16));
56 static int tcpci_set_cc(struct tcpc_dev *tcpc, enum typec_cc_status cc)
58 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
64 reg = (TCPC_ROLE_CTRL_CC_RA << TCPC_ROLE_CTRL_CC1_SHIFT) |
65 (TCPC_ROLE_CTRL_CC_RA << TCPC_ROLE_CTRL_CC2_SHIFT);
68 reg = (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT) |
69 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT);
72 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
73 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
74 (TCPC_ROLE_CTRL_RP_VAL_DEF <<
75 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
78 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
79 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
80 (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
81 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
84 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
85 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
86 (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
87 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
91 reg = (TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC1_SHIFT) |
92 (TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC2_SHIFT);
96 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
103 static int tcpci_start_toggling(struct tcpc_dev *tcpc,
104 enum typec_port_type port_type,
105 enum typec_cc_status cc)
108 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
109 unsigned int reg = TCPC_ROLE_CTRL_DRP;
111 if (port_type != TYPEC_PORT_DRP)
114 /* Handle vendor drp toggling */
115 if (tcpci->data->start_drp_toggling) {
116 ret = tcpci->data->start_drp_toggling(tcpci, tcpci->data, cc);
123 case TYPEC_CC_RP_DEF:
124 reg |= (TCPC_ROLE_CTRL_RP_VAL_DEF <<
125 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
127 case TYPEC_CC_RP_1_5:
128 reg |= (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
129 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
131 case TYPEC_CC_RP_3_0:
132 reg |= (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
133 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
137 if (cc == TYPEC_CC_RD)
138 reg |= (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT) |
139 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT);
141 reg |= (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
142 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT);
143 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
146 return regmap_write(tcpci->regmap, TCPC_COMMAND,
147 TCPC_CMD_LOOK4CONNECTION);
150 static enum typec_cc_status tcpci_to_typec_cc(unsigned int cc, bool sink)
154 return sink ? TYPEC_CC_RP_DEF : TYPEC_CC_RA;
156 return sink ? TYPEC_CC_RP_1_5 : TYPEC_CC_RD;
159 return TYPEC_CC_RP_3_0;
163 return TYPEC_CC_OPEN;
167 static int tcpci_get_cc(struct tcpc_dev *tcpc,
168 enum typec_cc_status *cc1, enum typec_cc_status *cc2)
170 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
174 ret = regmap_read(tcpci->regmap, TCPC_CC_STATUS, ®);
178 *cc1 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC1_SHIFT) &
179 TCPC_CC_STATUS_CC1_MASK,
180 reg & TCPC_CC_STATUS_TERM);
181 *cc2 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC2_SHIFT) &
182 TCPC_CC_STATUS_CC2_MASK,
183 reg & TCPC_CC_STATUS_TERM);
188 static int tcpci_set_polarity(struct tcpc_dev *tcpc,
189 enum typec_cc_polarity polarity)
191 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
195 /* Keep the disconnect cc line open */
196 ret = regmap_read(tcpci->regmap, TCPC_ROLE_CTRL, ®);
200 if (polarity == TYPEC_POLARITY_CC2)
201 reg |= TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC1_SHIFT;
203 reg |= TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC2_SHIFT;
204 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
208 return regmap_write(tcpci->regmap, TCPC_TCPC_CTRL,
209 (polarity == TYPEC_POLARITY_CC2) ?
210 TCPC_TCPC_CTRL_ORIENTATION : 0);
213 static int tcpci_set_vconn(struct tcpc_dev *tcpc, bool enable)
215 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
218 /* Handle vendor set vconn */
219 if (tcpci->data->set_vconn) {
220 ret = tcpci->data->set_vconn(tcpci, tcpci->data, enable);
225 return regmap_update_bits(tcpci->regmap, TCPC_POWER_CTRL,
226 TCPC_POWER_CTRL_VCONN_ENABLE,
227 enable ? TCPC_POWER_CTRL_VCONN_ENABLE : 0);
230 static int tcpci_set_roles(struct tcpc_dev *tcpc, bool attached,
231 enum typec_role role, enum typec_data_role data)
233 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
237 reg = PD_REV20 << TCPC_MSG_HDR_INFO_REV_SHIFT;
238 if (role == TYPEC_SOURCE)
239 reg |= TCPC_MSG_HDR_INFO_PWR_ROLE;
240 if (data == TYPEC_HOST)
241 reg |= TCPC_MSG_HDR_INFO_DATA_ROLE;
242 ret = regmap_write(tcpci->regmap, TCPC_MSG_HDR_INFO, reg);
249 static int tcpci_set_pd_rx(struct tcpc_dev *tcpc, bool enable)
251 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
252 unsigned int reg = 0;
256 reg = TCPC_RX_DETECT_SOP | TCPC_RX_DETECT_HARD_RESET;
257 ret = regmap_write(tcpci->regmap, TCPC_RX_DETECT, reg);
264 static int tcpci_get_vbus(struct tcpc_dev *tcpc)
266 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
270 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
274 return !!(reg & TCPC_POWER_STATUS_VBUS_PRES);
277 static int tcpci_set_vbus(struct tcpc_dev *tcpc, bool source, bool sink)
279 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
282 /* Disable both source and sink first before enabling anything */
285 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
286 TCPC_CMD_DISABLE_SRC_VBUS);
292 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
293 TCPC_CMD_DISABLE_SINK_VBUS);
299 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
300 TCPC_CMD_SRC_VBUS_DEFAULT);
306 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
315 static int tcpci_pd_transmit(struct tcpc_dev *tcpc,
316 enum tcpm_transmit_type type,
317 const struct pd_message *msg)
319 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
320 u16 header = msg ? le16_to_cpu(msg->header) : 0;
321 unsigned int reg, cnt;
324 cnt = msg ? pd_header_cnt(header) * 4 : 0;
325 ret = regmap_write(tcpci->regmap, TCPC_TX_BYTE_CNT, cnt + 2);
329 ret = tcpci_write16(tcpci, TCPC_TX_HDR, header);
334 ret = regmap_raw_write(tcpci->regmap, TCPC_TX_DATA,
340 reg = (PD_RETRY_COUNT << TCPC_TRANSMIT_RETRY_SHIFT) |
341 (type << TCPC_TRANSMIT_TYPE_SHIFT);
342 ret = regmap_write(tcpci->regmap, TCPC_TRANSMIT, reg);
349 static int tcpci_init(struct tcpc_dev *tcpc)
351 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
352 unsigned long timeout = jiffies + msecs_to_jiffies(2000); /* XXX */
356 while (time_before_eq(jiffies, timeout)) {
357 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
360 if (!(reg & TCPC_POWER_STATUS_UNINIT))
362 usleep_range(10000, 20000);
364 if (time_after(jiffies, timeout))
367 /* Handle vendor init */
368 if (tcpci->data->init) {
369 ret = tcpci->data->init(tcpci, tcpci->data);
374 /* Clear all events */
375 ret = tcpci_write16(tcpci, TCPC_ALERT, 0xffff);
379 if (tcpci->controls_vbus)
380 reg = TCPC_POWER_STATUS_VBUS_PRES;
383 ret = regmap_write(tcpci->regmap, TCPC_POWER_STATUS_MASK, reg);
387 /* Enable Vbus detection */
388 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
389 TCPC_CMD_ENABLE_VBUS_DETECT);
393 reg = TCPC_ALERT_TX_SUCCESS | TCPC_ALERT_TX_FAILED |
394 TCPC_ALERT_TX_DISCARDED | TCPC_ALERT_RX_STATUS |
395 TCPC_ALERT_RX_HARD_RST | TCPC_ALERT_CC_STATUS;
396 if (tcpci->controls_vbus)
397 reg |= TCPC_ALERT_POWER_STATUS;
398 return tcpci_write16(tcpci, TCPC_ALERT_MASK, reg);
401 irqreturn_t tcpci_irq(struct tcpci *tcpci)
405 tcpci_read16(tcpci, TCPC_ALERT, &status);
408 * Clear alert status for everything except RX_STATUS, which shouldn't
409 * be cleared until we have successfully retrieved message.
411 if (status & ~TCPC_ALERT_RX_STATUS)
412 tcpci_write16(tcpci, TCPC_ALERT,
413 status & ~TCPC_ALERT_RX_STATUS);
415 if (status & TCPC_ALERT_CC_STATUS)
416 tcpm_cc_change(tcpci->port);
418 if (status & TCPC_ALERT_POWER_STATUS) {
421 regmap_read(tcpci->regmap, TCPC_POWER_STATUS_MASK, ®);
424 * If power status mask has been reset, then the TCPC
428 tcpm_tcpc_reset(tcpci->port);
430 tcpm_vbus_change(tcpci->port);
433 if (status & TCPC_ALERT_RX_STATUS) {
434 struct pd_message msg;
438 regmap_read(tcpci->regmap, TCPC_RX_BYTE_CNT, &cnt);
440 tcpci_read16(tcpci, TCPC_RX_HDR, &header);
441 msg.header = cpu_to_le16(header);
443 if (WARN_ON(cnt > sizeof(msg.payload)))
444 cnt = sizeof(msg.payload);
447 regmap_raw_read(tcpci->regmap, TCPC_RX_DATA,
450 /* Read complete, clear RX status alert bit */
451 tcpci_write16(tcpci, TCPC_ALERT, TCPC_ALERT_RX_STATUS);
453 tcpm_pd_receive(tcpci->port, &msg);
456 if (status & TCPC_ALERT_RX_HARD_RST)
457 tcpm_pd_hard_reset(tcpci->port);
459 if (status & TCPC_ALERT_TX_SUCCESS)
460 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_SUCCESS);
461 else if (status & TCPC_ALERT_TX_DISCARDED)
462 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_DISCARDED);
463 else if (status & TCPC_ALERT_TX_FAILED)
464 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_FAILED);
468 EXPORT_SYMBOL_GPL(tcpci_irq);
470 static irqreturn_t _tcpci_irq(int irq, void *dev_id)
472 struct tcpci_chip *chip = dev_id;
474 return tcpci_irq(chip->tcpci);
477 static const struct regmap_config tcpci_regmap_config = {
481 .max_register = 0x7F, /* 0x80 .. 0xFF are vendor defined */
484 static int tcpci_parse_config(struct tcpci *tcpci)
486 tcpci->controls_vbus = true; /* XXX */
488 tcpci->tcpc.fwnode = device_get_named_child_node(tcpci->dev,
490 if (!tcpci->tcpc.fwnode) {
491 dev_err(tcpci->dev, "Can't find connector node.\n");
498 struct tcpci *tcpci_register_port(struct device *dev, struct tcpci_data *data)
503 tcpci = devm_kzalloc(dev, sizeof(*tcpci), GFP_KERNEL);
505 return ERR_PTR(-ENOMEM);
509 tcpci->regmap = data->regmap;
511 tcpci->tcpc.init = tcpci_init;
512 tcpci->tcpc.get_vbus = tcpci_get_vbus;
513 tcpci->tcpc.set_vbus = tcpci_set_vbus;
514 tcpci->tcpc.set_cc = tcpci_set_cc;
515 tcpci->tcpc.get_cc = tcpci_get_cc;
516 tcpci->tcpc.set_polarity = tcpci_set_polarity;
517 tcpci->tcpc.set_vconn = tcpci_set_vconn;
518 tcpci->tcpc.start_toggling = tcpci_start_toggling;
520 tcpci->tcpc.set_pd_rx = tcpci_set_pd_rx;
521 tcpci->tcpc.set_roles = tcpci_set_roles;
522 tcpci->tcpc.pd_transmit = tcpci_pd_transmit;
524 err = tcpci_parse_config(tcpci);
528 tcpci->port = tcpm_register_port(tcpci->dev, &tcpci->tcpc);
529 if (IS_ERR(tcpci->port))
530 return ERR_CAST(tcpci->port);
534 EXPORT_SYMBOL_GPL(tcpci_register_port);
536 void tcpci_unregister_port(struct tcpci *tcpci)
538 tcpm_unregister_port(tcpci->port);
540 EXPORT_SYMBOL_GPL(tcpci_unregister_port);
542 static int tcpci_probe(struct i2c_client *client,
543 const struct i2c_device_id *i2c_id)
545 struct tcpci_chip *chip;
549 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
553 chip->data.regmap = devm_regmap_init_i2c(client, &tcpci_regmap_config);
554 if (IS_ERR(chip->data.regmap))
555 return PTR_ERR(chip->data.regmap);
557 i2c_set_clientdata(client, chip);
559 /* Disable chip interrupts before requesting irq */
560 err = regmap_raw_write(chip->data.regmap, TCPC_ALERT_MASK, &val,
565 chip->tcpci = tcpci_register_port(&client->dev, &chip->data);
566 if (IS_ERR(chip->tcpci))
567 return PTR_ERR(chip->tcpci);
569 err = devm_request_threaded_irq(&client->dev, client->irq, NULL,
571 IRQF_ONESHOT | IRQF_TRIGGER_LOW,
572 dev_name(&client->dev), chip);
574 tcpci_unregister_port(chip->tcpci);
581 static int tcpci_remove(struct i2c_client *client)
583 struct tcpci_chip *chip = i2c_get_clientdata(client);
585 tcpci_unregister_port(chip->tcpci);
590 static const struct i2c_device_id tcpci_id[] = {
594 MODULE_DEVICE_TABLE(i2c, tcpci_id);
597 static const struct of_device_id tcpci_of_match[] = {
598 { .compatible = "nxp,ptn5110", },
601 MODULE_DEVICE_TABLE(of, tcpci_of_match);
604 static struct i2c_driver tcpci_i2c_driver = {
607 .of_match_table = of_match_ptr(tcpci_of_match),
609 .probe = tcpci_probe,
610 .remove = tcpci_remove,
611 .id_table = tcpci_id,
613 module_i2c_driver(tcpci_i2c_driver);
615 MODULE_DESCRIPTION("USB Type-C Port Controller Interface driver");
616 MODULE_LICENSE("GPL");