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_drp_toggling(struct tcpc_dev *tcpc,
104 enum typec_cc_status cc)
107 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
108 unsigned int reg = TCPC_ROLE_CTRL_DRP;
110 /* Handle vendor drp toggling */
111 if (tcpci->data->start_drp_toggling) {
112 ret = tcpci->data->start_drp_toggling(tcpci, tcpci->data, cc);
119 case TYPEC_CC_RP_DEF:
120 reg |= (TCPC_ROLE_CTRL_RP_VAL_DEF <<
121 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
123 case TYPEC_CC_RP_1_5:
124 reg |= (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
125 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
127 case TYPEC_CC_RP_3_0:
128 reg |= (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
129 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
133 if (cc == TYPEC_CC_RD)
134 reg |= (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT) |
135 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT);
137 reg |= (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
138 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT);
139 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
142 return regmap_write(tcpci->regmap, TCPC_COMMAND,
143 TCPC_CMD_LOOK4CONNECTION);
146 static enum typec_cc_status tcpci_to_typec_cc(unsigned int cc, bool sink)
150 return sink ? TYPEC_CC_RP_DEF : TYPEC_CC_RA;
152 return sink ? TYPEC_CC_RP_1_5 : TYPEC_CC_RD;
155 return TYPEC_CC_RP_3_0;
159 return TYPEC_CC_OPEN;
163 static int tcpci_get_cc(struct tcpc_dev *tcpc,
164 enum typec_cc_status *cc1, enum typec_cc_status *cc2)
166 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
170 ret = regmap_read(tcpci->regmap, TCPC_CC_STATUS, ®);
174 *cc1 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC1_SHIFT) &
175 TCPC_CC_STATUS_CC1_MASK,
176 reg & TCPC_CC_STATUS_TERM);
177 *cc2 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC2_SHIFT) &
178 TCPC_CC_STATUS_CC2_MASK,
179 reg & TCPC_CC_STATUS_TERM);
184 static int tcpci_set_polarity(struct tcpc_dev *tcpc,
185 enum typec_cc_polarity polarity)
187 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
191 /* Keep the disconnect cc line open */
192 ret = regmap_read(tcpci->regmap, TCPC_ROLE_CTRL, ®);
196 if (polarity == TYPEC_POLARITY_CC2)
197 reg |= TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC1_SHIFT;
199 reg |= TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC2_SHIFT;
200 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
204 return regmap_write(tcpci->regmap, TCPC_TCPC_CTRL,
205 (polarity == TYPEC_POLARITY_CC2) ?
206 TCPC_TCPC_CTRL_ORIENTATION : 0);
209 static int tcpci_set_vconn(struct tcpc_dev *tcpc, bool enable)
211 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
214 /* Handle vendor set vconn */
215 if (tcpci->data->set_vconn) {
216 ret = tcpci->data->set_vconn(tcpci, tcpci->data, enable);
221 return regmap_update_bits(tcpci->regmap, TCPC_POWER_CTRL,
222 TCPC_POWER_CTRL_VCONN_ENABLE,
223 enable ? TCPC_POWER_CTRL_VCONN_ENABLE : 0);
226 static int tcpci_set_roles(struct tcpc_dev *tcpc, bool attached,
227 enum typec_role role, enum typec_data_role data)
229 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
233 reg = PD_REV20 << TCPC_MSG_HDR_INFO_REV_SHIFT;
234 if (role == TYPEC_SOURCE)
235 reg |= TCPC_MSG_HDR_INFO_PWR_ROLE;
236 if (data == TYPEC_HOST)
237 reg |= TCPC_MSG_HDR_INFO_DATA_ROLE;
238 ret = regmap_write(tcpci->regmap, TCPC_MSG_HDR_INFO, reg);
245 static int tcpci_set_pd_rx(struct tcpc_dev *tcpc, bool enable)
247 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
248 unsigned int reg = 0;
252 reg = TCPC_RX_DETECT_SOP | TCPC_RX_DETECT_HARD_RESET;
253 ret = regmap_write(tcpci->regmap, TCPC_RX_DETECT, reg);
260 static int tcpci_get_vbus(struct tcpc_dev *tcpc)
262 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
266 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
270 return !!(reg & TCPC_POWER_STATUS_VBUS_PRES);
273 static int tcpci_set_vbus(struct tcpc_dev *tcpc, bool source, bool sink)
275 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
278 /* Disable both source and sink first before enabling anything */
281 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
282 TCPC_CMD_DISABLE_SRC_VBUS);
288 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
289 TCPC_CMD_DISABLE_SINK_VBUS);
295 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
296 TCPC_CMD_SRC_VBUS_DEFAULT);
302 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
311 static int tcpci_pd_transmit(struct tcpc_dev *tcpc,
312 enum tcpm_transmit_type type,
313 const struct pd_message *msg)
315 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
316 u16 header = msg ? le16_to_cpu(msg->header) : 0;
317 unsigned int reg, cnt;
320 cnt = msg ? pd_header_cnt(header) * 4 : 0;
321 ret = regmap_write(tcpci->regmap, TCPC_TX_BYTE_CNT, cnt + 2);
325 ret = tcpci_write16(tcpci, TCPC_TX_HDR, header);
330 ret = regmap_raw_write(tcpci->regmap, TCPC_TX_DATA,
336 reg = (PD_RETRY_COUNT << TCPC_TRANSMIT_RETRY_SHIFT) |
337 (type << TCPC_TRANSMIT_TYPE_SHIFT);
338 ret = regmap_write(tcpci->regmap, TCPC_TRANSMIT, reg);
345 static int tcpci_init(struct tcpc_dev *tcpc)
347 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
348 unsigned long timeout = jiffies + msecs_to_jiffies(2000); /* XXX */
352 while (time_before_eq(jiffies, timeout)) {
353 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
356 if (!(reg & TCPC_POWER_STATUS_UNINIT))
358 usleep_range(10000, 20000);
360 if (time_after(jiffies, timeout))
363 /* Handle vendor init */
364 if (tcpci->data->init) {
365 ret = tcpci->data->init(tcpci, tcpci->data);
370 /* Clear all events */
371 ret = tcpci_write16(tcpci, TCPC_ALERT, 0xffff);
375 if (tcpci->controls_vbus)
376 reg = TCPC_POWER_STATUS_VBUS_PRES;
379 ret = regmap_write(tcpci->regmap, TCPC_POWER_STATUS_MASK, reg);
383 /* Enable Vbus detection */
384 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
385 TCPC_CMD_ENABLE_VBUS_DETECT);
389 reg = TCPC_ALERT_TX_SUCCESS | TCPC_ALERT_TX_FAILED |
390 TCPC_ALERT_TX_DISCARDED | TCPC_ALERT_RX_STATUS |
391 TCPC_ALERT_RX_HARD_RST | TCPC_ALERT_CC_STATUS;
392 if (tcpci->controls_vbus)
393 reg |= TCPC_ALERT_POWER_STATUS;
394 return tcpci_write16(tcpci, TCPC_ALERT_MASK, reg);
397 irqreturn_t tcpci_irq(struct tcpci *tcpci)
401 tcpci_read16(tcpci, TCPC_ALERT, &status);
404 * Clear alert status for everything except RX_STATUS, which shouldn't
405 * be cleared until we have successfully retrieved message.
407 if (status & ~TCPC_ALERT_RX_STATUS)
408 tcpci_write16(tcpci, TCPC_ALERT,
409 status & ~TCPC_ALERT_RX_STATUS);
411 if (status & TCPC_ALERT_CC_STATUS)
412 tcpm_cc_change(tcpci->port);
414 if (status & TCPC_ALERT_POWER_STATUS) {
417 regmap_read(tcpci->regmap, TCPC_POWER_STATUS_MASK, ®);
420 * If power status mask has been reset, then the TCPC
424 tcpm_tcpc_reset(tcpci->port);
426 tcpm_vbus_change(tcpci->port);
429 if (status & TCPC_ALERT_RX_STATUS) {
430 struct pd_message msg;
434 regmap_read(tcpci->regmap, TCPC_RX_BYTE_CNT, &cnt);
436 tcpci_read16(tcpci, TCPC_RX_HDR, &header);
437 msg.header = cpu_to_le16(header);
439 if (WARN_ON(cnt > sizeof(msg.payload)))
440 cnt = sizeof(msg.payload);
443 regmap_raw_read(tcpci->regmap, TCPC_RX_DATA,
446 /* Read complete, clear RX status alert bit */
447 tcpci_write16(tcpci, TCPC_ALERT, TCPC_ALERT_RX_STATUS);
449 tcpm_pd_receive(tcpci->port, &msg);
452 if (status & TCPC_ALERT_RX_HARD_RST)
453 tcpm_pd_hard_reset(tcpci->port);
455 if (status & TCPC_ALERT_TX_SUCCESS)
456 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_SUCCESS);
457 else if (status & TCPC_ALERT_TX_DISCARDED)
458 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_DISCARDED);
459 else if (status & TCPC_ALERT_TX_FAILED)
460 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_FAILED);
464 EXPORT_SYMBOL_GPL(tcpci_irq);
466 static irqreturn_t _tcpci_irq(int irq, void *dev_id)
468 struct tcpci_chip *chip = dev_id;
470 return tcpci_irq(chip->tcpci);
473 static const struct regmap_config tcpci_regmap_config = {
477 .max_register = 0x7F, /* 0x80 .. 0xFF are vendor defined */
480 static int tcpci_parse_config(struct tcpci *tcpci)
482 tcpci->controls_vbus = true; /* XXX */
484 tcpci->tcpc.fwnode = device_get_named_child_node(tcpci->dev,
486 if (!tcpci->tcpc.fwnode) {
487 dev_err(tcpci->dev, "Can't find connector node.\n");
494 struct tcpci *tcpci_register_port(struct device *dev, struct tcpci_data *data)
499 tcpci = devm_kzalloc(dev, sizeof(*tcpci), GFP_KERNEL);
501 return ERR_PTR(-ENOMEM);
505 tcpci->regmap = data->regmap;
507 tcpci->tcpc.init = tcpci_init;
508 tcpci->tcpc.get_vbus = tcpci_get_vbus;
509 tcpci->tcpc.set_vbus = tcpci_set_vbus;
510 tcpci->tcpc.set_cc = tcpci_set_cc;
511 tcpci->tcpc.get_cc = tcpci_get_cc;
512 tcpci->tcpc.set_polarity = tcpci_set_polarity;
513 tcpci->tcpc.set_vconn = tcpci_set_vconn;
514 tcpci->tcpc.start_drp_toggling = tcpci_start_drp_toggling;
516 tcpci->tcpc.set_pd_rx = tcpci_set_pd_rx;
517 tcpci->tcpc.set_roles = tcpci_set_roles;
518 tcpci->tcpc.pd_transmit = tcpci_pd_transmit;
520 err = tcpci_parse_config(tcpci);
524 tcpci->port = tcpm_register_port(tcpci->dev, &tcpci->tcpc);
525 if (IS_ERR(tcpci->port))
526 return ERR_CAST(tcpci->port);
530 EXPORT_SYMBOL_GPL(tcpci_register_port);
532 void tcpci_unregister_port(struct tcpci *tcpci)
534 tcpm_unregister_port(tcpci->port);
536 EXPORT_SYMBOL_GPL(tcpci_unregister_port);
538 static int tcpci_probe(struct i2c_client *client,
539 const struct i2c_device_id *i2c_id)
541 struct tcpci_chip *chip;
545 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
549 chip->data.regmap = devm_regmap_init_i2c(client, &tcpci_regmap_config);
550 if (IS_ERR(chip->data.regmap))
551 return PTR_ERR(chip->data.regmap);
553 i2c_set_clientdata(client, chip);
555 /* Disable chip interrupts before requesting irq */
556 err = regmap_raw_write(chip->data.regmap, TCPC_ALERT_MASK, &val,
561 chip->tcpci = tcpci_register_port(&client->dev, &chip->data);
562 if (IS_ERR(chip->tcpci))
563 return PTR_ERR(chip->tcpci);
565 err = devm_request_threaded_irq(&client->dev, client->irq, NULL,
567 IRQF_ONESHOT | IRQF_TRIGGER_LOW,
568 dev_name(&client->dev), chip);
570 tcpci_unregister_port(chip->tcpci);
577 static int tcpci_remove(struct i2c_client *client)
579 struct tcpci_chip *chip = i2c_get_clientdata(client);
581 tcpci_unregister_port(chip->tcpci);
586 static const struct i2c_device_id tcpci_id[] = {
590 MODULE_DEVICE_TABLE(i2c, tcpci_id);
593 static const struct of_device_id tcpci_of_match[] = {
594 { .compatible = "nxp,ptn5110", },
597 MODULE_DEVICE_TABLE(of, tcpci_of_match);
600 static struct i2c_driver tcpci_i2c_driver = {
603 .of_match_table = of_match_ptr(tcpci_of_match),
605 .probe = tcpci_probe,
606 .remove = tcpci_remove,
607 .id_table = tcpci_id,
609 module_i2c_driver(tcpci_i2c_driver);
611 MODULE_DESCRIPTION("USB Type-C Port Controller Interface driver");
612 MODULE_LICENSE("GPL");