Skip to content

Commit 103e4fa

Browse files
thejpsterthejpster
authored
Merge pull request #830 from Dirbaio/rp-binary-info
Extract picotool binary info to a separate `rp-binary-info` crate.
2 parents 903376a + 8a7b4ec commit 103e4fa

13 files changed

+366
-59
lines changed

‎Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[workspace]
22
resolver = "2"
3-
members = ["rp2040-hal", "rp2040-hal-macros", "on-target-tests"]
3+
members = ["rp2040-hal", "rp2040-hal-macros", "on-target-tests", "rp-binary-info"]
44
exclude = []
55

66
[patch.'https://github.com/rp-rs/rp-hal.git']

‎rp-binary-info/Cargo.toml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[package]
2+
name = "rp-binary-info"
3+
version = "0.1.0"
4+
edition = "2021"
5+
authors = ["The rp-rs Developers"]
6+
homepage = "https://github.com/rp-rs/rp-hal"
7+
description = "Code and types for creating Picotool compatible Binary Info metadata"
8+
license = "MIT OR Apache-2.0"
9+
rust-version = "1.77"
10+
repository = "https://github.com/rp-rs/rp-hal"
11+
categories = ["embedded", "hardware-support", "no-std", "no-std::no-alloc"]
12+
keywords = ["embedded", "raspberry-pi", "rp2040", "rp2350", "picotool"]
13+
14+
[features]
15+
binary-info = []
16+
17+
[dependencies]

‎rp-binary-info/LICENSE-APACHE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎rp-binary-info/LICENSE-MIT

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2021-2024 The rp-rs Developers
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎rp-binary-info/NOTICE

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Copyright (c) 2021-2024 The rp-rs Developers
2+
3+
Originally published at https://github.com/rp-rs/rp-hal

‎rp-binary-info/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# `rp-binary-info`
2+
3+
Code and types for creating [Picotool](https://github.com/raspberrypi/picotool) compatible "Binary Info" metadata.
4+
5+
# License
6+
7+
The contents of this repository are dual-licensed under the _MIT OR Apache 2.0_
8+
License. That means you can choose either the MIT license or the Apache 2.0
9+
license when you re-use this code. See [`LICENSE-MIT`](./LICENSE-MIT) or
10+
[`LICENSE-APACHE`](./LICENSE-APACHE) for more information on each specific
11+
license. Our Apache 2.0 notices can be found in [`NOTICE`](./NOTICE).
12+
13+
Unless you explicitly state otherwise, any contribution intentionally submitted
14+
for inclus`ion in the work by you, as defined in the Apache-2.0 license, shall be
15+
dual licensed as above, without any additional terms or conditions.

‎rp2040-hal/src/binary_info/consts.rs ‎rp-binary-info/src/consts.rs

File renamed without changes.

‎rp2040-hal/src/binary_info/mod.rs ‎rp-binary-info/src/lib.rs

+63-12
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,75 @@
11
//! Code and types for creating Picotool compatible "Binary Info" metadata
22
//!
3-
//! Add something like this to your program, and compile with the "binary-info"
4-
//! and "rt" features:
3+
//! ## Example usage
4+
//!
5+
//! Enable the Cargo feature `binary-info`.
6+
//!
7+
//! Add this to your linker script (usually named `memory.x`):
8+
//!
9+
//! ```not_rust,ignore
10+
//! SECTIONS {
11+
//! /* ### Boot ROM info
12+
//! *
13+
//! * Goes after .vector_table, to keep it in the first 512 bytes of flash,
14+
//! * where picotool can find it
15+
//! */
16+
//! .boot_info : ALIGN(4)
17+
//! {
18+
//! KEEP(*(.boot_info));
19+
//! } > FLASH
20+
//!
21+
//! } INSERT AFTER .vector_table;
22+
//!
23+
//! /* move .text to start /after/ the boot info */
24+
//! _stext = ADDR(.boot_info) + SIZEOF(.boot_info);
25+
//!
26+
//! SECTIONS {
27+
//! /* ### Picotool 'Binary Info' Entries
28+
//! *
29+
//! * Picotool looks through this block (as we have pointers to it in our
30+
//! * header) to find interesting information.
31+
//! */
32+
//! .bi_entries : ALIGN(4)
33+
//! {
34+
//! /* We put this in the header */
35+
//! __bi_entries_start = .;
36+
//! /* Here are the entries */
37+
//! KEEP(*(.bi_entries));
38+
//! /* Keep this block a nice round size */
39+
//! . = ALIGN(4);
40+
//! /* We put this in the header */
41+
//! __bi_entries_end = .;
42+
//! } > FLASH
43+
//! } INSERT AFTER .text;
44+
//! ```
45+
//!
46+
//! Then, add this to your Rust code:
547
//!
648
//! ```
7-
//! # use rp2040_hal as hal;
849
//! #[link_section = ".bi_entries"]
950
//! #[used]
10-
//! pub static PICOTOOL_ENTRIES: [hal::binary_info::EntryAddr; 3] = [
11-
//! hal::binary_info_rp_program_name!(c"Program Name Here"),
12-
//! hal::binary_info_rp_cargo_version!(),
13-
//! hal::binary_info_int!(
14-
//! hal::binary_info::make_tag(b"JP"),
51+
//! pub static PICOTOOL_ENTRIES: [rp_binary_info::EntryAddr; 3] = [
52+
//! rp_binary_info::rp_program_name!(c"Program Name Here"),
53+
//! rp_binary_info::rp_cargo_version!(),
54+
//! rp_binary_info::int!(
55+
//! rp_binary_info::make_tag(b"JP"),
1556
//! 0x0000_0001,
1657
//! 0x12345678
1758
//! ),
1859
//! ];
1960
//! ```
61+
//!
62+
//! ## Cargo features
63+
//!
64+
//! The `binary-info` Cargo feature enables emitting the main `PICOTOOL_HEADER`
65+
//! static, which is what Picotool looks for to discover the binary info.
66+
//!
67+
//! It is optional to allow you to emit the static yourself differently, for e.g.
68+
//! compatibility with different linker scripts, while still allowing using the
69+
//! rest of the utilities in the crate to format the info.
70+
71+
#![no_std]
72+
#![warn(missing_docs)]
2073

2174
pub mod consts;
2275

@@ -50,8 +103,8 @@ extern "C" {
50103
///
51104
/// The data here tells picotool the start and end flash addresses of our
52105
/// metadata.
53-
#[cfg(feature = "binary-info")]
54106
#[link_section = ".boot_info"]
107+
#[cfg(feature = "binary-info")]
55108
#[used]
56109
pub static PICOTOOL_HEADER: Header = unsafe {
57110
Header::new(
@@ -62,7 +115,6 @@ pub static PICOTOOL_HEADER: Header = unsafe {
62115
};
63116

64117
/// This tells picotool how to convert RAM addresses back into Flash addresses
65-
#[cfg(feature = "binary-info")]
66118
pub static MAPPING_TABLE: [MappingTableEntry; 2] = [
67119
// This is the entry for .data
68120
MappingTableEntry {
@@ -187,8 +239,7 @@ pub const fn rp_boot2_name(value: &'static core::ffi::CStr) -> StringEntry {
187239
/// Create a tag from two ASCII letters.
188240
///
189241
/// ```
190-
/// # use rp2040_hal as hal;
191-
/// let tag = hal::binary_info::make_tag(b"RP");
242+
/// let tag = rp_binary_info::make_tag(b"RP");
192243
/// assert_eq!(tag, 0x5052);
193244
/// ```
194245
pub const fn make_tag(c: &[u8; 2]) -> u16 {

0 commit comments

Comments
 (0)