Skip to content

Latest commit

 

History

History
90 lines (51 loc) · 2.5 KB

macos-setup-scratch.rst

File metadata and controls

90 lines (51 loc) · 2.5 KB

Setup Toolchain for Mac OS from Scratch

:link_to_translation:`zh_CN:[中文]`

Package Manager

To set up the toolchain from scratch, rather than :doc:`downloading a pre-compiled toolchain<macos-setup>`, you will need to install either the MacPorts or homebrew package manager.

MacPorts needs a full XCode installation, while homebrew only needs XCode command line tools.

See :ref:`Customized Setup of Toolchain <get-started-customized-setup>` section for some of the reasons why installing the toolchain from scratch may be necessary.

Install Prerequisites

  • install pip:

    sudo easy_install pip
    
  • install pyserial:

    pip install --user pyserial
    
  • install CMake & Ninja build:

    • If you have HomeBrew, you can run:

      brew install cmake ninja
      
    • If you have MacPorts, you can run:

      sudo port install cmake ninja
      

Compile the Toolchain from Source

  • Install dependencies:

    • with MacPorts:

      sudo port install gsed gawk binutils gperf grep gettext wget libtool autoconf automake make
      
    • with homebrew:

      brew install gnu-sed gawk binutils gperftools gettext wget help2man libtool autoconf automake make
      

Create a case-sensitive filesystem image:

hdiutil create ~/esp/crosstool.dmg -volname "ctng" -size 10g -fs "Case-sensitive HFS+"

Mount it:

hdiutil mount ~/esp/crosstool.dmg

Create a symlink to your work directory:

mkdir -p ~/esp
ln -s /Volumes/ctng ~/esp/ctng-volume

Go into the newly created directory:

cd ~/esp/ctng-volume

Download crosstool-NG and build it:

Build the toolchain:

./ct-ng xtensa-esp32-elf
./ct-ng build
chmod -R u+w builds/xtensa-esp32-elf

Toolchain will be built in ~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf. To use it, you need to add ~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf/bin to PATH environment variable.

Python 2 deprecation

Python 2 reached its end of life and support for it in ESP-IDF will be removed soon. Please install Python 3.6 or higher. Instructions for macOS are listed above.

Next Steps

To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.