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
23 #define tcpc_presenting_cc1_rd(reg) \
24 (!(TCPC_ROLE_CTRL_DRP & (reg)) && \
25 (((reg) & (TCPC_ROLE_CTRL_CC1_MASK << TCPC_ROLE_CTRL_CC1_SHIFT)) == \
26 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT)))
27 #define tcpc_presenting_cc2_rd(reg) \
28 (!(TCPC_ROLE_CTRL_DRP & (reg)) && \
29 (((reg) & (TCPC_ROLE_CTRL_CC2_MASK << TCPC_ROLE_CTRL_CC2_SHIFT)) == \
30 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT)))
35 struct tcpm_port *port;
37 struct regmap *regmap;
42 struct tcpci_data *data;
47 struct tcpci_data data;
50 static inline struct tcpci *tcpc_to_tcpci(struct tcpc_dev *tcpc)
52 return container_of(tcpc, struct tcpci, tcpc);
55 static int tcpci_read16(struct tcpci *tcpci, unsigned int reg, u16 *val)
57 return regmap_raw_read(tcpci->regmap, reg, val, sizeof(u16));
60 static int tcpci_write16(struct tcpci *tcpci, unsigned int reg, u16 val)
62 return regmap_raw_write(tcpci->regmap, reg, &val, sizeof(u16));
65 static int tcpci_set_cc(struct tcpc_dev *tcpc, enum typec_cc_status cc)
67 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
73 reg = (TCPC_ROLE_CTRL_CC_RA << TCPC_ROLE_CTRL_CC1_SHIFT) |
74 (TCPC_ROLE_CTRL_CC_RA << TCPC_ROLE_CTRL_CC2_SHIFT);
77 reg = (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT) |
78 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT);
81 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
82 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
83 (TCPC_ROLE_CTRL_RP_VAL_DEF <<
84 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
87 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
88 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
89 (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
90 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
93 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
94 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
95 (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
96 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
100 reg = (TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC1_SHIFT) |
101 (TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC2_SHIFT);
105 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
112 static int tcpci_start_toggling(struct tcpc_dev *tcpc,
113 enum typec_port_type port_type,
114 enum typec_cc_status cc)
117 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
118 unsigned int reg = TCPC_ROLE_CTRL_DRP;
120 if (port_type != TYPEC_PORT_DRP)
123 /* Handle vendor drp toggling */
124 if (tcpci->data->start_drp_toggling) {
125 ret = tcpci->data->start_drp_toggling(tcpci, tcpci->data, cc);
132 case TYPEC_CC_RP_DEF:
133 reg |= (TCPC_ROLE_CTRL_RP_VAL_DEF <<
134 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
136 case TYPEC_CC_RP_1_5:
137 reg |= (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
138 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
140 case TYPEC_CC_RP_3_0:
141 reg |= (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
142 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
146 if (cc == TYPEC_CC_RD)
147 reg |= (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT) |
148 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT);
150 reg |= (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
151 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT);
152 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
155 return regmap_write(tcpci->regmap, TCPC_COMMAND,
156 TCPC_CMD_LOOK4CONNECTION);
159 static enum typec_cc_status tcpci_to_typec_cc(unsigned int cc, bool sink)
163 return sink ? TYPEC_CC_RP_DEF : TYPEC_CC_RA;
165 return sink ? TYPEC_CC_RP_1_5 : TYPEC_CC_RD;
168 return TYPEC_CC_RP_3_0;
172 return TYPEC_CC_OPEN;
176 static int tcpci_get_cc(struct tcpc_dev *tcpc,
177 enum typec_cc_status *cc1, enum typec_cc_status *cc2)
179 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
180 unsigned int reg, role_control;
183 ret = regmap_read(tcpci->regmap, TCPC_ROLE_CTRL, &role_control);
187 ret = regmap_read(tcpci->regmap, TCPC_CC_STATUS, ®);
191 *cc1 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC1_SHIFT) &
192 TCPC_CC_STATUS_CC1_MASK,
193 reg & TCPC_CC_STATUS_TERM ||
194 tcpc_presenting_cc1_rd(role_control));
195 *cc2 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC2_SHIFT) &
196 TCPC_CC_STATUS_CC2_MASK,
197 reg & TCPC_CC_STATUS_TERM ||
198 tcpc_presenting_cc2_rd(role_control));
203 static int tcpci_set_polarity(struct tcpc_dev *tcpc,
204 enum typec_cc_polarity polarity)
206 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
210 /* Keep the disconnect cc line open */
211 ret = regmap_read(tcpci->regmap, TCPC_ROLE_CTRL, ®);
215 if (polarity == TYPEC_POLARITY_CC2)
216 reg |= TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC1_SHIFT;
218 reg |= TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC2_SHIFT;
219 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
223 return regmap_write(tcpci->regmap, TCPC_TCPC_CTRL,
224 (polarity == TYPEC_POLARITY_CC2) ?
225 TCPC_TCPC_CTRL_ORIENTATION : 0);
228 static int tcpci_set_vconn(struct tcpc_dev *tcpc, bool enable)
230 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
233 /* Handle vendor set vconn */
234 if (tcpci->data->set_vconn) {
235 ret = tcpci->data->set_vconn(tcpci, tcpci->data, enable);
240 return regmap_update_bits(tcpci->regmap, TCPC_POWER_CTRL,
241 TCPC_POWER_CTRL_VCONN_ENABLE,
242 enable ? TCPC_POWER_CTRL_VCONN_ENABLE : 0);
245 static int tcpci_set_roles(struct tcpc_dev *tcpc, bool attached,
246 enum typec_role role, enum typec_data_role data)
248 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
252 reg = PD_REV20 << TCPC_MSG_HDR_INFO_REV_SHIFT;
253 if (role == TYPEC_SOURCE)
254 reg |= TCPC_MSG_HDR_INFO_PWR_ROLE;
255 if (data == TYPEC_HOST)
256 reg |= TCPC_MSG_HDR_INFO_DATA_ROLE;
257 ret = regmap_write(tcpci->regmap, TCPC_MSG_HDR_INFO, reg);
264 static int tcpci_set_pd_rx(struct tcpc_dev *tcpc, bool enable)
266 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
267 unsigned int reg = 0;
271 reg = TCPC_RX_DETECT_SOP | TCPC_RX_DETECT_HARD_RESET;
272 ret = regmap_write(tcpci->regmap, TCPC_RX_DETECT, reg);
279 static int tcpci_get_vbus(struct tcpc_dev *tcpc)
281 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
285 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
289 return !!(reg & TCPC_POWER_STATUS_VBUS_PRES);
292 static int tcpci_set_vbus(struct tcpc_dev *tcpc, bool source, bool sink)
294 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
297 /* Disable both source and sink first before enabling anything */
300 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
301 TCPC_CMD_DISABLE_SRC_VBUS);
307 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
308 TCPC_CMD_DISABLE_SINK_VBUS);
314 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
315 TCPC_CMD_SRC_VBUS_DEFAULT);
321 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
330 static int tcpci_pd_transmit(struct tcpc_dev *tcpc,
331 enum tcpm_transmit_type type,
332 const struct pd_message *msg)
334 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
335 u16 header = msg ? le16_to_cpu(msg->header) : 0;
336 unsigned int reg, cnt;
339 cnt = msg ? pd_header_cnt(header) * 4 : 0;
340 ret = regmap_write(tcpci->regmap, TCPC_TX_BYTE_CNT, cnt + 2);
344 ret = tcpci_write16(tcpci, TCPC_TX_HDR, header);
349 ret = regmap_raw_write(tcpci->regmap, TCPC_TX_DATA,
355 reg = (PD_RETRY_COUNT << TCPC_TRANSMIT_RETRY_SHIFT) |
356 (type << TCPC_TRANSMIT_TYPE_SHIFT);
357 ret = regmap_write(tcpci->regmap, TCPC_TRANSMIT, reg);
364 static int tcpci_init(struct tcpc_dev *tcpc)
366 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
367 unsigned long timeout = jiffies + msecs_to_jiffies(2000); /* XXX */
371 while (time_before_eq(jiffies, timeout)) {
372 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
375 if (!(reg & TCPC_POWER_STATUS_UNINIT))
377 usleep_range(10000, 20000);
379 if (time_after(jiffies, timeout))
382 /* Handle vendor init */
383 if (tcpci->data->init) {
384 ret = tcpci->data->init(tcpci, tcpci->data);
389 /* Clear all events */
390 ret = tcpci_write16(tcpci, TCPC_ALERT, 0xffff);
394 if (tcpci->controls_vbus)
395 reg = TCPC_POWER_STATUS_VBUS_PRES;
398 ret = regmap_write(tcpci->regmap, TCPC_POWER_STATUS_MASK, reg);
402 /* Enable Vbus detection */
403 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
404 TCPC_CMD_ENABLE_VBUS_DETECT);
408 reg = TCPC_ALERT_TX_SUCCESS | TCPC_ALERT_TX_FAILED |
409 TCPC_ALERT_TX_DISCARDED | TCPC_ALERT_RX_STATUS |
410 TCPC_ALERT_RX_HARD_RST | TCPC_ALERT_CC_STATUS;
411 if (tcpci->controls_vbus)
412 reg |= TCPC_ALERT_POWER_STATUS;
413 return tcpci_write16(tcpci, TCPC_ALERT_MASK, reg);
416 irqreturn_t tcpci_irq(struct tcpci *tcpci)
420 tcpci_read16(tcpci, TCPC_ALERT, &status);
423 * Clear alert status for everything except RX_STATUS, which shouldn't
424 * be cleared until we have successfully retrieved message.
426 if (status & ~TCPC_ALERT_RX_STATUS)
427 tcpci_write16(tcpci, TCPC_ALERT,
428 status & ~TCPC_ALERT_RX_STATUS);
430 if (status & TCPC_ALERT_CC_STATUS)
431 tcpm_cc_change(tcpci->port);
433 if (status & TCPC_ALERT_POWER_STATUS) {
436 regmap_read(tcpci->regmap, TCPC_POWER_STATUS_MASK, ®);
439 * If power status mask has been reset, then the TCPC
443 tcpm_tcpc_reset(tcpci->port);
445 tcpm_vbus_change(tcpci->port);
448 if (status & TCPC_ALERT_RX_STATUS) {
449 struct pd_message msg;
453 regmap_read(tcpci->regmap, TCPC_RX_BYTE_CNT, &cnt);
455 tcpci_read16(tcpci, TCPC_RX_HDR, &header);
456 msg.header = cpu_to_le16(header);
458 if (WARN_ON(cnt > sizeof(msg.payload)))
459 cnt = sizeof(msg.payload);
462 regmap_raw_read(tcpci->regmap, TCPC_RX_DATA,
465 /* Read complete, clear RX status alert bit */
466 tcpci_write16(tcpci, TCPC_ALERT, TCPC_ALERT_RX_STATUS);
468 tcpm_pd_receive(tcpci->port, &msg);
471 if (status & TCPC_ALERT_RX_HARD_RST)
472 tcpm_pd_hard_reset(tcpci->port);
474 if (status & TCPC_ALERT_TX_SUCCESS)
475 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_SUCCESS);
476 else if (status & TCPC_ALERT_TX_DISCARDED)
477 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_DISCARDED);
478 else if (status & TCPC_ALERT_TX_FAILED)
479 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_FAILED);
483 EXPORT_SYMBOL_GPL(tcpci_irq);
485 static irqreturn_t _tcpci_irq(int irq, void *dev_id)
487 struct tcpci_chip *chip = dev_id;
489 return tcpci_irq(chip->tcpci);
492 static const struct regmap_config tcpci_regmap_config = {
496 .max_register = 0x7F, /* 0x80 .. 0xFF are vendor defined */
499 static int tcpci_parse_config(struct tcpci *tcpci)
501 tcpci->controls_vbus = true; /* XXX */
503 tcpci->tcpc.fwnode = device_get_named_child_node(tcpci->dev,
505 if (!tcpci->tcpc.fwnode) {
506 dev_err(tcpci->dev, "Can't find connector node.\n");
513 struct tcpci *tcpci_register_port(struct device *dev, struct tcpci_data *data)
518 tcpci = devm_kzalloc(dev, sizeof(*tcpci), GFP_KERNEL);
520 return ERR_PTR(-ENOMEM);
524 tcpci->regmap = data->regmap;
526 tcpci->tcpc.init = tcpci_init;
527 tcpci->tcpc.get_vbus = tcpci_get_vbus;
528 tcpci->tcpc.set_vbus = tcpci_set_vbus;
529 tcpci->tcpc.set_cc = tcpci_set_cc;
530 tcpci->tcpc.get_cc = tcpci_get_cc;
531 tcpci->tcpc.set_polarity = tcpci_set_polarity;
532 tcpci->tcpc.set_vconn = tcpci_set_vconn;
533 tcpci->tcpc.start_toggling = tcpci_start_toggling;
535 tcpci->tcpc.set_pd_rx = tcpci_set_pd_rx;
536 tcpci->tcpc.set_roles = tcpci_set_roles;
537 tcpci->tcpc.pd_transmit = tcpci_pd_transmit;
539 err = tcpci_parse_config(tcpci);
543 tcpci->port = tcpm_register_port(tcpci->dev, &tcpci->tcpc);
544 if (IS_ERR(tcpci->port))
545 return ERR_CAST(tcpci->port);
549 EXPORT_SYMBOL_GPL(tcpci_register_port);
551 void tcpci_unregister_port(struct tcpci *tcpci)
553 tcpm_unregister_port(tcpci->port);
555 EXPORT_SYMBOL_GPL(tcpci_unregister_port);
557 static int tcpci_probe(struct i2c_client *client,
558 const struct i2c_device_id *i2c_id)
560 struct tcpci_chip *chip;
564 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
568 chip->data.regmap = devm_regmap_init_i2c(client, &tcpci_regmap_config);
569 if (IS_ERR(chip->data.regmap))
570 return PTR_ERR(chip->data.regmap);
572 i2c_set_clientdata(client, chip);
574 /* Disable chip interrupts before requesting irq */
575 err = regmap_raw_write(chip->data.regmap, TCPC_ALERT_MASK, &val,
580 chip->tcpci = tcpci_register_port(&client->dev, &chip->data);
581 if (IS_ERR(chip->tcpci))
582 return PTR_ERR(chip->tcpci);
584 err = devm_request_threaded_irq(&client->dev, client->irq, NULL,
586 IRQF_ONESHOT | IRQF_TRIGGER_LOW,
587 dev_name(&client->dev), chip);
589 tcpci_unregister_port(chip->tcpci);
596 static int tcpci_remove(struct i2c_client *client)
598 struct tcpci_chip *chip = i2c_get_clientdata(client);
601 /* Disable chip interrupts before unregistering port */
602 err = tcpci_write16(chip->tcpci, TCPC_ALERT_MASK, 0);
604 dev_warn(&client->dev, "Failed to disable irqs (%pe)\n", ERR_PTR(err));
606 tcpci_unregister_port(chip->tcpci);
611 static const struct i2c_device_id tcpci_id[] = {
615 MODULE_DEVICE_TABLE(i2c, tcpci_id);
618 static const struct of_device_id tcpci_of_match[] = {
619 { .compatible = "nxp,ptn5110", },
622 MODULE_DEVICE_TABLE(of, tcpci_of_match);
625 static struct i2c_driver tcpci_i2c_driver = {
628 .of_match_table = of_match_ptr(tcpci_of_match),
630 .probe = tcpci_probe,
631 .remove = tcpci_remove,
632 .id_table = tcpci_id,
634 module_i2c_driver(tcpci_i2c_driver);
636 MODULE_DESCRIPTION("USB Type-C Port Controller Interface driver");
637 MODULE_LICENSE("GPL");