Add basic support for the ESP32 #96131

taktoa · 2020-08-24T01:56:47Z

Motivation for this change

Created a basic cross-compilation toolchain for the ESP32 microcontroller.

To test, try running flash.bash after cloning https://github.com/taktoa/esp32-baremetal (assuming you have an ESP32 microcontroller connected on /dev/ttyUSB0 and your current user is in the dialout group). Then do:

$ stty -F /dev/ttyUSB0 180:4:18b2:8a20:3:1c:7f:15:4:0:1:0:11:13:1a:0:12:f:17:16:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0
$ cat /dev/ttyUSB0

and you should see a spam of "hello, world!".

I tested with the SparkFun ESP32 Thing, for other boards YMMV, though I don't know of any reason why it might not work.

CC: @Ericson2314 @cleverca22 @bgamari

Things done

lheckemann

I absolutely love the idea of building my ESP32 firmware with nix! I have some little implementation niggles, but thank you for this!

lheckemann · 2020-08-24T16:52:08Z

pkgs/development/compilers/gcc/8/default.nix

@@ -1,4 +1,4 @@
-{ stdenv, targetPackages, fetchurl, fetchpatch, noSysDirs
+{ stdenv, targetPackages, fetchurl, fetchFromGitHub, fetchpatch, noSysDirs


I'm not sure I like the idea of introducing all this very specific stuff in the generic gcc8 expression. At a glance, this looks to me like all these changes can be achieved using overrides? And in that case I think it would be better to have a separate expression file containing these overrides, and using the overridden version to define the stdenv for this platform.

Sorry for the delay; it is indeed not trivially clear where this should go — maybe @Ericson2314 and/or @matthewbauer can provide some input, being familiar with stdenv/bootstrapping stuff?

Possibly here:

nixpkgs/pkgs/stdenv/cross/default.nix

Lines 56 to 68 in 04cea8b

cc = if crossSystem.useiOSPrebuilt or false

then buildPackages.darwin.iosSdkPkgs.clang

else if crossSystem.useAndroidPrebuilt or false

then buildPackages."androidndkPkgs_${crossSystem.ndkVer}".clang

else if targetPlatform.isGhcjs

# Need to use `throw` so tryEval for splicing works, ugh. Using

# `null` or skipping the attribute would cause an eval failure

# `tryEval` wouldn't catch, wrecking accessing previous stages

# when there is a C compiler and everything should be fine.

then throw "no C compiler provided for this platform"

else if crossSystem.useLLVM or false

then buildPackages.llvmPackages_8.lldClang

else buildPackages.gcc;

I am also for putting this behind a different attribute and use overrides.

@lheckemann I think it's fine. See the very similar changes for VC4 and Redox for GCC 6. If we could break up the GCC derivation like we do with the LLVM family of projects, we could do better, but we haven't done that yet so I think GCC is just kinda doomed to be messier.

lheckemann · 2020-08-24T16:52:30Z

pkgs/development/misc/newlib/default.nix

@@ -1,10 +1,23 @@
-{ stdenv, fetchurl, buildPackages }:
+{ stdenv, fetchurl, fetchFromGitHub, buildPackages }:


Likewise, I think an override would be nicer here.

It could go in a separate file, taking "regular" newlib as an arg and overriding it, then put into place like here:

nixpkgs/pkgs/top-level/all-packages.nix

Lines 12495 to 12513 in 04cea8b

libcCrossChooser = name:

# libc is hackily often used from the previous stage. This `or`

# hack fixes the hack, *sigh*.

/**/ if name == "glibc" then targetPackages.glibcCross or glibcCross

else if name == "bionic" then targetPackages.bionic or bionic

else if name == "uclibc" then targetPackages.uclibcCross or uclibcCross

else if name == "avrlibc" then targetPackages.avrlibcCross or avrlibcCross

else if name == "newlib" && stdenv.targetPlatform.isMsp430 then targetPackages.msp430NewlibCross or msp430NewlibCross

else if name == "newlib" && stdenv.targetPlatform.isVc4 then targetPackages.vc4-newlib or vc4-newlib

else if name == "newlib" then targetPackages.newlibCross or newlibCross

else if name == "musl" then targetPackages.muslCross or muslCross

else if name == "msvcrt" then targetPackages.windows.mingw_w64 or windows.mingw_w64

else if stdenv.targetPlatform.useiOSPrebuilt then targetPackages.darwin.iosSdkPkgs.libraries or darwin.iosSdkPkgs.libraries

else if name == "libSystem" then targetPackages.darwin.xcode

else if name == "nblibc" then targetPackages.netbsdCross.libc

else if name == "wasilibc" then targetPackages.wasilibc or wasilibc

else if name == "relibc" then targetPackages.relibc or relibc

else if stdenv.targetPlatform.isGhcjs then null

else throw "Unknown libc ${name}";

bgamari · 2020-08-24T18:37:48Z

Indeed, this looks great.

Also relevant: https://github.com/bgamari/esp32.nix.

Mic92 · 2020-09-12T11:50:17Z

Good to see esp-idf working, setting up the SDK was such a pain!

Mic92 · 2020-09-12T12:02:08Z

I also found that we have some tutorials in the wiki: https://nixos.wiki/wiki/ESP-IDF#See_also
Maybe this can be updated to use esp32.nix instead.

Ericson2314 · 2020-11-18T04:53:38Z

Someone wanna rebase this? I would have merged it but for the conflicts, being more laxed than the others.

taktoa · 2020-11-18T04:54:47Z

Sorry, I'm kind of busy right now, but if anyone has the time and interest I'd welcome help.

Ericson2314 · 2020-11-18T04:59:37Z

I think a few other people were interested, so 🤞.

plietar · 2021-02-07T14:07:38Z

I have a new rebased version of this PR, along with some minor improvements. What’s the best way to proceed? Should I open a new PR for it?

Mic92 · 2021-02-07T15:56:35Z

I have a new rebased version of this PR, along with some minor improvements. What’s the best way to proceed? Should I open a new PR for it?

sure.

taktoa · 2021-02-07T19:30:12Z

Feel free to open a new PR; I'll close this one

plietar · 2021-02-08T13:59:30Z

Opened #112401.

Add basic support for the ESP32

e73a0fa

taktoa requested review from Ericson2314, matthewbauer and nbp as code owners August 24, 2020 01:56

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Aug 24, 2020

lheckemann reviewed Aug 24, 2020

View reviewed changes

sorki mentioned this pull request Aug 26, 2020

convert default.nix to overlay.nix, add shell-esp-open-rtos.nix mirrexagon/nixpkgs-esp-dev#2

Merged

ehmry added the 6.topic: exotic Exotic hardware or software platform label Nov 3, 2020

SuperSandro2000 added the 2.status: merge conflict label Jan 18, 2021

taktoa closed this Feb 7, 2021

plietar mentioned this pull request Feb 8, 2021

Add support for cross compiling to ESP MCUs #112401

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic support for the ESP32 #96131

Add basic support for the ESP32 #96131

taktoa commented Aug 24, 2020 •

edited

lheckemann left a comment

lheckemann Aug 24, 2020

lheckemann Sep 2, 2020

lheckemann Sep 12, 2020

Mic92 Sep 12, 2020

Ericson2314 Sep 12, 2020

lheckemann Aug 24, 2020

lheckemann Sep 12, 2020 •

edited

bgamari commented Aug 24, 2020

Mic92 commented Sep 12, 2020

Mic92 commented Sep 12, 2020

Ericson2314 commented Nov 18, 2020 •

edited

taktoa commented Nov 18, 2020

Ericson2314 commented Nov 18, 2020

plietar commented Feb 7, 2021

Mic92 commented Feb 7, 2021

taktoa commented Feb 7, 2021

plietar commented Feb 8, 2021

		@@ -1,4 +1,4 @@
		{ stdenv, targetPackages, fetchurl, fetchpatch, noSysDirs
		{ stdenv, targetPackages, fetchurl, fetchFromGitHub, fetchpatch, noSysDirs

	cc = if crossSystem.useiOSPrebuilt or false
	then buildPackages.darwin.iosSdkPkgs.clang
	else if crossSystem.useAndroidPrebuilt or false
	then buildPackages."androidndkPkgs_${crossSystem.ndkVer}".clang
	else if targetPlatform.isGhcjs
	# Need to use `throw` so tryEval for splicing works, ugh. Using
	# `null` or skipping the attribute would cause an eval failure
	# `tryEval` wouldn't catch, wrecking accessing previous stages
	# when there is a C compiler and everything should be fine.
	then throw "no C compiler provided for this platform"
	else if crossSystem.useLLVM or false
	then buildPackages.llvmPackages_8.lldClang
	else buildPackages.gcc;

		@@ -1,10 +1,23 @@
		{ stdenv, fetchurl, buildPackages }:
		{ stdenv, fetchurl, fetchFromGitHub, buildPackages }:

	libcCrossChooser = name:
	# libc is hackily often used from the previous stage. This `or`
	# hack fixes the hack, sigh.
	/**/ if name == "glibc" then targetPackages.glibcCross or glibcCross
	else if name == "bionic" then targetPackages.bionic or bionic
	else if name == "uclibc" then targetPackages.uclibcCross or uclibcCross
	else if name == "avrlibc" then targetPackages.avrlibcCross or avrlibcCross
	else if name == "newlib" && stdenv.targetPlatform.isMsp430 then targetPackages.msp430NewlibCross or msp430NewlibCross
	else if name == "newlib" && stdenv.targetPlatform.isVc4 then targetPackages.vc4-newlib or vc4-newlib
	else if name == "newlib" then targetPackages.newlibCross or newlibCross
	else if name == "musl" then targetPackages.muslCross or muslCross
	else if name == "msvcrt" then targetPackages.windows.mingw_w64 or windows.mingw_w64
	else if stdenv.targetPlatform.useiOSPrebuilt then targetPackages.darwin.iosSdkPkgs.libraries or darwin.iosSdkPkgs.libraries
	else if name == "libSystem" then targetPackages.darwin.xcode
	else if name == "nblibc" then targetPackages.netbsdCross.libc
	else if name == "wasilibc" then targetPackages.wasilibc or wasilibc
	else if name == "relibc" then targetPackages.relibc or relibc
	else if stdenv.targetPlatform.isGhcjs then null
	else throw "Unknown libc ${name}";

Add basic support for the ESP32 #96131

Add basic support for the ESP32 #96131

Conversation

taktoa commented Aug 24, 2020 • edited

Motivation for this change

Things done

lheckemann left a comment

Choose a reason for hiding this comment

lheckemann Aug 24, 2020

Choose a reason for hiding this comment

lheckemann Sep 2, 2020

Choose a reason for hiding this comment

lheckemann Sep 12, 2020

Choose a reason for hiding this comment

Mic92 Sep 12, 2020

Choose a reason for hiding this comment

Ericson2314 Sep 12, 2020

Choose a reason for hiding this comment

lheckemann Aug 24, 2020

Choose a reason for hiding this comment

lheckemann Sep 12, 2020 • edited

Choose a reason for hiding this comment

bgamari commented Aug 24, 2020

Mic92 commented Sep 12, 2020

Mic92 commented Sep 12, 2020

Ericson2314 commented Nov 18, 2020 • edited

taktoa commented Nov 18, 2020

Ericson2314 commented Nov 18, 2020

plietar commented Feb 7, 2021

Mic92 commented Feb 7, 2021

taktoa commented Feb 7, 2021

plietar commented Feb 8, 2021

taktoa commented Aug 24, 2020 •

edited

lheckemann Sep 12, 2020 •

edited

Ericson2314 commented Nov 18, 2020 •

edited