Updated README.md for IDF v4.1

catalinio · catalinio · commit 6904824ed15b · 2021-03-04T14:18:17.000+02:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 The MicroPython project
 =======================
 <p align="center">
-  <img src="https://raw.githubusercontent.com/pycom/LoPy/master/images/LopySide.jpg" alt="The LoPy"/>
+  <img src="https://pycom.io/wp-content/uploads/2018/08/fipySide.png" alt="The FiPy"/>
 </p>
 
 This is the MicroPython project, which aims to put an implementation
@@ -41,7 +41,7 @@ Additional components:
 The subdirectories above may include READMEs with additional info.
 
 "make" is used to build the components, or "gmake" on BSD-based systems.
-You will also need bash and Python (at least 2.7 or 3.3).
+You will also need bash and Python 3.
 
 The ESP32 version
 -----------------
@@ -51,15 +51,16 @@ the Espressif website:
 
 - for 64-bit Linux::
 
-    https://dl.espressif.com/dl/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz
+    https://dl.espressif.com/dl/xtensa-esp32-elf-gcc8_4_0-esp-2020r3-linux-amd64.tar.gz
 
 - for 32-bit Linux::
 
-    https://dl.espressif.com/dl/xtensa-esp32-elf-linux32-1.22.0-80-g6c4433a-5.2.0.tar.gz
+    https://dl.espressif.com/dl/xtensa-esp32s2-elf-gcc8_4_0-esp-2020r3-linux-i686.tar.gz
 
 - for Mac OS:
 
-    https://dl.espressif.com/dl/xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz
+    https://dl.espressif.com/dl/xtensa-esp32-elf-gcc8_4_0-esp-2020r3-macos.tar.gz
+
 
 To use it, you will need to update your ``PATH`` environment variable in ``~/.bash_profile`` file. To make ``xtensa-esp32-elf`` available for all terminal sessions, add the following line to your ``~/.bash_profile`` file::
 
@@ -74,7 +75,7 @@ Then when you need the toolchain you can type ``get_esp32`` on the command line
 You also need the ESP IDF along side this repository in order to build the ESP32 port.
 To get it:
 
-    $ git clone --recursive -b idf_v3.3.1 https://github.com/pycom/pycom-esp-idf.git
+    $ git clone --recursive -b idf_v4.1_ml_ota https://github.com/pycom/pycom-esp-idf.git
 
 After cloning, if you did not specify the --recursive option, make sure to checkout all the submodules:
 
@@ -128,8 +129,7 @@ By default, both bootloader and application are built. To build them separately:
 
     $ cd esp32
     $ make clean
-    $ make TARGET=boot
-    $ make TARGET=app
+    $ make release
     $ make flash
 
 You can change the board type by using the BOARD variable:
@@ -141,7 +141,7 @@ You can change the board type by using the BOARD variable:
 
 We currently support the following BOARD types:
 
-	WIPY LOPY SIPY GPY FIPY LOPY4
+	WIPY LOPY GPY FIPY LOPY4
 	
 For OEM modules, please use the following BOARD type:
 
@@ -155,7 +155,7 @@ G01: GPY
 To specify a serial port other than /dev/ttyUSB0, use ESPPORT variable:
 
     $ # On MacOS
-    $ make ESPPORT=/dev/tty.usbserial-DQ008HQY flash
+    $ make ESPPORT=/dev/tty.usbmodemPy8eaa911 flash
     $ # On Windows
     $ make ESPPORT=COM3 flash
     $ # On linux
@@ -179,7 +179,7 @@ To create a release package that can be flashed with the Pycom firmware tool:
 To create a release package for all currently supported Pycom boards:
 
     $ cd esp32
-    $ for BOARD in WIPY LOPY SIPY GPY FIPY LOPY4; do make BOARD=$BOARD clean && make BOARD=$BOARD release; done
+    $ for BOARD in WIPY LOPY GPY FIPY LOPY4; do make BOARD=$BOARD clean && make BOARD=$BOARD release; done
 
 To specify a directory other than the default build/ directory:
 
@@ -190,7 +190,7 @@ To specify a directory other than the default build/ directory:
 To create a release package for all currently supported Pycom boards in a directory other than the default build/ directory:
 
     $ cd esp32
-    $ for BOARD in WIPY LOPY SIPY GPY FIPY LOPY4; do make BOARD=$BOARD clean && make BOARD=$BOARD RELEASE_DIR=~/pycom-packages release; done
+    $ for BOARD in WIPY LOPY GPY FIPY LOPY4; do make BOARD=$BOARD clean && make BOARD=$BOARD RELEASE_DIR=~/pycom-packages release; done
 
 To inclue a step for copying IDF libs from IDF_PATH specify the following variable in the make command
 
@@ -206,81 +206,4 @@ To Disable RGB Led control use the following make variable
 
 ## Steps for using Secure Boot and Flash Encryption
 
-### Summary
-
-1. Obtain keys (for Secure Boot and Flash Encryption)
-2. Flash keys and parameters in efuses
-3. Compile bootloader and application with `make SECURE=on`
-4. Flash: bootloader-digest at address 0x0 and encrypted; all the others (partitions and application) encrypted, too.
-
-### Prerequisites
-
-    $ export IDF_PATH=<pycom-esp-idf_PATH>
-    $ cd esp32
-
-Hold valid keys for Flash Encryption and Secure Boot; they can be generated randomly with the following commands:
-
-    python $IDF_PATH/components/esptool_py/esptool/espsecure.py generate_flash_encryption_key flash_encryption_key.bin
-    python $IDF_PATH/components/esptool_py/esptool/espsecure.py generate_signing_key secure_boot_signing_key.pem
-
-The Secure Boot key `secure_boot_signing_key.pem` has to be transformed into `secure-bootloader-key.bin`, to be burnt into efuses. This can be done in 2 ways:
-
-    python $IDF_PATH/components/esptool_py/esptool/espefuse.py extract_public_key --keyfile secure_boot_signing_key.pem signature_verification_key.bin
-
-    # or, as an artifact of the make build process, on the same directory level as Makefile
-    make BOARD=GPY SECURE=on TARGET=boot
-
-Flash keys (`flash_encryption_key.bin` and `secure-bootloader-key.bin`) into the efuses (write and read protected):
-
-**_Note: Irreversible operations_**
-
-    # Burning Encryption Key
-    python $IDF_PATH/components/esptool_py/esptool/espefuse.py --port /dev/ttyUSB0 burn_key flash_encryption flash_encryption_key.bin
-    # Burning Secure Boot Key
-    python $IDF_PATH/components/esptool_py/esptool/espefuse.py --port /dev/ttyUSB0 burn_key secure_boot secure-bootloader-key.bin
-    # Enabling Flash Encryption mechanism
-    python $IDF_PATH/components/esptool_py/esptool/espefuse.py --port /dev/ttyUSB0 burn_efuse FLASH_CRYPT_CNT
-    # Configuring Flash Encryption to use all address bits togheter with Encryption key (max value 0x0F)
-    python $IDF_PATH/components/esptool_py/esptool/espefuse.py --port /dev/ttyUSB0 burn_efuse FLASH_CRYPT_CONFIG 0x0F
-    # Enabling Secure Boot mechanism
-    python $IDF_PATH/components/esptool_py/esptool/espefuse.py --port /dev/ttyUSB0 burn_efuse ABS_DONE_0
-
-**_If the keys are not written in efuse, before flashing the bootloader, then random keys will be generated by the ESP32, they can never be read nor re-written, so bootloader can never be updated. Even more, the application can be re-flashed (by USB) just 3 more times._**
-
-### Makefile options:
-
-    make BOARD=GPY SECURE=on SECURE_KEY=secure_boot_signing_key.pem ENCRYPT_KEY=flash_encryption_key.bin
-
-- `SECURE=on` is the main flag; it's not optional
-- if `SECURE=on` by default:
-    - encryption is enabled        
-    - secure_boot_signing_key.pem is the secure boot key, located relatively to Makefile
-    - flash_encryption_key.bin is the flash encryption key, located relatively to Makefile
-
-For flashing the bootloader digest and the encrypted versions of all binaries:
-
-    make BOARD=GPY SECURE=on flash
-
-### Flashing
-
-For flashing the bootloader-reflash-digest.bin has to be written at address 0x0, instead of the bootloader.bin (at address 0x1000).
-
-Build is done using `SECURE=on` option; additionally, all the binaries are pre-encrypted.
-
-    make BOARD=GPY clean
-    make BOARD=GPY SECURE=on
-    make BOARD=GPY SECURE=on flash
-
-Manual flash command:
-
-    python $IDF_PATH/components/esptool_py/esptool/esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 921600 --before no_reset --after no_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size detect 0x0 build/GPY/release/bootloader/bootloader-reflash-digest.bin_enc 0x8000 build/GPY/release/lib/partitions.bin_enc 0x10000 build/GPY/release/gpy.bin_enc_0x10000
-
-### OTA update
-
-The OTA should be done using the pre-encrypted application image.
-
-Because the encryption is done based on the physical flash address, there are 2 application binaries generated:
-- gpy.bin_enc_0x10000 which has to be written at default factory address: 0x10000
-- gpy.bin_enc_0x1A0000 which has to be written at the ota_0 partition address (0x1A0000)
-
-*__Hint:__ on micropython interface, the method `pycom.ota_slot()` responds with the address of the next OTA partition available (either 0x10000 or 0x1A0000).*
+For Secure Boot and Flash Encryption please check: https://docs.pycom.io/advance/encryption/
