Skip to content

Commit f7643a4

Browse files
geekbozugeekbozu
committed
Added cmake variants
1 parent c0b8453 commit f7643a4

12 files changed

+245
-69
lines changed

‎.devcontainer/Dockerfile

+14-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM ubuntu:18.04
1+
FROM ubuntu:latest
22

33
ARG DEBIAN_FRONTEND=noninteractive
44
RUN apt-get update -qq \
@@ -18,12 +18,20 @@ RUN apt-get update -qq \
1818
dos2unix \
1919
clang-format \
2020
clang-tidy \
21+
locales \
22+
libncurses5 \
2123
# aarch64 packages
2224
libffi-dev \
2325
libssl-dev \
2426
python3-dev \
2527
rustc \
2628
&& rm -rf /var/cache/apt/* /var/lib/apt/lists/*;
29+
30+
#SET LOCALE
31+
RUN locale-gen en_US.UTF-8
32+
ENV LANG en_US.UTF-8
33+
ENV LANGUAGE en_US:en
34+
ENV LC_ALL en_US.UTF-8
2735

2836
RUN pip3 install adafruit-nrfutil
2937
# required for McuBoot
@@ -32,9 +40,10 @@ RUN pip3 install setuptools_rust
3240
WORKDIR /opt/
3341
# build.sh knows how to compile but it problimatic on Win10
3442
COPY build.sh .
43+
RUN chmod +x build.sh
3544
# create_build_openocd.sh uses cmake to crate to build directory
3645
COPY create_build_openocd.sh .
37-
46+
RUN chmod +x create_build_openocd.sh
3847
# Lets get each in a separate docker layer for better downloads
3948
# GCC
4049
# RUN bash -c "source /opt/build.sh; GetGcc;"
@@ -51,4 +60,6 @@ RUN pip3 install -r ./mcuboot/scripts/requirements.txt
5160

5261
RUN adduser infinitime
5362

54-
ENV SOURCES_DIR /workspaces/Pinetime
63+
ENV NRF5_SDK_PATH /opt/nRF5_SDK_15.3.0_59ac345
64+
ENV ARM_NONE_EABI_TOOLCHAIN_PATH /opt/gcc-arm-none-eabi-9-2020-q2-update
65+
ENV SOURCES_DIR /workspaces/InfiniTime

‎.devcontainer/README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# VScode devcontainer
2+
This is a docker-based interactive development environment using VSCode and Docker Devcontainers removing the need to install any tools locally*
3+
4+
5+
6+
## Requirements
7+
8+
- VScode
9+
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
10+
- Docker
11+
- OpenOCD - For debugging
12+
13+
## Using
14+
15+
### Code editing, and building.
16+
17+
1. Clone InifiniTime and update submodules
18+
2. Launch VSCode
19+
3. Open InifiTime directory,
20+
4. Allow VSCode to open folder with devcontainer.
21+
22+
After this the environment will be built if you do not currently have a container setup, it will install all the necessary tools and extra VSCode extensions.
23+
24+
In order to build InfiniTime we need to run the initial submodule init and Cmake commands.
25+
26+
#### Manually
27+
28+
You can use the VSCode terminal to run the CMake commands as outlined in the [build instructions](blob/develop/doc/buildAndProgram.md)
29+
30+
#### Script
31+
32+
The dev enviroment comes with some scripts to make this easier, They are located in /opt/.
33+
34+
There are also VSCode tasks provided should you desire to use those.
35+
36+
The task BuildInit will update submodules and configure for openocd
37+
38+
39+
40+
### Build
41+
42+
You can use the build.sh script located in /opt/
43+
44+
There will also eventually be a Build task. - Not written yet
45+
46+
47+
48+
### Debugging
49+
50+
Docker on windows does not support passing USB devices to the underlying WSL2 subsystem, To get around this we use openocd in server mode running on the host.
51+
52+
`openocd -f <yourinterface> -f <nrf52.cfg target file>`
53+
54+
This will launch openocd in server mode and attach it to the MCU.
55+
56+
The default launch.json file expects openocd to be listening on port 3333, edit if needed
57+
58+
59+
## Current Issues
60+
Currently WSL2 Has some real performance issues with IO on a windows host. Accessing files on the virtualized filesystem is much faster. Using VSCodes "clone in container" feature of the Remote - Containers will get around this. After the container is built you will need to update the submodules and follow the build isntructions like normal

‎.devcontainer/build.sh

100755100644
File mode changed.

‎.devcontainer/create_build_openocd.sh

100755100644
File mode changed.

‎.devcontainer/devcontainer.json

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"extensions": [
2020
"ms-vscode.cpptools",
2121
"ms-vscode.cmake-tools",
22+
"marus25.cortex-debug"
2223
],
2324

2425
// Use 'forwardPorts' to make a list of ports inside the container available locally.

‎.devcontainer/make_build_dir.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
#!/bin/bash
2-
cmake -G 'Unix Makefiles' -DCMAKE_BUILD_TYPE=Release -DUSE_OPENOCD=1 -DARM_NONE_EABI_TOOLCHAIN_PATH=/opt/gcc-arm-none-eabi-9-2020-q2-update -DNRF5_SDK_PATH=/opt/nRF5_SDK_15.3.0_59ac345 /workspaces/Pinetime
2+
cmake -G 'Unix Makefiles' -DCMAKE_BUILD_TYPE=Release -DUSE_OPENOCD=1 -DARM_NONE_EABI_TOOLCHAIN_PATH=/opt/gcc-arm-none-eabi-9-2020-q2-update -DNRF5_SDK_PATH=/opt/nRF5_SDK_15.3.0_59ac345 ${SOURCES_DIR}

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# CMake
66
cmake-build-*
7-
cmake-*
7+
cmake-*/
88
CMakeFiles
99
**/CMakeCache.txt
1010
cmake_install.cmake

‎.vscode/c_cpp_properties.json

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
{
22
"configurations": [
33
{
4-
"name": "Linux",
4+
"name": "nrfCC",
55
"includePath": [
6-
"${workspaceFolder}/**"
6+
"${workspaceFolder}/**",
7+
"${workspaceFolder}/src/**",
8+
"${workspaceFolder}/src"
79
],
810
"defines": [],
9-
"compilerPath": "/usr/bin/gcc",
10-
"cStandard": "gnu11",
11-
"cppStandard": "gnu++14",
12-
"intelliSenseMode": "linux-gcc-x64",
11+
"compilerPath": "${env:ARM_NONE_EABI_TOOLCHAIN_PATH}/bin/arm-none-eabi-gcc",
12+
"cStandard": "c11",
13+
"cppStandard": "c++14",
14+
"intelliSenseMode": "linux-gcc-arm",
15+
"configurationProvider": "ms-vscode.cmake-tools",
1316
"compileCommands": "${workspaceFolder}/build/compile_commands.json"
1417
}
1518
],

‎.vscode/cmake-variants.json

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"buildType": {
3+
"default": "release",
4+
"choices": {
5+
"debug": {
6+
"short": "Debug",
7+
"long": "Emit debug information without performing optimizations",
8+
"buildType": "Debug"
9+
},
10+
"release": {
11+
"short": "Release",
12+
"long": "Perform optimizations",
13+
"buildType": "Release"
14+
}
15+
}
16+
},
17+
"programmer":{
18+
"default": "OpenOCD",
19+
"choices":{
20+
"OpenOCD":{
21+
"short":"OpenOCD",
22+
"long": "Use OpenOCD",
23+
"settings":{
24+
"USE_OPENOCD":1
25+
}
26+
},
27+
"JLink":{
28+
"short":"JLink",
29+
"long": "Use JLink",
30+
"settings":{
31+
"USE_JLINK":1
32+
}
33+
},
34+
"GDB":{
35+
"short":"GDB",
36+
"long": "Use GDB",
37+
"settings":{
38+
"USE_GDB_CLIENT":1
39+
}
40+
}
41+
}
42+
},
43+
"DFU": {
44+
"default": "no",
45+
"choices": {
46+
"no": {
47+
"short": "No DFU",
48+
"long": "Do not build DFU",
49+
"settings": {
50+
"BUILD_DFU":0
51+
}
52+
},
53+
"yes": {
54+
"short": "Build DFU",
55+
"long": "Build DFU",
56+
"settings": {
57+
"BUILD_DFU":1
58+
}
59+
}
60+
}
61+
}
62+
}

‎.vscode/launch.json

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"version": "0.1.0",
3+
"configurations": [
4+
{
5+
"name": "Debug - Openocd docker Remote",
6+
"type":"cortex-debug",
7+
"cortex-debug.armToolchainPath":"${env:COMPILER_DIR}/bin",
8+
"cwd": "${workspaceRoot}",
9+
"executable": "${command:cmake.launchTargetPath}",
10+
"request": "launch",
11+
"servertype": "external",
12+
// This may need to be arm-none-eabi-gdb depending on your system
13+
"gdbPath" : "${env:COMPILER_DIR}/bin/arm-none-eabi-gdb",
14+
// Connect to an already running OpenOCD instance
15+
"gdbTarget": "host.docker.internal:3333",
16+
"svdFile": "${workspaceRoot}/nrf52.svd",
17+
"runToMain": true,
18+
// Work around for stopping at main on restart
19+
"postRestartCommands": [
20+
"break main",
21+
"continue"
22+
]
23+
},
24+
{
25+
"name": "Debug - Openocd Local",
26+
"type":"cortex-debug",
27+
"cortex-debug.armToolchainPath":"${env:COMPILER_DIR}/bin",
28+
"cwd": "${workspaceRoot}",
29+
"executable": "${command:cmake.launchTargetPath}",
30+
"request": "launch",
31+
"servertype": "openocd",
32+
// This may need to be arm-none-eabi-gdb depending on your system
33+
"gdbPath" : "${env:COMPILER_DIR}/bin/arm-none-eabi-gdb",
34+
// Connect to an already running OpenOCD instance
35+
"gdbTarget": "localhost:3333",
36+
"svdFile": "${workspaceRoot}/nrf52.svd",
37+
"runToMain": true,
38+
// Work around for stopping at main on restart
39+
"postRestartCommands": [
40+
"break main",
41+
"continue"
42+
]
43+
}
44+
45+
]
46+
}

‎.vscode/settings.json

+7-58
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,8 @@
11
{
2-
"files.associations": {
3-
"chrono": "cpp",
4-
"list": "cpp",
5-
"array": "cpp",
6-
"atomic": "cpp",
7-
"bit": "cpp",
8-
"*.tcc": "cpp",
9-
"cctype": "cpp",
10-
"charconv": "cpp",
11-
"clocale": "cpp",
12-
"cmath": "cpp",
13-
"condition_variable": "cpp",
14-
"cstdarg": "cpp",
15-
"cstddef": "cpp",
16-
"cstdint": "cpp",
17-
"cstdio": "cpp",
18-
"cstdlib": "cpp",
19-
"cstring": "cpp",
20-
"ctime": "cpp",
21-
"cwchar": "cpp",
22-
"cwctype": "cpp",
23-
"deque": "cpp",
24-
"unordered_map": "cpp",
25-
"vector": "cpp",
26-
"exception": "cpp",
27-
"algorithm": "cpp",
28-
"functional": "cpp",
29-
"iterator": "cpp",
30-
"memory": "cpp",
31-
"memory_resource": "cpp",
32-
"netfwd": "cpp",
33-
"numeric": "cpp",
34-
"optional": "cpp",
35-
"random": "cpp",
36-
"ratio": "cpp",
37-
"string": "cpp",
38-
"string_view": "cpp",
39-
"system_error": "cpp",
40-
"tuple": "cpp",
41-
"type_traits": "cpp",
42-
"utility": "cpp",
43-
"fstream": "cpp",
44-
"initializer_list": "cpp",
45-
"iosfwd": "cpp",
46-
"iostream": "cpp",
47-
"istream": "cpp",
48-
"limits": "cpp",
49-
"mutex": "cpp",
50-
"new": "cpp",
51-
"ostream": "cpp",
52-
"sstream": "cpp",
53-
"stdexcept": "cpp",
54-
"streambuf": "cpp",
55-
"thread": "cpp",
56-
"cinttypes": "cpp",
57-
"typeinfo": "cpp"
58-
}
59-
}
2+
"C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
3+
"cmake.configureArgs": [
4+
"-DARM_NONE_EABI_TOOLCHAIN_PATH=${env:ARM_NONE_EABI_TOOLCHAIN_PATH}",
5+
"-DNRF5_SDK_PATH=${env:NRF5_SDK_PATH}",
6+
],
7+
"cmake.generator": "Unix Makefiles"
8+
}

‎.vscode/tasks.json

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "create openocd build",
6+
"type": "shell",
7+
"command": "/opt/create_build_openocd.sh",
8+
"group": {
9+
"kind": "build",
10+
"isDefault": true
11+
},
12+
"presentation": {
13+
"reveal": "always",
14+
"panel": "shared"
15+
},
16+
"problemMatcher": []
17+
},
18+
{
19+
"label": "update submodules",
20+
"type": "shell",
21+
"command": "git submodule update --init",
22+
"options": {
23+
"cwd": "${workspaceFolder}"
24+
},
25+
"group": {
26+
"kind": "build",
27+
"isDefault": true
28+
},
29+
"presentation": {
30+
"reveal": "always",
31+
"panel": "shared"
32+
},
33+
"problemMatcher": []
34+
},
35+
{
36+
"label": "BuildInit",
37+
"dependsOn": [
38+
"update submodules",
39+
"create openocd build"
40+
],
41+
"problemMatcher": []
42+
}
43+
]
44+
}

0 commit comments

Comments
 (0)