Skip to content

Commit fc10a97

Browse files
kilograhamkilograham
authored
Merge commit of 1.1.0 changes
2 parents 2d5789e + 8c059ca commit fc10a97

File tree

164 files changed

+25654
-22838
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+25654
-22838
lines changed

‎.github/workflows/cmake.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: CMake
2+
on: [push, pull_request]
3+
4+
env:
5+
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
6+
BUILD_TYPE: Release
7+
8+
jobs:
9+
build:
10+
if: github.repository_owner == 'raspberrypi'
11+
runs-on: [self-hosted, Linux, X64]
12+
13+
steps:
14+
- name: Clean workspace
15+
run: |
16+
echo "Cleaning up previous run"
17+
rm -rf "${{ github.workspace }}"
18+
mkdir -p "${{ github.workspace }}"
19+
20+
- name: Checkout repo
21+
uses: actions/checkout@v2
22+
23+
- name: Checkout submodules
24+
run: git submodule update --init
25+
26+
- name: Create Build Environment
27+
# Some projects don't allow in-source building, so create a separate build directory
28+
# We'll use this as our working directory for all subsequent commands
29+
run: cmake -E make_directory ${{github.workspace}}/build
30+
31+
- name: Configure CMake
32+
# Use a bash shell so we can use the same syntax for environment variable
33+
# access regardless of the host operating system
34+
shell: bash
35+
working-directory: ${{github.workspace}}/build
36+
# Note the current convention is to use the -S and -B options here to specify source
37+
# and build directories, but this is only available with CMake 3.13 and higher.
38+
# The CMake binaries on the Github Actions machines are (as of this writing) 3.12
39+
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
40+
41+
- name: Get core count
42+
id: core_count
43+
run : cat /proc/cpuinfo | grep processor | wc -l
44+
45+
- name: Build
46+
working-directory: ${{github.workspace}}/build
47+
shell: bash
48+
# Execute the build. You can specify a specific target with "--target <NAME>"
49+
run: cmake --build . --config $BUILD_TYPE --parallel ${{steps.core_count.outputs.output}}

‎CMakeLists.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,17 @@ if (NOT TARGET _pico_sdk_inclusion_marker)
3030

3131
add_compile_options(-Winline)
3232

33+
# allow customization
34+
add_sub_list_dirs(PICO_SDK_POST_LIST_DIRS)
35+
3336
if (PICO_SDK_TOP_LEVEL_PROJECT AND NOT DEFINED PICO_SDK_TESTS_ENABLED)
3437
set(PICO_SDK_TESTS_ENABLED 1)
3538
endif()
3639
if (PICO_SDK_TESTS_ENABLED)
3740
add_subdirectory(test)
3841
endif ()
39-
set(PICO_SDK_TESTS_ENABLED "${PICO_SDK_TESTS_ENABLED}" CACHE INTERNAL "Enable build of SDK tests")
4042

41-
# allow customization
42-
add_sub_list_dirs(PICO_SDK_POST_LIST_DIRS)
43+
set(PICO_SDK_TESTS_ENABLED "${PICO_SDK_TESTS_ENABLED}" CACHE INTERNAL "Enable build of SDK tests")
4344

4445
# add docs at the end, as we gather documentation dirs as we go
4546
add_subdirectory(docs)

‎README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ instructions for other platforms, and just in general, we recommend you see [Ras
4242
```
4343
1. Set up your project to point to use the Raspberry Pi Pico SDK
4444

45-
* By cloning the SDK locally (most common)
45+
* Either by cloning the SDK locally (most common) :
4646
1. `git clone` this Raspberry Pi Pico SDK repository
4747
1. Copy [pico_sdk_import.cmake](https://github.com/raspberrypi/pico-sdk/blob/master/external/pico_sdk_import.cmake)
4848
from the SDK into your project directory
@@ -65,7 +65,7 @@ instructions for other platforms, and just in general, we recommend you see [Ras
6565
6666
```
6767
68-
* With the Raspberry Pi Pico SDK as a submodule
68+
* Or with the Raspberry Pi Pico SDK as a submodule :
6969
1. Clone the SDK as a submodule called `pico-sdk`
7070
1. Setup a `CMakeLists.txt` like:
7171
@@ -85,7 +85,7 @@ instructions for other platforms, and just in general, we recommend you see [Ras
8585
8686
```
8787
88-
* With automatic download from github
88+
* Or with automatic download from GitHub :
8989
1. Copy [pico_sdk_import.cmake](https://github.com/raspberrypi/pico-sdk/blob/master/external/pico_sdk_import.cmake)
9090
from the SDK into your project directory
9191
1. Setup a `CMakeLists.txt` like:
@@ -110,16 +110,7 @@ instructions for other platforms, and just in general, we recommend you see [Ras
110110
111111
```
112112
113-
3. Setup a CMake build directory.
114-
For example, if not using an IDE:
115-
```
116-
$ mkdir build
117-
$ cd build
118-
$ cmake ..
119-
```
120-
121-
4. Write your code (see [pico-examples](https://github.com/raspberrypi/pico-examples) or the [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk) documentation
122-
for more information)
113+
1. Write your code (see [pico-examples](https://github.com/raspberrypi/pico-examples) or the [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk) documentation for more information)
123114
124115
About the simplest you can do is a single source file (e.g. hello_world.c)
125116
@@ -151,10 +142,17 @@ for more information)
151142
if you want to use the default USB see the [hello-usb](https://github.com/raspberrypi/pico-examples/tree/master/hello_world/usb) example.
152143

153144

154-
5. Make your target from the build directory you created.
145+
1. Setup a CMake build directory.
146+
For example, if not using an IDE:
147+
```
148+
$ mkdir build
149+
$ cd build
150+
$ cmake ..
151+
```
152+
153+
1. Make your target from the build directory you created.
155154
```sh
156155
$ make hello_world
157156
```
158157
159-
6. You now have `hello_world.elf` to load via a debugger, or `hello_world.uf2` that can be installed and
160-
run on your Raspberry Pi Pico via drag and drop.
158+
1. You now have `hello_world.elf` to load via a debugger, or `hello_world.uf2` that can be installed and run on your Raspberry Pi Pico via drag and drop.

‎docs/Doxyfile.in

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
PROJECT_NAME = "Raspberry Pi Pico SDK"
2-
PROJECT_NUMBER = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
1+
PROJECT_NAME = "Raspberry Pi Pico SDK"
2+
PROJECT_BRIEF = "Raspberry Pi Pico SDK documentation"
3+
PROJECT_NUMBER = @PICO_SDK_VERSION_STRING@
34

45
#STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@
56
STRIP_FROM_PATH = @DOXY_INPUT_DIRS@
@@ -20,8 +21,6 @@ LAYOUT_FILE = @PROJECT_SOURCE_DIR@/docs/DoxygenLayout.xml
2021
HTML_FOOTER = @PROJECT_SOURCE_DIR@/docs/footer.html
2122
HTML_HEADER = @PROJECT_SOURCE_DIR@/docs/header.html
2223

23-
PROJECT_BRIEF = "Raspberry Pi Pico SDK documentation"
24-
PROJECT_NUMBER = 1.0
2524
OPTIMIZE_OUTPUT_FOR_C = YES
2625
# HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/customdoxygen.css
2726
HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/normalise.css @PROJECT_SOURCE_DIR@/docs/main.css @PROJECT_SOURCE_DIR@/docs/styles.css

‎docs/DoxygenLayout.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,17 @@
1212
<tab type="user" url="https://rptl.io/pico-c-sdk" visible="yes" title="Raspberry Pi Pico C/C++ SDK" intro=""/>
1313
<tab type="user" url="https://rptl.io/pico-micropython" visible="yes" title="Raspberry Pi Pico Python SDK" intro=""/>
1414
<tab type="user" url="https://rptl.io/pico-get-started" visible="yes" title="Getting started with Raspberry Pi Pico" intro=""/>
15+
<tab type="user" url="https://rptl.io/pico-faq" visible="yes" title="Raspberry Pi Pico FAQ" intro=""/>
1516
</tab>
1617
<tab type="usergroup" url="@ref weblinks_page" visible="yes" title="Web" intro="useful weblinks">
1718
<tab type="user" url="https://www.raspberrypi.org/" visible="yes" title="Raspberry Pi Site" intro=""/>
1819
<tab type="user" url="https://rptl.io/rp2040-get-started" visible="yes" title="Raspberry Pi Pico Page" intro=""/>
1920
<tab type="user" url="https://www.raspberrypi.org/forums" visible="yes" title="Raspberry Pi Forums" intro=""/>
20-
<tab type="user" url="https://github.com/raspberrypi/pico-sdk" visible="yes" title="Raspberry Pi Pico SDK on Github" intro=""/>
21-
<tab type="user" url="https://github.com/raspberrypi/pico-examples" visible="yes" title="Pico Examples on Github" intro=""/>
22-
<tab type="user" url="https://github.com/raspberrypi/pico-extras" visible="yes" title="Pico Extras on Github" intro=""/>
23-
<tab type="user" url="https://github.com/raspberrypi/pico-playground" visible="yes" title="Pico Playground on Github" intro=""/>
24-
<tab type="user" url="https://github.com/raspberrypi/pico-bootrom" visible="yes" title="Pico Bootrom on Github" intro=""/>
21+
<tab type="user" url="https://github.com/raspberrypi/pico-sdk" visible="yes" title="Raspberry Pi Pico SDK on GitHub" intro=""/>
22+
<tab type="user" url="https://github.com/raspberrypi/pico-examples" visible="yes" title="Pico Examples on GitHub" intro=""/>
23+
<tab type="user" url="https://github.com/raspberrypi/pico-extras" visible="yes" title="Pico Extras on GitHub" intro=""/>
24+
<tab type="user" url="https://github.com/raspberrypi/pico-playground" visible="yes" title="Pico Playground on GitHub" intro=""/>
25+
<tab type="user" url="https://github.com/raspberrypi/pico-bootrom" visible="yes" title="Pico Bootrom on GitHub" intro=""/>
2526
</tab>
2627
<tab type="pages" visible="no" title="" intro=""/>
2728
<tab type="namespaces" visible="yes" title="">
@@ -146,8 +147,7 @@
146147
</namespace>
147148

148149
<!-- Layout definition for a file page -->
149-
<file> <tab type="modules" visible="yes" title="Libraries" intro="Here is a list of all the libraries supported in the Raspberry Pi Pico SDK"/>
150-
150+
<file>
151151
<briefdescription visible="yes"/>
152152
<includes visible="$SHOW_INCLUDE_FILES"/>
153153
<includegraph visible="$INCLUDE_GRAPH"/>

‎docs/header.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@
4646

4747
<div class="logo">
4848
<a href="$relpath^index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
49+
<span style="display: inline-block; margin-top: 10px;">
50+
v$projectnumber
51+
</span>
4952
</div>
5053

5154

‎docs/index.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,10 @@
6262
* @{
6363
* \defgroup boot_stage2 boot_stage2
6464
* \defgroup pico_base pico_base
65+
* \defgroup pico_binary_info pico_binary_info
6566
* \defgroup pico_bit_ops pico_bit_ops
6667
* \defgroup pico_bootrom pico_bootrom
68+
* \defgroup pico_bootsel_via_double_reset pico_bootsel_via_double_reset
6769
* \defgroup pico_cxx_options pico_cxx_options
6870
* \defgroup pico_divider pico_divider
6971
* \defgroup pico_double pico_double
@@ -84,4 +86,4 @@
8486
* \defgroup boot_picoboot boot_picoboot
8587
* \defgroup boot_uf2 boot_uf2
8688
* @}
87-
*/
89+
*/

‎docs/main.css

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ body {
77
}
88

99
h1, h2, h3, h4, h5, h6, p, a, li, span, blockquote, input, textarea, select, label {
10-
font-family: 'Roboto', sans-serif !important;
10+
font-family: 'Roboto', sans-serif;
1111
}
1212

1313
p {
@@ -97,5 +97,9 @@ a {
9797
display: none !important;
9898
}
9999

100-
100+
div.line,
101+
div.line a,
102+
div.line span {
103+
font-family: monospace;
104+
}
101105

‎docs/styles.css

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@
9999
}
100100
#MSearchSelectWindow {
101101
position: fixed;
102-
top: 145px !important;
103-
left: 35px !important;
102+
top: 178px !important;
103+
left: 49px !important;
104104
border: solid 1px #d4d4d4;
105105
border-radius: 0;
106106
box-shadow: 0px 3px 5px 0px rgba(0,0,0,0.25);
@@ -118,8 +118,8 @@
118118
}
119119
#MSearchResultsWindow {
120120
position: fixed;
121-
top: 145px !important;
122-
left: 35px !important;
121+
top: 178px !important;
122+
left: 49px !important;
123123
border: solid 1px #d4d4d4;
124124
border-radius: 0;
125125
box-shadow: 0px 3px 5px 0px rgba(0,0,0,0.25);

‎docs/weblinks_page.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
The full documentation for the RP2040 and Raspberry Pi Pico board can be found at the following links
44

55
- [RP2040 Datasheet](https://rptl.io/rp2040-datasheet)
6-
- [Raspberry Pi Pico datasheet](https://rptl.io/pico-datasheet)
7-
- [Hardware Design with the RP2040](https://rptl.io/rp2040-design)
6+
- [Raspberry Pi Pico Datasheet](https://rptl.io/pico-datasheet)
7+
- [Hardware design with the RP2040](https://rptl.io/rp2040-design)
88
- [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk)
99
- [Raspberry Pi Pico Python SDK](https://rptl.io/pico-micropython)
10-
- [Getting Started with Raspberry Pi Pico](https://rptl.io/pico-get-started)
10+
- [Getting started with Raspberry Pi Pico](https://rptl.io/pico-get-started)
11+
- [Raspberry Pi Pico FAQ](https://rptl.io/pico-faq)
1112

1213
### Weblinks
1314

@@ -19,9 +20,9 @@ For the main Raspberry Pi website, [see here](https://www.raspberrypi.org)
1920

2021
For the Raspberry Pi Pico page, [see here](https://rptl.io/rp2040-get-started)
2122

22-
### Github
23+
### GitHub
2324

24-
All the source code for the Raspberry Pi Pico SDK, examples and other libraries can be found on Github.
25+
All the source code for the Raspberry Pi Pico SDK, examples and other libraries can be found on GitHub.
2526

2627
- [Raspberry Pi Pico SDK](https://github.com/raspberrypi/pico-sdk)
2728
- [Pico Examples](https://github.com/raspberrypi/pico-examples)

0 commit comments

Comments
 (0)