Skip to content

Commit 7d8cbda

Browse files
committed
feat(type_c,pd): add public APIs for Type-C (HUSB320) and PD (FUSB302)
Introduce initial, beta public headers aligned with esp-idf/esp-usb style: - Type-C core (CC-only): attach/detach/orientation & power-role control - File: esp-usb/type_c/include/esp_typec.h - Install/uninstall + library info - Events: ATTACHED/DETACHED/ORIENTATION/PWR_ROLE/ERROR - Factory: esp_typec_port_create_husb320() (HUSB320; CC-only) - APIs: esp_typec_set_power_role(), esp_typec_get_orientation(), esp_typec_is_attached(), esp_typec_port_destroy() - Power Delivery (PD-only): runtime role control and sink requests - File: esp-usb/type_c/include/esp_typec_pd.h - Install/uninstall + optional polling handler + library info - Events: ATTACHED/DETACHED/CONTRACT_READY/CONTRACT_LOST/PPS_ADJUSTED/ERROR - Factory: esp_typec_pd_port_create_fusb302() (FUSB302; PD-capable) - APIs: esp_typec_pd_set_power_role(), esp_typec_pd_sink_request_fixed(), esp_typec_pd_sink_request_pps(), esp_typec_pd_get_contract(), esp_typec_pd_get_orientation(), esp_typec_pd_is_attached(), esp_typec_pd_port_destroy() Decisions: - Split CC-only and PD APIs to keep modules independent and build-light. - Reused event naming across CC and PD for consistency; separate enums to avoid coupling. - Only include HUSB320 (CC-only) and FUSB302 (PD-capable) factories for now; removed any HUSB311 references. - New files use SPDX year 2025 per repo convention. Notes: - APIs are intentionally minimal; more controls (source caps, swaps, DRP policies) can be added without breaking the current surface. - Data-role (host/device) integration is out of scope for this step.
1 parent 613f79a commit 7d8cbda

File tree

18 files changed

+1870
-0
lines changed

18 files changed

+1870
-0
lines changed

.github/workflows/upload_component.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ jobs:
4444
host/class/uac/usb_host_uac;
4545
host/class/uvc/usb_host_uvc;
4646
host/usb;
47+
type_c;
4748
namespace: "espressif"
4849
# API token will only be available in the master branch in the main repository.
4950
# However, dry-run doesn't require a valid token.

type_c/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog for USB type C/PD library
2+
3+
## 0.1.0-beta
4+
5+
- Initial version

type_c/CMakeLists.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
idf_component_register(
3+
SRCS "src/esp_typec.c" "src/esp_typec_pd.c"
4+
INCLUDE_DIRS "include"
5+
REQUIRES freertos
6+
)

type_c/LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

type_c/README.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# ESP Type-C / USB Power Delivery (esp-usb/type_c)
2+
3+
> **Status:** Beta API — names and behavior may change before v1.0.
4+
5+
This component provides two focused, minimal public APIs for USB Type-C:
6+
7+
- **Type-C Core (CC-only)** — attach/detach, orientation (CC1/CC2), and power-role presence (Rp/Rd).
8+
Backed by **HUSB320** (Type-C CC controller; **no PD**).
9+
- **USB Power Delivery (PD-only)** — PD negotiation, runtime power-role control, fixed/PPS sink requests, and contract reporting.
10+
Backed by **FUSB302** (PD-capable TCPC).
11+
12+
The split keeps builds small, avoids unnecessary coupling, and mirrors esp-usb / esp-idf style.
13+
14+
---
15+
16+
## Contents
17+
18+
- [`include/esp_typec.h`](./include/esp_typec.h)**Type-C Core (CC-only)** public API
19+
- [`include/esp_typec_pd.h`](./include/esp_typec_pd.h)**PD-only** public API
20+
- `src/` — stub sources to make the component build; real backends land incrementally
21+
- `CMakeLists.txt`, `idf_component.yml` — component metadata
22+
23+
> New files use:
24+
> `/* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD */`
25+
> `/* SPDX-License-Identifier: Apache-2.0 */`
26+
27+
---
28+
29+
## Supported Controllers
30+
31+
| Controller | Capability | API / Factory Function | Notes |
32+
|-----------:|------------|-----------------------------------------------------------|--------------------------------|
33+
| HUSB320 | Type-C CC | `esp_typec_port_create_husb320()` (in `esp_typec.h`) | CC attach/orientation only |
34+
| FUSB302 | PD (TCPC) | `esp_typec_pd_port_create_fusb302()` (in `esp_typec_pd.h`)| Full PD PHY over CC (BMC) |
35+
36+
> **Not supported here:** CC-only parts for PD; they cannot negotiate PD by design.
37+
> Additional PD-capable TCPCs (e.g., PTN5110/TCPM family) can be added later using the same factory pattern.
38+
39+
---
40+
41+
## Quick Start
42+
43+
### 1) Type-C Core (CC-only) with HUSB320
44+
45+
```c
46+
#include "esp_typec.h"
47+
48+
static void on_typec(esp_typec_event_t evt, const void *payload, void *arg)
49+
{
50+
switch (evt) {
51+
case ESP_TYPEC_EVENT_ATTACHED: {
52+
const esp_typec_evt_attached_t *a = payload;
53+
// a->flags & ESP_TYPEC_FLAG_CC2 -> polarity
54+
// a->rp_cur_ma -> advertised current (if known)
55+
break;
56+
}
57+
case ESP_TYPEC_EVENT_ORIENTATION: {
58+
const bool *cc2_active = payload;
59+
(void)cc2_active;
60+
break;
61+
}
62+
case ESP_TYPEC_EVENT_DETACHED:
63+
default: break;
64+
}
65+
}
66+
67+
void app_main(void)
68+
{
69+
ESP_ERROR_CHECK(esp_typec_install());
70+
71+
esp_typec_port_config_t port_cfg = {
72+
.default_power_role = ESP_TYPEC_PWR_SINK,
73+
.try_snk = true,
74+
.try_src = false,
75+
.task_stack = 0,
76+
.task_prio = 0,
77+
};
78+
esp_typec_husb320_config_t hw = {
79+
.i2c_port = 0, .i2c_addr = 0x60, .gpio_int = 4, .use_intr = true,
80+
};
81+
esp_typec_port_handle_t h;
82+
ESP_ERROR_CHECK(esp_typec_port_create_husb320(&port_cfg, &hw, on_typec, NULL, &h));
83+
84+
// Optional: request a role change (sets Rp/Rd)
85+
ESP_ERROR_CHECK(esp_typec_set_power_role(h, ESP_TYPEC_PWR_DRP));
86+
}
87+
```
88+
89+
### 1) Power Delivery (PD) with FUSB302
90+
91+
```c
92+
#include "esp_typec_pd.h"
93+
94+
static void on_pd(esp_typec_pd_event_t evt, const void *payload, void *arg)
95+
{
96+
switch (evt) {
97+
case ESP_TYPEC_PD_EVENT_CONTRACT_READY: {
98+
const esp_typec_pd_contract_t *c = payload;
99+
// c->mv, c->ma, c->selected_pdo, c->flags (PPS/CC2)
100+
break;
101+
}
102+
case ESP_TYPEC_PD_EVENT_ATTACHED:
103+
case ESP_TYPEC_PD_EVENT_DETACHED:
104+
default: break;
105+
}
106+
}
107+
108+
void app_main(void)
109+
{
110+
esp_typec_pd_install_config_t lib_cfg = {
111+
.skip_ctrl_intr_alloc = false,
112+
.intr_flags = 0,
113+
};
114+
ESP_ERROR_CHECK(esp_typec_pd_install(&lib_cfg));
115+
116+
esp_typec_pd_port_config_t port_cfg = {
117+
.default_power_role = ESP_TYPEC_PD_PWR_SINK,
118+
.sink_i_min_ma = 500,
119+
.sink_fixed_pref_mv = 9000, // 0 = auto select best
120+
.enable_pps = true,
121+
.sink_pps_v_min_mv = 5000, .sink_pps_v_max_mv = 11000, .sink_pps_i_max_ma = 2000,
122+
.src_pdos = NULL, .src_pdo_count = 0,
123+
.task_stack = 0, .task_prio = 0,
124+
};
125+
esp_typec_pd_fusb302_config_t hw = {
126+
.i2c_port = 0, .i2c_addr = 0x22, .gpio_int = 5, .use_intr = true,
127+
};
128+
esp_typec_pd_port_handle_t h;
129+
ESP_ERROR_CHECK(esp_typec_pd_port_create_fusb302(&port_cfg, &hw, on_pd, NULL, &h));
130+
131+
// Example: request a specific Fixed PDO after Source_Capabilities are received
132+
// ESP_ERROR_CHECK(esp_typec_pd_sink_request_fixed(h, 9000, 2000));
133+
}
134+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
cmake_minimum_required(VERSION 3.16)
2+
3+
# Tell IDF where to find the local "type_c" component (two levels up).
4+
# This lets the example depend on your in-tree component without copying it.
5+
set(EXTRA_COMPONENT_DIRS "${CMAKE_CURRENT_LIST_DIR}/../..")
6+
7+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
8+
project(pd_fusb302_attach)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
idf_component_register(SRCS "main.c"
2+
PRIV_REQUIRES esp_driver_i2c
3+
REQUIRES type_c)

0 commit comments

Comments
 (0)