Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
usbc_tcpc.h
Go to the documentation of this file.
1/*
2 * Copyright 2022 The Chromium OS Authors
3 * SPDX-License-Identifier: Apache-2.0
4 */
5
15#ifndef ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_TCPC_H_
16#define ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_TCPC_H_
17
27#include <zephyr/types.h>
28#include <zephyr/device.h>
29#include <errno.h>
30
31#include "usbc_tc.h"
32#include "usbc_pd.h"
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
81
99
120
121typedef int (*tcpc_vconn_control_cb_t)(const struct device *dev,
122 enum tc_cc_polarity pol, bool enable);
123typedef int (*tcpc_vconn_discharge_cb_t)(const struct device *dev,
124 enum tc_cc_polarity pol, bool enable);
125typedef void (*tcpc_alert_handler_cb_t)(const struct device *dev, void *data,
126 enum tcpc_alert alert);
127
128__subsystem struct tcpc_driver_api {
129 int (*init)(const struct device *dev);
130 int (*get_cc)(const struct device *dev, enum tc_cc_voltage_state *cc1,
131 enum tc_cc_voltage_state *cc2);
132 int (*select_rp_value)(const struct device *dev, enum tc_rp_value rp);
133 int (*get_rp_value)(const struct device *dev, enum tc_rp_value *rp);
134 int (*set_cc)(const struct device *dev, enum tc_cc_pull pull);
136 void (*set_vconn_cb)(const struct device *dev, tcpc_vconn_control_cb_t vconn_cb);
137 int (*vconn_discharge)(const struct device *dev, bool enable);
138 int (*set_vconn)(const struct device *dev, bool enable);
139 int (*set_roles)(const struct device *dev, enum tc_power_role power_role,
140 enum tc_data_role data_role);
141 int (*get_rx_pending_msg)(const struct device *dev, struct pd_msg *msg);
142 int (*set_rx_enable)(const struct device *dev, bool enable);
143 int (*set_cc_polarity)(const struct device *dev, enum tc_cc_polarity polarity);
144 int (*transmit_data)(const struct device *dev, struct pd_msg *msg);
145 int (*dump_std_reg)(const struct device *dev);
146 void (*alert_handler_cb)(const struct device *dev, void *data, enum tcpc_alert alert);
147 int (*get_status_register)(const struct device *dev, enum tcpc_status_reg reg,
148 int32_t *status);
149 int (*clear_status_register)(const struct device *dev, enum tcpc_status_reg reg,
150 uint32_t mask);
151 int (*mask_status_register)(const struct device *dev, enum tcpc_status_reg reg,
152 uint32_t mask);
153 int (*set_debug_accessory)(const struct device *dev, bool enable);
154 int (*set_debug_detach)(const struct device *dev);
155 int (*set_drp_toggle)(const struct device *dev, bool enable);
156 int (*get_snk_ctrl)(const struct device *dev);
157 int (*set_snk_ctrl)(const struct device *dev, bool enable);
158 int (*get_src_ctrl)(const struct device *dev);
159 int (*set_src_ctrl)(const struct device *dev, bool enable);
160 int (*get_chip_info)(const struct device *dev, struct tcpc_chip_info *chip_info);
161 int (*set_low_power_mode)(const struct device *dev, bool enable);
162 int (*sop_prime_enable)(const struct device *dev, bool enable);
163 int (*set_bist_test_mode)(const struct device *dev, bool enable);
164 int (*set_alert_handler_cb)(const struct device *dev, tcpc_alert_handler_cb_t handler,
165 void *data);
166};
167
171static inline int tcpc_is_cc_rp(enum tc_cc_voltage_state cc)
172{
173 return (cc == TC_CC_VOLT_RP_DEF) || (cc == TC_CC_VOLT_RP_1A5) ||
175}
176
180static inline int tcpc_is_cc_open(enum tc_cc_voltage_state cc1,
181 enum tc_cc_voltage_state cc2)
182{
183 return (cc1 < TC_CC_VOLT_RD) && (cc2 < TC_CC_VOLT_RD);
184}
185
190 enum tc_cc_voltage_state cc2)
191{
192 return cc1 == TC_CC_VOLT_RD && cc2 == TC_CC_VOLT_RD;
193}
194
199 enum tc_cc_voltage_state cc2)
200{
201 return tcpc_is_cc_rp(cc1) && tcpc_is_cc_rp(cc2);
202}
203
207static inline int tcpc_is_cc_audio_acc(enum tc_cc_voltage_state cc1,
208 enum tc_cc_voltage_state cc2)
209{
210 return cc1 == TC_CC_VOLT_RA && cc2 == TC_CC_VOLT_RA;
211}
212
217 enum tc_cc_voltage_state cc2)
218{
219 return cc1 == TC_CC_VOLT_RD || cc2 == TC_CC_VOLT_RD;
220}
221
226 enum tc_cc_voltage_state cc2)
227{
228 return tcpc_is_cc_at_least_one_rd(cc1, cc2) && cc1 != cc2;
229}
230
240static inline int tcpc_init(const struct device *dev)
241{
242 const struct tcpc_driver_api *api =
243 (const struct tcpc_driver_api *)dev->api;
244
245 __ASSERT(api->init != NULL,
246 "Callback pointer should not be NULL");
247
248 return api->init(dev);
249}
250
262static inline int tcpc_get_cc(const struct device *dev,
263 enum tc_cc_voltage_state *cc1,
264 enum tc_cc_voltage_state *cc2)
265{
266 const struct tcpc_driver_api *api =
267 (const struct tcpc_driver_api *)dev->api;
268
269 if (api->get_cc == NULL) {
270 return -ENOSYS;
271 }
272
273 return api->get_cc(dev, cc1, cc2);
274}
275
286static inline int tcpc_select_rp_value(const struct device *dev, enum tc_rp_value rp)
287{
288 const struct tcpc_driver_api *api =
289 (const struct tcpc_driver_api *)dev->api;
290
291 if (api->select_rp_value == NULL) {
292 return -ENOSYS;
293 }
294
295 return api->select_rp_value(dev, rp);
296}
297
308static inline int tcpc_get_rp_value(const struct device *dev, enum tc_rp_value *rp)
309{
310 const struct tcpc_driver_api *api =
311 (const struct tcpc_driver_api *)dev->api;
312
313 if (api->get_rp_value == NULL) {
314 return -ENOSYS;
315 }
316
317 return api->get_rp_value(dev, rp);
318}
319
329static inline int tcpc_set_cc(const struct device *dev, enum tc_cc_pull pull)
330{
331 const struct tcpc_driver_api *api =
332 (const struct tcpc_driver_api *)dev->api;
333
334 __ASSERT(api->set_cc != NULL,
335 "Callback pointer should not be NULL");
336
337 return api->set_cc(dev, pull);
338}
339
350static inline void tcpc_set_vconn_cb(const struct device *dev,
352{
353 const struct tcpc_driver_api *api =
354 (const struct tcpc_driver_api *)dev->api;
355
356 __ASSERT(api->set_vconn_cb != NULL,
357 "Callback pointer should not be NULL");
358
359 api->set_vconn_cb(dev, vconn_cb);
360}
361
372static inline void tcpc_set_vconn_discharge_cb(const struct device *dev,
374{
375 const struct tcpc_driver_api *api =
376 (const struct tcpc_driver_api *)dev->api;
377
378 __ASSERT(api->set_vconn_discharge_cb != NULL,
379 "Callback pointer should not be NULL");
380
381 api->set_vconn_discharge_cb(dev, cb);
382}
383
397static inline int tcpc_vconn_discharge(const struct device *dev, bool enable)
398{
399 const struct tcpc_driver_api *api =
400 (const struct tcpc_driver_api *)dev->api;
401
402 if (api->vconn_discharge == NULL) {
403 return -ENOSYS;
404 }
405
406 return api->vconn_discharge(dev, enable);
407}
408
422static inline int tcpc_set_vconn(const struct device *dev, bool enable)
423{
424 const struct tcpc_driver_api *api =
425 (const struct tcpc_driver_api *)dev->api;
426
427 if (api->set_vconn == NULL) {
428 return -ENOSYS;
429 }
430
431 return api->set_vconn(dev, enable);
432}
433
447static inline int tcpc_set_roles(const struct device *dev,
448 enum tc_power_role power_role,
449 enum tc_data_role data_role)
450{
451 const struct tcpc_driver_api *api =
452 (const struct tcpc_driver_api *)dev->api;
453
454 if (api->set_roles == NULL) {
455 return -ENOSYS;
456 }
457
458 return api->set_roles(dev, power_role, data_role);
459}
460
474static inline int tcpc_get_rx_pending_msg(const struct device *dev, struct pd_msg *buf)
475{
476 const struct tcpc_driver_api *api = (const struct tcpc_driver_api *)dev->api;
477
478 __ASSERT(api->get_rx_pending_msg != NULL, "Callback pointer should not be NULL");
479
480 return api->get_rx_pending_msg(dev, buf);
481}
482
494static inline int tcpc_set_rx_enable(const struct device *dev, bool enable)
495{
496 const struct tcpc_driver_api *api =
497 (const struct tcpc_driver_api *)dev->api;
498
499 if (api->set_rx_enable == NULL) {
500 return -ENOSYS;
501 }
502
503 return api->set_rx_enable(dev, enable);
504}
505
515static inline int tcpc_set_cc_polarity(const struct device *dev,
516 enum tc_cc_polarity polarity)
517{
518 const struct tcpc_driver_api *api =
519 (const struct tcpc_driver_api *)dev->api;
520
521 __ASSERT(api->set_cc_polarity != NULL,
522 "Callback pointer should not be NULL");
523
524 return api->set_cc_polarity(dev, polarity);
525}
526
537static inline int tcpc_transmit_data(const struct device *dev,
538 struct pd_msg *msg)
539{
540 const struct tcpc_driver_api *api =
541 (const struct tcpc_driver_api *)dev->api;
542
543 if (api->transmit_data == NULL) {
544 return -ENOSYS;
545 }
546
547 return api->transmit_data(dev, msg);
548}
549
559static inline int tcpc_dump_std_reg(const struct device *dev)
560{
561 const struct tcpc_driver_api *api =
562 (const struct tcpc_driver_api *)dev->api;
563
564 if (api->dump_std_reg == NULL) {
565 return -ENOSYS;
566 }
567
568 return api->dump_std_reg(dev);
569}
570
584static inline int tcpc_set_alert_handler_cb(const struct device *dev,
586 void *data)
587{
588 const struct tcpc_driver_api *api =
589 (const struct tcpc_driver_api *)dev->api;
590
591 __ASSERT(api->set_alert_handler_cb != NULL,
592 "Callback pointer should not be NULL");
593
594 return api->set_alert_handler_cb(dev, handler, data);
595}
596
608static inline int tcpc_get_status_register(const struct device *dev,
609 enum tcpc_status_reg reg,
610 int32_t *status)
611{
612 const struct tcpc_driver_api *api =
613 (const struct tcpc_driver_api *)dev->api;
614
615 if (api->get_status_register == NULL) {
616 return -ENOSYS;
617 }
618
619 return api->get_status_register(dev, reg, status);
620}
621
634static inline int tcpc_clear_status_register(const struct device *dev,
635 enum tcpc_status_reg reg,
636 uint32_t mask)
637{
638 const struct tcpc_driver_api *api =
639 (const struct tcpc_driver_api *)dev->api;
640
641 if (api->clear_status_register == NULL) {
642 return -ENOSYS;
643 }
644
645 return api->clear_status_register(dev, reg, mask);
646}
647
660static inline int tcpc_mask_status_register(const struct device *dev,
661 enum tcpc_status_reg reg,
662 uint32_t mask)
663{
664 const struct tcpc_driver_api *api =
665 (const struct tcpc_driver_api *)dev->api;
666
667 if (api->mask_status_register == NULL) {
668 return -ENOSYS;
669 }
670
671 return api->mask_status_register(dev, reg, mask);
672}
673
684static inline int tcpc_set_debug_accessory(const struct device *dev,
685 bool enable)
686{
687 const struct tcpc_driver_api *api =
688 (const struct tcpc_driver_api *)dev->api;
689
690 if (api->set_debug_accessory == NULL) {
691 return -ENOSYS;
692 }
693
694 return api->set_debug_accessory(dev, enable);
695}
696
706static inline int tcpc_set_debug_detach(const struct device *dev)
707{
708 const struct tcpc_driver_api *api =
709 (const struct tcpc_driver_api *)dev->api;
710
711 if (api->set_debug_detach == NULL) {
712 return -ENOSYS;
713 }
714
715 return api->set_debug_detach(dev);
716}
717
728static inline int tcpc_set_drp_toggle(const struct device *dev, bool enable)
729{
730 const struct tcpc_driver_api *api =
731 (const struct tcpc_driver_api *)dev->api;
732
733 if (api->set_drp_toggle == NULL) {
734 return -ENOSYS;
735 }
736
737 return api->set_drp_toggle(dev, enable);
738}
739
749static inline int tcpc_get_snk_ctrl(const struct device *dev)
750{
751 const struct tcpc_driver_api *api =
752 (const struct tcpc_driver_api *)dev->api;
753
754 if (api->get_snk_ctrl == NULL) {
755 return -ENOSYS;
756 }
757
758 return api->get_snk_ctrl(dev);
759}
760
769static inline int tcpc_set_snk_ctrl(const struct device *dev, bool enable)
770{
771 const struct tcpc_driver_api *api = (const struct tcpc_driver_api *)dev->api;
772
773 if (api->set_snk_ctrl == NULL) {
774 return -ENOSYS;
775 }
776
777 return api->set_snk_ctrl(dev, enable);
778}
779
789static inline int tcpc_get_src_ctrl(const struct device *dev)
790{
791 const struct tcpc_driver_api *api =
792 (const struct tcpc_driver_api *)dev->api;
793
794 if (api->get_src_ctrl == NULL) {
795 return -ENOSYS;
796 }
797
798 return api->get_src_ctrl(dev);
799}
800
809static inline int tcpc_set_src_ctrl(const struct device *dev, bool enable)
810{
811 const struct tcpc_driver_api *api = (const struct tcpc_driver_api *)dev->api;
812
813 if (api->set_src_ctrl == NULL) {
814 return -ENOSYS;
815 }
816
817 return api->set_src_ctrl(dev, enable);
818}
819
831static inline int tcpc_set_bist_test_mode(const struct device *dev,
832 bool enable)
833{
834 const struct tcpc_driver_api *api =
835 (const struct tcpc_driver_api *)dev->api;
836
837 if (api->set_bist_test_mode == NULL) {
838 return -ENOSYS;
839 }
840
841 return api->set_bist_test_mode(dev, enable);
842}
843
854static inline int tcpc_get_chip_info(const struct device *dev,
855 struct tcpc_chip_info *chip_info)
856{
857 const struct tcpc_driver_api *api =
858 (const struct tcpc_driver_api *)dev->api;
859
860 if (api->get_chip_info == NULL) {
861 return -ENOSYS;
862 }
863
864 return api->get_chip_info(dev, chip_info);
865}
866
877static inline int tcpc_set_low_power_mode(const struct device *dev,
878 bool enable)
879{
880 const struct tcpc_driver_api *api =
881 (const struct tcpc_driver_api *)dev->api;
882
883 if (api->set_low_power_mode == NULL) {
884 return -ENOSYS;
885 }
886
887 return api->set_low_power_mode(dev, enable);
888}
889
900static inline int tcpc_sop_prime_enable(const struct device *dev,
901 bool enable)
902{
903 const struct tcpc_driver_api *api =
904 (const struct tcpc_driver_api *)dev->api;
905
906 if (api->sop_prime_enable == NULL) {
907 return -ENOSYS;
908 }
909
910 return api->sop_prime_enable(dev, enable);
911}
912
917#ifdef __cplusplus
918}
919#endif
920
921#endif /* ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_TCPC_H_ */
irp cc
Definition asm-macro-32-bit-gnu.h:10
System error numbers.
#define ENOSYS
Function not implemented.
Definition errno.h:82
static int tcpc_clear_status_register(const struct device *dev, enum tcpc_status_reg reg, uint32_t mask)
Clears a TCPC status register.
Definition usbc_tcpc.h:634
static int tcpc_set_debug_accessory(const struct device *dev, bool enable)
Manual control of TCPC DebugAccessory control.
Definition usbc_tcpc.h:684
static int tcpc_is_cc_src_dbg_acc(enum tc_cc_voltage_state cc1, enum tc_cc_voltage_state cc2)
Returns true if we detect the port partner is a src debug accessory.
Definition usbc_tcpc.h:198
static int tcpc_get_src_ctrl(const struct device *dev)
Queries the current sourcing state of the TCPC.
Definition usbc_tcpc.h:789
static int tcpc_get_snk_ctrl(const struct device *dev)
Queries the current sinking state of the TCPC.
Definition usbc_tcpc.h:749
static int tcpc_mask_status_register(const struct device *dev, enum tcpc_status_reg reg, uint32_t mask)
Sets the mask of a TCPC status register.
Definition usbc_tcpc.h:660
static int tcpc_is_cc_open(enum tc_cc_voltage_state cc1, enum tc_cc_voltage_state cc2)
Returns true if both CC lines are completely open.
Definition usbc_tcpc.h:180
static int tcpc_is_cc_audio_acc(enum tc_cc_voltage_state cc1, enum tc_cc_voltage_state cc2)
Returns true if the port partner is an audio accessory.
Definition usbc_tcpc.h:207
static int tcpc_set_vconn(const struct device *dev, bool enable)
Enables or disables VCONN.
Definition usbc_tcpc.h:422
static int tcpc_get_rp_value(const struct device *dev, enum tc_rp_value *rp)
Gets the value of the CC pull up resistor used when operating as a Source.
Definition usbc_tcpc.h:308
static int tcpc_get_rx_pending_msg(const struct device *dev, struct pd_msg *buf)
Retrieves the Power Delivery message from the TCPC.
Definition usbc_tcpc.h:474
static int tcpc_vconn_discharge(const struct device *dev, bool enable)
Discharges VCONN.
Definition usbc_tcpc.h:397
static int tcpc_select_rp_value(const struct device *dev, enum tc_rp_value rp)
Sets the value of CC pull up resistor used when operating as a Source.
Definition usbc_tcpc.h:286
static int tcpc_get_status_register(const struct device *dev, enum tcpc_status_reg reg, int32_t *status)
Gets a status register.
Definition usbc_tcpc.h:608
int(* tcpc_vconn_discharge_cb_t)(const struct device *dev, enum tc_cc_polarity pol, bool enable)
Definition usbc_tcpc.h:123
tcpc_alert
TCPC Alert bits.
Definition usbc_tcpc.h:41
static int tcpc_set_cc_polarity(const struct device *dev, enum tc_cc_polarity polarity)
Sets the polarity of the CC lines.
Definition usbc_tcpc.h:515
void(* tcpc_alert_handler_cb_t)(const struct device *dev, void *data, enum tcpc_alert alert)
Definition usbc_tcpc.h:125
static int tcpc_get_cc(const struct device *dev, enum tc_cc_voltage_state *cc1, enum tc_cc_voltage_state *cc2)
Reads the status of the CC lines.
Definition usbc_tcpc.h:262
static int tcpc_is_cc_rp(enum tc_cc_voltage_state cc)
Returns whether the sink has detected a Rp resistor on the other side.
Definition usbc_tcpc.h:171
static int tcpc_set_alert_handler_cb(const struct device *dev, tcpc_alert_handler_cb_t handler, void *data)
Sets the alert function that's called when an interrupt is triggered due to an alert bit.
Definition usbc_tcpc.h:584
static int tcpc_set_snk_ctrl(const struct device *dev, bool enable)
Set the VBUS sinking state of the TCPC.
Definition usbc_tcpc.h:769
int(* tcpc_vconn_control_cb_t)(const struct device *dev, enum tc_cc_polarity pol, bool enable)
Definition usbc_tcpc.h:121
static int tcpc_get_chip_info(const struct device *dev, struct tcpc_chip_info *chip_info)
Gets the TCPC firmware version.
Definition usbc_tcpc.h:854
static int tcpc_transmit_data(const struct device *dev, struct pd_msg *msg)
Transmits a Power Delivery message.
Definition usbc_tcpc.h:537
static int tcpc_set_roles(const struct device *dev, enum tc_power_role power_role, enum tc_data_role data_role)
Sets the Power and Data Role of the PD message header.
Definition usbc_tcpc.h:447
static int tcpc_set_src_ctrl(const struct device *dev, bool enable)
Set the VBUS sourcing state of the TCPC.
Definition usbc_tcpc.h:809
static int tcpc_set_rx_enable(const struct device *dev, bool enable)
Enables the reception of SOP* message types.
Definition usbc_tcpc.h:494
static int tcpc_is_cc_only_one_rd(enum tc_cc_voltage_state cc1, enum tc_cc_voltage_state cc2)
Returns true if the port partner is presenting Rd on only one CC line.
Definition usbc_tcpc.h:225
static int tcpc_dump_std_reg(const struct device *dev)
Dump a set of TCPC registers.
Definition usbc_tcpc.h:559
static int tcpc_set_low_power_mode(const struct device *dev, bool enable)
Instructs the TCPC to enter or exit low power mode.
Definition usbc_tcpc.h:877
static void tcpc_set_vconn_discharge_cb(const struct device *dev, tcpc_vconn_discharge_cb_t cb)
Sets a callback that can enable or discharge VCONN if the TCPC is unable to or the system is configur...
Definition usbc_tcpc.h:372
static int tcpc_set_drp_toggle(const struct device *dev, bool enable)
Enable TCPC auto dual role toggle.
Definition usbc_tcpc.h:728
static int tcpc_is_cc_snk_dbg_acc(enum tc_cc_voltage_state cc1, enum tc_cc_voltage_state cc2)
Returns true if we detect the port partner is a snk debug accessory.
Definition usbc_tcpc.h:189
static void tcpc_set_vconn_cb(const struct device *dev, tcpc_vconn_control_cb_t vconn_cb)
Sets a callback that can enable or disable VCONN if the TCPC is unable to or the system is configured...
Definition usbc_tcpc.h:350
static int tcpc_set_debug_detach(const struct device *dev)
Detach from a debug connection.
Definition usbc_tcpc.h:706
static int tcpc_sop_prime_enable(const struct device *dev, bool enable)
Enables the reception of SOP Prime messages.
Definition usbc_tcpc.h:900
static int tcpc_is_cc_at_least_one_rd(enum tc_cc_voltage_state cc1, enum tc_cc_voltage_state cc2)
Returns true if the port partner is presenting at least one Rd.
Definition usbc_tcpc.h:216
static int tcpc_init(const struct device *dev)
Initializes the TCPC.
Definition usbc_tcpc.h:240
static int tcpc_set_cc(const struct device *dev, enum tc_cc_pull pull)
Sets the CC pull resistor and sets the role as either Source or Sink.
Definition usbc_tcpc.h:329
static int tcpc_set_bist_test_mode(const struct device *dev, bool enable)
Controls the BIST Mode of the TCPC.
Definition usbc_tcpc.h:831
tcpc_status_reg
TCPC Status register.
Definition usbc_tcpc.h:85
@ TCPC_ALERT_EXTENDED_STATUS
Extended status changed.
Definition usbc_tcpc.h:72
@ TCPC_ALERT_TRANSMIT_MSG_DISCARDED
Reset or SOP* message transmission not sent due to an incoming receive message.
Definition usbc_tcpc.h:56
@ TCPC_ALERT_CC_STATUS
CC status changed.
Definition usbc_tcpc.h:43
@ TCPC_ALERT_EXTENDED
An extended interrupt event has occurred.
Definition usbc_tcpc.h:77
@ TCPC_ALERT_BEGINNING_MSG_STATUS
Receive buffer register changed.
Definition usbc_tcpc.h:70
@ TCPC_ALERT_MSG_STATUS
Receive Buffer register changed.
Definition usbc_tcpc.h:47
@ TCPC_ALERT_HARD_RESET_RECEIVED
Received Hard Reset message.
Definition usbc_tcpc.h:49
@ TCPC_ALERT_TRANSMIT_MSG_SUCCESS
Reset or SOP* message transmission successful.
Definition usbc_tcpc.h:58
@ TCPC_ALERT_VBUS_ALARM_HI
A high-voltage alarm has occurred.
Definition usbc_tcpc.h:60
@ TCPC_ALERT_VBUS_SNK_DISCONNECT
The TCPC in Attached.SNK state has detected a sink disconnect.
Definition usbc_tcpc.h:68
@ TCPC_ALERT_POWER_STATUS
Power status changed.
Definition usbc_tcpc.h:45
@ TCPC_ALERT_VBUS_ALARM_LO
A low-voltage alarm has occurred.
Definition usbc_tcpc.h:62
@ TCPC_ALERT_VENDOR_DEFINED
A vendor defined alert has been detected.
Definition usbc_tcpc.h:79
@ TCPC_ALERT_FAULT_STATUS
A fault has occurred.
Definition usbc_tcpc.h:64
@ TCPC_ALERT_TRANSMIT_MSG_FAILED
SOP* message transmission not successful.
Definition usbc_tcpc.h:51
@ TCPC_ALERT_RX_BUFFER_OVERFLOW
TCPC RX buffer has overflowed.
Definition usbc_tcpc.h:66
@ TCPC_FAULT_STATUS
The Fault Status register.
Definition usbc_tcpc.h:91
@ TCPC_VENDOR_DEFINED_STATUS
The Vendor Defined Status register.
Definition usbc_tcpc.h:97
@ TCPC_EXTENDED_ALERT_STATUS
The Extended Alert Status register.
Definition usbc_tcpc.h:95
@ TCPC_POWER_STATUS
The Power Status register.
Definition usbc_tcpc.h:89
@ TCPC_CC_STATUS
The CC Status register.
Definition usbc_tcpc.h:87
@ TCPC_EXTENDED_STATUS
The Extended Status register.
Definition usbc_tcpc.h:93
tc_cc_pull
CC pull resistors.
Definition usbc_tc.h:352
tc_rp_value
Pull-Up resistor values.
Definition usbc_tc.h:338
tc_cc_voltage_state
CC Voltage status.
Definition usbc_tc.h:308
tc_data_role
Power Delivery Data Role.
Definition usbc_tc.h:389
tc_power_role
Power Delivery Power Role.
Definition usbc_tc.h:379
tc_cc_polarity
Polarity of the CC lines.
Definition usbc_tc.h:401
@ TC_CC_VOLT_RP_DEF
Port partner is applying Rp (0.5A)
Definition usbc_tc.h:316
@ TC_CC_VOLT_RA
Port partner is applying Ra.
Definition usbc_tc.h:312
@ TC_CC_VOLT_RD
Port partner is applying Rd.
Definition usbc_tc.h:314
@ TC_CC_VOLT_RP_3A0
Port partner is applying Rp (3.0A)
Definition usbc_tc.h:320
@ TC_CC_VOLT_RP_1A5
Definition usbc_tc.h:318
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
void * data
Address of the device instance private data.
Definition device.h:422
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418
Power Delivery message.
Definition usbc_pd.h:1040
TCPC Chip Information.
Definition usbc_tcpc.h:103
uint16_t product_id
Product Id.
Definition usbc_tcpc.h:107
uint8_t min_req_fw_version_string[8]
Minimum Required firmware version string.
Definition usbc_tcpc.h:115
uint64_t fw_version_number
Firmware version number.
Definition usbc_tcpc.h:111
uint64_t min_req_fw_version_number
Minimum Required firmware version number.
Definition usbc_tcpc.h:117
uint16_t device_id
Device Id.
Definition usbc_tcpc.h:109
uint16_t vendor_id
Vendor Id.
Definition usbc_tcpc.h:105
Definition usbc_tcpc.h:128
int(* init)(const struct device *dev)
Definition usbc_tcpc.h:129
int(* vconn_discharge)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:137
int(* set_debug_accessory)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:153
int(* get_rx_pending_msg)(const struct device *dev, struct pd_msg *msg)
Definition usbc_tcpc.h:141
int(* dump_std_reg)(const struct device *dev)
Definition usbc_tcpc.h:145
int(* select_rp_value)(const struct device *dev, enum tc_rp_value rp)
Definition usbc_tcpc.h:132
void(* alert_handler_cb)(const struct device *dev, void *data, enum tcpc_alert alert)
Definition usbc_tcpc.h:146
void(* set_vconn_discharge_cb)(const struct device *dev, tcpc_vconn_discharge_cb_t cb)
Definition usbc_tcpc.h:135
int(* set_snk_ctrl)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:157
int(* set_rx_enable)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:142
int(* set_cc)(const struct device *dev, enum tc_cc_pull pull)
Definition usbc_tcpc.h:134
int(* set_roles)(const struct device *dev, enum tc_power_role power_role, enum tc_data_role data_role)
Definition usbc_tcpc.h:139
int(* sop_prime_enable)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:162
int(* clear_status_register)(const struct device *dev, enum tcpc_status_reg reg, uint32_t mask)
Definition usbc_tcpc.h:149
int(* get_snk_ctrl)(const struct device *dev)
Definition usbc_tcpc.h:156
int(* get_src_ctrl)(const struct device *dev)
Definition usbc_tcpc.h:158
int(* set_vconn)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:138
int(* set_src_ctrl)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:159
int(* set_cc_polarity)(const struct device *dev, enum tc_cc_polarity polarity)
Definition usbc_tcpc.h:143
int(* get_chip_info)(const struct device *dev, struct tcpc_chip_info *chip_info)
Definition usbc_tcpc.h:160
int(* get_status_register)(const struct device *dev, enum tcpc_status_reg reg, int32_t *status)
Definition usbc_tcpc.h:147
int(* transmit_data)(const struct device *dev, struct pd_msg *msg)
Definition usbc_tcpc.h:144
int(* set_low_power_mode)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:161
int(* mask_status_register)(const struct device *dev, enum tcpc_status_reg reg, uint32_t mask)
Definition usbc_tcpc.h:151
int(* set_debug_detach)(const struct device *dev)
Definition usbc_tcpc.h:154
int(* get_rp_value)(const struct device *dev, enum tc_rp_value *rp)
Definition usbc_tcpc.h:133
void(* set_vconn_cb)(const struct device *dev, tcpc_vconn_control_cb_t vconn_cb)
Definition usbc_tcpc.h:136
int(* set_alert_handler_cb)(const struct device *dev, tcpc_alert_handler_cb_t handler, void *data)
Definition usbc_tcpc.h:164
int(* get_cc)(const struct device *dev, enum tc_cc_voltage_state *cc1, enum tc_cc_voltage_state *cc2)
Definition usbc_tcpc.h:130
int(* set_drp_toggle)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:155
int(* set_bist_test_mode)(const struct device *dev, bool enable)
Definition usbc_tcpc.h:163
USB-C Power Delivery API used for USB-C drivers.
USB Type-C Cable and Connector API used for USB-C drivers.