Ents sdi12 transmit by stevegtaylor · Pull Request #25 · jlab-sensing/tock

stevegtaylor · 2026-01-17T00:37:54Z

Pull Request Overview

This pull request adds/changes/fixes...

Testing Strategy

This pull request was tested by...

TODO or Help Wanted

This pull request still needs...

Documentation Updated

Updated the relevant files in /docs, or no updates are required.

Formatting

Ran make prepush.

Bumps [cryptography](https://github.com/pyca/cryptography) from 43.0.1 to 44.0.1. - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@43.0.1...44.0.1) --- updated-dependencies: - dependency-name: cryptography dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com>

The streaming process slice would write data leaving a one-byte gap between the header and payload. This caused a mismatch between the kernel behavior and the documented interface or assumptions made in userspace respectively.

The board isn't used and the company behind it seems to no longer exist.

MachineRegister is a data type that represents exactly what can be stored in a hardware-specific register. It has no additional semantic information.

These data types in Tock have no semantic meaning other than they are exactly the size of a register. To express that in code we use the MachineRegister type.

These used to be CapabilityPtr and thus now need to be handled slightly differently.

Previously, `CapabilityPtr` wrapped `MachineRegister`. This initially made sense because every `CapabilityPtr` is logically a `MachineRegister` but not every `MachineRegister` is a `CapabilityPtr`. However, we've realized that building `CapabilityPtr` atop `MachineRegister` requires `MachineRegister` to expose all of `CapabilityPtr`'s functionality, which is not correct for `MachineRegister`. Therefore, this commit reverses that relationship: `MachineRegister`'s implementation now wraps `CapabilityPtr`. There is no conceptual change in what the two types mean. However, `CapabilityPtr` now promises that it can contain an integer for `MachineRegister`'s use -- but other code is not allowed to rely on that.

`From` is only meant for lossless conversions. Converting a `CapabilityPtr` or `MachineRegister` to a `usize`, or a `MachineRegister` to a `CapabilityPtr`, conceptually lose information. Therefore, these conversions should be inherent methods instead.

This documents how `CapabilityPtr` and `MachineRegister` interact with pointer provenance.

…en they are offset, and remove confusing redundant wording.

…/tock into ents-sdi12-transmit

- add sdi12 that is built upon gpio/usart and alarm functionality. - require low level control that is chip specific.

Ents sdi12 transmit

stevegtaylor · 2026-01-19T21:28:53Z

@tyler-potyondy I fixed merge conflicts and went through the CI checks. I think it's ready for you to take a look at.

tyler-potyondy

Just did a first pass through the files. Let me know if you have any questions on the comments.

Make sure you go through and remove the debug! statements throughout these changes. These add a lot of code size.

tyler-potyondy · 2026-01-20T18:21:26Z

+.PHONY: flash-kernel-app-blink
+flash-kernel-app-blink: $(TOCK_ROOT_DIRECTORY)target/$(TARGET)/release/$(PLATFORM).bin erase-all
+	# Flash the kernel.
+	$(OPENOCD) -f interface/stlink.cfg -c "transport select hla_swd" -f target/stm32wlx.cfg \
+        -c "init; reset halt; program $< verify 0x08000000; reset; shutdown"
+	# Flash the blink app we temporarily are including in seeed studio board directory. 
+	$(OPENOCD) -f interface/stlink.cfg -c "transport select hla_swd" -f target/stm32wlx.cfg -c \
+		"init; reset halt; program $(TOCK_ROOT_DIRECTORY)boards/seeed_studio_lora-E5-HF/blink.tbf verify 0x08020000; reset; shutdown"
+


Suggested change

.PHONY: flash-kernel-app-blink

flash-kernel-app-blink: $(TOCK_ROOT_DIRECTORY)target/$(TARGET)/release/$(PLATFORM).bin erase-all

# Flash the kernel.

$(OPENOCD) -f interface/stlink.cfg -c "transport select hla_swd" -f target/stm32wlx.cfg \

-c "init; reset halt; program $< verify 0x08000000; reset; shutdown"

# Flash the blink app we temporarily are including in seeed studio board directory.

$(OPENOCD) -f interface/stlink.cfg -c "transport select hla_swd" -f target/stm32wlx.cfg -c \

"init; reset halt; program $(TOCK_ROOT_DIRECTORY)boards/seeed_studio_lora-E5-HF/blink.tbf verify 0x08020000; reset; shutdown"

Revert/remove this.

tyler-potyondy · 2026-01-20T18:22:07Z

+            // kernel::ipc::DRIVER_NUM => f(Some(&self.ipc)),
+            // capsules_core::gpio::DRIVER_NUM => f(Some(self.gpio)),


Suggested change

// kernel::ipc::DRIVER_NUM => f(Some(&self.ipc)),

// capsules_core::gpio::DRIVER_NUM => f(Some(self.gpio)),

Revert/remove this.

tyler-potyondy · 2026-01-20T18:23:46Z

+    let uart_device = static_init!(
+        capsules_core::virtualizers::virtual_uart::UartDevice<'static>,
+        capsules_core::virtualizers::virtual_uart::UartDevice::new(uart_mux_2, true)
+    );
+    uart_device.setup();
+


This uart_device is for sdi12 right?

I think the variable name should have something about sdi12 in it? Maybe sdi12_uart_device?

tyler-potyondy · 2026-01-20T18:25:20Z

+    //TODO: figure out why there needs to be a uart_device for the uart to transmit
+    // but the peripheral needs to be set to the transmit client for that to work


Is this todo still pending?

tyler-potyondy · 2026-01-20T18:26:16Z

+            unsafe { &mut *addr_of_mut!(SDI12_TX_BUF) },
+            unsafe { &mut *addr_of_mut!(SDI12_RX_BUF) },


We don't want to do this here. We should be able to do this without unsafe and just pass the slice/buffer.

tyler-potyondy · 2026-01-20T18:55:03Z

 #![crate_name = "stm32wle5xx"]
 #![crate_type = "rlib"]
 #![no_std]
+#![allow(clippy::doc_suspicious_footnotes)]


This shouldn't be needed. I think this is related to adding [^1] back above (which exposed a clippy bug).

tyler-potyondy · 2026-01-20T18:55:19Z

@@ -0,0 +1,199 @@
+// Licensed under the Apache License, Version 2.0 or the MIT License.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+// Copyright Tock Contributors 2022.


Suggested change

// Copyright Tock Contributors 2022.

// Copyright Tock Contributors 2025.

tyler-potyondy · 2026-01-20T19:12:07Z

If possible, can you please pull these changes into a separate and clearly labeled commit?

Something like: chips: stm32wle5xx: usart: int. handler fixes

This will be helpful since this is orthogonal to the other sdi12 changes and this should get upstreamed more urgently.

tyler-potyondy · 2026-01-20T19:13:14Z

+
+                // Completion conditions:
+                // 1) buffer full, OR
+                // 2) SDI-12 line complete on '\n'


Do we need to make sdi12 specific changes to the usart driver?

tyler-potyondy · 2026-01-20T19:14:33Z

@@ -0,0 +1,45 @@
+// Licensed under the Apache License, Version 2.0 or the MIT License.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+// Copyright Tock Contributors 2022.


Suggested change

// Copyright Tock Contributors 2022.

// Copyright Tock Contributors 2025.

stevegtaylor and others added 30 commits September 3, 2025 13:54

sdi12 capsule skelaton

154d4c7

adding pub mod for sdi

172f0cf

sdi12 compiler warnings

a4f099f

Commiting latests sdi12, about to switch to uartdevice instance

707213b

Merge branch 'ents-dev' into ents/sdi12

f568249

adding transmit branch

e7db539

boards: archive the acd52832

21e2776

The board isn't used and the company behind it seems to no longer exist.

kernel: utilities: add MachineRegister

7d3d79f

MachineRegister is a data type that represents exactly what can be stored in a hardware-specific register. It has no additional semantic information.

kernel: use MachineRegister for register contents

451dede

These data types in Tock have no semantic meaning other than they are exactly the size of a register. To express that in code we use the MachineRegister type.

kernel: machine register: implement as struct

82e808b

kernel: capptr: implement with MachineRegister

ee13c01

update uses of MachineRegister

979b816

These used to be CapabilityPtr and thus now need to be handled slightly differently.

CapabilityPtr and MachineRegister: Document provenance properties.

6a9b158

This documents how `CapabilityPtr` and `MachineRegister` interact with pointer provenance.

Clarify that CapabilityPtr's authority is not reliably invalidated wh…

ecc4bce

…en they are offset, and remove confusing redundant wording.

stable: MSRV now 1.84 for strict provenance APIs

1f082fa

capsules/core/driver: rename "Radio" section to "Networking"

2b68680

capsules/core/driver: reserve "EthernetTap" syscall driver number

75131fb

doc: Add core wg notes for 2025-02-19

0bbc12b

Network working group call notes: February 10, 2025

747f8c7

sdi12 capsule skelaton

24674d0

adding pub mod for sdi

115356e

sdi12 compiler warnings

0d5756e

Commiting latests sdi12, about to switch to uartdevice instance

0e654c7

adding transmit branch

00b23c6

implementing secondary uart for sdi12

a8917f3

Merge branch 'ents-sdi12-transmit' of https://github.com/jlab-sensing…

7ca5171

…/tock into ents-sdi12-transmit

stevegtaylor and others added 24 commits October 21, 2025 16:48

changing uart.rs breaks serial

ac08f6c

ents will make something happen over serial

e6d837c

uart2 not responding

005ddc8

tx client implemented

34713a8

debugging internal uart bug

28a5cd2

fixed tockos uart interrupt bugs

0f1c8e3

kernel: hil: add sdi12

e93b407

chips: stm32wle5xx: implement sdi12

0418e18

- add sdi12 that is built upon gpio/usart and alarm functionality. - require low level control that is chip specific.

capsules: sdi12: wip ents sdi12 driver

e7a137b

refactoring sdi12

9d931d3

marking is working better on the driver level

be0c774

getting ENOMEM error

844a0e1

ready to add grant

8e34da7

capsules extra: sdi12: add grant definition

85db279

Debugging why code hangs

229feb2

test fixes with yielding bug

e19d5b5

fix for overrunning issue

7909480

usart updated with delimiter to allow larger buffers

37962b4

fixed formatting errors

4ead4c1

formatting

b63a3a3

Merge pull request #24 from atorshizi/ents-sdi12-transmit

3806bae

Ents sdi12 transmit

merged ents-dev into sdi12 to fix conflicts

6e1beae

fixing prepush stuff

359293e

fixing ci checks

8b8e8a8

tyler-potyondy requested changes Jan 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ents sdi12 transmit#25

Ents sdi12 transmit#25
stevegtaylor wants to merge 54 commits intoents-devfrom
ents-sdi12-transmit

stevegtaylor commented Jan 17, 2026

Uh oh!

stevegtaylor commented Jan 19, 2026

Uh oh!

tyler-potyondy left a comment

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

tyler-potyondy Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

		// kernel::ipc::DRIVER_NUM => f(Some(&self.ipc)),
		// capsules_core::gpio::DRIVER_NUM => f(Some(self.gpio)),

		//TODO: figure out why there needs to be a uart_device for the uart to transmit
		// but the peripheral needs to be set to the transmit client for that to work

		unsafe { &mut *addr_of_mut!(SDI12_TX_BUF) },
		unsafe { &mut *addr_of_mut!(SDI12_RX_BUF) },

	// Copyright Tock Contributors 2022.
	// Copyright Tock Contributors 2025.

Conversation

stevegtaylor commented Jan 17, 2026

Pull Request Overview

Testing Strategy

TODO or Help Wanted

Documentation Updated

Formatting

Uh oh!

stevegtaylor commented Jan 19, 2026

Uh oh!

tyler-potyondy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants