From 5380a6517279b6364c55625d1dacf5ab08a967a6 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Fri, 16 Aug 2024 22:30:13 +0200 Subject: [PATCH 1/2] Extract picotool binary info to a separate `rp-binary-info` crate. --- Cargo.toml | 2 +- rp-binary-info/Cargo.toml | 17 ++ rp-binary-info/LICENSE-APACHE | 202 ++++++++++++++++++ rp-binary-info/LICENSE-MIT | 19 ++ rp-binary-info/NOTICE | 3 + rp-binary-info/README.md | 15 ++ .../src}/consts.rs | 0 .../mod.rs => rp-binary-info/src/lib.rs | 75 +++++-- .../src}/macros.rs | 70 +++--- .../src}/types.rs | 0 rp2040-hal/Cargo.toml | 6 +- rp2040-hal/examples/binary_info_demo.rs | 14 +- rp2040-hal/src/lib.rs | 3 +- 13 files changed, 367 insertions(+), 59 deletions(-) create mode 100644 rp-binary-info/Cargo.toml create mode 100644 rp-binary-info/LICENSE-APACHE create mode 100644 rp-binary-info/LICENSE-MIT create mode 100644 rp-binary-info/NOTICE create mode 100644 rp-binary-info/README.md rename {rp2040-hal/src/binary_info => rp-binary-info/src}/consts.rs (100%) rename rp2040-hal/src/binary_info/mod.rs => rp-binary-info/src/lib.rs (74%) rename {rp2040-hal/src/binary_info => rp-binary-info/src}/macros.rs (60%) rename {rp2040-hal/src/binary_info => rp-binary-info/src}/types.rs (100%) diff --git a/Cargo.toml b/Cargo.toml index 17b93a079..2eb595db0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [workspace] resolver = "2" -members = ["rp2040-hal", "rp2040-hal-macros", "on-target-tests"] +members = ["rp2040-hal", "rp2040-hal-macros", "on-target-tests", "rp-binary-info"] exclude = [] [patch.'https://github.com/rp-rs/rp-hal.git'] diff --git a/rp-binary-info/Cargo.toml b/rp-binary-info/Cargo.toml new file mode 100644 index 000000000..cd91e86cb --- /dev/null +++ b/rp-binary-info/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "rp-binary-info" +version = "0.1.0" +edition = "2021" +authors = ["The rp-rs Developers"] +homepage = "https://github.com/rp-rs/rp-hal" +description = "Code and types for creating Picotool compatible Binary Info metadata" +license = "MIT OR Apache-2.0" +rust-version = "1.77" +repository = "https://github.com/rp-rs/rp-hal" +categories = ["embedded", "hardware-support", "no-std", "no-std::no-alloc"] +keywords = ["embedded", "raspberry-pi", "rp2040", "rp2350", "picotool"] + +[features] +binary-info = [] + +[dependencies] diff --git a/rp-binary-info/LICENSE-APACHE b/rp-binary-info/LICENSE-APACHE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/rp-binary-info/LICENSE-APACHE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/rp-binary-info/LICENSE-MIT b/rp-binary-info/LICENSE-MIT new file mode 100644 index 000000000..6e052e35b --- /dev/null +++ b/rp-binary-info/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) 2021-2024 The rp-rs Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/rp-binary-info/NOTICE b/rp-binary-info/NOTICE new file mode 100644 index 000000000..790ecb167 --- /dev/null +++ b/rp-binary-info/NOTICE @@ -0,0 +1,3 @@ +Copyright (c) 2021-2024 The rp-rs Developers + +Originally published at https://github.com/rp-rs/rp-hal diff --git a/rp-binary-info/README.md b/rp-binary-info/README.md new file mode 100644 index 000000000..18541f865 --- /dev/null +++ b/rp-binary-info/README.md @@ -0,0 +1,15 @@ +# `rp-binary-info` + +Code and types for creating [Picotool](https://github.com/raspberrypi/picotool) compatible "Binary Info" metadata. + +# License + +The contents of this repository are dual-licensed under the _MIT OR Apache 2.0_ +License. That means you can choose either the MIT license or the Apache 2.0 +license when you re-use this code. See [`LICENSE-MIT`](./LICENSE-MIT) or +[`LICENSE-APACHE`](./LICENSE-APACHE) for more information on each specific +license. Our Apache 2.0 notices can be found in [`NOTICE`](./NOTICE). + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclus`ion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/rp2040-hal/src/binary_info/consts.rs b/rp-binary-info/src/consts.rs similarity index 100% rename from rp2040-hal/src/binary_info/consts.rs rename to rp-binary-info/src/consts.rs diff --git a/rp2040-hal/src/binary_info/mod.rs b/rp-binary-info/src/lib.rs similarity index 74% rename from rp2040-hal/src/binary_info/mod.rs rename to rp-binary-info/src/lib.rs index ab2167e37..25aa1edfe 100644 --- a/rp2040-hal/src/binary_info/mod.rs +++ b/rp-binary-info/src/lib.rs @@ -1,22 +1,75 @@ //! Code and types for creating Picotool compatible "Binary Info" metadata //! -//! Add something like this to your program, and compile with the "binary-info" -//! and "rt" features: +//! ## Example usage +//! +//! Enable the Cargo feature `binary-info`. +//! +//! Add this to your linker script (usually named `memory.x`): +//! +//! ```not_rust,ignore +//! SECTIONS { +//! /* ### Boot ROM info +//! * +//! * Goes after .vector_table, to keep it in the first 512 bytes of flash, +//! * where picotool can find it +//! */ +//! .boot_info : ALIGN(4) +//! { +//! KEEP(*(.boot_info)); +//! } > FLASH +//! +//! } INSERT AFTER .vector_table; +//! +//! /* move .text to start /after/ the boot info */ +//! _stext = ADDR(.boot_info) + SIZEOF(.boot_info); +//! +//! SECTIONS { +//! /* ### Picotool 'Binary Info' Entries +//! * +//! * Picotool looks through this block (as we have pointers to it in our +//! * header) to find interesting information. +//! */ +//! .bi_entries : ALIGN(4) +//! { +//! /* We put this in the header */ +//! __bi_entries_start = .; +//! /* Here are the entries */ +//! KEEP(*(.bi_entries)); +//! /* Keep this block a nice round size */ +//! . = ALIGN(4); +//! /* We put this in the header */ +//! __bi_entries_end = .; +//! } > FLASH +//! } INSERT AFTER .text; +//! ``` +//! +//! Then, add this to your Rust code: //! //! ``` -//! # use rp2040_hal as hal; //! #[link_section = ".bi_entries"] //! #[used] -//! pub static PICOTOOL_ENTRIES: [hal::binary_info::EntryAddr; 3] = [ -//! hal::binary_info_rp_program_name!(c"Program Name Here"), -//! hal::binary_info_rp_cargo_version!(), -//! hal::binary_info_int!( -//! hal::binary_info::make_tag(b"JP"), +//! pub static PICOTOOL_ENTRIES: [rp_binary_info::EntryAddr; 3] = [ +//! rp_binary_info::rp_program_name!(c"Program Name Here"), +//! rp_binary_info::rp_cargo_version!(), +//! rp_binary_info::int!( +//! rp_binary_info::make_tag(b"JP"), //! 0x0000_0001, //! 0x12345678 //! ), //! ]; //! ``` +//! +//! ## Cargo features +//! +//! The `binary-info` Cargo feature enables emitting the main `PICOTOOL_HEADER` +//! static, which is what Picotool looks for to discover the binary info. +//! +//! It is optional to allow you to emit the static yourself differently, for e.g. +//! compatibility with different linker scripts, while still allowing using the +//! rest of the utilities in the crate to format the info. + +#![no_std] +#![warn(missing_docs)] pub mod consts; @@ -50,8 +103,8 @@ extern "C" { /// /// The data here tells picotool the start and end flash addresses of our /// metadata. -#[cfg(feature = "binary-info")] #[link_section = ".boot_info"] +#[cfg(feature = "binary-info")] #[used] pub static PICOTOOL_HEADER: Header = unsafe { Header::new( @@ -62,7 +115,6 @@ pub static PICOTOOL_HEADER: Header = unsafe { }; /// This tells picotool how to convert RAM addresses back into Flash addresses -#[cfg(feature = "binary-info")] pub static MAPPING_TABLE: [MappingTableEntry; 2] = [ // This is the entry for .data MappingTableEntry { @@ -187,8 +239,7 @@ pub const fn rp_boot2_name(value: &'static core::ffi::CStr) -> StringEntry { /// Create a tag from two ASCII letters. /// /// ``` -/// # use rp2040_hal as hal; -/// let tag = hal::binary_info::make_tag(b"RP"); +/// let tag = rp_binary_info::make_tag(b"RP"); /// assert_eq!(tag, 0x5052); /// ``` pub const fn make_tag(c: &[u8; 2]) -> u16 { diff --git a/rp2040-hal/src/binary_info/macros.rs b/rp-binary-info/src/macros.rs similarity index 60% rename from rp2040-hal/src/binary_info/macros.rs rename to rp-binary-info/src/macros.rs index 760525615..0689ddb54 100644 --- a/rp2040-hal/src/binary_info/macros.rs +++ b/rp-binary-info/src/macros.rs @@ -3,9 +3,9 @@ /// Generate a static item containing the given environment variable, /// and return its [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_env { +macro_rules! env { ($tag:expr, $id:expr, $env_var_name:expr) => { - $crate::binary_info_str!($tag, $id, { + $crate::str!($tag, $id, { let value = concat!(env!($env_var_name), "\0"); // # Safety // @@ -23,10 +23,9 @@ macro_rules! binary_info_env { /// You must pass a numeric tag, a numeric ID, and `&CStr` (which is always /// null-terminated). #[macro_export] -macro_rules! binary_info_str { +macro_rules! str { ($tag:expr, $id:expr, $str:expr) => {{ - static ENTRY: $crate::binary_info::StringEntry = - $crate::binary_info::StringEntry::new($tag, $id, $str); + static ENTRY: $crate::StringEntry = $crate::StringEntry::new($tag, $id, $str); ENTRY.addr() }}; } @@ -37,10 +36,9 @@ macro_rules! binary_info_str { /// You must pass a numeric tag, a numeric ID, and `&CStr` (which is always /// null-terminated). #[macro_export] -macro_rules! binary_info_int { +macro_rules! int { ($tag:expr, $id:expr, $int:expr) => {{ - static ENTRY: $crate::binary_info::IntegerEntry = - $crate::binary_info::IntegerEntry::new($tag, $id, $int); + static ENTRY: $crate::IntegerEntry = $crate::IntegerEntry::new($tag, $id, $int); ENTRY.addr() }}; } @@ -48,11 +46,11 @@ macro_rules! binary_info_int { /// Generate a static item containing the program name, and return its /// [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_program_name { +macro_rules! rp_program_name { ($name:expr) => { - $crate::binary_info_str!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PROGRAM_NAME, + $crate::str!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PROGRAM_NAME, $name ) }; @@ -61,11 +59,11 @@ macro_rules! binary_info_rp_program_name { /// Generate a static item containing the program version, and return its /// [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_program_version { +macro_rules! rp_program_version { ($version:expr) => {{ - $crate::binary_info_str!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PROGRAM_VERSION, + $crate::str!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PROGRAM_VERSION, $version ) }}; @@ -74,11 +72,11 @@ macro_rules! binary_info_rp_program_version { /// Generate a static item containing the `CARGO_PKG_VERSION` as the program /// version, and return its [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_cargo_version { +macro_rules! rp_cargo_version { () => { - $crate::binary_info_env!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PROGRAM_VERSION_STRING, + $crate::env!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PROGRAM_VERSION_STRING, "CARGO_PKG_VERSION" ) }; @@ -87,11 +85,11 @@ macro_rules! binary_info_rp_cargo_version { /// Generate a static item containing the program url, and return its /// [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_program_url { +macro_rules! rp_program_url { ($url:expr) => { - $crate::binary_info_str!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PROGRAM_URL, + $crate::str!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PROGRAM_URL, $url ) }; @@ -100,11 +98,11 @@ macro_rules! binary_info_rp_program_url { /// Generate a static item containing the program description, and return its /// [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_program_description { +macro_rules! rp_program_description { ($description:expr) => { - $crate::binary_info_str!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PROGRAM_DESCRIPTION, + $crate::str!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PROGRAM_DESCRIPTION, $description ) }; @@ -113,11 +111,11 @@ macro_rules! binary_info_rp_program_description { /// Generate a static item containing whether this is a debug or a release /// build, and return its [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_program_build_attribute { +macro_rules! rp_program_build_attribute { () => { - $crate::binary_info_str!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PROGRAM_BUILD_ATTRIBUTE, + $crate::str!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PROGRAM_BUILD_ATTRIBUTE, { if cfg!(debug_assertions) { c"debug" @@ -132,11 +130,11 @@ macro_rules! binary_info_rp_program_build_attribute { /// Generate a static item containing the specific board this program runs on, /// and return its [`EntryAddr`](super::EntryAddr). #[macro_export] -macro_rules! binary_info_rp_pico_board { +macro_rules! rp_pico_board { ($board:expr) => { - $crate::binary_info_str!( - $crate::binary_info::consts::TAG_RASPBERRY_PI, - $crate::binary_info::consts::ID_RP_PICO_BOARD, + $crate::str!( + $crate::consts::TAG_RASPBERRY_PI, + $crate::consts::ID_RP_PICO_BOARD, $board ) }; diff --git a/rp2040-hal/src/binary_info/types.rs b/rp-binary-info/src/types.rs similarity index 100% rename from rp2040-hal/src/binary_info/types.rs rename to rp-binary-info/src/types.rs diff --git a/rp2040-hal/Cargo.toml b/rp2040-hal/Cargo.toml index 48a5caa8f..43a4ae80d 100644 --- a/rp2040-hal/Cargo.toml +++ b/rp2040-hal/Cargo.toml @@ -18,6 +18,9 @@ targets = ["thumbv6m-none-eabi"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] +rp2040-hal-macros = { version = "0.1.0", path = "../rp2040-hal-macros" } +rp-binary-info = { version = "0.1.0", path = "../rp-binary-info" } + cortex-m = "0.7.2" embedded_hal_0_2 = { package = "embedded-hal", version = "0.2.5", features = [ "unproven", @@ -33,7 +36,6 @@ nb = "1.0" rp2040-pac = { version = "0.6.0", features = ["critical-section"] } paste = "1.0" pio = "0.2.0" -rp2040-hal-macros = { version = "0.1.0", path = "../rp2040-hal-macros" } usb-device = "0.3" vcell = "0.1" void = { version = "1.0.2", default-features = false } @@ -110,7 +112,7 @@ i2c-write-iter = ["dep:i2c-write-iter"] # # Requires 'rt' so that the vector table is correctly sized and therefore the # header is within reach of picotool. -binary-info = ["rt"] +binary-info = ["rt", "rp-binary-info/binary-info"] [[example]] name = "binary_info_demo" diff --git a/rp2040-hal/examples/binary_info_demo.rs b/rp2040-hal/examples/binary_info_demo.rs index ae728bdff..f0b752367 100644 --- a/rp2040-hal/examples/binary_info_demo.rs +++ b/rp2040-hal/examples/binary_info_demo.rs @@ -96,14 +96,14 @@ fn main() -> ! { #[link_section = ".bi_entries"] #[used] pub static PICOTOOL_ENTRIES: [binary_info::EntryAddr; 7] = [ - hal::binary_info_rp_program_name!(c"rp2040-hal Binary Info Example"), - hal::binary_info_rp_cargo_version!(), - hal::binary_info_rp_program_description!(c"A GPIO blinky with extra metadata."), - hal::binary_info_rp_program_url!(c"https://github.com/rp-rs/rp-hal"), - hal::binary_info_rp_program_build_attribute!(), - hal::binary_info_rp_pico_board!(c"pico"), + binary_info::rp_program_name!(c"rp2040-hal Binary Info Example"), + binary_info::rp_cargo_version!(), + binary_info::rp_program_description!(c"A GPIO blinky with extra metadata."), + binary_info::rp_program_url!(c"https://github.com/rp-rs/rp-hal"), + binary_info::rp_program_build_attribute!(), + binary_info::rp_pico_board!(c"pico"), // An example with a non-Raspberry-Pi tag - hal::binary_info_int!(binary_info::make_tag(b"JP"), 0x0000_0001, 0x12345678), + binary_info::int!(binary_info::make_tag(b"JP"), 0x0000_0001, 0x12345678), ]; // End of file diff --git a/rp2040-hal/src/lib.rs b/rp2040-hal/src/lib.rs index fd12b3e36..290792979 100644 --- a/rp2040-hal/src/lib.rs +++ b/rp2040-hal/src/lib.rs @@ -52,7 +52,8 @@ pub mod adc; #[macro_use] pub mod async_utils; pub(crate) mod atomic_register_access; -pub mod binary_info; +#[cfg(feature = "binary-info")] +pub use rp_binary_info as binary_info; pub mod clocks; #[cfg(feature = "critical-section-impl")] mod critical_section_impl; From 8a7b4ece9d5424d714143d45dec5509e76b53482 Mon Sep 17 00:00:00 2001 From: Jonathan 'theJPster' Pallant Date: Sat, 17 Aug 2024 13:27:25 +0100 Subject: [PATCH 2/2] Always export binary-info crate as a module. --- rp2040-hal/src/lib.rs | 1 - 1 file changed, 1 deletion(-) diff --git a/rp2040-hal/src/lib.rs b/rp2040-hal/src/lib.rs index 290792979..73efe6d17 100644 --- a/rp2040-hal/src/lib.rs +++ b/rp2040-hal/src/lib.rs @@ -52,7 +52,6 @@ pub mod adc; #[macro_use] pub mod async_utils; pub(crate) mod atomic_register_access; -#[cfg(feature = "binary-info")] pub use rp_binary_info as binary_info; pub mod clocks; #[cfg(feature = "critical-section-impl")]