Skip to content

Commit ff5d68e

Browse files
DirbaioDirbaio
committed
First commit
0 parents  commit ff5d68e

File tree

10 files changed

+439
-0
lines changed

10 files changed

+439
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Cargo.lock
2+
target

‎Cargo.toml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[package]
2+
authors = ["Dario Nieuwenhuis <[email protected]>"]
3+
edition = "2018"
4+
license = "MIT OR Apache-2.0"
5+
name = "defmt-rtt-target"
6+
version = "0.1.0"
7+
8+
[dependencies]
9+
defmt = "0.1.0"
10+
cortex-m = "0.6.3"
11+
rtt-target = "0.2.2"

‎LICENSE-APACHE

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

‎LICENSE-MIT

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

‎README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# `defmt-rtt-target`
2+
3+
[`defmt`](https://github.com/knurling-rs/defmt) logger implementation using [`rtt-target`](https://github.com/mvirkkunen/rtt-target).
4+
5+
The official [`defmt-rtt`](https://github.com/knurling-rs/defmt/tree/main/firmware/defmt-rtt) crate has its own RTT
6+
implementation that is not externally exposed. This is done so that users can't corrupt the defmt log stream
7+
by manually writing to the RTT channel. This library exists as an alternate option for when you do need
8+
control over RTT, for example to log extra non-defmt data on other channels, or have a host->target "down channel".
9+
10+
If all you need is logging, you should use `defmt-rtt` instead of this.
11+
12+
## Usage
13+
14+
- Initialize `rtt_target` in your code
15+
- Call `defmt_rtt_target::init()` with the `UpChannel` you want to use for RTT printing. This should be channel 0, as that's the one all defmt tools use.
16+
- Now you can log with the standard defmt macros.
17+
18+
Note that all log output before calling `defmt_rtt_target::init()` is discarded.
19+
20+
## License
21+
22+
Licensed under either of
23+
24+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
25+
http://www.apache.org/licenses/LICENSE-2.0)
26+
27+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
28+
29+
at your option.

‎example/.cargo/config

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[target.'cfg(all(target_arch = "arm", target_os = "none"))']
2+
runner = "probe-run --chip nRF52840_xxAA --defmt --input"
3+
4+
rustflags = [
5+
# LLD (shipped with the Rust toolchain) is used as the default linker
6+
"-C", "link-arg=--nmagic",
7+
"-C", "link-arg=-Tlink.x",
8+
"-C", "link-arg=-Tdefmt.x",
9+
10+
# if you run into problems with LLD switch to the GNU linker by commenting out
11+
# this line
12+
# "-C", "linker=arm-none-eabi-ld",
13+
14+
# if you need to link to pre-compiled C libraries provided by a C toolchain
15+
# use GCC as the linker by commenting out both lines above and then
16+
# uncommenting the three lines below
17+
# "-C", "linker=arm-none-eabi-gcc",
18+
# "-C", "link-arg=-Wl,-Tlink.x",
19+
# "-C", "link-arg=-nostartfiles",
20+
]
21+
22+
[build]
23+
# Pick ONE of these compilation targets
24+
# target = "thumbv6m-none-eabi" # Cortex-M0 and Cortex-M0+
25+
# target = "thumbv7m-none-eabi" # Cortex-M3
26+
# target = "thumbv7em-none-eabi" # Cortex-M4 and Cortex-M7 (no FPU)
27+
target = "thumbv7em-none-eabihf" # Cortex-M4F and Cortex-M7F (with FPU)

‎example/Cargo.toml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[package]
2+
authors = ["Dario Nieuwenhuis <[email protected]>"]
3+
edition = "2018"
4+
name = "defmt-rtt-target-example"
5+
version = "0.1.0"
6+
7+
[features]
8+
default = [
9+
"defmt-default",
10+
]
11+
defmt-default = []
12+
defmt-trace = []
13+
defmt-debug = []
14+
defmt-info = []
15+
defmt-warn = []
16+
defmt-error = []
17+
18+
19+
[dependencies]
20+
cortex-m = { version = "0.6.3" }
21+
cortex-m-rt = "0.6.12"
22+
defmt = "0.1.0"
23+
defmt-rtt-target = { path = ".." }
24+
panic-probe = "0.1.0"
25+
rtt-target = "0.2.2"
26+
27+
[patch.crates-io]
28+
panic-probe = { git = "https://github.com/knurling-rs/probe-run", branch="main" }
29+
defmt = { git = "https://github.com/knurling-rs/defmt", branch="main" }

‎example/memory.x

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
MEMORY
2+
{
3+
/* NOTE 1 K = 1 KiBi = 1024 bytes */
4+
/* These values correspond to the NRF52840 with Softdevices S140 7.0.1 */
5+
FLASH : ORIGIN = 0x00000000, LENGTH = 1024K
6+
RAM : ORIGIN = 0x20000000, LENGTH = 256K
7+
}

‎example/src/main.rs

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
#![no_std]
2+
#![no_main]
3+
4+
use defmt_rtt_target as _;
5+
use panic_probe as _;
6+
7+
use cortex_m_rt::entry;
8+
use rtt_target::rtt_init;
9+
use defmt::info;
10+
use core::sync::atomic::{AtomicUsize, Ordering};
11+
12+
#[defmt::timestamp]
13+
fn timestamp() -> u64 {
14+
static COUNT: AtomicUsize = AtomicUsize::new(0);
15+
// NOTE(no-CAS) `timestamps` runs with interrupts disabled
16+
let n = COUNT.load(Ordering::Relaxed);
17+
COUNT.store(n + 1, Ordering::Relaxed);
18+
n as u64
19+
}
20+
21+
#[entry]
22+
fn main() -> ! {
23+
let channels = rtt_init! {
24+
up: {
25+
0: {
26+
size: 1024
27+
mode: BlockIfFull
28+
name: "Terminal"
29+
}
30+
}
31+
down: {
32+
0: {
33+
size: 16
34+
name: "Terminal"
35+
}
36+
}
37+
};
38+
39+
defmt_rtt_target::init(channels.up.0);
40+
41+
info!("Hello World!");
42+
43+
let mut input = channels.down.0;
44+
loop {
45+
let mut buf = [0u8; 16];
46+
let n = input.read(&mut buf);
47+
if n != 0 {
48+
info!("Read: {:str}", unsafe { core::str::from_utf8_unchecked(&buf[..n])});
49+
}
50+
}
51+
}

0 commit comments

Comments
 (0)