Skip to content

Commit 01fe964

Browse files
Rovio01valeros
andauthored
Implement Zephyr support for Teensy (#83)
Co-authored-by: Valerii Koval <valeros@users.noreply.github.com>
1 parent acbb405 commit 01fe964

27 files changed

Lines changed: 702 additions & 4 deletions

File tree

.github/workflows/examples.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ jobs:
1616
- "examples/mbed-blink"
1717
- "examples/mbed-dsp"
1818
- "examples/mbed-serial"
19+
- "examples/zephyr-blink"
20+
- "examples/zephyr-synchronization"
1921
runs-on: ${{ matrix.os }}
2022
steps:
2123
- uses: actions/checkout@v2

boards/teensy40.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
"cpu": "cortex-m7",
88
"extra_flags": "-D__IMXRT1062__ -DARDUINO_TEENSY40",
99
"f_cpu": "600000000",
10-
"mcu": "imxrt1062"
10+
"mcu": "imxrt1062",
11+
"zephyr": {
12+
"variant": "teensy40"
13+
}
1114
},
1215
"connectivity": [
1316
"can"
@@ -16,7 +19,8 @@
1619
"jlink_device": "MIMXRT1062xxxxA"
1720
},
1821
"frameworks": [
19-
"arduino"
22+
"arduino",
23+
"zephyr"
2024
],
2125
"name": "Teensy 4.0",
2226
"upload": {

boards/teensy41.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
"cpu": "cortex-m7",
88
"extra_flags": "-D__IMXRT1062__ -DARDUINO_TEENSY41",
99
"f_cpu": "600000000",
10-
"mcu": "imxrt1062"
10+
"mcu": "imxrt1062",
11+
"zephyr": {
12+
"variant": "teensy41"
13+
}
1114
},
1215
"connectivity": [
1316
"can"
@@ -16,7 +19,8 @@
1619
"jlink_device": "MIMXRT1062xxxxA"
1720
},
1821
"frameworks": [
19-
"arduino"
22+
"arduino",
23+
"zephyr"
2024
],
2125
"name": "Teensy 4.1",
2226
"upload": {

builder/frameworks/zephyr.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Copyright 2019-present PlatformIO <contact@platformio.org>
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
"""
15+
The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple
16+
hardware architectures, optimized for resource constrained devices, and built with
17+
safety and security in mind.
18+
https://github.com/zephyrproject-rtos/zephyr
19+
"""
20+
21+
from os.path import join
22+
23+
from SCons.Script import Import, SConscript
24+
25+
Import("env")
26+
27+
SConscript(
28+
join(env.PioPlatform().get_package_dir("framework-zephyr"), "scripts",
29+
"platformio", "platformio-build.py"), exports="env")

builder/main.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,13 @@
147147
# Target: Build executable and linkable firmware
148148
#
149149

150+
if "zephyr" in env.get("PIOFRAMEWORK", []):
151+
env.SConscript(
152+
join(platform.get_package_dir(
153+
"framework-zephyr"), "scripts", "platformio", "platformio-build-pre.py"),
154+
exports={"env": env}
155+
)
156+
150157
target_elf = None
151158
if "nobuild" in COMMAND_LINE_TARGETS:
152159
target_elf = join("$BUILD_DIR", "${PROGNAME}.elf")

examples/zephyr-blink/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.pio

examples/zephyr-blink/.travis.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Continuous Integration (CI) is the practice, in software
2+
# engineering, of merging all developer working copies with a shared mainline
3+
# several times a day < https://docs.platformio.org/page/ci/index.html >
4+
#
5+
# Documentation:
6+
#
7+
# * Travis CI Embedded Builds with PlatformIO
8+
# < https://docs.travis-ci.com/user/integration/platformio/ >
9+
#
10+
# * PlatformIO integration with Travis CI
11+
# < https://docs.platformio.org/page/ci/travis.html >
12+
#
13+
# * User Guide for `platformio ci` command
14+
# < https://docs.platformio.org/page/userguide/cmd_ci.html >
15+
#
16+
#
17+
# Please choose one of the following templates (proposed below) and uncomment
18+
# it (remove "# " before each line) or use own configuration according to the
19+
# Travis CI documentation (see above).
20+
#
21+
22+
23+
#
24+
# Template #1: General project. Test it using existing `platformio.ini`.
25+
#
26+
27+
# language: python
28+
# python:
29+
# - "2.7"
30+
#
31+
# sudo: false
32+
# cache:
33+
# directories:
34+
# - "~/.platformio"
35+
#
36+
# install:
37+
# - pip install -U platformio
38+
# - platformio update
39+
#
40+
# script:
41+
# - platformio run
42+
43+
44+
#
45+
# Template #2: The project is intended to be used as a library with examples.
46+
#
47+
48+
# language: python
49+
# python:
50+
# - "2.7"
51+
#
52+
# sudo: false
53+
# cache:
54+
# directories:
55+
# - "~/.platformio"
56+
#
57+
# env:
58+
# - PLATFORMIO_CI_SRC=path/to/test/file.c
59+
# - PLATFORMIO_CI_SRC=examples/file.ino
60+
# - PLATFORMIO_CI_SRC=path/to/test/directory
61+
#
62+
# install:
63+
# - pip install -U platformio
64+
# - platformio update
65+
#
66+
# script:
67+
# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

examples/zephyr-blink/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. Copyright 2020-present PlatformIO <contact@platformio.org>
2+
Licensed under the Apache License, Version 2.0 (the "License");
3+
you may not use this file except in compliance with the License.
4+
You may obtain a copy of the License at
5+
http://www.apache.org/licenses/LICENSE-2.0
6+
Unless required by applicable law or agreed to in writing, software
7+
distributed under the License is distributed on an "AS IS" BASIS,
8+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
See the License for the specific language governing permissions and
10+
limitations under the License.
11+
12+
How to build PlatformIO based project
13+
=====================================
14+
15+
1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html)
16+
2. Download [development platform with examples](https://github.com/platformio/platform-teensy/archive/develop.zip)
17+
3. Extract ZIP archive
18+
4. Run these commands:
19+
20+
```shell
21+
# Change directory to example
22+
$ cd platform-teensy/examples/zephyr-blink
23+
24+
# Build project
25+
$ pio run
26+
27+
# Upload firmware
28+
$ pio run --target upload
29+
30+
# Clean build files
31+
$ pio run --target clean
32+
```
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
This directory is intended for project header files.
3+
4+
A header file is a file containing C declarations and macro definitions
5+
to be shared between several project source files. You request the use of a
6+
header file in your project source file (C, C++, etc) located in `src` folder
7+
by including it, with the C preprocessing directive `#include'.
8+
9+
```src/main.c
10+
11+
#include "header.h"
12+
13+
int main (void)
14+
{
15+
...
16+
}
17+
```
18+
19+
Including a header file produces the same results as copying the header file
20+
into each source file that needs it. Such copying would be time-consuming
21+
and error-prone. With a header file, the related declarations appear
22+
in only one place. If they need to be changed, they can be changed in one
23+
place, and programs that include the header file will automatically use the
24+
new version when next recompiled. The header file eliminates the labor of
25+
finding and changing all the copies as well as the risk that a failure to
26+
find one copy will result in inconsistencies within a program.
27+
28+
In C, the usual convention is to give header files names that end with `.h'.
29+
It is most portable to use only letters, digits, dashes, and underscores in
30+
header file names, and at most one dot.
31+
32+
Read more about using header files in official GCC documentation:
33+
34+
* Include Syntax
35+
* Include Operation
36+
* Once-Only Headers
37+
* Computed Includes
38+
39+
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

examples/zephyr-blink/lib/README

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
This directory is intended for project specific (private) libraries.
3+
PlatformIO will compile them to static libraries and link into executable file.
4+
5+
The source code of each library should be placed in a an own separate directory
6+
("lib/your_library_name/[here are source files]").
7+
8+
For example, see a structure of the following two libraries `Foo` and `Bar`:
9+
10+
|--lib
11+
| |
12+
| |--Bar
13+
| | |--docs
14+
| | |--examples
15+
| | |--src
16+
| | |- Bar.c
17+
| | |- Bar.h
18+
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
19+
| |
20+
| |--Foo
21+
| | |- Foo.c
22+
| | |- Foo.h
23+
| |
24+
| |- README --> THIS FILE
25+
|
26+
|- platformio.ini
27+
|--src
28+
|- main.c
29+
30+
and a contents of `src/main.c`:
31+
```
32+
#include <Foo.h>
33+
#include <Bar.h>
34+
35+
int main (void)
36+
{
37+
...
38+
}
39+
40+
```
41+
42+
PlatformIO Library Dependency Finder will find automatically dependent
43+
libraries scanning project source files.
44+
45+
More information about PlatformIO Library Dependency Finder
46+
- https://docs.platformio.org/page/librarymanager/ldf.html

0 commit comments

Comments
 (0)