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.
15 #ifndef __LINUX_USB_TCPM_H
16 #define __LINUX_USB_TCPM_H
18 #include <linux/bitops.h>
19 #include <linux/usb/typec.h>
22 enum typec_cc_status {
31 enum typec_cc_polarity {
36 /* Time to wait for TCPC to complete transmit */
37 #define PD_T_TCPC_TX_TIMEOUT 100
39 enum tcpm_transmit_status {
41 TCPC_TX_DISCARDED = 1,
45 enum tcpm_transmit_type {
47 TCPC_TX_SOP_PRIME = 1,
48 TCPC_TX_SOP_PRIME_PRIME = 2,
49 TCPC_TX_SOP_DEBUG_PRIME = 3,
50 TCPC_TX_SOP_DEBUG_PRIME_PRIME = 4,
51 TCPC_TX_HARD_RESET = 5,
52 TCPC_TX_CABLE_RESET = 6,
53 TCPC_TX_BIST_MODE_2 = 7
58 unsigned int nr_src_pdo;
61 unsigned int nr_snk_pdo;
63 unsigned int max_snk_mv;
64 unsigned int max_snk_ma;
65 unsigned int max_snk_mw;
66 unsigned int operating_snk_mw;
68 enum typec_port_type type;
69 enum typec_role default_role;
70 bool try_role_hw; /* try.{src,snk} implemented in hardware */
72 struct typec_altmode_desc *alt_modes;
75 enum tcpc_usb_switch {
76 TCPC_USB_SWITCH_CONNECT,
77 TCPC_USB_SWITCH_DISCONNECT,
78 TCPC_USB_SWITCH_RESTORE, /* TODO FIXME */
81 /* Mux state attributes */
82 #define TCPC_MUX_USB_ENABLED BIT(0) /* USB enabled */
83 #define TCPC_MUX_DP_ENABLED BIT(1) /* DP enabled */
84 #define TCPC_MUX_POLARITY_INVERTED BIT(2) /* Polarity inverted */
86 /* Mux modes, decoded to attributes */
88 TYPEC_MUX_NONE = 0, /* Open switch */
89 TYPEC_MUX_USB = TCPC_MUX_USB_ENABLED, /* USB only */
90 TYPEC_MUX_DP = TCPC_MUX_DP_ENABLED, /* DP only */
91 TYPEC_MUX_DOCK = TCPC_MUX_USB_ENABLED | /* Both USB and DP */
96 int (*set)(struct tcpc_mux_dev *dev, enum tcpc_mux_mode mux_mode,
97 enum tcpc_usb_switch usb_config,
98 enum typec_cc_polarity polarity);
104 const struct tcpc_config *config;
106 int (*init)(struct tcpc_dev *dev);
107 int (*get_vbus)(struct tcpc_dev *dev);
108 int (*set_cc)(struct tcpc_dev *dev, enum typec_cc_status cc);
109 int (*get_cc)(struct tcpc_dev *dev, enum typec_cc_status *cc1,
110 enum typec_cc_status *cc2);
111 int (*set_polarity)(struct tcpc_dev *dev,
112 enum typec_cc_polarity polarity);
113 int (*set_vconn)(struct tcpc_dev *dev, bool on);
114 int (*set_vbus)(struct tcpc_dev *dev, bool on, bool charge);
115 int (*set_current_limit)(struct tcpc_dev *dev, u32 max_ma, u32 mv);
116 int (*set_pd_rx)(struct tcpc_dev *dev, bool on);
117 int (*set_roles)(struct tcpc_dev *dev, bool attached,
118 enum typec_role role, enum typec_data_role data);
119 int (*start_drp_toggling)(struct tcpc_dev *dev,
120 enum typec_cc_status cc);
121 int (*try_role)(struct tcpc_dev *dev, int role);
122 int (*pd_transmit)(struct tcpc_dev *dev, enum tcpm_transmit_type type,
123 const struct pd_message *msg);
124 struct tcpc_mux_dev *mux;
129 struct tcpm_port *tcpm_register_port(struct device *dev, struct tcpc_dev *tcpc);
130 void tcpm_unregister_port(struct tcpm_port *port);
132 void tcpm_update_source_capabilities(struct tcpm_port *port, const u32 *pdo,
133 unsigned int nr_pdo);
134 void tcpm_update_sink_capabilities(struct tcpm_port *port, const u32 *pdo,
136 unsigned int max_snk_mv,
137 unsigned int max_snk_ma,
138 unsigned int max_snk_mw,
139 unsigned int operating_snk_mw);
141 void tcpm_vbus_change(struct tcpm_port *port);
142 void tcpm_cc_change(struct tcpm_port *port);
143 void tcpm_pd_receive(struct tcpm_port *port,
144 const struct pd_message *msg);
145 void tcpm_pd_transmit_complete(struct tcpm_port *port,
146 enum tcpm_transmit_status status);
147 void tcpm_pd_hard_reset(struct tcpm_port *port);
148 void tcpm_tcpc_reset(struct tcpm_port *port);
150 #endif /* __LINUX_USB_TCPM_H */