diff --git a/boards/pico.json b/boards/pico.json index 55fdfa4..44d876e 100644 --- a/boards/pico.json +++ b/boards/pico.json @@ -21,7 +21,10 @@ ] ], "mcu": "rp2040", - "variant": "RASPBERRY_PI_PICO" + "variant": "RASPBERRY_PI_PICO", + "zephyr": { + "variant": "rpi_pico" + } }, "debug": { "jlink_device": "RP2040_M0_0", @@ -29,7 +32,8 @@ "svd_path": "rp2040.svd" }, "frameworks": [ - "arduino" + "arduino", + "zephyr" ], "name": "Raspberry Pi Pico", "upload": { diff --git a/builder/frameworks/zephyr.py b/builder/frameworks/zephyr.py new file mode 100644 index 0000000..87141e5 --- /dev/null +++ b/builder/frameworks/zephyr.py @@ -0,0 +1,30 @@ +# Copyright 2019-present PlatformIO +# +# 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. +""" +The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple +hardware architectures, optimized for resource constrained devices, and built with +safety and security in mind. + +https://github.com/zephyrproject-rtos/zephyr +""" + +from os.path import join + +from SCons.Script import Import, SConscript + +Import("env") + +SConscript( + join(env.PioPlatform().get_package_dir("framework-zephyr"), "scripts", + "platformio", "platformio-build.py"), exports="env") diff --git a/builder/main.py b/builder/main.py index 409d9e7..c027b5d 100644 --- a/builder/main.py +++ b/builder/main.py @@ -213,6 +213,14 @@ env.Append( # Target: Build executable and linkable firmware # +frameworks = env.get("PIOFRAMEWORK", []) +if "zephyr" in frameworks: + env.SConscript( + join(platform.get_package_dir( + "framework-zephyr"), "scripts", "platformio", "platformio-build-pre.py"), + exports={"env": env} + ) + target_elf = None if "nobuild" in COMMAND_LINE_TARGETS: target_elf = join("$BUILD_DIR", "${PROGNAME}.elf") diff --git a/examples/zephyr-blink/include/README b/examples/zephyr-blink/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/examples/zephyr-blink/include/README @@ -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 diff --git a/examples/zephyr-blink/lib/README b/examples/zephyr-blink/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/examples/zephyr-blink/lib/README @@ -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 +#include + +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 diff --git a/examples/zephyr-blink/platformio.ini b/examples/zephyr-blink/platformio.ini new file mode 100644 index 0000000..55d9866 --- /dev/null +++ b/examples/zephyr-blink/platformio.ini @@ -0,0 +1,14 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:pico] +platform = https://github.com/maxgerhardt/platform-raspberrypi.git +board = pico +framework = zephyr diff --git a/examples/zephyr-blink/src/main.c b/examples/zephyr-blink/src/main.c new file mode 100644 index 0000000..e2fbfd3 --- /dev/null +++ b/examples/zephyr-blink/src/main.c @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2016 Intel Corporation + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#include +#include +#include +#include + +/* 1000 msec = 1 sec */ +#define SLEEP_TIME_MS 1000 + +/* The devicetree node identifier for the "led0" alias. */ +#define LED0_NODE DT_ALIAS(led0) + +#if DT_NODE_HAS_STATUS(LED0_NODE, okay) +#define LED0 DT_GPIO_LABEL(LED0_NODE, gpios) +#define PIN DT_GPIO_PIN(LED0_NODE, gpios) +#define FLAGS DT_GPIO_FLAGS(LED0_NODE, gpios) +#else +/* A build error here means your board isn't set up to blink an LED. */ +#error "Unsupported board: led0 devicetree alias is not defined" +#define LED0 "" +#define PIN 0 +#define FLAGS 0 +#endif + +void main(void) +{ + const struct device *dev; + bool led_is_on = true; + int ret; + + dev = device_get_binding(LED0); + if (dev == NULL) { + return; + } + + ret = gpio_pin_configure(dev, PIN, GPIO_OUTPUT_ACTIVE | FLAGS); + if (ret < 0) { + return; + } + + while (1) { + gpio_pin_set(dev, PIN, (int)led_is_on); + led_is_on = !led_is_on; + k_msleep(SLEEP_TIME_MS); + } +} diff --git a/examples/zephyr-blink/test/README b/examples/zephyr-blink/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/examples/zephyr-blink/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner 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 PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html diff --git a/examples/zephyr-blink/zephyr/CMakeLists.txt b/examples/zephyr-blink/zephyr/CMakeLists.txt new file mode 100644 index 0000000..5272a40 --- /dev/null +++ b/examples/zephyr-blink/zephyr/CMakeLists.txt @@ -0,0 +1,7 @@ +# SPDX-License-Identifier: Apache-2.0 + +cmake_minimum_required(VERSION 3.20.0) +find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) +project(blinky) + +target_sources(app PRIVATE ../src/main.c) diff --git a/examples/zephyr-blink/zephyr/prj.conf b/examples/zephyr-blink/zephyr/prj.conf new file mode 100644 index 0000000..05bbd0f --- /dev/null +++ b/examples/zephyr-blink/zephyr/prj.conf @@ -0,0 +1 @@ +# nothing here \ No newline at end of file diff --git a/platform.json b/platform.json index a72ca8d..3f1b77e 100644 --- a/platform.json +++ b/platform.json @@ -23,6 +23,13 @@ "arduino": { "package": "framework-arduino-mbed", "script": "builder/frameworks/arduino/arduino.py" + }, + "zephyr": { + "package": "framework-zephyr", + "script": "builder/frameworks/zephyr.py", + "description": "The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple hardware architectures, optimized for resource constrained devices, and built with safety and security in mind", + "homepage": "https://www.zephyrproject.org", + "title": "Zephyr RTOS" } }, "packages": { @@ -49,6 +56,12 @@ "owner": "earlephilhower", "version": "~1.20303.0" }, + "framework-zephyr": { + "type": "framework", + "optional": true, + "owner": "platformio", + "version": "https://github.com/maxgerhardt/zephyr.git#3.1.0_pio" + }, "tool-rp2040tools": { "type": "uploader", "owner": "platformio", @@ -71,6 +84,26 @@ "optional": true, "owner": "earlephilhower", "version": "~5.100300.0" + }, + "tool-cmake": { + "optional": true, + "owner": "platformio", + "version": "~3.21.0" + }, + "tool-dtc": { + "optional": true, + "owner": "platformio", + "version": "~1.4.7" + }, + "tool-ninja": { + "optional": true, + "owner": "platformio", + "version": "^1.7.0" + }, + "tool-gperf": { + "optional": true, + "owner": "platformio", + "version": "^3.0.0" } } } diff --git a/platform.py b/platform.py index f66db00..94eab8f 100644 --- a/platform.py +++ b/platform.py @@ -13,10 +13,13 @@ # limitations under the License. import platform +import sys from platformio.public import PlatformBase +IS_WINDOWS = sys.platform.startswith("win") + class RaspberrypiPlatform(PlatformBase): def is_embedded(self): @@ -51,6 +54,14 @@ class RaspberrypiPlatform(PlatformBase): if "buildfs" in targets: self.packages["tool-mklittlefs-rp2040-earlephilhower"]["optional"] = False + if "zephyr" in variables.get("pioframework", []): + for p in self.packages: + if p in ("tool-cmake", "tool-dtc", "tool-ninja"): + self.packages[p]["optional"] = False + self.packages["toolchain-gccarmnoneeabi"]["version"] = "~1.80201.0" + if not IS_WINDOWS: + self.packages["tool-gperf"]["optional"] = False + # configure J-LINK tool jlink_conds = [ "jlink" in variables.get(option, "")