2 * Copyright 2015-2017 Google, Inc
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * USB Type-C Port Controller Interface.
17 #include <linux/delay.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/i2c.h>
21 #include <linux/interrupt.h>
22 #include <linux/regmap.h>
23 #include <linux/usb/typec.h>
29 #define PD_RETRY_COUNT 3
31 #define tcpc_presenting_cc1_rd(reg) \
32 (!(TCPC_ROLE_CTRL_DRP & (reg)) && \
33 (((reg) & (TCPC_ROLE_CTRL_CC1_MASK << TCPC_ROLE_CTRL_CC1_SHIFT)) == \
34 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT)))
35 #define tcpc_presenting_cc2_rd(reg) \
36 (!(TCPC_ROLE_CTRL_DRP & (reg)) && \
37 (((reg) & (TCPC_ROLE_CTRL_CC2_MASK << TCPC_ROLE_CTRL_CC2_SHIFT)) == \
38 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT)))
42 struct i2c_client *client;
44 struct tcpm_port *port;
46 struct regmap *regmap;
53 static inline struct tcpci *tcpc_to_tcpci(struct tcpc_dev *tcpc)
55 return container_of(tcpc, struct tcpci, tcpc);
58 static int tcpci_read16(struct tcpci *tcpci, unsigned int reg,
61 return regmap_raw_read(tcpci->regmap, reg, val, sizeof(u16));
64 static int tcpci_write16(struct tcpci *tcpci, unsigned int reg, u16 val)
66 return regmap_raw_write(tcpci->regmap, reg, &val, sizeof(u16));
69 static int tcpci_set_cc(struct tcpc_dev *tcpc, enum typec_cc_status cc)
71 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
77 reg = (TCPC_ROLE_CTRL_CC_RA << TCPC_ROLE_CTRL_CC1_SHIFT) |
78 (TCPC_ROLE_CTRL_CC_RA << TCPC_ROLE_CTRL_CC2_SHIFT);
81 reg = (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC1_SHIFT) |
82 (TCPC_ROLE_CTRL_CC_RD << TCPC_ROLE_CTRL_CC2_SHIFT);
85 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
86 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
87 (TCPC_ROLE_CTRL_RP_VAL_DEF <<
88 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
91 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
92 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
93 (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
94 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
97 reg = (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC1_SHIFT) |
98 (TCPC_ROLE_CTRL_CC_RP << TCPC_ROLE_CTRL_CC2_SHIFT) |
99 (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
100 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
104 reg = (TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC1_SHIFT) |
105 (TCPC_ROLE_CTRL_CC_OPEN << TCPC_ROLE_CTRL_CC2_SHIFT);
109 ret = regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
116 static int tcpci_start_drp_toggling(struct tcpc_dev *tcpc,
117 enum typec_cc_status cc)
119 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
120 unsigned int reg = TCPC_ROLE_CTRL_DRP;
124 case TYPEC_CC_RP_DEF:
125 reg |= (TCPC_ROLE_CTRL_RP_VAL_DEF <<
126 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
128 case TYPEC_CC_RP_1_5:
129 reg |= (TCPC_ROLE_CTRL_RP_VAL_1_5 <<
130 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
132 case TYPEC_CC_RP_3_0:
133 reg |= (TCPC_ROLE_CTRL_RP_VAL_3_0 <<
134 TCPC_ROLE_CTRL_RP_VAL_SHIFT);
138 return regmap_write(tcpci->regmap, TCPC_ROLE_CTRL, reg);
141 static enum typec_cc_status tcpci_to_typec_cc(unsigned int cc, bool sink)
145 return sink ? TYPEC_CC_RP_DEF : TYPEC_CC_RA;
147 return sink ? TYPEC_CC_RP_1_5 : TYPEC_CC_RD;
150 return TYPEC_CC_RP_3_0;
153 return TYPEC_CC_OPEN;
157 static int tcpci_get_cc(struct tcpc_dev *tcpc,
158 enum typec_cc_status *cc1, enum typec_cc_status *cc2)
160 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
161 unsigned int reg, role_control;
164 ret = regmap_read(tcpci->regmap, TCPC_ROLE_CTRL, &role_control);
168 ret = regmap_read(tcpci->regmap, TCPC_CC_STATUS, ®);
172 *cc1 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC1_SHIFT) &
173 TCPC_CC_STATUS_CC1_MASK,
174 reg & TCPC_CC_STATUS_TERM ||
175 tcpc_presenting_cc1_rd(role_control));
176 *cc2 = tcpci_to_typec_cc((reg >> TCPC_CC_STATUS_CC2_SHIFT) &
177 TCPC_CC_STATUS_CC2_MASK,
178 reg & TCPC_CC_STATUS_TERM ||
179 tcpc_presenting_cc2_rd(role_control));
184 static int tcpci_set_polarity(struct tcpc_dev *tcpc,
185 enum typec_cc_polarity polarity)
187 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
190 ret = regmap_write(tcpci->regmap, TCPC_TCPC_CTRL,
191 (polarity == TYPEC_POLARITY_CC2) ?
192 TCPC_TCPC_CTRL_ORIENTATION : 0);
199 static int tcpci_set_vconn(struct tcpc_dev *tcpc, bool enable)
201 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
204 ret = regmap_write(tcpci->regmap, TCPC_POWER_CTRL,
205 enable ? TCPC_POWER_CTRL_VCONN_ENABLE : 0);
212 static int tcpci_set_roles(struct tcpc_dev *tcpc, bool attached,
213 enum typec_role role, enum typec_data_role data)
215 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
219 reg = PD_REV20 << TCPC_MSG_HDR_INFO_REV_SHIFT;
220 if (role == TYPEC_SOURCE)
221 reg |= TCPC_MSG_HDR_INFO_PWR_ROLE;
222 if (data == TYPEC_HOST)
223 reg |= TCPC_MSG_HDR_INFO_DATA_ROLE;
224 ret = regmap_write(tcpci->regmap, TCPC_MSG_HDR_INFO, reg);
231 static int tcpci_set_pd_rx(struct tcpc_dev *tcpc, bool enable)
233 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
234 unsigned int reg = 0;
238 reg = TCPC_RX_DETECT_SOP | TCPC_RX_DETECT_HARD_RESET;
239 ret = regmap_write(tcpci->regmap, TCPC_RX_DETECT, reg);
246 static int tcpci_get_vbus(struct tcpc_dev *tcpc)
248 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
252 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
256 return !!(reg & TCPC_POWER_STATUS_VBUS_PRES);
259 static int tcpci_set_vbus(struct tcpc_dev *tcpc, bool source, bool sink)
261 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
264 /* Disable both source and sink first before enabling anything */
267 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
268 TCPC_CMD_DISABLE_SRC_VBUS);
274 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
275 TCPC_CMD_DISABLE_SINK_VBUS);
281 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
282 TCPC_CMD_SRC_VBUS_DEFAULT);
288 ret = regmap_write(tcpci->regmap, TCPC_COMMAND,
297 static int tcpci_pd_transmit(struct tcpc_dev *tcpc,
298 enum tcpm_transmit_type type,
299 const struct pd_message *msg)
301 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
302 unsigned int reg, cnt, header;
305 cnt = msg ? pd_header_cnt(msg->header) * 4 : 0;
306 ret = regmap_write(tcpci->regmap, TCPC_TX_BYTE_CNT, cnt + 2);
310 header = msg ? msg->header : 0;
311 ret = tcpci_write16(tcpci, TCPC_TX_HDR, header);
316 ret = regmap_raw_write(tcpci->regmap, TCPC_TX_DATA,
322 reg = (PD_RETRY_COUNT << TCPC_TRANSMIT_RETRY_SHIFT) |
323 (type << TCPC_TRANSMIT_TYPE_SHIFT);
324 ret = regmap_write(tcpci->regmap, TCPC_TRANSMIT, reg);
331 static int tcpci_init(struct tcpc_dev *tcpc)
333 struct tcpci *tcpci = tcpc_to_tcpci(tcpc);
334 unsigned long timeout = jiffies + msecs_to_jiffies(2000); /* XXX */
338 while (time_before_eq(jiffies, timeout)) {
339 ret = regmap_read(tcpci->regmap, TCPC_POWER_STATUS, ®);
342 if (!(reg & TCPC_POWER_STATUS_UNINIT))
344 usleep_range(10000, 20000);
346 if (time_after(jiffies, timeout))
349 /* Clear all events */
350 ret = tcpci_write16(tcpci, TCPC_ALERT, 0xffff);
354 if (tcpci->controls_vbus)
355 reg = TCPC_POWER_STATUS_VBUS_PRES;
358 ret = regmap_write(tcpci->regmap, TCPC_POWER_STATUS_MASK, reg);
362 reg = TCPC_ALERT_TX_SUCCESS | TCPC_ALERT_TX_FAILED |
363 TCPC_ALERT_TX_DISCARDED | TCPC_ALERT_RX_STATUS |
364 TCPC_ALERT_RX_HARD_RST | TCPC_ALERT_CC_STATUS;
365 if (tcpci->controls_vbus)
366 reg |= TCPC_ALERT_POWER_STATUS;
367 return tcpci_write16(tcpci, TCPC_ALERT_MASK, reg);
370 static irqreturn_t tcpci_irq(int irq, void *dev_id)
372 struct tcpci *tcpci = dev_id;
373 unsigned int status, reg;
375 tcpci_read16(tcpci, TCPC_ALERT, &status);
378 * Clear alert status for everything except RX_STATUS, which shouldn't
379 * be cleared until we have successfully retrieved message.
381 if (status & ~TCPC_ALERT_RX_STATUS)
382 tcpci_write16(tcpci, TCPC_ALERT,
383 status & ~TCPC_ALERT_RX_STATUS);
385 if (status & TCPC_ALERT_CC_STATUS)
386 tcpm_cc_change(tcpci->port);
388 if (status & TCPC_ALERT_POWER_STATUS) {
389 regmap_read(tcpci->regmap, TCPC_POWER_STATUS_MASK, ®);
392 * If power status mask has been reset, then the TCPC
396 tcpm_tcpc_reset(tcpci->port);
398 tcpm_vbus_change(tcpci->port);
401 if (status & TCPC_ALERT_RX_STATUS) {
402 struct pd_message msg;
405 regmap_read(tcpci->regmap, TCPC_RX_BYTE_CNT, &cnt);
407 tcpci_read16(tcpci, TCPC_RX_HDR, ®);
410 if (WARN_ON(cnt > sizeof(msg.payload)))
411 cnt = sizeof(msg.payload);
414 regmap_raw_read(tcpci->regmap, TCPC_RX_DATA,
417 /* Read complete, clear RX status alert bit */
418 tcpci_write16(tcpci, TCPC_ALERT, TCPC_ALERT_RX_STATUS);
420 tcpm_pd_receive(tcpci->port, &msg);
423 if (status & TCPC_ALERT_RX_HARD_RST)
424 tcpm_pd_hard_reset(tcpci->port);
426 if (status & TCPC_ALERT_TX_SUCCESS)
427 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_SUCCESS);
428 else if (status & TCPC_ALERT_TX_DISCARDED)
429 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_DISCARDED);
430 else if (status & TCPC_ALERT_TX_FAILED)
431 tcpm_pd_transmit_complete(tcpci->port, TCPC_TX_FAILED);
436 static const struct regmap_config tcpci_regmap_config = {
440 .max_register = 0x7F, /* 0x80 .. 0xFF are vendor defined */
443 static const struct tcpc_config tcpci_tcpc_config = {
444 .type = TYPEC_PORT_DFP,
445 .default_role = TYPEC_SINK,
448 static int tcpci_parse_config(struct tcpci *tcpci)
450 tcpci->controls_vbus = true; /* XXX */
452 /* TODO: Populate struct tcpc_config from ACPI/device-tree */
453 tcpci->tcpc.config = &tcpci_tcpc_config;
458 static int tcpci_probe(struct i2c_client *client,
459 const struct i2c_device_id *i2c_id)
464 tcpci = devm_kzalloc(&client->dev, sizeof(*tcpci), GFP_KERNEL);
468 tcpci->client = client;
469 tcpci->dev = &client->dev;
470 i2c_set_clientdata(client, tcpci);
471 tcpci->regmap = devm_regmap_init_i2c(client, &tcpci_regmap_config);
472 if (IS_ERR(tcpci->regmap))
473 return PTR_ERR(tcpci->regmap);
475 tcpci->tcpc.init = tcpci_init;
476 tcpci->tcpc.get_vbus = tcpci_get_vbus;
477 tcpci->tcpc.set_vbus = tcpci_set_vbus;
478 tcpci->tcpc.set_cc = tcpci_set_cc;
479 tcpci->tcpc.get_cc = tcpci_get_cc;
480 tcpci->tcpc.set_polarity = tcpci_set_polarity;
481 tcpci->tcpc.set_vconn = tcpci_set_vconn;
482 tcpci->tcpc.start_drp_toggling = tcpci_start_drp_toggling;
484 tcpci->tcpc.set_pd_rx = tcpci_set_pd_rx;
485 tcpci->tcpc.set_roles = tcpci_set_roles;
486 tcpci->tcpc.pd_transmit = tcpci_pd_transmit;
488 err = tcpci_parse_config(tcpci);
492 /* Disable chip interrupts */
493 tcpci_write16(tcpci, TCPC_ALERT_MASK, 0);
495 err = devm_request_threaded_irq(tcpci->dev, client->irq, NULL,
497 IRQF_ONESHOT | IRQF_TRIGGER_LOW,
498 dev_name(tcpci->dev), tcpci);
502 tcpci->port = tcpm_register_port(tcpci->dev, &tcpci->tcpc);
503 return PTR_ERR_OR_ZERO(tcpci->port);
506 static int tcpci_remove(struct i2c_client *client)
508 struct tcpci *tcpci = i2c_get_clientdata(client);
510 tcpm_unregister_port(tcpci->port);
515 static const struct i2c_device_id tcpci_id[] = {
519 MODULE_DEVICE_TABLE(i2c, tcpci_id);
522 static const struct of_device_id tcpci_of_match[] = {
523 { .compatible = "usb,tcpci", },
526 MODULE_DEVICE_TABLE(of, tcpci_of_match);
529 static struct i2c_driver tcpci_i2c_driver = {
532 .of_match_table = of_match_ptr(tcpci_of_match),
534 .probe = tcpci_probe,
535 .remove = tcpci_remove,
536 .id_table = tcpci_id,
538 module_i2c_driver(tcpci_i2c_driver);
540 MODULE_DESCRIPTION("USB Type-C Port Controller Interface driver");
541 MODULE_LICENSE("GPL");