Skip to content

Commit f918406

Browse files
authored
Merge pull request #2454 from hathach/fix-esp-build
Fix esp build
2 parents c151da6 + 7ab39cd commit f918406

26 files changed

+2155
-292
lines changed

.github/workflows/build_esp.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
uses: actions/checkout@v4
4949

5050
- name: Build
51-
run: docker run --rm -v $PWD:/project -w /project espressif/idf:latest python3 tools/build_esp32.py ${{ matrix.board }}
51+
run: docker run --rm -v $PWD:/project -w /project espressif/idf:v5.1.1 python3 tools/build_esp32.py ${{ matrix.board }}
5252

5353
- name: Upload Artifacts for Hardware Testing
5454
if: matrix.board == 'espressif_s3_devkitc' && github.repository_owner == 'hathach'

hw/bsp/espressif/boards/family.c

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
#include "hal/usb_hal.h"
3434
#include "soc/usb_periph.h"
3535

36-
#include "driver/rmt.h"
36+
#include "driver/gpio.h"
3737
#include "driver/uart.h"
3838

3939
#if ESP_IDF_VERSION_MAJOR > 4
@@ -48,7 +48,7 @@
4848

4949
#ifdef NEOPIXEL_PIN
5050
#include "led_strip.h"
51-
static led_strip_t* strip;
51+
static led_strip_handle_t led_strip;
5252
#endif
5353

5454
#if CFG_TUH_ENABLED && CFG_TUH_MAX3421
@@ -85,15 +85,23 @@ void board_init(void) {
8585
#endif
8686

8787
// WS2812 Neopixel driver with RMT peripheral
88-
rmt_config_t config = RMT_DEFAULT_CONFIG_TX(NEOPIXEL_PIN, RMT_CHANNEL_0);
89-
config.clk_div = 2; // set counter clock to 40MHz
88+
led_strip_rmt_config_t rmt_config = {
89+
.clk_src = RMT_CLK_SRC_DEFAULT, // different clock source can lead to different power consumption
90+
.resolution_hz = 10 * 1000 * 1000, // RMT counter clock frequency, default = 10 Mhz
91+
.flags.with_dma = false, // DMA feature is available on ESP target like ESP32-S3
92+
};
93+
94+
led_strip_config_t strip_config = {
95+
.strip_gpio_num = NEOPIXEL_PIN, // The GPIO that connected to the LED strip's data line
96+
.max_leds = 1, // The number of LEDs in the strip,
97+
.led_pixel_format = LED_PIXEL_FORMAT_GRB, // Pixel format of your LED strip
98+
.led_model = LED_MODEL_WS2812, // LED strip model
99+
.flags.invert_out = false, // whether to invert the output signal
100+
};
90101

91-
rmt_config(&config);
92-
rmt_driver_install(config.channel, 0, 0);
102+
ESP_ERROR_CHECK(led_strip_new_rmt_device(&strip_config, &rmt_config, &led_strip));
93103

94-
led_strip_config_t strip_config = LED_STRIP_DEFAULT_CONFIG(1, (led_strip_dev_t) config.channel);
95-
strip = led_strip_new_rmt_ws2812(&strip_config);
96-
strip->clear(strip, 100); // off led
104+
led_strip_clear(led_strip); // off
97105
#endif
98106

99107
// Button
@@ -158,8 +166,8 @@ size_t board_get_unique_id(uint8_t id[], size_t max_len) {
158166

159167
void board_led_write(bool state) {
160168
#ifdef NEOPIXEL_PIN
161-
strip->set_pixel(strip, 0, state ? 0x08 : 0x00, 0x00, 0x00);
162-
strip->refresh(strip, 100);
169+
led_strip_set_pixel(led_strip, 0, state ? 0x08 : 0x00, 0x00, 0x00);
170+
led_strip_refresh(led_strip);
163171
#endif
164172
}
165173

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## 2.5.0
2+
3+
- Enabled support for IDF4.4 and above
4+
- with RMT backend only
5+
- Added API `led_strip_set_pixel_hsv`
6+
7+
## 2.4.0
8+
9+
- Support configurable SPI mode to control leds
10+
- recommend enabling DMA when using SPI mode
11+
12+
## 2.3.0
13+
14+
- Support configurable RMT channel size by setting `mem_block_symbols`
15+
16+
## 2.2.0
17+
18+
- Support for 4 components RGBW leds (SK6812):
19+
- in led_strip_config_t new fields
20+
led_pixel_format, controlling byte format (LED_PIXEL_FORMAT_GRB, LED_PIXEL_FORMAT_GRBW)
21+
led_model, used to configure bit timing (LED_MODEL_WS2812, LED_MODEL_SK6812)
22+
- new API led_strip_set_pixel_rgbw
23+
- new interface type set_pixel_rgbw
24+
25+
## 2.1.0
26+
27+
- Support DMA feature, which offloads the CPU by a lot when it comes to drive a bunch of LEDs
28+
- Support various RMT clock sources
29+
- Acquire and release the power management lock before and after each refresh
30+
- New driver flag: `invert_out` which can invert the led control signal by hardware
31+
32+
## 2.0.0
33+
34+
- Reimplemented the driver using the new RMT driver (`driver/rmt_tx.h`)
35+
36+
## 1.0.0
37+
38+
- Initial driver version, based on the legacy RMT driver (`driver/rmt.h`)
Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
1-
set(component_srcs "src/led_strip_rmt_ws2812.c")
1+
include($ENV{IDF_PATH}/tools/cmake/version.cmake)
22

3-
idf_component_register(SRCS "${component_srcs}"
4-
INCLUDE_DIRS "include"
5-
PRIV_INCLUDE_DIRS ""
6-
PRIV_REQUIRES "driver"
7-
REQUIRES "")
3+
set(srcs "src/led_strip_api.c")
4+
5+
if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.0")
6+
if(CONFIG_SOC_RMT_SUPPORTED)
7+
list(APPEND srcs "src/led_strip_rmt_dev.c" "src/led_strip_rmt_encoder.c")
8+
endif()
9+
else()
10+
list(APPEND srcs "src/led_strip_rmt_dev_idf4.c")
11+
endif()
12+
13+
# the SPI backend driver relies on something that was added in IDF 5.1
14+
if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.1")
15+
if(CONFIG_SOC_GPSPI_SUPPORTED)
16+
list(APPEND srcs "src/led_strip_spi_dev.c")
17+
endif()
18+
endif()
19+
20+
idf_component_register(SRCS ${srcs}
21+
INCLUDE_DIRS "include" "interface"
22+
REQUIRES "driver")
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.

0 commit comments

Comments
 (0)