uefi: add high-level TCP wrapper #1798

JayKickliter · 2025-10-21T19:27:34Z

This is PR 2 of 2 adding TCP to uefi-rs, and is a replacement for #1779. Note that this PR contains the commits from #1797 and will need to rebased before merging.

TODO before merging

Blocked by uefi-raw: add Tcp4 protocol type definitions #1797
Repalce uefi-raw relative path dep in uefi/Cargo.toml to point to publushed uefi-raw crate.

Checklist

Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
Update the changelog (if necessary)

phip1611 · 2025-10-22T05:06:17Z

typically we mark PRs as draft when they wait to be rebased onto another PR - so I marked this PR as draft.

Thanks for working on this and splitting this into multiple PRs!

uefi/Cargo.toml

uefi/src/proto/network/tcp4.rs

uefi/src/proto/network/tcpv4.rs

JayKickliter · 2025-11-11T18:34:31Z

uefi/src/proto/network/tcp4.rs

+
+impl Tcp4 {
+    /// See [Tcp4Protocol::configure].
+    pub fn configure(&mut self, config: &ConfigData, options: Option<&ConfigOptions>) -> Result {


I just realize this fn duplicates a lot of Ip4Config2::ifup() . Should I just make Tcp4 take a NIC Handle that's already been configured like Http does?

makes sense. in uefi, we prefer to hide lower-level details of UEFI from public API. Convenient high-level abstractions are very appreciated

phip1611 · 2025-11-19T13:18:12Z

#1797 is merged, please rebase

JayKickliter · 2025-12-08T18:28:18Z

@phip1611 I had to move on to a different task for a bit but I am not done with this PR. I plan on getting back to it soonish, but I can close it in the meantime if you prefer

phip1611 · 2025-12-09T07:10:55Z

@phip1611 I had to move on to a different task for a bit but I am not done with this PR. I plan on getting back to it soonish, but I can close it in the meantime if you prefer

No worries. We can keep it open. As a rule of thumb, I'd like to close PRs that are inactive for 6 months. So you still have some time

phip1611 · 2026-01-25T09:07:35Z

hi @JayKickliter
any plans to continue the work here?

JayKickliter · 2026-01-25T09:09:54Z

hi @JayKickliter

any plans to continue the work here?

Absolutely. We're using this in production. I'll prioritize

JayKickliter · 2026-01-30T01:17:14Z

I marked this PR ready for review

phip1611

Thanks for your contribution! You said you are using this in production? That's great!

Left a few remarks:

Please streamline function documentation. There are other parts in the code that use that pattern already
please list the error codes that can happen for each function (as listed in the UEFI spec)

I'd love if you have the capacity to add an integration test, but that could also be a follow-up.

phip1611 · 2026-01-30T07:56:53Z

uefi/src/proto/network/tcp4.rs

+///     boot, print, println,
+///     proto::network::tcp4::{AccessPoint, ConfigData, Tcp4,
+///     Tcp4ServiceBinding,
+/// },


this looks broken?

Suggested change

/// },

phip1611 · 2026-01-30T08:00:47Z

uefi/src/proto/network/tcp4.rs

+            unsafe { (self.0.configure)(self.this(), ptr::from_ref(&tcpv4_config_data) as *mut _) }
+                .to_result();
+        // Maximum timeout of 10 seconds.
+        for _ in 0..9 {


Suggested change

for _ in 0..9 {

for _ in 0..10 {

or

Suggested change

for _ in 0..9 {

for _ in 0..=9 {

or

Suggested change

for _ in 0..9 {

// Maximum timeout of 9 seconds.

I prefer (A)

phip1611 · 2026-01-30T08:01:42Z

uefi/src/proto/network/tcp4.rs

+        Ok(())
+    }
+
+    /// See [Tcp4Protocol::transmit].


Suggested change

/// See [Tcp4Protocol::transmit].

/// See [`Tcp4Protocol::transmit`].

also same as above, please follow our documentation template

phip1611 · 2026-01-30T08:03:14Z

uefi/src/proto/network/tcp4.rs

+pub struct Tcp4(pub Tcp4Protocol);
+
+impl Tcp4 {
+    /// See [Tcp4Protocol::configure].


Suggested change

/// See [Tcp4Protocol::configure].

/// <high-level description in one sentence>

///

/// <if helpful, additional comments>

///

///

/// See [`Tcp4Protocol::configure`] for more details.

///

/// # Arguments

///

/// - `config`: the [`ConfigData`] to apply <if needed more explanation>

/// - `options`: the optional [`ConfigOptions`] <if needed more explanation>

///

/// # Errors

///

/// - [`Status::INVALID_PARAMETER`]: if ....

/// - <the other error status codes that can be returned here>

phip1611 · 2026-01-30T08:04:53Z

uefi/src/proto/network/tcp4.rs

+        res
+    }
+
+    /// See [`Tcp4Protocol::connect`].


Please adapt this to the style I've mentioned above.

We are not 100% consistent with this yet in the code base unfortunately, but new code should follow that pattern

Copy, thanks for the review

phip1611 · 2026-01-30T08:05:58Z

uefi/src/proto/network/tcp4.rs

+        Ok(rx_data_len)
+    }
+
+    /// Receives data from the remote connection. On success, returns


phip1611 · 2026-01-30T08:06:05Z

uefi/src/proto/network/tcp4.rs

+    /// Receives data from the remote connection. On success, returns
+    /// the number of bytes read.
+    ///
+    /// See [Tcp4Protocol::receive].


Suggested change

/// See [Tcp4Protocol::receive].

/// See [`Tcp4Protocol::receive`].

phip1611 · 2026-01-30T08:06:09Z

uefi/src/proto/network/tcp4.rs

+        self.receive_vectored(&[buf])
+    }
+
+    /// Receives the exact number of bytes required to fill `buf`.


phip1611 · 2026-01-30T08:06:44Z

uefi/src/proto/network/tcp4.rs

+pub struct Tcp4ServiceBinding(ServiceBindingProtocol);
+
+impl Tcp4ServiceBinding {
+    /// Create TCPv4 Protocol Handle.


same as above, please follow our doc template

phip1611 · 2026-01-30T08:06:49Z

uefi/src/proto/network/tcp4.rs

+        }
+    }
+
+    /// Destroy TCPv4  Protocol Handle.


same as above, please follow our doc template

JayKickliter force-pushed the jsk/uefi/add-tcpv4 branch from b692b35 to e130f46 Compare October 21, 2025 23:12

phip1611 marked this pull request as draft October 22, 2025 05:05

phip1611 reviewed Oct 22, 2025

View reviewed changes

uefi/Cargo.toml Outdated Show resolved Hide resolved

phip1611 requested changes Oct 22, 2025

View reviewed changes

uefi/src/proto/network/tcp4.rs Show resolved Hide resolved

uefi/src/proto/network/tcpv4.rs Outdated Show resolved Hide resolved

uefi/src/proto/network/tcpv4.rs Outdated Show resolved Hide resolved

uefi/src/proto/network/tcpv4.rs Outdated Show resolved Hide resolved

JayKickliter force-pushed the jsk/uefi/add-tcpv4 branch 4 times, most recently from ebf20de to dee28f7 Compare October 22, 2025 18:15

JayKickliter force-pushed the jsk/uefi/add-tcpv4 branch 2 times, most recently from 05b5155 to f547536 Compare November 11, 2025 18:30

JayKickliter commented Nov 11, 2025

View reviewed changes

JayKickliter force-pushed the jsk/uefi/add-tcpv4 branch 4 times, most recently from 327b902 to 7d9befe Compare November 18, 2025 16:52

phip1611 changed the title ~~uefi: add high-level TCP wrapper~~ [STALE] uefi: add high-level TCP wrapper Jan 25, 2026

uefi: add tcpv4 protocol wrapper

b51a482

JayKickliter force-pushed the jsk/uefi/add-tcpv4 branch from 7d9befe to b51a482 Compare January 30, 2026 01:03

JayKickliter marked this pull request as ready for review January 30, 2026 01:04

JayKickliter marked this pull request as draft January 30, 2026 01:06

uefi/tcp4: fix doc test

f63372e

JayKickliter marked this pull request as ready for review January 30, 2026 01:16

phip1611 changed the title ~~[STALE] uefi: add high-level TCP wrapper~~ uefi: add high-level TCP wrapper Jan 30, 2026

phip1611 requested changes Jan 30, 2026

View reviewed changes

	/// See [Tcp4Protocol::transmit].
	/// See [`Tcp4Protocol::transmit`].

-    /// See [Tcp4Protocol::configure].
+    /// <high-level description in one sentence>
+    ///
+    /// <if helpful, additional comments>
+    ///
+    ///
+    /// See [`Tcp4Protocol::configure`] for more details.
+    ///
+    /// # Arguments
+    ///
+    /// - `config`: the [`ConfigData`] to apply  <if needed more explanation>
+    /// - `options`: the optional [`ConfigOptions`] <if needed more explanation>
+    ///
+    /// # Errors
+    ///
+    /// - [`Status::INVALID_PARAMETER`]: if ....
+    /// - <the other error status codes that can be returned here>

	/// See [Tcp4Protocol::receive].
	/// See [`Tcp4Protocol::receive`].

Uh oh!

uefi: add high-level TCP wrapper #1798

Are you sure you want to change the base?

uefi: add high-level TCP wrapper #1798

Uh oh!

Conversation

JayKickliter commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO before merging

Checklist

Uh oh!

phip1611 commented Oct 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phip1611 Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phip1611 commented Nov 19, 2025

Uh oh!

JayKickliter commented Dec 8, 2025

Uh oh!

phip1611 commented Dec 9, 2025

Uh oh!

phip1611 commented Jan 25, 2026

Uh oh!

JayKickliter commented Jan 25, 2026

Uh oh!

JayKickliter commented Jan 30, 2026

Uh oh!

phip1611 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

2 participants

JayKickliter commented Oct 21, 2025 •

edited

Loading

phip1611 Nov 19, 2025 •

edited

Loading

phip1611 left a comment •

edited

Loading