Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Copyright 2015-2017 Google, Inc
4 */
5
6#ifndef __LINUX_USB_TCPM_H
7#define __LINUX_USB_TCPM_H
8
9#include <linux/bitops.h>
10#include <linux/usb/typec.h>
11#include "pd.h"
12
13enum typec_cc_status {
14 TYPEC_CC_OPEN,
15 TYPEC_CC_RA,
16 TYPEC_CC_RD,
17 TYPEC_CC_RP_DEF,
18 TYPEC_CC_RP_1_5,
19 TYPEC_CC_RP_3_0,
20};
21
22/* Collision Avoidance */
23#define SINK_TX_NG TYPEC_CC_RP_1_5
24#define SINK_TX_OK TYPEC_CC_RP_3_0
25
26enum typec_cc_polarity {
27 TYPEC_POLARITY_CC1,
28 TYPEC_POLARITY_CC2,
29};
30
31/* Time to wait for TCPC to complete transmit */
32#define PD_T_TCPC_TX_TIMEOUT 100 /* in ms */
33#define PD_ROLE_SWAP_TIMEOUT (MSEC_PER_SEC * 10)
34#define PD_PPS_CTRL_TIMEOUT (MSEC_PER_SEC * 10)
35
36enum tcpm_transmit_status {
37 TCPC_TX_SUCCESS = 0,
38 TCPC_TX_DISCARDED = 1,
39 TCPC_TX_FAILED = 2,
40};
41
42enum tcpm_transmit_type {
43 TCPC_TX_SOP = 0,
44 TCPC_TX_SOP_PRIME = 1,
45 TCPC_TX_SOP_PRIME_PRIME = 2,
46 TCPC_TX_SOP_DEBUG_PRIME = 3,
47 TCPC_TX_SOP_DEBUG_PRIME_PRIME = 4,
48 TCPC_TX_HARD_RESET = 5,
49 TCPC_TX_CABLE_RESET = 6,
50 TCPC_TX_BIST_MODE_2 = 7
51};
52
53/* Mux state attributes */
54#define TCPC_MUX_USB_ENABLED BIT(0) /* USB enabled */
55#define TCPC_MUX_DP_ENABLED BIT(1) /* DP enabled */
56#define TCPC_MUX_POLARITY_INVERTED BIT(2) /* Polarity inverted */
57
58/**
59 * struct tcpc_dev - Port configuration and callback functions
60 * @fwnode: Pointer to port fwnode
61 * @get_vbus: Called to read current VBUS state
62 * @get_current_limit:
63 * Optional; called by the tcpm core when configured as a snk
64 * and cc=Rp-def. This allows the tcpm to provide a fallback
65 * current-limit detection method for the cc=Rp-def case.
66 * For example, some tcpcs may include BC1.2 charger detection
67 * and use that in this case.
68 * @set_cc: Called to set value of CC pins
69 * @get_cc: Called to read current CC pin values
70 * @set_polarity:
71 * Called to set polarity
72 * @set_vconn: Called to enable or disable VCONN
73 * @set_vbus: Called to enable or disable VBUS
74 * @set_current_limit:
75 * Optional; called to set current limit as negotiated
76 * with partner.
77 * @set_pd_rx: Called to enable or disable reception of PD messages
78 * @set_roles: Called to set power and data roles
79 * @start_toggling:
80 * Optional; if supported by hardware, called to start dual-role
81 * toggling or single-role connection detection. Toggling stops
82 * automatically if a connection is established.
83 * @try_role: Optional; called to set a preferred role
84 * @pd_transmit:Called to transmit PD message
85 * @set_bist_data: Turn on/off bist data mode for compliance testing
86 * @enable_frs:
87 * Optional; Called to enable/disable PD 3.0 fast role swap.
88 * Enabling frs is accessory dependent as not all PD3.0
89 * accessories support fast role swap.
90 * @frs_sourcing_vbus:
91 * Optional; Called to notify that vbus is now being sourced.
92 * Low level drivers can perform chip specific operations, if any.
93 * @enable_auto_vbus_discharge:
94 * Optional; TCPCI spec based TCPC implementations can optionally
95 * support hardware to autonomously dischrge vbus upon disconnecting
96 * as sink or source. TCPM signals TCPC to enable the mechanism upon
97 * entering connected state and signals disabling upon disconnect.
98 * @set_auto_vbus_discharge_threshold:
99 * Mandatory when enable_auto_vbus_discharge is implemented. TCPM
100 * calls this function to allow lower levels drivers to program the
101 * vbus threshold voltage below which the vbus discharge circuit
102 * will be turned on. requested_vbus_voltage is set to 0 when vbus
103 * is going to disappear knowingly i.e. during PR_SWAP and
104 * HARD_RESET etc.
105 * @is_vbus_vsafe0v:
106 * Optional; TCPCI spec based TCPC implementations are expected to
107 * detect VSAFE0V voltage level at vbus. When detection of VSAFE0V
108 * is supported by TCPC, set this callback for TCPM to query
109 * whether vbus is at VSAFE0V when needed.
110 * Returns true when vbus is at VSAFE0V, false otherwise.
111 * @set_partner_usb_comm_capable:
112 * Optional; The USB Communications Capable bit indicates if port
113 * partner is capable of communication over the USB data lines
114 * (e.g. D+/- or SS Tx/Rx). Called to notify the status of the bit.
115 */
116struct tcpc_dev {
117 struct fwnode_handle *fwnode;
118
119 int (*init)(struct tcpc_dev *dev);
120 int (*get_vbus)(struct tcpc_dev *dev);
121 int (*get_current_limit)(struct tcpc_dev *dev);
122 int (*set_cc)(struct tcpc_dev *dev, enum typec_cc_status cc);
123 int (*get_cc)(struct tcpc_dev *dev, enum typec_cc_status *cc1,
124 enum typec_cc_status *cc2);
125 int (*set_polarity)(struct tcpc_dev *dev,
126 enum typec_cc_polarity polarity);
127 int (*set_vconn)(struct tcpc_dev *dev, bool on);
128 int (*set_vbus)(struct tcpc_dev *dev, bool on, bool charge);
129 int (*set_current_limit)(struct tcpc_dev *dev, u32 max_ma, u32 mv);
130 int (*set_pd_rx)(struct tcpc_dev *dev, bool on);
131 int (*set_roles)(struct tcpc_dev *dev, bool attached,
132 enum typec_role role, enum typec_data_role data);
133 int (*start_toggling)(struct tcpc_dev *dev,
134 enum typec_port_type port_type,
135 enum typec_cc_status cc);
136 int (*try_role)(struct tcpc_dev *dev, int role);
137 int (*pd_transmit)(struct tcpc_dev *dev, enum tcpm_transmit_type type,
138 const struct pd_message *msg, unsigned int negotiated_rev);
139 int (*set_bist_data)(struct tcpc_dev *dev, bool on);
140 int (*enable_frs)(struct tcpc_dev *dev, bool enable);
141 void (*frs_sourcing_vbus)(struct tcpc_dev *dev);
142 int (*enable_auto_vbus_discharge)(struct tcpc_dev *dev, bool enable);
143 int (*set_auto_vbus_discharge_threshold)(struct tcpc_dev *dev, enum typec_pwr_opmode mode,
144 bool pps_active, u32 requested_vbus_voltage);
145 bool (*is_vbus_vsafe0v)(struct tcpc_dev *dev);
146 void (*set_partner_usb_comm_capable)(struct tcpc_dev *dev, bool enable);
147};
148
149struct tcpm_port;
150
151struct tcpm_port *tcpm_register_port(struct device *dev, struct tcpc_dev *tcpc);
152void tcpm_unregister_port(struct tcpm_port *port);
153
154void tcpm_vbus_change(struct tcpm_port *port);
155void tcpm_cc_change(struct tcpm_port *port);
156void tcpm_sink_frs(struct tcpm_port *port);
157void tcpm_sourcing_vbus(struct tcpm_port *port);
158void tcpm_pd_receive(struct tcpm_port *port,
159 const struct pd_message *msg);
160void tcpm_pd_transmit_complete(struct tcpm_port *port,
161 enum tcpm_transmit_status status);
162void tcpm_pd_hard_reset(struct tcpm_port *port);
163void tcpm_tcpc_reset(struct tcpm_port *port);
164
165#endif /* __LINUX_USB_TCPM_H */