Initial updates for ESP-IDF v4.2

2021-01-21 13:42:23 +02:00
parent e542df17d1
commit 7e5f3f56fa
26 changed files with 754 additions and 110 deletions
@@ -0,0 +1 @@
+.pio
@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N
@@ -0,0 +1,6 @@
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(tusb_sample_descriptor)
@@ -0,0 +1,32 @@
+..  Copyright 2014-present PlatformIO <contact@platformio.org>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+How to build PlatformIO based project
+=====================================
+
+1. `Install PlatformIO Core <http://docs.platformio.org/page/core.html>`_
+2. Download `development platform with examples <https://github.com/platformio/platform-espressif32/archive/develop.zip>`_
+3. Extract ZIP archive
+4. Run these commands:
+
+.. code-block:: bash
+
+    # Change directory to example
+    > cd platform-espressif32/examples/espidf-peripherals-usb
+
+    # Build project
+    > platformio run
+
+    # Upload firmware
+    > platformio run --target upload
+
+    # Clean build files
+    > platformio run --target clean
@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html
@@ -0,0 +1,19 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter, extra scripting
+;   Upload options: custom port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;
+; Please visit documentation for the other options and examples
+; http://docs.platformio.org/page/projectconf.html
+
+[env]
+platform = espressif32
+framework = espidf
+monitor_speed = 115200
+
+[env:esp32-s2-saola-1]
+board = esp32-s2-saola-1
+
+[env:esp32-s2-kaluga-1]
+board = esp32-s2-kaluga-1
@@ -0,0 +1,6 @@
+CONFIG_IDF_TARGET="esp32s2"
+CONFIG_USB_ENABLED=y
+CONFIG_USB_DESC_USE_ESPRESSIF_VID=n
+CONFIG_USB_DESC_CUSTOM_VID=0x303A
+CONFIG_USB_DESC_USE_DEFAULT_PID=n
+CONFIG_USB_DESC_CUSTOM_PID=0x3000
@@ -0,0 +1,2 @@
+idf_component_register(SRCS "tusb_sample_descriptor.c"
+                       INCLUDE_DIRS . ${COMPONENT_DIR})
@@ -0,0 +1,10 @@
+menu "Example Configuration"
+
+    config EXAMPLE_MANUAL_DESC
+        bool "Set up a USB descriptor manually in code"
+        default y
+        help
+            You can set up a descriptor using Menuconfig or independently of
+            your project configuration - manually in code
+
+endmenu
@@ -0,0 +1,84 @@
+/* USB Example
+
+   This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+   Unless required by applicable law or agreed to in writing, this
+   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+   CONDITIONS OF ANY KIND, either express or implied.
+*/
+
+#include <stdlib.h>
+#include "esp_log.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "driver/gpio.h"
+#include "sdkconfig.h"
+#include "tinyusb.h"
+
+static const char *TAG = "example";
+
+// USB Device Driver task
+// This top level thread processes all usb events and invokes callbacks
+static void usb_device_task(void *param) {
+    (void)param;
+    ESP_LOGI(TAG, "USB task started");
+    while (1) {
+        tud_task(); // RTOS forever loop
+    }
+}
+
+void app_main(void) {
+
+    ESP_LOGI(TAG, "USB initialization");
+
+#if CONFIG_EXAMPLE_MANUAL_DESC
+    // Setting of descriptor. You can use descriptor_tinyusb and
+    // descriptor_str_tinyusb as a reference
+    tusb_desc_device_t my_descriptor = {
+        .bLength = sizeof(my_descriptor),
+        .bDescriptorType = TUSB_DESC_DEVICE,
+        .bcdUSB = 0x0200, // USB version. 0x0200 means version 2.0
+        .bDeviceClass = TUSB_CLASS_UNSPECIFIED,
+        .bMaxPacketSize0 = CFG_TUD_ENDOINT0_SIZE,
+
+        .idVendor = 0x303A,
+        .idProduct = 0x3000,
+        .bcdDevice = 0x0101, // Device FW version
+
+        .iManufacturer = 0x01, // see string_descriptor[1] bellow
+        .iProduct = 0x02,      // see string_descriptor[2] bellow
+        .iSerialNumber = 0x03, // see string_descriptor[3] bellow
+
+        .bNumConfigurations = 0x01};
+
+    tusb_desc_strarray_device_t my_string_descriptor = {
+        // array of pointer to string descriptors
+        (char[]){0x09, 0x04}, // 0: is supported language is English (0x0409)
+        "I",                  // 1: Manufacturer
+        "My Custom Device",   // 2: Product
+        "012-345",            // 3: Serials, should use chip ID
+    };
+
+    tinyusb_config_t tusb_cfg = {
+        .descriptor = &my_descriptor,
+        .string_descriptor = my_string_descriptor,
+        .external_phy = false // In the most cases you need to use a `false` value
+    };
+
+#else
+
+    tinyusb_config_t tusb_cfg = {
+        .descriptor = NULL,
+        .string_descriptor = NULL,
+        .external_phy = false // In the most cases you need to use a `false` value
+    };
+
+#endif
+
+    ESP_ERROR_CHECK(tinyusb_driver_install(&tusb_cfg));
+    ESP_LOGI(TAG, "USB initialization DONE");
+
+    // Create a task for tinyusb device stack:
+    xTaskCreate(usb_device_task, "usbd", 4096, NULL, 5, NULL);
+    return;
+}
@@ -0,0 +1,11 @@
+
+This directory is intended for PIO Unit Testing and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html