From e965f179e1654103eca33feed7a9cc4c51d91be6 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 23 May 2024 13:18:16 +0100
Subject: [libc] Add stpcpy()

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/string.c | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

(limited to 'src/core')

diff --git a/src/core/string.c b/src/core/string.c
index 9a1b9b72a..364c4cf0e 100644
--- a/src/core/string.c
+++ b/src/core/string.c
@@ -321,9 +321,9 @@ char * strstr ( const char *haystack, const char *needle ) {
  *
  * @v dest		Destination string
  * @v src		Source string
- * @ret dest		Destination string
+ * @ret dnul		Terminating NUL of destination string
  */
-char * strcpy ( char *dest, const char *src ) {
+char * stpcpy ( char *dest, const char *src ) {
 	const uint8_t *src_bytes = ( ( const uint8_t * ) src );
 	uint8_t *dest_bytes = ( ( uint8_t * ) dest );
 
@@ -333,6 +333,19 @@ char * strcpy ( char *dest, const char *src ) {
 		if ( ! *dest_bytes )
 			break;
 	}
+	return ( ( char * ) dest_bytes );
+}
+
+/**
+ * Copy string
+ *
+ * @v dest		Destination string
+ * @v src		Source string
+ * @ret dest		Destination string
+ */
+char * strcpy ( char *dest, const char *src ) {
+
+	stpcpy ( dest, src );
 	return dest;
 }
 
-- 
cgit v1.2.3-55-g7522


From 76e0933d781474acf52000cba0afaebe32361667 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 18 Jun 2024 15:17:03 -0700
Subject: [hci] Rename "item" command's first parameter from "label" to "name"

Switch terminology for the "item" command from "item <label> <text>"
to "item <name> <text>", in preparation for repurposing the "item"
command to cover interactive forms as well as menus.

Since this renaming affects only a positional parameter, it does not
break compatibility with any existing scripts.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/menu.c             | 22 +++++++++++-----------
 src/hci/commands/menu_cmd.c | 12 ++++++------
 src/hci/tui/menu_ui.c       | 26 +++++++++++++-------------
 src/include/ipxe/menu.h     |  6 +++---
 4 files changed, 33 insertions(+), 33 deletions(-)

(limited to 'src/core')

diff --git a/src/core/menu.c b/src/core/menu.c
index ab5b0c7f5..b9d0d5b77 100644
--- a/src/core/menu.c
+++ b/src/core/menu.c
@@ -94,20 +94,20 @@ struct menu * create_menu ( const char *name, const char *title ) {
  * Add menu item
  *
  * @v menu		Menu
- * @v label		Label, or NULL
+ * @v name		Name, or NULL
  * @v text		Text, or NULL
  * @v shortcut		Shortcut key
  * @v is_default	Item is the default item
  * @ret item		Menu item, or NULL on failure
  */
-struct menu_item * add_menu_item ( struct menu *menu, const char *label,
+struct menu_item * add_menu_item ( struct menu *menu, const char *name,
 				   const char *text, int shortcut,
 				   int is_default ) {
-	size_t label_len;
+	size_t name_len;
 	size_t text_len;
 	size_t len;
 	struct menu_item *item;
-	char *label_copy;
+	char *name_copy;
 	char *text_copy;
 
 	/* Use empty text if none given */
@@ -115,19 +115,19 @@ struct menu_item * add_menu_item ( struct menu *menu, const char *label,
 		text = "";
 
 	/* Allocate item */
-	label_len = ( label ? ( strlen ( label ) + 1 /* NUL */ ) : 0 );
+	name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
 	text_len = ( strlen ( text ) + 1 /* NUL */ );
-	len = ( sizeof ( *item ) + label_len + text_len );
+	len = ( sizeof ( *item ) + name_len + text_len );
 	item = zalloc ( len );
 	if ( ! item )
 		return NULL;
-	label_copy = ( ( void * ) ( item + 1 ) );
-	text_copy = ( label_copy + label_len );
+	name_copy = ( ( void * ) ( item + 1 ) );
+	text_copy = ( name_copy + name_len );
 
 	/* Initialise item */
-	if ( label ) {
-		strcpy ( label_copy, label );
-		item->label = label_copy;
+	if ( name ) {
+		strcpy ( name_copy, name );
+		item->name = name_copy;
 	}
 	strcpy ( text_copy, text );
 	item->text = text_copy;
diff --git a/src/hci/commands/menu_cmd.c b/src/hci/commands/menu_cmd.c
index 76bce8695..8b6d2a9f1 100644
--- a/src/hci/commands/menu_cmd.c
+++ b/src/hci/commands/menu_cmd.c
@@ -135,7 +135,7 @@ static struct option_descriptor item_opts[] = {
 /** "item" command descriptor */
 static struct command_descriptor item_cmd =
 	COMMAND_DESC ( struct item_options, item_opts, 0, MAX_ARGUMENTS,
-		       "[<label> [<text>]]" );
+		       "[<name> [<text>]]" );
 
 /**
  * The "item" command
@@ -148,7 +148,7 @@ static int item_exec ( int argc, char **argv ) {
 	struct item_options opts;
 	struct menu *menu;
 	struct menu_item *item;
-	char *label = NULL;
+	char *name = NULL;
 	char *text = NULL;
 	int rc;
 
@@ -156,9 +156,9 @@ static int item_exec ( int argc, char **argv ) {
 	if ( ( rc = parse_options ( argc, argv, &item_cmd, &opts ) ) != 0 )
 		goto err_parse_options;
 
-	/* Parse label, if present */
+	/* Parse name, if present */
 	if ( ! opts.is_gap )
-		label = argv[optind++]; /* May be NULL */
+		name = argv[optind++]; /* May be NULL */
 
 	/* Parse text, if present */
 	if ( optind < argc ) {
@@ -174,7 +174,7 @@ static int item_exec ( int argc, char **argv ) {
 		goto err_parse_menu;
 
 	/* Add menu item */
-	item = add_menu_item ( menu, label, ( text ? text : "" ),
+	item = add_menu_item ( menu, name, ( text ? text : "" ),
 			       opts.key, opts.is_default );
 	if ( ! item ) {
 		rc = -ENOMEM;
@@ -257,7 +257,7 @@ static int choose_exec ( int argc, char **argv ) {
 
 	/* Store setting */
 	if ( ( rc = storef_setting ( setting.settings, &setting.setting,
-				     item->label ) ) != 0 ) {
+				     item->name ) ) != 0 ) {
 		printf ( "Could not store \"%s\": %s\n",
 			 setting.setting.name, strerror ( rc ) );
 		goto err_store;
diff --git a/src/hci/tui/menu_ui.c b/src/hci/tui/menu_ui.c
index f9dd9d100..cac61a7da 100644
--- a/src/hci/tui/menu_ui.c
+++ b/src/hci/tui/menu_ui.c
@@ -99,7 +99,7 @@ static void draw_menu_item ( struct menu_ui *ui, unsigned int index ) {
 	if ( item ) {
 
 		/* Draw separators in a different colour */
-		if ( ! item->label )
+		if ( ! item->name )
 			color_set ( CPAIR_SEPARATOR, NULL );
 
 		/* Highlight if this is the selected item */
@@ -225,7 +225,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 						continue;
 					}
 					ui->scroll.current = i;
-					if ( item->label ) {
+					if ( item->name ) {
 						chosen = 1;
 					} else {
 						move = +1;
@@ -239,7 +239,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 		while ( move ) {
 			move = jump_scroll_move ( &ui->scroll, move );
 			item = menu_item ( ui->menu, ui->scroll.current );
-			if ( item->label )
+			if ( item->name )
 				break;
 		}
 
@@ -254,7 +254,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 		/* Record selection */
 		item = menu_item ( ui->menu, ui->scroll.current );
 		assert ( item != NULL );
-		assert ( item->label != NULL );
+		assert ( item->name != NULL );
 		*selected = item;
 
 	} while ( ( rc == 0 ) && ! chosen );
@@ -275,7 +275,7 @@ int show_menu ( struct menu *menu, unsigned long timeout,
 	struct menu_item *item;
 	struct menu_ui ui;
 	char buf[ MENU_COLS + 1 /* NUL */ ];
-	int labelled_count = 0;
+	int named_count = 0;
 	int rc;
 
 	/* Initialise UI */
@@ -284,12 +284,12 @@ int show_menu ( struct menu *menu, unsigned long timeout,
 	ui.scroll.rows = MENU_ROWS;
 	ui.timeout = timeout;
 	list_for_each_entry ( item, &menu->items, list ) {
-		if ( item->label ) {
-			if ( ! labelled_count )
+		if ( item->name ) {
+			if ( ! named_count )
 				ui.scroll.current = ui.scroll.count;
-			labelled_count++;
+			named_count++;
 			if ( select ) {
-				if ( strcmp ( select, item->label ) == 0 )
+				if ( strcmp ( select, item->name ) == 0 )
 					ui.scroll.current = ui.scroll.count;
 			} else {
 				if ( item->is_default )
@@ -298,10 +298,10 @@ int show_menu ( struct menu *menu, unsigned long timeout,
 		}
 		ui.scroll.count++;
 	}
-	if ( ! labelled_count ) {
-		/* Menus with no labelled items cannot be selected
-		 * from, and will seriously confuse the navigation
-		 * logic.  Refuse to display any such menus.
+	if ( ! named_count ) {
+		/* Menus with no named items cannot be selected from,
+		 * and will seriously confuse the navigation logic.
+		 * Refuse to display any such menus.
 		 */
 		return -ENOENT;
 	}
diff --git a/src/include/ipxe/menu.h b/src/include/ipxe/menu.h
index 3cc99be48..d11a92559 100644
--- a/src/include/ipxe/menu.h
+++ b/src/include/ipxe/menu.h
@@ -27,8 +27,8 @@ struct menu {
 struct menu_item {
 	/** List of menu items */
 	struct list_head list;
-	/** Label */
-	const char *label;
+	/** Name */
+	const char *name;
 	/** Text */
 	const char *text;
 	/** Shortcut key */
@@ -38,7 +38,7 @@ struct menu_item {
 };
 
 extern struct menu * create_menu ( const char *name, const char *title );
-extern struct menu_item * add_menu_item ( struct menu *menu, const char *label,
+extern struct menu_item * add_menu_item ( struct menu *menu, const char *name,
 					  const char *text, int shortcut,
 					  int is_default );
 extern void destroy_menu ( struct menu *menu );
-- 
cgit v1.2.3-55-g7522


From 5719cde838b6e86a02831373dae81642653b872f Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 20 Jun 2024 14:24:53 -0700
Subject: [dynui] Generalise the concept of a menu to a dynamic user interface

We currently have an abstract model of a dynamic menu as a list of
items, each of which has a name, a description, and assorted metadata
such as a shortcut key.  The "menu" and "item" commands construct
representations in this abstract model, and the "choose" command then
presents the items as a single-choice menu, with the selected item's
name used as the output value.

This same abstraction may be used to model a dynamic form as a list of
editable items, each of which has a corresponding setting name, an
optional description label, and assorted metadata such as a shortcut
key.  By defining a "form" command as an alias for the "menu" command,
we could construct and present forms using commands such as:

  #!ipxe
  form                     Login to ${url}
  item          username   Username or email address
  item --secret password   Password
  present

or

  #!ipxe
  form                Configure IPv4 networking for ${netX/ifname}
  item netX/ip        IPv4 address
  item netX/netmask   Subnet mask
  item netX/gateway   Gateway address
  item netX/dns       DNS server address
  present

Reusing the same abstract model for both menus and forms allows us to
minimise the increase in code size, since the implementation of the
"form" and "item" commands is essentially zero-cost.

Rename everything within the abstract data model from "menu" to
"dynamic user interface" to reflect this generalisation.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/config/config.c          |   2 +-
 src/core/dynui.c             | 182 ++++++++++++++++++++++++++
 src/core/menu.c              | 182 --------------------------
 src/core/parseopt.c          |  18 +--
 src/hci/commands/dynui_cmd.c | 295 +++++++++++++++++++++++++++++++++++++++++++
 src/hci/commands/menu_cmd.c  | 294 ------------------------------------------
 src/hci/tui/menu_ui.c        |  43 ++++---
 src/include/ipxe/dynui.h     |  50 ++++++++
 src/include/ipxe/errfile.h   |   2 +-
 src/include/ipxe/menu.h      |  49 -------
 src/include/ipxe/parseopt.h  |   4 +-
 11 files changed, 562 insertions(+), 559 deletions(-)
 create mode 100644 src/core/dynui.c
 delete mode 100644 src/core/menu.c
 create mode 100644 src/hci/commands/dynui_cmd.c
 delete mode 100644 src/hci/commands/menu_cmd.c
 create mode 100644 src/include/ipxe/dynui.h
 delete mode 100644 src/include/ipxe/menu.h

(limited to 'src/core')

diff --git a/src/config/config.c b/src/config/config.c
index 209336c25..666712304 100644
--- a/src/config/config.c
+++ b/src/config/config.c
@@ -225,7 +225,7 @@ REQUIRE_OBJECT ( dhcp_cmd );
 REQUIRE_OBJECT ( sanboot_cmd );
 #endif
 #ifdef MENU_CMD
-REQUIRE_OBJECT ( menu_cmd );
+REQUIRE_OBJECT ( dynui_cmd );
 #endif
 #ifdef LOGIN_CMD
 REQUIRE_OBJECT ( login_cmd );
diff --git a/src/core/dynui.c b/src/core/dynui.c
new file mode 100644
index 000000000..6e053b905
--- /dev/null
+++ b/src/core/dynui.c
@@ -0,0 +1,182 @@
+/*
+ * Copyright (C) 2012 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * Dynamic user interfaces
+ *
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
+#include <ipxe/list.h>
+#include <ipxe/dynui.h>
+
+/** List of all dynamic user interfaces */
+static LIST_HEAD ( dynamic_uis );
+
+/**
+ * Create dynamic user interface
+ *
+ * @v name		User interface name, or NULL
+ * @v title		User interface title, or NULL
+ * @ret dynui		Dynamic user interface, or NULL on failure
+ */
+struct dynamic_ui * create_dynui ( const char *name, const char *title ) {
+	struct dynamic_ui *dynui;
+	size_t name_len;
+	size_t title_len;
+	size_t len;
+	char *name_copy;
+	char *title_copy;
+
+	/* Destroy any existing user interface of this name */
+	dynui = find_dynui ( name );
+	if ( dynui )
+		destroy_dynui ( dynui );
+
+	/* Use empty title if none given */
+	if ( ! title )
+		title = "";
+
+	/* Allocate user interface */
+	name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
+	title_len = ( strlen ( title ) + 1 /* NUL */ );
+	len = ( sizeof ( *dynui ) + name_len + title_len );
+	dynui = zalloc ( len );
+	if ( ! dynui )
+		return NULL;
+	name_copy = ( ( void * ) ( dynui + 1 ) );
+	title_copy = ( name_copy + name_len );
+
+	/* Initialise user interface */
+	if ( name ) {
+		strcpy ( name_copy, name );
+		dynui->name = name_copy;
+	}
+	strcpy ( title_copy, title );
+	dynui->title = title_copy;
+	INIT_LIST_HEAD ( &dynui->items );
+
+	/* Add to list of user interfaces */
+	list_add_tail ( &dynui->list, &dynamic_uis );
+
+	DBGC ( dynui, "DYNUI %s created with title \"%s\"\n",
+	       dynui->name, dynui->title );
+
+	return dynui;
+}
+
+/**
+ * Add dynamic user interface item
+ *
+ * @v dynui		Dynamic user interface
+ * @v name		Name, or NULL
+ * @v text		Text, or NULL
+ * @v shortcut		Shortcut key
+ * @v is_default	Item is the default item
+ * @ret item		User interface item, or NULL on failure
+ */
+struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
+				       const char *name, const char *text,
+				       int shortcut, int is_default ) {
+	struct dynamic_item *item;
+	size_t name_len;
+	size_t text_len;
+	size_t len;
+	char *name_copy;
+	char *text_copy;
+
+	/* Use empty text if none given */
+	if ( ! text )
+		text = "";
+
+	/* Allocate item */
+	name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
+	text_len = ( strlen ( text ) + 1 /* NUL */ );
+	len = ( sizeof ( *item ) + name_len + text_len );
+	item = zalloc ( len );
+	if ( ! item )
+		return NULL;
+	name_copy = ( ( void * ) ( item + 1 ) );
+	text_copy = ( name_copy + name_len );
+
+	/* Initialise item */
+	if ( name ) {
+		strcpy ( name_copy, name );
+		item->name = name_copy;
+	}
+	strcpy ( text_copy, text );
+	item->text = text_copy;
+	item->shortcut = shortcut;
+	item->is_default = is_default;
+
+	/* Add to list of items */
+	list_add_tail ( &item->list, &dynui->items );
+
+	return item;
+}
+
+/**
+ * Destroy dynamic user interface
+ *
+ * @v dynui		Dynamic user interface
+ */
+void destroy_dynui ( struct dynamic_ui *dynui ) {
+	struct dynamic_item *item;
+	struct dynamic_item *tmp;
+
+	/* Remove from list of user interfaces */
+	list_del ( &dynui->list );
+
+	/* Free items */
+	list_for_each_entry_safe ( item, tmp, &dynui->items, list ) {
+		list_del ( &item->list );
+		free ( item );
+	}
+
+	/* Free user interface */
+	free ( dynui );
+}
+
+/**
+ * Find dynamic user interface
+ *
+ * @v name		User interface name, or NULL
+ * @ret dynui		Dynamic user interface, or NULL if not found
+ */
+struct dynamic_ui * find_dynui ( const char *name ) {
+	struct dynamic_ui *dynui;
+
+	list_for_each_entry ( dynui, &dynamic_uis, list ) {
+		if ( ( dynui->name == name ) ||
+		     ( strcmp ( dynui->name, name ) == 0 ) ) {
+			return dynui;
+		}
+	}
+
+	return NULL;
+}
diff --git a/src/core/menu.c b/src/core/menu.c
deleted file mode 100644
index b9d0d5b77..000000000
--- a/src/core/menu.c
+++ /dev/null
@@ -1,182 +0,0 @@
-/*
- * Copyright (C) 2012 Michael Brown <mbrown@fensystems.co.uk>.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301, USA.
- *
- * You can also choose to distribute this program under the terms of
- * the Unmodified Binary Distribution Licence (as given in the file
- * COPYING.UBDL), provided that you have satisfied its requirements.
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-/** @file
- *
- * Menu selection
- *
- */
-
-#include <stdlib.h>
-#include <string.h>
-#include <assert.h>
-#include <ipxe/list.h>
-#include <ipxe/menu.h>
-
-/** List of all menus */
-static LIST_HEAD ( menus );
-
-/**
- * Create menu
- *
- * @v name		Menu name, or NULL
- * @v title		Menu title, or NULL
- * @ret menu		Menu, or NULL on failure
- */
-struct menu * create_menu ( const char *name, const char *title ) {
-	size_t name_len;
-	size_t title_len;
-	size_t len;
-	struct menu *menu;
-	char *name_copy;
-	char *title_copy;
-
-	/* Destroy any existing menu of this name */
-	menu = find_menu ( name );
-	if ( menu )
-		destroy_menu ( menu );
-
-	/* Use empty title if none given */
-	if ( ! title )
-		title = "";
-
-	/* Allocate menu */
-	name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
-	title_len = ( strlen ( title ) + 1 /* NUL */ );
-	len = ( sizeof ( *menu ) + name_len + title_len );
-	menu = zalloc ( len );
-	if ( ! menu )
-		return NULL;
-	name_copy = ( ( void * ) ( menu + 1 ) );
-	title_copy = ( name_copy + name_len );
-
-	/* Initialise menu */
-	if ( name ) {
-		strcpy ( name_copy, name );
-		menu->name = name_copy;
-	}
-	strcpy ( title_copy, title );
-	menu->title = title_copy;
-	INIT_LIST_HEAD ( &menu->items );
-
-	/* Add to list of menus */
-	list_add_tail ( &menu->list, &menus );
-
-	DBGC ( menu, "MENU %s created with title \"%s\"\n",
-	       menu->name, menu->title );
-
-	return menu;
-}
-
-/**
- * Add menu item
- *
- * @v menu		Menu
- * @v name		Name, or NULL
- * @v text		Text, or NULL
- * @v shortcut		Shortcut key
- * @v is_default	Item is the default item
- * @ret item		Menu item, or NULL on failure
- */
-struct menu_item * add_menu_item ( struct menu *menu, const char *name,
-				   const char *text, int shortcut,
-				   int is_default ) {
-	size_t name_len;
-	size_t text_len;
-	size_t len;
-	struct menu_item *item;
-	char *name_copy;
-	char *text_copy;
-
-	/* Use empty text if none given */
-	if ( ! text )
-		text = "";
-
-	/* Allocate item */
-	name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
-	text_len = ( strlen ( text ) + 1 /* NUL */ );
-	len = ( sizeof ( *item ) + name_len + text_len );
-	item = zalloc ( len );
-	if ( ! item )
-		return NULL;
-	name_copy = ( ( void * ) ( item + 1 ) );
-	text_copy = ( name_copy + name_len );
-
-	/* Initialise item */
-	if ( name ) {
-		strcpy ( name_copy, name );
-		item->name = name_copy;
-	}
-	strcpy ( text_copy, text );
-	item->text = text_copy;
-	item->shortcut = shortcut;
-	item->is_default = is_default;
-
-	/* Add to list of items */
-	list_add_tail ( &item->list, &menu->items );
-
-	return item;
-}
-
-/**
- * Destroy menu
- *
- * @v menu		Menu
- */
-void destroy_menu ( struct menu *menu ) {
-	struct menu_item *item;
-	struct menu_item *tmp;
-
-	/* Remove from list of menus */
-	list_del ( &menu->list );
-
-	/* Free items */
-	list_for_each_entry_safe ( item, tmp, &menu->items, list ) {
-		list_del ( &item->list );
-		free ( item );
-	}
-
-	/* Free menu */
-	free ( menu );
-}
-
-/**
- * Find menu
- *
- * @v name		Menu name, or NULL
- * @ret menu		Menu, or NULL if not found
- */
-struct menu * find_menu ( const char *name ) {
-	struct menu *menu;
-
-	list_for_each_entry ( menu, &menus, list ) {
-		if ( ( menu->name == name ) ||
-		     ( strcmp ( menu->name, name ) == 0 ) ) {
-			return menu;
-		}
-	}
-
-	return NULL;
-}
diff --git a/src/core/parseopt.c b/src/core/parseopt.c
index 8410e6e90..b657c3fce 100644
--- a/src/core/parseopt.c
+++ b/src/core/parseopt.c
@@ -33,7 +33,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <getopt.h>
 #include <ipxe/uuid.h>
 #include <ipxe/netdevice.h>
-#include <ipxe/menu.h>
+#include <ipxe/dynui.h>
 #include <ipxe/settings.h>
 #include <ipxe/params.h>
 #include <ipxe/timer.h>
@@ -194,21 +194,21 @@ int parse_netdev_configurator ( char *text,
 }
 
 /**
- * Parse menu name
+ * Parse dynamic user interface name
  *
  * @v text		Text
- * @ret menu		Menu
+ * @ret dynui		Dynamic user interface
  * @ret rc		Return status code
  */
-int parse_menu ( char *text, struct menu **menu ) {
+int parse_dynui ( char *text, struct dynamic_ui **dynui ) {
 
-	/* Find menu */
-	*menu = find_menu ( text );
-	if ( ! *menu ) {
+	/* Find user interface */
+	*dynui = find_dynui ( text );
+	if ( ! *dynui ) {
 		if ( text ) {
-			printf ( "\"%s\": no such menu\n", text );
+			printf ( "\"%s\": no such user interface\n", text );
 		} else {
-			printf ( "No default menu\n" );
+			printf ( "No default user interface\n" );
 		}
 		return -ENOENT;
 	}
diff --git a/src/hci/commands/dynui_cmd.c b/src/hci/commands/dynui_cmd.c
new file mode 100644
index 000000000..dbaa669ef
--- /dev/null
+++ b/src/hci/commands/dynui_cmd.c
@@ -0,0 +1,295 @@
+/*
+ * Copyright (C) 2012 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * Dynamic user interface commands
+ *
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <getopt.h>
+#include <ipxe/dynui.h>
+#include <ipxe/command.h>
+#include <ipxe/parseopt.h>
+#include <ipxe/settings.h>
+#include <ipxe/features.h>
+
+FEATURE ( FEATURE_MISC, "Menu", DHCP_EB_FEATURE_MENU, 1 );
+
+/** "dynui" options */
+struct dynui_options {
+	/** Name */
+	char *name;
+	/** Delete */
+	int delete;
+};
+
+/** "dynui" option list */
+static struct option_descriptor dynui_opts[] = {
+	OPTION_DESC ( "name", 'n', required_argument,
+		      struct dynui_options, name, parse_string ),
+	OPTION_DESC ( "delete", 'd', no_argument,
+		      struct dynui_options, delete, parse_flag ),
+};
+
+/** "dynui" command descriptor */
+static struct command_descriptor dynui_cmd =
+	COMMAND_DESC ( struct dynui_options, dynui_opts, 0, MAX_ARGUMENTS,
+		       "[<title>]" );
+
+/**
+ * The "dynui" command
+ *
+ * @v argc		Argument count
+ * @v argv		Argument list
+ * @ret rc		Return status code
+ */
+static int dynui_exec ( int argc, char **argv ) {
+	struct dynui_options opts;
+	struct dynamic_ui *dynui;
+	char *title;
+	int rc;
+
+	/* Parse options */
+	if ( ( rc = parse_options ( argc, argv, &dynui_cmd, &opts ) ) != 0 )
+		goto err_parse_options;
+
+	/* Parse title */
+	title = concat_args ( &argv[optind] );
+	if ( ! title ) {
+		rc = -ENOMEM;
+		goto err_parse_title;
+	}
+
+	/* Create dynamic user interface */
+	dynui = create_dynui ( opts.name, title );
+	if ( ! dynui ) {
+		rc = -ENOMEM;
+		goto err_create_dynui;
+	}
+
+	/* Destroy dynamic user interface, if applicable */
+	if ( opts.delete )
+		destroy_dynui ( dynui );
+
+	/* Success */
+	rc = 0;
+
+ err_create_dynui:
+	free ( title );
+ err_parse_title:
+ err_parse_options:
+	return rc;
+}
+
+/** "item" options */
+struct item_options {
+	/** Dynamic user interface name */
+	char *dynui;
+	/** Shortcut key */
+	unsigned int key;
+	/** Use as default */
+	int is_default;
+	/** Use as a separator */
+	int is_gap;
+};
+
+/** "item" option list */
+static struct option_descriptor item_opts[] = {
+	OPTION_DESC ( "menu", 'm', required_argument,
+		      struct item_options, dynui, parse_string ),
+	OPTION_DESC ( "key", 'k', required_argument,
+		      struct item_options, key, parse_key ),
+	OPTION_DESC ( "default", 'd', no_argument,
+		      struct item_options, is_default, parse_flag ),
+	OPTION_DESC ( "gap", 'g', no_argument,
+		      struct item_options, is_gap, parse_flag ),
+};
+
+/** "item" command descriptor */
+static struct command_descriptor item_cmd =
+	COMMAND_DESC ( struct item_options, item_opts, 0, MAX_ARGUMENTS,
+		       "[<name> [<text>]]" );
+
+/**
+ * The "item" command
+ *
+ * @v argc		Argument count
+ * @v argv		Argument list
+ * @ret rc		Return status code
+ */
+static int item_exec ( int argc, char **argv ) {
+	struct item_options opts;
+	struct dynamic_ui *dynui;
+	struct dynamic_item *item;
+	char *name = NULL;
+	char *text = NULL;
+	int rc;
+
+	/* Parse options */
+	if ( ( rc = parse_options ( argc, argv, &item_cmd, &opts ) ) != 0 )
+		goto err_parse_options;
+
+	/* Parse name, if present */
+	if ( ! opts.is_gap )
+		name = argv[optind++]; /* May be NULL */
+
+	/* Parse text, if present */
+	if ( optind < argc ) {
+		text = concat_args ( &argv[optind] );
+		if ( ! text ) {
+			rc = -ENOMEM;
+			goto err_parse_text;
+		}
+	}
+
+	/* Identify dynamic user interface */
+	if ( ( rc = parse_dynui ( opts.dynui, &dynui ) ) != 0 )
+		goto err_parse_dynui;
+
+	/* Add dynamic user interface item */
+	item = add_dynui_item ( dynui, name, ( text ? text : "" ),
+				opts.key, opts.is_default );
+	if ( ! item ) {
+		rc = -ENOMEM;
+		goto err_add_dynui_item;
+	}
+
+	/* Success */
+	rc = 0;
+
+ err_add_dynui_item:
+ err_parse_dynui:
+	free ( text );
+ err_parse_text:
+ err_parse_options:
+	return rc;
+}
+
+/** "choose" options */
+struct choose_options {
+	/** Dynamic user interface name */
+	char *dynui;
+	/** Timeout */
+	unsigned long timeout;
+	/** Default selection */
+	char *select;
+	/** Keep dynamic user interface */
+	int keep;
+};
+
+/** "choose" option list */
+static struct option_descriptor choose_opts[] = {
+	OPTION_DESC ( "menu", 'm', required_argument,
+		      struct choose_options, dynui, parse_string ),
+	OPTION_DESC ( "default", 'd', required_argument,
+		      struct choose_options, select, parse_string ),
+	OPTION_DESC ( "timeout", 't', required_argument,
+		      struct choose_options, timeout, parse_timeout ),
+	OPTION_DESC ( "keep", 'k', no_argument,
+		      struct choose_options, keep, parse_flag ),
+};
+
+/** "choose" command descriptor */
+static struct command_descriptor choose_cmd =
+	COMMAND_DESC ( struct choose_options, choose_opts, 1, 1, "<setting>" );
+
+/**
+ * The "choose" command
+ *
+ * @v argc		Argument count
+ * @v argv		Argument list
+ * @ret rc		Return status code
+ */
+static int choose_exec ( int argc, char **argv ) {
+	struct choose_options opts;
+	struct named_setting setting;
+	struct dynamic_ui *dynui;
+	struct dynamic_item *item;
+	int rc;
+
+	/* Parse options */
+	if ( ( rc = parse_options ( argc, argv, &choose_cmd, &opts ) ) != 0 )
+		goto err_parse_options;
+
+	/* Parse setting name */
+	if ( ( rc = parse_autovivified_setting ( argv[optind],
+						 &setting ) ) != 0 )
+		goto err_parse_setting;
+
+	/* Identify dynamic user interface */
+	if ( ( rc = parse_dynui ( opts.dynui, &dynui ) ) != 0 )
+		goto err_parse_dynui;
+
+	/* Show as menu */
+	if ( ( rc = show_menu ( dynui, opts.timeout, opts.select,
+				&item ) ) != 0 )
+		goto err_show_menu;
+
+	/* Apply default type if necessary */
+	if ( ! setting.setting.type )
+		setting.setting.type = &setting_type_string;
+
+	/* Store setting */
+	if ( ( rc = storef_setting ( setting.settings, &setting.setting,
+				     item->name ) ) != 0 ) {
+		printf ( "Could not store \"%s\": %s\n",
+			 setting.setting.name, strerror ( rc ) );
+		goto err_store;
+	}
+
+	/* Success */
+	rc = 0;
+
+ err_store:
+ err_show_menu:
+	/* Destroy dynamic user interface, if applicable */
+	if ( ! opts.keep )
+		destroy_dynui ( dynui );
+ err_parse_dynui:
+ err_parse_setting:
+ err_parse_options:
+	return rc;
+}
+
+/** Dynamic user interface commands */
+struct command dynui_commands[] __command = {
+	{
+		.name = "menu",
+		.exec = dynui_exec,
+	},
+	{
+		.name = "item",
+		.exec = item_exec,
+	},
+	{
+		.name = "choose",
+		.exec = choose_exec,
+	},
+};
diff --git a/src/hci/commands/menu_cmd.c b/src/hci/commands/menu_cmd.c
deleted file mode 100644
index 8b6d2a9f1..000000000
--- a/src/hci/commands/menu_cmd.c
+++ /dev/null
@@ -1,294 +0,0 @@
-/*
- * Copyright (C) 2012 Michael Brown <mbrown@fensystems.co.uk>.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301, USA.
- *
- * You can also choose to distribute this program under the terms of
- * the Unmodified Binary Distribution Licence (as given in the file
- * COPYING.UBDL), provided that you have satisfied its requirements.
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-/** @file
- *
- * Menu commands
- *
- */
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-#include <getopt.h>
-#include <ipxe/menu.h>
-#include <ipxe/command.h>
-#include <ipxe/parseopt.h>
-#include <ipxe/settings.h>
-#include <ipxe/features.h>
-
-FEATURE ( FEATURE_MISC, "Menu", DHCP_EB_FEATURE_MENU, 1 );
-
-/** "menu" options */
-struct menu_options {
-	/** Name */
-	char *name;
-	/** Delete */
-	int delete;
-};
-
-/** "menu" option list */
-static struct option_descriptor menu_opts[] = {
-	OPTION_DESC ( "name", 'n', required_argument,
-		      struct menu_options, name, parse_string ),
-	OPTION_DESC ( "delete", 'd', no_argument,
-		      struct menu_options, delete, parse_flag ),
-};
-
-/** "menu" command descriptor */
-static struct command_descriptor menu_cmd =
-	COMMAND_DESC ( struct menu_options, menu_opts, 0, MAX_ARGUMENTS,
-		       "[<title>]" );
-
-/**
- * The "menu" command
- *
- * @v argc		Argument count
- * @v argv		Argument list
- * @ret rc		Return status code
- */
-static int menu_exec ( int argc, char **argv ) {
-	struct menu_options opts;
-	struct menu *menu;
-	char *title;
-	int rc;
-
-	/* Parse options */
-	if ( ( rc = parse_options ( argc, argv, &menu_cmd, &opts ) ) != 0 )
-		goto err_parse_options;
-
-	/* Parse title */
-	title = concat_args ( &argv[optind] );
-	if ( ! title ) {
-		rc = -ENOMEM;
-		goto err_parse_title;
-	}
-
-	/* Create menu */
-	menu = create_menu ( opts.name, title );
-	if ( ! menu ) {
-		rc = -ENOMEM;
-		goto err_create_menu;
-	}
-
-	/* Destroy menu, if applicable */
-	if ( opts.delete )
-		destroy_menu ( menu );
-
-	/* Success */
-	rc = 0;
-
- err_create_menu:
-	free ( title );
- err_parse_title:
- err_parse_options:
-	return rc;
-}
-
-/** "item" options */
-struct item_options {
-	/** Menu name */
-	char *menu;
-	/** Shortcut key */
-	unsigned int key;
-	/** Use as default */
-	int is_default;
-	/** Use as a separator */
-	int is_gap;
-};
-
-/** "item" option list */
-static struct option_descriptor item_opts[] = {
-	OPTION_DESC ( "menu", 'm', required_argument,
-		      struct item_options, menu, parse_string ),
-	OPTION_DESC ( "key", 'k', required_argument,
-		      struct item_options, key, parse_key ),
-	OPTION_DESC ( "default", 'd', no_argument,
-		      struct item_options, is_default, parse_flag ),
-	OPTION_DESC ( "gap", 'g', no_argument,
-		      struct item_options, is_gap, parse_flag ),
-};
-
-/** "item" command descriptor */
-static struct command_descriptor item_cmd =
-	COMMAND_DESC ( struct item_options, item_opts, 0, MAX_ARGUMENTS,
-		       "[<name> [<text>]]" );
-
-/**
- * The "item" command
- *
- * @v argc		Argument count
- * @v argv		Argument list
- * @ret rc		Return status code
- */
-static int item_exec ( int argc, char **argv ) {
-	struct item_options opts;
-	struct menu *menu;
-	struct menu_item *item;
-	char *name = NULL;
-	char *text = NULL;
-	int rc;
-
-	/* Parse options */
-	if ( ( rc = parse_options ( argc, argv, &item_cmd, &opts ) ) != 0 )
-		goto err_parse_options;
-
-	/* Parse name, if present */
-	if ( ! opts.is_gap )
-		name = argv[optind++]; /* May be NULL */
-
-	/* Parse text, if present */
-	if ( optind < argc ) {
-		text = concat_args ( &argv[optind] );
-		if ( ! text ) {
-			rc = -ENOMEM;
-			goto err_parse_text;
-		}
-	}
-
-	/* Identify menu */
-	if ( ( rc = parse_menu ( opts.menu, &menu ) ) != 0 )
-		goto err_parse_menu;
-
-	/* Add menu item */
-	item = add_menu_item ( menu, name, ( text ? text : "" ),
-			       opts.key, opts.is_default );
-	if ( ! item ) {
-		rc = -ENOMEM;
-		goto err_add_menu_item;
-	}
-
-	/* Success */
-	rc = 0;
-
- err_add_menu_item:
- err_parse_menu:
-	free ( text );
- err_parse_text:
- err_parse_options:
-	return rc;
-}
-
-/** "choose" options */
-struct choose_options {
-	/** Menu name */
-	char *menu;
-	/** Timeout */
-	unsigned long timeout;
-	/** Default selection */
-	char *select;
-	/** Keep menu */
-	int keep;
-};
-
-/** "choose" option list */
-static struct option_descriptor choose_opts[] = {
-	OPTION_DESC ( "menu", 'm', required_argument,
-		      struct choose_options, menu, parse_string ),
-	OPTION_DESC ( "default", 'd', required_argument,
-		      struct choose_options, select, parse_string ),
-	OPTION_DESC ( "timeout", 't', required_argument,
-		      struct choose_options, timeout, parse_timeout ),
-	OPTION_DESC ( "keep", 'k', no_argument,
-		      struct choose_options, keep, parse_flag ),
-};
-
-/** "choose" command descriptor */
-static struct command_descriptor choose_cmd =
-	COMMAND_DESC ( struct choose_options, choose_opts, 1, 1, "<setting>" );
-
-/**
- * The "choose" command
- *
- * @v argc		Argument count
- * @v argv		Argument list
- * @ret rc		Return status code
- */
-static int choose_exec ( int argc, char **argv ) {
-	struct choose_options opts;
-	struct named_setting setting;
-	struct menu *menu;
-	struct menu_item *item;
-	int rc;
-
-	/* Parse options */
-	if ( ( rc = parse_options ( argc, argv, &choose_cmd, &opts ) ) != 0 )
-		goto err_parse_options;
-
-	/* Parse setting name */
-	if ( ( rc = parse_autovivified_setting ( argv[optind],
-						 &setting ) ) != 0 )
-		goto err_parse_setting;
-
-	/* Identify menu */
-	if ( ( rc = parse_menu ( opts.menu, &menu ) ) != 0 )
-		goto err_parse_menu;
-
-	/* Show menu */
-	if ( ( rc = show_menu ( menu, opts.timeout, opts.select, &item ) ) != 0)
-		goto err_show_menu;
-
-	/* Apply default type if necessary */
-	if ( ! setting.setting.type )
-		setting.setting.type = &setting_type_string;
-
-	/* Store setting */
-	if ( ( rc = storef_setting ( setting.settings, &setting.setting,
-				     item->name ) ) != 0 ) {
-		printf ( "Could not store \"%s\": %s\n",
-			 setting.setting.name, strerror ( rc ) );
-		goto err_store;
-	}
-
-	/* Success */
-	rc = 0;
-
- err_store:
- err_show_menu:
-	/* Destroy menu, if applicable */
-	if ( ! opts.keep )
-		destroy_menu ( menu );
- err_parse_menu:
- err_parse_setting:
- err_parse_options:
-	return rc;
-}
-
-/** Menu commands */
-struct command menu_commands[] __command = {
-	{
-		.name = "menu",
-		.exec = menu_exec,
-	},
-	{
-		.name = "item",
-		.exec = item_exec,
-	},
-	{
-		.name = "choose",
-		.exec = choose_exec,
-	},
-};
diff --git a/src/hci/tui/menu_ui.c b/src/hci/tui/menu_ui.c
index 067e2d8ca..ab4e602a7 100644
--- a/src/hci/tui/menu_ui.c
+++ b/src/hci/tui/menu_ui.c
@@ -37,7 +37,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/console.h>
 #include <ipxe/ansicol.h>
 #include <ipxe/jumpscroll.h>
-#include <ipxe/menu.h>
+#include <ipxe/dynui.h>
 
 /* Screen layout */
 #define TITLE_ROW	1U
@@ -49,8 +49,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 /** A menu user interface */
 struct menu_ui {
-	/** Menu */
-	struct menu *menu;
+	/** Dynamic user interface */
+	struct dynamic_ui *dynui;
 	/** Jump scroller */
 	struct jump_scroller scroll;
 	/** Timeout (0=indefinite) */
@@ -60,14 +60,15 @@ struct menu_ui {
 /**
  * Return a numbered menu item
  *
- * @v menu		Menu
+ * @v dynui		Dynamic user interface
  * @v index		Index
  * @ret item		Menu item, or NULL
  */
-static struct menu_item * menu_item ( struct menu *menu, unsigned int index ) {
-	struct menu_item *item;
+static struct dynamic_item * menu_item ( struct dynamic_ui *dynui,
+					 unsigned int index ) {
+	struct dynamic_item *item;
 
-	list_for_each_entry ( item, &menu->items, list ) {
+	list_for_each_entry ( item, &dynui->items, list ) {
 		if ( index-- == 0 )
 			return item;
 	}
@@ -82,7 +83,7 @@ static struct menu_item * menu_item ( struct menu *menu, unsigned int index ) {
  * @v index		Index
  */
 static void draw_menu_item ( struct menu_ui *ui, unsigned int index ) {
-	struct menu_item *item;
+	struct dynamic_item *item;
 	unsigned int row_offset;
 	char buf[ MENU_COLS + 1 /* NUL */ ];
 	char timeout_buf[6]; /* "(xxx)" + NUL */
@@ -95,7 +96,7 @@ static void draw_menu_item ( struct menu_ui *ui, unsigned int index ) {
 	move ( ( MENU_ROW + row_offset ), MENU_COL );
 
 	/* Get menu item */
-	item = menu_item ( ui->menu, index );
+	item = menu_item ( ui->dynui, index );
 	if ( item ) {
 
 		/* Draw separators in a different colour */
@@ -171,8 +172,8 @@ static void draw_menu_items ( struct menu_ui *ui ) {
  * @ret selected	Selected item
  * @ret rc		Return status code
  */
-static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
-	struct menu_item *item;
+static int menu_loop ( struct menu_ui *ui, struct dynamic_item **selected ) {
+	struct dynamic_item *item;
 	unsigned long timeout;
 	unsigned int previous;
 	unsigned int move;
@@ -217,7 +218,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 				break;
 			default:
 				i = 0;
-				list_for_each_entry ( item, &ui->menu->items,
+				list_for_each_entry ( item, &ui->dynui->items,
 						      list ) {
 					if ( ! ( item->shortcut &&
 						 ( item->shortcut == key ) ) ) {
@@ -238,7 +239,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 		/* Move selection, if applicable */
 		while ( move ) {
 			move = jump_scroll_move ( &ui->scroll, move );
-			item = menu_item ( ui->menu, ui->scroll.current );
+			item = menu_item ( ui->dynui, ui->scroll.current );
 			if ( item->name )
 				break;
 		}
@@ -252,7 +253,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 		}
 
 		/* Record selection */
-		item = menu_item ( ui->menu, ui->scroll.current );
+		item = menu_item ( ui->dynui, ui->scroll.current );
 		assert ( item != NULL );
 		assert ( item->name != NULL );
 		*selected = item;
@@ -265,14 +266,14 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) {
 /**
  * Show menu
  *
- * @v menu		Menu
+ * @v dynui		Dynamic user interface
  * @v timeout		Timeout period, in ticks (0=indefinite)
  * @ret selected	Selected item
  * @ret rc		Return status code
  */
-int show_menu ( struct menu *menu, unsigned long timeout,
-		const char *select, struct menu_item **selected ) {
-	struct menu_item *item;
+int show_menu ( struct dynamic_ui *dynui, unsigned long timeout,
+		const char *select, struct dynamic_item **selected ) {
+	struct dynamic_item *item;
 	struct menu_ui ui;
 	char buf[ MENU_COLS + 1 /* NUL */ ];
 	int named_count = 0;
@@ -280,10 +281,10 @@ int show_menu ( struct menu *menu, unsigned long timeout,
 
 	/* Initialise UI */
 	memset ( &ui, 0, sizeof ( ui ) );
-	ui.menu = menu;
+	ui.dynui = dynui;
 	ui.scroll.rows = MENU_ROWS;
 	ui.timeout = timeout;
-	list_for_each_entry ( item, &menu->items, list ) {
+	list_for_each_entry ( item, &dynui->items, list ) {
 		if ( item->name ) {
 			if ( ! named_count )
 				ui.scroll.current = ui.scroll.count;
@@ -315,7 +316,7 @@ int show_menu ( struct menu *menu, unsigned long timeout,
 
 	/* Draw initial content */
 	attron ( A_BOLD );
-	snprintf ( buf, sizeof ( buf ), "%s", ui.menu->title );
+	snprintf ( buf, sizeof ( buf ), "%s", ui.dynui->title );
 	mvprintw ( TITLE_ROW, ( ( COLS - strlen ( buf ) ) / 2 ), "%s", buf );
 	attroff ( A_BOLD );
 	jump_scroll ( &ui.scroll );
diff --git a/src/include/ipxe/dynui.h b/src/include/ipxe/dynui.h
new file mode 100644
index 000000000..25124a3af
--- /dev/null
+++ b/src/include/ipxe/dynui.h
@@ -0,0 +1,50 @@
+#ifndef _IPXE_DYNUI_H
+#define _IPXE_DYNUI_H
+
+/** @file
+ *
+ * Dynamic user interfaces
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/list.h>
+
+/** A dynamic user interface */
+struct dynamic_ui {
+	/** List of dynamic user interfaces */
+	struct list_head list;
+	/** Name */
+	const char *name;
+	/** Title */
+	const char *title;
+	/** Dynamic user interface items */
+	struct list_head items;
+};
+
+/** A dynamic user interface item */
+struct dynamic_item {
+	/** List of dynamic user interface items */
+	struct list_head list;
+	/** Name */
+	const char *name;
+	/** Text */
+	const char *text;
+	/** Shortcut key */
+	int shortcut;
+	/** Is default item */
+	int is_default;
+};
+
+extern struct dynamic_ui * create_dynui ( const char *name, const char *title );
+extern struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
+					      const char *name,
+					      const char *text, int shortcut,
+					      int is_default );
+extern void destroy_dynui ( struct dynamic_ui *dynui );
+extern struct dynamic_ui * find_dynui ( const char *name );
+extern int show_menu ( struct dynamic_ui *dynui, unsigned long timeout,
+		       const char *select, struct dynamic_item **selected );
+
+#endif /* _IPXE_DYNUI_H */
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index a9ce6569b..d75661ba7 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -364,7 +364,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define ERRFILE_cms		      ( ERRFILE_OTHER | 0x002a0000 )
 #define ERRFILE_imgtrust	      ( ERRFILE_OTHER | 0x002b0000 )
 #define ERRFILE_menu_ui		      ( ERRFILE_OTHER | 0x002c0000 )
-#define ERRFILE_menu_cmd	      ( ERRFILE_OTHER | 0x002d0000 )
+#define ERRFILE_dynui_cmd	      ( ERRFILE_OTHER | 0x002d0000 )
 #define ERRFILE_validator	      ( ERRFILE_OTHER | 0x002e0000 )
 #define ERRFILE_ocsp		      ( ERRFILE_OTHER | 0x002f0000 )
 #define ERRFILE_nslookup	      ( ERRFILE_OTHER | 0x00300000 )
diff --git a/src/include/ipxe/menu.h b/src/include/ipxe/menu.h
deleted file mode 100644
index d11a92559..000000000
--- a/src/include/ipxe/menu.h
+++ /dev/null
@@ -1,49 +0,0 @@
-#ifndef _IPXE_MENU_H
-#define _IPXE_MENU_H
-
-/** @file
- *
- * Menu selection
- *
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#include <ipxe/list.h>
-
-/** A menu */
-struct menu {
-	/** List of menus */
-	struct list_head list;
-	/** Name */
-	const char *name;
-	/** Title */
-	const char *title;
-	/** Menu items */
-	struct list_head items;
-};
-
-/** A menu item */
-struct menu_item {
-	/** List of menu items */
-	struct list_head list;
-	/** Name */
-	const char *name;
-	/** Text */
-	const char *text;
-	/** Shortcut key */
-	int shortcut;
-	/** Is default item */
-	int is_default;
-};
-
-extern struct menu * create_menu ( const char *name, const char *title );
-extern struct menu_item * add_menu_item ( struct menu *menu, const char *name,
-					  const char *text, int shortcut,
-					  int is_default );
-extern void destroy_menu ( struct menu *menu );
-extern struct menu * find_menu ( const char *name );
-extern int show_menu ( struct menu *menu, unsigned long timeout,
-		       const char *select, struct menu_item **selected );
-
-#endif /* _IPXE_MENU_H */
diff --git a/src/include/ipxe/parseopt.h b/src/include/ipxe/parseopt.h
index 61010f22a..5c449cd42 100644
--- a/src/include/ipxe/parseopt.h
+++ b/src/include/ipxe/parseopt.h
@@ -16,7 +16,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 struct net_device;
 struct net_device_configurator;
-struct menu;
+struct dynamic_ui;
 struct parameters;
 
 /** A command-line option descriptor */
@@ -142,7 +142,7 @@ extern int parse_netdev ( char *text, struct net_device **netdev );
 extern int
 parse_netdev_configurator ( char *text,
 			    struct net_device_configurator **configurator );
-extern int parse_menu ( char *text, struct menu **menu );
+extern int parse_dynui ( char *text, struct dynamic_ui **dynui );
 extern int parse_flag ( char *text __unused, int *flag );
 extern int parse_key ( char *text, unsigned int *key );
 extern int parse_settings ( char *text, struct settings **settings );
-- 
cgit v1.2.3-55-g7522


From c8e50bb0fd3d9d1629e5c78f92bbf7bc9af84f2c Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 20 Jun 2024 14:16:18 -0700
Subject: [dynui] Generalise mechanisms for looking up user interface items

Generalise the ability to look up a dynamic user interface item by
index or by shortcut key, to allow for reuse of this code for
interactive forms.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/dynui.c         | 38 ++++++++++++++++++++++++++++++++++++++
 src/hci/tui/menu_ui.c    | 38 ++++++--------------------------------
 src/include/ipxe/dynui.h |  8 ++++++++
 3 files changed, 52 insertions(+), 32 deletions(-)

(limited to 'src/core')

diff --git a/src/core/dynui.c b/src/core/dynui.c
index 6e053b905..33218f598 100644
--- a/src/core/dynui.c
+++ b/src/core/dynui.c
@@ -131,6 +131,7 @@ struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
 	}
 	strcpy ( text_copy, text );
 	item->text = text_copy;
+	item->index = dynui->count++;
 	item->shortcut = shortcut;
 	item->is_default = is_default;
 
@@ -180,3 +181,40 @@ struct dynamic_ui * find_dynui ( const char *name ) {
 
 	return NULL;
 }
+
+/**
+ * Find dynamic user interface item by index
+ *
+ * @v dynui		Dynamic user interface
+ * @v index		Index
+ * @ret item		User interface item, or NULL if not found
+ */
+struct dynamic_item * dynui_item ( struct dynamic_ui *dynui,
+				   unsigned int index ) {
+	struct dynamic_item *item;
+
+	list_for_each_entry ( item, &dynui->items, list ) {
+		if ( index-- == 0 )
+			return item;
+	}
+
+	return NULL;
+}
+
+/**
+ * Find dynamic user interface item by shortcut key
+ *
+ * @v dynui		Dynamic user interface
+ * @v key		Shortcut key
+ * @ret item		User interface item, or NULL if not found
+ */
+struct dynamic_item * dynui_shortcut ( struct dynamic_ui *dynui, int key ) {
+	struct dynamic_item *item;
+
+	list_for_each_entry ( item, &dynui->items, list ) {
+		if ( key && ( key == item->shortcut ) )
+			return item;
+	}
+
+	return NULL;
+}
diff --git a/src/hci/tui/menu_ui.c b/src/hci/tui/menu_ui.c
index ab4e602a7..00cdab8df 100644
--- a/src/hci/tui/menu_ui.c
+++ b/src/hci/tui/menu_ui.c
@@ -57,25 +57,6 @@ struct menu_ui {
 	unsigned long timeout;
 };
 
-/**
- * Return a numbered menu item
- *
- * @v dynui		Dynamic user interface
- * @v index		Index
- * @ret item		Menu item, or NULL
- */
-static struct dynamic_item * menu_item ( struct dynamic_ui *dynui,
-					 unsigned int index ) {
-	struct dynamic_item *item;
-
-	list_for_each_entry ( item, &dynui->items, list ) {
-		if ( index-- == 0 )
-			return item;
-	}
-
-	return NULL;
-}
-
 /**
  * Draw a numbered menu item
  *
@@ -96,7 +77,7 @@ static void draw_menu_item ( struct menu_ui *ui, unsigned int index ) {
 	move ( ( MENU_ROW + row_offset ), MENU_COL );
 
 	/* Get menu item */
-	item = menu_item ( ui->dynui, index );
+	item = dynui_item ( ui->dynui, index );
 	if ( item ) {
 
 		/* Draw separators in a different colour */
@@ -178,7 +159,6 @@ static int menu_loop ( struct menu_ui *ui, struct dynamic_item **selected ) {
 	unsigned int previous;
 	unsigned int move;
 	int key;
-	int i;
 	int chosen = 0;
 	int rc = 0;
 
@@ -217,15 +197,9 @@ static int menu_loop ( struct menu_ui *ui, struct dynamic_item **selected ) {
 				chosen = 1;
 				break;
 			default:
-				i = 0;
-				list_for_each_entry ( item, &ui->dynui->items,
-						      list ) {
-					if ( ! ( item->shortcut &&
-						 ( item->shortcut == key ) ) ) {
-						i++;
-						continue;
-					}
-					ui->scroll.current = i;
+				item = dynui_shortcut ( ui->dynui, key );
+				if ( item ) {
+					ui->scroll.current = item->index;
 					if ( item->name ) {
 						chosen = 1;
 					} else {
@@ -239,7 +213,7 @@ static int menu_loop ( struct menu_ui *ui, struct dynamic_item **selected ) {
 		/* Move selection, if applicable */
 		while ( move ) {
 			move = jump_scroll_move ( &ui->scroll, move );
-			item = menu_item ( ui->dynui, ui->scroll.current );
+			item = dynui_item ( ui->dynui, ui->scroll.current );
 			if ( item->name )
 				break;
 		}
@@ -253,7 +227,7 @@ static int menu_loop ( struct menu_ui *ui, struct dynamic_item **selected ) {
 		}
 
 		/* Record selection */
-		item = menu_item ( ui->dynui, ui->scroll.current );
+		item = dynui_item ( ui->dynui, ui->scroll.current );
 		assert ( item != NULL );
 		assert ( item->name != NULL );
 		*selected = item;
diff --git a/src/include/ipxe/dynui.h b/src/include/ipxe/dynui.h
index 25124a3af..f38d44825 100644
--- a/src/include/ipxe/dynui.h
+++ b/src/include/ipxe/dynui.h
@@ -21,6 +21,8 @@ struct dynamic_ui {
 	const char *title;
 	/** Dynamic user interface items */
 	struct list_head items;
+	/** Number of user interface items */
+	unsigned int count;
 };
 
 /** A dynamic user interface item */
@@ -31,6 +33,8 @@ struct dynamic_item {
 	const char *name;
 	/** Text */
 	const char *text;
+	/** Index */
+	unsigned int index;
 	/** Shortcut key */
 	int shortcut;
 	/** Is default item */
@@ -44,6 +48,10 @@ extern struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
 					      int is_default );
 extern void destroy_dynui ( struct dynamic_ui *dynui );
 extern struct dynamic_ui * find_dynui ( const char *name );
+extern struct dynamic_item * dynui_item ( struct dynamic_ui *dynui,
+					  unsigned int index );
+extern struct dynamic_item * dynui_shortcut ( struct dynamic_ui *dynui,
+					      int key );
 extern int show_menu ( struct dynamic_ui *dynui, unsigned long timeout,
 		       const char *select, struct dynamic_item **selected );
 
-- 
cgit v1.2.3-55-g7522


From 039019039e89aedf4c5a0d81c351638a1e036335 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 20 Jun 2024 16:20:05 -0700
Subject: [dynui] Allow for multiple flags on a user interface item

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/dynui.c             |  6 +++---
 src/hci/commands/dynui_cmd.c |  7 +++++--
 src/hci/tui/menu_ui.c        |  2 +-
 src/include/ipxe/dynui.h     | 12 ++++++++----
 4 files changed, 17 insertions(+), 10 deletions(-)

(limited to 'src/core')

diff --git a/src/core/dynui.c b/src/core/dynui.c
index 33218f598..3d139c02a 100644
--- a/src/core/dynui.c
+++ b/src/core/dynui.c
@@ -96,13 +96,13 @@ struct dynamic_ui * create_dynui ( const char *name, const char *title ) {
  * @v dynui		Dynamic user interface
  * @v name		Name, or NULL
  * @v text		Text, or NULL
+ * @v flags		Flags
  * @v shortcut		Shortcut key
- * @v is_default	Item is the default item
  * @ret item		User interface item, or NULL on failure
  */
 struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
 				       const char *name, const char *text,
-				       int shortcut, int is_default ) {
+				       unsigned int flags, int shortcut ) {
 	struct dynamic_item *item;
 	size_t name_len;
 	size_t text_len;
@@ -132,8 +132,8 @@ struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
 	strcpy ( text_copy, text );
 	item->text = text_copy;
 	item->index = dynui->count++;
+	item->flags = flags;
 	item->shortcut = shortcut;
-	item->is_default = is_default;
 
 	/* Add to list of items */
 	list_add_tail ( &item->list, &dynui->items );
diff --git a/src/hci/commands/dynui_cmd.c b/src/hci/commands/dynui_cmd.c
index dbaa669ef..557c5db5d 100644
--- a/src/hci/commands/dynui_cmd.c
+++ b/src/hci/commands/dynui_cmd.c
@@ -148,6 +148,7 @@ static int item_exec ( int argc, char **argv ) {
 	struct item_options opts;
 	struct dynamic_ui *dynui;
 	struct dynamic_item *item;
+	unsigned int flags = 0;
 	char *name = NULL;
 	char *text = NULL;
 	int rc;
@@ -174,8 +175,10 @@ static int item_exec ( int argc, char **argv ) {
 		goto err_parse_dynui;
 
 	/* Add dynamic user interface item */
-	item = add_dynui_item ( dynui, name, ( text ? text : "" ),
-				opts.key, opts.is_default );
+	if ( opts.is_default )
+		flags |= DYNUI_DEFAULT;
+	item = add_dynui_item ( dynui, name, ( text ? text : "" ), flags,
+				opts.key );
 	if ( ! item ) {
 		rc = -ENOMEM;
 		goto err_add_dynui_item;
diff --git a/src/hci/tui/menu_ui.c b/src/hci/tui/menu_ui.c
index 00cdab8df..b7b52ee62 100644
--- a/src/hci/tui/menu_ui.c
+++ b/src/hci/tui/menu_ui.c
@@ -267,7 +267,7 @@ int show_menu ( struct dynamic_ui *dynui, unsigned long timeout,
 				if ( strcmp ( select, item->name ) == 0 )
 					ui.scroll.current = ui.scroll.count;
 			} else {
-				if ( item->is_default )
+				if ( item->flags & DYNUI_DEFAULT )
 					ui.scroll.current = ui.scroll.count;
 			}
 		}
diff --git a/src/include/ipxe/dynui.h b/src/include/ipxe/dynui.h
index f38d44825..5ba007032 100644
--- a/src/include/ipxe/dynui.h
+++ b/src/include/ipxe/dynui.h
@@ -35,17 +35,21 @@ struct dynamic_item {
 	const char *text;
 	/** Index */
 	unsigned int index;
+	/** Flags */
+	unsigned int flags;
 	/** Shortcut key */
 	int shortcut;
-	/** Is default item */
-	int is_default;
 };
 
+/** Dynamic user interface item is default selection */
+#define DYNUI_DEFAULT 0x0001
+
 extern struct dynamic_ui * create_dynui ( const char *name, const char *title );
 extern struct dynamic_item * add_dynui_item ( struct dynamic_ui *dynui,
 					      const char *name,
-					      const char *text, int shortcut,
-					      int is_default );
+					      const char *text,
+					      unsigned int flags,
+					      int shortcut );
 extern void destroy_dynui ( struct dynamic_ui *dynui );
 extern struct dynamic_ui * find_dynui ( const char *name );
 extern struct dynamic_item * dynui_item ( struct dynamic_ui *dynui,
-- 
cgit v1.2.3-55-g7522


From 49404bfea99f68f4c364ea30a9ad3ea6ffb7e5f6 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 29 Aug 2024 13:08:27 +0100
Subject: [image] Split image_strip_suffix() out from image_extract()

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/archive.c       |  7 ++-----
 src/core/image.c         | 19 +++++++++++++++++++
 src/include/ipxe/image.h |  1 +
 3 files changed, 22 insertions(+), 5 deletions(-)

(limited to 'src/core')

diff --git a/src/core/archive.c b/src/core/archive.c
index bb62c7e47..3d3f00cc6 100644
--- a/src/core/archive.c
+++ b/src/core/archive.c
@@ -43,7 +43,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 int image_extract ( struct image *image, const char *name,
 		    struct image **extracted ) {
-	char *dot;
 	int rc;
 
 	/* Check that this image can be used to extract an archive image */
@@ -66,10 +65,8 @@ int image_extract ( struct image *image, const char *name,
 	}
 
 	/* Strip any archive or compression suffix from implicit name */
-	if ( ( ! name ) && ( (*extracted)->name ) &&
-	     ( ( dot = strrchr ( (*extracted)->name, '.' ) ) != NULL ) ) {
-		*dot = '\0';
-	}
+	if ( ! name )
+		image_strip_suffix ( *extracted );
 
 	/* Try extracting archive image */
 	if ( ( rc = image->type->extract ( image, *extracted ) ) != 0 ) {
diff --git a/src/core/image.c b/src/core/image.c
index bf0e4f756..c69c05c93 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -172,6 +172,25 @@ int image_set_name ( struct image *image, const char *name ) {
 	return 0;
 }
 
+/**
+ * Strip dot suffix from image name, if present
+ *
+ * @v image		Image
+ * @ret sep		Position of old dot separator, or NULL
+ */
+char * image_strip_suffix ( struct image *image ) {
+	char *dot;
+
+	/* Locate and strip suffix, if present */
+	if ( image->name &&
+	     ( ( dot = strrchr ( image->name, '.' ) ) != NULL ) ) {
+		*dot = '\0';
+		return dot;
+	}
+
+	return NULL;
+}
+
 /**
  * Set image command line
  *
diff --git a/src/include/ipxe/image.h b/src/include/ipxe/image.h
index bfbf23687..ca383dc7b 100644
--- a/src/include/ipxe/image.h
+++ b/src/include/ipxe/image.h
@@ -188,6 +188,7 @@ static inline struct image * first_image ( void ) {
 extern struct image * alloc_image ( struct uri *uri );
 extern int image_set_uri ( struct image *image, struct uri *uri );
 extern int image_set_name ( struct image *image, const char *name );
+extern char * image_strip_suffix ( struct image *image );
 extern int image_set_cmdline ( struct image *image, const char *cmdline );
 extern int image_set_len ( struct image *image, size_t len );
 extern int image_set_data ( struct image *image, userptr_t data, size_t len );
-- 
cgit v1.2.3-55-g7522


From 2b82007571dbe02b85338dc9fa85251cd5d68028 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 4 Sep 2024 13:29:30 +0100
Subject: [gdb] Allow CPU architectures to omit support for GDB

Move the <gdbmach.h> file to <bits/gdbmach.h>, and provide a common
dummy implementation for all architectures that have not yet
implemented support for GDB.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/arm32/include/gdbmach.h       | 45 -------------------
 src/arch/arm64/include/gdbmach.h       | 45 -------------------
 src/arch/i386/include/bits/gdbmach.h   | 72 ++++++++++++++++++++++++++++++
 src/arch/i386/include/gdbmach.h        | 72 ------------------------------
 src/arch/loong64/include/gdbmach.h     | 45 -------------------
 src/arch/x86/core/gdbmach.c            |  1 -
 src/arch/x86_64/include/bits/gdbmach.h | 80 ++++++++++++++++++++++++++++++++++
 src/arch/x86_64/include/gdbmach.h      | 80 ----------------------------------
 src/core/gdbstub.c                     |  1 -
 src/include/bits/gdbmach.h             | 45 +++++++++++++++++++
 src/include/ipxe/gdbstub.h             |  2 +-
 11 files changed, 198 insertions(+), 290 deletions(-)
 delete mode 100644 src/arch/arm32/include/gdbmach.h
 delete mode 100644 src/arch/arm64/include/gdbmach.h
 create mode 100644 src/arch/i386/include/bits/gdbmach.h
 delete mode 100644 src/arch/i386/include/gdbmach.h
 delete mode 100644 src/arch/loong64/include/gdbmach.h
 create mode 100644 src/arch/x86_64/include/bits/gdbmach.h
 delete mode 100644 src/arch/x86_64/include/gdbmach.h
 create mode 100644 src/include/bits/gdbmach.h

(limited to 'src/core')

diff --git a/src/arch/arm32/include/gdbmach.h b/src/arch/arm32/include/gdbmach.h
deleted file mode 100644
index cd152eedd..000000000
--- a/src/arch/arm32/include/gdbmach.h
+++ /dev/null
@@ -1,45 +0,0 @@
-#ifndef GDBMACH_H
-#define GDBMACH_H
-
-/** @file
- *
- * GDB architecture specifics
- *
- * This file declares functions for manipulating the machine state and
- * debugging context.
- *
- */
-
-#include <stdint.h>
-
-typedef unsigned long gdbreg_t;
-
-/* Register snapshot */
-enum {
-	/* Not yet implemented */
-	GDBMACH_NREGS,
-};
-
-#define GDBMACH_SIZEOF_REGS ( GDBMACH_NREGS * sizeof ( gdbreg_t ) )
-
-static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
-	/* Not yet implemented */
-	( void ) regs;
-	( void ) pc;
-}
-
-static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
-	/* Not yet implemented */
-	( void ) regs;
-	( void ) step;
-}
-
-static inline void gdbmach_breakpoint ( void ) {
-	/* Not yet implemented */
-}
-
-extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len,
-				    int enable );
-extern void gdbmach_init ( void );
-
-#endif /* GDBMACH_H */
diff --git a/src/arch/arm64/include/gdbmach.h b/src/arch/arm64/include/gdbmach.h
deleted file mode 100644
index cd152eedd..000000000
--- a/src/arch/arm64/include/gdbmach.h
+++ /dev/null
@@ -1,45 +0,0 @@
-#ifndef GDBMACH_H
-#define GDBMACH_H
-
-/** @file
- *
- * GDB architecture specifics
- *
- * This file declares functions for manipulating the machine state and
- * debugging context.
- *
- */
-
-#include <stdint.h>
-
-typedef unsigned long gdbreg_t;
-
-/* Register snapshot */
-enum {
-	/* Not yet implemented */
-	GDBMACH_NREGS,
-};
-
-#define GDBMACH_SIZEOF_REGS ( GDBMACH_NREGS * sizeof ( gdbreg_t ) )
-
-static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
-	/* Not yet implemented */
-	( void ) regs;
-	( void ) pc;
-}
-
-static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
-	/* Not yet implemented */
-	( void ) regs;
-	( void ) step;
-}
-
-static inline void gdbmach_breakpoint ( void ) {
-	/* Not yet implemented */
-}
-
-extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len,
-				    int enable );
-extern void gdbmach_init ( void );
-
-#endif /* GDBMACH_H */
diff --git a/src/arch/i386/include/bits/gdbmach.h b/src/arch/i386/include/bits/gdbmach.h
new file mode 100644
index 000000000..52cce7833
--- /dev/null
+++ b/src/arch/i386/include/bits/gdbmach.h
@@ -0,0 +1,72 @@
+#ifndef GDBMACH_H
+#define GDBMACH_H
+
+/** @file
+ *
+ * GDB architecture specifics
+ *
+ * This file declares functions for manipulating the machine state and
+ * debugging context.
+ *
+ */
+
+#include <stdint.h>
+
+typedef unsigned long gdbreg_t;
+
+/* The register snapshot, this must be in sync with interrupt handler and the
+ * GDB protocol. */
+enum {
+	GDBMACH_EAX,
+	GDBMACH_ECX,
+	GDBMACH_EDX,
+	GDBMACH_EBX,
+	GDBMACH_ESP,
+	GDBMACH_EBP,
+	GDBMACH_ESI,
+	GDBMACH_EDI,
+	GDBMACH_EIP,
+	GDBMACH_EFLAGS,
+	GDBMACH_CS,
+	GDBMACH_SS,
+	GDBMACH_DS,
+	GDBMACH_ES,
+	GDBMACH_FS,
+	GDBMACH_GS,
+	GDBMACH_NREGS,
+	GDBMACH_SIZEOF_REGS = GDBMACH_NREGS * sizeof ( gdbreg_t )
+};
+
+/* Breakpoint types */
+enum {
+	GDBMACH_BPMEM,
+	GDBMACH_BPHW,
+	GDBMACH_WATCH,
+	GDBMACH_RWATCH,
+	GDBMACH_AWATCH,
+};
+
+/* Interrupt vectors */
+extern void gdbmach_sigfpe ( void );
+extern void gdbmach_sigtrap ( void );
+extern void gdbmach_sigstkflt ( void );
+extern void gdbmach_sigill ( void );
+
+static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
+	regs [ GDBMACH_EIP ] = pc;
+}
+
+static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
+	regs [ GDBMACH_EFLAGS ] &= ~( 1 << 8 ); /* Trace Flag (TF) */
+	regs [ GDBMACH_EFLAGS ] |= ( step << 8 );
+}
+
+static inline void gdbmach_breakpoint ( void ) {
+	__asm__ __volatile__ ( "int $3\n" );
+}
+
+extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len, int enable );
+
+extern void gdbmach_init ( void );
+
+#endif /* GDBMACH_H */
diff --git a/src/arch/i386/include/gdbmach.h b/src/arch/i386/include/gdbmach.h
deleted file mode 100644
index 52cce7833..000000000
--- a/src/arch/i386/include/gdbmach.h
+++ /dev/null
@@ -1,72 +0,0 @@
-#ifndef GDBMACH_H
-#define GDBMACH_H
-
-/** @file
- *
- * GDB architecture specifics
- *
- * This file declares functions for manipulating the machine state and
- * debugging context.
- *
- */
-
-#include <stdint.h>
-
-typedef unsigned long gdbreg_t;
-
-/* The register snapshot, this must be in sync with interrupt handler and the
- * GDB protocol. */
-enum {
-	GDBMACH_EAX,
-	GDBMACH_ECX,
-	GDBMACH_EDX,
-	GDBMACH_EBX,
-	GDBMACH_ESP,
-	GDBMACH_EBP,
-	GDBMACH_ESI,
-	GDBMACH_EDI,
-	GDBMACH_EIP,
-	GDBMACH_EFLAGS,
-	GDBMACH_CS,
-	GDBMACH_SS,
-	GDBMACH_DS,
-	GDBMACH_ES,
-	GDBMACH_FS,
-	GDBMACH_GS,
-	GDBMACH_NREGS,
-	GDBMACH_SIZEOF_REGS = GDBMACH_NREGS * sizeof ( gdbreg_t )
-};
-
-/* Breakpoint types */
-enum {
-	GDBMACH_BPMEM,
-	GDBMACH_BPHW,
-	GDBMACH_WATCH,
-	GDBMACH_RWATCH,
-	GDBMACH_AWATCH,
-};
-
-/* Interrupt vectors */
-extern void gdbmach_sigfpe ( void );
-extern void gdbmach_sigtrap ( void );
-extern void gdbmach_sigstkflt ( void );
-extern void gdbmach_sigill ( void );
-
-static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
-	regs [ GDBMACH_EIP ] = pc;
-}
-
-static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
-	regs [ GDBMACH_EFLAGS ] &= ~( 1 << 8 ); /* Trace Flag (TF) */
-	regs [ GDBMACH_EFLAGS ] |= ( step << 8 );
-}
-
-static inline void gdbmach_breakpoint ( void ) {
-	__asm__ __volatile__ ( "int $3\n" );
-}
-
-extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len, int enable );
-
-extern void gdbmach_init ( void );
-
-#endif /* GDBMACH_H */
diff --git a/src/arch/loong64/include/gdbmach.h b/src/arch/loong64/include/gdbmach.h
deleted file mode 100644
index cd152eedd..000000000
--- a/src/arch/loong64/include/gdbmach.h
+++ /dev/null
@@ -1,45 +0,0 @@
-#ifndef GDBMACH_H
-#define GDBMACH_H
-
-/** @file
- *
- * GDB architecture specifics
- *
- * This file declares functions for manipulating the machine state and
- * debugging context.
- *
- */
-
-#include <stdint.h>
-
-typedef unsigned long gdbreg_t;
-
-/* Register snapshot */
-enum {
-	/* Not yet implemented */
-	GDBMACH_NREGS,
-};
-
-#define GDBMACH_SIZEOF_REGS ( GDBMACH_NREGS * sizeof ( gdbreg_t ) )
-
-static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
-	/* Not yet implemented */
-	( void ) regs;
-	( void ) pc;
-}
-
-static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
-	/* Not yet implemented */
-	( void ) regs;
-	( void ) step;
-}
-
-static inline void gdbmach_breakpoint ( void ) {
-	/* Not yet implemented */
-}
-
-extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len,
-				    int enable );
-extern void gdbmach_init ( void );
-
-#endif /* GDBMACH_H */
diff --git a/src/arch/x86/core/gdbmach.c b/src/arch/x86/core/gdbmach.c
index af6abfedd..d4d187e35 100644
--- a/src/arch/x86/core/gdbmach.c
+++ b/src/arch/x86/core/gdbmach.c
@@ -31,7 +31,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/uaccess.h>
 #include <ipxe/gdbstub.h>
 #include <librm.h>
-#include <gdbmach.h>
 
 /** @file
  *
diff --git a/src/arch/x86_64/include/bits/gdbmach.h b/src/arch/x86_64/include/bits/gdbmach.h
new file mode 100644
index 000000000..367405fd6
--- /dev/null
+++ b/src/arch/x86_64/include/bits/gdbmach.h
@@ -0,0 +1,80 @@
+#ifndef GDBMACH_H
+#define GDBMACH_H
+
+/** @file
+ *
+ * GDB architecture specifics
+ *
+ * This file declares functions for manipulating the machine state and
+ * debugging context.
+ *
+ */
+
+#include <stdint.h>
+
+typedef unsigned long gdbreg_t;
+
+/* Register snapshot */
+enum {
+	GDBMACH_RAX,
+	GDBMACH_RBX,
+	GDBMACH_RCX,
+	GDBMACH_RDX,
+	GDBMACH_RSI,
+	GDBMACH_RDI,
+	GDBMACH_RBP,
+	GDBMACH_RSP,
+	GDBMACH_R8,
+	GDBMACH_R9,
+	GDBMACH_R10,
+	GDBMACH_R11,
+	GDBMACH_R12,
+	GDBMACH_R13,
+	GDBMACH_R14,
+	GDBMACH_R15,
+	GDBMACH_RIP,
+	GDBMACH_RFLAGS,
+	GDBMACH_CS,
+	GDBMACH_SS,
+	GDBMACH_DS,
+	GDBMACH_ES,
+	GDBMACH_FS,
+	GDBMACH_GS,
+	GDBMACH_NREGS,
+};
+
+#define GDBMACH_SIZEOF_REGS ( GDBMACH_NREGS * sizeof ( gdbreg_t ) )
+
+/* Breakpoint types */
+enum {
+	GDBMACH_BPMEM,
+	GDBMACH_BPHW,
+	GDBMACH_WATCH,
+	GDBMACH_RWATCH,
+	GDBMACH_AWATCH,
+};
+
+/* Exception vectors */
+extern void gdbmach_sigfpe ( void );
+extern void gdbmach_sigtrap ( void );
+extern void gdbmach_sigstkflt ( void );
+extern void gdbmach_sigill ( void );
+
+static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
+	regs[GDBMACH_RIP] = pc;
+}
+
+static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
+	regs[GDBMACH_RFLAGS] &= ~( 1 << 8 ); /* Trace Flag (TF) */
+	regs[GDBMACH_RFLAGS] |= ( step << 8 );
+}
+
+static inline void gdbmach_breakpoint ( void ) {
+	__asm__ __volatile__ ( "int $3\n" );
+}
+
+extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len,
+				    int enable );
+extern void gdbmach_init ( void );
+
+#endif /* GDBMACH_H */
diff --git a/src/arch/x86_64/include/gdbmach.h b/src/arch/x86_64/include/gdbmach.h
deleted file mode 100644
index 367405fd6..000000000
--- a/src/arch/x86_64/include/gdbmach.h
+++ /dev/null
@@ -1,80 +0,0 @@
-#ifndef GDBMACH_H
-#define GDBMACH_H
-
-/** @file
- *
- * GDB architecture specifics
- *
- * This file declares functions for manipulating the machine state and
- * debugging context.
- *
- */
-
-#include <stdint.h>
-
-typedef unsigned long gdbreg_t;
-
-/* Register snapshot */
-enum {
-	GDBMACH_RAX,
-	GDBMACH_RBX,
-	GDBMACH_RCX,
-	GDBMACH_RDX,
-	GDBMACH_RSI,
-	GDBMACH_RDI,
-	GDBMACH_RBP,
-	GDBMACH_RSP,
-	GDBMACH_R8,
-	GDBMACH_R9,
-	GDBMACH_R10,
-	GDBMACH_R11,
-	GDBMACH_R12,
-	GDBMACH_R13,
-	GDBMACH_R14,
-	GDBMACH_R15,
-	GDBMACH_RIP,
-	GDBMACH_RFLAGS,
-	GDBMACH_CS,
-	GDBMACH_SS,
-	GDBMACH_DS,
-	GDBMACH_ES,
-	GDBMACH_FS,
-	GDBMACH_GS,
-	GDBMACH_NREGS,
-};
-
-#define GDBMACH_SIZEOF_REGS ( GDBMACH_NREGS * sizeof ( gdbreg_t ) )
-
-/* Breakpoint types */
-enum {
-	GDBMACH_BPMEM,
-	GDBMACH_BPHW,
-	GDBMACH_WATCH,
-	GDBMACH_RWATCH,
-	GDBMACH_AWATCH,
-};
-
-/* Exception vectors */
-extern void gdbmach_sigfpe ( void );
-extern void gdbmach_sigtrap ( void );
-extern void gdbmach_sigstkflt ( void );
-extern void gdbmach_sigill ( void );
-
-static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
-	regs[GDBMACH_RIP] = pc;
-}
-
-static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
-	regs[GDBMACH_RFLAGS] &= ~( 1 << 8 ); /* Trace Flag (TF) */
-	regs[GDBMACH_RFLAGS] |= ( step << 8 );
-}
-
-static inline void gdbmach_breakpoint ( void ) {
-	__asm__ __volatile__ ( "int $3\n" );
-}
-
-extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len,
-				    int enable );
-extern void gdbmach_init ( void );
-
-#endif /* GDBMACH_H */
diff --git a/src/core/gdbstub.c b/src/core/gdbstub.c
index 8b57ddf56..d668f454a 100644
--- a/src/core/gdbstub.c
+++ b/src/core/gdbstub.c
@@ -36,7 +36,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ctype.h>
 #include <byteswap.h>
 #include <ipxe/gdbstub.h>
-#include "gdbmach.h"
 
 enum {
 	POSIX_EINVAL = 0x1c,  /* used to report bad arguments to GDB */
diff --git a/src/include/bits/gdbmach.h b/src/include/bits/gdbmach.h
new file mode 100644
index 000000000..7e349856f
--- /dev/null
+++ b/src/include/bits/gdbmach.h
@@ -0,0 +1,45 @@
+#ifndef _BITS_GDBMACH_H
+#define _BITS_GDBMACH_H
+
+/** @file
+ *
+ * Dummy GDB architecture specifics
+ *
+ * This file is included only if the architecture does not provide its
+ * own version of this file.
+ *
+ */
+
+#include <stdint.h>
+
+typedef unsigned long gdbreg_t;
+
+/* Register snapshot */
+enum {
+	/* Not yet implemented */
+	GDBMACH_NREGS,
+};
+
+#define GDBMACH_SIZEOF_REGS ( GDBMACH_NREGS * sizeof ( gdbreg_t ) )
+
+static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
+	/* Not yet implemented */
+	( void ) regs;
+	( void ) pc;
+}
+
+static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
+	/* Not yet implemented */
+	( void ) regs;
+	( void ) step;
+}
+
+static inline void gdbmach_breakpoint ( void ) {
+	/* Not yet implemented */
+}
+
+extern int gdbmach_set_breakpoint ( int type, unsigned long addr, size_t len,
+				    int enable );
+extern void gdbmach_init ( void );
+
+#endif /* _BITS_GDBMACH_H */
diff --git a/src/include/ipxe/gdbstub.h b/src/include/ipxe/gdbstub.h
index 13ca33ddb..2240cca42 100644
--- a/src/include/ipxe/gdbstub.h
+++ b/src/include/ipxe/gdbstub.h
@@ -11,7 +11,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <ipxe/tables.h>
-#include <gdbmach.h>
+#include <bits/gdbmach.h>
 
 /**
  * A transport mechanism for the GDB protocol
-- 
cgit v1.2.3-55-g7522


From 33d80b1cd8dd73580c7843d4a1fb8b6b3f458e22 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 25 Oct 2024 14:05:00 +0100
Subject: [smbios] Provide a null SMBIOS API for platforms with no concept of
 SMBIOS

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/null_smbios.c         | 47 ++++++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/errfile.h     |  1 +
 src/include/ipxe/null_smbios.h | 18 ++++++++++++++++
 src/include/ipxe/smbios.h      |  1 +
 4 files changed, 67 insertions(+)
 create mode 100644 src/core/null_smbios.c
 create mode 100644 src/include/ipxe/null_smbios.h

(limited to 'src/core')

diff --git a/src/core/null_smbios.c b/src/core/null_smbios.c
new file mode 100644
index 000000000..d46aab3b5
--- /dev/null
+++ b/src/core/null_smbios.c
@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2024 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/**
+ * @file
+ *
+ * Null SMBIOS API
+ *
+ */
+
+#include <errno.h>
+#include <ipxe/smbios.h>
+
+/**
+ * Find SMBIOS
+ *
+ * @v smbios		SMBIOS entry point descriptor structure to fill in
+ * @ret rc		Return status code
+ */
+static int null_find_smbios ( struct smbios *smbios __unused ) {
+
+	return -ENOTSUP;
+}
+
+PROVIDE_SMBIOS ( null, find_smbios, null_find_smbios );
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index 6183e5b7e..48b35c537 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -83,6 +83,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define ERRFILE_efi_path	       ( ERRFILE_CORE | 0x002b0000 )
 #define ERRFILE_efi_mp		       ( ERRFILE_CORE | 0x002c0000 )
 #define ERRFILE_efi_service	       ( ERRFILE_CORE | 0x002d0000 )
+#define ERRFILE_null_smbios	       ( ERRFILE_CORE | 0x002e0000 )
 
 #define ERRFILE_eisa		     ( ERRFILE_DRIVER | 0x00000000 )
 #define ERRFILE_isa		     ( ERRFILE_DRIVER | 0x00010000 )
diff --git a/src/include/ipxe/null_smbios.h b/src/include/ipxe/null_smbios.h
new file mode 100644
index 000000000..c430dd089
--- /dev/null
+++ b/src/include/ipxe/null_smbios.h
@@ -0,0 +1,18 @@
+#ifndef _IPXE_NULL_SMBIOS_H
+#define _IPXE_NULL_SMBIOS_H
+
+/** @file
+ *
+ * Null SMBIOS API
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#ifdef SMBIOS_NULL
+#define SMBIOS_PREFIX_null
+#else
+#define SMBIOS_PREFIX_null __null_
+#endif
+
+#endif /* _IPXE_NULL_SMBIOS_H */
diff --git a/src/include/ipxe/smbios.h b/src/include/ipxe/smbios.h
index 077a67a85..f36a5ad40 100644
--- a/src/include/ipxe/smbios.h
+++ b/src/include/ipxe/smbios.h
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 	PROVIDE_SINGLE_API ( SMBIOS_PREFIX_ ## _subsys, _api_func, _func )
 
 /* Include all architecture-independent SMBIOS API headers */
+#include <ipxe/null_smbios.h>
 #include <ipxe/efi/efi_smbios.h>
 #include <ipxe/linux/linux_smbios.h>
 
-- 
cgit v1.2.3-55-g7522


From abfa7c3ab1323967c38b11d4732b2d27ecf2f094 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 25 Oct 2024 14:21:27 +0100
Subject: [uaccess] Rename UACCESS_EFI to UACCESS_FLAT

Running with flat physical addressing is a fairly common early boot
environment.  Rename UACCESS_EFI to UACCESS_FLAT so that this code may
be reused in non-UEFI boot environments that also use flat physical
addressing.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/config/defaults/efi.h          |   2 +-
 src/core/uaccess.c                 |  44 ++++++++++++++++
 src/include/ipxe/efi/efi_uaccess.h | 103 -------------------------------------
 src/include/ipxe/uaccess.h         |  76 ++++++++++++++++++++++++++-
 src/interface/efi/efi_uaccess.c    |  44 ----------------
 5 files changed, 120 insertions(+), 149 deletions(-)
 create mode 100644 src/core/uaccess.c
 delete mode 100644 src/include/ipxe/efi/efi_uaccess.h
 delete mode 100644 src/interface/efi/efi_uaccess.c

(limited to 'src/core')

diff --git a/src/config/defaults/efi.h b/src/config/defaults/efi.h
index b32381de6..607f94c14 100644
--- a/src/config/defaults/efi.h
+++ b/src/config/defaults/efi.h
@@ -9,7 +9,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
-#define UACCESS_EFI
+#define UACCESS_FLAT
 #define IOMAP_VIRT
 #define PCIAPI_EFI
 #define DMAAPI_OP
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
new file mode 100644
index 000000000..d3a9ca17d
--- /dev/null
+++ b/src/core/uaccess.c
@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2024 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/uaccess.h>
+
+/** @file
+ *
+ * iPXE user access API
+ *
+ */
+
+/* Flat address space user access API */
+PROVIDE_UACCESS_INLINE ( flat, phys_to_user );
+PROVIDE_UACCESS_INLINE ( flat, user_to_phys );
+PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
+PROVIDE_UACCESS_INLINE ( flat, user_to_virt );
+PROVIDE_UACCESS_INLINE ( flat, userptr_add );
+PROVIDE_UACCESS_INLINE ( flat, memcpy_user );
+PROVIDE_UACCESS_INLINE ( flat, memmove_user );
+PROVIDE_UACCESS_INLINE ( flat, memset_user );
+PROVIDE_UACCESS_INLINE ( flat, strlen_user );
+PROVIDE_UACCESS_INLINE ( flat, memchr_user );
diff --git a/src/include/ipxe/efi/efi_uaccess.h b/src/include/ipxe/efi/efi_uaccess.h
deleted file mode 100644
index 3cc750405..000000000
--- a/src/include/ipxe/efi/efi_uaccess.h
+++ /dev/null
@@ -1,103 +0,0 @@
-#ifndef _IPXE_EFI_UACCESS_H
-#define _IPXE_EFI_UACCESS_H
-
-/** @file
- *
- * iPXE user access API for EFI
- *
- * EFI runs with flat physical addressing, so the various mappings
- * between virtual addresses, I/O addresses and bus addresses are all
- * no-ops.
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#ifdef UACCESS_EFI
-#define UACCESS_PREFIX_efi
-#else
-#define UACCESS_PREFIX_efi __efi_
-#endif
-
-/**
- * Convert physical address to user pointer
- *
- * @v phys_addr		Physical address
- * @ret userptr		User pointer
- */
-static inline __always_inline userptr_t
-UACCESS_INLINE ( efi, phys_to_user ) ( unsigned long phys_addr ) {
-	return phys_addr;
-}
-
-/**
- * Convert user buffer to physical address
- *
- * @v userptr		User pointer
- * @v offset		Offset from user pointer
- * @ret phys_addr	Physical address
- */
-static inline __always_inline unsigned long
-UACCESS_INLINE ( efi, user_to_phys ) ( userptr_t userptr, off_t offset ) {
-	return ( userptr + offset );
-}
-
-static inline __always_inline userptr_t
-UACCESS_INLINE ( efi, virt_to_user ) ( volatile const void *addr ) {
-	return trivial_virt_to_user ( addr );
-}
-
-static inline __always_inline void *
-UACCESS_INLINE ( efi, user_to_virt ) ( userptr_t userptr, off_t offset ) {
-	return trivial_user_to_virt ( userptr, offset );
-}
-
-static inline __always_inline userptr_t
-UACCESS_INLINE ( efi, userptr_add ) ( userptr_t userptr, off_t offset ) {
-	return trivial_userptr_add ( userptr, offset );
-}
-
-static inline __always_inline off_t
-UACCESS_INLINE ( efi, userptr_sub ) ( userptr_t userptr,
-				      userptr_t subtrahend ) {
-	return trivial_userptr_sub ( userptr, subtrahend );
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( efi, memcpy_user ) ( userptr_t dest, off_t dest_off,
-					userptr_t src, off_t src_off,
-					size_t len ) {
-	trivial_memcpy_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( efi, memmove_user ) ( userptr_t dest, off_t dest_off,
-					 userptr_t src, off_t src_off,
-					 size_t len ) {
-	trivial_memmove_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline int
-UACCESS_INLINE ( efi, memcmp_user ) ( userptr_t first, off_t first_off,
-				      userptr_t second, off_t second_off,
-				      size_t len ) {
-	return trivial_memcmp_user ( first, first_off, second, second_off, len);
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( efi, memset_user ) ( userptr_t buffer, off_t offset,
-					int c, size_t len ) {
-	trivial_memset_user ( buffer, offset, c, len );
-}
-
-static inline __always_inline size_t
-UACCESS_INLINE ( efi, strlen_user ) ( userptr_t buffer, off_t offset ) {
-	return trivial_strlen_user ( buffer, offset );
-}
-
-static inline __always_inline off_t
-UACCESS_INLINE ( efi, memchr_user ) ( userptr_t buffer, off_t offset,
-					int c, size_t len ) {
-	return trivial_memchr_user ( buffer, offset, c, len );
-}
-
-#endif /* _IPXE_EFI_UACCESS_H */
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index a3f78566a..b71361cab 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -26,6 +26,12 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/api.h>
 #include <config/ioapi.h>
 
+#ifdef UACCESS_FLAT
+#define UACCESS_PREFIX_flat
+#else
+#define UACCESS_PREFIX_flat __flat_
+#endif
+
 /**
  * A pointer to a user buffer
  *
@@ -216,8 +222,76 @@ trivial_memchr_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
 #define PROVIDE_UACCESS_INLINE( _subsys, _api_func ) \
 	PROVIDE_SINGLE_API_INLINE ( UACCESS_PREFIX_ ## _subsys, _api_func )
 
+static inline __always_inline userptr_t
+UACCESS_INLINE ( flat, phys_to_user ) ( unsigned long phys_addr ) {
+	return phys_addr;
+}
+
+static inline __always_inline unsigned long
+UACCESS_INLINE ( flat, user_to_phys ) ( userptr_t userptr, off_t offset ) {
+	return ( userptr + offset );
+}
+
+static inline __always_inline userptr_t
+UACCESS_INLINE ( flat, virt_to_user ) ( volatile const void *addr ) {
+	return trivial_virt_to_user ( addr );
+}
+
+static inline __always_inline void *
+UACCESS_INLINE ( flat, user_to_virt ) ( userptr_t userptr, off_t offset ) {
+	return trivial_user_to_virt ( userptr, offset );
+}
+
+static inline __always_inline userptr_t
+UACCESS_INLINE ( flat, userptr_add ) ( userptr_t userptr, off_t offset ) {
+	return trivial_userptr_add ( userptr, offset );
+}
+
+static inline __always_inline off_t
+UACCESS_INLINE ( flat, userptr_sub ) ( userptr_t userptr,
+				       userptr_t subtrahend ) {
+	return trivial_userptr_sub ( userptr, subtrahend );
+}
+
+static inline __always_inline void
+UACCESS_INLINE ( flat, memcpy_user ) ( userptr_t dest, off_t dest_off,
+				       userptr_t src, off_t src_off,
+				       size_t len ) {
+	trivial_memcpy_user ( dest, dest_off, src, src_off, len );
+}
+
+static inline __always_inline void
+UACCESS_INLINE ( flat, memmove_user ) ( userptr_t dest, off_t dest_off,
+					userptr_t src, off_t src_off,
+					size_t len ) {
+	trivial_memmove_user ( dest, dest_off, src, src_off, len );
+}
+
+static inline __always_inline int
+UACCESS_INLINE ( flat, memcmp_user ) ( userptr_t first, off_t first_off,
+				       userptr_t second, off_t second_off,
+				       size_t len ) {
+	return trivial_memcmp_user ( first, first_off, second, second_off, len);
+}
+
+static inline __always_inline void
+UACCESS_INLINE ( flat, memset_user ) ( userptr_t buffer, off_t offset,
+				       int c, size_t len ) {
+	trivial_memset_user ( buffer, offset, c, len );
+}
+
+static inline __always_inline size_t
+UACCESS_INLINE ( flat, strlen_user ) ( userptr_t buffer, off_t offset ) {
+	return trivial_strlen_user ( buffer, offset );
+}
+
+static inline __always_inline off_t
+UACCESS_INLINE ( flat, memchr_user ) ( userptr_t buffer, off_t offset,
+				       int c, size_t len ) {
+	return trivial_memchr_user ( buffer, offset, c, len );
+}
+
 /* Include all architecture-independent user access API headers */
-#include <ipxe/efi/efi_uaccess.h>
 #include <ipxe/linux/linux_uaccess.h>
 
 /* Include all architecture-dependent user access API headers */
diff --git a/src/interface/efi/efi_uaccess.c b/src/interface/efi/efi_uaccess.c
deleted file mode 100644
index e058be66b..000000000
--- a/src/interface/efi/efi_uaccess.c
+++ /dev/null
@@ -1,44 +0,0 @@
-/*
- * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301, USA.
- *
- * You can also choose to distribute this program under the terms of
- * the Unmodified Binary Distribution Licence (as given in the file
- * COPYING.UBDL), provided that you have satisfied its requirements.
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#include <ipxe/uaccess.h>
-#include <ipxe/efi/efi.h>
-
-/** @file
- *
- * iPXE user access API for EFI
- *
- */
-
-PROVIDE_UACCESS_INLINE ( efi, phys_to_user );
-PROVIDE_UACCESS_INLINE ( efi, user_to_phys );
-PROVIDE_UACCESS_INLINE ( efi, virt_to_user );
-PROVIDE_UACCESS_INLINE ( efi, user_to_virt );
-PROVIDE_UACCESS_INLINE ( efi, userptr_add );
-PROVIDE_UACCESS_INLINE ( efi, memcpy_user );
-PROVIDE_UACCESS_INLINE ( efi, memmove_user );
-PROVIDE_UACCESS_INLINE ( efi, memset_user );
-PROVIDE_UACCESS_INLINE ( efi, strlen_user );
-PROVIDE_UACCESS_INLINE ( efi, memchr_user );
-- 
cgit v1.2.3-55-g7522


From 74710b8316b40c9e3081c1014813867d4764796b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 28 Oct 2024 13:45:51 +0000
Subject: [fdt] Add ability to parse unsigned integer properties

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 38 ++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/fdt.h |  1 +
 2 files changed, 39 insertions(+)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index f439422cf..b7289fd36 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -367,6 +367,44 @@ const char * fdt_string ( unsigned int offset, const char *name ) {
 	return desc.data;
 }
 
+/**
+ * Find integer property
+ *
+ * @v offset		Starting node offset
+ * @v name		Property name
+ * @v value		Integer value to fill in
+ * @ret rc		Return status code
+ */
+int fdt_u64 ( unsigned int offset, const char *name, uint64_t *value ) {
+	struct fdt_descriptor desc;
+	const uint8_t *data;
+	size_t remaining;
+	int rc;
+
+	/* Clear value */
+	*value = 0;
+
+	/* Find property */
+	if ( ( rc = fdt_property ( offset, name, &desc ) ) != 0 )
+		return rc;
+
+	/* Check range */
+	if ( desc.len > sizeof ( *value ) ) {
+		DBGC ( &fdt, "FDT oversized integer property \"%s\"\n", name );
+		return -ERANGE;
+	}
+
+	/* Parse value */
+	data = desc.data;
+	remaining = desc.len;
+	while ( remaining-- ) {
+		*value <<= 8;
+		*value |= *(data++);
+	}
+
+	return 0;
+}
+
 /**
  * Get MAC address from property
  *
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 97efa100c..9b9b01b6c 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -96,6 +96,7 @@ struct fdt {
 extern int fdt_path ( const char *path, unsigned int *offset );
 extern int fdt_alias ( const char *name, unsigned int *offset );
 extern const char * fdt_string ( unsigned int offset, const char *name );
+extern int fdt_u64 ( unsigned int offset, const char *name, uint64_t *value );
 extern int fdt_mac ( unsigned int offset, struct net_device *netdev );
 extern int register_fdt ( const struct fdt_header *hdr );
 
-- 
cgit v1.2.3-55-g7522


From d9c0d26e1775cb0e45b30ad6b36bae90abb1fc78 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 28 Oct 2024 16:39:23 +0000
Subject: [pci] Provide a null PCI API for platforms with no PCI bus

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/null_pci.c         |  43 +++++++++++++
 src/include/ipxe/null_pci.h | 154 ++++++++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/pci_io.h   |   1 +
 3 files changed, 198 insertions(+)
 create mode 100644 src/core/null_pci.c
 create mode 100644 src/include/ipxe/null_pci.h

(limited to 'src/core')

diff --git a/src/core/null_pci.c b/src/core/null_pci.c
new file mode 100644
index 000000000..196eabb6f
--- /dev/null
+++ b/src/core/null_pci.c
@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2024 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/**
+ * @file
+ *
+ * Null PCI API
+ *
+ */
+
+#include <ipxe/pci.h>
+
+PROVIDE_PCIAPI_INLINE ( null, pci_can_probe );
+PROVIDE_PCIAPI_INLINE ( null, pci_discover );
+PROVIDE_PCIAPI_INLINE ( null, pci_read_config_byte );
+PROVIDE_PCIAPI_INLINE ( null, pci_read_config_word );
+PROVIDE_PCIAPI_INLINE ( null, pci_read_config_dword );
+PROVIDE_PCIAPI_INLINE ( null, pci_write_config_byte );
+PROVIDE_PCIAPI_INLINE ( null, pci_write_config_word );
+PROVIDE_PCIAPI_INLINE ( null, pci_write_config_dword );
+PROVIDE_PCIAPI_INLINE ( null, pci_ioremap );
diff --git a/src/include/ipxe/null_pci.h b/src/include/ipxe/null_pci.h
new file mode 100644
index 000000000..476ede202
--- /dev/null
+++ b/src/include/ipxe/null_pci.h
@@ -0,0 +1,154 @@
+#ifndef _IPXE_NULL_PCI_H
+#define _IPXE_NULL_PCI_H
+
+#include <stdint.h>
+
+/** @file
+ *
+ * Null PCI API
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#ifdef PCIAPI_NULL
+#define PCIAPI_PREFIX_null
+#else
+#define PCIAPI_PREFIX_null __null_
+#endif
+
+struct pci_device;
+
+/**
+ * Check if PCI bus probing is allowed
+ *
+ * @ret ok		Bus probing is allowed
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_can_probe ) ( void ) {
+	return 0;
+}
+
+/**
+ * Find next PCI bus:dev.fn address range in system
+ *
+ * @v busdevfn		Starting PCI bus:dev.fn address
+ * @v range		PCI bus:dev.fn address range to fill in
+ */
+static inline __always_inline void
+PCIAPI_INLINE ( null, pci_discover ) ( uint32_t busdevfn __unused,
+				       struct pci_range *range ) {
+
+	range->start = 0;
+	range->count = 0;
+}
+
+/**
+ * Read byte from PCI configuration space via PCI BIOS
+ *
+ * @v pci	PCI device
+ * @v where	Location within PCI configuration space
+ * @v value	Value read
+ * @ret rc	Return status code
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_read_config_byte ) ( struct pci_device *pci __unused,
+					       unsigned int where __unused,
+					       uint8_t *value ) {
+	*value = 0xff;
+	return 0;
+}
+
+/**
+ * Read word from PCI configuration space via PCI BIOS
+ *
+ * @v pci	PCI device
+ * @v where	Location within PCI configuration space
+ * @v value	Value read
+ * @ret rc	Return status code
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_read_config_word ) ( struct pci_device *pci __unused,
+					       unsigned int where __unused,
+					       uint16_t *value ) {
+	*value = 0xffff;
+	return 0;
+}
+
+/**
+ * Read dword from PCI configuration space via PCI BIOS
+ *
+ * @v pci	PCI device
+ * @v where	Location within PCI configuration space
+ * @v value	Value read
+ * @ret rc	Return status code
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_read_config_dword ) ( struct pci_device *pci __unused,
+						unsigned int where __unused,
+						uint32_t *value ) {
+	*value = 0xffffffff;
+	return 0;
+}
+
+/**
+ * Write byte to PCI configuration space via PCI BIOS
+ *
+ * @v pci	PCI device
+ * @v where	Location within PCI configuration space
+ * @v value	Value to be written
+ * @ret rc	Return status code
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_write_config_byte ) ( struct pci_device *pci __unused,
+						unsigned int where __unused,
+						uint8_t value __unused ) {
+	return 0;
+}
+
+/**
+ * Write word to PCI configuration space via PCI BIOS
+ *
+ * @v pci	PCI device
+ * @v where	Location within PCI configuration space
+ * @v value	Value to be written
+ * @ret rc	Return status code
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_write_config_word ) ( struct pci_device *pci __unused,
+						unsigned int where __unused,
+						uint16_t value __unused ) {
+	return 0;
+}
+
+/**
+ * Write dword to PCI configuration space via PCI BIOS
+ *
+ * @v pci	PCI device
+ * @v where	Location within PCI configuration space
+ * @v value	Value to be written
+ * @ret rc	Return status code
+ */
+static inline __always_inline int
+PCIAPI_INLINE ( null, pci_write_config_dword ) ( struct pci_device *pci
+						 __unused,
+						 unsigned int where __unused,
+						 uint32_t value __unused ) {
+	return 0;
+}
+
+/**
+ * Map PCI bus address as an I/O address
+ *
+ * @v bus_addr		PCI bus address
+ * @v len		Length of region
+ * @ret io_addr		I/O address, or NULL on error
+ */
+static inline __always_inline void *
+PCIAPI_INLINE ( null, pci_ioremap ) ( struct pci_device *pci __unused,
+				      unsigned long bus_addr __unused,
+				      size_t len __unused ) {
+	return NULL;
+}
+
+#endif /* _IPXE_NULL_PCI_H */
diff --git a/src/include/ipxe/pci_io.h b/src/include/ipxe/pci_io.h
index 322fdbb24..9b4cbcab4 100644
--- a/src/include/ipxe/pci_io.h
+++ b/src/include/ipxe/pci_io.h
@@ -59,6 +59,7 @@ struct pci_range {
 	PROVIDE_SINGLE_API_INLINE ( PCIAPI_PREFIX_ ## _subsys, _api_func )
 
 /* Include all architecture-independent I/O API headers */
+#include <ipxe/null_pci.h>
 #include <ipxe/ecam_io.h>
 #include <ipxe/efi/efi_pci_api.h>
 #include <ipxe/linux/linux_pci.h>
-- 
cgit v1.2.3-55-g7522


From 6f076efa650f5d8cc73bc70402b23f7066943474 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 3 Feb 2025 14:41:35 +0000
Subject: [malloc] Clean up debug messages

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/malloc.c | 59 ++++++++++++++++++++++++++++---------------------------
 1 file changed, 30 insertions(+), 29 deletions(-)

(limited to 'src/core')

diff --git a/src/core/malloc.c b/src/core/malloc.c
index 8499ab45a..b4bf4f0a6 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -310,7 +310,7 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 	assert ( actual_size >= size );
 	align_mask = ( ( align - 1 ) | ( MIN_MEMBLOCK_SIZE - 1 ) );
 
-	DBGC2 ( &heap, "Allocating %#zx (aligned %#zx+%zx)\n",
+	DBGC2 ( &heap, "HEAP allocating %#zx (aligned %#zx+%zx)\n",
 		size, align, offset );
 	while ( 1 ) {
 		/* Search through blocks for the first one with enough space */
@@ -329,7 +329,8 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 			pre   = block;
 			block = ( ( ( void * ) pre   ) + pre_size );
 			post  = ( ( ( void * ) block ) + actual_size );
-			DBGC2 ( &heap, "[%p,%p) -> [%p,%p) + [%p,%p)\n", pre,
+			DBGC2 ( &heap, "HEAP splitting [%p,%p) -> [%p,%p) "
+				"+ [%p,%p)\n", pre,
 				( ( ( void * ) pre ) + pre->size ), pre, block,
 				post, ( ( ( void * ) pre ) + pre->size ) );
 			/* If there is a "post" block, add it in to
@@ -364,7 +365,7 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 			if ( usedmem > maxusedmem )
 				maxusedmem = usedmem;
 			/* Return allocated block */
-			DBGC2 ( &heap, "Allocated [%p,%p)\n", block,
+			DBGC2 ( &heap, "HEAP allocated [%p,%p)\n", block,
 				( ( ( void * ) block ) + size ) );
 			ptr = block;
 			VALGRIND_MAKE_MEM_UNDEFINED ( ptr, size );
@@ -372,15 +373,16 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 		}
 
 		/* Try discarding some cached data to free up memory */
-		DBGC ( &heap, "Attempting discard for %#zx (aligned %#zx+%zx), "
-		       "used %zdkB\n", size, align, offset, ( usedmem >> 10 ) );
+		DBGC ( &heap, "HEAP attempting discard for %#zx (aligned "
+		       "%#zx+%zx), used %zdkB\n", size, align, offset,
+		       ( usedmem >> 10 ) );
 		valgrind_make_blocks_noaccess();
 		discarded = discard_cache();
 		valgrind_make_blocks_defined();
 		check_blocks();
 		if ( ! discarded ) {
 			/* Nothing available to discard */
-			DBGC ( &heap, "Failed to allocate %#zx (aligned "
+			DBGC ( &heap, "HEAP failed to allocate %#zx (aligned "
 			       "%#zx)\n", size, align );
 			ptr = NULL;
 			goto done;
@@ -426,7 +428,7 @@ void free_memblock ( void *ptr, size_t size ) {
 			~( MIN_MEMBLOCK_SIZE - 1 ) );
 	freeing = ptr;
 	VALGRIND_MAKE_MEM_UNDEFINED ( freeing, sizeof ( *freeing ) );
-	DBGC2 ( &heap, "Freeing [%p,%p)\n",
+	DBGC2 ( &heap, "HEAP freeing [%p,%p)\n",
 		freeing, ( ( ( void * ) freeing ) + size ) );
 
 	/* Check that this block does not overlap the free list */
@@ -437,7 +439,7 @@ void free_memblock ( void *ptr, size_t size ) {
 			     ( ( void * ) freeing <
 			       ( ( void * ) block + block->size ) ) ) {
 				assert ( 0 );
-				DBGC ( &heap, "Double free of [%p,%p) "
+				DBGC ( &heap, "HEAP double free of [%p,%p) "
 				       "overlapping [%p,%p) detected from %p\n",
 				       freeing,
 				       ( ( ( void * ) freeing ) + size ), block,
@@ -457,7 +459,8 @@ void free_memblock ( void *ptr, size_t size ) {
 			      ( ( ( void * ) freeing ) + freeing->size ) );
 		/* Merge with immediately preceding block, if possible */
 		if ( gap_before == 0 ) {
-			DBGC2 ( &heap, "[%p,%p) + [%p,%p) -> [%p,%p)\n", block,
+			DBGC2 ( &heap, "HEAP merging [%p,%p) + [%p,%p) -> "
+				"[%p,%p)\n", block,
 				( ( ( void * ) block ) + block->size ), freeing,
 				( ( ( void * ) freeing ) + freeing->size ),
 				block,
@@ -477,13 +480,13 @@ void free_memblock ( void *ptr, size_t size ) {
 	 * possible, merge the following block into the "freeing"
 	 * block.
 	 */
-	DBGC2 ( &heap, "[%p,%p)\n",
+	DBGC2 ( &heap, "HEAP freed [%p,%p)\n",
 		freeing, ( ( ( void * ) freeing ) + freeing->size ) );
 	list_add_tail ( &freeing->list, &block->list );
 	if ( gap_after == 0 ) {
-		DBGC2 ( &heap, "[%p,%p) + [%p,%p) -> [%p,%p)\n", freeing,
-			( ( ( void * ) freeing ) + freeing->size ), block,
-			( ( ( void * ) block ) + block->size ), freeing,
+		DBGC2 ( &heap, "HEAP merging [%p,%p) + [%p,%p) -> [%p,%p)\n",
+			freeing, ( ( ( void * ) freeing ) + freeing->size ),
+			block, ( ( ( void * ) block ) + block->size ), freeing,
 			( ( ( void * ) block ) + block->size ) );
 		freeing->size += block->size;
 		list_del ( &block->list );
@@ -565,8 +568,8 @@ void * realloc ( void *old_ptr, size_t new_size ) {
 	}
 
 	if ( ASSERTED ) {
-		DBGC ( &heap, "Possible memory corruption detected from %p\n",
-		       __builtin_return_address ( 0 ) );
+		DBGC ( &heap, "HEAP detected possible memory corruption "
+		       "from %p\n", __builtin_return_address ( 0 ) );
 	}
 	return new_ptr;
 }
@@ -585,8 +588,8 @@ void * malloc ( size_t size ) {
 
 	ptr = realloc ( NULL, size );
 	if ( ASSERTED ) {
-		DBGC ( &heap, "Possible memory corruption detected from %p\n",
-		       __builtin_return_address ( 0 ) );
+		DBGC ( &heap, "HEAP detected possible memory corruption "
+		       "from %p\n", __builtin_return_address ( 0 ) );
 	}
 	return ptr;
 }
@@ -605,8 +608,8 @@ void free ( void *ptr ) {
 
 	realloc ( ptr, 0 );
 	if ( ASSERTED ) {
-		DBGC ( &heap, "Possible memory corruption detected from %p\n",
-		       __builtin_return_address ( 0 ) );
+		DBGC ( &heap, "HEAP detected possible memory corruption "
+		       "from %p\n", __builtin_return_address ( 0 ) );
 	}
 }
 
@@ -628,8 +631,8 @@ void * zalloc ( size_t size ) {
 	if ( data )
 		memset ( data, 0, size );
 	if ( ASSERTED ) {
-		DBGC ( &heap, "Possible memory corruption detected from %p\n",
-		       __builtin_return_address ( 0 ) );
+		DBGC ( &heap, "HEAP detected possible memory corruption "
+		       "from %p\n", __builtin_return_address ( 0 ) );
 	}
 	return data;
 }
@@ -680,7 +683,7 @@ struct init_fn heap_init_fn __init_fn ( INIT_EARLY ) = {
  */
 static void shutdown_cache ( int booting __unused ) {
 	discard_all_cache();
-	DBGC ( &heap, "Maximum heap usage %zdkB\n", ( maxusedmem >> 10 ) );
+	DBGC ( &heap, "HEAP maximum usage %zdkB\n", ( maxusedmem >> 10 ) );
 }
 
 /** Memory allocator shutdown function */
@@ -689,19 +692,17 @@ struct startup_fn heap_startup_fn __startup_fn ( STARTUP_EARLY ) = {
 	.shutdown = shutdown_cache,
 };
 
-#if 0
-#include <stdio.h>
 /**
- * Dump free block list
+ * Dump free block list (for debugging)
  *
  */
 void mdumpfree ( void ) {
 	struct memory_block *block;
 
-	printf ( "Free block list:\n" );
+	dbg_printf ( "HEAP free block list:\n" );
 	list_for_each_entry ( block, &free_blocks, list ) {
-		printf ( "[%p,%p] (size %#zx)\n", block,
-			 ( ( ( void * ) block ) + block->size ), block->size );
+		dbg_printf ( "...[%p,%p] (size %#zx)\n", block,
+			     ( ( ( void * ) block ) + block->size ),
+			     block->size );
 	}
 }
-#endif
-- 
cgit v1.2.3-55-g7522


From 77cc3ed10892f65e5b01af482b5739e29614486e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 3 Feb 2025 14:43:03 +0000
Subject: [malloc] Ensure free memory blocks remain aligned

When allocating memory with a non-zero alignment offset, the free
memory block structure following the allocation may end up improperly
aligned.

Ensure that free memory blocks always remain aligned to the size of
the free memory block structure.

Ensure that the initial heap is also correctly aligned, thereby
allowing the logic for leaking undersized free memory blocks to be
omitted.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/malloc.c         | 97 ++++++++++++++++++++++++++++-------------------
 src/include/ipxe/malloc.h |  1 -
 2 files changed, 58 insertions(+), 40 deletions(-)

(limited to 'src/core')

diff --git a/src/core/malloc.c b/src/core/malloc.c
index b4bf4f0a6..c499ce6fd 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -59,7 +59,8 @@ struct memory_block {
 	struct list_head list;
 };
 
-#define MIN_MEMBLOCK_SIZE \
+/** Physical address alignment maintained for free blocks of memory */
+#define MEMBLOCK_ALIGN \
 	( ( size_t ) ( 1 << ( fls ( sizeof ( struct memory_block ) - 1 ) ) ) )
 
 /** A block of allocated memory complete with size information */
@@ -107,7 +108,7 @@ size_t maxusedmem;
 #define HEAP_SIZE ( 512 * 1024 )
 
 /** The heap itself */
-static char heap[HEAP_SIZE] __attribute__ (( aligned ( __alignof__(void *) )));
+static char heap[HEAP_SIZE];
 
 /**
  * Mark all blocks in free list as defined
@@ -211,12 +212,16 @@ static inline void check_blocks ( void ) {
 
 	list_for_each_entry ( block, &free_blocks, list ) {
 
+		/* Check alignment */
+		assert ( ( virt_to_phys ( block ) &
+			   ( MEMBLOCK_ALIGN - 1 ) ) == 0 );
+
 		/* Check that list structure is intact */
 		list_check ( &block->list );
 
 		/* Check that block size is not too small */
 		assert ( block->size >= sizeof ( *block ) );
-		assert ( block->size >= MIN_MEMBLOCK_SIZE );
+		assert ( block->size >= MEMBLOCK_ALIGN );
 
 		/* Check that block does not wrap beyond end of address space */
 		assert ( ( ( void * ) block + block->size ) >
@@ -278,6 +283,7 @@ static void discard_all_cache ( void ) {
  */
 void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 	struct memory_block *block;
+	size_t actual_offset;
 	size_t align_mask;
 	size_t actual_size;
 	size_t pre_size;
@@ -293,11 +299,13 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 	valgrind_make_blocks_defined();
 	check_blocks();
 
-	/* Round up size to multiple of MIN_MEMBLOCK_SIZE and
-	 * calculate alignment mask.
-	 */
-	actual_size = ( ( size + MIN_MEMBLOCK_SIZE - 1 ) &
-			~( MIN_MEMBLOCK_SIZE - 1 ) );
+	/* Calculate offset of memory block */
+	actual_offset = ( offset & ~( MEMBLOCK_ALIGN - 1 ) );
+	assert ( actual_offset <= offset );
+
+	/* Calculate size of memory block */
+	actual_size = ( ( size + offset - actual_offset + MEMBLOCK_ALIGN - 1 )
+			& ~( MEMBLOCK_ALIGN - 1 ) );
 	if ( ! actual_size ) {
 		/* The requested size is not permitted to be zero.  A
 		 * zero result at this point indicates that either the
@@ -308,14 +316,16 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 		goto done;
 	}
 	assert ( actual_size >= size );
-	align_mask = ( ( align - 1 ) | ( MIN_MEMBLOCK_SIZE - 1 ) );
+
+	/* Calculate alignment mask */
+	align_mask = ( ( align - 1 ) | ( MEMBLOCK_ALIGN - 1 ) );
 
 	DBGC2 ( &heap, "HEAP allocating %#zx (aligned %#zx+%zx)\n",
 		size, align, offset );
 	while ( 1 ) {
 		/* Search through blocks for the first one with enough space */
 		list_for_each_entry ( block, &free_blocks, list ) {
-			pre_size = ( ( offset - virt_to_phys ( block ) )
+			pre_size = ( ( actual_offset - virt_to_phys ( block ) )
 				     & align_mask );
 			if ( ( block->size < pre_size ) ||
 			     ( ( block->size - pre_size ) < actual_size ) )
@@ -334,11 +344,10 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 				( ( ( void * ) pre ) + pre->size ), pre, block,
 				post, ( ( ( void * ) pre ) + pre->size ) );
 			/* If there is a "post" block, add it in to
-			 * the free list.  Leak it if it is too small
-			 * (which can happen only at the very end of
-			 * the heap).
+			 * the free list.
 			 */
-			if ( post_size >= MIN_MEMBLOCK_SIZE ) {
+			if ( post_size ) {
+				assert ( post_size >= MEMBLOCK_ALIGN );
 				VALGRIND_MAKE_MEM_UNDEFINED ( post,
 							      sizeof ( *post ));
 				post->size = post_size;
@@ -350,14 +359,14 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 			 */
 			pre->size = pre_size;
 			/* If there is no "pre" block, remove it from
-			 * the list.  Also remove it (i.e. leak it) if
-			 * it is too small, which can happen only at
-			 * the very start of the heap.
+			 * the list.
 			 */
-			if ( pre_size < MIN_MEMBLOCK_SIZE ) {
+			if ( ! pre_size ) {
 				list_del ( &pre->list );
 				VALGRIND_MAKE_MEM_NOACCESS ( pre,
 							     sizeof ( *pre ) );
+			} else {
+				assert ( pre_size >= MEMBLOCK_ALIGN );
 			}
 			/* Update memory usage statistics */
 			freemem -= actual_size;
@@ -365,9 +374,10 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 			if ( usedmem > maxusedmem )
 				maxusedmem = usedmem;
 			/* Return allocated block */
-			DBGC2 ( &heap, "HEAP allocated [%p,%p)\n", block,
-				( ( ( void * ) block ) + size ) );
-			ptr = block;
+			ptr = ( ( ( void * ) block ) + offset - actual_offset );
+			DBGC2 ( &heap, "HEAP allocated [%p,%p) within "
+				"[%p,%p)\n", ptr, ( ptr + size ), block,
+				( ( ( void * ) block ) + actual_size ) );
 			VALGRIND_MAKE_MEM_UNDEFINED ( ptr, size );
 			goto done;
 		}
@@ -407,6 +417,7 @@ void free_memblock ( void *ptr, size_t size ) {
 	struct memory_block *freeing;
 	struct memory_block *block;
 	struct memory_block *tmp;
+	size_t sub_offset;
 	size_t actual_size;
 	ssize_t gap_before;
 	ssize_t gap_after = -1;
@@ -420,16 +431,18 @@ void free_memblock ( void *ptr, size_t size ) {
 	valgrind_make_blocks_defined();
 	check_blocks();
 
-	/* Round up size to match actual size that alloc_memblock()
-	 * would have used.
+	/* Round up to match actual block that alloc_memblock() would
+	 * have allocated.
 	 */
 	assert ( size != 0 );
-	actual_size = ( ( size + MIN_MEMBLOCK_SIZE - 1 ) &
-			~( MIN_MEMBLOCK_SIZE - 1 ) );
-	freeing = ptr;
+	sub_offset = ( virt_to_phys ( ptr ) & ( MEMBLOCK_ALIGN - 1) );
+	freeing = ( ptr - sub_offset );
+	actual_size = ( ( size + sub_offset + MEMBLOCK_ALIGN - 1 ) &
+			~( MEMBLOCK_ALIGN - 1 ) );
+	DBGC2 ( &heap, "HEAP freeing [%p,%p) within [%p,%p)\n",
+		ptr, ( ptr + size ), freeing,
+		( ( ( void * ) freeing ) + actual_size ) );
 	VALGRIND_MAKE_MEM_UNDEFINED ( freeing, sizeof ( *freeing ) );
-	DBGC2 ( &heap, "HEAP freeing [%p,%p)\n",
-		freeing, ( ( ( void * ) freeing ) + size ) );
 
 	/* Check that this block does not overlap the free list */
 	if ( ASSERTING ) {
@@ -546,7 +559,7 @@ void * realloc ( void *old_ptr, size_t new_size ) {
 		new_ptr = &new_block->data;
 		VALGRIND_MALLOCLIKE_BLOCK ( new_ptr, new_size, 0, 0 );
 	}
-	
+
 	/* Copy across relevant part of the old data region (if any),
 	 * then free it.  Note that at this point either (a) new_ptr
 	 * is valid, or (b) new_size is 0; either way, the memcpy() is
@@ -641,19 +654,25 @@ void * zalloc ( size_t size ) {
  * Add memory to allocation pool
  *
  * @v start		Start address
- * @v end		End address
+ * @v len		Length of memory
  *
- * Adds a block of memory [start,end) to the allocation pool.  This is
- * a one-way operation; there is no way to reclaim this memory.
- *
- * @c start must be aligned to at least a multiple of sizeof(void*).
+ * Adds a block of memory to the allocation pool.  This is a one-way
+ * operation; there is no way to reclaim this memory.
  */
-void mpopulate ( void *start, size_t len ) {
+static void mpopulate ( void *start, size_t len ) {
+	size_t skip;
 
-	/* Prevent free_memblock() from rounding up len beyond the end
-	 * of what we were actually given...
-	 */
-	len &= ~( MIN_MEMBLOCK_SIZE - 1 );
+	/* Align start of block */
+	skip = ( ( -virt_to_phys ( start ) ) & ( MEMBLOCK_ALIGN - 1 ) );
+	if ( skip > len )
+		return;
+	start += skip;
+	len -= skip;
+
+	/* Align end of block */
+	len &= ~( MEMBLOCK_ALIGN - 1 );
+	if ( ! len )
+		return;
 
 	/* Add to allocation pool */
 	free_memblock ( start, len );
diff --git a/src/include/ipxe/malloc.h b/src/include/ipxe/malloc.h
index 180ca001d..f0fde0bc3 100644
--- a/src/include/ipxe/malloc.h
+++ b/src/include/ipxe/malloc.h
@@ -28,7 +28,6 @@ extern size_t maxusedmem;
 extern void * __malloc alloc_memblock ( size_t size, size_t align,
 					size_t offset );
 extern void free_memblock ( void *ptr, size_t size );
-extern void mpopulate ( void *start, size_t len );
 extern void mdumpfree ( void );
 
 /**
-- 
cgit v1.2.3-55-g7522


From 12ea8c40741786ea33c866d131d510ae70897728 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 24 Feb 2025 14:04:06 +0000
Subject: [cpio] Allow for construction of parent directories as needed

iPXE allows individual raw files to be automatically wrapped with
suitable CPIO headers and injected into the magic initrd image as
exposed to a booted Linux kernel.  This feature is currently limited
to placing files within directories that already exist in the initrd
filesystem.

Remove this limitation by adding the ability for iPXE to construct
CPIO headers for parent directories as needed, under control of the
"mkdir=<n>" command-line argument.  For example:

  initrd config.ign /usr/share/oem/config.ign mkdir=1

will create CPIO headers for the "/usr/share/oem" directory as well as
for the "/usr/share/oem/config.ign" file itself.

This simplifies the process of booting operating systems such as
Flatcar Linux, which otherwise require the single "config.ign" file to
be manually wrapped up as a CPIO archive solely in order to create the
relevant parent directory entries.

The value <n> may be used to control the number of parent directory
entries that are created.  For example, "mkdir=2" would cause up to
two parent directories to be created (i.e. "/usr/share" and
"/usr/share/oem" in the above example).  A negative value such as
"mkdir=-1" may be used to create all parent directories up to the root
of the tree.

Do not create any parent directory entries by default, since doing so
would potentially cause the modes and ownership information for
existing directories to be overwritten.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/image/bzimage.c |  37 +++++++-----
 src/core/cpio.c              | 135 +++++++++++++++++++++++++++++++++----------
 src/include/ipxe/cpio.h      |  25 +++++++-
 src/interface/efi/efi_file.c |  16 ++---
 4 files changed, 161 insertions(+), 52 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/image/bzimage.c b/src/arch/x86/image/bzimage.c
index 2c776147d..d2534bdad 100644
--- a/src/arch/x86/image/bzimage.c
+++ b/src/arch/x86/image/bzimage.c
@@ -353,24 +353,35 @@ static size_t bzimage_load_initrd ( struct image *image,
 	const char *filename = cpio_name ( initrd );
 	struct cpio_header cpio;
 	size_t offset;
+	size_t cpio_len;
 	size_t pad_len;
+	size_t len;
+	unsigned int i;
 
 	/* Skip hidden images */
 	if ( initrd->flags & IMAGE_HIDDEN )
 		return 0;
 
-	/* Create cpio header for non-prebuilt images */
-	offset = cpio_header ( initrd, &cpio );
+	/* Determine length of cpio headers for non-prebuilt images */
+	len = 0;
+	for ( i = 0 ; ( cpio_len = cpio_header ( initrd, i, &cpio ) ) ; i++ )
+		len += ( cpio_len + cpio_pad_len ( cpio_len ) );
 
-	/* Copy in initrd image body (and cpio header if applicable) */
+	/* Copy in initrd image body and construct any cpio headers */
 	if ( address ) {
-		memmove_user ( address, offset, initrd->data, 0, initrd->len );
-		if ( offset ) {
-			memset_user ( address, 0, 0, offset );
-			copy_to_user ( address, 0, &cpio, sizeof ( cpio ) );
-			copy_to_user ( address, sizeof ( cpio ), filename,
-				       cpio_name_len ( initrd ) );
+		memmove_user ( address, len, initrd->data, 0, initrd->len );
+		memset_user ( address, 0, 0, len );
+		offset = 0;
+		for ( i = 0 ; ( cpio_len = cpio_header ( initrd, i, &cpio ) ) ;
+		      i++ ) {
+			copy_to_user ( address, offset, &cpio,
+				       sizeof ( cpio ) );
+			copy_to_user ( address, ( offset + sizeof ( cpio ) ),
+				       filename,
+				       ( cpio_len - sizeof ( cpio ) ) );
+			offset += ( cpio_len + cpio_pad_len ( cpio_len ) );
 		}
+		assert ( offset == len );
 		DBGC ( image, "bzImage %p initrd %p [%#08lx,%#08lx,%#08lx)"
 		       "%s%s\n", image, initrd, user_to_phys ( address, 0 ),
 		       user_to_phys ( address, offset ),
@@ -379,14 +390,14 @@ static size_t bzimage_load_initrd ( struct image *image,
 		DBGC2_MD5A ( image, user_to_phys ( address, offset ),
 			     user_to_virt ( address, offset ), initrd->len );
 	}
-	offset += initrd->len;
+	len += initrd->len;
 
 	/* Zero-pad to next INITRD_ALIGN boundary */
-	pad_len = ( ( -offset ) & ( INITRD_ALIGN - 1 ) );
+	pad_len = ( ( -len ) & ( INITRD_ALIGN - 1 ) );
 	if ( address )
-		memset_user ( address, offset, 0, pad_len );
+		memset_user ( address, len, 0, pad_len );
 
-	return offset;
+	return len;
 }
 
 /**
diff --git a/src/core/cpio.c b/src/core/cpio.c
index 4b607e260..4a7061960 100644
--- a/src/core/cpio.c
+++ b/src/core/cpio.c
@@ -34,13 +34,19 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <string.h>
 #include <ipxe/cpio.h>
 
+/** CPIO default file mode */
+#define CPIO_DEFAULT_MODE 0644
+
+/** CPIO directory mode */
+#define CPIO_DEFAULT_DIR_MODE 0755
+
 /**
  * Set field within a CPIO header
  *
  * @v field		Field within CPIO header
  * @v value		Value to set
  */
-void cpio_set_field ( char *field, unsigned long value ) {
+static void cpio_set_field ( char *field, unsigned long value ) {
 	char buf[9];
 
 	snprintf ( buf, sizeof ( buf ), "%08lx", value );
@@ -48,23 +54,49 @@ void cpio_set_field ( char *field, unsigned long value ) {
 }
 
 /**
- * Get CPIO image filename
+ * Get maximum number of CPIO headers (i.e. number of path components)
  *
  * @v image		Image
- * @ret len		CPIO filename length (0 for no filename)
+ * @ret max		Maximum number of CPIO headers
  */
-size_t cpio_name_len ( struct image *image ) {
+static unsigned int cpio_max ( struct image *image ) {
 	const char *name = cpio_name ( image );
-	char *sep;
-	size_t len;
+	unsigned int max = 0;
+	char c;
 
 	/* Check for existence of CPIO filename */
 	if ( ! name )
 		return 0;
 
-	/* Locate separator (if any) */
-	sep = strchr ( name, ' ' );
-	len = ( sep ? ( ( size_t ) ( sep - name ) ) : strlen ( name ) );
+	/* Count number of path separators */
+	while ( ( ( c = *(name++) ) ) && ( c != ' ' ) ) {
+		if ( c == '/' )
+			max++;
+	}
+
+	return max;
+}
+
+/**
+ * Get CPIO image filename
+ *
+ * @v image		Image
+ * @v depth		Path depth
+ * @ret len		Filename length
+ */
+static size_t cpio_name_len ( struct image *image, unsigned int depth ) {
+	const char *name = cpio_name ( image );
+	size_t len;
+	char c;
+
+	/* Sanity check */
+	assert ( name != NULL );
+
+	/* Calculate length up to specified path depth */
+	for ( len = 0 ; ( ( ( c = name[len] ) ) && ( c != ' ' ) ) ; len++ ) {
+		if ( ( c == '/' ) && ( depth-- == 0 ) )
+			break;
+	}
 
 	return len;
 }
@@ -73,55 +105,100 @@ size_t cpio_name_len ( struct image *image ) {
  * Parse CPIO image parameters
  *
  * @v image		Image
- * @v cpio		CPIO header to fill in
+ * @v mode		Mode to fill in
+ * @v count		Number of CPIO headers to fill in
  */
-static void cpio_parse_cmdline ( struct image *image,
-				 struct cpio_header *cpio ) {
+static void cpio_parse_cmdline ( struct image *image, unsigned int *mode,
+				 unsigned int *count ) {
 	const char *arg;
 	char *end;
-	unsigned int mode;
 
-	/* Look for "mode=" */
+	/* Set default values */
+	*mode = CPIO_DEFAULT_MODE;
+	*count = 1;
+
+	/* Parse "mode=...", if present */
 	if ( ( arg = image_argument ( image, "mode=" ) ) ) {
-		mode = strtoul ( arg, &end, 8 /* Octal for file mode */ );
+		*mode = strtoul ( arg, &end, 8 /* Octal for file mode */ );
 		if ( *end && ( *end != ' ' ) ) {
 			DBGC ( image, "CPIO %p strange \"mode=\" "
 			       "terminator '%c'\n", image, *end );
 		}
-		cpio_set_field ( cpio->c_mode, ( 0100000 | mode ) );
 	}
+
+	/* Parse "mkdir=...", if present */
+	if ( ( arg = image_argument ( image, "mkdir=" ) ) ) {
+		*count += strtoul ( arg, &end, 10 );
+		if ( *end && ( *end != ' ' ) ) {
+			DBGC ( image, "CPIO %p strange \"mkdir=\" "
+			       "terminator '%c'\n", image, *end );
+		}
+	}
+
+	/* Allow "mkdir=-1" to request creation of full directory tree */
+	if ( ! *count )
+		*count = -1U;
 }
 
 /**
  * Construct CPIO header for image, if applicable
  *
  * @v image		Image
+ * @v index		CPIO header index
  * @v cpio		CPIO header to fill in
- * @ret len		Length of magic CPIO header (including filename)
+ * @ret len		Length of CPIO header (including name, excluding NUL)
  */
-size_t cpio_header ( struct image *image, struct cpio_header *cpio ) {
+size_t cpio_header ( struct image *image, unsigned int index,
+		     struct cpio_header *cpio ) {
+	const char *name = cpio_name ( image );
+	unsigned int mode;
+	unsigned int count;
+	unsigned int max;
+	unsigned int depth;
+	unsigned int i;
 	size_t name_len;
 	size_t len;
 
-	/* Get filename length */
-	name_len = cpio_name_len ( image );
+	/* Parse command line arguments */
+	cpio_parse_cmdline ( image, &mode, &count );
 
-	/* Images with no filename are assumed to already be CPIO archives */
-	if ( ! name_len )
+	/* Determine number of CPIO headers to be constructed */
+	max = cpio_max ( image );
+	if ( count > max )
+		count = max;
+
+	/* Determine path depth of this CPIO header */
+	if ( index >= count )
 		return 0;
+	depth = ( max - count + index + 1 );
+
+	/* Get filename length */
+	name_len = cpio_name_len ( image, depth );
+
+	/* Calculate mode and length */
+	if ( depth < max ) {
+		/* Directory */
+		mode = ( CPIO_MODE_DIR | CPIO_DEFAULT_DIR_MODE );
+		len = 0;
+	} else {
+		/* File */
+		mode |= CPIO_MODE_FILE;
+		len = image->len;
+	}
 
 	/* Construct CPIO header */
 	memset ( cpio, '0', sizeof ( *cpio ) );
 	memcpy ( cpio->c_magic, CPIO_MAGIC, sizeof ( cpio->c_magic ) );
-	cpio_set_field ( cpio->c_mode, 0100644 );
+	cpio_set_field ( cpio->c_mode, mode );
 	cpio_set_field ( cpio->c_nlink, 1 );
-	cpio_set_field ( cpio->c_filesize, image->len );
+	cpio_set_field ( cpio->c_filesize, len );
 	cpio_set_field ( cpio->c_namesize, ( name_len + 1 /* NUL */ ) );
-	cpio_parse_cmdline ( image, cpio );
+	DBGC ( image, "CPIO %s %d/%d \"", image->name, depth, max );
+	for ( i = 0 ; i < name_len ; i++ )
+		DBGC ( image, "%c", name[i] );
+	DBGC ( image, "\"\n" );
+	DBGC2_HDA ( image, 0, cpio, sizeof ( *cpio ) );
 
 	/* Calculate total length */
-	len = ( ( sizeof ( *cpio ) + name_len + 1 /* NUL */ + CPIO_ALIGN - 1 )
-		& ~( CPIO_ALIGN - 1 ) );
-
-	return len;
+	return ( sizeof ( *cpio ) + name_len );
 }
diff --git a/src/include/ipxe/cpio.h b/src/include/ipxe/cpio.h
index 9c5e22d5a..c45c12b11 100644
--- a/src/include/ipxe/cpio.h
+++ b/src/include/ipxe/cpio.h
@@ -9,6 +9,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <stdint.h>
 #include <ipxe/image.h>
 
 /** A CPIO archive header
@@ -50,6 +51,12 @@ struct cpio_header {
 /** CPIO magic */
 #define CPIO_MAGIC "070701"
 
+/** CPIO type for regular files */
+#define CPIO_MODE_FILE 0100000
+
+/** CPIO type for directories */
+#define CPIO_MODE_DIR 0040000
+
 /** CPIO header length alignment */
 #define CPIO_ALIGN 4
 
@@ -67,8 +74,20 @@ cpio_name ( struct image *image ) {
 	return image->cmdline;
 }
 
-extern void cpio_set_field ( char *field, unsigned long value );
-extern size_t cpio_name_len ( struct image *image );
-extern size_t cpio_header ( struct image *image, struct cpio_header *cpio );
+/**
+ * Get CPIO header zero-padding length
+ *
+ * @v len		Length of CPIO header (including name, excluding NUL)
+ * @ret pad_len		Padding length
+ */
+static inline __attribute__ (( always_inline )) size_t
+cpio_pad_len ( size_t len ) {
+
+	/* Pad by at least one byte (for name's terminating NUL) */
+	return ( CPIO_ALIGN - ( len % CPIO_ALIGN ) );
+}
+
+extern size_t cpio_header ( struct image *image, unsigned int index,
+			    struct cpio_header *cpio );
 
 #endif /* _IPXE_CPIO_H */
diff --git a/src/interface/efi/efi_file.c b/src/interface/efi/efi_file.c
index 2ae3a0cb4..e10c2ec4e 100644
--- a/src/interface/efi/efi_file.c
+++ b/src/interface/efi/efi_file.c
@@ -245,6 +245,7 @@ static size_t efi_file_read_initrd ( struct efi_file_reader *reader ) {
 	size_t cpio_len;
 	size_t name_len;
 	size_t len;
+	unsigned int i;
 
 	/* Read from file */
 	len = 0;
@@ -263,15 +264,16 @@ static size_t efi_file_read_initrd ( struct efi_file_reader *reader ) {
 		}
 		len += efi_file_read_chunk ( reader, UNULL, pad_len );
 
-		/* Read CPIO header, if applicable */
-		cpio_len = cpio_header ( image, &cpio );
-		if ( cpio_len ) {
-			name = cpio_name ( image );
-			name_len = cpio_name_len ( image );
-			pad_len = ( cpio_len - sizeof ( cpio ) - name_len );
+		/* Read CPIO header(s), if applicable */
+		name = cpio_name ( image );
+		for ( i = 0 ; ( cpio_len = cpio_header ( image, i, &cpio ) );
+		      i++ ) {
+			name_len = ( cpio_len - sizeof ( cpio ) );
+			pad_len = cpio_pad_len ( cpio_len );
 			DBGC ( file, "EFIFILE %s [%#08zx,%#08zx) %s header\n",
 			       efi_file_name ( file ), reader->pos,
-			       ( reader->pos + cpio_len ), image->name );
+			       ( reader->pos + cpio_len + pad_len ),
+			       image->name );
 			len += efi_file_read_chunk ( reader,
 						     virt_to_user ( &cpio ),
 						     sizeof ( cpio ) );
-- 
cgit v1.2.3-55-g7522


From d6ee9a9242f7f2c3ea1fad6959ff16481b34f6b3 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 12 Mar 2025 14:15:16 +0000
Subject: [cpio] Fix calculation of name lengths in CPIO headers

Commit 12ea8c4 ("[cpio] Allow for construction of parent directories
as needed") introduced a regression in constructing CPIO archive
headers for relative paths (e.g. simple filenames with no leading
slash).

Fix by counting the number of path components rather than the number
of path separators, and add some test cases to cover CPIO header
construction.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/cpio.c       |  16 +--
 src/tests/cpio_test.c | 263 ++++++++++++++++++++++++++++++++++++++++++++++++++
 src/tests/tests.c     |   1 +
 3 files changed, 274 insertions(+), 6 deletions(-)
 create mode 100644 src/tests/cpio_test.c

(limited to 'src/core')

diff --git a/src/core/cpio.c b/src/core/cpio.c
index 4a7061960..63ac28ee6 100644
--- a/src/core/cpio.c
+++ b/src/core/cpio.c
@@ -63,14 +63,15 @@ static unsigned int cpio_max ( struct image *image ) {
 	const char *name = cpio_name ( image );
 	unsigned int max = 0;
 	char c;
+	char p;
 
 	/* Check for existence of CPIO filename */
 	if ( ! name )
 		return 0;
 
-	/* Count number of path separators */
-	while ( ( ( c = *(name++) ) ) && ( c != ' ' ) ) {
-		if ( c == '/' )
+	/* Count number of path components */
+	for ( p = '/' ; ( ( ( c = *(name++) ) ) && ( c != ' ' ) ) ; p = c ) {
+		if ( ( p == '/' ) && ( c != '/' ) )
 			max++;
 	}
 
@@ -88,13 +89,16 @@ static size_t cpio_name_len ( struct image *image, unsigned int depth ) {
 	const char *name = cpio_name ( image );
 	size_t len;
 	char c;
+	char p;
 
-	/* Sanity check */
+	/* Sanity checks */
 	assert ( name != NULL );
+	assert ( depth > 0 );
 
 	/* Calculate length up to specified path depth */
-	for ( len = 0 ; ( ( ( c = name[len] ) ) && ( c != ' ' ) ) ; len++ ) {
-		if ( ( c == '/' ) && ( depth-- == 0 ) )
+	for ( len = 0, p = '/' ; ( ( ( c = name[len] ) ) && ( c != ' ' ) ) ;
+	      len++, p = c ) {
+		if ( ( c == '/' ) && ( p != '/' ) && ( --depth == 0 ) )
 			break;
 	}
 
diff --git a/src/tests/cpio_test.c b/src/tests/cpio_test.c
new file mode 100644
index 000000000..3498c0f95
--- /dev/null
+++ b/src/tests/cpio_test.c
@@ -0,0 +1,263 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * CPIO self-tests
+ *
+ */
+
+/* Forcibly enable assertions */
+#undef NDEBUG
+
+#include <stdlib.h>
+#include <ipxe/cpio.h>
+#include <ipxe/test.h>
+
+/** A CPIO test */
+struct cpio_test {
+	/** Test name */
+	const char *name;
+	/** Image length */
+	size_t len;
+	/** Image command line */
+	const char *cmdline;
+	/** Expected CPIO headers */
+	const uint8_t *expected;
+	/** Length of expected CPIO headers */
+	size_t expected_len;
+	/** Expected number of CPIO headers */
+	unsigned int expected_count;
+};
+
+/** Define an expected CPIO header */
+#define CPIO_HEADER( mode, filesize, namesize, pname )			\
+     "070701" "00000000" mode "00000000" "00000000" "00000001"		\
+     "00000000" filesize "00000000" "00000000" "00000000" "00000000"	\
+     namesize "00000000" pname
+
+/** Define a one-byte padding */
+#define PAD1 "\0"
+
+/** Define a two-byte padding */
+#define PAD2 "\0\0"
+
+/** Define a three-byte padding */
+#define PAD3 "\0\0\0"
+
+/** Define four-byte padding */
+#define PAD4 "\0\0\0\0"
+
+/** Define a CPIO test */
+#define CPIO_TEST( NAME, LEN, CMDLINE, COUNT, EXPECTED )		\
+	static const uint8_t NAME ## _expected[] = EXPECTED;		\
+	static struct cpio_test NAME = {				\
+		.name = #NAME,						\
+		.len = LEN,						\
+		.cmdline = CMDLINE,					\
+		.expected = NAME ## _expected,				\
+		.expected_len = ( sizeof ( NAME ## _expected )		\
+				  - 1 /* NUL */ ),			\
+		.expected_count = COUNT,				\
+	};
+
+/**
+ * Report a CPIO test result
+ *
+ * @v test		CPIO test
+ * @v file		Test code file
+ * @v line		Test code line
+ */
+static void cpio_okx ( struct cpio_test *test, const char *file,
+		       unsigned int line ) {
+	struct cpio_header cpio;
+	struct image *image;
+	uint8_t *data;
+	size_t len;
+	size_t cpio_len;
+	unsigned int i;
+	unsigned int j;
+
+	DBGC ( test, "CPIO len %#zx cmdline \"%s\"\n",
+	       test->len, test->cmdline );
+	DBGC2_HDA ( test, 0, test->expected, test->expected_len );
+
+	/* Sanity check */
+	okx ( ( test->expected_len % CPIO_ALIGN ) == 0, file, line );
+
+	/* Construct dummy image */
+	image = alloc_image ( NULL );
+	okx ( image != NULL, file, line );
+	okx ( image_set_name ( image, test->name ) == 0, file, line );
+	okx ( image_set_len ( image, test->len ) == 0, file, line );
+	okx ( image_set_cmdline ( image, test->cmdline ) == 0, file, line );
+
+	/* Calculate length of CPIO headers */
+	len = 0;
+	for ( i = 0 ; ( cpio_len = cpio_header ( image, i, &cpio ) ) ; i++ ) {
+		okx ( cpio_len >= sizeof ( cpio ), file, line );
+		len += ( cpio_len + cpio_pad_len ( cpio_len ) );
+		okx ( cpio_pad_len ( cpio_len ) > 0, file, line );
+		okx ( ( len % CPIO_ALIGN ) == 0, file, line );
+	}
+	okx ( i == test->expected_count, file, line );
+	okx ( len == test->expected_len, file, line );
+
+	/* Allocate space for CPIO headers */
+	data = zalloc ( len );
+	okx ( data != NULL, file, line );
+
+	/* Construct CPIO headers */
+	len = 0;
+	for ( i = 0 ; ( cpio_len = cpio_header ( image, i, &cpio ) ) ; i++ ) {
+		memcpy ( ( data + len ), &cpio, sizeof ( cpio ) );
+		memcpy ( ( data + len + sizeof ( cpio ) ), cpio_name ( image ),
+			 ( cpio_len - sizeof ( cpio ) ) );
+		DBGC ( test, "CPIO hdr %d: ", i );
+		for ( j = 0 ; j < cpio_len ; j++ ) {
+			if ( ( j <= sizeof ( cpio ) && ! ( ( j + 2 ) % 8 ) ) )
+				DBGC ( test, " " );
+			DBGC ( test, "%c", data[ len + j ] );
+		}
+		DBGC ( test, "\n" );
+		len += ( cpio_len + cpio_pad_len ( cpio_len ) );
+	}
+	okx ( i == test->expected_count, file, line );
+	okx ( len == test->expected_len, file, line );
+
+	/* Verify constructed CPIO headers */
+	DBGC2_HDA ( test, 0, data, len );
+	okx ( memcmp ( data, test->expected, test->expected_len ) == 0,
+	      file, line );
+
+	/* Free constructed headers */
+	free ( data );
+
+	/* Drop reference to dummy image */
+	image_put ( image );
+}
+#define cpio_ok( test ) cpio_okx ( test, __FILE__, __LINE__ )
+
+/* Image with no command line */
+CPIO_TEST ( no_cmdline, 42, NULL, 0, "" );
+
+/* Image with empty command line */
+CPIO_TEST ( empty_cmdline, 154, "", 0, "" );
+
+/* All slashes */
+CPIO_TEST ( all_slashes, 64, "////", 0, "" );
+
+/* Simple filename */
+CPIO_TEST ( simple, 0x69, "wimboot", 1,
+	    CPIO_HEADER ( "000081a4", "00000069", "00000008",
+			  "wimboot" PAD3 ) );
+
+/* Initial slash */
+CPIO_TEST ( init_slash, 0x273, "/wimboot", 1,
+	    CPIO_HEADER ( "000081a4", "00000273", "00000009",
+			  "/wimboot" PAD2 ) );
+
+/* Initial slashes */
+CPIO_TEST ( init_slashes, 0x94, "///initscript", 1,
+	    CPIO_HEADER ( "000081a4", "00000094", "0000000e",
+			  "///initscript" PAD1 ) );
+
+/* Full path */
+CPIO_TEST ( path, 0x341, "/usr/share/oem/config.ign", 1,
+	    CPIO_HEADER ( "000081a4", "00000341", "0000001a",
+			  "/usr/share/oem/config.ign" PAD1 ) );
+
+/* Full path, mkdir=0 */
+CPIO_TEST ( path_mkdir_0, 0x341, "/usr/share/oem/config.ign mkdir=0", 1,
+	    CPIO_HEADER ( "000081a4", "00000341", "0000001a",
+			  "/usr/share/oem/config.ign" PAD1 ) );
+
+/* Full path, mkdir=1 */
+CPIO_TEST ( path_mkdir_1, 0x341, "/usr/share/oem/config.ign mkdir=1", 2,
+	    CPIO_HEADER ( "000041ed", "00000000", "0000000f",
+			  "/usr/share/oem" PAD4 )
+	    CPIO_HEADER ( "000081a4", "00000341", "0000001a",
+			  "/usr/share/oem/config.ign" PAD1 ) );
+
+/* Full path, mkdir=2 */
+CPIO_TEST ( path_mkdir_2, 0x341, "/usr/share/oem/config.ign mkdir=2", 3,
+	    CPIO_HEADER ( "000041ed", "00000000", "0000000b",
+			  "/usr/share" PAD4 )
+	    CPIO_HEADER ( "000041ed", "00000000", "0000000f",
+			  "/usr/share/oem" PAD4 )
+	    CPIO_HEADER ( "000081a4", "00000341", "0000001a",
+			  "/usr/share/oem/config.ign" PAD1 ) );
+
+/* Full path, mkdir=-1 */
+CPIO_TEST ( path_mkdir_all, 0x341, "/usr/share/oem/config.ign mkdir=-1", 4,
+	    CPIO_HEADER ( "000041ed", "00000000", "00000005",
+			  "/usr" PAD2 )
+	    CPIO_HEADER ( "000041ed", "00000000", "0000000b",
+			  "/usr/share" PAD4 )
+	    CPIO_HEADER ( "000041ed", "00000000", "0000000f",
+			  "/usr/share/oem" PAD4 )
+	    CPIO_HEADER ( "000081a4", "00000341", "0000001a",
+			  "/usr/share/oem/config.ign" PAD1 ) );
+
+/* Custom mode */
+CPIO_TEST ( mode, 39, "/sbin/init mode=755", 1,
+	    CPIO_HEADER ( "000081ed", "00000027", "0000000b",
+			  "/sbin/init" PAD4 ) );
+
+/* Chaos */
+CPIO_TEST ( chaos, 73, "///etc//init.d///runthings mode=700 mkdir=99", 3,
+	    CPIO_HEADER ( "000041ed", "00000000", "00000007",
+			  "///etc" PAD4 )
+	    CPIO_HEADER ( "000041ed", "00000000", "0000000f",
+			  "///etc//init.d" PAD4 )
+	    CPIO_HEADER ( "000081c0", "00000049", "0000001b",
+			  "///etc//init.d///runthings" PAD4 ) );
+
+/**
+ * Perform CPIO self-test
+ *
+ */
+static void cpio_test_exec ( void ) {
+
+	cpio_ok ( &no_cmdline );
+	cpio_ok ( &empty_cmdline );
+	cpio_ok ( &all_slashes );
+	cpio_ok ( &simple );
+	cpio_ok ( &init_slash );
+	cpio_ok ( &init_slashes );
+	cpio_ok ( &path );
+	cpio_ok ( &path_mkdir_0 );
+	cpio_ok ( &path_mkdir_1 );
+	cpio_ok ( &path_mkdir_2 );
+	cpio_ok ( &path_mkdir_all );
+	cpio_ok ( &mode );
+	cpio_ok ( &chaos );
+}
+
+/** CPIO self-test */
+struct self_test cpio_test __self_test = {
+	.name = "cpio",
+	.exec = cpio_test_exec,
+};
diff --git a/src/tests/tests.c b/src/tests/tests.c
index 865818bdc..447eec314 100644
--- a/src/tests/tests.c
+++ b/src/tests/tests.c
@@ -89,3 +89,4 @@ REQUIRE_OBJECT ( editstring_test );
 REQUIRE_OBJECT ( p256_test );
 REQUIRE_OBJECT ( p384_test );
 REQUIRE_OBJECT ( efi_siglist_test );
+REQUIRE_OBJECT ( cpio_test );
-- 
cgit v1.2.3-55-g7522


From da3024d257d73d2c40e65c6fb9db5a2a6bc86dbb Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 12 Mar 2025 14:25:05 +0000
Subject: [cpio] Allow for the construction of pure directories

Allow for the possibility of creating empty directories (without
having to include a dummy file inside the directory) using a
zero-length image and a CPIO filename with a trailing slash, such as:

  initrd emptyfile /usr/share/oem/

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/cpio.c       | 11 +++++------
 src/tests/cpio_test.c | 16 ++++++++++++++++
 2 files changed, 21 insertions(+), 6 deletions(-)

(limited to 'src/core')

diff --git a/src/core/cpio.c b/src/core/cpio.c
index 63ac28ee6..9f5d772e9 100644
--- a/src/core/cpio.c
+++ b/src/core/cpio.c
@@ -179,17 +179,16 @@ size_t cpio_header ( struct image *image, unsigned int index,
 	/* Get filename length */
 	name_len = cpio_name_len ( image, depth );
 
-	/* Calculate mode and length */
-	if ( depth < max ) {
-		/* Directory */
+	/* Set directory mode or file mode as appropriate */
+	if ( name[name_len] == '/' ) {
 		mode = ( CPIO_MODE_DIR | CPIO_DEFAULT_DIR_MODE );
-		len = 0;
 	} else {
-		/* File */
 		mode |= CPIO_MODE_FILE;
-		len = image->len;
 	}
 
+	/* Set length on final header */
+	len = ( ( depth < max ) ? 0 : image->len );
+
 	/* Construct CPIO header */
 	memset ( cpio, '0', sizeof ( *cpio ) );
 	memcpy ( cpio->c_magic, CPIO_MAGIC, sizeof ( cpio->c_magic ) );
diff --git a/src/tests/cpio_test.c b/src/tests/cpio_test.c
index 3498c0f95..7eb8b2c74 100644
--- a/src/tests/cpio_test.c
+++ b/src/tests/cpio_test.c
@@ -221,6 +221,20 @@ CPIO_TEST ( path_mkdir_all, 0x341, "/usr/share/oem/config.ign mkdir=-1", 4,
 	    CPIO_HEADER ( "000081a4", "00000341", "0000001a",
 			  "/usr/share/oem/config.ign" PAD1 ) );
 
+/* Simple directory */
+CPIO_TEST ( dir, 0, "/opt/", 1,
+	    CPIO_HEADER ( "000041ed", "00000000", "00000005",
+			  "/opt" PAD2 ) );
+
+/* Directory tree */
+CPIO_TEST ( tree, 0, "/opt/oem/scripts/ mkdir=-1", 3,
+	    CPIO_HEADER ( "000041ed", "00000000", "00000005",
+			  "/opt" PAD2 )
+	    CPIO_HEADER ( "000041ed", "00000000", "00000009",
+			  "/opt/oem" PAD2 )
+	    CPIO_HEADER ( "000041ed", "00000000", "00000011",
+			  "/opt/oem/scripts" PAD2 ) );
+
 /* Custom mode */
 CPIO_TEST ( mode, 39, "/sbin/init mode=755", 1,
 	    CPIO_HEADER ( "000081ed", "00000027", "0000000b",
@@ -252,6 +266,8 @@ static void cpio_test_exec ( void ) {
 	cpio_ok ( &path_mkdir_1 );
 	cpio_ok ( &path_mkdir_2 );
 	cpio_ok ( &path_mkdir_all );
+	cpio_ok ( &dir );
+	cpio_ok ( &tree );
 	cpio_ok ( &mode );
 	cpio_ok ( &chaos );
 }
-- 
cgit v1.2.3-55-g7522


From cfd93465ec9d5e47447564cd4cedabc43390c12b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 27 Mar 2025 11:30:27 +0000
Subject: [fdt] Add the concept of an FDT image

Define the concept of an "FDT" image, representing a Flattened Device
Tree blob that has been downloaded in order to be provided to a kernel
or other executable image.  FDT images are represented using an image
tag (as with other special-purpose images such as the UEFI shim), and
are similarly marked as hidden so that they will not be included in a
generated magic initrd or show up in a virtual filesystem directory
listing.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c            |  6 ++++++
 src/include/ipxe/fdt.h    |  3 +++
 src/include/usr/fdtmgmt.h | 16 +++++++++++++++
 src/usr/fdtmgmt.c         | 51 +++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 76 insertions(+)
 create mode 100644 src/include/usr/fdtmgmt.h
 create mode 100644 src/usr/fdtmgmt.c

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index b7289fd36..ad83ed69a 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -28,6 +28,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <assert.h>
 #include <byteswap.h>
 #include <ipxe/netdevice.h>
+#include <ipxe/image.h>
 #include <ipxe/fdt.h>
 
 /** @file
@@ -39,6 +40,11 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /** The system flattened device tree (if present) */
 static struct fdt fdt;
 
+/** The downloaded flattened device tree tag */
+struct image_tag fdt_image __image_tag = {
+	.name = "FDT",
+};
+
 /** A position within a device tree */
 struct fdt_cursor {
 	/** Offset within structure block */
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 9b9b01b6c..995975ed8 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -10,6 +10,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
+#include <ipxe/image.h>
 
 struct net_device;
 
@@ -93,6 +94,8 @@ struct fdt {
 	size_t strings_len;
 };
 
+extern struct image_tag fdt_image __image_tag;
+
 extern int fdt_path ( const char *path, unsigned int *offset );
 extern int fdt_alias ( const char *name, unsigned int *offset );
 extern const char * fdt_string ( unsigned int offset, const char *name );
diff --git a/src/include/usr/fdtmgmt.h b/src/include/usr/fdtmgmt.h
new file mode 100644
index 000000000..3d3aef859
--- /dev/null
+++ b/src/include/usr/fdtmgmt.h
@@ -0,0 +1,16 @@
+#ifndef _USR_FDTMGMT_H
+#define _USR_FDTMGMT_H
+
+/** @file
+ *
+ * Flattened Device Tree management
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/image.h>
+
+extern int imgfdt ( struct image *image );
+
+#endif /* _USR_FDTMGMT_H */
diff --git a/src/usr/fdtmgmt.c b/src/usr/fdtmgmt.c
new file mode 100644
index 000000000..dabeef2c8
--- /dev/null
+++ b/src/usr/fdtmgmt.c
@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/fdt.h>
+#include <usr/fdtmgmt.h>
+
+/** @file
+ *
+ * Flattened Device Tree management
+ *
+ */
+
+/**
+ * Apply flattened device tree image
+ *
+ * @v image		FDT image, or NULL to clear FDT
+ * @ret rc		Return status code
+ */
+int imgfdt ( struct image *image ) {
+
+	/* Record (or clear) FDT image */
+	image_tag ( image, &fdt_image );
+
+	/* Avoid including image in constructed initrd */
+	if ( image )
+		image_hide ( image );
+
+	return 0;
+}
-- 
cgit v1.2.3-55-g7522


From 2399c7998072f47a7f599ddd4d318bbc14adf39d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 28 Mar 2025 12:42:30 +0000
Subject: [fdt] Allow for the existence of multiple device trees

When running on a platform that uses FDT as its hardware description
mechanism, we are likely to have multiple device tree structures.  At
a minimum, there will be the device tree passed to us from the
previous boot stage (e.g. OpenSBI), and the device tree that we
construct to be passed to the booted operating system.

Update the internal FDT API to include an FDT pointer in all function
parameter lists.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/core/hart.c        |   4 +-
 src/arch/riscv/core/zicntr.c      |   4 +-
 src/arch/riscv/prefix/sbiprefix.S |   5 +-
 src/core/fdt.c                    | 186 +++++++++++++++++++-------------------
 src/drivers/net/smscusb.c         |   6 +-
 src/include/ipxe/fdt.h            |  20 ++--
 src/interface/efi/efi_fdt.c       |   6 +-
 7 files changed, 121 insertions(+), 110 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/core/hart.c b/src/arch/riscv/core/hart.c
index c4f2bd0a5..d9cfb4e5d 100644
--- a/src/arch/riscv/core/hart.c
+++ b/src/arch/riscv/core/hart.c
@@ -55,7 +55,7 @@ static int hart_node ( unsigned int *offset ) {
 	snprintf ( path, sizeof ( path ), "/cpus/cpu@%lx", boot_hart );
 
 	/* Find node */
-	if ( ( rc = fdt_path ( path, offset ) ) != 0 ) {
+	if ( ( rc = fdt_path ( &sysfdt, path, offset ) ) != 0 ) {
 		DBGC ( colour, "HART could not find %s: %s\n",
 		       path, strerror ( rc ) );
 		return rc;
@@ -81,7 +81,7 @@ int hart_supported ( const char *ext ) {
 		return rc;
 
 	/* Get ISA description */
-	isa = fdt_string ( offset, "riscv,isa" );
+	isa = fdt_string ( &sysfdt, offset, "riscv,isa" );
 	if ( ! isa ) {
 		DBGC ( colour, "HART could not identify ISA\n" );
 		return -ENOENT;
diff --git a/src/arch/riscv/core/zicntr.c b/src/arch/riscv/core/zicntr.c
index 826f31a68..7ea9f96ad 100644
--- a/src/arch/riscv/core/zicntr.c
+++ b/src/arch/riscv/core/zicntr.c
@@ -152,8 +152,8 @@ static int zicntr_probe ( void ) {
 	}
 
 	/* Get timer frequency */
-	if ( ( ( rc = fdt_path ( "/cpus", &offset ) ) != 0 ) ||
-	     ( ( rc = fdt_u64 ( offset, "timebase-frequency",
+	if ( ( ( rc = fdt_path ( &sysfdt, "/cpus", &offset ) ) != 0 ) ||
+	     ( ( rc = fdt_u64 ( &sysfdt, offset, "timebase-frequency",
 				&u.freq ) ) != 0 ) ) {
 		DBGC ( colour, "ZICNTR could not determine frequency: %s\n",
 		       strerror ( rc ) );
diff --git a/src/arch/riscv/prefix/sbiprefix.S b/src/arch/riscv/prefix/sbiprefix.S
index 0de001951..a39d37cb1 100644
--- a/src/arch/riscv/prefix/sbiprefix.S
+++ b/src/arch/riscv/prefix/sbiprefix.S
@@ -121,8 +121,9 @@ _sbi_start:
 	STOREN	s0, (t0)
 
 	/* Register device tree */
-	mv	a0, s1
-	call	register_fdt
+	la	a0, sysfdt
+	mv	a1, s1
+	call	fdt_parse
 
 	/* Call main program */
 	progress "\n\n"
diff --git a/src/core/fdt.c b/src/core/fdt.c
index ad83ed69a..e2ce055eb 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -38,7 +38,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 /** The system flattened device tree (if present) */
-static struct fdt fdt;
+struct fdt sysfdt;
 
 /** The downloaded flattened device tree tag */
 struct image_tag fdt_image __image_tag = {
@@ -63,24 +63,16 @@ struct fdt_descriptor {
 	size_t len;
 };
 
-/**
- * Check if device tree exists
- *
- * @v has_fdt		Device tree exists
- */
-static inline __attribute__ (( always_inline )) int fdt_exists ( void ) {
-
-	return ( fdt.hdr != NULL );
-}
-
 /**
  * Traverse device tree
  *
+ * @v fdt		Device tree
  * @v pos		Position within device tree
  * @v desc		Lexical descriptor to fill in
  * @ret rc		Return status code
  */
-static int fdt_traverse ( struct fdt_cursor *pos,
+static int fdt_traverse ( struct fdt *fdt,
+			  struct fdt_cursor *pos,
 			  struct fdt_descriptor *desc ) {
 	const fdt_token_t *token;
 	const void *data;
@@ -90,17 +82,17 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 	size_t len;
 
 	/* Sanity checks */
-	assert ( pos->offset < fdt.len );
+	assert ( pos->offset < fdt->len );
 	assert ( ( pos->offset & ( FDT_STRUCTURE_ALIGN - 1 ) ) == 0 );
 
 	/* Clear descriptor */
 	memset ( desc, 0, sizeof ( *desc ) );
 
 	/* Locate token and calculate remaining space */
-	token = ( fdt.raw + fdt.structure + pos->offset );
-	remaining = ( fdt.len - pos->offset );
+	token = ( fdt->raw + fdt->structure + pos->offset );
+	remaining = ( fdt->len - pos->offset );
 	if ( remaining < sizeof ( *token ) ) {
-		DBGC ( &fdt, "FDT truncated tree at +%#04x\n", pos->offset );
+		DBGC ( fdt, "FDT truncated tree at +%#04x\n", pos->offset );
 		return -EINVAL;
 	}
 	remaining -= sizeof ( *token );
@@ -116,7 +108,7 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 		desc->name = data;
 		len = ( strnlen ( desc->name, remaining ) + 1 /* NUL */ );
 		if ( remaining < len ) {
-			DBGC ( &fdt, "FDT unterminated node name at +%#04x\n",
+			DBGC ( fdt, "FDT unterminated node name at +%#04x\n",
 			       pos->offset );
 			return -EINVAL;
 		}
@@ -127,7 +119,7 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 
 		/* End of node */
 		if ( pos->depth < 0 ) {
-			DBGC ( &fdt, "FDT spurious node end at +%#04x\n",
+			DBGC ( fdt, "FDT spurious node end at +%#04x\n",
 			       pos->offset );
 			return -EINVAL;
 		}
@@ -143,7 +135,7 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 		/* Property */
 		prop = data;
 		if ( remaining < sizeof ( *prop ) ) {
-			DBGC ( &fdt, "FDT truncated property at +%#04x\n",
+			DBGC ( fdt, "FDT truncated property at +%#04x\n",
 			       pos->offset );
 			return -EINVAL;
 		}
@@ -151,17 +143,17 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 		desc->len = be32_to_cpu ( prop->len );
 		len = ( sizeof ( *prop ) + desc->len );
 		if ( remaining < len ) {
-			DBGC ( &fdt, "FDT overlength property at +%#04x\n",
+			DBGC ( fdt, "FDT overlength property at +%#04x\n",
 			       pos->offset );
 			return -EINVAL;
 		}
 		name_off = be32_to_cpu ( prop->name_off );
-		if ( name_off > fdt.strings_len ) {
-			DBGC ( &fdt, "FDT property name outside strings "
+		if ( name_off > fdt->strings_len ) {
+			DBGC ( fdt, "FDT property name outside strings "
 			       "block at +%#04x\n", pos->offset );
 			return -EINVAL;
 		}
-		desc->name = ( fdt.raw + fdt.strings + name_off );
+		desc->name = ( fdt->raw + fdt->strings + name_off );
 		break;
 
 	case cpu_to_be32 ( FDT_NOP ):
@@ -172,7 +164,7 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 	default:
 
 		/* Unrecognised or unexpected token */
-		DBGC ( &fdt, "FDT unexpected token %#08x at +%#04x\n",
+		DBGC ( fdt, "FDT unexpected token %#08x at +%#04x\n",
 		       be32_to_cpu ( *token ), pos->offset );
 		return -EINVAL;
 	}
@@ -183,7 +175,7 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 	pos->offset += ( sizeof ( *token ) + len );
 
 	/* Sanity checks */
-	assert ( pos->offset <= fdt.len );
+	assert ( pos->offset <= fdt->len );
 
 	return 0;
 }
@@ -191,12 +183,13 @@ static int fdt_traverse ( struct fdt_cursor *pos,
 /**
  * Find child node
  *
+ * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Node name
  * @v child		Child node offset to fill in
  * @ret rc		Return status code
  */
-static int fdt_child ( unsigned int offset, const char *name,
+static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 		       unsigned int *child ) {
 	struct fdt_cursor pos;
 	struct fdt_descriptor desc;
@@ -217,18 +210,18 @@ static int fdt_child ( unsigned int offset, const char *name,
 		*child = pos.offset;
 
 		/* Traverse tree */
-		if ( ( rc = fdt_traverse ( &pos, &desc ) ) != 0 ) {
-			DBGC ( &fdt, "FDT +%#04x has no child node \"%s\": "
+		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has no child node \"%s\": "
 			       "%s\n", orig_offset, name, strerror ( rc ) );
 			return rc;
 		}
 
 		/* Check for matching immediate child node */
 		if ( ( pos.depth == 1 ) && desc.name && ( ! desc.data ) ) {
-			DBGC2 ( &fdt, "FDT +%#04x has child node \"%s\"\n",
+			DBGC2 ( fdt, "FDT +%#04x has child node \"%s\"\n",
 				orig_offset, desc.name );
 			if ( strcmp ( name, desc.name ) == 0 ) {
-				DBGC2 ( &fdt, "FDT +%#04x found child node "
+				DBGC2 ( fdt, "FDT +%#04x found child node "
 					"\"%s\" at +%#04x\n", orig_offset,
 					desc.name, *child );
 				return 0;
@@ -240,11 +233,12 @@ static int fdt_child ( unsigned int offset, const char *name,
 /**
  * Find node by path
  *
+ * @v fdt		Device tree
  * @v path		Node path
  * @v offset		Offset to fill in
  * @ret rc		Return status code
  */
-int fdt_path ( const char *path, unsigned int *offset ) {
+int fdt_path ( struct fdt *fdt, const char *path, unsigned int *offset ) {
 	char *tmp = ( ( char * ) path );
 	char *del;
 	int rc;
@@ -265,7 +259,7 @@ int fdt_path ( const char *path, unsigned int *offset ) {
 			*del = '\0';
 
 		/* Find child and restore delimiter */
-		rc = fdt_child ( *offset, tmp, offset );
+		rc = fdt_child ( fdt, *offset, tmp, offset );
 		if ( del )
 			*del = '/';
 		if ( rc != 0 )
@@ -276,32 +270,33 @@ int fdt_path ( const char *path, unsigned int *offset ) {
 			tmp++;
 	}
 
-	DBGC2 ( &fdt, "FDT found path \"%s\" at +%#04x\n", path, *offset );
+	DBGC2 ( fdt, "FDT found path \"%s\" at +%#04x\n", path, *offset );
 	return 0;
 }
 
 /**
  * Find node by alias
  *
+ * @v fdt		Device tree
  * @v name		Alias name
  * @v offset		Offset to fill in
  * @ret rc		Return status code
  */
-int fdt_alias ( const char *name, unsigned int *offset ) {
+int fdt_alias ( struct fdt *fdt, const char *name, unsigned int *offset ) {
 	const char *alias;
 	int rc;
 
 	/* Locate "/aliases" node */
-	if ( ( rc = fdt_child ( 0, "aliases", offset ) ) != 0 )
+	if ( ( rc = fdt_child ( fdt, 0, "aliases", offset ) ) != 0 )
 		return rc;
 
 	/* Locate alias property */
-	if ( ( alias = fdt_string ( *offset, name ) ) == NULL )
+	if ( ( alias = fdt_string ( fdt, *offset, name ) ) == NULL )
 		return -ENOENT;
-	DBGC ( &fdt, "FDT alias \"%s\" is \"%s\"\n", name, alias );
+	DBGC ( fdt, "FDT alias \"%s\" is \"%s\"\n", name, alias );
 
 	/* Locate aliased node */
-	if ( ( rc = fdt_path ( alias, offset ) ) != 0 )
+	if ( ( rc = fdt_path ( fdt, alias, offset ) ) != 0 )
 		return rc;
 
 	return 0;
@@ -310,13 +305,14 @@ int fdt_alias ( const char *name, unsigned int *offset ) {
 /**
  * Find property
  *
+ * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
  * @v desc		Lexical descriptor to fill in
  * @ret rc		Return status code
  */
-static int fdt_property ( unsigned int offset, const char *name,
-			  struct fdt_descriptor *desc ) {
+static int fdt_property ( struct fdt *fdt, unsigned int offset,
+			  const char *name, struct fdt_descriptor *desc ) {
 	struct fdt_cursor pos;
 	int rc;
 
@@ -328,20 +324,20 @@ static int fdt_property ( unsigned int offset, const char *name,
 	while ( 1 ) {
 
 		/* Traverse tree */
-		if ( ( rc = fdt_traverse ( &pos, desc ) ) != 0 ) {
-			DBGC ( &fdt, "FDT +%#04x has no property \"%s\": %s\n",
+		if ( ( rc = fdt_traverse ( fdt, &pos, desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has no property \"%s\": %s\n",
 			       offset, name, strerror ( rc ) );
 			return rc;
 		}
 
 		/* Check for matching immediate child property */
 		if ( ( pos.depth == 0 ) && desc->data ) {
-			DBGC2 ( &fdt, "FDT +%#04x has property \"%s\" len "
+			DBGC2 ( fdt, "FDT +%#04x has property \"%s\" len "
 				"%#zx\n", offset, desc->name, desc->len );
 			if ( strcmp ( name, desc->name ) == 0 ) {
-				DBGC2 ( &fdt, "FDT +%#04x found property "
+				DBGC2 ( fdt, "FDT +%#04x found property "
 					"\"%s\"\n", offset, desc->name );
-				DBGC2_HDA ( &fdt, 0, desc->data, desc->len );
+				DBGC2_HDA ( fdt, 0, desc->data, desc->len );
 				return 0;
 			}
 		}
@@ -351,21 +347,23 @@ static int fdt_property ( unsigned int offset, const char *name,
 /**
  * Find string property
  *
+ * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
  * @ret string		String property, or NULL on error
  */
-const char * fdt_string ( unsigned int offset, const char *name ) {
+const char * fdt_string ( struct fdt *fdt, unsigned int offset,
+			  const char *name ) {
 	struct fdt_descriptor desc;
 	int rc;
 
 	/* Find property */
-	if ( ( rc = fdt_property ( offset, name, &desc ) ) != 0 )
+	if ( ( rc = fdt_property ( fdt, offset, name, &desc ) ) != 0 )
 		return NULL;
 
 	/* Check NUL termination */
 	if ( strnlen ( desc.data, desc.len ) == desc.len ) {
-		DBGC ( &fdt, "FDT unterminated string property \"%s\"\n",
+		DBGC ( fdt, "FDT unterminated string property \"%s\"\n",
 		       name );
 		return NULL;
 	}
@@ -376,12 +374,14 @@ const char * fdt_string ( unsigned int offset, const char *name ) {
 /**
  * Find integer property
  *
+ * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
  * @v value		Integer value to fill in
  * @ret rc		Return status code
  */
-int fdt_u64 ( unsigned int offset, const char *name, uint64_t *value ) {
+int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
+	      uint64_t *value ) {
 	struct fdt_descriptor desc;
 	const uint8_t *data;
 	size_t remaining;
@@ -391,12 +391,12 @@ int fdt_u64 ( unsigned int offset, const char *name, uint64_t *value ) {
 	*value = 0;
 
 	/* Find property */
-	if ( ( rc = fdt_property ( offset, name, &desc ) ) != 0 )
+	if ( ( rc = fdt_property ( fdt, offset, name, &desc ) ) != 0 )
 		return rc;
 
 	/* Check range */
 	if ( desc.len > sizeof ( *value ) ) {
-		DBGC ( &fdt, "FDT oversized integer property \"%s\"\n", name );
+		DBGC ( fdt, "FDT oversized integer property \"%s\"\n", name );
 		return -ERANGE;
 	}
 
@@ -414,18 +414,21 @@ int fdt_u64 ( unsigned int offset, const char *name, uint64_t *value ) {
 /**
  * Get MAC address from property
  *
+ * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v netdev		Network device
  * @ret rc		Return status code
  */
-int fdt_mac ( unsigned int offset, struct net_device *netdev ) {
+int fdt_mac ( struct fdt *fdt, unsigned int offset,
+	      struct net_device *netdev ) {
 	struct fdt_descriptor desc;
 	size_t len;
 	int rc;
 
 	/* Find applicable MAC address property */
-	if ( ( ( rc = fdt_property ( offset, "mac-address", &desc ) ) != 0 ) &&
-	     ( ( rc = fdt_property ( offset, "local-mac-address",
+	if ( ( ( rc = fdt_property ( fdt, offset, "mac-address",
+				     &desc ) ) != 0 ) &&
+	     ( ( rc = fdt_property ( fdt, offset, "local-mac-address",
 				     &desc ) ) != 0 ) ) {
 		return rc;
 	}
@@ -433,9 +436,9 @@ int fdt_mac ( unsigned int offset, struct net_device *netdev ) {
 	/* Check length */
 	len = netdev->ll_protocol->hw_addr_len;
 	if ( len != desc.len ) {
-		DBGC ( &fdt, "FDT malformed MAC address \"%s\":\n",
+		DBGC ( fdt, "FDT malformed MAC address \"%s\":\n",
 		       desc.name );
-		DBGC_HDA ( &fdt, 0, desc.data, desc.len );
+		DBGC_HDA ( fdt, 0, desc.data, desc.len );
 		return -ERANGE;
 	}
 
@@ -446,85 +449,86 @@ int fdt_mac ( unsigned int offset, struct net_device *netdev ) {
 }
 
 /**
- * Register device tree
+ * Parse device tree
  *
- * @v fdt		Device tree header
+ * @v fdt		Device tree
+ * @v hdr		Device tree header
  * @ret rc		Return status code
  */
-int register_fdt ( const struct fdt_header *hdr ) {
+int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr ) {
 	const uint8_t *end;
 
 	/* Record device tree location */
-	fdt.hdr = hdr;
-	fdt.len = be32_to_cpu ( hdr->totalsize );
-	DBGC ( &fdt, "FDT version %d at %p+%#04zx\n",
-	       be32_to_cpu ( hdr->version ), fdt.hdr, fdt.len );
+	fdt->hdr = hdr;
+	fdt->len = be32_to_cpu ( hdr->totalsize );
+	DBGC ( fdt, "FDT version %d at %p+%#04zx\n",
+	       be32_to_cpu ( hdr->version ), fdt->hdr, fdt->len );
 
 	/* Check signature */
 	if ( hdr->magic != cpu_to_be32 ( FDT_MAGIC ) ) {
-		DBGC ( &fdt, "FDT has invalid magic value %#08x\n",
+		DBGC ( fdt, "FDT has invalid magic value %#08x\n",
 		       be32_to_cpu ( hdr->magic ) );
 		goto err;
 	}
 
 	/* Check version */
 	if ( hdr->last_comp_version != cpu_to_be32 ( FDT_VERSION ) ) {
-		DBGC ( &fdt, "FDT unsupported version %d\n",
+		DBGC ( fdt, "FDT unsupported version %d\n",
 		       be32_to_cpu ( hdr->last_comp_version ) );
 		goto err;
 	}
 
 	/* Record structure block location */
-	fdt.structure = be32_to_cpu ( hdr->off_dt_struct );
-	fdt.structure_len = be32_to_cpu ( hdr->size_dt_struct );
-	DBGC ( &fdt, "FDT structure block at +[%#04x,%#04zx)\n",
-	       fdt.structure, ( fdt.structure + fdt.structure_len ) );
-	if ( ( fdt.structure > fdt.len ) ||
-	     ( fdt.structure_len > ( fdt.len - fdt.structure ) ) ) {
-		DBGC ( &fdt, "FDT structure block exceeds table\n" );
+	fdt->structure = be32_to_cpu ( hdr->off_dt_struct );
+	fdt->structure_len = be32_to_cpu ( hdr->size_dt_struct );
+	DBGC ( fdt, "FDT structure block at +[%#04x,%#04zx)\n",
+	       fdt->structure, ( fdt->structure + fdt->structure_len ) );
+	if ( ( fdt->structure > fdt->len ) ||
+	     ( fdt->structure_len > ( fdt->len - fdt->structure ) ) ) {
+		DBGC ( fdt, "FDT structure block exceeds table\n" );
 		goto err;
 	}
-	if ( ( fdt.structure | fdt.structure_len ) &
+	if ( ( fdt->structure | fdt->structure_len ) &
 	     ( FDT_STRUCTURE_ALIGN - 1 ) ) {
-		DBGC ( &fdt, "FDT structure block is misaligned\n" );
+		DBGC ( fdt, "FDT structure block is misaligned\n" );
 		goto err;
 	}
 
 	/* Record strings block location */
-	fdt.strings = be32_to_cpu ( hdr->off_dt_strings );
-	fdt.strings_len = be32_to_cpu ( hdr->size_dt_strings );
-	DBGC ( &fdt, "FDT strings block at +[%#04x,%#04zx)\n",
-	       fdt.strings, ( fdt.strings + fdt.strings_len ) );
-	if ( ( fdt.strings > fdt.len ) ||
-	     ( fdt.strings_len > ( fdt.len - fdt.strings ) ) ) {
-		DBGC ( &fdt, "FDT strings block exceeds table\n" );
+	fdt->strings = be32_to_cpu ( hdr->off_dt_strings );
+	fdt->strings_len = be32_to_cpu ( hdr->size_dt_strings );
+	DBGC ( fdt, "FDT strings block at +[%#04x,%#04zx)\n",
+	       fdt->strings, ( fdt->strings + fdt->strings_len ) );
+	if ( ( fdt->strings > fdt->len ) ||
+	     ( fdt->strings_len > ( fdt->len - fdt->strings ) ) ) {
+		DBGC ( fdt, "FDT strings block exceeds table\n" );
 		goto err;
 	}
 
 	/* Shrink strings block to ensure NUL termination safety */
-	end = ( fdt.raw + fdt.strings + fdt.strings_len );
-	for ( ; fdt.strings_len ; fdt.strings_len-- ) {
+	end = ( fdt->raw + fdt->strings + fdt->strings_len );
+	for ( ; fdt->strings_len ; fdt->strings_len-- ) {
 		if ( *(--end) == '\0' )
 			break;
 	}
-	if ( fdt.strings_len != be32_to_cpu ( hdr->size_dt_strings ) ) {
-		DBGC ( &fdt, "FDT strings block shrunk to +[%#04x,%#04zx)\n",
-		       fdt.strings, ( fdt.strings + fdt.strings_len ) );
+	if ( fdt->strings_len != be32_to_cpu ( hdr->size_dt_strings ) ) {
+		DBGC ( fdt, "FDT strings block shrunk to +[%#04x,%#04zx)\n",
+		       fdt->strings, ( fdt->strings + fdt->strings_len ) );
 	}
 
 	/* Print model name (for debugging) */
-	DBGC ( &fdt, "FDT model is \"%s\"\n", fdt_string ( 0, "model" ) );
+	DBGC ( fdt, "FDT model is \"%s\"\n", fdt_string ( fdt, 0, "model" ) );
 
 	return 0;
 
  err:
-	DBGC_HDA ( &fdt, 0, hdr, sizeof ( *hdr ) );
-	fdt.hdr = NULL;
+	DBGC_HDA ( fdt, 0, hdr, sizeof ( *hdr ) );
+	memset ( fdt, 0, sizeof ( *fdt ) );
 	return -EINVAL;
 }
 
-/* Drag in objects via register_fdt */
-REQUIRING_SYMBOL ( register_fdt );
+/* Drag in objects via fdt_traverse() */
+REQUIRING_SYMBOL ( fdt_traverse );
 
 /* Drag in device tree configuration */
 REQUIRE_OBJECT ( config_fdt );
diff --git a/src/drivers/net/smscusb.c b/src/drivers/net/smscusb.c
index c639c58c1..93007e386 100644
--- a/src/drivers/net/smscusb.c
+++ b/src/drivers/net/smscusb.c
@@ -459,13 +459,13 @@ int smscusb_fdt_fetch_mac ( struct smscusb_device *smscusb ) {
 	int rc;
 
 	/* Look for "ethernet[0]" alias */
-	if ( ( rc = fdt_alias ( "ethernet", &offset ) != 0 ) &&
-	     ( rc = fdt_alias ( "ethernet0", &offset ) != 0 ) ) {
+	if ( ( rc = fdt_alias ( &sysfdt, "ethernet", &offset ) != 0 ) &&
+	     ( rc = fdt_alias ( &sysfdt, "ethernet0", &offset ) != 0 ) ) {
 		return rc;
 	}
 
 	/* Fetch MAC address */
-	if ( ( rc = fdt_mac ( offset, netdev ) ) != 0 )
+	if ( ( rc = fdt_mac ( &sysfdt, offset, netdev ) ) != 0 )
 		return rc;
 
 	DBGC ( smscusb, "SMSCUSB %p using FDT MAC %s\n",
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 995975ed8..04201ce9b 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -95,12 +95,18 @@ struct fdt {
 };
 
 extern struct image_tag fdt_image __image_tag;
-
-extern int fdt_path ( const char *path, unsigned int *offset );
-extern int fdt_alias ( const char *name, unsigned int *offset );
-extern const char * fdt_string ( unsigned int offset, const char *name );
-extern int fdt_u64 ( unsigned int offset, const char *name, uint64_t *value );
-extern int fdt_mac ( unsigned int offset, struct net_device *netdev );
-extern int register_fdt ( const struct fdt_header *hdr );
+extern struct fdt sysfdt;
+
+extern int fdt_path ( struct fdt *fdt, const char *path,
+		      unsigned int *offset );
+extern int fdt_alias ( struct fdt *fdt, const char *name,
+		       unsigned int *offset );
+extern const char * fdt_string ( struct fdt *fdt, unsigned int offset,
+				 const char *name );
+extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
+		     uint64_t *value );
+extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
+		     struct net_device *netdev );
+extern int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr );
 
 #endif /* _IPXE_FDT_H */
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index dd9f4cf18..f81e6ad63 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -53,9 +53,9 @@ static void efi_fdt_init ( void ) {
 	}
 	DBGC ( &efi_fdt, "EFIFDT configuration table at %p\n", efi_fdt );
 
-	/* Register device tree */
-	if ( ( rc = register_fdt ( efi_fdt ) ) != 0 ) {
-		DBGC ( &efi_fdt, "EFIFDT could not register: %s\n",
+	/* Parse as system device tree */
+	if ( ( rc = fdt_parse ( &sysfdt, efi_fdt ) ) != 0 ) {
+		DBGC ( &efi_fdt, "EFIFDT could not parse: %s\n",
 		       strerror ( rc ) );
 		return;
 	}
-- 
cgit v1.2.3-55-g7522


From 3860313dd59af568de28f048bccfb644e20ba3b0 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 28 Mar 2025 14:08:18 +0000
Subject: [fdt] Allow for parsing device trees where the length is known in
 advance

Allow for parsing device trees where an external factor (such as a
downloaded image length) determines the maximum length, which must be
validated against the length within the device tree header.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/sbiprefix.S |  1 +
 src/core/fdt.c                    | 18 ++++++++++++++++--
 src/include/ipxe/fdt.h            |  3 ++-
 src/interface/efi/efi_fdt.c       |  2 +-
 4 files changed, 20 insertions(+), 4 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/sbiprefix.S b/src/arch/riscv/prefix/sbiprefix.S
index a39d37cb1..e8ef40b6d 100644
--- a/src/arch/riscv/prefix/sbiprefix.S
+++ b/src/arch/riscv/prefix/sbiprefix.S
@@ -123,6 +123,7 @@ _sbi_start:
 	/* Register device tree */
 	la	a0, sysfdt
 	mv	a1, s1
+	li	a2, -1
 	call	fdt_parse
 
 	/* Call main program */
diff --git a/src/core/fdt.c b/src/core/fdt.c
index e2ce055eb..9c2880c84 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -82,7 +82,7 @@ static int fdt_traverse ( struct fdt *fdt,
 	size_t len;
 
 	/* Sanity checks */
-	assert ( pos->offset < fdt->len );
+	assert ( pos->offset <= fdt->len );
 	assert ( ( pos->offset & ( FDT_STRUCTURE_ALIGN - 1 ) ) == 0 );
 
 	/* Clear descriptor */
@@ -453,14 +453,28 @@ int fdt_mac ( struct fdt *fdt, unsigned int offset,
  *
  * @v fdt		Device tree
  * @v hdr		Device tree header
+ * @v max_len		Maximum device tree length
  * @ret rc		Return status code
  */
-int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr ) {
+int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr,
+		size_t max_len ) {
 	const uint8_t *end;
 
+	/* Sanity check */
+	if ( sizeof ( fdt ) > max_len ) {
+		DBGC ( fdt, "FDT length %#zx too short for header\n",
+		       max_len );
+		goto err;
+	}
+
 	/* Record device tree location */
 	fdt->hdr = hdr;
 	fdt->len = be32_to_cpu ( hdr->totalsize );
+	if ( fdt->len > max_len ) {
+		DBGC ( fdt, "FDT has invalid length %#zx / %#zx\n",
+		       fdt->len, max_len );
+		goto err;
+	}
 	DBGC ( fdt, "FDT version %d at %p+%#04zx\n",
 	       be32_to_cpu ( hdr->version ), fdt->hdr, fdt->len );
 
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 04201ce9b..70dc01790 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -107,6 +107,7 @@ extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint64_t *value );
 extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
-extern int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr );
+extern int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr,
+		       size_t max_len );
 
 #endif /* _IPXE_FDT_H */
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index f81e6ad63..e207f7e6d 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -54,7 +54,7 @@ static void efi_fdt_init ( void ) {
 	DBGC ( &efi_fdt, "EFIFDT configuration table at %p\n", efi_fdt );
 
 	/* Parse as system device tree */
-	if ( ( rc = fdt_parse ( &sysfdt, efi_fdt ) ) != 0 ) {
+	if ( ( rc = fdt_parse ( &sysfdt, efi_fdt, -1UL ) ) != 0 ) {
 		DBGC ( &efi_fdt, "EFIFDT could not parse: %s\n",
 		       strerror ( rc ) );
 		return;
-- 
cgit v1.2.3-55-g7522


From 666929e311190b4df0b70d1d8e46c802cba7af97 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 28 Mar 2025 14:10:55 +0000
Subject: [efi] Create a copy of the system flattened device tree, if present

EFI configuration tables may be freed at any time, and there is no way
to be notified when the table becomes invalidated.  Create a copy of
the system flattened device tree (if present), so that we do not risk
being left with an invalid pointer.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c              |  3 +--
 src/include/ipxe/fdt.h      |  6 +++---
 src/interface/efi/efi_fdt.c | 11 +++++++++++
 3 files changed, 15 insertions(+), 5 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 9c2880c84..4fd2b76bf 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -456,8 +456,7 @@ int fdt_mac ( struct fdt *fdt, unsigned int offset,
  * @v max_len		Maximum device tree length
  * @ret rc		Return status code
  */
-int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr,
-		size_t max_len ) {
+int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 	const uint8_t *end;
 
 	/* Sanity check */
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 70dc01790..2799e0d07 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -78,9 +78,9 @@ struct fdt {
 	/** Tree data */
 	union {
 		/** Tree header */
-		const struct fdt_header *hdr;
+		struct fdt_header *hdr;
 		/** Raw data */
-		const void *raw;
+		void *raw;
 	};
 	/** Length of tree */
 	size_t len;
@@ -107,7 +107,7 @@ extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint64_t *value );
 extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
-extern int fdt_parse ( struct fdt *fdt, const struct fdt_header *hdr,
+extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
 		       size_t max_len );
 
 #endif /* _IPXE_FDT_H */
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index e207f7e6d..71b788ae7 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -44,6 +44,8 @@ EFI_USE_TABLE ( FDT_TABLE, &efi_fdt, 0 );
  *
  */
 static void efi_fdt_init ( void ) {
+	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
+	EFI_STATUS efirc;
 	int rc;
 
 	/* Do nothing if no configuration table is present */
@@ -59,6 +61,15 @@ static void efi_fdt_init ( void ) {
 		       strerror ( rc ) );
 		return;
 	}
+
+	/* Create copy, since table may be removed at any time */
+	if ( ( efirc = bs->AllocatePool ( EfiBootServicesData, sysfdt.len,
+					  &sysfdt.raw ) ) != 0 ) {
+		DBGC ( &efi_fdt, "EFIFDT could not create copy\n" );
+		sysfdt.len = 0;
+		return;
+	}
+	memcpy ( sysfdt.raw, efi_fdt, sysfdt.len );
 }
 
 /** EFI Flattened Device Tree initialisation function */
-- 
cgit v1.2.3-55-g7522


From 761f43ce123115d58a60378b6f8b6eb9e9968f2e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 28 Mar 2025 14:17:29 +0000
Subject: [fdt] Provide the ability to create a device tree for a booted OS

Provide fdt_create() to create a device tree to be passed to a booted
operating system.  The device tree will be created from the FDT image
(if present), falling back to the system device tree (if present).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/fdt.h |  2 ++
 2 files changed, 81 insertions(+)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 4fd2b76bf..59692e135 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -29,6 +29,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <byteswap.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/image.h>
+#include <ipxe/umalloc.h>
 #include <ipxe/fdt.h>
 
 /** @file
@@ -540,6 +541,84 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 	return -EINVAL;
 }
 
+/**
+ * Parse device tree image
+ *
+ * @v fdt		Device tree
+ * @v image		Image
+ * @ret rc		Return status code
+ */
+static int fdt_parse_image ( struct fdt *fdt, struct image *image ) {
+	int rc;
+
+	/* Parse image */
+	if ( ( rc = fdt_parse ( fdt, user_to_virt ( image->data, 0 ),
+				image->len ) ) != 0 ) {
+		DBGC ( fdt, "FDT image \"%s\" is invalid: %s\n",
+		       image->name, strerror ( rc ) );
+		return rc;
+	}
+
+	DBGC ( fdt, "FDT image is \"%s\"\n", image->name );
+	return 0;
+}
+
+/**
+ * Create device tree
+ *
+ * @v hdr		Device tree header to fill in (may be set to NULL)
+ * @ret rc		Return status code
+ */
+int fdt_create ( struct fdt_header **hdr ) {
+	struct image *image;
+	struct fdt fdt;
+	void *copy;
+	int rc;
+
+	/* Use system FDT as the base by default */
+	memcpy ( &fdt, &sysfdt, sizeof ( fdt ) );
+
+	/* If an FDT image exists, use this instead */
+	image = find_image_tag ( &fdt_image );
+	if ( image && ( ( rc = fdt_parse_image ( &fdt, image ) ) != 0 ) )
+		goto err_image;
+
+	/* Exit successfully if we have no base FDT */
+	if ( ! fdt.len ) {
+		DBGC ( &fdt, "FDT has no base tree\n" );
+		goto no_fdt;
+	}
+
+	/* Create modifiable copy */
+	copy = user_to_virt ( umalloc ( fdt.len ), 0 );
+	if ( ! copy ) {
+		rc = -ENOMEM;
+		goto err_alloc;
+	}
+	memcpy ( copy, fdt.raw, fdt.len );
+	fdt.raw = copy;
+
+ no_fdt:
+	*hdr = fdt.raw;
+	return 0;
+
+	ufree ( virt_to_user ( fdt.raw ) );
+ err_alloc:
+ err_image:
+	return rc;
+}
+
+/**
+ * Remove device tree
+ *
+ * @v hdr		Device tree header, or NULL
+ */
+void fdt_remove ( struct fdt_header *hdr ) {
+
+	/* Free modifiable copy */
+	ufree ( virt_to_user ( hdr ) );
+}
+
 /* Drag in objects via fdt_traverse() */
 REQUIRING_SYMBOL ( fdt_traverse );
 
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 2799e0d07..46025f02e 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -109,5 +109,7 @@ extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
 extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
 		       size_t max_len );
+extern int fdt_create ( struct fdt_header **hdr );
+extern void fdt_remove ( struct fdt_header *hdr );
 
 #endif /* _IPXE_FDT_H */
-- 
cgit v1.2.3-55-g7522


From 5818529f39fc245744d966d8ad49cf194ee3109d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 31 Mar 2025 13:33:44 +0100
Subject: [iobuf] Limit automatic I/O buffer alignment to page size

Without any explicit alignment requirement, we will currently allocate
I/O buffers on their own size rounded up to the nearest power of two.
This is done to simplify driver transmit code paths, which can assume
that a standard Ethernet frame lies within a single physical page and
therefore does not need to be split even for devices with DMA engines
that cannot cross page boundaries.

Limit this automatic alignment to a maximum of the page size, to avoid
requiring excessive alignment for unusually large buffers (such as a
buffer allocated for an HTTP POST with a large parameter list).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/iobuf.c | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'src/core')

diff --git a/src/core/iobuf.c b/src/core/iobuf.c
index c9970bc76..9f8a263d2 100644
--- a/src/core/iobuf.c
+++ b/src/core/iobuf.c
@@ -124,18 +124,24 @@ struct io_buffer * alloc_iob_raw ( size_t len, size_t align, size_t offset ) {
  * @ret iobuf	I/O buffer, or NULL if none available
  *
  * The I/O buffer will be physically aligned on its own size (rounded
- * up to the nearest power of two).
+ * up to the nearest power of two), up to a maximum of page-size
+ * alignment.
  */
 struct io_buffer * alloc_iob ( size_t len ) {
+	size_t align;
 
 	/* Pad to minimum length */
 	if ( len < IOB_ZLEN )
 		len = IOB_ZLEN;
 
-	/* Align buffer on its own size to avoid potential problems
-	 * with boundary-crossing DMA.
+	/* Align buffer on its own size (up to page size) to avoid
+	 * potential problems with boundary-crossing DMA.
 	 */
-	return alloc_iob_raw ( len, len, 0 );
+	align = len;
+	if ( align > PAGE_SIZE )
+		align = PAGE_SIZE;
+
+	return alloc_iob_raw ( len, align, 0 );
 }
 
 /**
-- 
cgit v1.2.3-55-g7522


From d8534488878b88bd466798929820eaac461c865b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 1 Apr 2025 13:04:10 +0100
Subject: [fdt] Identify free space (if any) at end of parsed tree

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 31 +++++++++++++++++++++++++++----
 src/include/ipxe/fdt.h |  4 ++++
 2 files changed, 31 insertions(+), 4 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 59692e135..1664ec7b2 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -458,10 +458,11 @@ int fdt_mac ( struct fdt *fdt, unsigned int offset,
  * @ret rc		Return status code
  */
 int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
-	const uint8_t *end;
+	const uint8_t *nul;
+	size_t end;
 
 	/* Sanity check */
-	if ( sizeof ( fdt ) > max_len ) {
+	if ( sizeof ( *hdr ) > max_len ) {
 		DBGC ( fdt, "FDT length %#zx too short for header\n",
 		       max_len );
 		goto err;
@@ -470,6 +471,7 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 	/* Record device tree location */
 	fdt->hdr = hdr;
 	fdt->len = be32_to_cpu ( hdr->totalsize );
+	fdt->used = sizeof ( *hdr );
 	if ( fdt->len > max_len ) {
 		DBGC ( fdt, "FDT has invalid length %#zx / %#zx\n",
 		       fdt->len, max_len );
@@ -507,6 +509,9 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 		DBGC ( fdt, "FDT structure block is misaligned\n" );
 		goto err;
 	}
+	end = ( fdt->structure + fdt->structure_len );
+	if ( fdt->used < end )
+		fdt->used = end;
 
 	/* Record strings block location */
 	fdt->strings = be32_to_cpu ( hdr->off_dt_strings );
@@ -518,11 +523,14 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 		DBGC ( fdt, "FDT strings block exceeds table\n" );
 		goto err;
 	}
+	end = ( fdt->strings + fdt->strings_len );
+	if ( fdt->used < end )
+		fdt->used = end;
 
 	/* Shrink strings block to ensure NUL termination safety */
-	end = ( fdt->raw + fdt->strings + fdt->strings_len );
+	nul = ( fdt->raw + fdt->strings + fdt->strings_len );
 	for ( ; fdt->strings_len ; fdt->strings_len-- ) {
-		if ( *(--end) == '\0' )
+		if ( *(--nul) == '\0' )
 			break;
 	}
 	if ( fdt->strings_len != be32_to_cpu ( hdr->size_dt_strings ) ) {
@@ -530,6 +538,21 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 		       fdt->strings, ( fdt->strings + fdt->strings_len ) );
 	}
 
+	/* Record memory reservation block location */
+	fdt->reservations = be32_to_cpu ( hdr->off_mem_rsvmap );
+	DBGC ( fdt, "FDT memory reservations at +[%#04x,...)\n",
+	       fdt->reservations );
+	if ( fdt->used <= fdt->reservations ) {
+		/* No size field exists: assume whole table is used */
+		fdt->used = fdt->len;
+	}
+
+	/* Identify free space (if any) */
+	if ( fdt->used < fdt->len ) {
+		DBGC ( fdt, "FDT free space at +[%#04zx,%#04zx)\n",
+		       fdt->used, fdt->len );
+	}
+
 	/* Print model name (for debugging) */
 	DBGC ( fdt, "FDT model is \"%s\"\n", fdt_string ( fdt, 0, "model" ) );
 
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 46025f02e..0c2137f2b 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -84,6 +84,8 @@ struct fdt {
 	};
 	/** Length of tree */
 	size_t len;
+	/** Used length of tree */
+	size_t used;
 	/** Offset to structure block */
 	unsigned int structure;
 	/** Length of structure block */
@@ -92,6 +94,8 @@ struct fdt {
 	unsigned int strings;
 	/** Length of strings block */
 	size_t strings_len;
+	/** Offset to memory reservation block */
+	unsigned int reservations;
 };
 
 extern struct image_tag fdt_image __image_tag;
-- 
cgit v1.2.3-55-g7522


From 7e64e9b6703e6dd363c063d545a5fe63bbc70011 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 1 Apr 2025 16:53:02 +0100
Subject: [fdt] Populate boot arguments in constructed device tree

When creating a device tree to pass to a booted operating system,
ensure that the "chosen" node exists, and populate the "bootargs"
property with the image command line.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c                 | 423 ++++++++++++++++++++++++++++++++++++++++-
 src/image/efi_image.c          |   5 +-
 src/include/ipxe/efi/efi_fdt.h |   2 +-
 src/include/ipxe/fdt.h         |  12 +-
 src/interface/efi/efi_fdt.c    |   5 +-
 5 files changed, 433 insertions(+), 14 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 1664ec7b2..298cc439a 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -46,6 +46,9 @@ struct image_tag fdt_image __image_tag = {
 	.name = "FDT",
 };
 
+/** Amount of free space to add whenever we have to reallocate a tree */
+#define FDT_INSERT_PAD 1024
+
 /** A position within a device tree */
 struct fdt_cursor {
 	/** Offset within structure block */
@@ -56,6 +59,8 @@ struct fdt_cursor {
 
 /** A lexical descriptor */
 struct fdt_descriptor {
+	/** Offset within structure block */
+	unsigned int offset;
 	/** Node or property name (if applicable) */
 	const char *name;
 	/** Property data (if applicable) */
@@ -86,8 +91,9 @@ static int fdt_traverse ( struct fdt *fdt,
 	assert ( pos->offset <= fdt->len );
 	assert ( ( pos->offset & ( FDT_STRUCTURE_ALIGN - 1 ) ) == 0 );
 
-	/* Clear descriptor */
+	/* Initialise descriptor */
 	memset ( desc, 0, sizeof ( *desc ) );
+	desc->offset = pos->offset;
 
 	/* Locate token and calculate remaining space */
 	token = ( fdt->raw + fdt->structure + pos->offset );
@@ -212,8 +218,8 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 
 		/* Traverse tree */
 		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 ) {
-			DBGC ( fdt, "FDT +%#04x has no child node \"%s\": "
-			       "%s\n", orig_offset, name, strerror ( rc ) );
+			DBGC2 ( fdt, "FDT +%#04x has no child node \"%s\": "
+				"%s\n", orig_offset, name, strerror ( rc ) );
 			return rc;
 		}
 
@@ -231,6 +237,50 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 	}
 }
 
+/**
+ * Find end of node
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v end		End of node offset to fill in
+ * @ret rc		Return status code
+ */
+static int fdt_end ( struct fdt *fdt, unsigned int offset,
+		     unsigned int *end ) {
+	struct fdt_cursor pos;
+	struct fdt_descriptor desc;
+	unsigned int orig_offset;
+	int rc;
+
+	/* Record original offset (for debugging) */
+	orig_offset = offset;
+
+	/* Initialise cursor */
+	pos.offset = offset;
+	pos.depth = 0;
+
+	/* Find child node */
+	while ( 1 ) {
+
+		/* Record current offset */
+		*end = pos.offset;
+
+		/* Traverse tree */
+		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       orig_offset, strerror ( rc ) );
+			return rc;
+		}
+
+		/* Check for end of current node */
+		if ( pos.depth == 0 ) {
+			DBGC2 ( fdt, "FDT +%#04x has end at +%#04x\n",
+				orig_offset, *end );
+			return 0;
+		}
+	}
+}
+
 /**
  * Find node by path
  *
@@ -326,8 +376,8 @@ static int fdt_property ( struct fdt *fdt, unsigned int offset,
 
 		/* Traverse tree */
 		if ( ( rc = fdt_traverse ( fdt, &pos, desc ) ) != 0 ) {
-			DBGC ( fdt, "FDT +%#04x has no property \"%s\": %s\n",
-			       offset, name, strerror ( rc ) );
+			DBGC2 ( fdt, "FDT +%#04x has no property \"%s\": %s\n",
+				offset, name, strerror ( rc ) );
 			return rc;
 		}
 
@@ -459,6 +509,7 @@ int fdt_mac ( struct fdt *fdt, unsigned int offset,
  */
 int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 	const uint8_t *nul;
+	unsigned int chosen;
 	size_t end;
 
 	/* Sanity check */
@@ -553,8 +604,15 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 		       fdt->used, fdt->len );
 	}
 
-	/* Print model name (for debugging) */
-	DBGC ( fdt, "FDT model is \"%s\"\n", fdt_string ( fdt, 0, "model" ) );
+	/* Print model name and boot arguments (for debugging) */
+	if ( DBG_LOG ) {
+		DBGC ( fdt, "FDT model is \"%s\"\n",
+		       fdt_string ( fdt, 0, "model" ) );
+		if ( fdt_child ( fdt, 0, "chosen", &chosen ) == 0 ) {
+			DBGC ( fdt, "FDT boot arguments \"%s\"\n",
+			       fdt_string ( fdt, chosen, "bootargs" ) );
+		}
+	}
 
 	return 0;
 
@@ -586,13 +644,356 @@ static int fdt_parse_image ( struct fdt *fdt, struct image *image ) {
 	return 0;
 }
 
+/**
+ * Insert empty space
+ *
+ * @v fdt		Device tree
+ * @v offset		Offset at which to insert space
+ * @v len		Length to insert (must be a multiple of FDT_MAX_ALIGN)
+ * @ret rc		Return status code
+ */
+static int fdt_insert ( struct fdt *fdt, unsigned int offset, size_t len ) {
+	size_t free;
+	size_t new;
+	int rc;
+
+	/* Sanity checks */
+	assert ( offset <= fdt->used );
+	assert ( fdt->used <= fdt->len );
+	assert ( ( len % FDT_MAX_ALIGN ) == 0 );
+
+	/* Reallocate tree if necessary */
+	free = ( fdt->len - fdt->used );
+	if ( free < len ) {
+		if ( ! fdt->realloc ) {
+			DBGC ( fdt, "FDT is not reallocatable\n" );
+			return -ENOTSUP;
+		}
+		new = ( fdt->len + ( len - free ) + FDT_INSERT_PAD );
+		if ( ( rc = fdt->realloc ( fdt, new ) ) != 0 )
+			return rc;
+	}
+	assert ( ( fdt->used + len ) <= fdt->len );
+
+	/* Insert empty space */
+	memmove ( ( fdt->raw + offset + len ), ( fdt->raw + offset ),
+		  ( fdt->used - offset ) );
+	memset ( ( fdt->raw + offset ), 0, len );
+	fdt->used += len;
+
+	/* Update offsets
+	 *
+	 * We assume that we never need to legitimately insert data at
+	 * the start of a block, and therefore can unambiguously
+	 * determine which block offsets need to be updated.
+	 *
+	 * It is the caller's responsibility to update the length (and
+	 * contents) of the block into which it has inserted space.
+	 */
+	if ( fdt->structure >= offset ) {
+		fdt->structure += len;
+		fdt->hdr->off_dt_struct = cpu_to_be32 ( fdt->structure );
+		DBGC ( fdt, "FDT structure block now at +[%#04x,%#04zx)\n",
+		       fdt->structure,
+		       ( fdt->structure + fdt->structure_len ) );
+	}
+	if ( fdt->strings >= offset ) {
+		fdt->strings += len;
+		fdt->hdr->off_dt_strings = cpu_to_be32 ( fdt->strings );
+		DBGC ( fdt, "FDT strings block now at +[%#04x,%#04zx)\n",
+		       fdt->strings, ( fdt->strings + fdt->strings_len ) );
+	}
+	if ( fdt->reservations >= offset ) {
+		fdt->reservations += len;
+		fdt->hdr->off_mem_rsvmap = cpu_to_be32 ( fdt->reservations );
+		DBGC ( fdt, "FDT memory reservations now at +[%#04x,...)\n",
+		       fdt->reservations );
+	}
+
+	return 0;
+}
+
+/**
+ * Fill space in structure block with FDT_NOP
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting offset
+ * @v len		Length (must be a multiple of FDT_STRUCTURE_ALIGN)
+ */
+static void fdt_nop ( struct fdt *fdt, unsigned int offset, size_t len ) {
+	fdt_token_t *token;
+	unsigned int count;
+
+	/* Sanity check */
+	assert ( ( len % FDT_STRUCTURE_ALIGN ) == 0 );
+
+	/* Fill with FDT_NOP */
+	token = ( fdt->raw + fdt->structure + offset );
+	count = ( len / sizeof ( *token ) );
+	while ( count-- )
+		*(token++) = cpu_to_be32 ( FDT_NOP );
+}
+
+/**
+ * Insert FDT_NOP padded space in structure block
+ *
+ * @v fdt		Device tree
+ * @v offset		Offset at which to insert space
+ * @v len		Minimal length to insert
+ * @ret rc		Return status code
+ */
+static int fdt_insert_nop ( struct fdt *fdt, unsigned int offset,
+			    size_t len ) {
+	int rc;
+
+	/* Sanity check */
+	assert ( ( offset % FDT_STRUCTURE_ALIGN ) == 0 );
+
+	/* Round up inserted length to maximal alignment */
+	len = ( ( len + FDT_MAX_ALIGN - 1 ) & ~( FDT_MAX_ALIGN - 1 ) );
+
+	/* Insert empty space in structure block */
+	if ( ( rc = fdt_insert ( fdt, ( fdt->structure + offset ),
+				 len ) ) != 0 )
+		return rc;
+
+	/* Fill with NOPs */
+	fdt_nop ( fdt, offset, len );
+
+	/* Update structure block size */
+	fdt->structure_len += len;
+	fdt->hdr->size_dt_struct = cpu_to_be32 ( fdt->structure_len );
+	DBGC ( fdt, "FDT structure block now at +[%#04x,%#04zx)\n",
+	       fdt->structure, ( fdt->structure + fdt->structure_len ) );
+
+	return 0;
+}
+
+/**
+ * Insert string in strings block
+ *
+ * @v fdt		Device tree
+ * @v string		String
+ * @v offset		String offset to fill in
+ * @ret rc		Return status code
+ */
+static int fdt_insert_string ( struct fdt *fdt, const char *string,
+			       unsigned int *offset ) {
+	size_t len = ( strlen ( string ) + 1 /* NUL */ );
+	int rc;
+
+	/* Round up inserted length to maximal alignment */
+	len = ( ( len + FDT_MAX_ALIGN - 1 ) & ~( FDT_MAX_ALIGN - 1 ) );
+
+	/* Insert space at end of strings block */
+	if ( ( rc = fdt_insert ( fdt, ( fdt->strings + fdt->strings_len ),
+				 len ) ) != 0 )
+		return rc;
+
+	/* Append string to strings block */
+	*offset = fdt->strings_len;
+	strcpy ( ( fdt->raw + fdt->strings + *offset ), string );
+
+	/* Update strings block size */
+	fdt->strings_len += len;
+	fdt->hdr->size_dt_strings = cpu_to_be32 ( fdt->strings_len );
+	DBGC ( fdt, "FDT strings block now at +[%#04x,%#04zx)\n",
+		       fdt->strings, ( fdt->strings + fdt->strings_len ) );
+
+	return 0;
+}
+
+/**
+ * Ensure child node exists
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v name		New node name
+ * @v child		Child node offset to fill in
+ * @ret rc		Return status code
+ */
+static int fdt_ensure_child ( struct fdt *fdt, unsigned int offset,
+			      const char *name, unsigned int *child ) {
+	size_t name_len = ( strlen ( name ) + 1 /* NUL */ );
+	fdt_token_t *token;
+	size_t len;
+	int rc;
+
+	/* Find existing child node, if any */
+	if ( ( rc = fdt_child ( fdt, offset, name, child ) ) == 0 )
+		return 0;
+
+	/* Find end of parent node */
+	if ( ( rc = fdt_end ( fdt, offset, child ) ) != 0 )
+		return rc;
+
+	/* Insert space for child node (with maximal alignment) */
+	len = ( sizeof ( fdt_token_t ) /* BEGIN_NODE */ + name_len +
+		sizeof ( fdt_token_t ) /* END_NODE */ );
+	if ( ( rc = fdt_insert_nop ( fdt, *child, len ) ) != 0 )
+		return rc;
+
+	/* Construct node */
+	token = ( fdt->raw + fdt->structure + *child );
+	*(token++) = cpu_to_be32 ( FDT_BEGIN_NODE );
+	memcpy ( token, name, name_len );
+	name_len = ( ( name_len + FDT_STRUCTURE_ALIGN - 1 ) &
+		     ~( FDT_STRUCTURE_ALIGN - 1 ) );
+	token = ( ( ( void * ) token ) + name_len );
+	*(token++) = cpu_to_be32 ( FDT_END_NODE );
+	DBGC2 ( fdt, "FDT +%#04x created child \"%s\" at +%#04x\n",
+		offset, name, *child );
+
+	return 0;
+}
+
+/**
+ * Ensure property exists with specified value
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v name		Property name
+ * @v data		Property data
+ * @v len		Length of property data
+ * @ret rc		Return status code
+ */
+static int fdt_ensure_property ( struct fdt *fdt, unsigned int offset,
+				 const char *name, const void *data,
+				 size_t len ) {
+	struct fdt_descriptor desc;
+	struct fdt_cursor pos;
+	struct {
+		fdt_token_t token;
+		struct fdt_prop prop;
+		uint8_t data[0];
+	} __attribute__ (( packed )) *hdr;
+	unsigned int string;
+	size_t erase;
+	size_t insert;
+	int rc;
+
+	/* Find and reuse existing property, if any */
+	if ( ( rc = fdt_property ( fdt, offset, name, &desc ) ) == 0 ) {
+
+		/* Reuse existing name */
+		pos.offset = desc.offset;
+		hdr = ( fdt->raw + fdt->structure + pos.offset );
+		string = be32_to_cpu ( hdr->prop.name_off );
+
+		/* Erase existing property */
+		erase = ( sizeof ( *hdr ) + desc.len );
+		erase = ( ( erase + FDT_STRUCTURE_ALIGN - 1 ) &
+			  ~( FDT_STRUCTURE_ALIGN - 1 ) );
+		fdt_nop ( fdt, pos.offset, erase );
+		DBGC2 ( fdt, "FDT +%#04x erased property \"%s\"\n",
+			offset, name );
+
+		/* Calculate insertion position and length */
+		insert = ( ( desc.len < len ) ? ( len - desc.len ) : 0 );
+
+	} else {
+
+		/* Create name */
+		if ( ( rc = fdt_insert_string ( fdt, name, &string ) ) != 0 )
+			return rc;
+
+		/* Enter node */
+		pos.offset = offset;
+		pos.depth = 0;
+		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 )
+			return rc;
+		assert ( pos.depth == 1 );
+
+		/* Calculate insertion length */
+		insert = ( sizeof ( *hdr ) + len );
+	}
+
+	/* Insert space */
+	if ( ( rc = fdt_insert_nop ( fdt, pos.offset, insert ) ) != 0 )
+		return rc;
+
+	/* Construct property */
+	hdr = ( fdt->raw + fdt->structure + pos.offset );
+	hdr->token = cpu_to_be32 ( FDT_PROP );
+	hdr->prop.len = cpu_to_be32 ( len );
+	hdr->prop.name_off = cpu_to_be32 ( string );
+	memset ( hdr->data, 0, ( ( len + FDT_STRUCTURE_ALIGN - 1 ) &
+				 ~( FDT_STRUCTURE_ALIGN - 1 ) ) );
+	memcpy ( hdr->data, data, len );
+	DBGC2 ( fdt, "FDT +%#04x created property \"%s\"\n", offset, name );
+	DBGC2_HDA ( fdt, 0, hdr->data, len );
+
+	return 0;
+}
+
+/**
+ * Reallocate device tree via urealloc()
+ *
+ * @v fdt		Device tree
+ * @v len		New total length
+ * @ret rc		Return status code
+ */
+static int fdt_urealloc ( struct fdt *fdt, size_t len ) {
+	void *new;
+
+	/* Sanity check */
+	assert ( len >= fdt->used );
+
+	/* Attempt reallocation */
+	new = user_to_virt ( urealloc ( virt_to_user ( fdt->raw ), len ), 0 );
+	if ( ! new ) {
+		DBGC ( fdt, "FDT could not reallocate from +%#04zx to "
+		       "+%#04zx\n", fdt->len, len );
+		return -ENOMEM;
+	}
+	DBGC ( fdt, "FDT reallocated from +%#04zx to +%#04zx\n",
+	       fdt->len, len );
+
+	/* Update device tree */
+	fdt->raw = new;
+	fdt->len = len;
+	fdt->hdr->totalsize = cpu_to_be32 ( len );
+
+	return 0;
+}
+
+/**
+ * Populate device tree with boot arguments
+ *
+ * @v fdt		Device tree
+ * @v cmdline		Command line, or NULL
+ * @ret rc		Return status code
+ */
+static int fdt_bootargs ( struct fdt *fdt, const char *cmdline ) {
+	unsigned int chosen;
+	size_t len;
+	int rc;
+
+	/* Ensure "chosen" node exists */
+	if ( ( rc = fdt_ensure_child ( fdt, 0, "chosen", &chosen ) ) != 0 )
+		return rc;
+
+	/* Use empty command line if none specified */
+	if ( ! cmdline )
+		cmdline = "";
+
+	/* Ensure "bootargs" property exists */
+	len = ( strlen ( cmdline ) + 1 /* NUL */ );
+	if ( ( rc = fdt_ensure_property ( fdt, chosen, "bootargs", cmdline,
+					  len ) ) != 0 )
+		return rc;
+
+	return 0;
+}
+
 /**
  * Create device tree
  *
  * @v hdr		Device tree header to fill in (may be set to NULL)
+ * @v cmdline		Command line, or NULL
  * @ret rc		Return status code
  */
-int fdt_create ( struct fdt_header **hdr ) {
+int fdt_create ( struct fdt_header **hdr, const char *cmdline ) {
 	struct image *image;
 	struct fdt fdt;
 	void *copy;
@@ -620,11 +1021,17 @@ int fdt_create ( struct fdt_header **hdr ) {
 	}
 	memcpy ( copy, fdt.raw, fdt.len );
 	fdt.raw = copy;
+	fdt.realloc = fdt_urealloc;
+
+	/* Populate boot arguments */
+	if ( ( rc = fdt_bootargs ( &fdt, cmdline ) ) != 0 )
+		goto err_bootargs;
 
  no_fdt:
 	*hdr = fdt.raw;
 	return 0;
 
+ err_bootargs:
 	ufree ( virt_to_user ( fdt.raw ) );
  err_alloc:
  err_image:
diff --git a/src/image/efi_image.c b/src/image/efi_image.c
index 273f8e8fd..c87196487 100644
--- a/src/image/efi_image.c
+++ b/src/image/efi_image.c
@@ -126,9 +126,10 @@ static wchar_t * efi_image_cmdline ( struct image *image ) {
 /**
  * Install EFI Flattened Device Tree table (when no FDT support is present)
  *
+ * @v cmdline		Command line, or NULL
  * @ret rc		Return status code
  */
-__weak int efi_fdt_install ( void ) {
+__weak int efi_fdt_install ( const char *cmdline __unused ) {
 	return 0;
 }
 
@@ -209,7 +210,7 @@ static int efi_image_exec ( struct image *image ) {
 	}
 
 	/* Install Flattened Device Tree table */
-	if ( ( rc = efi_fdt_install() ) != 0 ) {
+	if ( ( rc = efi_fdt_install ( image->cmdline ) ) != 0 ) {
 		DBGC ( image, "EFIIMAGE %s could not install FDT: %s\n",
 		       image->name, strerror ( rc ) );
 		goto err_fdt_install;
diff --git a/src/include/ipxe/efi/efi_fdt.h b/src/include/ipxe/efi/efi_fdt.h
index a9b7eac8b..d18676d7e 100644
--- a/src/include/ipxe/efi/efi_fdt.h
+++ b/src/include/ipxe/efi/efi_fdt.h
@@ -11,7 +11,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <ipxe/efi/efi.h>
 
-extern int efi_fdt_install ( void );
+extern int efi_fdt_install ( const char *cmdline );
 extern int efi_fdt_uninstall ( void );
 
 #endif /* _IPXE_EFI_FDT_H */
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 0c2137f2b..7eec5cd88 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -73,6 +73,9 @@ struct fdt_prop {
 /** Alignment of structure block */
 #define FDT_STRUCTURE_ALIGN ( sizeof ( fdt_token_t ) )
 
+/** Maximum alignment of any block */
+#define FDT_MAX_ALIGN 8
+
 /** A device tree */
 struct fdt {
 	/** Tree data */
@@ -96,6 +99,13 @@ struct fdt {
 	size_t strings_len;
 	/** Offset to memory reservation block */
 	unsigned int reservations;
+	/** Reallocate device tree
+	 *
+	 * @v fdt		Device tree
+	 * @v len		New length
+	 * @ret rc		Return status code
+	 */
+	int ( * realloc ) ( struct fdt *fdt, size_t len );
 };
 
 extern struct image_tag fdt_image __image_tag;
@@ -113,7 +123,7 @@ extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
 extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
 		       size_t max_len );
-extern int fdt_create ( struct fdt_header **hdr );
+extern int fdt_create ( struct fdt_header **hdr, const char *cmdline );
 extern void fdt_remove ( struct fdt_header *hdr );
 
 #endif /* _IPXE_FDT_H */
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index 4a10236a0..1e0d4b8b7 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -107,13 +107,14 @@ static struct fdt_header *efi_fdt_installed;
 /**
  * Install EFI Flattened Device Tree table
  *
+ * @v cmdline		Command line, or NULL
  * @ret rc		Return status code
  */
-int efi_fdt_install ( void ) {
+int efi_fdt_install ( const char *cmdline ) {
 	int rc;
 
 	/* Create device tree */
-	if ( ( rc = fdt_create ( &efi_fdt_installed ) ) != 0 ) {
+	if ( ( rc = fdt_create ( &efi_fdt_installed, cmdline ) ) != 0 ) {
 		DBGC ( &efi_fdt, "EFI_FDT could not install: %s\n",
 		       strerror ( rc ) );
 		goto err_create;
-- 
cgit v1.2.3-55-g7522


From 69af6f0c30b8a5049fea47ce44d4cbbca1bfac65 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 14 Apr 2025 11:26:49 +0100
Subject: [fdt] Allow for trailing slashes in path lookups

Using fdt_path() to find the root node "/" currently fails, since it
will attempt to find a child node with the empty name "" within the
root node.

Fix by changing fdt_path() to ignore any trailing slashes in a device
tree path.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 298cc439a..199a53497 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -298,12 +298,16 @@ int fdt_path ( struct fdt *fdt, const char *path, unsigned int *offset ) {
 	*offset = 0;
 
 	/* Traverse tree one path segment at a time */
-	while ( *tmp ) {
+	while ( 1 ) {
 
 		/* Skip any leading '/' */
 		while ( *tmp == '/' )
 			tmp++;
 
+		/* Terminate if there are no more path components */
+		if ( ! *tmp )
+			break;
+
 		/* Find next '/' delimiter and convert to NUL */
 		del = strchr ( tmp, '/' );
 		if ( del )
@@ -316,9 +320,12 @@ int fdt_path ( struct fdt *fdt, const char *path, unsigned int *offset ) {
 		if ( rc != 0 )
 			return rc;
 
-		/* Move to next path component, if any */
-		while ( *tmp && ( *tmp != '/' ) )
-			tmp++;
+		/* Terminate if there are no more delimiters */
+		if ( ! del )
+			break;
+
+		/* Move to next path component */
+		tmp = del;
 	}
 
 	DBGC2 ( fdt, "FDT found path \"%s\" at +%#04x\n", path, *offset );
-- 
cgit v1.2.3-55-g7522


From c887de208fd18efd65e19d325e24e3365fce0570 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 14 Apr 2025 11:32:17 +0100
Subject: [fdt] Provide fdt_strings() to read string list properties

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 39 ++++++++++++++++++++++++++++++++++-----
 src/include/ipxe/fdt.h |  2 ++
 2 files changed, 36 insertions(+), 5 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 199a53497..2ca41bc08 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -403,30 +403,59 @@ static int fdt_property ( struct fdt *fdt, unsigned int offset,
 }
 
 /**
- * Find string property
+ * Find strings property
  *
  * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
+ * @v count		String count to fill in
  * @ret string		String property, or NULL on error
  */
-const char * fdt_string ( struct fdt *fdt, unsigned int offset,
-			  const char *name ) {
+const char * fdt_strings ( struct fdt *fdt, unsigned int offset,
+			   const char *name, unsigned int *count ) {
 	struct fdt_descriptor desc;
+	const char *data;
+	size_t len;
 	int rc;
 
+	/* Return a zero count on error */
+	*count = 0;
+
 	/* Find property */
 	if ( ( rc = fdt_property ( fdt, offset, name, &desc ) ) != 0 )
 		return NULL;
 
 	/* Check NUL termination */
-	if ( strnlen ( desc.data, desc.len ) == desc.len ) {
+	data = desc.data;
+	if ( desc.len && ( data[ desc.len - 1 ] != '\0' ) ) {
 		DBGC ( fdt, "FDT unterminated string property \"%s\"\n",
 		       name );
 		return NULL;
 	}
 
-	return desc.data;
+	/* Count number of strings */
+	for ( len = desc.len ; len-- ; ) {
+		if ( data[len] == '\0' )
+			(*count)++;
+	}
+
+	return data;
+}
+
+/**
+ * Find string property
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v name		Property name
+ * @ret string		String property, or NULL on error
+ */
+const char * fdt_string ( struct fdt *fdt, unsigned int offset,
+			  const char *name ) {
+	unsigned int count;
+
+	/* Find strings property */
+	return fdt_strings ( fdt, offset, name, &count );
 }
 
 /**
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 7eec5cd88..1e05c9e2d 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -115,6 +115,8 @@ extern int fdt_path ( struct fdt *fdt, const char *path,
 		      unsigned int *offset );
 extern int fdt_alias ( struct fdt *fdt, const char *name,
 		       unsigned int *offset );
+extern const char * fdt_strings ( struct fdt *fdt, unsigned int offset,
+				  const char *name, unsigned int *count );
 extern const char * fdt_string ( struct fdt *fdt, unsigned int offset,
 				 const char *name );
 extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
-- 
cgit v1.2.3-55-g7522


From db4934617764325aa44e0dfdd01c54e3ad798076 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 14 Apr 2025 13:41:55 +0100
Subject: [fdt] Avoid temporarily modifying path during path lookup

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c | 33 +++++++++++++++------------------
 1 file changed, 15 insertions(+), 18 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 2ca41bc08..714dba13b 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -201,6 +201,8 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 	struct fdt_cursor pos;
 	struct fdt_descriptor desc;
 	unsigned int orig_offset;
+	const char *sep;
+	size_t name_len;
 	int rc;
 
 	/* Record original offset (for debugging) */
@@ -210,6 +212,10 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 	pos.offset = offset;
 	pos.depth = -1;
 
+	/* Determine length of name (may be terminated with NUL or '/') */
+	sep = strchr ( name, '/' );
+	name_len = ( sep ? ( ( size_t ) ( sep - name ) ) : strlen ( name ) );
+
 	/* Find child node */
 	while ( 1 ) {
 
@@ -227,7 +233,9 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 		if ( ( pos.depth == 1 ) && desc.name && ( ! desc.data ) ) {
 			DBGC2 ( fdt, "FDT +%#04x has child node \"%s\"\n",
 				orig_offset, desc.name );
-			if ( strcmp ( name, desc.name ) == 0 ) {
+			if ( ( strlen ( desc.name ) == name_len ) &&
+			     ( memcmp ( name, desc.name, name_len ) == 0 ) ) {
+				*child = desc.offset;
 				DBGC2 ( fdt, "FDT +%#04x found child node "
 					"\"%s\" at +%#04x\n", orig_offset,
 					desc.name, *child );
@@ -290,8 +298,7 @@ static int fdt_end ( struct fdt *fdt, unsigned int offset,
  * @ret rc		Return status code
  */
 int fdt_path ( struct fdt *fdt, const char *path, unsigned int *offset ) {
-	char *tmp = ( ( char * ) path );
-	char *del;
+	const char *tmp = path;
 	int rc;
 
 	/* Initialise offset */
@@ -308,24 +315,14 @@ int fdt_path ( struct fdt *fdt, const char *path, unsigned int *offset ) {
 		if ( ! *tmp )
 			break;
 
-		/* Find next '/' delimiter and convert to NUL */
-		del = strchr ( tmp, '/' );
-		if ( del )
-			*del = '\0';
-
-		/* Find child and restore delimiter */
-		rc = fdt_child ( fdt, *offset, tmp, offset );
-		if ( del )
-			*del = '/';
-		if ( rc != 0 )
+		/* Find child */
+		if ( ( rc = fdt_child ( fdt, *offset, tmp, offset ) ) != 0 )
 			return rc;
 
-		/* Terminate if there are no more delimiters */
-		if ( ! del )
+		/* Move to next path component, if any */
+		tmp = strchr ( tmp, '/' );
+		if ( ! tmp )
 			break;
-
-		/* Move to next path component */
-		tmp = del;
 	}
 
 	DBGC2 ( fdt, "FDT found path \"%s\" at +%#04x\n", path, *offset );
-- 
cgit v1.2.3-55-g7522


From d462aeb0ca9c7fb5fb61631121404661bf5e7809 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 14 Apr 2025 11:33:27 +0100
Subject: [fdt] Remove concept of a device tree cursor

Refactor device tree traversal to operate on the basis of describing
the token at a given offset, with no separate notion of a device tree
cursor.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 257 +++++++++++++++++++++++++------------------------
 src/include/ipxe/fdt.h |  18 ++++
 src/tests/fdt_test.c   |  14 +++
 3 files changed, 165 insertions(+), 124 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 714dba13b..85394a8e0 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -49,37 +49,16 @@ struct image_tag fdt_image __image_tag = {
 /** Amount of free space to add whenever we have to reallocate a tree */
 #define FDT_INSERT_PAD 1024
 
-/** A position within a device tree */
-struct fdt_cursor {
-	/** Offset within structure block */
-	unsigned int offset;
-	/** Tree depth */
-	int depth;
-};
-
-/** A lexical descriptor */
-struct fdt_descriptor {
-	/** Offset within structure block */
-	unsigned int offset;
-	/** Node or property name (if applicable) */
-	const char *name;
-	/** Property data (if applicable) */
-	const void *data;
-	/** Length of property data (if applicable) */
-	size_t len;
-};
-
 /**
- * Traverse device tree
+ * Describe device tree token
  *
  * @v fdt		Device tree
- * @v pos		Position within device tree
- * @v desc		Lexical descriptor to fill in
+ * @v offset		Offset within structure block
+ * @v desc		Token descriptor to fill in
  * @ret rc		Return status code
  */
-static int fdt_traverse ( struct fdt *fdt,
-			  struct fdt_cursor *pos,
-			  struct fdt_descriptor *desc ) {
+int fdt_describe ( struct fdt *fdt, unsigned int offset,
+		   struct fdt_descriptor *desc ) {
 	const fdt_token_t *token;
 	const void *data;
 	const struct fdt_prop *prop;
@@ -88,18 +67,18 @@ static int fdt_traverse ( struct fdt *fdt,
 	size_t len;
 
 	/* Sanity checks */
-	assert ( pos->offset <= fdt->len );
-	assert ( ( pos->offset & ( FDT_STRUCTURE_ALIGN - 1 ) ) == 0 );
+	assert ( offset <= fdt->len );
+	assert ( ( offset & ( FDT_STRUCTURE_ALIGN - 1 ) ) == 0 );
 
 	/* Initialise descriptor */
 	memset ( desc, 0, sizeof ( *desc ) );
-	desc->offset = pos->offset;
+	desc->offset = offset;
 
 	/* Locate token and calculate remaining space */
-	token = ( fdt->raw + fdt->structure + pos->offset );
-	remaining = ( fdt->len - pos->offset );
+	token = ( fdt->raw + fdt->structure + offset );
+	remaining = ( fdt->len - offset );
 	if ( remaining < sizeof ( *token ) ) {
-		DBGC ( fdt, "FDT truncated tree at +%#04x\n", pos->offset );
+		DBGC ( fdt, "FDT truncated tree at +%#04x\n", offset );
 		return -EINVAL;
 	}
 	remaining -= sizeof ( *token );
@@ -116,25 +95,16 @@ static int fdt_traverse ( struct fdt *fdt,
 		len = ( strnlen ( desc->name, remaining ) + 1 /* NUL */ );
 		if ( remaining < len ) {
 			DBGC ( fdt, "FDT unterminated node name at +%#04x\n",
-			       pos->offset );
+			       offset );
 			return -EINVAL;
 		}
-		pos->depth++;
+		desc->depth = +1;
 		break;
 
 	case cpu_to_be32 ( FDT_END_NODE ):
 
 		/* End of node */
-		if ( pos->depth < 0 ) {
-			DBGC ( fdt, "FDT spurious node end at +%#04x\n",
-			       pos->offset );
-			return -EINVAL;
-		}
-		pos->depth--;
-		if ( pos->depth < 0 ) {
-			/* End of (sub)tree */
-			return -ENOENT;
-		}
+		desc->depth = -1;
 		break;
 
 	case cpu_to_be32 ( FDT_PROP ):
@@ -143,7 +113,7 @@ static int fdt_traverse ( struct fdt *fdt,
 		prop = data;
 		if ( remaining < sizeof ( *prop ) ) {
 			DBGC ( fdt, "FDT truncated property at +%#04x\n",
-			       pos->offset );
+			       offset );
 			return -EINVAL;
 		}
 		desc->data = ( ( ( const void * ) prop ) + sizeof ( *prop ) );
@@ -151,13 +121,13 @@ static int fdt_traverse ( struct fdt *fdt,
 		len = ( sizeof ( *prop ) + desc->len );
 		if ( remaining < len ) {
 			DBGC ( fdt, "FDT overlength property at +%#04x\n",
-			       pos->offset );
+			       offset );
 			return -EINVAL;
 		}
 		name_off = be32_to_cpu ( prop->name_off );
 		if ( name_off > fdt->strings_len ) {
 			DBGC ( fdt, "FDT property name outside strings "
-			       "block at +%#04x\n", pos->offset );
+			       "block at +%#04x\n", offset );
 			return -EINVAL;
 		}
 		desc->name = ( fdt->raw + fdt->strings + name_off );
@@ -172,21 +142,75 @@ static int fdt_traverse ( struct fdt *fdt,
 
 		/* Unrecognised or unexpected token */
 		DBGC ( fdt, "FDT unexpected token %#08x at +%#04x\n",
-		       be32_to_cpu ( *token ), pos->offset );
+		       be32_to_cpu ( *token ), offset );
 		return -EINVAL;
 	}
 
-	/* Update cursor */
+	/* Calculate offset to next token */
 	len = ( ( len + FDT_STRUCTURE_ALIGN - 1 ) &
 		~( FDT_STRUCTURE_ALIGN - 1 ) );
-	pos->offset += ( sizeof ( *token ) + len );
+	offset += ( sizeof ( *token ) + len );
+	desc->next = offset;
 
 	/* Sanity checks */
-	assert ( pos->offset <= fdt->len );
+	assert ( offset <= fdt->len );
 
 	return 0;
 }
 
+/**
+ * Describe next device tree token
+ *
+ * @v fdt		Device tree
+ * @v desc		Token descriptor to update
+ * @ret rc		Return status code
+ */
+static int fdt_next ( struct fdt *fdt, struct fdt_descriptor *desc ) {
+
+	/* Describe next token */
+	return fdt_describe ( fdt, desc->next, desc );
+}
+
+/**
+ * Enter node
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v desc		Begin node descriptor to fill in
+ * @ret rc		Return status code
+ */
+static int fdt_enter ( struct fdt *fdt, unsigned int offset,
+		struct fdt_descriptor *desc ) {
+	int rc;
+
+	/* Find begin node token */
+	for ( ; ; offset = desc->next ) {
+
+		/* Describe token */
+		if ( ( rc = fdt_describe ( fdt, offset, desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       offset, strerror ( rc ) );
+			return rc;
+		}
+
+		/* Check for begin node token */
+		if ( desc->depth > 0 )
+			return 0;
+
+		/* Check for non-NOPs */
+		if ( desc->depth ) {
+			DBGC ( fdt, "FDT +%#04x has spurious node end at "
+			       "+%#04x\n", offset, desc->offset );
+			return -EINVAL;
+		}
+		if ( desc->name ) {
+			DBGC ( fdt, "FDT +%#04x has spurious property at "
+			       "+%#04x\n", offset, desc->offset );
+			return -EINVAL;
+		}
+	}
+}
+
 /**
  * Find child node
  *
@@ -198,51 +222,45 @@ static int fdt_traverse ( struct fdt *fdt,
  */
 static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 		       unsigned int *child ) {
-	struct fdt_cursor pos;
 	struct fdt_descriptor desc;
-	unsigned int orig_offset;
 	const char *sep;
 	size_t name_len;
+	int depth;
 	int rc;
 
-	/* Record original offset (for debugging) */
-	orig_offset = offset;
-
-	/* Initialise cursor */
-	pos.offset = offset;
-	pos.depth = -1;
-
 	/* Determine length of name (may be terminated with NUL or '/') */
 	sep = strchr ( name, '/' );
 	name_len = ( sep ? ( ( size_t ) ( sep - name ) ) : strlen ( name ) );
 
-	/* Find child node */
-	while ( 1 ) {
+	/* Enter node */
+	if ( ( rc = fdt_enter ( fdt, offset, &desc ) ) != 0 )
+		return rc;
 
-		/* Record current offset */
-		*child = pos.offset;
+	/* Find child node */
+	for ( depth = 0 ; depth >= 0 ; depth += desc.depth ) {
 
-		/* Traverse tree */
-		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 ) {
-			DBGC2 ( fdt, "FDT +%#04x has no child node \"%s\": "
-				"%s\n", orig_offset, name, strerror ( rc ) );
+		/* Describe token */
+		if ( ( rc = fdt_next ( fdt, &desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       offset, strerror ( rc ) );
 			return rc;
 		}
 
 		/* Check for matching immediate child node */
-		if ( ( pos.depth == 1 ) && desc.name && ( ! desc.data ) ) {
-			DBGC2 ( fdt, "FDT +%#04x has child node \"%s\"\n",
-				orig_offset, desc.name );
+		if ( ( depth == 0 ) && desc.name && ( ! desc.data ) ) {
+			DBGC2 ( fdt, "FDT +%#04x has child node \"%s\" at "
+				"+%#04x\n", offset, desc.name, desc.offset );
+			assert ( desc.depth > 0 );
 			if ( ( strlen ( desc.name ) == name_len ) &&
 			     ( memcmp ( name, desc.name, name_len ) == 0 ) ) {
 				*child = desc.offset;
-				DBGC2 ( fdt, "FDT +%#04x found child node "
-					"\"%s\" at +%#04x\n", orig_offset,
-					desc.name, *child );
 				return 0;
 			}
 		}
 	}
+
+	DBGC2 ( fdt, "FDT +%#04x has no child node \"%s\"\n", offset, name );
+	return -ENOENT;
 }
 
 /**
@@ -255,38 +273,29 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
  */
 static int fdt_end ( struct fdt *fdt, unsigned int offset,
 		     unsigned int *end ) {
-	struct fdt_cursor pos;
 	struct fdt_descriptor desc;
-	unsigned int orig_offset;
+	int depth;
 	int rc;
 
-	/* Record original offset (for debugging) */
-	orig_offset = offset;
-
-	/* Initialise cursor */
-	pos.offset = offset;
-	pos.depth = 0;
-
-	/* Find child node */
-	while ( 1 ) {
+	/* Enter node */
+	if ( ( rc = fdt_enter ( fdt, offset, &desc ) ) != 0 )
+		return rc;
 
-		/* Record current offset */
-		*end = pos.offset;
+	/* Find end of this node */
+	for ( depth = 0 ; depth >= 0 ; depth += desc.depth ) {
 
-		/* Traverse tree */
-		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 ) {
+		/* Describe token */
+		if ( ( rc = fdt_next ( fdt, &desc ) ) != 0 ) {
 			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
-			       orig_offset, strerror ( rc ) );
+			       offset, strerror ( rc ) );
 			return rc;
 		}
-
-		/* Check for end of current node */
-		if ( pos.depth == 0 ) {
-			DBGC2 ( fdt, "FDT +%#04x has end at +%#04x\n",
-				orig_offset, *end );
-			return 0;
-		}
 	}
+
+	/* Record end offset */
+	*end = desc.offset;
+	DBGC2 ( fdt, "FDT +%#04x has end at +%#04x\n", offset, *end );
+	return 0;
 }
 
 /**
@@ -363,40 +372,43 @@ int fdt_alias ( struct fdt *fdt, const char *name, unsigned int *offset ) {
  * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
- * @v desc		Lexical descriptor to fill in
+ * @v desc		Token descriptor to fill in
  * @ret rc		Return status code
  */
 static int fdt_property ( struct fdt *fdt, unsigned int offset,
 			  const char *name, struct fdt_descriptor *desc ) {
-	struct fdt_cursor pos;
+	int depth;
 	int rc;
 
-	/* Initialise cursor */
-	pos.offset = offset;
-	pos.depth = -1;
+	/* Enter node */
+	if ( ( rc = fdt_enter ( fdt, offset, desc ) ) != 0 )
+		return rc;
 
 	/* Find property */
-	while ( 1 ) {
+	for ( depth = 0 ; depth == 0 ; depth += desc->depth ) {
 
-		/* Traverse tree */
-		if ( ( rc = fdt_traverse ( fdt, &pos, desc ) ) != 0 ) {
-			DBGC2 ( fdt, "FDT +%#04x has no property \"%s\": %s\n",
-				offset, name, strerror ( rc ) );
+		/* Describe token */
+		if ( ( rc = fdt_next ( fdt, desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       offset, strerror ( rc ) );
 			return rc;
 		}
 
 		/* Check for matching immediate child property */
-		if ( ( pos.depth == 0 ) && desc->data ) {
-			DBGC2 ( fdt, "FDT +%#04x has property \"%s\" len "
-				"%#zx\n", offset, desc->name, desc->len );
+		if ( desc->data ) {
+			DBGC2 ( fdt, "FDT +%#04x has property \"%s\" at "
+				"+%#04x len %#zx\n", offset, desc->name,
+				desc->offset, desc->len );
+			assert ( desc->depth == 0 );
 			if ( strcmp ( name, desc->name ) == 0 ) {
-				DBGC2 ( fdt, "FDT +%#04x found property "
-					"\"%s\"\n", offset, desc->name );
 				DBGC2_HDA ( fdt, 0, desc->data, desc->len );
 				return 0;
 			}
 		}
 	}
+
+	DBGC2 ( fdt, "FDT +%#04x has no property \"%s\"\n", offset, name );
+	return -ENOENT;
 }
 
 /**
@@ -894,7 +906,6 @@ static int fdt_ensure_property ( struct fdt *fdt, unsigned int offset,
 				 const char *name, const void *data,
 				 size_t len ) {
 	struct fdt_descriptor desc;
-	struct fdt_cursor pos;
 	struct {
 		fdt_token_t token;
 		struct fdt_prop prop;
@@ -909,15 +920,14 @@ static int fdt_ensure_property ( struct fdt *fdt, unsigned int offset,
 	if ( ( rc = fdt_property ( fdt, offset, name, &desc ) ) == 0 ) {
 
 		/* Reuse existing name */
-		pos.offset = desc.offset;
-		hdr = ( fdt->raw + fdt->structure + pos.offset );
+		hdr = ( fdt->raw + fdt->structure + desc.offset );
 		string = be32_to_cpu ( hdr->prop.name_off );
 
 		/* Erase existing property */
 		erase = ( sizeof ( *hdr ) + desc.len );
 		erase = ( ( erase + FDT_STRUCTURE_ALIGN - 1 ) &
 			  ~( FDT_STRUCTURE_ALIGN - 1 ) );
-		fdt_nop ( fdt, pos.offset, erase );
+		fdt_nop ( fdt, desc.offset, erase );
 		DBGC2 ( fdt, "FDT +%#04x erased property \"%s\"\n",
 			offset, name );
 
@@ -931,22 +941,21 @@ static int fdt_ensure_property ( struct fdt *fdt, unsigned int offset,
 			return rc;
 
 		/* Enter node */
-		pos.offset = offset;
-		pos.depth = 0;
-		if ( ( rc = fdt_traverse ( fdt, &pos, &desc ) ) != 0 )
+		if ( ( rc = fdt_enter ( fdt, offset, &desc ) ) != 0 )
 			return rc;
-		assert ( pos.depth == 1 );
+		assert ( desc.depth > 0 );
+		desc.offset = desc.next;
 
 		/* Calculate insertion length */
 		insert = ( sizeof ( *hdr ) + len );
 	}
 
 	/* Insert space */
-	if ( ( rc = fdt_insert_nop ( fdt, pos.offset, insert ) ) != 0 )
+	if ( ( rc = fdt_insert_nop ( fdt, desc.offset, insert ) ) != 0 )
 		return rc;
 
 	/* Construct property */
-	hdr = ( fdt->raw + fdt->structure + pos.offset );
+	hdr = ( fdt->raw + fdt->structure + desc.offset );
 	hdr->token = cpu_to_be32 ( FDT_PROP );
 	hdr->prop.len = cpu_to_be32 ( len );
 	hdr->prop.name_off = cpu_to_be32 ( string );
@@ -1082,8 +1091,8 @@ void fdt_remove ( struct fdt_header *hdr ) {
 	ufree ( virt_to_user ( hdr ) );
 }
 
-/* Drag in objects via fdt_traverse() */
-REQUIRING_SYMBOL ( fdt_traverse );
+/* Drag in objects via fdt_describe() */
+REQUIRING_SYMBOL ( fdt_describe );
 
 /* Drag in device tree configuration */
 REQUIRE_OBJECT ( config_fdt );
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 1e05c9e2d..a41dcaa30 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -108,9 +108,27 @@ struct fdt {
 	int ( * realloc ) ( struct fdt *fdt, size_t len );
 };
 
+/** A device tree token descriptor */
+struct fdt_descriptor {
+	/** Offset within structure block */
+	unsigned int offset;
+	/** Next offset within structure block */
+	unsigned int next;
+	/** Node or property name (if applicable) */
+	const char *name;
+	/** Property data (if applicable) */
+	const void *data;
+	/** Length of property data (if applicable) */
+	size_t len;
+	/** Depth change */
+	int depth;
+};
+
 extern struct image_tag fdt_image __image_tag;
 extern struct fdt sysfdt;
 
+extern int fdt_describe ( struct fdt *fdt, unsigned int offset,
+			  struct fdt_descriptor *desc );
 extern int fdt_path ( struct fdt *fdt, const char *path,
 		      unsigned int *offset );
 extern int fdt_alias ( struct fdt *fdt, const char *name,
diff --git a/src/tests/fdt_test.c b/src/tests/fdt_test.c
index ec0f0bd3c..738966df8 100644
--- a/src/tests/fdt_test.c
+++ b/src/tests/fdt_test.c
@@ -158,6 +158,7 @@ static const uint8_t sifive_u[] = {
  *
  */
 static void fdt_test_exec ( void ) {
+	struct fdt_descriptor desc;
 	struct fdt_header *hdr;
 	struct fdt fdt;
 	const char *string;
@@ -218,6 +219,19 @@ static void fdt_test_exec ( void ) {
 	ok ( ( string = fdt_string ( &fdt, offset, "compatible" ) ) != NULL );
 	ok ( strcmp ( string, "sifive,uart0" ) == 0 );
 	ok ( fdt_alias ( &fdt, "nonexistent0", &offset ) != 0 );
+
+	/* Verify node description */
+	ok ( fdt_path ( &fdt, "/memory@80000000", &offset ) == 0 );
+	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
+	ok ( desc.offset == offset );
+	ok ( strcmp ( desc.name, "memory@80000000" ) == 0 );
+	ok ( desc.data == NULL );
+	ok ( desc.len == 0 );
+	ok ( desc.depth == +1 );
+	ok ( fdt_describe ( &fdt, desc.next, &desc ) == 0 );
+	ok ( strcmp ( desc.name, "device_type" ) == 0 );
+	ok ( strcmp ( desc.data, "memory" ) == 0 );
+	ok ( desc.depth == 0 );
 }
 
 /** FDT self-test */
-- 
cgit v1.2.3-55-g7522


From 99322fd3b37abd88867ccc3e9f60df0195730036 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 15 Apr 2025 20:14:03 +0100
Subject: [fdt] Add fdt_cells() to read cell-based properties such as "reg"

Add fdt_cells() to read scalar values encoded within a cell array,
reimplement fdt_u64() as a wrapper around this, and add fdt_u32() for
completeness.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 84 ++++++++++++++++++++++++++++++++++++--------
 src/include/ipxe/fdt.h |  5 +++
 src/tests/fdt_test.c   | 94 ++++++++++++++++++++++++++++++++------------------
 3 files changed, 136 insertions(+), 47 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 85394a8e0..54f930286 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -468,19 +468,21 @@ const char * fdt_string ( struct fdt *fdt, unsigned int offset,
 }
 
 /**
- * Find integer property
+ * Get integer property
  *
  * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
+ * @v index		Starting cell index
+ * @v count		Number of cells (or 0 to read all remaining cells)
  * @v value		Integer value to fill in
  * @ret rc		Return status code
  */
-int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
-	      uint64_t *value ) {
+int fdt_cells ( struct fdt *fdt, unsigned int offset, const char *name,
+		unsigned int index, unsigned int count, uint64_t *value ) {
 	struct fdt_descriptor desc;
-	const uint8_t *data;
-	size_t remaining;
+	const uint32_t *cell;
+	unsigned int total;
 	int rc;
 
 	/* Clear value */
@@ -489,19 +491,73 @@ int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
 	/* Find property */
 	if ( ( rc = fdt_property ( fdt, offset, name, &desc ) ) != 0 )
 		return rc;
+	cell = desc.data;
 
-	/* Check range */
-	if ( desc.len > sizeof ( *value ) ) {
-		DBGC ( fdt, "FDT oversized integer property \"%s\"\n", name );
+	/* Determine number of cells */
+	total = ( desc.len / sizeof ( *cell ) );
+	if ( ( index > total ) || ( count > ( total - index ) ) ) {
+		DBGC ( fdt, "FDT truncated integer \"%s\"\n", name );
+		return -ERANGE;
+	}
+	if ( ! count )
+		count = ( total - index );
+	if ( count > ( sizeof ( *value ) / sizeof ( *cell ) ) ) {
+		DBGC ( fdt, "FDT overlength integer \"%s\"\n", name );
 		return -ERANGE;
 	}
 
-	/* Parse value */
-	data = desc.data;
-	remaining = desc.len;
-	while ( remaining-- ) {
-		*value <<= 8;
-		*value |= *(data++);
+	/* Read value */
+	for ( cell += index ; count ; cell++, count-- ) {
+		*value <<= 32;
+		*value |= be32_to_cpu ( *cell );
+	}
+
+	return 0;
+}
+
+/**
+ * Get 64-bit integer property
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v name		Property name
+ * @v value		Integer value to fill in
+ * @ret rc		Return status code
+ */
+int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
+	      uint64_t *value ) {
+	int rc;
+
+	/* Read value */
+	if ( ( rc = fdt_cells ( fdt, offset, name, 0, 0, value ) ) != 0 )
+		return rc;
+
+	return 0;
+}
+
+/**
+ * Get 32-bit integer property
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v name		Property name
+ * @v value		Integer value to fill in
+ * @ret rc		Return status code
+ */
+int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
+	      uint32_t *value ) {
+	uint64_t value64;
+	int rc;
+
+	/* Read value */
+	if ( ( rc = fdt_u64 ( fdt, offset, name, &value64 ) ) != 0 )
+		return rc;
+
+	/* Check range */
+	*value = value64;
+	if ( *value != value64 ) {
+		DBGC ( fdt, "FDT overlength 32-bit integer \"%s\"\n", name );
+		return -ERANGE;
 	}
 
 	return 0;
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index a41dcaa30..fb0ae7752 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -137,8 +137,13 @@ extern const char * fdt_strings ( struct fdt *fdt, unsigned int offset,
 				  const char *name, unsigned int *count );
 extern const char * fdt_string ( struct fdt *fdt, unsigned int offset,
 				 const char *name );
+extern int fdt_cells ( struct fdt *fdt, unsigned int offset, const char *name,
+		       unsigned int index, unsigned int count,
+		       uint64_t *value );
 extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint64_t *value );
+extern int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
+		     uint32_t *value );
 extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
 extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
diff --git a/src/tests/fdt_test.c b/src/tests/fdt_test.c
index 738966df8..0a143ec62 100644
--- a/src/tests/fdt_test.c
+++ b/src/tests/fdt_test.c
@@ -38,10 +38,10 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 /** Simplified QEMU sifive_u device tree blob */
 static const uint8_t sifive_u[] = {
-	0xd0, 0x0d, 0xfe, 0xed, 0x00, 0x00, 0x05, 0x43, 0x00, 0x00, 0x00, 0x38,
-	0x00, 0x00, 0x04, 0x68, 0x00, 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x11,
-	0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xdb,
-	0x00, 0x00, 0x04, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0xd0, 0x0d, 0xfe, 0xed, 0x00, 0x00, 0x05, 0x61, 0x00, 0x00, 0x00, 0x38,
+	0x00, 0x00, 0x04, 0x7c, 0x00, 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x11,
+	0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xe5,
+	0x00, 0x00, 0x04, 0x44, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01,
 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04,
 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x03,
@@ -127,30 +127,32 @@ static const uint8_t sifive_u[] = {
 	0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x16,
 	0x00, 0x00, 0x00, 0x1b, 0x73, 0x69, 0x66, 0x69, 0x76, 0x65, 0x2c, 0x66,
 	0x75, 0x35, 0x34, 0x30, 0x2d, 0x63, 0x30, 0x30, 0x30, 0x2d, 0x67, 0x65,
-	0x6d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x65, 0x74, 0x68, 0x65,
-	0x72, 0x6e, 0x65, 0x74, 0x2d, 0x70, 0x68, 0x79, 0x40, 0x30, 0x00, 0x00,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x69,
-	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02,
-	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x09,
-	0x23, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x2d, 0x63, 0x65, 0x6c,
-	0x6c, 0x73, 0x00, 0x23, 0x73, 0x69, 0x7a, 0x65, 0x2d, 0x63, 0x65, 0x6c,
-	0x6c, 0x73, 0x00, 0x63, 0x6f, 0x6d, 0x70, 0x61, 0x74, 0x69, 0x62, 0x6c,
-	0x65, 0x00, 0x6d, 0x6f, 0x64, 0x65, 0x6c, 0x00, 0x73, 0x74, 0x64, 0x6f,
-	0x75, 0x74, 0x2d, 0x70, 0x61, 0x74, 0x68, 0x00, 0x73, 0x65, 0x72, 0x69,
-	0x61, 0x6c, 0x30, 0x00, 0x65, 0x74, 0x68, 0x65, 0x72, 0x6e, 0x65, 0x74,
-	0x30, 0x00, 0x74, 0x69, 0x6d, 0x65, 0x62, 0x61, 0x73, 0x65, 0x2d, 0x66,
-	0x72, 0x65, 0x71, 0x75, 0x65, 0x6e, 0x63, 0x79, 0x00, 0x64, 0x65, 0x76,
-	0x69, 0x63, 0x65, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x00, 0x72, 0x65, 0x67,
-	0x00, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x00, 0x72, 0x69, 0x73, 0x63,
-	0x76, 0x2c, 0x69, 0x73, 0x61, 0x00, 0x23, 0x69, 0x6e, 0x74, 0x65, 0x72,
-	0x72, 0x75, 0x70, 0x74, 0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x69,
-	0x6e, 0x74, 0x65, 0x72, 0x72, 0x75, 0x70, 0x74, 0x2d, 0x63, 0x6f, 0x6e,
-	0x74, 0x72, 0x6f, 0x6c, 0x6c, 0x65, 0x72, 0x00, 0x72, 0x61, 0x6e, 0x67,
-	0x65, 0x73, 0x00, 0x6c, 0x6f, 0x63, 0x61, 0x6c, 0x2d, 0x6d, 0x61, 0x63,
-	0x2d, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x00, 0x70, 0x68, 0x79,
-	0x2d, 0x68, 0x61, 0x6e, 0x64, 0x6c, 0x65, 0x00, 0x70, 0x68, 0x79, 0x2d,
-	0x6d, 0x6f, 0x64, 0x65, 0x00, 0x72, 0x65, 0x67, 0x2d, 0x6e, 0x61, 0x6d,
-	0x65, 0x73, 0x00
+	0x6d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x08,
+	0x00, 0x00, 0x00, 0xdb, 0x00, 0x00, 0x00, 0x02, 0x54, 0x0b, 0xe4, 0x00,
+	0x00, 0x00, 0x00, 0x01, 0x65, 0x74, 0x68, 0x65, 0x72, 0x6e, 0x65, 0x74,
+	0x2d, 0x70, 0x68, 0x79, 0x40, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x69, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02,
+	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x09, 0x23, 0x61, 0x64, 0x64,
+	0x72, 0x65, 0x73, 0x73, 0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x23,
+	0x73, 0x69, 0x7a, 0x65, 0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x63,
+	0x6f, 0x6d, 0x70, 0x61, 0x74, 0x69, 0x62, 0x6c, 0x65, 0x00, 0x6d, 0x6f,
+	0x64, 0x65, 0x6c, 0x00, 0x73, 0x74, 0x64, 0x6f, 0x75, 0x74, 0x2d, 0x70,
+	0x61, 0x74, 0x68, 0x00, 0x73, 0x65, 0x72, 0x69, 0x61, 0x6c, 0x30, 0x00,
+	0x65, 0x74, 0x68, 0x65, 0x72, 0x6e, 0x65, 0x74, 0x30, 0x00, 0x74, 0x69,
+	0x6d, 0x65, 0x62, 0x61, 0x73, 0x65, 0x2d, 0x66, 0x72, 0x65, 0x71, 0x75,
+	0x65, 0x6e, 0x63, 0x79, 0x00, 0x64, 0x65, 0x76, 0x69, 0x63, 0x65, 0x5f,
+	0x74, 0x79, 0x70, 0x65, 0x00, 0x72, 0x65, 0x67, 0x00, 0x73, 0x74, 0x61,
+	0x74, 0x75, 0x73, 0x00, 0x72, 0x69, 0x73, 0x63, 0x76, 0x2c, 0x69, 0x73,
+	0x61, 0x00, 0x23, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x72, 0x75, 0x70, 0x74,
+	0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x69, 0x6e, 0x74, 0x65, 0x72,
+	0x72, 0x75, 0x70, 0x74, 0x2d, 0x63, 0x6f, 0x6e, 0x74, 0x72, 0x6f, 0x6c,
+	0x6c, 0x65, 0x72, 0x00, 0x72, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x00, 0x6c,
+	0x6f, 0x63, 0x61, 0x6c, 0x2d, 0x6d, 0x61, 0x63, 0x2d, 0x61, 0x64, 0x64,
+	0x72, 0x65, 0x73, 0x73, 0x00, 0x70, 0x68, 0x79, 0x2d, 0x68, 0x61, 0x6e,
+	0x64, 0x6c, 0x65, 0x00, 0x70, 0x68, 0x79, 0x2d, 0x6d, 0x6f, 0x64, 0x65,
+	0x00, 0x72, 0x65, 0x67, 0x2d, 0x6e, 0x61, 0x6d, 0x65, 0x73, 0x00, 0x6d,
+	0x61, 0x78, 0x2d, 0x73, 0x70, 0x65, 0x65, 0x64, 0x00
 };
 
 /**
@@ -162,6 +164,7 @@ static void fdt_test_exec ( void ) {
 	struct fdt_header *hdr;
 	struct fdt fdt;
 	const char *string;
+	uint32_t u32;
 	uint64_t u64;
 	unsigned int count;
 	unsigned int offset;
@@ -194,11 +197,6 @@ static void fdt_test_exec ( void ) {
 				      &count ) ) == NULL );
 	ok ( count == 0 );
 
-	/* Verify integer properties */
-	ok ( fdt_u64 ( &fdt, 0, "#address-cells", &u64 ) == 0 );
-	ok ( u64 == 2 );
-	ok ( fdt_u64 ( &fdt, 0, "#nonexistent", &u64 ) != 0 );
-
 	/* Verify path lookup */
 	ok ( fdt_path ( &fdt, "", &offset ) == 0 );
 	ok ( offset == 0 );
@@ -214,6 +212,36 @@ static void fdt_test_exec ( void ) {
 	ok ( fdt_path ( &fdt, "/nonexistent", &offset ) != 0 );
 	ok ( fdt_path ( &fdt, "/cpus/nonexistent", &offset ) != 0 );
 
+	/* Verify 64-bit integer properties */
+	ok ( fdt_u64 ( &fdt, 0, "#address-cells", &u64 ) == 0 );
+	ok ( u64 == 2 );
+	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000", &offset ) == 0 );
+	ok ( fdt_u64 ( &fdt, offset, "max-speed", &u64 ) == 0 );
+	ok ( u64 == 10000000000ULL );
+	ok ( fdt_u64 ( &fdt, offset, "#nonexistent", &u64 ) != 0 );
+
+	/* Verify 32-bit integer properties */
+	ok ( fdt_u32 ( &fdt, 0, "#address-cells", &u32 ) == 0 );
+	ok ( u32 == 2 );
+	ok ( fdt_u32 ( &fdt, 0, "#nonexistent", &u32 ) != 0 );
+	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000", &offset ) == 0 );
+	ok ( fdt_u32 ( &fdt, offset, "max-speed", &u32 ) != 0 );
+
+	/* Verify cell properties */
+	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000", &offset ) == 0 );
+	ok ( fdt_cells ( &fdt, offset, "reg", 4, 2, &u64 ) == 0 );
+	ok ( u64 == 0x100a0000 );
+	ok ( fdt_cells ( &fdt, offset, "reg", 6, 2, &u64 ) == 0 );
+	ok ( u64 == 0x1000 );
+	ok ( fdt_cells ( &fdt, offset, "reg", 0, 2, &u64 ) == 0 );
+	ok ( u64 == 0x10090000 );
+	ok ( fdt_cells ( &fdt, offset, "reg", 6, 0, &u64 ) == 0 );
+	ok ( u64 == 0x1000 );
+	ok ( fdt_cells ( &fdt, offset, "reg", 8, 0, &u64 ) == 0 );
+	ok ( u64 == 0 );
+	ok ( fdt_cells ( &fdt, offset, "reg", 7, 2, &u64 ) != 0 );
+	ok ( fdt_cells ( &fdt, offset, "notareg", 0, 1, &u64 ) != 0 );
+
 	/* Verify alias lookup */
 	ok ( fdt_alias ( &fdt, "serial0", &offset ) == 0 );
 	ok ( ( string = fdt_string ( &fdt, offset, "compatible" ) ) != NULL );
-- 
cgit v1.2.3-55-g7522


From 453acba7dc4b34fa3814755671755e2601a9059d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Sat, 19 Apr 2025 13:35:23 +0100
Subject: [time] Use currticks() to provide the null system time

For platforms with no real-time clock (such as RISC-V SBI) we use the
null time source, which currently just returns a constant zero.

Switch to using currticks() to provide a clock that does not represent
the real current time, but does at least advance at approximately the
correct rate.  In conjunction with the "ntp" command, this allows
these platforms to use time-dependent features such as X.509
certificate verification for HTTPS connections.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/null_time.c         | 14 +++++++++++++-
 src/include/ipxe/null_time.h |  5 -----
 2 files changed, 13 insertions(+), 6 deletions(-)

(limited to 'src/core')

diff --git a/src/core/null_time.c b/src/core/null_time.c
index 90041a456..15d8a57a5 100644
--- a/src/core/null_time.c
+++ b/src/core/null_time.c
@@ -30,5 +30,17 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <ipxe/time.h>
+#include <ipxe/timer.h>
 
-PROVIDE_TIME_INLINE ( null, time_now );
+/**
+ * Get current time in seconds
+ *
+ * @ret time		Time, in seconds
+ */
+static time_t null_now ( void ) {
+
+	/* Provide a non-absolute timer bassed on currticks() */
+	return ( currticks() / TICKS_PER_SEC );
+}
+
+PROVIDE_TIME ( null, time_now, null_now );
diff --git a/src/include/ipxe/null_time.h b/src/include/ipxe/null_time.h
index d2b15194b..c670a5fce 100644
--- a/src/include/ipxe/null_time.h
+++ b/src/include/ipxe/null_time.h
@@ -15,9 +15,4 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define TIME_PREFIX_null __null_
 #endif
 
-static inline __always_inline time_t
-TIME_INLINE ( null, time_now ) ( void ) {
-	return 0;
-}
-
 #endif /* _IPXE_NULL_TIME_H */
-- 
cgit v1.2.3-55-g7522


From ef038491858cb51f8aa17b1f6e50444d2e627413 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Sun, 20 Apr 2025 18:45:55 +0100
Subject: [uaccess] Remove redundant userptr_add() and userptr_diff()

The userptr_add() and userptr_diff() functions are now just
straightforward wrappers around addition and subtraction.

Remove these redundant wrappers.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/image/bzimage.c                   | 12 +++---
 src/arch/x86/image/initrd.c                    | 25 ++++++------
 src/arch/x86/image/nbi.c                       |  4 +-
 src/arch/x86/include/librm.h                   | 11 ------
 src/arch/x86/interface/pcbios/memtop_umalloc.c | 10 ++---
 src/arch/x86/transitions/librm_mgmt.c          |  1 -
 src/core/sanboot.c                             |  2 +-
 src/core/uaccess.c                             |  1 -
 src/drivers/net/gve.c                          |  2 +-
 src/image/gzip.c                               |  2 +-
 src/include/ipxe/linux/linux_uaccess.h         | 11 ------
 src/include/ipxe/uaccess.h                     | 53 --------------------------
 src/interface/linux/linux_uaccess.c            |  1 -
 13 files changed, 27 insertions(+), 108 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/image/bzimage.c b/src/arch/x86/image/bzimage.c
index b4a78cdfc..d00b9f155 100644
--- a/src/arch/x86/image/bzimage.c
+++ b/src/arch/x86/image/bzimage.c
@@ -431,7 +431,7 @@ static int bzimage_check_initrds ( struct image *image,
 	}
 
 	/* Calculate lowest usable address */
-	bottom = userptr_add ( bzimg->pm_kernel, bzimg->pm_sz );
+	bottom = ( bzimg->pm_kernel + bzimg->pm_sz );
 
 	/* Check that total length fits within space available for
 	 * reshuffling.  This is a conservative check, since CPIO
@@ -471,14 +471,12 @@ static void bzimage_load_initrds ( struct image *image,
 	size_t len;
 
 	/* Reshuffle initrds into desired order */
-	initrd_reshuffle ( userptr_add ( bzimg->pm_kernel, bzimg->pm_sz ) );
+	initrd_reshuffle ( bzimg->pm_kernel + bzimg->pm_sz );
 
 	/* Find highest initrd */
 	for_each_image ( initrd ) {
-		if ( ( highest == NULL ) ||
-		     ( userptr_diff ( initrd->data, highest->data ) > 0 ) ) {
+		if ( ( highest == NULL ) || ( initrd->data > highest->data ) )
 			highest = initrd;
-		}
 	}
 
 	/* Do nothing if there are no initrds */
@@ -486,7 +484,7 @@ static void bzimage_load_initrds ( struct image *image,
 		return;
 
 	/* Find highest usable address */
-	top = userptr_add ( highest->data, bzimage_align ( highest->len ) );
+	top = ( highest->data + bzimage_align ( highest->len ) );
 	if ( user_to_phys ( top, -1 ) > bzimg->mem_limit ) {
 		top = phys_to_user ( ( bzimg->mem_limit + 1 ) &
 				     ~( INITRD_ALIGN - 1 ) );
@@ -509,7 +507,7 @@ static void bzimage_load_initrds ( struct image *image,
 		}
 
 		/* Load initrd at this address */
-		dest = userptr_add ( top, -offset );
+		dest = ( top - offset );
 		len = bzimage_load_initrd ( image, initrd, dest );
 
 		/* Record initrd location */
diff --git a/src/arch/x86/image/initrd.c b/src/arch/x86/image/initrd.c
index c0a56b7f6..e32e40341 100644
--- a/src/arch/x86/image/initrd.c
+++ b/src/arch/x86/image/initrd.c
@@ -61,10 +61,9 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 		/* Find the highest image not yet in its final position */
 		highest = NULL;
 		for_each_image ( initrd ) {
-			if ( ( userptr_diff ( initrd->data, current ) < 0 ) &&
+			if ( ( initrd->data < current ) &&
 			     ( ( highest == NULL ) ||
-			       ( userptr_diff ( initrd->data,
-						highest->data ) > 0 ) ) ) {
+			       ( initrd->data > highest->data ) ) ) {
 				highest = initrd;
 			}
 		}
@@ -74,7 +73,7 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 		/* Move this image to its final position */
 		len = ( ( highest->len + INITRD_ALIGN - 1 ) &
 			~( INITRD_ALIGN - 1 ) );
-		current = userptr_add ( current, -len );
+		current -= len;
 		DBGC ( &images, "INITRD squashing %s [%#08lx,%#08lx)->"
 		       "[%#08lx,%#08lx)\n", highest->name,
 		       user_to_phys ( highest->data, 0 ),
@@ -87,10 +86,10 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 
 	/* Copy any remaining initrds (e.g. embedded images) to the region */
 	for_each_image ( initrd ) {
-		if ( userptr_diff ( initrd->data, top ) >= 0 ) {
+		if ( initrd->data >= top ) {
 			len = ( ( initrd->len + INITRD_ALIGN - 1 ) &
 				~( INITRD_ALIGN - 1 ) );
-			current = userptr_add ( current, -len );
+			current -= len;
 			DBGC ( &images, "INITRD copying %s [%#08lx,%#08lx)->"
 			       "[%#08lx,%#08lx)\n", initrd->name,
 			       user_to_phys ( initrd->data, 0 ),
@@ -149,7 +148,7 @@ static void initrd_swap ( struct image *low, struct image *high,
 
 	/* Adjust data pointers */
 	high->data = low->data;
-	low->data = userptr_add ( low->data, len );
+	low->data += len;
 }
 
 /**
@@ -171,7 +170,7 @@ static int initrd_swap_any ( userptr_t free, size_t free_len ) {
 		/* Calculate location of adjacent image (if any) */
 		padded_len = ( ( low->len + INITRD_ALIGN - 1 ) &
 			       ~( INITRD_ALIGN - 1 ) );
-		adjacent = userptr_add ( low->data, padded_len );
+		adjacent = ( low->data + padded_len );
 
 		/* Search for adjacent image */
 		for_each_image ( high ) {
@@ -235,7 +234,7 @@ void initrd_reshuffle ( userptr_t bottom ) {
 
 	/* Calculate limits of available space for initrds */
 	top = initrd_top;
-	if ( userptr_diff ( initrd_bottom, bottom ) > 0 )
+	if ( initrd_bottom > bottom )
 		bottom = initrd_bottom;
 
 	/* Debug */
@@ -248,7 +247,7 @@ void initrd_reshuffle ( userptr_t bottom ) {
 
 	/* Calculate available free space */
 	free = bottom;
-	free_len = userptr_diff ( used, free );
+	free_len = ( used - free );
 
 	/* Bubble-sort initrds into desired order */
 	while ( initrd_swap_any ( free, free_len ) ) {}
@@ -270,9 +269,9 @@ int initrd_reshuffle_check ( size_t len, userptr_t bottom ) {
 
 	/* Calculate limits of available space for initrds */
 	top = initrd_top;
-	if ( userptr_diff ( initrd_bottom, bottom ) > 0 )
+	if ( initrd_bottom > bottom )
 		bottom = initrd_bottom;
-	available = userptr_diff ( top, bottom );
+	available = ( top - bottom );
 
 	/* Allow for a sensible minimum amount of free space */
 	len += INITRD_MIN_FREE_LEN;
@@ -296,7 +295,7 @@ static void initrd_startup ( void ) {
 	 * can safely reuse when rearranging).
 	 */
 	len = largest_memblock ( &initrd_bottom );
-	initrd_top = userptr_add ( initrd_bottom, len );
+	initrd_top = ( initrd_bottom + len );
 }
 
 /** initrd startup function */
diff --git a/src/arch/x86/image/nbi.c b/src/arch/x86/image/nbi.c
index b691bee20..2f0d3164a 100644
--- a/src/arch/x86/image/nbi.c
+++ b/src/arch/x86/image/nbi.c
@@ -184,10 +184,10 @@ static int nbi_process_segments ( struct image *image,
 			dest = phys_to_user ( sh.loadaddr );
 			break;
 		case NBI_LOADADDR_AFTER:
-			dest = userptr_add ( dest, memsz + sh.loadaddr );
+			dest = ( dest + memsz + sh.loadaddr );
 			break;
 		case NBI_LOADADDR_BEFORE:
-			dest = userptr_add ( dest, -sh.loadaddr );
+			dest = ( dest - sh.loadaddr );
 			break;
 		case NBI_LOADADDR_END:
 			/* Not correct according to the spec, but
diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index 23ca4650f..c0d910287 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -137,17 +137,6 @@ UACCESS_INLINE ( librm, user_to_virt ) ( userptr_t userptr, off_t offset ) {
 	return trivial_user_to_virt ( userptr, offset );
 }
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( librm, userptr_add ) ( userptr_t userptr, off_t offset ) {
-	return trivial_userptr_add ( userptr, offset );
-}
-
-static inline __always_inline off_t
-UACCESS_INLINE ( librm, userptr_diff ) ( userptr_t userptr,
-					 userptr_t subtrahend ) {
-	return trivial_userptr_diff ( userptr, subtrahend );
-}
-
 static inline __always_inline void
 UACCESS_INLINE ( librm, memcpy_user ) ( userptr_t dest, off_t dest_off,
 					userptr_t src, off_t src_off,
diff --git a/src/arch/x86/interface/pcbios/memtop_umalloc.c b/src/arch/x86/interface/pcbios/memtop_umalloc.c
index 1cc3aff91..e76b3df93 100644
--- a/src/arch/x86/interface/pcbios/memtop_umalloc.c
+++ b/src/arch/x86/interface/pcbios/memtop_umalloc.c
@@ -122,7 +122,7 @@ static void init_eheap ( void ) {
 	userptr_t base;
 
 	heap_size = largest_memblock ( &base );
-	bottom = top = userptr_add ( base, heap_size );
+	bottom = top = ( base + heap_size );
 	DBG ( "External heap grows downwards from %lx (size %zx)\n",
 	      user_to_phys ( top, 0 ), heap_size );
 }
@@ -144,7 +144,7 @@ static void ecollect_free ( void ) {
 		DBG ( "EXTMEM freeing [%lx,%lx)\n", user_to_phys ( bottom, 0 ),
 		      user_to_phys ( bottom, extmem.size ) );
 		len = ( extmem.size + sizeof ( extmem ) );
-		bottom = userptr_add ( bottom, len );
+		bottom += len;
 		heap_size += len;
 	}
 }
@@ -179,7 +179,7 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 			DBG ( "EXTMEM out of space\n" );
 			return UNULL;
 		}
-		ptr = bottom = userptr_add ( bottom, -sizeof ( extmem ) );
+		ptr = bottom = ( bottom - sizeof ( extmem ) );
 		heap_size -= sizeof ( extmem );
 		DBG ( "EXTMEM allocating [%lx,%lx)\n",
 		      user_to_phys ( ptr, 0 ), user_to_phys ( ptr, 0 ) );
@@ -190,10 +190,10 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 	/* Expand/shrink block if possible */
 	if ( ptr == bottom ) {
 		/* Update block */
-		new = userptr_add ( ptr, - ( new_size - extmem.size ) );
+		new = ( ptr - ( new_size - extmem.size ) );
 		align = ( user_to_phys ( new, 0 ) & ( EM_ALIGN - 1 ) );
 		new_size += align;
-		new = userptr_add ( new, -align );
+		new -= align;
 		if ( new_size > ( heap_size + extmem.size ) ) {
 			DBG ( "EXTMEM out of space\n" );
 			return UNULL;
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index b3820589c..ec31fceb1 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -432,7 +432,6 @@ PROVIDE_UACCESS_INLINE ( librm, phys_to_user );
 PROVIDE_UACCESS_INLINE ( librm, user_to_phys );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_user );
 PROVIDE_UACCESS_INLINE ( librm, user_to_virt );
-PROVIDE_UACCESS_INLINE ( librm, userptr_add );
 PROVIDE_UACCESS_INLINE ( librm, memcpy_user );
 PROVIDE_UACCESS_INLINE ( librm, memmove_user );
 PROVIDE_UACCESS_INLINE ( librm, memset_user );
diff --git a/src/core/sanboot.c b/src/core/sanboot.c
index e49a3f92d..4facf86b8 100644
--- a/src/core/sanboot.c
+++ b/src/core/sanboot.c
@@ -625,7 +625,7 @@ static int sandev_rw ( struct san_device *sandev, uint64_t lba,
 
 		/* Move to next fragment */
 		frag_len = ( sandev->capacity.blksize * params.rw.count );
-		params.rw.buffer = userptr_add ( params.rw.buffer, frag_len );
+		params.rw.buffer += frag_len;
 		params.rw.lba += params.rw.count;
 		remaining -= params.rw.count;
 	}
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index d3a9ca17d..ad17a58ab 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -36,7 +36,6 @@ PROVIDE_UACCESS_INLINE ( flat, phys_to_user );
 PROVIDE_UACCESS_INLINE ( flat, user_to_phys );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
 PROVIDE_UACCESS_INLINE ( flat, user_to_virt );
-PROVIDE_UACCESS_INLINE ( flat, userptr_add );
 PROVIDE_UACCESS_INLINE ( flat, memcpy_user );
 PROVIDE_UACCESS_INLINE ( flat, memmove_user );
 PROVIDE_UACCESS_INLINE ( flat, memset_user );
diff --git a/src/drivers/net/gve.c b/src/drivers/net/gve.c
index efc38dd21..805feee3d 100644
--- a/src/drivers/net/gve.c
+++ b/src/drivers/net/gve.c
@@ -807,7 +807,7 @@ static inline __attribute__ (( always_inline )) userptr_t
 gve_buffer ( struct gve_queue *queue, unsigned int index ) {
 
 	/* Pages are currently allocated as a single contiguous block */
-	return userptr_add ( queue->qpl.data, gve_address ( queue, index ) );
+	return ( queue->qpl.data + gve_address ( queue, index ) );
 }
 
 /**
diff --git a/src/image/gzip.c b/src/image/gzip.c
index 98376e113..116d912d7 100644
--- a/src/image/gzip.c
+++ b/src/image/gzip.c
@@ -111,7 +111,7 @@ static int gzip_extract ( struct image *image, struct image *extracted ) {
 	}
 
 	/* Initialise input chunk */
-	deflate_chunk_init ( &in, userptr_add ( image->data, offset ), 0, len );
+	deflate_chunk_init ( &in, ( image->data + offset ), 0, len );
 
 	/* Presize extracted image */
 	if ( ( rc = image_set_len ( extracted,
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index 1e31afd9c..790c75123 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -69,17 +69,6 @@ UACCESS_INLINE ( linux, user_to_virt ) ( userptr_t userptr, off_t offset ) {
 	return trivial_user_to_virt ( userptr, offset );
 }
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( linux, userptr_add ) ( userptr_t userptr, off_t offset ) {
-	return trivial_userptr_add ( userptr, offset );
-}
-
-static inline __always_inline off_t
-UACCESS_INLINE ( linux, userptr_diff ) ( userptr_t userptr,
-					 userptr_t subtrahend ) {
-	return trivial_userptr_diff ( userptr, subtrahend );
-}
-
 static inline __always_inline void
 UACCESS_INLINE ( linux, memcpy_user ) ( userptr_t dest, off_t dest_off,
 					userptr_t src, off_t src_off,
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 1790e4066..93dc60d62 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -65,30 +65,6 @@ trivial_user_to_virt ( userptr_t userptr, off_t offset ) {
 	return ( ( void * ) userptr + offset );
 }
 
-/**
- * Add offset to user pointer
- *
- * @v userptr		User pointer
- * @v offset		Offset
- * @ret userptr		New pointer value
- */
-static inline __always_inline userptr_t
-trivial_userptr_add ( userptr_t userptr, off_t offset ) {
-	return ( userptr + offset );
-}
-
-/**
- * Subtract user pointers
- *
- * @v userptr		User pointer
- * @v subtrahend	User pointer to be subtracted
- * @ret offset		Offset
- */
-static inline __always_inline off_t
-trivial_userptr_diff ( userptr_t userptr, userptr_t subtrahend ) {
-	return ( userptr - subtrahend );
-}
-
 /**
  * Copy data between user buffers
  *
@@ -231,17 +207,6 @@ UACCESS_INLINE ( flat, user_to_virt ) ( userptr_t userptr, off_t offset ) {
 	return trivial_user_to_virt ( userptr, offset );
 }
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( flat, userptr_add ) ( userptr_t userptr, off_t offset ) {
-	return trivial_userptr_add ( userptr, offset );
-}
-
-static inline __always_inline off_t
-UACCESS_INLINE ( flat, userptr_diff ) ( userptr_t userptr,
-					userptr_t subtrahend ) {
-	return trivial_userptr_diff ( userptr, subtrahend );
-}
-
 static inline __always_inline void
 UACCESS_INLINE ( flat, memcpy_user ) ( userptr_t dest, off_t dest_off,
 				       userptr_t src, off_t src_off,
@@ -322,24 +287,6 @@ userptr_t virt_to_user ( volatile const void *addr );
  */
 void * user_to_virt ( userptr_t userptr, off_t offset );
 
-/**
- * Add offset to user pointer
- *
- * @v userptr		User pointer
- * @v offset		Offset
- * @ret userptr		New pointer value
- */
-userptr_t userptr_add ( userptr_t userptr, off_t offset );
-
-/**
- * Subtract user pointers
- *
- * @v userptr		User pointer
- * @v subtrahend	User pointer to be subtracted
- * @ret offset		Offset
- */
-off_t userptr_diff ( userptr_t userptr, userptr_t subtrahend );
-
 /**
  * Convert virtual address to a physical address
  *
diff --git a/src/interface/linux/linux_uaccess.c b/src/interface/linux/linux_uaccess.c
index ea2d8057c..9fc99c5e2 100644
--- a/src/interface/linux/linux_uaccess.c
+++ b/src/interface/linux/linux_uaccess.c
@@ -30,7 +30,6 @@ FILE_LICENCE(GPL2_OR_LATER);
 PROVIDE_UACCESS_INLINE(linux, user_to_phys);
 PROVIDE_UACCESS_INLINE(linux, virt_to_user);
 PROVIDE_UACCESS_INLINE(linux, user_to_virt);
-PROVIDE_UACCESS_INLINE(linux, userptr_add);
 PROVIDE_UACCESS_INLINE(linux, memcpy_user);
 PROVIDE_UACCESS_INLINE(linux, memmove_user);
 PROVIDE_UACCESS_INLINE(linux, memset_user);
-- 
cgit v1.2.3-55-g7522


From 89fe7886897be76ed902317e311d60ae654057aa Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Sun, 20 Apr 2025 18:29:48 +0100
Subject: [uaccess] Remove redundant memcpy_user() and related string functions

The memcpy_user(), memmove_user(), memcmp_user(), memset_user(), and
strlen_user() functions are now just straightforward wrappers around
the corresponding standard library functions.

Remove these redundant wrappers.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/runtime.c                    |   2 +-
 src/arch/x86/image/bzimage.c                   |  13 +-
 src/arch/x86/image/com32.c                     |   2 +-
 src/arch/x86/image/comboot.c                   |   4 +-
 src/arch/x86/image/initrd.c                    |  12 +-
 src/arch/x86/image/multiboot.c                 |   6 +-
 src/arch/x86/image/nbi.c                       |   2 +-
 src/arch/x86/image/pxe_image.c                 |   2 +-
 src/arch/x86/image/sdi.c                       |   4 +-
 src/arch/x86/image/ucode.c                     |   2 +-
 src/arch/x86/include/librm.h                   |  32 -----
 src/arch/x86/interface/pcbios/memtop_umalloc.c |   4 +-
 src/arch/x86/interface/pxe/pxe_file.c          |   6 +-
 src/arch/x86/interface/syslinux/com32_call.c   |  20 ++-
 src/arch/x86/interface/syslinux/comboot_call.c |  20 +--
 src/arch/x86/transitions/librm_mgmt.c          |   8 +-
 src/core/fbcon.c                               |  24 ++--
 src/core/image.c                               |   2 +-
 src/core/uaccess.c                             |   4 -
 src/crypto/deflate.c                           |   4 +-
 src/drivers/net/exanic.c                       |   2 +-
 src/drivers/net/gve.c                          |   2 +-
 src/drivers/usb/xhci.c                         |   2 +-
 src/image/elf.c                                |   2 +-
 src/image/segment.c                            |   2 +-
 src/include/ipxe/linux/linux_uaccess.h         |  32 -----
 src/include/ipxe/uaccess.h                     | 166 +------------------------
 src/interface/efi/efi_fbcon.c                  |   4 +-
 src/interface/efi/efi_umalloc.c                |   4 +-
 src/interface/linux/linux_uaccess.c            |   4 -
 src/interface/smbios/smbios.c                  |   2 +-
 src/tests/cms_test.c                           |   4 +-
 src/tests/gzip_test.c                          |   5 +-
 src/tests/pixbuf_test.c                        |   5 +-
 src/tests/zlib_test.c                          |   5 +-
 35 files changed, 83 insertions(+), 331 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/runtime.c b/src/arch/x86/core/runtime.c
index 02072b5bf..2b803f772 100644
--- a/src/arch/x86/core/runtime.c
+++ b/src/arch/x86/core/runtime.c
@@ -125,7 +125,7 @@ static int cmdline_init ( void ) {
 		return 0;
 	}
 	cmdline_user = phys_to_user ( cmdline_phys );
-	len = ( strlen_user ( cmdline_user, 0 ) + 1 /* NUL */ );
+	len = ( strlen ( cmdline_user ) + 1 /* NUL */ );
 
 	/* Allocate and copy command line */
 	cmdline_copy = malloc ( len );
diff --git a/src/arch/x86/image/bzimage.c b/src/arch/x86/image/bzimage.c
index d00b9f155..29ebeb507 100644
--- a/src/arch/x86/image/bzimage.c
+++ b/src/arch/x86/image/bzimage.c
@@ -369,8 +369,8 @@ static size_t bzimage_load_initrd ( struct image *image,
 
 	/* Copy in initrd image body and construct any cpio headers */
 	if ( address ) {
-		memmove_user ( address, len, initrd->data, 0, initrd->len );
-		memset_user ( address, 0, 0, len );
+		memmove ( ( address + len ), initrd->data, initrd->len );
+		memset ( address, 0, len );
 		offset = 0;
 		for ( i = 0 ; ( cpio_len = cpio_header ( initrd, i, &cpio ) ) ;
 		      i++ ) {
@@ -395,7 +395,7 @@ static size_t bzimage_load_initrd ( struct image *image,
 	/* Zero-pad to next INITRD_ALIGN boundary */
 	pad_len = ( ( -len ) & ( INITRD_ALIGN - 1 ) );
 	if ( address )
-		memset_user ( address, len, 0, pad_len );
+		memset ( ( address + len ), 0, pad_len );
 
 	return len;
 }
@@ -562,10 +562,9 @@ static int bzimage_exec ( struct image *image ) {
 	unregister_image ( image_get ( image ) );
 
 	/* Load segments */
-	memcpy_user ( bzimg.rm_kernel, 0, image->data,
-		      0, bzimg.rm_filesz );
-	memcpy_user ( bzimg.pm_kernel, 0, image->data,
-		      bzimg.rm_filesz, bzimg.pm_sz );
+	memcpy ( bzimg.rm_kernel, image->data, bzimg.rm_filesz );
+	memcpy ( bzimg.pm_kernel, ( image->data + bzimg.rm_filesz ),
+		 bzimg.pm_sz );
 
 	/* Store command line */
 	bzimage_set_cmdline ( image, &bzimg );
diff --git a/src/arch/x86/image/com32.c b/src/arch/x86/image/com32.c
index 6f0e66041..3e38215cb 100644
--- a/src/arch/x86/image/com32.c
+++ b/src/arch/x86/image/com32.c
@@ -219,7 +219,7 @@ static int com32_load_image ( struct image *image ) {
 	}
 
 	/* Copy image to segment */
-	memcpy_user ( buffer, 0, image->data, 0, filesz );
+	memcpy ( buffer, image->data, filesz );
 
 	return 0;
 }
diff --git a/src/arch/x86/image/comboot.c b/src/arch/x86/image/comboot.c
index 9a847f0ff..8609eb0f7 100644
--- a/src/arch/x86/image/comboot.c
+++ b/src/arch/x86/image/comboot.c
@@ -267,10 +267,10 @@ static int comboot_prepare_segment ( struct image *image )
 	}
 
 	/* Zero PSP */
-	memset_user ( seg_userptr, 0, 0, 0x100 );
+	memset ( seg_userptr, 0, 0x100 );
 
 	/* Copy image to segment:0100 */
-	memcpy_user ( seg_userptr, 0x100, image->data, 0, image->len );
+	memcpy ( ( seg_userptr + 0x100 ), image->data, image->len );
 
 	return 0;
 }
diff --git a/src/arch/x86/image/initrd.c b/src/arch/x86/image/initrd.c
index e32e40341..95f12d804 100644
--- a/src/arch/x86/image/initrd.c
+++ b/src/arch/x86/image/initrd.c
@@ -80,7 +80,7 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 		       user_to_phys ( highest->data, highest->len ),
 		       user_to_phys ( current, 0 ),
 		       user_to_phys ( current, highest->len ) );
-		memmove_user ( current, 0, highest->data, 0, highest->len );
+		memmove ( current, highest->data, highest->len );
 		highest->data = current;
 	}
 
@@ -96,8 +96,7 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 			       user_to_phys ( initrd->data, initrd->len ),
 			       user_to_phys ( current, 0 ),
 			       user_to_phys ( current, initrd->len ) );
-			memcpy_user ( current, 0, initrd->data, 0,
-				      initrd->len );
+			memcpy ( current, initrd->data, initrd->len );
 			initrd->data = current;
 		}
 	}
@@ -140,9 +139,10 @@ static void initrd_swap ( struct image *low, struct image *high,
 			    ~( INITRD_ALIGN - 1 ) );
 
 		/* Swap fragments */
-		memcpy_user ( free, 0, high->data, len, frag_len );
-		memmove_user ( low->data, new_len, low->data, len, low->len );
-		memcpy_user ( low->data, len, free, 0, frag_len );
+		memcpy ( free, ( high->data + len ), frag_len );
+		memmove ( ( low->data + new_len ), ( low->data + len ),
+			  low->len );
+		memcpy ( ( low->data + len ), free, frag_len );
 		len = new_len;
 	}
 
diff --git a/src/arch/x86/image/multiboot.c b/src/arch/x86/image/multiboot.c
index cada021ab..fe21f1f1a 100644
--- a/src/arch/x86/image/multiboot.c
+++ b/src/arch/x86/image/multiboot.c
@@ -222,8 +222,8 @@ static int multiboot_add_modules ( struct image *image, physaddr_t start,
 		}
 
 		/* Copy module */
-		memcpy_user ( phys_to_user ( start ), 0,
-			      module_image->data, 0, module_image->len );
+		memcpy ( phys_to_user ( start ), module_image->data,
+			 module_image->len );
 
 		/* Add module to list */
 		module = &modules[mbinfo->mods_count++];
@@ -350,7 +350,7 @@ static int multiboot_load_raw ( struct image *image,
 	}
 
 	/* Copy image to segment */
-	memcpy_user ( buffer, 0, image->data, offset, filesz );
+	memcpy ( buffer, ( image->data + offset ), filesz );
 
 	/* Record execution entry point and maximum used address */
 	*entry = hdr->mb.entry_addr;
diff --git a/src/arch/x86/image/nbi.c b/src/arch/x86/image/nbi.c
index 2f0d3164a..0b02a8985 100644
--- a/src/arch/x86/image/nbi.c
+++ b/src/arch/x86/image/nbi.c
@@ -131,7 +131,7 @@ static int nbi_prepare_segment ( struct image *image, size_t offset __unused,
 static int nbi_load_segment ( struct image *image, size_t offset,
 			      userptr_t dest, size_t filesz,
 			      size_t memsz __unused ) {
-	memcpy_user ( dest, 0, image->data, offset, filesz );
+	memcpy ( dest, ( image->data + offset ), filesz );
 	return 0;
 }
 
diff --git a/src/arch/x86/image/pxe_image.c b/src/arch/x86/image/pxe_image.c
index b6bcb18b4..bdce165ca 100644
--- a/src/arch/x86/image/pxe_image.c
+++ b/src/arch/x86/image/pxe_image.c
@@ -66,7 +66,7 @@ static int pxe_exec ( struct image *image ) {
 	}
 
 	/* Copy image to segment */
-	memcpy_user ( buffer, 0, image->data, 0, image->len );
+	memcpy ( buffer, image->data, image->len );
 
 	/* Arbitrarily pick the most recently opened network device */
 	if ( ( netdev = last_opened_netdev() ) == NULL ) {
diff --git a/src/arch/x86/image/sdi.c b/src/arch/x86/image/sdi.c
index fa2d0b73f..5bb5a7569 100644
--- a/src/arch/x86/image/sdi.c
+++ b/src/arch/x86/image/sdi.c
@@ -97,8 +97,8 @@ static int sdi_exec ( struct image *image ) {
 	       user_to_phys ( image->data, sdi.boot_offset ), sdi.boot_size );
 
 	/* Copy boot code */
-	memcpy_user ( real_to_user ( SDI_BOOT_SEG, SDI_BOOT_OFF ), 0,
-		      image->data, sdi.boot_offset, sdi.boot_size );
+	memcpy ( real_to_user ( SDI_BOOT_SEG, SDI_BOOT_OFF ),
+		 ( image->data + sdi.boot_offset ), sdi.boot_size );
 
 	/* Jump to boot code */
 	sdiptr = ( user_to_phys ( image->data, 0 ) | SDI_WTF );
diff --git a/src/arch/x86/image/ucode.c b/src/arch/x86/image/ucode.c
index 499c0a940..9b6b5067a 100644
--- a/src/arch/x86/image/ucode.c
+++ b/src/arch/x86/image/ucode.c
@@ -256,7 +256,7 @@ static int ucode_update_all ( struct image *image,
 		rc = -ENOMEM;
 		goto err_alloc;
 	}
-	memset_user ( status, 0, 0, len );
+	memset ( status, 0, len );
 
 	/* Construct control structure */
 	memset ( &control, 0, sizeof ( control ) );
diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index c0d910287..c117a8b5c 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -137,38 +137,6 @@ UACCESS_INLINE ( librm, user_to_virt ) ( userptr_t userptr, off_t offset ) {
 	return trivial_user_to_virt ( userptr, offset );
 }
 
-static inline __always_inline void
-UACCESS_INLINE ( librm, memcpy_user ) ( userptr_t dest, off_t dest_off,
-					userptr_t src, off_t src_off,
-					size_t len ) {
-	trivial_memcpy_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( librm, memmove_user ) ( userptr_t dest, off_t dest_off,
-					 userptr_t src, off_t src_off,
-					 size_t len ) {
-	trivial_memmove_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline int
-UACCESS_INLINE ( librm, memcmp_user ) ( userptr_t first, off_t first_off,
-					userptr_t second, off_t second_off,
-					size_t len ) {
-	return trivial_memcmp_user ( first, first_off, second, second_off, len);
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( librm, memset_user ) ( userptr_t buffer, off_t offset,
-					int c, size_t len ) {
-	trivial_memset_user ( buffer, offset, c, len );
-}
-
-static inline __always_inline size_t
-UACCESS_INLINE ( librm, strlen_user ) ( userptr_t buffer, off_t offset ) {
-	return trivial_strlen_user ( buffer, offset );
-}
-
 static inline __always_inline off_t
 UACCESS_INLINE ( librm, memchr_user ) ( userptr_t buffer, off_t offset,
 					int c, size_t len ) {
diff --git a/src/arch/x86/interface/pcbios/memtop_umalloc.c b/src/arch/x86/interface/pcbios/memtop_umalloc.c
index e76b3df93..8239b23b8 100644
--- a/src/arch/x86/interface/pcbios/memtop_umalloc.c
+++ b/src/arch/x86/interface/pcbios/memtop_umalloc.c
@@ -203,8 +203,8 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 		      user_to_phys ( ptr, extmem.size ),
 		      user_to_phys ( new, 0 ),
 		      user_to_phys ( new, new_size ));
-		memmove_user ( new, 0, ptr, 0, ( ( extmem.size < new_size ) ?
-						 extmem.size : new_size ) );
+		memmove ( new, ptr, ( ( extmem.size < new_size ) ?
+				      extmem.size : new_size ) );
 		bottom = new;
 		heap_size -= ( new_size - extmem.size );
 		extmem.size = new_size;
diff --git a/src/arch/x86/interface/pxe/pxe_file.c b/src/arch/x86/interface/pxe/pxe_file.c
index 456ffb5fd..1235520de 100644
--- a/src/arch/x86/interface/pxe/pxe_file.c
+++ b/src/arch/x86/interface/pxe/pxe_file.c
@@ -61,8 +61,8 @@ static PXENV_EXIT_t pxenv_file_open ( struct s_PXENV_FILE_OPEN *file_open ) {
 
 	/* Copy name from external program, and open it */
 	filename = real_to_user ( file_open->FileName.segment,
-			      file_open->FileName.offset );
-	filename_len = strlen_user ( filename, 0 );
+				  file_open->FileName.offset );
+	filename_len = strlen ( filename );
 	{
 		char uri_string[ filename_len + 1 ];
 
@@ -219,7 +219,7 @@ static PXENV_EXIT_t pxenv_file_exec ( struct s_PXENV_FILE_EXEC *file_exec ) {
 	/* Copy name from external program, and exec it */
 	command = real_to_user ( file_exec->Command.segment,
 				 file_exec->Command.offset );
-	command_len = strlen_user ( command, 0 );
+	command_len = strlen ( command );
 	{
 		char command_string[ command_len + 1 ];
 
diff --git a/src/arch/x86/interface/syslinux/com32_call.c b/src/arch/x86/interface/syslinux/com32_call.c
index 19fdbaff9..da9d6491a 100644
--- a/src/arch/x86/interface/syslinux/com32_call.c
+++ b/src/arch/x86/interface/syslinux/com32_call.c
@@ -49,9 +49,8 @@ void __asmcall com32_intcall ( uint8_t interrupt, physaddr_t inregs_phys, physad
 	DBGC ( &com32_regs, "COM32 INT%x in %#08lx out %#08lx\n",
 	       interrupt, inregs_phys, outregs_phys );
 
-	memcpy_user ( virt_to_user( &com32_regs ), 0,
-	              phys_to_user ( inregs_phys ), 0,
-	              sizeof(com32sys_t) );
+	memcpy ( virt_to_user( &com32_regs ), phys_to_user ( inregs_phys ),
+		 sizeof ( com32sys_t ) );
 
 	com32_int_vector = interrupt;
 
@@ -108,9 +107,8 @@ void __asmcall com32_intcall ( uint8_t interrupt, physaddr_t inregs_phys, physad
 		            : : );
 
 	if ( outregs_phys ) {
-		memcpy_user ( phys_to_user ( outregs_phys ), 0,
-		              virt_to_user( &com32_regs ), 0,
-		              sizeof(com32sys_t) );
+		memcpy ( phys_to_user ( outregs_phys ),
+			 virt_to_user ( &com32_regs ), sizeof ( com32sys_t ) );
 	}
 }
 
@@ -122,9 +120,8 @@ void __asmcall com32_farcall ( uint32_t proc, physaddr_t inregs_phys, physaddr_t
 	DBGC ( &com32_regs, "COM32 farcall %04x:%04x in %#08lx out %#08lx\n",
 	       ( proc >> 16 ), ( proc & 0xffff ), inregs_phys, outregs_phys );
 
-	memcpy_user ( virt_to_user( &com32_regs ), 0,
-	              phys_to_user ( inregs_phys ), 0,
-	              sizeof(com32sys_t) );
+	memcpy ( virt_to_user( &com32_regs ), phys_to_user ( inregs_phys ),
+		 sizeof ( com32sys_t ) );
 
 	com32_farcall_proc = proc;
 
@@ -170,9 +167,8 @@ void __asmcall com32_farcall ( uint32_t proc, physaddr_t inregs_phys, physaddr_t
 		            : : );
 
 	if ( outregs_phys ) {
-		memcpy_user ( phys_to_user ( outregs_phys ), 0,
-		              virt_to_user( &com32_regs ), 0,
-		              sizeof(com32sys_t) );
+		memcpy ( phys_to_user ( outregs_phys ),
+			 virt_to_user ( &com32_regs ), sizeof ( com32sys_t ) );
 	}
 }
 
diff --git a/src/arch/x86/interface/syslinux/comboot_call.c b/src/arch/x86/interface/syslinux/comboot_call.c
index b75e8ef7c..f26fcad0a 100644
--- a/src/arch/x86/interface/syslinux/comboot_call.c
+++ b/src/arch/x86/interface/syslinux/comboot_call.c
@@ -119,7 +119,7 @@ static void shuffle ( unsigned int list_segment, unsigned int list_offset, unsig
 
 		if ( shuf[ i ].src == 0xFFFFFFFF ) {
 			/* Fill with 0 instead of copying */
-			memset_user ( dest_u, 0, 0, shuf[ i ].len );
+			memset ( dest_u, 0, shuf[ i ].len );
 		} else if ( shuf[ i ].dest == 0xFFFFFFFF ) {
 			/* Copy new list of descriptors */
 			count = shuf[ i ].len / sizeof( comboot_shuffle_descriptor );
@@ -128,7 +128,7 @@ static void shuffle ( unsigned int list_segment, unsigned int list_offset, unsig
 			i = -1;
 		} else {
 			/* Regular copy */
-			memmove_user ( dest_u, 0, src_u, 0, shuf[ i ].len );
+			memmove ( dest_u, src_u, shuf[ i ].len );
 		}
 	}
 }
@@ -347,7 +347,7 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 	case 0x0003: /* Run command */
 		{
 			userptr_t cmd_u = real_to_user ( ix86->segs.es, ix86->regs.bx );
-			int len = strlen_user ( cmd_u, 0 );
+			int len = strlen ( cmd_u );
 			char cmd[len + 1];
 			copy_from_user ( cmd, cmd_u, 0, len + 1 );
 			DBG ( "COMBOOT: executing command '%s'\n", cmd );
@@ -371,7 +371,7 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 		{
 			int fd;
 			userptr_t file_u = real_to_user ( ix86->segs.es, ix86->regs.si );
-			int len = strlen_user ( file_u, 0 );
+			int len = strlen ( file_u );
 			char file[len + 1];
 
 			copy_from_user ( file, file_u, 0, len + 1 );
@@ -484,7 +484,7 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 	case 0x0010: /* Resolve hostname */
 		{
 			userptr_t hostname_u = real_to_user ( ix86->segs.es, ix86->regs.bx );
-			int len = strlen_user ( hostname_u, 0 );
+			int len = strlen ( hostname_u );
 			char hostname[len];
 			struct in_addr addr;
 
@@ -551,8 +551,8 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 		{
 			userptr_t file_u = real_to_user ( ix86->segs.ds, ix86->regs.si );
 			userptr_t cmd_u = real_to_user ( ix86->segs.es, ix86->regs.bx );
-			int file_len = strlen_user ( file_u, 0 );
-			int cmd_len = strlen_user ( cmd_u, 0 );
+			int file_len = strlen ( file_u );
+			int cmd_len = strlen ( cmd_u );
 			char file[file_len + 1];
 			char cmd[cmd_len + 1];
 
@@ -595,9 +595,9 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 		shuffle ( ix86->segs.es, ix86->regs.di, ix86->regs.cx );
 
 		/* Copy initial register values to .text16 */
-		memcpy_user ( real_to_user ( rm_cs, (unsigned) __from_text16 ( &comboot_initial_regs ) ), 0,
-		              real_to_user ( ix86->segs.ds, ix86->regs.si ), 0,
-		              sizeof(syslinux_rm_regs) );
+		memcpy ( real_to_user ( rm_cs, (unsigned) __from_text16 ( &comboot_initial_regs ) ),
+			 real_to_user ( ix86->segs.ds, ix86->regs.si ),
+			 sizeof(syslinux_rm_regs) );
 
 		/* Load initial register values */
 		__asm__ __volatile__ (
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index ec31fceb1..7ebf62137 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -69,7 +69,7 @@ uint16_t copy_user_to_rm_stack ( userptr_t data, size_t size ) {
 	userptr_t rm_stack;
 	rm_sp -= size;
 	rm_stack = real_to_user ( rm_ss, rm_sp );
-	memcpy_user ( rm_stack, 0, data, 0, size );
+	memcpy ( rm_stack, data, size );
 	return rm_sp;
 };
 
@@ -83,7 +83,7 @@ uint16_t copy_user_to_rm_stack ( userptr_t data, size_t size ) {
 void remove_user_from_rm_stack ( userptr_t data, size_t size ) {
 	if ( data ) {
 		userptr_t rm_stack = real_to_user ( rm_ss, rm_sp );
-		memcpy_user ( rm_stack, 0, data, 0, size );
+		memcpy ( rm_stack, data, size );
 	}
 	rm_sp += size;
 };
@@ -432,10 +432,6 @@ PROVIDE_UACCESS_INLINE ( librm, phys_to_user );
 PROVIDE_UACCESS_INLINE ( librm, user_to_phys );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_user );
 PROVIDE_UACCESS_INLINE ( librm, user_to_virt );
-PROVIDE_UACCESS_INLINE ( librm, memcpy_user );
-PROVIDE_UACCESS_INLINE ( librm, memmove_user );
-PROVIDE_UACCESS_INLINE ( librm, memset_user );
-PROVIDE_UACCESS_INLINE ( librm, strlen_user );
 PROVIDE_UACCESS_INLINE ( librm, memchr_user );
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
 PROVIDE_IOMAP ( pages, ioremap, ioremap_pages );
diff --git a/src/core/fbcon.c b/src/core/fbcon.c
index ff3132ac7..8d05484e2 100644
--- a/src/core/fbcon.c
+++ b/src/core/fbcon.c
@@ -185,12 +185,12 @@ static void fbcon_draw ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
 		/* Draw background picture, if applicable */
 		if ( transparent ) {
 			if ( fbcon->picture.start ) {
-				memcpy_user ( fbcon->start, offset,
-					      fbcon->picture.start, offset,
-					      fbcon->character.len );
+				memcpy ( ( fbcon->start + offset ),
+					 ( fbcon->picture.start + offset ),
+					 fbcon->character.len );
 			} else {
-				memset_user ( fbcon->start, offset, 0,
-					      fbcon->character.len );
+				memset ( ( fbcon->start + offset ), 0,
+					 fbcon->character.len );
 			}
 		}
 
@@ -247,8 +247,8 @@ static void fbcon_scroll ( struct fbcon *fbcon ) {
 
 	/* Scroll up character array */
 	row_len = ( fbcon->character.width * sizeof ( struct fbcon_text_cell ));
-	memmove_user ( fbcon->text.start, 0, fbcon->text.start, row_len,
-		       ( row_len * ( fbcon->character.height - 1 ) ) );
+	memmove ( fbcon->text.start, ( fbcon->text.start + row_len ),
+		  ( row_len * ( fbcon->character.height - 1 ) ) );
 	fbcon_clear ( fbcon, ( fbcon->character.height - 1 ) );
 
 	/* Update cursor position */
@@ -552,7 +552,7 @@ static int fbcon_picture_init ( struct fbcon *fbcon,
 	       ( ygap + pixbuf->height ) );
 
 	/* Convert to frame buffer raw format */
-	memset_user ( picture->start, 0, 0, len );
+	memset ( picture->start, 0, len );
 	for ( y = 0 ; y < height ; y++ ) {
 		offset = ( indent + ( y * pixel->stride ) );
 		pixbuf_offset = ( pixbuf_indent + ( y * pixbuf_stride ) );
@@ -684,7 +684,7 @@ int fbcon_init ( struct fbcon *fbcon, userptr_t start,
 	fbcon_clear ( fbcon, 0 );
 
 	/* Set framebuffer to all black (including margins) */
-	memset_user ( fbcon->start, 0, 0, fbcon->len );
+	memset ( fbcon->start, 0, fbcon->len );
 
 	/* Generate pixel buffer from background image, if applicable */
 	if ( config->pixbuf &&
@@ -692,10 +692,8 @@ int fbcon_init ( struct fbcon *fbcon, userptr_t start,
 		goto err_picture;
 
 	/* Draw background picture (including margins), if applicable */
-	if ( fbcon->picture.start ) {
-		memcpy_user ( fbcon->start, 0, fbcon->picture.start, 0,
-			      fbcon->len );
-	}
+	if ( fbcon->picture.start )
+		memcpy ( fbcon->start, fbcon->picture.start, fbcon->len );
 
 	/* Update console width and height */
 	console_set_size ( fbcon->character.width, fbcon->character.height );
diff --git a/src/core/image.c b/src/core/image.c
index c69c05c93..709d0da9c 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -246,7 +246,7 @@ int image_set_data ( struct image *image, userptr_t data, size_t len ) {
 		return rc;
 
 	/* Copy in new image data */
-	memcpy_user ( image->data, 0, data, 0, len );
+	memcpy ( image->data, data, len );
 
 	return 0;
 }
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index ad17a58ab..01089e6fa 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -36,8 +36,4 @@ PROVIDE_UACCESS_INLINE ( flat, phys_to_user );
 PROVIDE_UACCESS_INLINE ( flat, user_to_phys );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
 PROVIDE_UACCESS_INLINE ( flat, user_to_virt );
-PROVIDE_UACCESS_INLINE ( flat, memcpy_user );
-PROVIDE_UACCESS_INLINE ( flat, memmove_user );
-PROVIDE_UACCESS_INLINE ( flat, memset_user );
-PROVIDE_UACCESS_INLINE ( flat, strlen_user );
 PROVIDE_UACCESS_INLINE ( flat, memchr_user );
diff --git a/src/crypto/deflate.c b/src/crypto/deflate.c
index 7ad39ec1b..c6cce7516 100644
--- a/src/crypto/deflate.c
+++ b/src/crypto/deflate.c
@@ -464,8 +464,8 @@ static void deflate_copy ( struct deflate_chunk *out,
 		if ( copy_len > len )
 			copy_len = len;
 		while ( copy_len-- ) {
-			memcpy_user ( out->data, out_offset++,
-				      start, offset++, 1 );
+			memcpy ( ( out->data + out_offset++ ),
+				 ( start + offset++ ), 1 );
 		}
 	}
 	out->offset += len;
diff --git a/src/drivers/net/exanic.c b/src/drivers/net/exanic.c
index aaa6a28a1..14a17df47 100644
--- a/src/drivers/net/exanic.c
+++ b/src/drivers/net/exanic.c
@@ -395,7 +395,7 @@ static int exanic_open ( struct net_device *netdev ) {
 	}
 
 	/* Reset receive region contents */
-	memset_user ( port->rx, 0, 0xff, EXANIC_RX_LEN );
+	memset ( port->rx, 0xff, EXANIC_RX_LEN );
 
 	/* Reset transmit feedback region */
 	*(port->txf) = 0;
diff --git a/src/drivers/net/gve.c b/src/drivers/net/gve.c
index 805feee3d..2cbc401f5 100644
--- a/src/drivers/net/gve.c
+++ b/src/drivers/net/gve.c
@@ -980,7 +980,7 @@ static int gve_start ( struct gve_nic *gve ) {
 	}
 
 	/* Invalidate receive completions */
-	memset_user ( rx->cmplt, 0, 0, ( rx->count * rx->type->cmplt_len ) );
+	memset ( rx->cmplt, 0, ( rx->count * rx->type->cmplt_len ) );
 
 	/* Reset receive sequence */
 	gve->seq = gve_next ( 0 );
diff --git a/src/drivers/usb/xhci.c b/src/drivers/usb/xhci.c
index 3247ee69c..f244086ce 100644
--- a/src/drivers/usb/xhci.c
+++ b/src/drivers/usb/xhci.c
@@ -1000,7 +1000,7 @@ static int xhci_scratchpad_alloc ( struct xhci_device *xhci ) {
 		rc = -ENOMEM;
 		goto err_alloc;
 	}
-	memset_user ( scratch->buffer, 0, 0, buffer_len );
+	memset ( scratch->buffer, 0, buffer_len );
 
 	/* Allocate scratchpad array */
 	array_len = ( scratch->count * sizeof ( scratch->array[0] ) );
diff --git a/src/image/elf.c b/src/image/elf.c
index 5c2f9db25..46c9fe8eb 100644
--- a/src/image/elf.c
+++ b/src/image/elf.c
@@ -66,7 +66,7 @@ static int elf_load_segment ( struct image *image, Elf_Phdr *phdr,
 	}
 
 	/* Copy image to segment */
-	memcpy_user ( buffer, 0, image->data, phdr->p_offset, phdr->p_filesz );
+	memcpy ( buffer, ( image->data + phdr->p_offset ), phdr->p_filesz );
 
 	return 0;
 }
diff --git a/src/image/segment.c b/src/image/segment.c
index 2d0f2f0fc..b7f8ef56c 100644
--- a/src/image/segment.c
+++ b/src/image/segment.c
@@ -83,7 +83,7 @@ int prep_segment ( userptr_t segment, size_t filesz, size_t memsz ) {
 		if ( ( start >= memmap.regions[i].start ) &&
 		     ( end <= memmap.regions[i].end ) ) {
 			/* Found valid region: zero bss and return */
-			memset_user ( segment, filesz, 0, ( memsz - filesz ) );
+			memset ( ( segment + filesz ), 0, ( memsz - filesz ) );
 			return 0;
 		}
 	}
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index 790c75123..0c680c08f 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -69,38 +69,6 @@ UACCESS_INLINE ( linux, user_to_virt ) ( userptr_t userptr, off_t offset ) {
 	return trivial_user_to_virt ( userptr, offset );
 }
 
-static inline __always_inline void
-UACCESS_INLINE ( linux, memcpy_user ) ( userptr_t dest, off_t dest_off,
-					userptr_t src, off_t src_off,
-					size_t len ) {
-	trivial_memcpy_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( linux, memmove_user ) ( userptr_t dest, off_t dest_off,
-					 userptr_t src, off_t src_off,
-					 size_t len ) {
-	trivial_memmove_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline int
-UACCESS_INLINE ( linux, memcmp_user ) ( userptr_t first, off_t first_off,
-					userptr_t second, off_t second_off,
-					size_t len ) {
-	return trivial_memcmp_user ( first, first_off, second, second_off, len);
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( linux, memset_user ) ( userptr_t buffer, off_t offset,
-					int c, size_t len ) {
-	trivial_memset_user ( buffer, offset, c, len );
-}
-
-static inline __always_inline size_t
-UACCESS_INLINE ( linux, strlen_user ) ( userptr_t buffer, off_t offset ) {
-	return trivial_strlen_user ( buffer, offset );
-}
-
 static inline __always_inline off_t
 UACCESS_INLINE ( linux, memchr_user ) ( userptr_t buffer, off_t offset,
 					int c, size_t len ) {
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 93dc60d62..e84ca3eae 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -65,80 +65,6 @@ trivial_user_to_virt ( userptr_t userptr, off_t offset ) {
 	return ( ( void * ) userptr + offset );
 }
 
-/**
- * Copy data between user buffers
- *
- * @v dest		Destination
- * @v dest_off		Destination offset
- * @v src		Source
- * @v src_off		Source offset
- * @v len		Length
- */
-static inline __always_inline void
-trivial_memcpy_user ( userptr_t dest, off_t dest_off,
-		      userptr_t src, off_t src_off, size_t len ) {
-	memcpy ( ( ( void * ) dest + dest_off ),
-		 ( ( void * ) src + src_off ), len );
-}
-
-/**
- * Copy data between user buffers, allowing for overlap
- *
- * @v dest		Destination
- * @v dest_off		Destination offset
- * @v src		Source
- * @v src_off		Source offset
- * @v len		Length
- */
-static inline __always_inline void
-trivial_memmove_user ( userptr_t dest, off_t dest_off,
-		       userptr_t src, off_t src_off, size_t len ) {
-	memmove ( ( ( void * ) dest + dest_off ),
-		  ( ( void * ) src + src_off ), len );
-}
-
-/**
- * Compare data between user buffers
- *
- * @v first		First buffer
- * @v first_off		First buffer offset
- * @v second		Second buffer
- * @v second_off	Second buffer offset
- * @v len		Length
- * @ret diff		Difference
- */
-static inline __always_inline int
-trivial_memcmp_user ( userptr_t first, off_t first_off,
-		      userptr_t second, off_t second_off, size_t len ) {
-	return memcmp ( ( ( void * ) first + first_off ),
-			( ( void * ) second + second_off ), len );
-}
-
-/**
- * Fill user buffer with a constant byte
- *
- * @v buffer		User buffer
- * @v offset		Offset within buffer
- * @v c			Constant byte with which to fill
- * @v len		Length
- */
-static inline __always_inline void
-trivial_memset_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
-	memset ( ( ( void * ) buffer + offset ), c, len );
-}
-
-/**
- * Find length of NUL-terminated string in user buffer
- *
- * @v buffer		User buffer
- * @v offset		Offset within buffer
- * @ret len		Length of string (excluding NUL)
- */
-static inline __always_inline size_t
-trivial_strlen_user ( userptr_t buffer, off_t offset ) {
-	return strlen ( ( void * ) buffer + offset );
-}
-
 /**
  * Find character in user buffer
  *
@@ -207,38 +133,6 @@ UACCESS_INLINE ( flat, user_to_virt ) ( userptr_t userptr, off_t offset ) {
 	return trivial_user_to_virt ( userptr, offset );
 }
 
-static inline __always_inline void
-UACCESS_INLINE ( flat, memcpy_user ) ( userptr_t dest, off_t dest_off,
-				       userptr_t src, off_t src_off,
-				       size_t len ) {
-	trivial_memcpy_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( flat, memmove_user ) ( userptr_t dest, off_t dest_off,
-					userptr_t src, off_t src_off,
-					size_t len ) {
-	trivial_memmove_user ( dest, dest_off, src, src_off, len );
-}
-
-static inline __always_inline int
-UACCESS_INLINE ( flat, memcmp_user ) ( userptr_t first, off_t first_off,
-				       userptr_t second, off_t second_off,
-				       size_t len ) {
-	return trivial_memcmp_user ( first, first_off, second, second_off, len);
-}
-
-static inline __always_inline void
-UACCESS_INLINE ( flat, memset_user ) ( userptr_t buffer, off_t offset,
-				       int c, size_t len ) {
-	trivial_memset_user ( buffer, offset, c, len );
-}
-
-static inline __always_inline size_t
-UACCESS_INLINE ( flat, strlen_user ) ( userptr_t buffer, off_t offset ) {
-	return trivial_strlen_user ( buffer, offset );
-}
-
 static inline __always_inline off_t
 UACCESS_INLINE ( flat, memchr_user ) ( userptr_t buffer, off_t offset,
 				       int c, size_t len ) {
@@ -310,18 +204,6 @@ static inline __always_inline void * phys_to_virt ( unsigned long phys_addr ) {
 	return user_to_virt ( phys_to_user ( phys_addr ), 0 );
 }
 
-/**
- * Copy data between user buffers
- *
- * @v dest		Destination
- * @v dest_off		Destination offset
- * @v src		Source
- * @v src_off		Source offset
- * @v len		Length
- */
-void memcpy_user ( userptr_t dest, off_t dest_off,
-		   userptr_t src, off_t src_off, size_t len );
-
 /**
  * Copy data to user buffer
  *
@@ -332,7 +214,7 @@ void memcpy_user ( userptr_t dest, off_t dest_off,
  */
 static inline __always_inline void
 copy_to_user ( userptr_t dest, off_t dest_off, const void *src, size_t len ) {
-	memcpy_user ( dest, dest_off, virt_to_user ( src ), 0, len );
+	memcpy ( ( dest + dest_off ), src, len );
 }
 
 /**
@@ -345,53 +227,9 @@ copy_to_user ( userptr_t dest, off_t dest_off, const void *src, size_t len ) {
  */
 static inline __always_inline void
 copy_from_user ( void *dest, userptr_t src, off_t src_off, size_t len ) {
-	memcpy_user ( virt_to_user ( dest ), 0, src, src_off, len );
+	memcpy ( dest, ( src + src_off ), len );
 }
 
-/**
- * Copy data between user buffers, allowing for overlap
- *
- * @v dest		Destination
- * @v dest_off		Destination offset
- * @v src		Source
- * @v src_off		Source offset
- * @v len		Length
- */
-void memmove_user ( userptr_t dest, off_t dest_off,
-		    userptr_t src, off_t src_off, size_t len );
-
-/**
- * Compare data between user buffers
- *
- * @v first		First buffer
- * @v first_off		First buffer offset
- * @v second		Second buffer
- * @v second_off	Second buffer offset
- * @v len		Length
- * @ret diff		Difference
- */
-int memcmp_user ( userptr_t first, off_t first_off,
-		  userptr_t second, off_t second_off, size_t len );
-
-/**
- * Fill user buffer with a constant byte
- *
- * @v userptr		User buffer
- * @v offset		Offset within buffer
- * @v c			Constant byte with which to fill
- * @v len		Length
- */
-void memset_user ( userptr_t userptr, off_t offset, int c, size_t len );
-
-/**
- * Find length of NUL-terminated string in user buffer
- *
- * @v userptr		User buffer
- * @v offset		Offset within buffer
- * @ret len		Length of string (excluding NUL)
- */
-size_t strlen_user ( userptr_t userptr, off_t offset );
-
 /**
  * Find character in user buffer
  *
diff --git a/src/interface/efi/efi_fbcon.c b/src/interface/efi/efi_fbcon.c
index d388e0317..659ebd37e 100644
--- a/src/interface/efi/efi_fbcon.c
+++ b/src/interface/efi/efi_fbcon.c
@@ -124,7 +124,7 @@ static int efifb_draw ( unsigned int character, unsigned int index,
 
 	/* Clear existing glyph */
 	offset = ( index * efifb.font.height );
-	memset_user ( efifb.glyphs, offset, 0, efifb.font.height );
+	memset ( ( efifb.glyphs + offset ), 0, efifb.font.height );
 
 	/* Get glyph */
 	blt = NULL;
@@ -296,7 +296,7 @@ static int efifb_glyphs ( void ) {
 		rc = -ENOMEM;
 		goto err_alloc;
 	}
-	memset_user ( efifb.glyphs, 0, 0, len );
+	memset ( efifb.glyphs, 0, len );
 
 	/* Get font data */
 	for ( character = 0 ; character < EFIFB_ASCII ; character++ ) {
diff --git a/src/interface/efi/efi_umalloc.c b/src/interface/efi/efi_umalloc.c
index 175ae367e..488c53f3d 100644
--- a/src/interface/efi/efi_umalloc.c
+++ b/src/interface/efi/efi_umalloc.c
@@ -87,8 +87,8 @@ static userptr_t efi_urealloc ( userptr_t old_ptr, size_t new_size ) {
 	if ( old_ptr && ( old_ptr != UNOWHERE ) ) {
 		copy_from_user ( &old_size, old_ptr, -EFI_PAGE_SIZE,
 				 sizeof ( old_size ) );
-		memcpy_user ( new_ptr, 0, old_ptr, 0,
-			      ( (old_size < new_size) ? old_size : new_size ));
+		memcpy ( new_ptr, old_ptr,
+			 ( (old_size < new_size) ? old_size : new_size ) );
 		old_pages = ( EFI_SIZE_TO_PAGES ( old_size ) + 1 );
 		phys_addr = user_to_phys ( old_ptr, -EFI_PAGE_SIZE );
 		if ( ( efirc = bs->FreePages ( phys_addr, old_pages ) ) != 0 ){
diff --git a/src/interface/linux/linux_uaccess.c b/src/interface/linux/linux_uaccess.c
index 9fc99c5e2..d777bf3dd 100644
--- a/src/interface/linux/linux_uaccess.c
+++ b/src/interface/linux/linux_uaccess.c
@@ -30,8 +30,4 @@ FILE_LICENCE(GPL2_OR_LATER);
 PROVIDE_UACCESS_INLINE(linux, user_to_phys);
 PROVIDE_UACCESS_INLINE(linux, virt_to_user);
 PROVIDE_UACCESS_INLINE(linux, user_to_virt);
-PROVIDE_UACCESS_INLINE(linux, memcpy_user);
-PROVIDE_UACCESS_INLINE(linux, memmove_user);
-PROVIDE_UACCESS_INLINE(linux, memset_user);
-PROVIDE_UACCESS_INLINE(linux, strlen_user);
 PROVIDE_UACCESS_INLINE(linux, memchr_user);
diff --git a/src/interface/smbios/smbios.c b/src/interface/smbios/smbios.c
index fdd14499f..3e69a0c15 100644
--- a/src/interface/smbios/smbios.c
+++ b/src/interface/smbios/smbios.c
@@ -277,7 +277,7 @@ int read_smbios_string ( struct smbios_structure *structure,
 		 * smbios_strings struct is constructed so as to
 		 * always end on a string boundary.
 		 */
-		string_len = strlen_user ( smbios.address, offset );
+		string_len = strlen ( smbios.address + offset );
 		if ( --index == 0 ) {
 			/* Copy string, truncating as necessary. */
 			if ( len > string_len )
diff --git a/src/tests/cms_test.c b/src/tests/cms_test.c
index fc4f6bd19..debbfeee7 100644
--- a/src/tests/cms_test.c
+++ b/src/tests/cms_test.c
@@ -1773,8 +1773,8 @@ static void cms_decrypt_okx ( struct cms_test_image *img,
 
 	/* Check decrypted image matches expected plaintext */
 	okx ( img->image.len == expected->image.len, file, line );
-	okx ( memcmp_user ( img->image.data, 0, expected->image.data, 0,
-			    expected->image.len ) == 0, file, line );
+	okx ( memcmp ( img->image.data, expected->image.data,
+		       expected->image.len ) == 0, file, line );
 }
 #define cms_decrypt_ok( data, envelope, keypair, expected )		\
 	cms_decrypt_okx ( data, envelope, keypair, expected,		\
diff --git a/src/tests/gzip_test.c b/src/tests/gzip_test.c
index fa76edc53..9226b4c26 100644
--- a/src/tests/gzip_test.c
+++ b/src/tests/gzip_test.c
@@ -128,9 +128,8 @@ static void gzip_okx ( struct gzip_test *test, const char *file,
 
 	/* Verify extracted image content */
 	okx ( extracted->len == test->expected_len, file, line );
-	okx ( memcmp_user ( extracted->data, 0,
-			    virt_to_user ( test->expected ), 0,
-			    test->expected_len ) == 0, file, line );
+	okx ( memcmp ( extracted->data, virt_to_user ( test->expected ),
+		       test->expected_len ) == 0, file, line );
 
 	/* Verify extracted image name */
 	okx ( strcmp ( extracted->name, test->expected_name ) == 0,
diff --git a/src/tests/pixbuf_test.c b/src/tests/pixbuf_test.c
index aaa516bb2..1f82e0018 100644
--- a/src/tests/pixbuf_test.c
+++ b/src/tests/pixbuf_test.c
@@ -71,9 +71,8 @@ void pixbuf_okx ( struct pixel_buffer_test *test, const char *file,
 
 		/* Check pixel buffer data */
 		okx ( pixbuf->len == test->len, file, line );
-		okx ( memcmp_user ( pixbuf->data, 0,
-				    virt_to_user ( test->data ), 0,
-				    test->len ) == 0, file, line );
+		okx ( memcmp ( pixbuf->data, virt_to_user ( test->data ),
+			       test->len ) == 0, file, line );
 
 		pixbuf_put ( pixbuf );
 	}
diff --git a/src/tests/zlib_test.c b/src/tests/zlib_test.c
index df52d09ac..2efdcbad8 100644
--- a/src/tests/zlib_test.c
+++ b/src/tests/zlib_test.c
@@ -103,9 +103,8 @@ static void zlib_okx ( struct zlib_test *test, const char *file,
 
 	/* Verify extracted image content */
 	okx ( extracted->len == test->expected_len, file, line );
-	okx ( memcmp_user ( extracted->data, 0,
-			    virt_to_user ( test->expected ), 0,
-			    test->expected_len ) == 0, file, line );
+	okx ( memcmp ( extracted->data, virt_to_user ( test->expected ),
+		       test->expected_len ) == 0, file, line );
 
 	/* Verify extracted image name */
 	okx ( strcmp ( extracted->name, test->expected_name ) == 0,
-- 
cgit v1.2.3-55-g7522


From 4535548cba255c220719a55d02535e06da82ba47 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 21 Apr 2025 00:15:52 +0100
Subject: [uaccess] Remove redundant user_to_virt()

The user_to_virt() function is now a straightforward wrapper around
addition, with the addend almost invariably being zero.

Remove this redundant wrapper.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/image/bzimage.c           |  4 ++--
 src/arch/x86/image/initrd.c            |  2 +-
 src/arch/x86/include/librm.h           |  5 -----
 src/arch/x86/transitions/librm_mgmt.c  |  1 -
 src/core/fdt.c                         |  7 +++----
 src/core/uaccess.c                     |  1 -
 src/image/efi_image.c                  |  8 ++++----
 src/include/ipxe/linux/linux_uaccess.h |  5 -----
 src/include/ipxe/uaccess.h             | 32 +-------------------------------
 src/interface/efi/efi_pci.c            |  2 +-
 src/interface/linux/linux_acpi.c       |  2 +-
 src/interface/linux/linux_smbios.c     |  2 +-
 src/interface/linux/linux_sysfs.c      |  3 +--
 src/interface/linux/linux_uaccess.c    |  1 -
 14 files changed, 15 insertions(+), 60 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/image/bzimage.c b/src/arch/x86/image/bzimage.c
index 29ebeb507..32598525f 100644
--- a/src/arch/x86/image/bzimage.c
+++ b/src/arch/x86/image/bzimage.c
@@ -388,7 +388,7 @@ static size_t bzimage_load_initrd ( struct image *image,
 		       user_to_phys ( address, ( offset + initrd->len ) ),
 		       ( filename ? " " : "" ), ( filename ? filename : "" ) );
 		DBGC2_MD5A ( image, user_to_phys ( address, offset ),
-			     user_to_virt ( address, offset ), initrd->len );
+			     ( address + offset ), initrd->len );
 	}
 	len += initrd->len;
 
@@ -427,7 +427,7 @@ static int bzimage_check_initrds ( struct image *image,
 		       ( initrd->cmdline ? " " : "" ),
 		       ( initrd->cmdline ? initrd->cmdline : "" ) );
 		DBGC2_MD5A ( image, user_to_phys ( initrd->data, 0 ),
-			     user_to_virt ( initrd->data, 0 ), initrd->len );
+			     initrd->data, initrd->len );
 	}
 
 	/* Calculate lowest usable address */
diff --git a/src/arch/x86/image/initrd.c b/src/arch/x86/image/initrd.c
index 95f12d804..bcf95deef 100644
--- a/src/arch/x86/image/initrd.c
+++ b/src/arch/x86/image/initrd.c
@@ -211,7 +211,7 @@ static void initrd_dump ( void ) {
 		       initrd->name, user_to_phys ( initrd->data, 0 ),
 		       user_to_phys ( initrd->data, initrd->len ) );
 		DBGC2_MD5A ( &images, user_to_phys ( initrd->data, 0 ),
-			     user_to_virt ( initrd->data, 0 ), initrd->len );
+			     initrd->data, initrd->len );
 	}
 }
 
diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index c117a8b5c..9ed91022e 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -132,11 +132,6 @@ UACCESS_INLINE ( librm, virt_to_user ) ( volatile const void *addr ) {
 	return trivial_virt_to_user ( addr );
 }
 
-static inline __always_inline void *
-UACCESS_INLINE ( librm, user_to_virt ) ( userptr_t userptr, off_t offset ) {
-	return trivial_user_to_virt ( userptr, offset );
-}
-
 static inline __always_inline off_t
 UACCESS_INLINE ( librm, memchr_user ) ( userptr_t buffer, off_t offset,
 					int c, size_t len ) {
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index 7ebf62137..82e8eab39 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -431,7 +431,6 @@ void setup_sipi ( unsigned int vector, uint32_t handler,
 PROVIDE_UACCESS_INLINE ( librm, phys_to_user );
 PROVIDE_UACCESS_INLINE ( librm, user_to_phys );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_user );
-PROVIDE_UACCESS_INLINE ( librm, user_to_virt );
 PROVIDE_UACCESS_INLINE ( librm, memchr_user );
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
 PROVIDE_IOMAP ( pages, ioremap, ioremap_pages );
diff --git a/src/core/fdt.c b/src/core/fdt.c
index 54f930286..4c709b342 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -734,8 +734,7 @@ static int fdt_parse_image ( struct fdt *fdt, struct image *image ) {
 	int rc;
 
 	/* Parse image */
-	if ( ( rc = fdt_parse ( fdt, user_to_virt ( image->data, 0 ),
-				image->len ) ) != 0 ) {
+	if ( ( rc = fdt_parse ( fdt, image->data, image->len ) ) != 0 ) {
 		DBGC ( fdt, "FDT image \"%s\" is invalid: %s\n",
 		       image->name, strerror ( rc ) );
 		return rc;
@@ -1038,7 +1037,7 @@ static int fdt_urealloc ( struct fdt *fdt, size_t len ) {
 	assert ( len >= fdt->used );
 
 	/* Attempt reallocation */
-	new = user_to_virt ( urealloc ( virt_to_user ( fdt->raw ), len ), 0 );
+	new = urealloc ( virt_to_user ( fdt->raw ), len );
 	if ( ! new ) {
 		DBGC ( fdt, "FDT could not reallocate from +%#04zx to "
 		       "+%#04zx\n", fdt->len, len );
@@ -1112,7 +1111,7 @@ int fdt_create ( struct fdt_header **hdr, const char *cmdline ) {
 	}
 
 	/* Create modifiable copy */
-	copy = user_to_virt ( umalloc ( fdt.len ), 0 );
+	copy = umalloc ( fdt.len );
 	if ( ! copy ) {
 		rc = -ENOMEM;
 		goto err_alloc;
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index 01089e6fa..1c33c10b8 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -35,5 +35,4 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 PROVIDE_UACCESS_INLINE ( flat, phys_to_user );
 PROVIDE_UACCESS_INLINE ( flat, user_to_phys );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
-PROVIDE_UACCESS_INLINE ( flat, user_to_virt );
 PROVIDE_UACCESS_INLINE ( flat, memchr_user );
diff --git a/src/image/efi_image.c b/src/image/efi_image.c
index c87196487..2b0ff567a 100644
--- a/src/image/efi_image.c
+++ b/src/image/efi_image.c
@@ -245,8 +245,8 @@ static int efi_image_exec ( struct image *image ) {
 	/* Attempt loading image */
 	handle = NULL;
 	if ( ( efirc = bs->LoadImage ( FALSE, efi_image_handle, path,
-				       user_to_virt ( exec->data, 0 ),
-				       exec->len, &handle ) ) != 0 ) {
+				       exec->data, exec->len,
+				       &handle ) ) != 0 ) {
 		/* Not an EFI image */
 		rc = -EEFI_LOAD ( efirc );
 		DBGC ( image, "EFIIMAGE %s could not load: %s\n",
@@ -379,8 +379,8 @@ static int efi_image_probe ( struct image *image ) {
 	/* Attempt loading image */
 	handle = NULL;
 	if ( ( efirc = bs->LoadImage ( FALSE, efi_image_handle, &empty_path,
-				       user_to_virt ( image->data, 0 ),
-				       image->len, &handle ) ) != 0 ) {
+				       image->data, image->len,
+				       &handle ) ) != 0 ) {
 		/* Not an EFI image */
 		rc = -EEFI_LOAD ( efirc );
 		DBGC ( image, "EFIIMAGE %s could not load: %s\n",
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index 0c680c08f..4b1257b1e 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -64,11 +64,6 @@ UACCESS_INLINE ( linux, virt_to_user ) ( volatile const void *addr ) {
 	return trivial_virt_to_user ( addr );
 }
 
-static inline __always_inline void *
-UACCESS_INLINE ( linux, user_to_virt ) ( userptr_t userptr, off_t offset ) {
-	return trivial_user_to_virt ( userptr, offset );
-}
-
 static inline __always_inline off_t
 UACCESS_INLINE ( linux, memchr_user ) ( userptr_t buffer, off_t offset,
 					int c, size_t len ) {
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index e84ca3eae..4b3524bab 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -51,20 +51,6 @@ trivial_virt_to_user ( volatile const void *addr ) {
 	return ( ( userptr_t ) addr );
 }
 
-/**
- * Convert user pointer to virtual address
- *
- * @v userptr		User pointer
- * @v offset		Offset from user pointer
- * @ret addr		Virtual address
- *
- * This operation is not available under all memory models.
- */
-static inline __always_inline void *
-trivial_user_to_virt ( userptr_t userptr, off_t offset ) {
-	return ( ( void * ) userptr + offset );
-}
-
 /**
  * Find character in user buffer
  *
@@ -128,11 +114,6 @@ UACCESS_INLINE ( flat, virt_to_user ) ( volatile const void *addr ) {
 	return trivial_virt_to_user ( addr );
 }
 
-static inline __always_inline void *
-UACCESS_INLINE ( flat, user_to_virt ) ( userptr_t userptr, off_t offset ) {
-	return trivial_user_to_virt ( userptr, offset );
-}
-
 static inline __always_inline off_t
 UACCESS_INLINE ( flat, memchr_user ) ( userptr_t buffer, off_t offset,
 				       int c, size_t len ) {
@@ -170,17 +151,6 @@ unsigned long user_to_phys ( userptr_t userptr, off_t offset );
  */
 userptr_t virt_to_user ( volatile const void *addr );
 
-/**
- * Convert user pointer to virtual address
- *
- * @v userptr		User pointer
- * @v offset		Offset from user pointer
- * @ret addr		Virtual address
- *
- * This operation is not available under all memory models.
- */
-void * user_to_virt ( userptr_t userptr, off_t offset );
-
 /**
  * Convert virtual address to a physical address
  *
@@ -201,7 +171,7 @@ virt_to_phys ( volatile const void *addr ) {
  * This operation is not available under all memory models.
  */
 static inline __always_inline void * phys_to_virt ( unsigned long phys_addr ) {
-	return user_to_virt ( phys_to_user ( phys_addr ), 0 );
+	return ( phys_to_user ( phys_addr ) );
 }
 
 /**
diff --git a/src/interface/efi/efi_pci.c b/src/interface/efi/efi_pci.c
index dd11dd342..01351df51 100644
--- a/src/interface/efi/efi_pci.c
+++ b/src/interface/efi/efi_pci.c
@@ -669,7 +669,7 @@ static userptr_t efipci_dma_umalloc ( struct dma_device *dma,
 static void efipci_dma_ufree ( struct dma_device *dma, struct dma_mapping *map,
 			       userptr_t addr, size_t len ) {
 
-	efipci_dma_free ( dma, map, user_to_virt ( addr, 0 ), len );
+	efipci_dma_free ( dma, map, addr, len );
 }
 
 /**
diff --git a/src/interface/linux/linux_acpi.c b/src/interface/linux/linux_acpi.c
index e658936f2..846db2f1f 100644
--- a/src/interface/linux/linux_acpi.c
+++ b/src/interface/linux/linux_acpi.c
@@ -101,7 +101,7 @@ static userptr_t linux_acpi_find ( uint32_t signature, unsigned int index ) {
 		       filename, strerror ( rc ) );
 		goto err_read;
 	}
-	header = user_to_virt ( table->data, 0 );
+	header = table->data;
 	if ( ( ( ( size_t ) len ) < sizeof ( *header ) ) ||
 	     ( ( ( size_t ) len ) < le32_to_cpu ( header->length ) ) ) {
 		rc = -ENOENT;
diff --git a/src/interface/linux/linux_smbios.c b/src/interface/linux/linux_smbios.c
index 981873943..abe1b19d7 100644
--- a/src/interface/linux/linux_smbios.c
+++ b/src/interface/linux/linux_smbios.c
@@ -59,7 +59,7 @@ static int linux_find_smbios ( struct smbios *smbios ) {
 		       smbios_entry_filename, strerror ( rc ) );
 		goto err_entry;
 	}
-	data = user_to_virt ( entry, 0 );
+	data = entry;
 	smbios3_entry = data;
 	smbios_entry = data;
 	if ( ( len >= ( ( int ) sizeof ( *smbios3_entry ) ) ) &&
diff --git a/src/interface/linux/linux_sysfs.c b/src/interface/linux/linux_sysfs.c
index 4f0027cd4..cbb23d81d 100644
--- a/src/interface/linux/linux_sysfs.c
+++ b/src/interface/linux/linux_sysfs.c
@@ -70,8 +70,7 @@ int linux_sysfs_read ( const char *filename, userptr_t *data ) {
 		*data = tmp;
 
 		/* Read from file */
-		read = linux_read ( fd, user_to_virt ( *data, len ),
-				    LINUX_SYSFS_BLKSIZE );
+		read = linux_read ( fd, ( *data + len ), LINUX_SYSFS_BLKSIZE );
 		if ( read == 0 )
 			break;
 		if ( read < 0 ) {
diff --git a/src/interface/linux/linux_uaccess.c b/src/interface/linux/linux_uaccess.c
index d777bf3dd..e5c394365 100644
--- a/src/interface/linux/linux_uaccess.c
+++ b/src/interface/linux/linux_uaccess.c
@@ -29,5 +29,4 @@ FILE_LICENCE(GPL2_OR_LATER);
 
 PROVIDE_UACCESS_INLINE(linux, user_to_phys);
 PROVIDE_UACCESS_INLINE(linux, virt_to_user);
-PROVIDE_UACCESS_INLINE(linux, user_to_virt);
 PROVIDE_UACCESS_INLINE(linux, memchr_user);
-- 
cgit v1.2.3-55-g7522


From 8c31270a21a85cc87bce0e07e19e2041d2510a4c Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 21 Apr 2025 16:16:01 +0100
Subject: [uaccess] Remove user_to_phys() and phys_to_user()

Remove the intermediate concept of a user pointer from physical
address conversions, leaving virt_to_phys() and phys_to_virt() as the
directly implemented functions.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/runtime.c                    |  4 +--
 src/arch/x86/core/vram_settings.c              |  2 +-
 src/arch/x86/image/bzimage.c                   | 36 ++++++++++----------
 src/arch/x86/image/com32.c                     |  2 +-
 src/arch/x86/image/initrd.c                    | 32 +++++++++---------
 src/arch/x86/image/multiboot.c                 |  6 ++--
 src/arch/x86/image/nbi.c                       |  4 +--
 src/arch/x86/image/sdi.c                       |  9 ++---
 src/arch/x86/image/ucode.c                     | 11 +++---
 src/arch/x86/include/librm.h                   | 25 +++++++-------
 src/arch/x86/include/realmode.h                |  2 +-
 src/arch/x86/interface/pcbios/bios_cachedhcp.c |  2 +-
 src/arch/x86/interface/pcbios/bios_smbios.c    |  4 +--
 src/arch/x86/interface/pcbios/int13.c          |  6 ++--
 src/arch/x86/interface/pcbios/memtop_umalloc.c | 30 ++++++++--------
 src/arch/x86/interface/pcbios/rsdp.c           |  8 ++---
 src/arch/x86/interface/pcbios/vesafb.c         |  2 +-
 src/arch/x86/interface/pxe/pxe_tftp.c          |  2 +-
 src/arch/x86/interface/syslinux/com32_call.c   | 10 +++---
 src/arch/x86/interface/syslinux/comboot_call.c |  4 +--
 src/arch/x86/transitions/librm_mgmt.c          |  4 +--
 src/core/acpi.c                                | 24 ++++++-------
 src/core/blocktrans.c                          |  2 +-
 src/core/cachedhcp.c                           |  2 +-
 src/core/fbcon.c                               |  4 +--
 src/core/image.c                               |  4 +--
 src/core/uaccess.c                             |  4 +--
 src/drivers/block/srp.c                        |  4 +--
 src/drivers/infiniband/arbel.c                 |  4 +--
 src/drivers/infiniband/golan.c                 |  4 +--
 src/drivers/infiniband/golan.h                 |  4 +--
 src/drivers/infiniband/hermon.c                |  4 +--
 src/drivers/net/exanic.c                       |  6 ++--
 src/drivers/net/gve.c                          | 27 +++++++--------
 src/drivers/net/thunderx.c                     | 21 ++++++------
 src/drivers/usb/xhci.c                         |  7 ++--
 src/hci/commands/image_mem_cmd.c               |  2 +-
 src/image/elf.c                                |  2 +-
 src/image/segment.c                            |  6 ++--
 src/include/ipxe/linux/linux_uaccess.h         | 34 +++++++++----------
 src/include/ipxe/uaccess.h                     | 47 +++++++-------------------
 src/interface/efi/efi_acpi.c                   |  2 +-
 src/interface/efi/efi_fbcon.c                  |  2 +-
 src/interface/efi/efi_smbios.c                 |  8 ++---
 src/interface/efi/efi_umalloc.c                |  4 +--
 src/interface/hyperv/vmbus.c                   |  2 +-
 src/interface/linux/linux_uaccess.c            |  3 +-
 src/interface/smbios/smbios.c                  |  8 ++---
 48 files changed, 211 insertions(+), 235 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/runtime.c b/src/arch/x86/core/runtime.c
index 2b803f772..2d2a10674 100644
--- a/src/arch/x86/core/runtime.c
+++ b/src/arch/x86/core/runtime.c
@@ -124,7 +124,7 @@ static int cmdline_init ( void ) {
 		DBGC ( colour, "RUNTIME found no command line\n" );
 		return 0;
 	}
-	cmdline_user = phys_to_user ( cmdline_phys );
+	cmdline_user = phys_to_virt ( cmdline_phys );
 	len = ( strlen ( cmdline_user ) + 1 /* NUL */ );
 
 	/* Allocate and copy command line */
@@ -193,7 +193,7 @@ static int initrd_init ( void ) {
 	       initrd_phys, ( initrd_phys + initrd_len ) );
 
 	/* Create initrd image */
-	image = image_memory ( "<INITRD>", phys_to_user ( initrd_phys ),
+	image = image_memory ( "<INITRD>", phys_to_virt ( initrd_phys ),
 			       initrd_len );
 	if ( ! image ) {
 		DBGC ( colour, "RUNTIME could not create initrd image\n" );
diff --git a/src/arch/x86/core/vram_settings.c b/src/arch/x86/core/vram_settings.c
index 9c169b40c..ceeada467 100644
--- a/src/arch/x86/core/vram_settings.c
+++ b/src/arch/x86/core/vram_settings.c
@@ -47,7 +47,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * @ret len		Length of setting data, or negative error
  */
 static int vram_fetch ( void *data, size_t len ) {
-	userptr_t vram = phys_to_user ( VRAM_BASE );
+	userptr_t vram = phys_to_virt ( VRAM_BASE );
 
 	/* Copy video RAM */
 	if ( len > VRAM_LEN )
diff --git a/src/arch/x86/image/bzimage.c b/src/arch/x86/image/bzimage.c
index 32598525f..0f373c1c8 100644
--- a/src/arch/x86/image/bzimage.c
+++ b/src/arch/x86/image/bzimage.c
@@ -169,7 +169,7 @@ static int bzimage_parse_header ( struct image *image,
 	bzimg->rm_memsz += BZI_CMDLINE_SIZE;
 
 	/* Calculate load address of protected-mode portion */
-	bzimg->pm_kernel = phys_to_user ( is_bzimage ? BZI_LOAD_HIGH_ADDR
+	bzimg->pm_kernel = phys_to_virt ( is_bzimage ? BZI_LOAD_HIGH_ADDR
 					: BZI_LOAD_LOW_ADDR );
 
 	/* Extract video mode */
@@ -185,8 +185,8 @@ static int bzimage_parse_header ( struct image *image,
 
 	DBGC ( image, "bzImage %p version %04x RM %#lx+%#zx PM %#lx+%#zx "
 	       "cmdlen %zd\n", image, bzimg->version,
-	       user_to_phys ( bzimg->rm_kernel, 0 ), bzimg->rm_filesz,
-	       user_to_phys ( bzimg->pm_kernel, 0 ), bzimg->pm_sz,
+	       virt_to_phys ( bzimg->rm_kernel ), bzimg->rm_filesz,
+	       virt_to_phys ( bzimg->pm_kernel ), bzimg->pm_sz,
 	       bzimg->cmdline_size );
 
 	return 0;
@@ -215,8 +215,8 @@ static void bzimage_update_header ( struct image *image,
 
 	/* Set command line */
 	if ( bzimg->version >= 0x0202 ) {
-		bzimg->bzhdr.cmd_line_ptr = user_to_phys ( bzimg->rm_kernel,
-							   bzimg->rm_cmdline );
+		bzimg->bzhdr.cmd_line_ptr = ( virt_to_phys ( bzimg->rm_kernel )
+					      + bzimg->rm_cmdline );
 	} else {
 		bzimg->cmdline_magic.magic = BZI_CMDLINE_MAGIC;
 		bzimg->cmdline_magic.offset = bzimg->rm_cmdline;
@@ -383,11 +383,11 @@ static size_t bzimage_load_initrd ( struct image *image,
 		}
 		assert ( offset == len );
 		DBGC ( image, "bzImage %p initrd %p [%#08lx,%#08lx,%#08lx)"
-		       "%s%s\n", image, initrd, user_to_phys ( address, 0 ),
-		       user_to_phys ( address, offset ),
-		       user_to_phys ( address, ( offset + initrd->len ) ),
+		       "%s%s\n", image, initrd, virt_to_phys ( address ),
+		       ( virt_to_phys ( address ) + offset ),
+		       ( virt_to_phys ( address ) + offset + initrd->len ),
 		       ( filename ? " " : "" ), ( filename ? filename : "" ) );
-		DBGC2_MD5A ( image, user_to_phys ( address, offset ),
+		DBGC2_MD5A ( image, ( virt_to_phys ( address ) + offset ),
 			     ( address + offset ), initrd->len );
 	}
 	len += initrd->len;
@@ -422,11 +422,11 @@ static int bzimage_check_initrds ( struct image *image,
 		len = bzimage_align ( len );
 
 		DBGC ( image, "bzImage %p initrd %p from [%#08lx,%#08lx)%s%s\n",
-		       image, initrd, user_to_phys ( initrd->data, 0 ),
-		       user_to_phys ( initrd->data, initrd->len ),
+		       image, initrd, virt_to_phys ( initrd->data ),
+		       ( virt_to_phys ( initrd->data ) + initrd->len ),
 		       ( initrd->cmdline ? " " : "" ),
 		       ( initrd->cmdline ? initrd->cmdline : "" ) );
-		DBGC2_MD5A ( image, user_to_phys ( initrd->data, 0 ),
+		DBGC2_MD5A ( image, virt_to_phys ( initrd->data ),
 			     initrd->data, initrd->len );
 	}
 
@@ -445,7 +445,7 @@ static int bzimage_check_initrds ( struct image *image,
 	}
 
 	/* Check that total length fits within kernel's memory limit */
-	if ( user_to_phys ( bottom, len ) > bzimg->mem_limit ) {
+	if ( ( virt_to_phys ( bottom ) + len ) > bzimg->mem_limit ) {
 		DBGC ( image, "bzImage %p not enough space for initrds\n",
 		       image );
 		return -ENOBUFS;
@@ -485,12 +485,12 @@ static void bzimage_load_initrds ( struct image *image,
 
 	/* Find highest usable address */
 	top = ( highest->data + bzimage_align ( highest->len ) );
-	if ( user_to_phys ( top, -1 ) > bzimg->mem_limit ) {
-		top = phys_to_user ( ( bzimg->mem_limit + 1 ) &
+	if ( ( virt_to_phys ( top ) - 1UL ) > bzimg->mem_limit ) {
+		top = phys_to_virt ( ( bzimg->mem_limit + 1 ) &
 				     ~( INITRD_ALIGN - 1 ) );
 	}
 	DBGC ( image, "bzImage %p loading initrds from %#08lx downwards\n",
-	       image, user_to_phys ( top, -1 ) );
+	       image, ( virt_to_phys ( top ) - 1UL ) );
 
 	/* Load initrds in order */
 	for_each_image ( initrd ) {
@@ -512,8 +512,8 @@ static void bzimage_load_initrds ( struct image *image,
 
 		/* Record initrd location */
 		if ( ! bzimg->ramdisk_image )
-			bzimg->ramdisk_image = user_to_phys ( dest, 0 );
-		bzimg->ramdisk_size = ( user_to_phys ( dest, len ) -
+			bzimg->ramdisk_image = virt_to_phys ( dest );
+		bzimg->ramdisk_size = ( virt_to_phys ( dest ) + len -
 					bzimg->ramdisk_image );
 	}
 	DBGC ( image, "bzImage %p initrds at [%#08lx,%#08lx)\n",
diff --git a/src/arch/x86/image/com32.c b/src/arch/x86/image/com32.c
index 3e38215cb..a2b60987d 100644
--- a/src/arch/x86/image/com32.c
+++ b/src/arch/x86/image/com32.c
@@ -211,7 +211,7 @@ static int com32_load_image ( struct image *image ) {
 
 	filesz = image->len;
 	memsz = filesz;
-	buffer = phys_to_user ( COM32_START_PHYS );
+	buffer = phys_to_virt ( COM32_START_PHYS );
 	if ( ( rc = prep_segment ( buffer, filesz, memsz ) ) != 0 ) {
 		DBGC ( image, "COM32 %p: could not prepare segment: %s\n",
 		       image, strerror ( rc ) );
diff --git a/src/arch/x86/image/initrd.c b/src/arch/x86/image/initrd.c
index bcf95deef..fff40dd14 100644
--- a/src/arch/x86/image/initrd.c
+++ b/src/arch/x86/image/initrd.c
@@ -76,10 +76,10 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 		current -= len;
 		DBGC ( &images, "INITRD squashing %s [%#08lx,%#08lx)->"
 		       "[%#08lx,%#08lx)\n", highest->name,
-		       user_to_phys ( highest->data, 0 ),
-		       user_to_phys ( highest->data, highest->len ),
-		       user_to_phys ( current, 0 ),
-		       user_to_phys ( current, highest->len ) );
+		       virt_to_phys ( highest->data ),
+		       ( virt_to_phys ( highest->data ) + highest->len ),
+		       virt_to_phys ( current ),
+		       ( virt_to_phys ( current ) + highest->len ) );
 		memmove ( current, highest->data, highest->len );
 		highest->data = current;
 	}
@@ -92,10 +92,10 @@ static userptr_t initrd_squash_high ( userptr_t top ) {
 			current -= len;
 			DBGC ( &images, "INITRD copying %s [%#08lx,%#08lx)->"
 			       "[%#08lx,%#08lx)\n", initrd->name,
-			       user_to_phys ( initrd->data, 0 ),
-			       user_to_phys ( initrd->data, initrd->len ),
-			       user_to_phys ( current, 0 ),
-			       user_to_phys ( current, initrd->len ) );
+			       virt_to_phys ( initrd->data ),
+			       ( virt_to_phys ( initrd->data ) + initrd->len ),
+			       virt_to_phys ( current ),
+			       ( virt_to_phys ( current ) + initrd->len ) );
 			memcpy ( current, initrd->data, initrd->len );
 			initrd->data = current;
 		}
@@ -119,10 +119,10 @@ static void initrd_swap ( struct image *low, struct image *high,
 	size_t new_len;
 
 	DBGC ( &images, "INITRD swapping %s [%#08lx,%#08lx)<->[%#08lx,%#08lx) "
-	       "%s\n", low->name, user_to_phys ( low->data, 0 ),
-	       user_to_phys ( low->data, low->len ),
-	       user_to_phys ( high->data, 0 ),
-	       user_to_phys ( high->data, high->len ), high->name );
+	       "%s\n", low->name, virt_to_phys ( low->data ),
+	       ( virt_to_phys ( low->data ) + low->len ),
+	       virt_to_phys ( high->data ),
+	       ( virt_to_phys ( high->data ) + high->len ), high->name );
 
 	/* Round down length of free space */
 	free_len &= ~( INITRD_ALIGN - 1 );
@@ -208,9 +208,9 @@ static void initrd_dump ( void ) {
 	/* Dump initrd locations */
 	for_each_image ( initrd ) {
 		DBGC ( &images, "INITRD %s at [%#08lx,%#08lx)\n",
-		       initrd->name, user_to_phys ( initrd->data, 0 ),
-		       user_to_phys ( initrd->data, initrd->len ) );
-		DBGC2_MD5A ( &images, user_to_phys ( initrd->data, 0 ),
+		       initrd->name, virt_to_phys ( initrd->data ),
+		       ( virt_to_phys ( initrd->data ) + initrd->len ) );
+		DBGC2_MD5A ( &images, virt_to_phys ( initrd->data ),
 			     initrd->data, initrd->len );
 	}
 }
@@ -239,7 +239,7 @@ void initrd_reshuffle ( userptr_t bottom ) {
 
 	/* Debug */
 	DBGC ( &images, "INITRD region [%#08lx,%#08lx)\n",
-	       user_to_phys ( bottom, 0 ), user_to_phys ( top, 0 ) );
+	       virt_to_phys ( bottom ), virt_to_phys ( top ) );
 	initrd_dump();
 
 	/* Squash initrds as high as possible in memory */
diff --git a/src/arch/x86/image/multiboot.c b/src/arch/x86/image/multiboot.c
index fe21f1f1a..24f67e02f 100644
--- a/src/arch/x86/image/multiboot.c
+++ b/src/arch/x86/image/multiboot.c
@@ -212,7 +212,7 @@ static int multiboot_add_modules ( struct image *image, physaddr_t start,
 		start = ( ( start + 0xfff ) & ~0xfff );
 
 		/* Prepare segment */
-		if ( ( rc = prep_segment ( phys_to_user ( start ),
+		if ( ( rc = prep_segment ( phys_to_virt ( start ),
 					   module_image->len,
 					   module_image->len ) ) != 0 ) {
 			DBGC ( image, "MULTIBOOT %p could not prepare module "
@@ -222,7 +222,7 @@ static int multiboot_add_modules ( struct image *image, physaddr_t start,
 		}
 
 		/* Copy module */
-		memcpy ( phys_to_user ( start ), module_image->data,
+		memcpy ( phys_to_virt ( start ), module_image->data,
 			 module_image->len );
 
 		/* Add module to list */
@@ -342,7 +342,7 @@ static int multiboot_load_raw ( struct image *image,
 		   ( image->len - offset ) );
 	memsz = ( hdr->mb.bss_end_addr ?
 		  ( hdr->mb.bss_end_addr - hdr->mb.load_addr ) : filesz );
-	buffer = phys_to_user ( hdr->mb.load_addr );
+	buffer = phys_to_virt ( hdr->mb.load_addr );
 	if ( ( rc = prep_segment ( buffer, filesz, memsz ) ) != 0 ) {
 		DBGC ( image, "MULTIBOOT %p could not prepare segment: %s\n",
 		       image, strerror ( rc ) );
diff --git a/src/arch/x86/image/nbi.c b/src/arch/x86/image/nbi.c
index 0b02a8985..1f72c1287 100644
--- a/src/arch/x86/image/nbi.c
+++ b/src/arch/x86/image/nbi.c
@@ -181,7 +181,7 @@ static int nbi_process_segments ( struct image *image,
 		/* Calculate segment load address */
 		switch ( NBI_LOADADDR_FLAGS ( sh.flags ) ) {
 		case NBI_LOADADDR_ABS:
-			dest = phys_to_user ( sh.loadaddr );
+			dest = phys_to_virt ( sh.loadaddr );
 			break;
 		case NBI_LOADADDR_AFTER:
 			dest = ( dest + memsz + sh.loadaddr );
@@ -194,7 +194,7 @@ static int nbi_process_segments ( struct image *image,
 			 * maintains backwards compatibility with
 			 * previous versions of Etherboot.
 			 */
-			dest = phys_to_user ( ( extmemsize() + 1024 ) * 1024
+			dest = phys_to_virt ( ( extmemsize() + 1024 ) * 1024
 					      - sh.loadaddr );
 			break;
 		default:
diff --git a/src/arch/x86/image/sdi.c b/src/arch/x86/image/sdi.c
index 5bb5a7569..5e22daeb3 100644
--- a/src/arch/x86/image/sdi.c
+++ b/src/arch/x86/image/sdi.c
@@ -92,16 +92,17 @@ static int sdi_exec ( struct image *image ) {
 		return -ENOTTY;
 	}
 	DBGC ( image, "SDI %p image at %08lx+%08zx\n",
-	       image, user_to_phys ( image->data, 0 ), image->len );
-	DBGC ( image, "SDI %p boot code at %08lx+%llx\n", image,
-	       user_to_phys ( image->data, sdi.boot_offset ), sdi.boot_size );
+	       image, virt_to_phys ( image->data ), image->len );
+	DBGC ( image, "SDI %p boot code at %08llx+%llx\n", image,
+	       ( virt_to_phys ( image->data ) + sdi.boot_offset ),
+	       sdi.boot_size );
 
 	/* Copy boot code */
 	memcpy ( real_to_user ( SDI_BOOT_SEG, SDI_BOOT_OFF ),
 		 ( image->data + sdi.boot_offset ), sdi.boot_size );
 
 	/* Jump to boot code */
-	sdiptr = ( user_to_phys ( image->data, 0 ) | SDI_WTF );
+	sdiptr = ( virt_to_phys ( image->data ) | SDI_WTF );
 	__asm__ __volatile__ ( REAL_CODE ( "ljmp %0, %1\n\t" )
 			       : : "i" ( SDI_BOOT_SEG ),
 				   "i" ( SDI_BOOT_OFF ),
diff --git a/src/arch/x86/image/ucode.c b/src/arch/x86/image/ucode.c
index 9b6b5067a..a9fa8b8c4 100644
--- a/src/arch/x86/image/ucode.c
+++ b/src/arch/x86/image/ucode.c
@@ -165,7 +165,7 @@ static int ucode_status ( struct ucode_update *update,
 	assert ( id <= control->apic_max );
 
 	/* Read status report */
-	copy_from_user ( &status, phys_to_user ( control->status ),
+	copy_from_user ( &status, phys_to_virt ( control->status ),
 			 ( id * sizeof ( status ) ), sizeof ( status ) );
 
 	/* Ignore empty optional status reports */
@@ -261,7 +261,7 @@ static int ucode_update_all ( struct image *image,
 	/* Construct control structure */
 	memset ( &control, 0, sizeof ( control ) );
 	control.desc = virt_to_phys ( update->desc );
-	control.status = user_to_phys ( status, 0 );
+	control.status = virt_to_phys ( status );
 	vendor = update->vendor;
 	if ( vendor ) {
 		control.ver_clear = vendor->ver_clear;
@@ -446,8 +446,8 @@ static int ucode_parse_intel ( struct image *image, size_t start,
 	/* Populate descriptor */
 	desc.signature = hdr.signature;
 	desc.version = hdr.version;
-	desc.address = user_to_phys ( image->data,
-				      ( start + sizeof ( hdr ) ) );
+	desc.address = ( virt_to_phys ( image->data ) +
+			 start + sizeof ( hdr ) );
 
 	/* Add non-extended descriptor, if applicable */
 	ucode_describe ( image, start, &ucode_intel, &desc, hdr.platforms,
@@ -589,7 +589,8 @@ static int ucode_parse_amd ( struct image *image, size_t start,
 		copy_from_user ( &patch, image->data, ( start + offset ),
 				 sizeof ( patch ) );
 		desc.version = patch.version;
-		desc.address = user_to_phys ( image->data, ( start + offset ) );
+		desc.address = ( virt_to_phys ( image->data ) +
+				 start + offset );
 		offset += phdr.len;
 
 		/* Parse equivalence table to find matching signatures */
diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index 9ed91022e..7755abdcf 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -85,33 +85,32 @@ extern const unsigned long virt_offset;
 /**
  * Convert physical address to user pointer
  *
- * @v phys_addr		Physical address
- * @ret userptr		User pointer
+ * @v phys		Physical address
+ * @ret virt		Virtual address
  */
-static inline __always_inline userptr_t
-UACCESS_INLINE ( librm, phys_to_user ) ( unsigned long phys_addr ) {
+static inline __always_inline void *
+UACCESS_INLINE ( librm, phys_to_virt ) ( unsigned long phys ) {
 
 	/* In a 64-bit build, any valid physical address is directly
 	 * usable as a virtual address, since the low 4GB is
 	 * identity-mapped.
 	 */
 	if ( sizeof ( physaddr_t ) > sizeof ( uint32_t ) )
-		return ( ( userptr_t ) phys_addr );
+		return ( ( void * ) phys );
 
 	/* In a 32-bit build, subtract virt_offset */
-	return ( ( userptr_t ) ( phys_addr - virt_offset ) );
+	return ( ( void * ) ( phys - virt_offset ) );
 }
 
 /**
- * Convert user buffer to physical address
+ * Convert virtual address to physical address
  *
- * @v userptr		User pointer
- * @v offset		Offset from user pointer
- * @ret phys_addr	Physical address
+ * @v virt		Virtual address
+ * @ret phys		Physical address
  */
-static inline __always_inline unsigned long
-UACCESS_INLINE ( librm, user_to_phys ) ( userptr_t userptr, off_t offset ) {
-	unsigned long addr = ( ( unsigned long ) ( userptr + offset ) );
+static inline __always_inline physaddr_t
+UACCESS_INLINE ( librm, virt_to_phys ) ( volatile const void *virt ) {
+	physaddr_t addr = ( ( physaddr_t ) virt );
 
 	/* In a 64-bit build, any virtual address in the low 4GB is
 	 * directly usable as a physical address, since the low 4GB is
diff --git a/src/arch/x86/include/realmode.h b/src/arch/x86/include/realmode.h
index 4defd3b97..616db5eb9 100644
--- a/src/arch/x86/include/realmode.h
+++ b/src/arch/x86/include/realmode.h
@@ -73,7 +73,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 static inline __always_inline userptr_t
 real_to_user ( unsigned int segment, unsigned int offset ) {
-	return ( phys_to_user ( ( segment << 4 ) + offset ) );
+	return ( phys_to_virt ( ( segment << 4 ) + offset ) );
 }
 
 /**
diff --git a/src/arch/x86/interface/pcbios/bios_cachedhcp.c b/src/arch/x86/interface/pcbios/bios_cachedhcp.c
index bea803d6e..05d89b3b7 100644
--- a/src/arch/x86/interface/pcbios/bios_cachedhcp.c
+++ b/src/arch/x86/interface/pcbios/bios_cachedhcp.c
@@ -60,7 +60,7 @@ static void cachedhcp_init ( void ) {
 
 	/* Record cached DHCPACK */
 	if ( ( rc = cachedhcp_record ( &cached_dhcpack, 0,
-				       phys_to_user ( cached_dhcpack_phys ),
+				       phys_to_virt ( cached_dhcpack_phys ),
 				       sizeof ( BOOTPLAYER_t ) ) ) != 0 ) {
 		DBGC ( colour, "CACHEDHCP could not record DHCPACK: %s\n",
 		       strerror ( rc ) );
diff --git a/src/arch/x86/interface/pcbios/bios_smbios.c b/src/arch/x86/interface/pcbios/bios_smbios.c
index 366679d36..ab53d424b 100644
--- a/src/arch/x86/interface/pcbios/bios_smbios.c
+++ b/src/arch/x86/interface/pcbios/bios_smbios.c
@@ -54,7 +54,7 @@ static int bios_find_smbios2 ( struct smbios *smbios ) {
 		return rc;
 
 	/* Fill in entry point descriptor structure */
-	smbios->address = phys_to_user ( entry.smbios_address );
+	smbios->address = phys_to_virt ( entry.smbios_address );
 	smbios->len = entry.smbios_len;
 	smbios->count = entry.smbios_count;
 	smbios->version = SMBIOS_VERSION ( entry.major, entry.minor );
@@ -85,7 +85,7 @@ static int bios_find_smbios3 ( struct smbios *smbios ) {
 	}
 
 	/* Fill in entry point descriptor structure */
-	smbios->address = phys_to_user ( entry.smbios_address );
+	smbios->address = phys_to_virt ( entry.smbios_address );
 	smbios->len = entry.smbios_len;
 	smbios->count = 0;
 	smbios->version = SMBIOS_VERSION ( entry.major, entry.minor );
diff --git a/src/arch/x86/interface/pcbios/int13.c b/src/arch/x86/interface/pcbios/int13.c
index 372d40ba3..d60f7c7cc 100644
--- a/src/arch/x86/interface/pcbios/int13.c
+++ b/src/arch/x86/interface/pcbios/int13.c
@@ -743,7 +743,7 @@ static int int13_extended_rw ( struct san_device *sandev,
 	if ( ( addr.count == 0xff ) ||
 	     ( ( addr.buffer.segment == 0xffff ) &&
 	       ( addr.buffer.offset == 0xffff ) ) ) {
-		buffer = phys_to_user ( addr.buffer_phys );
+		buffer = phys_to_virt ( addr.buffer_phys );
 		DBGC2 ( sandev->drive, "%08llx",
 			( ( unsigned long long ) addr.buffer_phys ) );
 	} else {
@@ -1058,7 +1058,7 @@ static int int13_cdrom_read_boot_catalog ( struct san_device *sandev,
 
 	/* Read from boot catalog */
 	if ( ( rc = sandev_read ( sandev, start, command.count,
-				  phys_to_user ( command.buffer ) ) ) != 0 ) {
+				  phys_to_virt ( command.buffer ) ) ) != 0 ) {
 		DBGC ( sandev->drive, "INT13 drive %02x could not read boot "
 		       "catalog: %s\n", sandev->drive, strerror ( rc ) );
 		return -INT13_STATUS_READ_ERROR;
@@ -1455,7 +1455,7 @@ static int int13_load_eltorito ( unsigned int drive, struct segoff *address ) {
 		       "catalog (status %04x)\n", drive, status );
 		return -EIO;
 	}
-	copy_from_user ( &catalog, phys_to_user ( eltorito_cmd.buffer ), 0,
+	copy_from_user ( &catalog, phys_to_virt ( eltorito_cmd.buffer ), 0,
 			 sizeof ( catalog ) );
 
 	/* Sanity checks */
diff --git a/src/arch/x86/interface/pcbios/memtop_umalloc.c b/src/arch/x86/interface/pcbios/memtop_umalloc.c
index 8239b23b8..b87d22516 100644
--- a/src/arch/x86/interface/pcbios/memtop_umalloc.c
+++ b/src/arch/x86/interface/pcbios/memtop_umalloc.c
@@ -106,7 +106,7 @@ size_t largest_memblock ( userptr_t *start ) {
 		/* Use largest block */
 		if ( region_len > len ) {
 			DBG ( "...new best block found\n" );
-			*start = phys_to_user ( region_start );
+			*start = phys_to_virt ( region_start );
 			len = region_len;
 		}
 	}
@@ -124,7 +124,7 @@ static void init_eheap ( void ) {
 	heap_size = largest_memblock ( &base );
 	bottom = top = ( base + heap_size );
 	DBG ( "External heap grows downwards from %lx (size %zx)\n",
-	      user_to_phys ( top, 0 ), heap_size );
+	      virt_to_phys ( top ), heap_size );
 }
 
 /**
@@ -141,8 +141,8 @@ static void ecollect_free ( void ) {
 				 sizeof ( extmem ) );
 		if ( extmem.used )
 			break;
-		DBG ( "EXTMEM freeing [%lx,%lx)\n", user_to_phys ( bottom, 0 ),
-		      user_to_phys ( bottom, extmem.size ) );
+		DBG ( "EXTMEM freeing [%lx,%lx)\n", virt_to_phys ( bottom ),
+		      ( virt_to_phys ( bottom ) + extmem.size ) );
 		len = ( extmem.size + sizeof ( extmem ) );
 		bottom += len;
 		heap_size += len;
@@ -182,7 +182,7 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 		ptr = bottom = ( bottom - sizeof ( extmem ) );
 		heap_size -= sizeof ( extmem );
 		DBG ( "EXTMEM allocating [%lx,%lx)\n",
-		      user_to_phys ( ptr, 0 ), user_to_phys ( ptr, 0 ) );
+		      virt_to_phys ( ptr ), virt_to_phys ( ptr ) );
 		extmem.size = 0;
 	}
 	extmem.used = ( new_size > 0 );
@@ -191,7 +191,7 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 	if ( ptr == bottom ) {
 		/* Update block */
 		new = ( ptr - ( new_size - extmem.size ) );
-		align = ( user_to_phys ( new, 0 ) & ( EM_ALIGN - 1 ) );
+		align = ( virt_to_phys ( new ) & ( EM_ALIGN - 1 ) );
 		new_size += align;
 		new -= align;
 		if ( new_size > ( heap_size + extmem.size ) ) {
@@ -199,10 +199,10 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 			return UNULL;
 		}
 		DBG ( "EXTMEM expanding [%lx,%lx) to [%lx,%lx)\n",
-		      user_to_phys ( ptr, 0 ),
-		      user_to_phys ( ptr, extmem.size ),
-		      user_to_phys ( new, 0 ),
-		      user_to_phys ( new, new_size ));
+		      virt_to_phys ( ptr ),
+		      ( virt_to_phys ( ptr ) + extmem.size ),
+		      virt_to_phys ( new ),
+		      ( virt_to_phys ( new ) + new_size ) );
 		memmove ( new, ptr, ( ( extmem.size < new_size ) ?
 				      extmem.size : new_size ) );
 		bottom = new;
@@ -213,8 +213,8 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 		if ( new_size > extmem.size ) {
 			/* Refuse to expand */
 			DBG ( "EXTMEM cannot expand [%lx,%lx)\n",
-			      user_to_phys ( ptr, 0 ),
-			      user_to_phys ( ptr, extmem.size ) );
+			      virt_to_phys ( ptr ),
+			      ( virt_to_phys ( ptr ) + extmem.size ) );
 			return UNULL;
 		}
 	}
@@ -225,9 +225,9 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 
 	/* Collect any free blocks and update hidden memory region */
 	ecollect_free();
-	hide_umalloc ( user_to_phys ( bottom, ( ( bottom == top ) ?
-						0 : -sizeof ( extmem ) ) ),
-		       user_to_phys ( top, 0 ) );
+	hide_umalloc ( ( virt_to_phys ( bottom ) -
+			 ( ( bottom == top ) ? 0 : sizeof ( extmem ) ) ),
+		       virt_to_phys ( top ) );
 
 	return ( new_size ? new : UNOWHERE );
 }
diff --git a/src/arch/x86/interface/pcbios/rsdp.c b/src/arch/x86/interface/pcbios/rsdp.c
index 3c67b7525..02c58c780 100644
--- a/src/arch/x86/interface/pcbios/rsdp.c
+++ b/src/arch/x86/interface/pcbios/rsdp.c
@@ -78,10 +78,10 @@ static userptr_t rsdp_find_rsdt_range ( userptr_t start, size_t len ) {
 			continue;
 
 		/* Extract RSDT */
-		rsdt = phys_to_user ( le32_to_cpu ( rsdp.rsdt ) );
+		rsdt = phys_to_virt ( le32_to_cpu ( rsdp.rsdt ) );
 		DBGC ( rsdt, "RSDT %#08lx found via RSDP %#08lx\n",
-		       user_to_phys ( rsdt, 0 ),
-		       user_to_phys ( start, offset ) );
+		       virt_to_phys ( rsdt ),
+		       ( virt_to_phys ( start ) + offset ) );
 		return rsdt;
 	}
 
@@ -114,7 +114,7 @@ static userptr_t rsdp_find_rsdt ( void ) {
 	}
 
 	/* Search fixed BIOS area */
-	rsdt = rsdp_find_rsdt_range ( phys_to_user ( RSDP_BIOS_START ),
+	rsdt = rsdp_find_rsdt_range ( phys_to_virt ( RSDP_BIOS_START ),
 				      RSDP_BIOS_LEN );
 	if ( rsdt )
 		return rsdt;
diff --git a/src/arch/x86/interface/pcbios/vesafb.c b/src/arch/x86/interface/pcbios/vesafb.c
index 86edbda42..61609fa8c 100644
--- a/src/arch/x86/interface/pcbios/vesafb.c
+++ b/src/arch/x86/interface/pcbios/vesafb.c
@@ -473,7 +473,7 @@ static int vesafb_init ( struct console_configuration *config ) {
 	vesafb_font();
 
 	/* Initialise frame buffer console */
-	if ( ( rc = fbcon_init ( &vesafb.fbcon, phys_to_user ( vesafb.start ),
+	if ( ( rc = fbcon_init ( &vesafb.fbcon, phys_to_virt ( vesafb.start ),
 				 &vesafb.pixel, &vesafb.map, &vesafb.font,
 				 config ) ) != 0 )
 		goto err_fbcon_init;
diff --git a/src/arch/x86/interface/pxe/pxe_tftp.c b/src/arch/x86/interface/pxe/pxe_tftp.c
index 3b4c6d847..2c2eccca4 100644
--- a/src/arch/x86/interface/pxe/pxe_tftp.c
+++ b/src/arch/x86/interface/pxe/pxe_tftp.c
@@ -492,7 +492,7 @@ PXENV_EXIT_t pxenv_tftp_read_file ( struct s_PXENV_TFTP_READ_FILE
 	}
 
 	/* Read entire file */
-	pxe_tftp.buffer = phys_to_user ( tftp_read_file->Buffer );
+	pxe_tftp.buffer = phys_to_virt ( tftp_read_file->Buffer );
 	pxe_tftp.size = tftp_read_file->BufferSize;
 	while ( ( rc = pxe_tftp.rc ) == -EINPROGRESS )
 		step();
diff --git a/src/arch/x86/interface/syslinux/com32_call.c b/src/arch/x86/interface/syslinux/com32_call.c
index da9d6491a..47be69f9f 100644
--- a/src/arch/x86/interface/syslinux/com32_call.c
+++ b/src/arch/x86/interface/syslinux/com32_call.c
@@ -49,7 +49,7 @@ void __asmcall com32_intcall ( uint8_t interrupt, physaddr_t inregs_phys, physad
 	DBGC ( &com32_regs, "COM32 INT%x in %#08lx out %#08lx\n",
 	       interrupt, inregs_phys, outregs_phys );
 
-	memcpy ( virt_to_user( &com32_regs ), phys_to_user ( inregs_phys ),
+	memcpy ( virt_to_user( &com32_regs ), phys_to_virt ( inregs_phys ),
 		 sizeof ( com32sys_t ) );
 
 	com32_int_vector = interrupt;
@@ -107,7 +107,7 @@ void __asmcall com32_intcall ( uint8_t interrupt, physaddr_t inregs_phys, physad
 		            : : );
 
 	if ( outregs_phys ) {
-		memcpy ( phys_to_user ( outregs_phys ),
+		memcpy ( phys_to_virt ( outregs_phys ),
 			 virt_to_user ( &com32_regs ), sizeof ( com32sys_t ) );
 	}
 }
@@ -120,7 +120,7 @@ void __asmcall com32_farcall ( uint32_t proc, physaddr_t inregs_phys, physaddr_t
 	DBGC ( &com32_regs, "COM32 farcall %04x:%04x in %#08lx out %#08lx\n",
 	       ( proc >> 16 ), ( proc & 0xffff ), inregs_phys, outregs_phys );
 
-	memcpy ( virt_to_user( &com32_regs ), phys_to_user ( inregs_phys ),
+	memcpy ( virt_to_user( &com32_regs ), phys_to_virt ( inregs_phys ),
 		 sizeof ( com32sys_t ) );
 
 	com32_farcall_proc = proc;
@@ -167,7 +167,7 @@ void __asmcall com32_farcall ( uint32_t proc, physaddr_t inregs_phys, physaddr_t
 		            : : );
 
 	if ( outregs_phys ) {
-		memcpy ( phys_to_user ( outregs_phys ),
+		memcpy ( phys_to_virt ( outregs_phys ),
 			 virt_to_user ( &com32_regs ), sizeof ( com32sys_t ) );
 	}
 }
@@ -181,7 +181,7 @@ int __asmcall com32_cfarcall ( uint32_t proc, physaddr_t stack, size_t stacksz )
 	DBGC ( &com32_regs, "COM32 cfarcall %04x:%04x params %#08lx+%#zx\n",
 	       ( proc >> 16 ), ( proc & 0xffff ), stack, stacksz );
 
-	copy_user_to_rm_stack ( phys_to_user ( stack ), stacksz );
+	copy_user_to_rm_stack ( phys_to_virt ( stack ), stacksz );
 	com32_farcall_proc = proc;
 
 	__asm__ __volatile__ (
diff --git a/src/arch/x86/interface/syslinux/comboot_call.c b/src/arch/x86/interface/syslinux/comboot_call.c
index f26fcad0a..d7e923b70 100644
--- a/src/arch/x86/interface/syslinux/comboot_call.c
+++ b/src/arch/x86/interface/syslinux/comboot_call.c
@@ -114,8 +114,8 @@ static void shuffle ( unsigned int list_segment, unsigned int list_offset, unsig
 
 	/* Do the copies */
 	for ( i = 0; i < count; i++ ) {
-		userptr_t src_u = phys_to_user ( shuf[ i ].src );
-		userptr_t dest_u = phys_to_user ( shuf[ i ].dest );
+		userptr_t src_u = phys_to_virt ( shuf[ i ].src );
+		userptr_t dest_u = phys_to_virt ( shuf[ i ].dest );
 
 		if ( shuf[ i ].src == 0xFFFFFFFF ) {
 			/* Fill with 0 instead of copying */
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index 82e8eab39..fbc653969 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -428,8 +428,8 @@ void setup_sipi ( unsigned int vector, uint32_t handler,
 	copy_to_real ( ( vector << 8 ), 0, sipi, ( ( size_t ) sipi_len ) );
 }
 
-PROVIDE_UACCESS_INLINE ( librm, phys_to_user );
-PROVIDE_UACCESS_INLINE ( librm, user_to_phys );
+PROVIDE_UACCESS_INLINE ( librm, phys_to_virt );
+PROVIDE_UACCESS_INLINE ( librm, virt_to_phys );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_user );
 PROVIDE_UACCESS_INLINE ( librm, memchr_user );
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
diff --git a/src/core/acpi.c b/src/core/acpi.c
index 526bf8555..d7da0ccc1 100644
--- a/src/core/acpi.c
+++ b/src/core/acpi.c
@@ -128,16 +128,16 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
 	copy_from_user ( &acpi, rsdt, 0, sizeof ( acpi ) );
 	if ( acpi.signature != cpu_to_le32 ( RSDT_SIGNATURE ) ) {
 		DBGC ( colour, "RSDT %#08lx has invalid signature:\n",
-		       user_to_phys ( rsdt, 0 ) );
-		DBGC_HDA ( colour, user_to_phys ( rsdt, 0 ), &acpi,
+		       virt_to_phys ( rsdt ) );
+		DBGC_HDA ( colour, virt_to_phys ( rsdt ), &acpi,
 			   sizeof ( acpi ) );
 		return UNULL;
 	}
 	len = le32_to_cpu ( acpi.length );
 	if ( len < sizeof ( rsdtab->acpi ) ) {
 		DBGC ( colour, "RSDT %#08lx has invalid length:\n",
-		       user_to_phys ( rsdt, 0 ) );
-		DBGC_HDA ( colour, user_to_phys ( rsdt, 0 ), &acpi,
+		       virt_to_phys ( rsdt ) );
+		DBGC_HDA ( colour, virt_to_phys ( rsdt ), &acpi,
 			   sizeof ( acpi ) );
 		return UNULL;
 	}
@@ -154,7 +154,7 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
 				 sizeof ( entry ) );
 
 		/* Read table header */
-		table = phys_to_user ( entry );
+		table = phys_to_virt ( entry );
 		copy_from_user ( &acpi.signature, table, 0,
 				 sizeof ( acpi.signature ) );
 
@@ -169,20 +169,20 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
 		/* Check table integrity */
 		if ( acpi_checksum ( table ) != 0 ) {
 			DBGC ( colour, "RSDT %#08lx found %s with bad "
-			       "checksum at %08lx\n", user_to_phys ( rsdt, 0 ),
+			       "checksum at %08lx\n", virt_to_phys ( rsdt ),
 			       acpi_name ( signature ),
-			       user_to_phys ( table, 0 ) );
+			       virt_to_phys ( table ) );
 			break;
 		}
 
 		DBGC ( colour, "RSDT %#08lx found %s at %08lx\n",
-		       user_to_phys ( rsdt, 0 ), acpi_name ( signature ),
-		       user_to_phys ( table, 0 ) );
+		       virt_to_phys ( rsdt ), acpi_name ( signature ),
+		       virt_to_phys ( table ) );
 		return table;
 	}
 
 	DBGC ( colour, "RSDT %#08lx could not find %s\n",
-	       user_to_phys ( rsdt, 0 ), acpi_name ( signature ) );
+	       virt_to_phys ( rsdt ), acpi_name ( signature ) );
 	return UNULL;
 }
 
@@ -218,7 +218,7 @@ static int acpi_zsdt ( userptr_t zsdt, uint32_t signature, void *data,
 		if ( buf != cpu_to_le32 ( signature ) )
 			continue;
 		DBGC ( zsdt, "DSDT/SSDT %#08lx found %s at offset %#zx\n",
-		       user_to_phys ( zsdt, 0 ), acpi_name ( signature ),
+		       virt_to_phys ( zsdt ), acpi_name ( signature ),
 		       offset );
 
 		/* Attempt to extract data */
@@ -251,7 +251,7 @@ int acpi_extract ( uint32_t signature, void *data,
 	fadt = acpi_table ( FADT_SIGNATURE, 0 );
 	if ( fadt ) {
 		copy_from_user ( &fadtab, fadt, 0, sizeof ( fadtab ) );
-		dsdt = phys_to_user ( fadtab.dsdt );
+		dsdt = phys_to_virt ( fadtab.dsdt );
 		if ( ( rc = acpi_zsdt ( dsdt, signature, data,
 					extract ) ) == 0 )
 			return 0;
diff --git a/src/core/blocktrans.c b/src/core/blocktrans.c
index f9dcb95d2..f3be2ba2b 100644
--- a/src/core/blocktrans.c
+++ b/src/core/blocktrans.c
@@ -248,7 +248,7 @@ int block_translate ( struct interface *block, userptr_t buffer, size_t size ) {
 	DBGC2 ( blktrans, "BLKTRANS %p created", blktrans );
 	if ( buffer ) {
 		DBGC2 ( blktrans, " for %#lx+%#zx",
-			user_to_phys ( buffer, 0 ), size );
+			virt_to_phys ( buffer ), size );
 	}
 	DBGC2 ( blktrans, "\n" );
 	return 0;
diff --git a/src/core/cachedhcp.c b/src/core/cachedhcp.c
index 04945e646..07589f0b8 100644
--- a/src/core/cachedhcp.c
+++ b/src/core/cachedhcp.c
@@ -251,7 +251,7 @@ int cachedhcp_record ( struct cached_dhcp_packet *cache, unsigned int vlan,
 
 	/* Store as cached packet */
 	DBGC ( colour, "CACHEDHCP %s at %#08lx+%#zx/%#zx\n", cache->name,
-	       user_to_phys ( data, 0 ), len, max_len );
+	       virt_to_phys ( data ), len, max_len );
 	cache->dhcppkt = dhcppkt;
 	cache->vlan = vlan;
 
diff --git a/src/core/fbcon.c b/src/core/fbcon.c
index 8d05484e2..6d08ac419 100644
--- a/src/core/fbcon.c
+++ b/src/core/fbcon.c
@@ -613,8 +613,8 @@ int fbcon_init ( struct fbcon *fbcon, userptr_t start,
 	/* Derive overall length */
 	fbcon->len = ( pixel->height * pixel->stride );
 	DBGC ( fbcon, "FBCON %p at [%08lx,%08lx)\n", fbcon,
-	       user_to_phys ( fbcon->start, 0 ),
-	       user_to_phys ( fbcon->start, fbcon->len ) );
+	       virt_to_phys ( fbcon->start ),
+	       ( virt_to_phys ( fbcon->start ) + fbcon->len ) );
 
 	/* Calculate margin.  If the actual screen size is larger than
 	 * the requested screen size, then update the margins so that
diff --git a/src/core/image.c b/src/core/image.c
index 709d0da9c..e90d82ffb 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -300,8 +300,8 @@ int register_image ( struct image *image ) {
 	image->flags |= IMAGE_REGISTERED;
 	list_add_tail ( &image->list, &images );
 	DBGC ( image, "IMAGE %s at [%lx,%lx) registered\n",
-	       image->name, user_to_phys ( image->data, 0 ),
-	       user_to_phys ( image->data, image->len ) );
+	       image->name, virt_to_phys ( image->data ),
+	       ( virt_to_phys ( image->data ) + image->len ) );
 
 	/* Try to detect image type, if applicable.  Ignore failures,
 	 * since we expect to handle some unrecognised images
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index 1c33c10b8..32bd1ac38 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -32,7 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 /* Flat address space user access API */
-PROVIDE_UACCESS_INLINE ( flat, phys_to_user );
-PROVIDE_UACCESS_INLINE ( flat, user_to_phys );
+PROVIDE_UACCESS_INLINE ( flat, phys_to_virt );
+PROVIDE_UACCESS_INLINE ( flat, virt_to_phys );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
 PROVIDE_UACCESS_INLINE ( flat, memchr_user );
diff --git a/src/drivers/block/srp.c b/src/drivers/block/srp.c
index ab4812519..c12f230f7 100644
--- a/src/drivers/block/srp.c
+++ b/src/drivers/block/srp.c
@@ -428,7 +428,7 @@ static int srp_cmd ( struct srp_device *srpdev,
 		cmd->data_buffer_formats |= SRP_CMD_DO_FMT_DIRECT;
 		data_out = iob_put ( iobuf, sizeof ( *data_out ) );
 		data_out->address =
-		    cpu_to_be64 ( user_to_phys ( command->data_out, 0 ) );
+		    cpu_to_be64 ( virt_to_phys ( command->data_out ) );
 		data_out->handle = ntohl ( srpdev->memory_handle );
 		data_out->len = ntohl ( command->data_out_len );
 	}
@@ -438,7 +438,7 @@ static int srp_cmd ( struct srp_device *srpdev,
 		cmd->data_buffer_formats |= SRP_CMD_DI_FMT_DIRECT;
 		data_in = iob_put ( iobuf, sizeof ( *data_in ) );
 		data_in->address =
-		     cpu_to_be64 ( user_to_phys ( command->data_in, 0 ) );
+		     cpu_to_be64 ( virt_to_phys ( command->data_in ) );
 		data_in->handle = ntohl ( srpdev->memory_handle );
 		data_in->len = ntohl ( command->data_in_len );
 	}
diff --git a/src/drivers/infiniband/arbel.c b/src/drivers/infiniband/arbel.c
index 8be06d93d..4cb4167e0 100644
--- a/src/drivers/infiniband/arbel.c
+++ b/src/drivers/infiniband/arbel.c
@@ -2079,7 +2079,7 @@ static int arbel_start_firmware ( struct arbel *arbel ) {
 	} else {
 		assert ( arbel->firmware_len == fw_len );
 	}
-	fw_base = user_to_phys ( arbel->firmware_area, 0 );
+	fw_base = virt_to_phys ( arbel->firmware_area );
 	DBGC ( arbel, "Arbel %p firmware area at [%08lx,%08lx)\n",
 	       arbel, fw_base, ( fw_base + fw_len ) );
 	if ( ( rc = arbel_map_vpm ( arbel, arbel_cmd_map_fa,
@@ -2452,7 +2452,7 @@ static int arbel_alloc_icm ( struct arbel *arbel,
 		assert ( arbel->icm_len == icm_len );
 		assert ( arbel->icm_aux_len == icm_aux_len );
 	}
-	icm_phys = user_to_phys ( arbel->icm, 0 );
+	icm_phys = virt_to_phys ( arbel->icm );
 
 	/* Allocate doorbell UAR */
 	arbel->db_rec = malloc_phys ( ARBEL_PAGE_SIZE, ARBEL_PAGE_SIZE );
diff --git a/src/drivers/infiniband/golan.c b/src/drivers/infiniband/golan.c
index 81fc6c0f0..a33bad9ff 100755
--- a/src/drivers/infiniband/golan.c
+++ b/src/drivers/infiniband/golan.c
@@ -486,8 +486,8 @@ static inline int golan_provide_pages ( struct golan *golan , uint32_t pages
 		for ( i = 0 , j = MANAGE_PAGES_PSA_OFFSET; i < pas_num; ++i ,++j,
 				next_page_addr += GOLAN_PAGE_SIZE ) {
 			addr = next_page_addr;
-			if (GOLAN_PAGE_MASK & user_to_phys(addr, 0)) {
-				DBGC (golan ,"Addr not Page alligned [%lx]\n", user_to_phys(addr, 0));
+			if (GOLAN_PAGE_MASK & virt_to_phys(addr)) {
+				DBGC (golan ,"Addr not Page alligned [%lx]\n", virt_to_phys(addr));
 			}
 			mailbox->mblock.data[j]	= USR_2_BE64_BUS(addr);
 		}
diff --git a/src/drivers/infiniband/golan.h b/src/drivers/infiniband/golan.h
index 2fd06ecf0..f7da1e960 100755
--- a/src/drivers/infiniband/golan.h
+++ b/src/drivers/infiniband/golan.h
@@ -69,8 +69,8 @@ FILE_LICENCE ( GPL2_OR_LATER );
 
 #define VIRT_2_BE64_BUS( addr )		cpu_to_be64(((unsigned long long )virt_to_bus(addr)))
 #define BE64_BUS_2_VIRT( addr )		bus_to_virt(be64_to_cpu(addr))
-#define USR_2_BE64_BUS( addr )		cpu_to_be64(((unsigned long long )user_to_phys(addr, 0)))
-#define BE64_BUS_2_USR( addr )		be64_to_cpu(phys_to_user(addr))
+#define USR_2_BE64_BUS( addr )		cpu_to_be64(((unsigned long long )virt_to_phys(addr)))
+#define BE64_BUS_2_USR( addr )		be64_to_cpu(phys_to_virt(addr))
 
 #define GET_INBOX(golan, idx)		(&(((struct mbox *)(golan->mboxes.inbox))[idx]))
 #define GET_OUTBOX(golan, idx)		(&(((struct mbox *)(golan->mboxes.outbox))[idx]))
diff --git a/src/drivers/infiniband/hermon.c b/src/drivers/infiniband/hermon.c
index e5c3544fa..3138d8bfb 100644
--- a/src/drivers/infiniband/hermon.c
+++ b/src/drivers/infiniband/hermon.c
@@ -2382,7 +2382,7 @@ static int hermon_start_firmware ( struct hermon *hermon ) {
 	} else {
 		assert ( hermon->firmware_len == fw_len );
 	}
-	fw_base = user_to_phys ( hermon->firmware_area, 0 );
+	fw_base = virt_to_phys ( hermon->firmware_area );
 	DBGC ( hermon, "Hermon %p firmware area at physical [%08lx,%08lx)\n",
 	       hermon, fw_base, ( fw_base + fw_len ) );
 	if ( ( rc = hermon_map_vpm ( hermon, hermon_cmd_map_fa,
@@ -2752,7 +2752,7 @@ static int hermon_map_icm ( struct hermon *hermon,
 		assert ( hermon->icm_len == icm_len );
 		assert ( hermon->icm_aux_len == icm_aux_len );
 	}
-	icm_phys = user_to_phys ( hermon->icm, 0 );
+	icm_phys = virt_to_phys ( hermon->icm );
 
 	/* Map ICM auxiliary area */
 	DBGC ( hermon, "Hermon %p mapping ICM AUX => %08lx\n",
diff --git a/src/drivers/net/exanic.c b/src/drivers/net/exanic.c
index 14a17df47..b3148e090 100644
--- a/src/drivers/net/exanic.c
+++ b/src/drivers/net/exanic.c
@@ -406,7 +406,7 @@ static int exanic_open ( struct net_device *netdev ) {
 	port->rx_cons = 0;
 
 	/* Map receive region */
-	exanic_write_base ( phys_to_bus ( user_to_phys ( port->rx, 0 ) ),
+	exanic_write_base ( phys_to_bus ( virt_to_phys ( port->rx ) ),
 			    ( port->regs + EXANIC_PORT_RX_BASE ) );
 
 	/* Enable promiscuous mode */
@@ -729,8 +729,8 @@ static int exanic_probe_port ( struct exanic *exanic, struct device *dev,
 	DBGC ( port, "EXANIC %s port %d TX [%#05zx,%#05zx) TXF %#02x RX "
 	       "[%#lx,%#lx)\n", netdev->name, index, port->tx_offset,
 	       ( port->tx_offset + tx_len ), port->txf_slot,
-	       user_to_phys ( port->rx, 0 ),
-	       user_to_phys ( port->rx, EXANIC_RX_LEN ) );
+	       virt_to_phys ( port->rx ),
+	       ( virt_to_phys ( port->rx ) + EXANIC_RX_LEN ) );
 
 	/* Set initial link state */
 	exanic_check_link ( netdev );
diff --git a/src/drivers/net/gve.c b/src/drivers/net/gve.c
index 2cbc401f5..f9ec388a4 100644
--- a/src/drivers/net/gve.c
+++ b/src/drivers/net/gve.c
@@ -521,14 +521,14 @@ static int gve_deconfigure ( struct gve_nic *gve ) {
 static int gve_register ( struct gve_nic *gve, struct gve_qpl *qpl ) {
 	struct gve_pages *pages = &gve->scratch.buf->pages;
 	union gve_admin_command *cmd;
-	physaddr_t addr;
+	void *addr;
 	unsigned int i;
 	int rc;
 
 	/* Build page address list */
 	for ( i = 0 ; i < qpl->count ; i++ ) {
-		addr = user_to_phys ( qpl->data, ( i * GVE_PAGE_SIZE ) );
-		pages->addr[i] = cpu_to_be64 ( dma_phys ( &qpl->map, addr ) );
+		addr = ( qpl->data + ( i * GVE_PAGE_SIZE ) );
+		pages->addr[i] = cpu_to_be64 ( dma ( &qpl->map, addr ) );
 	}
 
 	/* Construct request */
@@ -575,11 +575,10 @@ static void gve_create_tx_param ( struct gve_queue *queue,
 				  union gve_admin_command *cmd ) {
 	struct gve_admin_create_tx *create = &cmd->create_tx;
 	const struct gve_queue_type *type = queue->type;
-	physaddr_t desc = user_to_phys ( queue->desc, 0 );
 
 	/* Construct request parameters */
 	create->res = cpu_to_be64 ( dma ( &queue->res_map, queue->res ) );
-	create->desc = cpu_to_be64 ( dma_phys ( &queue->desc_map, desc ) );
+	create->desc = cpu_to_be64 ( dma ( &queue->desc_map, queue->desc ) );
 	create->qpl_id = cpu_to_be32 ( type->qpl );
 	create->notify_id = cpu_to_be32 ( type->irq );
 }
@@ -594,14 +593,12 @@ static void gve_create_rx_param ( struct gve_queue *queue,
 				  union gve_admin_command *cmd ) {
 	struct gve_admin_create_rx *create = &cmd->create_rx;
 	const struct gve_queue_type *type = queue->type;
-	physaddr_t desc = user_to_phys ( queue->desc, 0 );
-	physaddr_t cmplt = user_to_phys ( queue->cmplt, 0 );
 
 	/* Construct request parameters */
 	create->notify_id = cpu_to_be32 ( type->irq );
 	create->res = cpu_to_be64 ( dma ( &queue->res_map, queue->res ) );
-	create->desc = cpu_to_be64 ( dma_phys ( &queue->desc_map, desc ) );
-	create->cmplt = cpu_to_be64 ( dma_phys ( &queue->cmplt_map, cmplt ) );
+	create->desc = cpu_to_be64 ( dma ( &queue->desc_map, queue->desc ) );
+	create->cmplt = cpu_to_be64 ( dma ( &queue->cmplt_map, queue->cmplt ));
 	create->qpl_id = cpu_to_be32 ( type->qpl );
 	create->bufsz = cpu_to_be16 ( GVE_BUF_SIZE );
 }
@@ -760,8 +757,8 @@ static int gve_alloc_qpl ( struct gve_nic *gve, struct gve_qpl *qpl,
 		return -ENOMEM;
 
 	DBGC ( gve, "GVE %p QPL %#08x at [%08lx,%08lx)\n",
-	       gve, qpl->id, user_to_phys ( qpl->data, 0 ),
-	       user_to_phys ( qpl->data, len ) );
+	       gve, qpl->id, virt_to_phys ( qpl->data ),
+	       ( virt_to_phys ( qpl->data ) + len ) );
 	return 0;
 }
 
@@ -883,8 +880,8 @@ static int gve_alloc_queue ( struct gve_nic *gve, struct gve_queue *queue ) {
 		goto err_desc;
 	}
 	DBGC ( gve, "GVE %p %s descriptors at [%08lx,%08lx)\n",
-	       gve, type->name, user_to_phys ( queue->desc, 0 ),
-	       user_to_phys ( queue->desc, desc_len ) );
+	       gve, type->name, virt_to_phys ( queue->desc ),
+	       ( virt_to_phys ( queue->desc ) + desc_len ) );
 
 	/* Allocate completions */
 	if ( cmplt_len ) {
@@ -895,8 +892,8 @@ static int gve_alloc_queue ( struct gve_nic *gve, struct gve_queue *queue ) {
 			goto err_cmplt;
 		}
 		DBGC ( gve, "GVE %p %s completions at [%08lx,%08lx)\n",
-		       gve, type->name, user_to_phys ( queue->cmplt, 0 ),
-		       user_to_phys ( queue->cmplt, cmplt_len ) );
+		       gve, type->name, virt_to_phys ( queue->cmplt ),
+		       ( virt_to_phys ( queue->cmplt ) + cmplt_len ) );
 	}
 
 	/* Allocate queue resources */
diff --git a/src/drivers/net/thunderx.c b/src/drivers/net/thunderx.c
index 1865a9b91..3d213b167 100644
--- a/src/drivers/net/thunderx.c
+++ b/src/drivers/net/thunderx.c
@@ -118,14 +118,14 @@ static int txnic_create_sq ( struct txnic *vnic ) {
 	writeq ( TXNIC_QS_SQ_CFG_RESET, ( vnic->regs + TXNIC_QS_SQ_CFG(0) ) );
 
 	/* Configure and enable send queue */
-	writeq ( user_to_phys ( vnic->sq.sqe, 0 ),
+	writeq ( virt_to_phys ( vnic->sq.sqe ),
 		 ( vnic->regs + TXNIC_QS_SQ_BASE(0) ) );
 	writeq ( ( TXNIC_QS_SQ_CFG_ENA | TXNIC_QS_SQ_CFG_QSIZE_1K ),
 		 ( vnic->regs + TXNIC_QS_SQ_CFG(0) ) );
 
 	DBGC ( vnic, "TXNIC %s SQ at [%08lx,%08lx)\n",
-	       vnic->name, user_to_phys ( vnic->sq.sqe, 0 ),
-	       user_to_phys ( vnic->sq.sqe, TXNIC_SQ_SIZE ) );
+	       vnic->name, virt_to_phys ( vnic->sq.sqe ),
+	       ( virt_to_phys ( vnic->sq.sqe ) + TXNIC_SQ_SIZE ) );
 	return 0;
 }
 
@@ -277,7 +277,7 @@ static int txnic_create_rq ( struct txnic *vnic ) {
 		 ( vnic->regs + TXNIC_QS_RBDR_CFG(0) ) );
 
 	/* Configure and enable receive buffer descriptor ring */
-	writeq ( user_to_phys ( vnic->rq.rqe, 0 ),
+	writeq ( virt_to_phys ( vnic->rq.rqe ),
 		 ( vnic->regs + TXNIC_QS_RBDR_BASE(0) ) );
 	writeq ( ( TXNIC_QS_RBDR_CFG_ENA | TXNIC_QS_RBDR_CFG_QSIZE_8K |
 		   TXNIC_QS_RBDR_CFG_LINES ( TXNIC_RQE_SIZE /
@@ -288,8 +288,8 @@ static int txnic_create_rq ( struct txnic *vnic ) {
 	writeq ( TXNIC_QS_RQ_CFG_ENA, ( vnic->regs + TXNIC_QS_RQ_CFG(0) ) );
 
 	DBGC ( vnic, "TXNIC %s RQ at [%08lx,%08lx)\n",
-	       vnic->name, user_to_phys ( vnic->rq.rqe, 0 ),
-	       user_to_phys ( vnic->rq.rqe, TXNIC_RQ_SIZE ) );
+	       vnic->name, virt_to_phys ( vnic->rq.rqe ),
+	       ( virt_to_phys ( vnic->rq.rqe ) + TXNIC_RQ_SIZE ) );
 	return 0;
 }
 
@@ -463,14 +463,14 @@ static int txnic_create_cq ( struct txnic *vnic ) {
 	writeq ( TXNIC_QS_CQ_CFG_RESET, ( vnic->regs + TXNIC_QS_CQ_CFG(0) ) );
 
 	/* Configure and enable completion queue */
-	writeq ( user_to_phys ( vnic->cq.cqe, 0 ),
+	writeq ( virt_to_phys ( vnic->cq.cqe ),
 		 ( vnic->regs + TXNIC_QS_CQ_BASE(0) ) );
 	writeq ( ( TXNIC_QS_CQ_CFG_ENA | TXNIC_QS_CQ_CFG_QSIZE_256 ),
 		 ( vnic->regs + TXNIC_QS_CQ_CFG(0) ) );
 
 	DBGC ( vnic, "TXNIC %s CQ at [%08lx,%08lx)\n",
-	       vnic->name, user_to_phys ( vnic->cq.cqe, 0 ),
-	       user_to_phys ( vnic->cq.cqe, TXNIC_CQ_SIZE ) );
+	       vnic->name, virt_to_phys ( vnic->cq.cqe ),
+	       ( virt_to_phys ( vnic->cq.cqe ) + TXNIC_CQ_SIZE ) );
 	return 0;
 }
 
@@ -559,7 +559,8 @@ static void txnic_poll_cq ( struct txnic *vnic ) {
 		default:
 			DBGC ( vnic, "TXNIC %s unknown completion type %d\n",
 			       vnic->name, cqe.common.cqe_type );
-			DBGC_HDA ( vnic, user_to_phys ( vnic->cq.cqe, offset ),
+			DBGC_HDA ( vnic,
+				   ( virt_to_phys ( vnic->cq.cqe ) + offset ),
 				   &cqe, sizeof ( cqe ) );
 			break;
 		}
diff --git a/src/drivers/usb/xhci.c b/src/drivers/usb/xhci.c
index f244086ce..30ee09bbb 100644
--- a/src/drivers/usb/xhci.c
+++ b/src/drivers/usb/xhci.c
@@ -1014,8 +1014,7 @@ static int xhci_scratchpad_alloc ( struct xhci_device *xhci ) {
 	}
 
 	/* Populate scratchpad array */
-	addr = dma_phys ( &scratch->buffer_map,
-			  user_to_phys ( scratch->buffer, 0 ) );
+	addr = dma ( &scratch->buffer_map, scratch->buffer );
 	for ( i = 0 ; i < scratch->count ; i++ ) {
 		scratch->array[i] = cpu_to_le64 ( addr );
 		addr += xhci->pagesize;
@@ -1027,8 +1026,8 @@ static int xhci_scratchpad_alloc ( struct xhci_device *xhci ) {
 						     scratch->array ) );
 
 	DBGC2 ( xhci, "XHCI %s scratchpad [%08lx,%08lx) array [%08lx,%08lx)\n",
-		xhci->name, user_to_phys ( scratch->buffer, 0 ),
-		user_to_phys ( scratch->buffer, buffer_len ),
+		xhci->name, virt_to_phys ( scratch->buffer ),
+		( virt_to_phys ( scratch->buffer ) + buffer_len ),
 		virt_to_phys ( scratch->array ),
 		( virt_to_phys ( scratch->array ) + array_len ) );
 	return 0;
diff --git a/src/hci/commands/image_mem_cmd.c b/src/hci/commands/image_mem_cmd.c
index c8bfab1ad..5f8363461 100644
--- a/src/hci/commands/image_mem_cmd.c
+++ b/src/hci/commands/image_mem_cmd.c
@@ -81,7 +81,7 @@ static int imgmem_exec ( int argc, char **argv ) {
 		return rc;
 
 	/* Create image */
-	if ( ( rc = imgmem ( opts.name, phys_to_user ( data ), len ) ) != 0 )
+	if ( ( rc = imgmem ( opts.name, phys_to_virt ( data ), len ) ) != 0 )
 		return rc;
 
 	return 0;
diff --git a/src/image/elf.c b/src/image/elf.c
index 46c9fe8eb..fa714b15f 100644
--- a/src/image/elf.c
+++ b/src/image/elf.c
@@ -50,7 +50,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 static int elf_load_segment ( struct image *image, Elf_Phdr *phdr,
 			      physaddr_t dest ) {
-	userptr_t buffer = phys_to_user ( dest );
+	userptr_t buffer = phys_to_virt ( dest );
 	int rc;
 
 	DBGC ( image, "ELF %p loading segment [%x,%x) to [%lx,%lx,%lx)\n",
diff --git a/src/image/segment.c b/src/image/segment.c
index b7f8ef56c..ebc2b703d 100644
--- a/src/image/segment.c
+++ b/src/image/segment.c
@@ -59,9 +59,9 @@ struct errortab segment_errors[] __errortab = {
  */
 int prep_segment ( userptr_t segment, size_t filesz, size_t memsz ) {
 	struct memory_map memmap;
-	physaddr_t start = user_to_phys ( segment, 0 );
-	physaddr_t mid = user_to_phys ( segment, filesz );
-	physaddr_t end = user_to_phys ( segment, memsz );
+	physaddr_t start = virt_to_phys ( segment );
+	physaddr_t mid = ( start + filesz );
+	physaddr_t end = ( start + memsz );
 	unsigned int i;
 
 	DBG ( "Preparing segment [%lx,%lx,%lx)\n", start, mid, end );
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index 4b1257b1e..b4f7e2fc6 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -10,10 +10,9 @@
  *
  * We have no concept of the underlying physical addresses, since
  * these are not exposed to userspace.  We provide a stub
- * implementation of user_to_phys() since this is required by
- * alloc_memblock().  We provide no implementation of phys_to_user();
- * any code attempting to access physical addresses will therefore
- * (correctly) fail to link.
+ * implementation of virt_to_phys() since this is required by
+ * alloc_memblock().  We provide a matching stub implementation of
+ * phys_to_virt().
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
@@ -25,14 +24,13 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #endif
 
 /**
- * Convert user pointer to physical address
+ * Convert virtual address to physical address
  *
- * @v userptr		User pointer
- * @v offset		Offset from user pointer
- * @ret phys_addr	Physical address
+ * @v virt		Virtual address
+ * @ret phys		Physical address
  */
-static inline __always_inline unsigned long
-UACCESS_INLINE ( linux, user_to_phys ) ( userptr_t userptr, off_t offset ) {
+static inline __always_inline physaddr_t
+UACCESS_INLINE ( linux, virt_to_phys ) ( volatile const void *virt ) {
 
 	/* We do not know the real underlying physical address.  We
 	 * provide this stub implementation only because it is
@@ -43,20 +41,20 @@ UACCESS_INLINE ( linux, user_to_phys ) ( userptr_t userptr, off_t offset ) {
 	 * virtual address will suffice for the purpose of determining
 	 * alignment.
 	 */
-	return ( ( unsigned long ) ( userptr + offset ) );
+	return ( ( physaddr_t ) virt );
 }
 
 /**
- * Convert physical address to user pointer
+ * Convert physical address to virtual address
  *
- * @v phys_addr		Physical address
- * @ret userptr		User pointer
+ * @v phys		Physical address
+ * @ret virt		Virtual address
  */
-static inline __always_inline userptr_t
-UACCESS_INLINE ( linux, phys_to_user ) ( physaddr_t phys_addr ) {
+static inline __always_inline void *
+UACCESS_INLINE ( linux, phys_to_virt ) ( physaddr_t phys ) {
 
-	/* For symmetry with the stub user_to_phys() */
-	return ( ( userptr_t ) phys_addr );
+	/* For symmetry with the stub virt_to_phys() */
+	return ( ( void * ) phys );
 }
 
 static inline __always_inline userptr_t
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 4b3524bab..62030dd8a 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -99,14 +99,14 @@ trivial_memchr_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
 #define PROVIDE_UACCESS_INLINE( _subsys, _api_func ) \
 	PROVIDE_SINGLE_API_INLINE ( UACCESS_PREFIX_ ## _subsys, _api_func )
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( flat, phys_to_user ) ( unsigned long phys_addr ) {
-	return ( ( userptr_t ) phys_addr );
+static inline __always_inline void *
+UACCESS_INLINE ( flat, phys_to_virt ) ( physaddr_t phys ) {
+	return ( ( void * ) phys );
 }
 
-static inline __always_inline unsigned long
-UACCESS_INLINE ( flat, user_to_phys ) ( userptr_t userptr, off_t offset ) {
-	return ( ( unsigned long ) ( userptr + offset ) );
+static inline __always_inline physaddr_t
+UACCESS_INLINE ( flat, virt_to_phys ) ( volatile const void *virt ) {
+	return ( ( physaddr_t ) virt );
 }
 
 static inline __always_inline userptr_t
@@ -126,23 +126,6 @@ UACCESS_INLINE ( flat, memchr_user ) ( userptr_t buffer, off_t offset,
 /* Include all architecture-dependent user access API headers */
 #include <bits/uaccess.h>
 
-/**
- * Convert physical address to user pointer
- *
- * @v phys_addr		Physical address
- * @ret userptr		User pointer
- */
-userptr_t phys_to_user ( unsigned long phys_addr );
-
-/**
- * Convert user pointer to physical address
- *
- * @v userptr		User pointer
- * @v offset		Offset from user pointer
- * @ret phys_addr	Physical address
- */
-unsigned long user_to_phys ( userptr_t userptr, off_t offset );
-
 /**
  * Convert virtual address to user pointer
  *
@@ -154,25 +137,21 @@ userptr_t virt_to_user ( volatile const void *addr );
 /**
  * Convert virtual address to a physical address
  *
- * @v addr		Virtual address
- * @ret phys_addr	Physical address
+ * @v virt		Virtual address
+ * @ret phys		Physical address
  */
-static inline __always_inline unsigned long
-virt_to_phys ( volatile const void *addr ) {
-	return user_to_phys ( virt_to_user ( addr ), 0 );
-}
+physaddr_t __attribute__ (( const ))
+virt_to_phys ( volatile const void *virt );
 
 /**
  * Convert physical address to a virtual address
  *
- * @v addr		Virtual address
- * @ret phys_addr	Physical address
+ * @v phys		Physical address
+ * @ret virt		Virtual address
  *
  * This operation is not available under all memory models.
  */
-static inline __always_inline void * phys_to_virt ( unsigned long phys_addr ) {
-	return ( phys_to_user ( phys_addr ) );
-}
+void * __attribute__ (( const )) phys_to_virt ( physaddr_t phys );
 
 /**
  * Copy data to user buffer
diff --git a/src/interface/efi/efi_acpi.c b/src/interface/efi/efi_acpi.c
index 07a225632..c1046c01a 100644
--- a/src/interface/efi/efi_acpi.c
+++ b/src/interface/efi/efi_acpi.c
@@ -48,7 +48,7 @@ static userptr_t efi_find_rsdt ( void ) {
 
 	/* Locate RSDT via ACPI configuration table, if available */
 	if ( rsdp )
-		return phys_to_user ( rsdp->RsdtAddress );
+		return phys_to_virt ( rsdp->RsdtAddress );
 
 	return UNULL;
 }
diff --git a/src/interface/efi/efi_fbcon.c b/src/interface/efi/efi_fbcon.c
index 659ebd37e..09cfde4c2 100644
--- a/src/interface/efi/efi_fbcon.c
+++ b/src/interface/efi/efi_fbcon.c
@@ -583,7 +583,7 @@ static int efifb_init ( struct console_configuration *config ) {
 	       mode, efifb.pixel.width, efifb.pixel.height, bpp, efifb.start );
 
 	/* Initialise frame buffer console */
-	if ( ( rc = fbcon_init ( &efifb.fbcon, phys_to_user ( efifb.start ),
+	if ( ( rc = fbcon_init ( &efifb.fbcon, phys_to_virt ( efifb.start ),
 				 &efifb.pixel, &efifb.map, &efifb.font,
 				 config ) ) != 0 )
 		goto err_fbcon_init;
diff --git a/src/interface/efi/efi_smbios.c b/src/interface/efi/efi_smbios.c
index d7877b0aa..3c1b77bdc 100644
--- a/src/interface/efi/efi_smbios.c
+++ b/src/interface/efi/efi_smbios.c
@@ -48,27 +48,27 @@ static int efi_find_smbios ( struct smbios *smbios ) {
 
 	/* Use 64-bit table if present */
 	if ( smbios3_entry && ( smbios3_entry->signature == SMBIOS3_SIGNATURE ) ) {
-		smbios->address = phys_to_user ( smbios3_entry->smbios_address );
+		smbios->address = phys_to_virt ( smbios3_entry->smbios_address );
 		smbios->len = smbios3_entry->smbios_len;
 		smbios->count = 0;
 		smbios->version =
 			SMBIOS_VERSION ( smbios3_entry->major, smbios3_entry->minor );
 		DBG ( "Found 64-bit SMBIOS v%d.%d entry point at %p (%lx+%zx)\n",
 		      smbios3_entry->major, smbios3_entry->minor, smbios3_entry,
-		      user_to_phys ( smbios->address, 0 ), smbios->len );
+		      virt_to_phys ( smbios->address ), smbios->len );
 		return 0;
 	}
 
 	/* Otherwise, use 32-bit table if present */
 	if ( smbios_entry && ( smbios_entry->signature == SMBIOS_SIGNATURE ) ) {
-		smbios->address = phys_to_user ( smbios_entry->smbios_address );
+		smbios->address = phys_to_virt ( smbios_entry->smbios_address );
 		smbios->len = smbios_entry->smbios_len;
 		smbios->count = smbios_entry->smbios_count;
 		smbios->version =
 			SMBIOS_VERSION ( smbios_entry->major, smbios_entry->minor );
 		DBG ( "Found 32-bit SMBIOS v%d.%d entry point at %p (%lx+%zx)\n",
 		      smbios_entry->major, smbios_entry->minor, smbios_entry,
-		      user_to_phys ( smbios->address, 0 ), smbios->len );
+		      virt_to_phys ( smbios->address ), smbios->len );
 		return 0;
 	}
 
diff --git a/src/interface/efi/efi_umalloc.c b/src/interface/efi/efi_umalloc.c
index 488c53f3d..0636cb7fd 100644
--- a/src/interface/efi/efi_umalloc.c
+++ b/src/interface/efi/efi_umalloc.c
@@ -72,7 +72,7 @@ static userptr_t efi_urealloc ( userptr_t old_ptr, size_t new_size ) {
 			return UNULL;
 		}
 		assert ( phys_addr != 0 );
-		new_ptr = phys_to_user ( phys_addr + EFI_PAGE_SIZE );
+		new_ptr = phys_to_virt ( phys_addr + EFI_PAGE_SIZE );
 		copy_to_user ( new_ptr, -EFI_PAGE_SIZE,
 			       &new_size, sizeof ( new_size ) );
 		DBG ( "EFI allocated %d pages at %llx\n",
@@ -90,7 +90,7 @@ static userptr_t efi_urealloc ( userptr_t old_ptr, size_t new_size ) {
 		memcpy ( new_ptr, old_ptr,
 			 ( (old_size < new_size) ? old_size : new_size ) );
 		old_pages = ( EFI_SIZE_TO_PAGES ( old_size ) + 1 );
-		phys_addr = user_to_phys ( old_ptr, -EFI_PAGE_SIZE );
+		phys_addr = virt_to_phys ( old_ptr - EFI_PAGE_SIZE );
 		if ( ( efirc = bs->FreePages ( phys_addr, old_pages ) ) != 0 ){
 			rc = -EEFI ( efirc );
 			DBG ( "EFI could not free %d pages at %llx: %s\n",
diff --git a/src/interface/hyperv/vmbus.c b/src/interface/hyperv/vmbus.c
index 86d2a08d7..49ccf69c8 100644
--- a/src/interface/hyperv/vmbus.c
+++ b/src/interface/hyperv/vmbus.c
@@ -277,7 +277,7 @@ int vmbus_establish_gpadl ( struct vmbus_device *vmdev, userptr_t data,
 			    size_t len ) {
 	struct hv_hypervisor *hv = vmdev->hv;
 	struct vmbus *vmbus = hv->vmbus;
-	physaddr_t addr = user_to_phys ( data, 0 );
+	physaddr_t addr = virt_to_phys ( data );
 	unsigned int pfn_count = hv_pfn_count ( addr, len );
 	struct {
 		struct vmbus_gpadl_header gpadlhdr;
diff --git a/src/interface/linux/linux_uaccess.c b/src/interface/linux/linux_uaccess.c
index e5c394365..4fdd8c03a 100644
--- a/src/interface/linux/linux_uaccess.c
+++ b/src/interface/linux/linux_uaccess.c
@@ -27,6 +27,7 @@ FILE_LICENCE(GPL2_OR_LATER);
  *
  */
 
-PROVIDE_UACCESS_INLINE(linux, user_to_phys);
+PROVIDE_UACCESS_INLINE(linux, phys_to_virt);
+PROVIDE_UACCESS_INLINE(linux, virt_to_phys);
 PROVIDE_UACCESS_INLINE(linux, virt_to_user);
 PROVIDE_UACCESS_INLINE(linux, memchr_user);
diff --git a/src/interface/smbios/smbios.c b/src/interface/smbios/smbios.c
index 3e69a0c15..89fa4d7ca 100644
--- a/src/interface/smbios/smbios.c
+++ b/src/interface/smbios/smbios.c
@@ -86,14 +86,14 @@ int find_smbios_entry ( userptr_t start, size_t len,
 		if ( ( sum = smbios_checksum ( start, offset,
 					       entry->len ) ) != 0 ) {
 			DBG ( "SMBIOS at %08lx has bad checksum %02x\n",
-			      user_to_phys ( start, offset ), sum );
+			      virt_to_phys ( start + offset ), sum );
 			continue;
 		}
 
 		/* Fill result structure */
 		DBG ( "Found SMBIOS v%d.%d entry point at %08lx\n",
 		      entry->major, entry->minor,
-		      user_to_phys ( start, offset ) );
+		      virt_to_phys ( start + offset ) );
 		return 0;
 	}
 
@@ -126,14 +126,14 @@ int find_smbios3_entry ( userptr_t start, size_t len,
 		if ( ( sum = smbios_checksum ( start, offset,
 					       entry->len ) ) != 0 ) {
 			DBG ( "SMBIOS3 at %08lx has bad checksum %02x\n",
-			      user_to_phys ( start, offset ), sum );
+			      virt_to_phys ( start + offset ), sum );
 			continue;
 		}
 
 		/* Fill result structure */
 		DBG ( "Found SMBIOS3 v%d.%d entry point at %08lx\n",
 		      entry->major, entry->minor,
-		      user_to_phys ( start, offset ) );
+		      virt_to_phys ( start + offset ) );
 		return 0;
 	}
 
-- 
cgit v1.2.3-55-g7522


From 04d0b2fdf9767fed690cdaaf36b4cd60c6bded02 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 21 Apr 2025 18:55:30 +0100
Subject: [uaccess] Remove redundant read_user()

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/interface/pxe/pxe_file.c          |  6 +++---
 src/arch/x86/interface/syslinux/comboot_call.c |  5 +++--
 src/core/posix_io.c                            |  9 ++++-----
 src/include/ipxe/posix_io.h                    | 16 +---------------
 4 files changed, 11 insertions(+), 25 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/interface/pxe/pxe_file.c b/src/arch/x86/interface/pxe/pxe_file.c
index 64bc335f2..6bb9f525f 100644
--- a/src/arch/x86/interface/pxe/pxe_file.c
+++ b/src/arch/x86/interface/pxe/pxe_file.c
@@ -148,7 +148,7 @@ pxenv_file_select ( struct s_PXENV_FILE_SELECT *file_select ) {
  *
  */
 static PXENV_EXIT_t pxenv_file_read ( struct s_PXENV_FILE_READ *file_read ) {
-	userptr_t buffer;
+	void *buffer;
 	ssize_t len;
 
 	DBG ( "PXENV_FILE_READ %d to %04x:%04x+%04x", file_read->FileHandle,
@@ -157,8 +157,8 @@ static PXENV_EXIT_t pxenv_file_read ( struct s_PXENV_FILE_READ *file_read ) {
 
 	buffer = real_to_virt ( file_read->Buffer.segment,
 				file_read->Buffer.offset );
-	if ( ( len = read_user ( file_read->FileHandle, buffer, 0,
-				file_read->BufferSize ) ) < 0 ) {
+	if ( ( len = read ( file_read->FileHandle, buffer,
+			    file_read->BufferSize ) ) < 0 ) {
 		file_read->Status = PXENV_STATUS ( len );
 		return PXENV_EXIT_FAILURE;
 	}
diff --git a/src/arch/x86/interface/syslinux/comboot_call.c b/src/arch/x86/interface/syslinux/comboot_call.c
index d8c245757..15539ada5 100644
--- a/src/arch/x86/interface/syslinux/comboot_call.c
+++ b/src/arch/x86/interface/syslinux/comboot_call.c
@@ -410,7 +410,8 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 			int len = ix86->regs.cx * COMBOOT_FILE_BLOCKSZ;
 			int rc;
 			fd_set fds;
-			userptr_t buf = real_to_virt ( ix86->segs.es, ix86->regs.bx );
+			void *buf = real_to_virt ( ix86->segs.es,
+						   ix86->regs.bx );
 
 			/* Wait for data ready to read */
 			FD_ZERO ( &fds );
@@ -418,7 +419,7 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 
 			select ( &fds, 1 );
 
-			rc = read_user ( fd, buf, 0, len );
+			rc = read ( fd, buf, len );
 			if ( rc < 0 ) {
 				DBG ( "COMBOOT: read failed\n" );
 				ix86->regs.si = 0;
diff --git a/src/core/posix_io.c b/src/core/posix_io.c
index 35b52beeb..9112798ec 100644
--- a/src/core/posix_io.c
+++ b/src/core/posix_io.c
@@ -254,15 +254,14 @@ int select ( fd_set *readfds, int wait ) {
 /**
  * Read data from file
  *
- * @v buffer		Data buffer
- * @v offset		Starting offset within data buffer
- * @v len		Maximum length to read
+ * @v buf		Data buffer
+ * @v max_len		Maximum length to read
  * @ret len		Actual length read, or negative error number
  *
  * This call is non-blocking; if no data is available to read then
  * -EWOULDBLOCK will be returned.
  */
-ssize_t read_user ( int fd, userptr_t buffer, off_t offset, size_t max_len ) {
+ssize_t read ( int fd, void *buf, size_t max_len ) {
 	struct posix_file *file;
 	struct io_buffer *iobuf;
 	size_t len;
@@ -281,7 +280,7 @@ ssize_t read_user ( int fd, userptr_t buffer, off_t offset, size_t max_len ) {
 		len = iob_len ( iobuf );
 		if ( len > max_len )
 			len = max_len;
-		copy_to_user ( buffer, offset, iobuf->data, len );
+		memcpy ( buf, iobuf->data, len );
 		iob_pull ( iobuf, len );
 		if ( ! iob_len ( iobuf ) ) {
 			list_del ( &iobuf->list );
diff --git a/src/include/ipxe/posix_io.h b/src/include/ipxe/posix_io.h
index 1a73b5e86..693e0ae34 100644
--- a/src/include/ipxe/posix_io.h
+++ b/src/include/ipxe/posix_io.h
@@ -10,7 +10,6 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 
 /** Minimum file descriptor that will ever be allocated */
 #define POSIX_FD_MIN ( 1 )
@@ -22,8 +21,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 typedef uint32_t fd_set;
 
 extern int open ( const char *uri_string );
-extern ssize_t read_user ( int fd, userptr_t buffer,
-			   off_t offset, size_t len );
+extern ssize_t read ( int fd, void *buf, size_t len );
 extern int select ( fd_set *readfds, int wait );
 extern ssize_t fsize ( int fd );
 extern int close ( int fd );
@@ -72,16 +70,4 @@ FD_ISSET ( int fd, fd_set *set ) {
 	return ( *set & ( 1 << fd ) );
 }
 
-/**
- * Read data from file
- *
- * @v fd		File descriptor
- * @v buf		Data buffer
- * @v len		Maximum length to read
- * @ret len		Actual length read, or negative error number
- */
-static inline ssize_t read ( int fd, void *buf, size_t len ) {
-	return read_user ( fd, virt_to_user ( buf ), 0, len );
-}
-
 #endif /* _IPXE_POSIX_IO_H */
-- 
cgit v1.2.3-55-g7522


From b89a34b07fee8b8bfb3cdf7d85d058c89e9d5b6f Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 22 Apr 2025 12:20:26 +0100
Subject: [image] Remove userptr_t from image definition

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/image.c          | 7 ++++---
 src/include/ipxe/image.h  | 7 ++++---
 src/include/usr/imgmgmt.h | 2 +-
 src/usr/imgmgmt.c         | 2 +-
 4 files changed, 10 insertions(+), 8 deletions(-)

(limited to 'src/core')

diff --git a/src/core/image.c b/src/core/image.c
index e90d82ffb..a49ca7e1d 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -218,7 +218,7 @@ int image_set_cmdline ( struct image *image, const char *cmdline ) {
  * @ret rc		Return status code
  */
 int image_set_len ( struct image *image, size_t len ) {
-	userptr_t new;
+	void *new;
 
 	/* (Re)allocate image data */
 	new = urealloc ( image->data, len );
@@ -238,7 +238,7 @@ int image_set_len ( struct image *image, size_t len ) {
  * @v len		Length of image data
  * @ret rc		Return status code
  */
-int image_set_data ( struct image *image, userptr_t data, size_t len ) {
+int image_set_data ( struct image *image, const void *data, size_t len ) {
 	int rc;
 
 	/* Set image length */
@@ -566,7 +566,8 @@ int image_set_trust ( int require_trusted, int permanent ) {
  * @v len		Length
  * @ret image		Image, or NULL on error
  */
-struct image * image_memory ( const char *name, userptr_t data, size_t len ) {
+struct image * image_memory ( const char *name, const void *data,
+			      size_t len ) {
 	struct image *image;
 	int rc;
 
diff --git a/src/include/ipxe/image.h b/src/include/ipxe/image.h
index ca383dc7b..bf2d77626 100644
--- a/src/include/ipxe/image.h
+++ b/src/include/ipxe/image.h
@@ -38,7 +38,7 @@ struct image {
 	/** Command line to pass to image */
 	char *cmdline;
 	/** Raw file image */
-	userptr_t data;
+	void *data;
 	/** Length of raw file image */
 	size_t len;
 
@@ -191,7 +191,8 @@ extern int image_set_name ( struct image *image, const char *name );
 extern char * image_strip_suffix ( struct image *image );
 extern int image_set_cmdline ( struct image *image, const char *cmdline );
 extern int image_set_len ( struct image *image, size_t len );
-extern int image_set_data ( struct image *image, userptr_t data, size_t len );
+extern int image_set_data ( struct image *image, const void *data,
+			    size_t len );
 extern int register_image ( struct image *image );
 extern void unregister_image ( struct image *image );
 extern struct image * find_image ( const char *name );
@@ -200,7 +201,7 @@ extern int image_exec ( struct image *image );
 extern int image_replace ( struct image *replacement );
 extern int image_select ( struct image *image );
 extern int image_set_trust ( int require_trusted, int permanent );
-extern struct image * image_memory ( const char *name, userptr_t data,
+extern struct image * image_memory ( const char *name, const void *data,
 				     size_t len );
 extern const char * image_argument ( struct image *image, const char *key );
 extern int image_pixbuf ( struct image *image, struct pixel_buffer **pixbuf );
diff --git a/src/include/usr/imgmgmt.h b/src/include/usr/imgmgmt.h
index 14fb7cbc6..506c3eb14 100644
--- a/src/include/usr/imgmgmt.h
+++ b/src/include/usr/imgmgmt.h
@@ -18,6 +18,6 @@ extern int imgdownload_string ( const char *uri_string, unsigned long timeout,
 extern int imgacquire ( const char *name, unsigned long timeout,
 			struct image **image );
 extern void imgstat ( struct image *image );
-extern int imgmem ( const char *name, userptr_t data, size_t len );
+extern int imgmem ( const char *name, const void *data, size_t len );
 
 #endif /* _USR_IMGMGMT_H */
diff --git a/src/usr/imgmgmt.c b/src/usr/imgmgmt.c
index 92bf236f9..054137696 100644
--- a/src/usr/imgmgmt.c
+++ b/src/usr/imgmgmt.c
@@ -184,7 +184,7 @@ void imgstat ( struct image *image ) {
  * @v len		Length
  * @ret rc		Return status code
  */
-int imgmem ( const char *name, userptr_t data, size_t len ) {
+int imgmem ( const char *name, const void *data, size_t len ) {
 	struct image *image;
 
 	/* Create image */
-- 
cgit v1.2.3-55-g7522


From 0b3fc48fefd311b17b666fecf3a34688717727e8 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 22 Apr 2025 14:13:45 +0100
Subject: [acpi] Remove userptr_t from ACPI table parsing

Simplify the ACPI table parsing code by assuming that all table
content is fully accessible via pointer dereferences.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/ipxe/rsdp.h           |   4 +-
 src/arch/x86/interface/pcbios/acpi_timer.c |   9 +--
 src/arch/x86/interface/pcbios/acpipwr.c    |  18 ++---
 src/arch/x86/interface/pcbios/rsdp.c       |  33 ++++----
 src/core/acpi.c                            | 116 +++++++++++++----------------
 src/core/acpi_settings.c                   |  21 +++---
 src/core/acpimac.c                         |  17 +++--
 src/drivers/bus/ecam.c                     |  34 ++++-----
 src/include/ipxe/acpi.h                    |  24 +++---
 src/include/ipxe/efi/efi_acpi.h            |   4 +-
 src/include/ipxe/null_acpi.h               |   6 +-
 src/interface/efi/efi_acpi.c               |   7 +-
 src/interface/linux/linux_acpi.c           |   9 ++-
 src/tests/acpi_test.c                      |  12 +--
 14 files changed, 152 insertions(+), 162 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/include/ipxe/rsdp.h b/src/arch/x86/include/ipxe/rsdp.h
index 14afcd774..daaa43077 100644
--- a/src/arch/x86/include/ipxe/rsdp.h
+++ b/src/arch/x86/include/ipxe/rsdp.h
@@ -20,9 +20,9 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-static inline __attribute__ (( always_inline )) userptr_t
+static inline __attribute__ (( always_inline )) const struct acpi_header *
 ACPI_INLINE ( rsdp, acpi_find ) ( uint32_t signature, unsigned int index ) {
 
 	return acpi_find_via_rsdt ( signature, index );
diff --git a/src/arch/x86/interface/pcbios/acpi_timer.c b/src/arch/x86/interface/pcbios/acpi_timer.c
index 2e4047e38..e1523578b 100644
--- a/src/arch/x86/interface/pcbios/acpi_timer.c
+++ b/src/arch/x86/interface/pcbios/acpi_timer.c
@@ -102,20 +102,19 @@ static void acpi_udelay ( unsigned long usecs ) {
  * @ret rc		Return status code
  */
 static int acpi_timer_probe ( void ) {
-	struct acpi_fadt fadtab;
-	userptr_t fadt;
+	const struct acpi_fadt *fadt;
 	unsigned int pm_tmr_blk;
 
 	/* Locate FADT */
-	fadt = acpi_table ( FADT_SIGNATURE, 0 );
+	fadt = container_of ( acpi_table ( FADT_SIGNATURE, 0 ),
+			      struct acpi_fadt, acpi );
 	if ( ! fadt ) {
 		DBGC ( &acpi_timer, "ACPI could not find FADT\n" );
 		return -ENOENT;
 	}
 
 	/* Read FADT */
-	copy_from_user ( &fadtab, fadt, 0, sizeof ( fadtab ) );
-	pm_tmr_blk = le32_to_cpu ( fadtab.pm_tmr_blk );
+	pm_tmr_blk = le32_to_cpu ( fadt->pm_tmr_blk );
 	if ( ! pm_tmr_blk ) {
 		DBGC ( &acpi_timer, "ACPI has no timer\n" );
 		return -ENOENT;
diff --git a/src/arch/x86/interface/pcbios/acpipwr.c b/src/arch/x86/interface/pcbios/acpipwr.c
index f08b4af25..bff53806b 100644
--- a/src/arch/x86/interface/pcbios/acpipwr.c
+++ b/src/arch/x86/interface/pcbios/acpipwr.c
@@ -62,8 +62,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * uglier hacks I have ever implemented, but it's still prettier than
  * the ACPI specification itself.
  */
-static int acpi_extract_sx ( userptr_t zsdt, size_t len, size_t offset,
-			     void *data ) {
+static int acpi_extract_sx ( const struct acpi_header *zsdt, size_t len,
+			     size_t offset, void *data ) {
 	unsigned int *sx = data;
 	uint8_t bytes[4];
 	uint8_t *byte;
@@ -77,7 +77,8 @@ static int acpi_extract_sx ( userptr_t zsdt, size_t len, size_t offset,
 	}
 
 	/* Read first four bytes of value */
-	copy_from_user ( bytes, zsdt, offset, sizeof ( bytes ) );
+	memcpy ( bytes, ( ( ( const void * ) zsdt ) + offset ),
+		 sizeof ( bytes ) );
 	DBGC ( colour, "ACPI found \\_Sx containing %02x:%02x:%02x:%02x\n",
 	       bytes[0], bytes[1], bytes[2], bytes[3] );
 
@@ -111,8 +112,7 @@ static int acpi_extract_sx ( userptr_t zsdt, size_t len, size_t offset,
  * @ret rc		Return status code
  */
 int acpi_poweroff ( void ) {
-	struct acpi_fadt fadtab;
-	userptr_t fadt;
+	const struct acpi_fadt *fadt;
 	unsigned int pm1a_cnt_blk;
 	unsigned int pm1b_cnt_blk;
 	unsigned int pm1a_cnt;
@@ -123,16 +123,16 @@ int acpi_poweroff ( void ) {
 	int rc;
 
 	/* Locate FADT */
-	fadt = acpi_table ( FADT_SIGNATURE, 0 );
+	fadt = container_of ( acpi_table ( FADT_SIGNATURE, 0 ),
+			      struct acpi_fadt, acpi );
 	if ( ! fadt ) {
 		DBGC ( colour, "ACPI could not find FADT\n" );
 		return -ENOENT;
 	}
 
 	/* Read FADT */
-	copy_from_user ( &fadtab, fadt, 0, sizeof ( fadtab ) );
-	pm1a_cnt_blk = le32_to_cpu ( fadtab.pm1a_cnt_blk );
-	pm1b_cnt_blk = le32_to_cpu ( fadtab.pm1b_cnt_blk );
+	pm1a_cnt_blk = le32_to_cpu ( fadt->pm1a_cnt_blk );
+	pm1b_cnt_blk = le32_to_cpu ( fadt->pm1b_cnt_blk );
 	pm1a_cnt = ( pm1a_cnt_blk + ACPI_PM1_CNT );
 	pm1b_cnt = ( pm1b_cnt_blk + ACPI_PM1_CNT );
 
diff --git a/src/arch/x86/interface/pcbios/rsdp.c b/src/arch/x86/interface/pcbios/rsdp.c
index c2534c7f6..6bcf19b18 100644
--- a/src/arch/x86/interface/pcbios/rsdp.c
+++ b/src/arch/x86/interface/pcbios/rsdp.c
@@ -53,50 +53,51 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  * @v start		Start address to search
  * @v len		Length to search
- * @ret rsdt		ACPI root system description table, or UNULL
+ * @ret rsdt		ACPI root system description table, or NULL
  */
-static userptr_t rsdp_find_rsdt_range ( userptr_t start, size_t len ) {
+static const struct acpi_rsdt * rsdp_find_rsdt_range ( const void *start,
+						       size_t len ) {
 	static const char signature[8] = RSDP_SIGNATURE;
-	struct acpi_rsdp rsdp;
-	userptr_t rsdt;
+	const struct acpi_rsdp *rsdp;
+	const struct acpi_rsdt *rsdt;
 	size_t offset;
 	uint8_t sum;
 	unsigned int i;
 
 	/* Search for RSDP */
-	for ( offset = 0 ; ( ( offset + sizeof ( rsdp ) ) < len ) ;
+	for ( offset = 0 ; ( ( offset + sizeof ( *rsdp ) ) < len ) ;
 	      offset += RSDP_STRIDE ) {
 
 		/* Check signature and checksum */
-		copy_from_user ( &rsdp, start, offset, sizeof ( rsdp ) );
-		if ( memcmp ( rsdp.signature, signature,
+		rsdp = ( start + offset );
+		if ( memcmp ( rsdp->signature, signature,
 			      sizeof ( signature ) ) != 0 )
 			continue;
-		for ( sum = 0, i = 0 ; i < sizeof ( rsdp ) ; i++ )
-			sum += *( ( ( uint8_t * ) &rsdp ) + i );
+		for ( sum = 0, i = 0 ; i < sizeof ( *rsdp ) ; i++ )
+			sum += *( ( ( uint8_t * ) rsdp ) + i );
 		if ( sum != 0 )
 			continue;
 
 		/* Extract RSDT */
-		rsdt = phys_to_virt ( le32_to_cpu ( rsdp.rsdt ) );
+		rsdt = phys_to_virt ( le32_to_cpu ( rsdp->rsdt ) );
 		DBGC ( rsdt, "RSDT %#08lx found via RSDP %#08lx\n",
 		       virt_to_phys ( rsdt ),
 		       ( virt_to_phys ( start ) + offset ) );
 		return rsdt;
 	}
 
-	return UNULL;
+	return NULL;
 }
 
 /**
  * Locate ACPI root system description table
  *
- * @ret rsdt		ACPI root system description table, or UNULL
+ * @ret rsdt		ACPI root system description table, or NULL
  */
-static userptr_t rsdp_find_rsdt ( void ) {
-	static userptr_t rsdt;
+static const struct acpi_rsdt * rsdp_find_rsdt ( void ) {
+	static const struct acpi_rsdt *rsdt;
+	const void *ebda;
 	uint16_t ebda_seg;
-	userptr_t ebda;
 	size_t ebda_len;
 
 	/* Return existing RSDT if already found */
@@ -119,7 +120,7 @@ static userptr_t rsdp_find_rsdt ( void ) {
 	if ( rsdt )
 		return rsdt;
 
-	return UNULL;
+	return NULL;
 }
 
 PROVIDE_ACPI ( rsdp, acpi_find_rsdt, rsdp_find_rsdt );
diff --git a/src/core/acpi.c b/src/core/acpi.c
index d7da0ccc1..6c5d1e079 100644
--- a/src/core/acpi.c
+++ b/src/core/acpi.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <errno.h>
 #include <byteswap.h>
 #include <ipxe/uaccess.h>
@@ -54,25 +55,17 @@ typeof ( acpi_find ) *acpi_finder __attribute__ (( weak )) = acpi_find;
 /**
  * Compute ACPI table checksum
  *
- * @v table		Any ACPI table
+ * @v acpi		Any ACPI table header
  * @ret checksum	0 if checksum is good
  */
-static uint8_t acpi_checksum ( userptr_t table ) {
-	struct acpi_header acpi;
+static uint8_t acpi_checksum ( const struct acpi_header *acpi ) {
+	const uint8_t *byte = ( ( const void * ) acpi );
+	size_t len = le32_to_cpu ( acpi->length );
 	uint8_t sum = 0;
-	uint8_t data = 0;
-	unsigned int i;
-
-	/* Read table length */
-	copy_from_user ( &acpi.length, table,
-			 offsetof ( typeof ( acpi ), length ),
-			 sizeof ( acpi.length ) );
 
 	/* Compute checksum */
-	for ( i = 0 ; i < le32_to_cpu ( acpi.length ) ; i++ ) {
-		copy_from_user ( &data, table, i, sizeof ( data ) );
-		sum += data;
-	}
+	while ( len-- )
+		sum += *(byte++);
 
 	return sum;
 }
@@ -85,7 +78,7 @@ static uint8_t acpi_checksum ( userptr_t table ) {
 void acpi_fix_checksum ( struct acpi_header *acpi ) {
 
 	/* Update checksum */
-	acpi->checksum -= acpi_checksum ( virt_to_user ( acpi ) );
+	acpi->checksum -= acpi_checksum ( acpi );
 }
 
 /**
@@ -93,9 +86,10 @@ void acpi_fix_checksum ( struct acpi_header *acpi ) {
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-userptr_t acpi_table ( uint32_t signature, unsigned int index ) {
+const struct acpi_header * acpi_table ( uint32_t signature,
+					unsigned int index ) {
 
 	return ( *acpi_finder ) ( signature, index );
 }
@@ -105,14 +99,12 @@ userptr_t acpi_table ( uint32_t signature, unsigned int index ) {
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
-	struct acpi_header acpi;
-	struct acpi_rsdt *rsdtab;
-	typeof ( rsdtab->entry[0] ) entry;
-	userptr_t rsdt;
-	userptr_t table;
+const struct acpi_header * acpi_find_via_rsdt ( uint32_t signature,
+						unsigned int index ) {
+	const struct acpi_rsdt *rsdt;
+	const struct acpi_header *table;
 	size_t len;
 	unsigned int count;
 	unsigned int i;
@@ -121,45 +113,38 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
 	rsdt = acpi_find_rsdt();
 	if ( ! rsdt ) {
 		DBG ( "RSDT not found\n" );
-		return UNULL;
+		return NULL;
 	}
 
 	/* Read RSDT header */
-	copy_from_user ( &acpi, rsdt, 0, sizeof ( acpi ) );
-	if ( acpi.signature != cpu_to_le32 ( RSDT_SIGNATURE ) ) {
+	if ( rsdt->acpi.signature != cpu_to_le32 ( RSDT_SIGNATURE ) ) {
 		DBGC ( colour, "RSDT %#08lx has invalid signature:\n",
 		       virt_to_phys ( rsdt ) );
-		DBGC_HDA ( colour, virt_to_phys ( rsdt ), &acpi,
-			   sizeof ( acpi ) );
-		return UNULL;
+		DBGC_HDA ( colour, virt_to_phys ( rsdt ), &rsdt->acpi,
+			   sizeof ( rsdt->acpi ) );
+		return NULL;
 	}
-	len = le32_to_cpu ( acpi.length );
-	if ( len < sizeof ( rsdtab->acpi ) ) {
+	len = le32_to_cpu ( rsdt->acpi.length );
+	if ( len < sizeof ( rsdt->acpi ) ) {
 		DBGC ( colour, "RSDT %#08lx has invalid length:\n",
 		       virt_to_phys ( rsdt ) );
-		DBGC_HDA ( colour, virt_to_phys ( rsdt ), &acpi,
-			   sizeof ( acpi ) );
-		return UNULL;
+		DBGC_HDA ( colour, virt_to_phys ( rsdt ), &rsdt->acpi,
+			   sizeof ( rsdt->acpi ) );
+		return NULL;
 	}
 
 	/* Calculate number of entries */
-	count = ( ( len - sizeof ( rsdtab->acpi ) ) / sizeof ( entry ) );
+	count = ( ( len - sizeof ( rsdt->acpi ) ) /
+		  sizeof ( rsdt->entry[0] ) );
 
 	/* Search through entries */
 	for ( i = 0 ; i < count ; i++ ) {
 
-		/* Get table address */
-		copy_from_user ( &entry, rsdt,
-				 offsetof ( typeof ( *rsdtab ), entry[i] ),
-				 sizeof ( entry ) );
-
 		/* Read table header */
-		table = phys_to_virt ( entry );
-		copy_from_user ( &acpi.signature, table, 0,
-				 sizeof ( acpi.signature ) );
+		table = phys_to_virt ( rsdt->entry[i] );
 
 		/* Check table signature */
-		if ( acpi.signature != cpu_to_le32 ( signature ) )
+		if ( table->signature != cpu_to_le32 ( signature ) )
 			continue;
 
 		/* Check index */
@@ -169,13 +154,13 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
 		/* Check table integrity */
 		if ( acpi_checksum ( table ) != 0 ) {
 			DBGC ( colour, "RSDT %#08lx found %s with bad "
-			       "checksum at %08lx\n", virt_to_phys ( rsdt ),
+			       "checksum at %#08lx\n", virt_to_phys ( rsdt ),
 			       acpi_name ( signature ),
 			       virt_to_phys ( table ) );
 			break;
 		}
 
-		DBGC ( colour, "RSDT %#08lx found %s at %08lx\n",
+		DBGC ( colour, "RSDT %#08lx found %s at %#08lx\n",
 		       virt_to_phys ( rsdt ), acpi_name ( signature ),
 		       virt_to_phys ( table ) );
 		return table;
@@ -183,7 +168,7 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
 
 	DBGC ( colour, "RSDT %#08lx could not find %s\n",
 	       virt_to_phys ( rsdt ), acpi_name ( signature ) );
-	return UNULL;
+	return NULL;
 }
 
 /**
@@ -195,26 +180,27 @@ userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index ) {
  * @v extract		Extraction method
  * @ret rc		Return status code
  */
-static int acpi_zsdt ( userptr_t zsdt, uint32_t signature, void *data,
-		       int ( * extract ) ( userptr_t zsdt, size_t len,
-					   size_t offset, void *data ) ) {
-	struct acpi_header acpi;
+static int acpi_zsdt ( const struct acpi_header *zsdt,
+		       uint32_t signature, void *data,
+		       int ( * extract ) ( const struct acpi_header *zsdt,
+					   size_t len, size_t offset,
+					   void *data ) ) {
 	uint32_t buf;
 	size_t offset;
 	size_t len;
 	int rc;
 
 	/* Read table header */
-	copy_from_user ( &acpi, zsdt, 0, sizeof ( acpi ) );
-	len = le32_to_cpu ( acpi.length );
+	len = le32_to_cpu ( zsdt->length );
 
 	/* Locate signature */
-	for ( offset = sizeof ( acpi ) ;
+	for ( offset = sizeof ( *zsdt ) ;
 	      ( ( offset + sizeof ( buf ) /* signature */ ) < len ) ;
 	      offset++ ) {
 
 		/* Check signature */
-		copy_from_user ( &buf, zsdt, offset, sizeof ( buf ) );
+		memcpy ( &buf, ( ( ( const void * ) zsdt ) + offset ),
+			 sizeof ( buf ) );
 		if ( buf != cpu_to_le32 ( signature ) )
 			continue;
 		DBGC ( zsdt, "DSDT/SSDT %#08lx found %s at offset %#zx\n",
@@ -238,20 +224,20 @@ static int acpi_zsdt ( userptr_t zsdt, uint32_t signature, void *data,
  * @ret rc		Return status code
  */
 int acpi_extract ( uint32_t signature, void *data,
-		   int ( * extract ) ( userptr_t zsdt, size_t len,
-				       size_t offset, void *data ) ) {
-	struct acpi_fadt fadtab;
-	userptr_t fadt;
-	userptr_t dsdt;
-	userptr_t ssdt;
+		   int ( * extract ) ( const struct acpi_header *zsdt,
+				       size_t len, size_t offset,
+				       void *data ) ) {
+	const struct acpi_fadt *fadt;
+	const struct acpi_header *dsdt;
+	const struct acpi_header *ssdt;
 	unsigned int i;
 	int rc;
 
 	/* Try DSDT first */
-	fadt = acpi_table ( FADT_SIGNATURE, 0 );
+	fadt = container_of ( acpi_table ( FADT_SIGNATURE, 0 ),
+			      struct acpi_fadt, acpi );
 	if ( fadt ) {
-		copy_from_user ( &fadtab, fadt, 0, sizeof ( fadtab ) );
-		dsdt = phys_to_virt ( fadtab.dsdt );
+		dsdt = phys_to_virt ( fadt->dsdt );
 		if ( ( rc = acpi_zsdt ( dsdt, signature, data,
 					extract ) ) == 0 )
 			return 0;
diff --git a/src/core/acpi_settings.c b/src/core/acpi_settings.c
index b9e2b7f61..cdee1f865 100644
--- a/src/core/acpi_settings.c
+++ b/src/core/acpi_settings.c
@@ -64,14 +64,15 @@ static int acpi_settings_applies ( struct settings *settings __unused,
 static int acpi_settings_fetch ( struct settings *settings,
 				 struct setting *setting,
 				 void *data, size_t len ) {
-	struct acpi_header acpi;
+	const struct acpi_header *acpi;
+	const uint8_t *src;
+	uint8_t *dst;
 	uint32_t tag_high;
 	uint32_t tag_low;
 	uint32_t tag_signature;
 	unsigned int tag_index;
 	size_t tag_offset;
 	size_t tag_len;
-	userptr_t table;
 	size_t offset;
 	size_t max_len;
 	int delta;
@@ -88,15 +89,12 @@ static int acpi_settings_fetch ( struct settings *settings,
 	       acpi_name ( tag_signature ), tag_index, tag_offset, tag_len );
 
 	/* Locate ACPI table */
-	table = acpi_table ( tag_signature, tag_index );
-	if ( ! table )
+	acpi = acpi_table ( tag_signature, tag_index );
+	if ( ! acpi )
 		return -ENOENT;
 
-	/* Read table header */
-	copy_from_user ( &acpi, table, 0, sizeof ( acpi ) );
-
 	/* Calculate starting offset and maximum available length */
-	max_len = le32_to_cpu ( acpi.length );
+	max_len = le32_to_cpu ( acpi->length );
 	if ( tag_offset > max_len )
 		return -ENOENT;
 	offset = tag_offset;
@@ -115,10 +113,11 @@ static int acpi_settings_fetch ( struct settings *settings,
 	}
 
 	/* Read data */
+	src = ( ( ( const void * ) acpi ) + offset );
+	dst = data;
 	for ( i = 0 ; ( ( i < max_len ) && ( i < len ) ) ; i++ ) {
-		copy_from_user ( data, table, offset, 1 );
-		data++;
-		offset += delta;
+		*(dst++) = *src;
+		src += delta;
 	}
 
 	/* Set type if not already specified */
diff --git a/src/core/acpimac.c b/src/core/acpimac.c
index e0074ba43..11ac3243e 100644
--- a/src/core/acpimac.c
+++ b/src/core/acpimac.c
@@ -142,8 +142,9 @@ static struct acpimac_extractor acpimac_rtxmac = {
  * string that appears shortly after an "AMAC" or "MACA" signature.
  * This should work for most implementations encountered in practice.
  */
-static int acpimac_extract ( userptr_t zsdt, size_t len, size_t offset,
-			     void *data, struct acpimac_extractor *extractor ){
+static int acpimac_extract ( const struct acpi_header *zsdt, size_t len,
+			     size_t offset, void *data,
+			     struct acpimac_extractor *extractor ) {
 	size_t prefix_len = strlen ( extractor->prefix );
 	uint8_t *hw_addr = data;
 	size_t skip = 0;
@@ -161,8 +162,8 @@ static int acpimac_extract ( userptr_t zsdt, size_t len, size_t offset,
 	      skip++ ) {
 
 		/* Read value */
-		copy_from_user ( buf, zsdt, ( offset + skip ),
-				 sizeof ( buf ) );
+		memcpy ( buf, ( ( ( const void * ) zsdt ) + offset + skip ),
+			 sizeof ( buf ) );
 
 		/* Check for expected format */
 		if ( memcmp ( buf, extractor->prefix, prefix_len ) != 0 )
@@ -203,8 +204,8 @@ static int acpimac_extract ( userptr_t zsdt, size_t len, size_t offset,
  * @v data		Data buffer
  * @ret rc		Return status code
  */
-static int acpimac_extract_auxmac ( userptr_t zsdt, size_t len, size_t offset,
-				    void *data ) {
+static int acpimac_extract_auxmac ( const struct acpi_header *zsdt,
+				    size_t len, size_t offset, void *data ) {
 
 	return acpimac_extract ( zsdt, len, offset, data, &acpimac_auxmac );
 }
@@ -218,8 +219,8 @@ static int acpimac_extract_auxmac ( userptr_t zsdt, size_t len, size_t offset,
  * @v data		Data buffer
  * @ret rc		Return status code
  */
-static int acpimac_extract_rtxmac ( userptr_t zsdt, size_t len, size_t offset,
-				    void *data ) {
+static int acpimac_extract_rtxmac ( const struct acpi_header *zsdt,
+				    size_t len, size_t offset, void *data ) {
 
 	return acpimac_extract ( zsdt, len, offset, data, &acpimac_rtxmac );
 }
diff --git a/src/drivers/bus/ecam.c b/src/drivers/bus/ecam.c
index cde5952b8..58d513e88 100644
--- a/src/drivers/bus/ecam.c
+++ b/src/drivers/bus/ecam.c
@@ -46,49 +46,43 @@ static struct ecam_mapping ecam;
  */
 static int ecam_find ( uint32_t busdevfn, struct pci_range *range,
 		       struct ecam_allocation *alloc ) {
-	struct ecam_allocation tmp;
+	struct ecam_table *mcfg;
+	struct ecam_allocation *tmp;
 	unsigned int best = 0;
-	unsigned int offset;
 	unsigned int count;
 	unsigned int index;
-	userptr_t mcfg;
-	uint32_t length;
+	unsigned int i;
 	uint32_t start;
 
 	/* Return empty range on error */
 	range->count = 0;
 
 	/* Locate MCFG table */
-	mcfg = acpi_table ( ECAM_SIGNATURE, 0 );
+	mcfg = container_of ( acpi_table ( ECAM_SIGNATURE, 0 ),
+			      struct ecam_table, acpi );
 	if ( ! mcfg ) {
 		DBGC ( &ecam, "ECAM found no MCFG table\n" );
 		return -ENOTSUP;
 	}
 
-	/* Get length of table */
-	copy_from_user ( &length, mcfg,
-			 offsetof ( struct ecam_table, acpi.length ),
-			 sizeof ( length ) );
-
 	/* Iterate over allocations */
-	for ( offset = offsetof ( struct ecam_table, alloc ) ;
-	      ( offset + sizeof ( tmp ) ) <= le32_to_cpu ( length ) ;
-	      offset += sizeof ( tmp ) ) {
+	for ( i = 0 ; ( offsetof ( typeof ( *mcfg ), alloc[ i + 1 ] ) <=
+			le32_to_cpu ( mcfg->acpi.length ) ) ; i++ ) {
 
 		/* Read allocation */
-		copy_from_user ( &tmp, mcfg, offset, sizeof ( tmp ) );
+		tmp = &mcfg->alloc[i];
 		DBGC2 ( &ecam, "ECAM %04x:[%02x-%02x] has base %08llx\n",
-			le16_to_cpu ( tmp.segment ), tmp.start, tmp.end,
-			( ( unsigned long long ) le64_to_cpu ( tmp.base ) ) );
-		start = PCI_BUSDEVFN ( le16_to_cpu ( tmp.segment ),
-				       tmp.start, 0, 0 );
-		count = PCI_BUSDEVFN ( 0, ( tmp.end - tmp.start + 1 ), 0, 0 );
+			le16_to_cpu ( tmp->segment ), tmp->start, tmp->end,
+			( ( unsigned long long ) le64_to_cpu ( tmp->base ) ) );
+		start = PCI_BUSDEVFN ( le16_to_cpu ( tmp->segment ),
+				       tmp->start, 0, 0 );
+		count = PCI_BUSDEVFN ( 0, ( tmp->end - tmp->start + 1 ), 0, 0 );
 
 		/* Check for a matching or new closest allocation */
 		index = ( busdevfn - start );
 		if ( ( index < count ) || ( index > best ) ) {
 			if ( alloc )
-				memcpy ( alloc, &tmp, sizeof ( *alloc ) );
+				memcpy ( alloc, tmp, sizeof ( *alloc ) );
 			range->start = start;
 			range->count = count;
 			best = index;
diff --git a/src/include/ipxe/acpi.h b/src/include/ipxe/acpi.h
index c34681238..40a44cffc 100644
--- a/src/include/ipxe/acpi.h
+++ b/src/include/ipxe/acpi.h
@@ -14,7 +14,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/refcnt.h>
 #include <ipxe/list.h>
 #include <ipxe/interface.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/tables.h>
 #include <ipxe/api.h>
 #include <config/general.h>
@@ -355,7 +354,8 @@ struct acpi_model {
 #define PROVIDE_ACPI_INLINE( _subsys, _api_func ) \
 	PROVIDE_SINGLE_API_INLINE ( ACPI_PREFIX_ ## _subsys, _api_func )
 
-extern userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index );
+extern const struct acpi_header * acpi_find_via_rsdt ( uint32_t signature,
+						       unsigned int index );
 
 /* Include all architecture-independent ACPI API headers */
 #include <ipxe/null_acpi.h>
@@ -368,31 +368,35 @@ extern userptr_t acpi_find_via_rsdt ( uint32_t signature, unsigned int index );
 /**
  * Locate ACPI root system description table
  *
- * @ret rsdt		ACPI root system description table, or UNULL
+ * @ret rsdt		ACPI root system description table, or NULL
  */
-userptr_t acpi_find_rsdt ( void );
+const struct acpi_rsdt * acpi_find_rsdt ( void );
 
 /**
  * Locate ACPI table
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-userptr_t acpi_find ( uint32_t signature, unsigned int index );
+const struct acpi_header * acpi_find ( uint32_t signature,
+				       unsigned int index );
 
 extern struct acpi_descriptor *
 acpi_describe ( struct interface *interface );
 #define acpi_describe_TYPE( object_type )				\
 	typeof ( struct acpi_descriptor * ( object_type ) )
 
-extern userptr_t ( * acpi_finder ) ( uint32_t signature, unsigned int index );
+extern const struct acpi_header * ( * acpi_finder ) ( uint32_t signature,
+						      unsigned int index );
 
 extern void acpi_fix_checksum ( struct acpi_header *acpi );
-extern userptr_t acpi_table ( uint32_t signature, unsigned int index );
+extern const struct acpi_header * acpi_table ( uint32_t signature,
+					       unsigned int index );
 extern int acpi_extract ( uint32_t signature, void *data,
-			  int ( * extract ) ( userptr_t zsdt, size_t len,
-					      size_t offset, void *data ) );
+			  int ( * extract ) ( const struct acpi_header *zsdt,
+					      size_t len, size_t offset,
+					      void *data ) );
 extern void acpi_add ( struct acpi_descriptor *desc );
 extern void acpi_del ( struct acpi_descriptor *desc );
 extern int acpi_install ( int ( * install ) ( struct acpi_header *acpi ) );
diff --git a/src/include/ipxe/efi/efi_acpi.h b/src/include/ipxe/efi/efi_acpi.h
index a698863a6..68f9c5be7 100644
--- a/src/include/ipxe/efi/efi_acpi.h
+++ b/src/include/ipxe/efi/efi_acpi.h
@@ -20,9 +20,9 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-static inline __attribute__ (( always_inline )) userptr_t
+static inline __attribute__ (( always_inline )) const struct acpi_header *
 ACPI_INLINE ( efi, acpi_find ) ( uint32_t signature, unsigned int index ) {
 
 	return acpi_find_via_rsdt ( signature, index );
diff --git a/src/include/ipxe/null_acpi.h b/src/include/ipxe/null_acpi.h
index cedb02839..18f059964 100644
--- a/src/include/ipxe/null_acpi.h
+++ b/src/include/ipxe/null_acpi.h
@@ -9,17 +9,19 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <stddef.h>
+
 #ifdef ACPI_NULL
 #define ACPI_PREFIX_null
 #else
 #define ACPI_PREFIX_null __null_
 #endif
 
-static inline __attribute__ (( always_inline )) userptr_t
+static inline __attribute__ (( always_inline )) const struct acpi_header *
 ACPI_INLINE ( null, acpi_find ) ( uint32_t signature __unused,
 				  unsigned int index __unused ) {
 
-	return UNULL;
+	return NULL;
 }
 
 #endif /* _IPXE_NULL_ACPI_H */
diff --git a/src/interface/efi/efi_acpi.c b/src/interface/efi/efi_acpi.c
index c1046c01a..a2021a4f6 100644
--- a/src/interface/efi/efi_acpi.c
+++ b/src/interface/efi/efi_acpi.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <ipxe/acpi.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/Guid/Acpi.h>
 #include <ipxe/efi/efi_acpi.h>
@@ -42,15 +43,15 @@ EFI_USE_TABLE ( ACPI_10_TABLE, &rsdp, 0 );
 /**
  * Locate ACPI root system description table
  *
- * @ret rsdt		ACPI root system description table, or UNULL
+ * @ret rsdt		ACPI root system description table, or NULL
  */
-static userptr_t efi_find_rsdt ( void ) {
+static const struct acpi_rsdt * efi_find_rsdt ( void ) {
 
 	/* Locate RSDT via ACPI configuration table, if available */
 	if ( rsdp )
 		return phys_to_virt ( rsdp->RsdtAddress );
 
-	return UNULL;
+	return NULL;
 }
 
 PROVIDE_ACPI ( efi, acpi_find_rsdt, efi_find_rsdt );
diff --git a/src/interface/linux/linux_acpi.c b/src/interface/linux/linux_acpi.c
index 846db2f1f..a2a8bf12e 100644
--- a/src/interface/linux/linux_acpi.c
+++ b/src/interface/linux/linux_acpi.c
@@ -42,7 +42,7 @@ struct linux_acpi_table {
 	/** Index */
 	unsigned int index;
 	/** Cached data */
-	userptr_t data;
+	void *data;
 };
 
 /** List of cached ACPI tables */
@@ -53,9 +53,10 @@ static LIST_HEAD ( linux_acpi_tables );
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-static userptr_t linux_acpi_find ( uint32_t signature, unsigned int index ) {
+static const struct acpi_header * linux_acpi_find ( uint32_t signature,
+						    unsigned int index ) {
 	struct linux_acpi_table *table;
 	struct acpi_header *header;
 	union {
@@ -121,7 +122,7 @@ static userptr_t linux_acpi_find ( uint32_t signature, unsigned int index ) {
  err_read:
 	free ( table );
  err_alloc:
-	return UNULL;
+	return NULL;
 }
 
 /**
diff --git a/src/tests/acpi_test.c b/src/tests/acpi_test.c
index 1ca5befaf..6e8840217 100644
--- a/src/tests/acpi_test.c
+++ b/src/tests/acpi_test.c
@@ -32,6 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /* Forcibly enable assertions */
 #undef NDEBUG
 
+#include <string.h>
 #include <ipxe/acpi.h>
 #include <ipxe/acpimac.h>
 #include <ipxe/if_ether.h>
@@ -185,26 +186,27 @@ static struct acpi_test_tables *acpi_test_tables;
  *
  * @v signature		Requested table signature
  * @v index		Requested index of table with this signature
- * @ret table		Table, or UNULL if not found
+ * @ret table		Table, or NULL if not found
  */
-static userptr_t acpi_test_find ( uint32_t signature, unsigned int index ) {
+static const struct acpi_header * acpi_test_find ( uint32_t signature,
+						   unsigned int index ) {
 	struct acpi_test_table *table;
 	unsigned int i;
 
 	/* Fail if no test tables are installed */
 	if ( ! acpi_test_tables )
-		return UNULL;
+		return NULL;
 
 	/* Scan through test tables */
 	for ( i = 0 ; i < acpi_test_tables->count ; i++ ) {
 		table = acpi_test_tables->table[i];
 		if ( ( signature == le32_to_cpu ( table->signature.raw ) ) &&
 		     ( index-- == 0 ) ) {
-			return virt_to_user ( table->data );
+			return table->data;
 		}
 	}
 
-	return UNULL;
+	return NULL;
 }
 
 /** Override ACPI table finder */
-- 
cgit v1.2.3-55-g7522


From 839540cb95a310ebf96d6302afecc3ac97ccf746 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 23 Apr 2025 12:47:53 +0100
Subject: [umalloc] Remove userptr_t from user memory allocations

Use standard void pointers for umalloc(), urealloc(), and ufree(),
with the "u" prefix retained to indicate that these allocations are
made from external ("user") memory rather than from the internal heap.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/interface/sbi/sbi_umalloc.c     | 11 +++----
 src/arch/x86/interface/pcbios/memtop_umalloc.c | 42 ++++++++++++--------------
 src/core/dma.c                                 |  9 +++---
 src/core/malloc.c                              | 17 -----------
 src/core/xferbuf.c                             | 12 ++++----
 src/include/ipxe/dma.h                         | 20 ++++++------
 src/include/ipxe/malloc.h                      | 18 +++++++++++
 src/include/ipxe/umalloc.h                     | 23 +++++++-------
 src/include/ipxe/xferbuf.h                     |  3 +-
 src/interface/efi/efi_pci.c                    | 36 ++--------------------
 src/interface/efi/efi_umalloc.c                | 25 ++++++++-------
 src/interface/linux/linux_umalloc.c            | 31 +++++++------------
 src/tests/umalloc_test.c                       |  5 ++-
 13 files changed, 101 insertions(+), 151 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/interface/sbi/sbi_umalloc.c b/src/arch/riscv/interface/sbi/sbi_umalloc.c
index 2f9935adb..0e351748b 100644
--- a/src/arch/riscv/interface/sbi/sbi_umalloc.c
+++ b/src/arch/riscv/interface/sbi/sbi_umalloc.c
@@ -32,23 +32,20 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
-/** Equivalent of NOWHERE for user pointers */
-#define UNOWHERE ( ~UNULL )
-
 /**
  * Reallocate external memory
  *
- * @v old_ptr		Memory previously allocated by umalloc(), or UNULL
+ * @v old_ptr		Memory previously allocated by umalloc(), or NULL
  * @v new_size		Requested size
- * @ret new_ptr		Allocated memory, or UNULL
+ * @ret new_ptr		Allocated memory, or NULL
  *
  * Calling realloc() with a new size of zero is a valid way to free a
  * memory block.
  */
-static userptr_t sbi_urealloc ( userptr_t old_ptr, size_t new_size ) {
+static void * sbi_urealloc ( void * old_ptr, size_t new_size ) {
 
 	/* External allocation not yet implemented: allocate from heap */
-	return ( ( userptr_t ) realloc ( ( ( void * ) old_ptr ), new_size ) );
+	return ( realloc ( old_ptr, new_size ) );
 }
 
 PROVIDE_UMALLOC ( sbi, urealloc, sbi_urealloc );
diff --git a/src/arch/x86/interface/pcbios/memtop_umalloc.c b/src/arch/x86/interface/pcbios/memtop_umalloc.c
index b87d22516..d4489fb01 100644
--- a/src/arch/x86/interface/pcbios/memtop_umalloc.c
+++ b/src/arch/x86/interface/pcbios/memtop_umalloc.c
@@ -44,9 +44,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /** Alignment of external allocated memory */
 #define EM_ALIGN ( 4 * 1024 )
 
-/** Equivalent of NOWHERE for user pointers */
-#define UNOWHERE ( ( userptr_t ) ~( ( intptr_t ) 0 ) )
-
 /** An external memory block */
 struct external_memory {
 	/** Size of this memory block (excluding this header) */
@@ -56,10 +53,10 @@ struct external_memory {
 };
 
 /** Top of heap */
-static userptr_t top = UNULL;
+static void *top = NULL;
 
 /** Bottom of heap (current lowest allocated block) */
-static userptr_t bottom = UNULL;
+static void *bottom = NULL;
 
 /** Remaining space on heap */
 static size_t heap_size;
@@ -70,7 +67,7 @@ static size_t heap_size;
  * @ret start		Start of region
  * @ret len		Length of region
  */
-size_t largest_memblock ( userptr_t *start ) {
+size_t largest_memblock ( void **start ) {
 	struct memory_map memmap;
 	struct memory_region *region;
 	physaddr_t max = EM_MAX_ADDRESS;
@@ -81,7 +78,7 @@ size_t largest_memblock ( userptr_t *start ) {
 	size_t len = 0;
 
 	/* Avoid returning uninitialised data on error */
-	*start = UNULL;
+	*start = NULL;
 
 	/* Scan through all memory regions */
 	get_memmap ( &memmap );
@@ -119,7 +116,7 @@ size_t largest_memblock ( userptr_t *start ) {
  *
  */
 static void init_eheap ( void ) {
-	userptr_t base;
+	void *base;
 
 	heap_size = largest_memblock ( &base );
 	bottom = top = ( base + heap_size );
@@ -137,8 +134,8 @@ static void ecollect_free ( void ) {
 
 	/* Walk the free list and collect empty blocks */
 	while ( bottom != top ) {
-		copy_from_user ( &extmem, bottom, -sizeof ( extmem ),
-				 sizeof ( extmem ) );
+		memcpy ( &extmem, ( bottom - sizeof ( extmem ) ),
+			 sizeof ( extmem ) );
 		if ( extmem.used )
 			break;
 		DBG ( "EXTMEM freeing [%lx,%lx)\n", virt_to_phys ( bottom ),
@@ -152,16 +149,16 @@ static void ecollect_free ( void ) {
 /**
  * Reallocate external memory
  *
- * @v old_ptr		Memory previously allocated by umalloc(), or UNULL
+ * @v old_ptr		Memory previously allocated by umalloc(), or NULL
  * @v new_size		Requested size
- * @ret new_ptr		Allocated memory, or UNULL
+ * @ret new_ptr		Allocated memory, or NULL
  *
  * Calling realloc() with a new size of zero is a valid way to free a
  * memory block.
  */
-static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
+static void * memtop_urealloc ( void *ptr, size_t new_size ) {
 	struct external_memory extmem;
-	userptr_t new = ptr;
+	void *new = ptr;
 	size_t align;
 
 	/* (Re)initialise external memory allocator if necessary */
@@ -169,15 +166,15 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 		init_eheap();
 
 	/* Get block properties into extmem */
-	if ( ptr && ( ptr != UNOWHERE ) ) {
+	if ( ptr && ( ptr != NOWHERE ) ) {
 		/* Determine old size */
-		copy_from_user ( &extmem, ptr, -sizeof ( extmem ),
-				 sizeof ( extmem ) );
+		memcpy ( &extmem, ( ptr - sizeof ( extmem ) ),
+			 sizeof ( extmem ) );
 	} else {
 		/* Create a zero-length block */
 		if ( heap_size < sizeof ( extmem ) ) {
 			DBG ( "EXTMEM out of space\n" );
-			return UNULL;
+			return NULL;
 		}
 		ptr = bottom = ( bottom - sizeof ( extmem ) );
 		heap_size -= sizeof ( extmem );
@@ -196,7 +193,7 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 		new -= align;
 		if ( new_size > ( heap_size + extmem.size ) ) {
 			DBG ( "EXTMEM out of space\n" );
-			return UNULL;
+			return NULL;
 		}
 		DBG ( "EXTMEM expanding [%lx,%lx) to [%lx,%lx)\n",
 		      virt_to_phys ( ptr ),
@@ -215,13 +212,12 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 			DBG ( "EXTMEM cannot expand [%lx,%lx)\n",
 			      virt_to_phys ( ptr ),
 			      ( virt_to_phys ( ptr ) + extmem.size ) );
-			return UNULL;
+			return NULL;
 		}
 	}
 
 	/* Write back block properties */
-	copy_to_user ( new, -sizeof ( extmem ), &extmem,
-		       sizeof ( extmem ) );
+	memcpy ( ( new - sizeof ( extmem ) ), &extmem, sizeof ( extmem ) );
 
 	/* Collect any free blocks and update hidden memory region */
 	ecollect_free();
@@ -229,7 +225,7 @@ static userptr_t memtop_urealloc ( userptr_t ptr, size_t new_size ) {
 			 ( ( bottom == top ) ? 0 : sizeof ( extmem ) ) ),
 		       virt_to_phys ( top ) );
 
-	return ( new_size ? new : UNOWHERE );
+	return ( new_size ? new : NOWHERE );
 }
 
 PROVIDE_UMALLOC ( memtop, urealloc, memtop_urealloc );
diff --git a/src/core/dma.c b/src/core/dma.c
index 5d6868216..1f3c1d8a6 100644
--- a/src/core/dma.c
+++ b/src/core/dma.c
@@ -130,9 +130,9 @@ static void dma_op_free ( struct dma_mapping *map, void *addr, size_t len ) {
  * @v align		Physical alignment
  * @ret addr		Buffer address, or NULL on error
  */
-static userptr_t dma_op_umalloc ( struct dma_device *dma,
-				  struct dma_mapping *map,
-				  size_t len, size_t align ) {
+static void * dma_op_umalloc ( struct dma_device *dma,
+			       struct dma_mapping *map,
+			       size_t len, size_t align ) {
 	struct dma_operations *op = dma->op;
 
 	if ( ! op )
@@ -147,8 +147,7 @@ static userptr_t dma_op_umalloc ( struct dma_device *dma,
  * @v addr		Buffer address
  * @v len		Length of buffer
  */
-static void dma_op_ufree ( struct dma_mapping *map, userptr_t addr,
-			   size_t len ) {
+static void dma_op_ufree ( struct dma_mapping *map, void *addr, size_t len ) {
 	struct dma_device *dma = map->dma;
 
 	assert ( dma != NULL );
diff --git a/src/core/malloc.c b/src/core/malloc.c
index c499ce6fd..ec29513ef 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -71,23 +71,6 @@ struct autosized_block {
 	char data[0];
 };
 
-/**
- * Address for zero-length memory blocks
- *
- * @c malloc(0) or @c realloc(ptr,0) will return the special value @c
- * NOWHERE.  Calling @c free(NOWHERE) will have no effect.
- *
- * This is consistent with the ANSI C standards, which state that
- * "either NULL or a pointer suitable to be passed to free()" must be
- * returned in these cases.  Using a special non-NULL value means that
- * the caller can take a NULL return value to indicate failure,
- * without first having to check for a requested size of zero.
- *
- * Code outside of malloc.c do not ever need to refer to the actual
- * value of @c NOWHERE; this is an internal definition.
- */
-#define NOWHERE ( ( void * ) ~( ( intptr_t ) 0 ) )
-
 /** List of free memory blocks */
 static LIST_HEAD ( free_blocks );
 
diff --git a/src/core/xferbuf.c b/src/core/xferbuf.c
index 240118557..1c08f8bc3 100644
--- a/src/core/xferbuf.c
+++ b/src/core/xferbuf.c
@@ -237,8 +237,8 @@ struct xfer_buffer_operations xferbuf_malloc_operations = {
  * @ret rc		Return status code
  */
 static int xferbuf_umalloc_realloc ( struct xfer_buffer *xferbuf, size_t len ) {
-	userptr_t *udata = xferbuf->data;
-	userptr_t new_udata;
+	void **udata = xferbuf->data;
+	void *new_udata;
 
 	new_udata = urealloc ( *udata, len );
 	if ( ! new_udata )
@@ -257,9 +257,9 @@ static int xferbuf_umalloc_realloc ( struct xfer_buffer *xferbuf, size_t len ) {
  */
 static void xferbuf_umalloc_write ( struct xfer_buffer *xferbuf, size_t offset,
 				    const void *data, size_t len ) {
-	userptr_t *udata = xferbuf->data;
+	void **udata = xferbuf->data;
 
-	copy_to_user ( *udata, offset, data, len );
+	memcpy ( ( *udata + offset ), data, len );
 }
 
 /**
@@ -272,9 +272,9 @@ static void xferbuf_umalloc_write ( struct xfer_buffer *xferbuf, size_t offset,
  */
 static void xferbuf_umalloc_read ( struct xfer_buffer *xferbuf, size_t offset,
 				   void *data, size_t len ) {
-	userptr_t *udata = xferbuf->data;
+	void **udata = xferbuf->data;
 
-	copy_from_user ( data, *udata, offset, len );
+	memcpy ( data, ( *udata + offset ), len );
 }
 
 /** umalloc()-based data buffer operations */
diff --git a/src/include/ipxe/dma.h b/src/include/ipxe/dma.h
index 385e4baf7..6e5c43289 100644
--- a/src/include/ipxe/dma.h
+++ b/src/include/ipxe/dma.h
@@ -106,9 +106,9 @@ struct dma_operations {
 	 * @v align		Physical alignment
 	 * @ret addr		Buffer address, or NULL on error
 	 */
-	userptr_t ( * umalloc ) ( struct dma_device *dma,
-				  struct dma_mapping *map,
-				  size_t len, size_t align );
+	void * ( * umalloc ) ( struct dma_device *dma,
+			       struct dma_mapping *map,
+			       size_t len, size_t align );
 	/**
 	 * Unmap and free DMA-coherent buffer from external (user) memory
 	 *
@@ -118,7 +118,7 @@ struct dma_operations {
 	 * @v len		Length of buffer
 	 */
 	void ( * ufree ) ( struct dma_device *dma, struct dma_mapping *map,
-			   userptr_t addr, size_t len );
+			   void *addr, size_t len );
 	/**
 	 * Set addressable space mask
 	 *
@@ -265,11 +265,11 @@ DMAAPI_INLINE ( flat, dma_free ) ( struct dma_mapping *map,
  * @v align		Physical alignment
  * @ret addr		Buffer address, or NULL on error
  */
-static inline __always_inline userptr_t
+static inline __always_inline void *
 DMAAPI_INLINE ( flat, dma_umalloc ) ( struct dma_device *dma,
 				      struct dma_mapping *map,
 				      size_t len, size_t align __unused ) {
-	userptr_t addr;
+	void *addr;
 
 	/* Allocate buffer */
 	addr = umalloc ( len );
@@ -292,7 +292,7 @@ DMAAPI_INLINE ( flat, dma_umalloc ) ( struct dma_device *dma,
  */
 static inline __always_inline void
 DMAAPI_INLINE ( flat, dma_ufree ) ( struct dma_mapping *map,
-				    userptr_t addr, size_t len __unused ) {
+				    void *addr, size_t len __unused ) {
 
 	/* Free buffer */
 	ufree ( addr );
@@ -397,8 +397,8 @@ void dma_free ( struct dma_mapping *map, void *addr, size_t len );
  * @v align		Physical alignment
  * @ret addr		Buffer address, or NULL on error
  */
-userptr_t dma_umalloc ( struct dma_device *dma, struct dma_mapping *map,
-			size_t len, size_t align );
+void * dma_umalloc ( struct dma_device *dma, struct dma_mapping *map,
+		     size_t len, size_t align );
 
 /**
  * Unmap and free DMA-coherent buffer from external (user) memory
@@ -407,7 +407,7 @@ userptr_t dma_umalloc ( struct dma_device *dma, struct dma_mapping *map,
  * @v addr		Buffer address
  * @v len		Length of buffer
  */
-void dma_ufree ( struct dma_mapping *map, userptr_t addr, size_t len );
+void dma_ufree ( struct dma_mapping *map, void *addr, size_t len );
 
 /**
  * Set addressable space mask
diff --git a/src/include/ipxe/malloc.h b/src/include/ipxe/malloc.h
index f0fde0bc3..8c3a7769d 100644
--- a/src/include/ipxe/malloc.h
+++ b/src/include/ipxe/malloc.h
@@ -21,6 +21,24 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/tables.h>
 #include <valgrind/memcheck.h>
 
+/**
+ * Address for zero-length memory blocks
+ *
+ * @c malloc(0) or @c realloc(ptr,0) will return the special value @c
+ * NOWHERE.  Calling @c free(NOWHERE) will have no effect.
+ *
+ * This is consistent with the ANSI C standards, which state that
+ * "either NULL or a pointer suitable to be passed to free()" must be
+ * returned in these cases.  Using a special non-NULL value means that
+ * the caller can take a NULL return value to indicate failure,
+ * without first having to check for a requested size of zero.
+ *
+ * Code outside of the memory allocators themselves does not ever need
+ * to refer to the actual value of @c NOWHERE; this is an internal
+ * definition.
+ */
+#define NOWHERE ( ( void * ) ~( ( intptr_t ) 0 ) )
+
 extern size_t freemem;
 extern size_t usedmem;
 extern size_t maxusedmem;
diff --git a/src/include/ipxe/umalloc.h b/src/include/ipxe/umalloc.h
index 3892ef53b..a6476a390 100644
--- a/src/include/ipxe/umalloc.h
+++ b/src/include/ipxe/umalloc.h
@@ -10,9 +10,10 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <stddef.h>
 #include <ipxe/api.h>
+#include <ipxe/malloc.h>
 #include <config/umalloc.h>
-#include <ipxe/uaccess.h>
 
 /**
  * Provide a user memory allocation API implementation
@@ -34,36 +35,36 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Reallocate external memory
  *
- * @v userptr		Memory previously allocated by umalloc(), or UNULL
+ * @v old_ptr		Memory previously allocated by umalloc(), or NULL
  * @v new_size		Requested size
- * @ret userptr		Allocated memory, or UNULL
+ * @ret new_ptr		Allocated memory, or NULL
  *
  * Calling realloc() with a new size of zero is a valid way to free a
  * memory block.
  */
-userptr_t urealloc ( userptr_t userptr, size_t new_size );
+void * urealloc ( void *ptr, size_t new_size );
 
 /**
  * Allocate external memory
  *
  * @v size		Requested size
- * @ret userptr		Memory, or UNULL
+ * @ret ptr		Memory, or NULL
  *
  * Memory is guaranteed to be aligned to a page boundary.
  */
-static inline __always_inline userptr_t umalloc ( size_t size ) {
-	return urealloc ( UNULL, size );
+static inline __always_inline void * umalloc ( size_t size ) {
+	return urealloc ( NULL, size );
 }
 
 /**
  * Free external memory
  *
- * @v userptr		Memory allocated by umalloc(), or UNULL
+ * @v ptr		Memory allocated by umalloc(), or NULL
  *
- * If @c ptr is UNULL, no action is taken.
+ * If @c ptr is NULL, no action is taken.
  */
-static inline __always_inline void ufree ( userptr_t userptr ) {
-	urealloc ( userptr, 0 );
+static inline __always_inline void ufree ( void *ptr ) {
+	urealloc ( ptr, 0 );
 }
 
 #endif /* _IPXE_UMALLOC_H */
diff --git a/src/include/ipxe/xferbuf.h b/src/include/ipxe/xferbuf.h
index cb0b1a0e8..04635999d 100644
--- a/src/include/ipxe/xferbuf.h
+++ b/src/include/ipxe/xferbuf.h
@@ -11,7 +11,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <ipxe/iobuf.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/interface.h>
 #include <ipxe/xfer.h>
 
@@ -84,7 +83,7 @@ xferbuf_malloc_init ( struct xfer_buffer *xferbuf ) {
  * @v data		User pointer
  */
 static inline __attribute__ (( always_inline )) void
-xferbuf_umalloc_init ( struct xfer_buffer *xferbuf, userptr_t *data ) {
+xferbuf_umalloc_init ( struct xfer_buffer *xferbuf, void **data ) {
 	xferbuf->data = data;
 	xferbuf->op = &xferbuf_umalloc_operations;
 }
diff --git a/src/interface/efi/efi_pci.c b/src/interface/efi/efi_pci.c
index 01351df51..b8c7df38d 100644
--- a/src/interface/efi/efi_pci.c
+++ b/src/interface/efi/efi_pci.c
@@ -640,38 +640,6 @@ static void efipci_dma_free ( struct dma_device *dma, struct dma_mapping *map,
 		dma->allocated--;
 }
 
-/**
- * Allocate and map DMA-coherent buffer from external (user) memory
- *
- * @v dma		DMA device
- * @v map		DMA mapping to fill in
- * @v len		Length of buffer
- * @v align		Physical alignment
- * @ret addr		Buffer address, or NULL on error
- */
-static userptr_t efipci_dma_umalloc ( struct dma_device *dma,
-				      struct dma_mapping *map,
-				      size_t len, size_t align ) {
-	void *addr;
-
-	addr = efipci_dma_alloc ( dma, map, len, align );
-	return virt_to_user ( addr );
-}
-
-/**
- * Unmap and free DMA-coherent buffer from external (user) memory
- *
- * @v dma		DMA device
- * @v map		DMA mapping
- * @v addr		Buffer address
- * @v len		Length of buffer
- */
-static void efipci_dma_ufree ( struct dma_device *dma, struct dma_mapping *map,
-			       userptr_t addr, size_t len ) {
-
-	efipci_dma_free ( dma, map, addr, len );
-}
-
 /**
  * Set addressable space mask
  *
@@ -710,8 +678,8 @@ static struct dma_operations efipci_dma_operations = {
 	.unmap = efipci_dma_unmap,
 	.alloc = efipci_dma_alloc,
 	.free = efipci_dma_free,
-	.umalloc = efipci_dma_umalloc,
-	.ufree = efipci_dma_ufree,
+	.umalloc = efipci_dma_alloc,
+	.ufree = efipci_dma_free,
 	.set_mask = efipci_dma_set_mask,
 };
 
diff --git a/src/interface/efi/efi_umalloc.c b/src/interface/efi/efi_umalloc.c
index 0636cb7fd..419d9b294 100644
--- a/src/interface/efi/efi_umalloc.c
+++ b/src/interface/efi/efi_umalloc.c
@@ -26,6 +26,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <string.h>
 #include <errno.h>
 #include <assert.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/efi/efi.h>
 
@@ -35,25 +36,23 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
-/** Equivalent of NOWHERE for user pointers */
-#define UNOWHERE ( ( userptr_t ) ~( ( intptr_t ) 0 ) )
-
 /**
  * Reallocate external memory
  *
- * @v old_ptr		Memory previously allocated by umalloc(), or UNULL
+ * @v old_ptr		Memory previously allocated by umalloc(), or NULL
  * @v new_size		Requested size
- * @ret new_ptr		Allocated memory, or UNULL
+ * @ret new_ptr		Allocated memory, or NULL
  *
  * Calling realloc() with a new size of zero is a valid way to free a
  * memory block.
  */
-static userptr_t efi_urealloc ( userptr_t old_ptr, size_t new_size ) {
+static void * efi_urealloc ( void *old_ptr, size_t new_size ) {
 	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
 	EFI_PHYSICAL_ADDRESS phys_addr;
 	unsigned int new_pages, old_pages;
-	userptr_t new_ptr = UNOWHERE;
+	void *new_ptr = NOWHERE;
 	size_t old_size;
+	size_t *info;
 	EFI_STATUS efirc;
 	int rc;
 
@@ -69,12 +68,12 @@ static userptr_t efi_urealloc ( userptr_t old_ptr, size_t new_size ) {
 			rc = -EEFI ( efirc );
 			DBG ( "EFI could not allocate %d pages: %s\n",
 			      new_pages, strerror ( rc ) );
-			return UNULL;
+			return NULL;
 		}
 		assert ( phys_addr != 0 );
 		new_ptr = phys_to_virt ( phys_addr + EFI_PAGE_SIZE );
-		copy_to_user ( new_ptr, -EFI_PAGE_SIZE,
-			       &new_size, sizeof ( new_size ) );
+		info = ( new_ptr - EFI_PAGE_SIZE );
+		*info = new_size;
 		DBG ( "EFI allocated %d pages at %llx\n",
 		      new_pages, phys_addr );
 	}
@@ -84,9 +83,9 @@ static userptr_t efi_urealloc ( userptr_t old_ptr, size_t new_size ) {
 	 * is valid, or (b) new_size is 0; either way, the memcpy() is
 	 * valid.
 	 */
-	if ( old_ptr && ( old_ptr != UNOWHERE ) ) {
-		copy_from_user ( &old_size, old_ptr, -EFI_PAGE_SIZE,
-				 sizeof ( old_size ) );
+	if ( old_ptr && ( old_ptr != NOWHERE ) ) {
+		info = ( old_ptr - EFI_PAGE_SIZE );
+		old_size = *info;
 		memcpy ( new_ptr, old_ptr,
 			 ( (old_size < new_size) ? old_size : new_size ) );
 		old_pages = ( EFI_SIZE_TO_PAGES ( old_size ) + 1 );
diff --git a/src/interface/linux/linux_umalloc.c b/src/interface/linux/linux_umalloc.c
index a7250fa5b..ab5770e9c 100644
--- a/src/interface/linux/linux_umalloc.c
+++ b/src/interface/linux/linux_umalloc.c
@@ -31,9 +31,6 @@ FILE_LICENCE(GPL2_OR_LATER);
 
 #include <ipxe/linux_api.h>
 
-/** Special address returned for empty allocations */
-#define NOWHERE ((void *)-1)
-
 /** Poison to make the metadata more unique */
 #define POISON 0xa5a5a5a5
 #define min(a,b) (((a)<(b))?(a):(b))
@@ -47,7 +44,16 @@ struct metadata
 
 #define SIZE_MD (sizeof(struct metadata))
 
-/** Simple realloc which passes most of the work to mmap(), mremap() and munmap() */
+/**
+ * Reallocate external memory
+ *
+ * @v old_ptr		Memory previously allocated by umalloc(), or NULL
+ * @v new_size		Requested size
+ * @ret new_ptr		Allocated memory, or NULL
+ *
+ * Calling realloc() with a new size of zero is a valid way to free a
+ * memory block.
+ */
 static void * linux_realloc(void *ptr, size_t size)
 {
 	struct metadata md = {0, 0};
@@ -136,19 +142,4 @@ static void * linux_realloc(void *ptr, size_t size)
 	return ptr;
 }
 
-/**
- * Reallocate external memory
- *
- * @v old_ptr		Memory previously allocated by umalloc(), or UNULL
- * @v new_size		Requested size
- * @ret new_ptr		Allocated memory, or UNULL
- *
- * Calling realloc() with a new size of zero is a valid way to free a
- * memory block.
- */
-static userptr_t linux_urealloc(userptr_t old_ptr, size_t new_size)
-{
-	return (userptr_t)linux_realloc((void *)old_ptr, new_size);
-}
-
-PROVIDE_UMALLOC(linux, urealloc, linux_urealloc);
+PROVIDE_UMALLOC(linux, urealloc, linux_realloc);
diff --git a/src/tests/umalloc_test.c b/src/tests/umalloc_test.c
index 53810833c..1a32a0531 100644
--- a/src/tests/umalloc_test.c
+++ b/src/tests/umalloc_test.c
@@ -1,12 +1,11 @@
 #include <stdio.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/io.h>
 
 void umalloc_test ( void ) {
 	struct memory_map memmap;
-	userptr_t bob;
-	userptr_t fred;
+	void *bob;
+	void *fred;
 
 	printf ( "Before allocation:\n" );
 	get_memmap ( &memmap );
-- 
cgit v1.2.3-55-g7522


From e8ffe2cd644000c1cca51c40ba14edb546ca769b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 24 Apr 2025 01:30:50 +0100
Subject: [uaccess] Remove trivial uses of userptr_t

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/vram_settings.c        |  5 +++--
 src/arch/x86/image/pxe_image.c           |  2 +-
 src/arch/x86/include/realmode.h          |  4 ++--
 src/arch/x86/interface/pxe/pxe_preboot.c |  5 ++---
 src/arch/x86/interface/pxe/pxe_tftp.c    | 12 +++++-------
 src/arch/x86/interface/pxe/pxe_udp.c     |  9 ++++-----
 src/core/cachedhcp.c                     |  4 ++--
 src/core/dma.c                           |  2 +-
 src/core/fdt.c                           |  6 +++---
 src/drivers/infiniband/arbel.c           |  2 +-
 src/drivers/infiniband/arbel.h           |  5 ++---
 src/drivers/infiniband/golan.c           | 12 ++++++------
 src/drivers/infiniband/golan.h           |  2 +-
 src/drivers/infiniband/hermon.c          |  2 +-
 src/drivers/infiniband/hermon.h          |  5 ++---
 src/drivers/net/efi/nii.c                |  2 +-
 src/drivers/net/netvsc.c                 |  2 +-
 src/drivers/net/netvsc.h                 |  2 +-
 src/drivers/usb/xhci.h                   |  3 +--
 src/image/segment.c                      |  2 +-
 src/include/ipxe/cachedhcp.h             |  3 +--
 src/include/ipxe/linux_sysfs.h           |  4 +---
 src/include/ipxe/memblock.h              |  3 +--
 src/include/ipxe/segment.h               |  4 ++--
 src/include/ipxe/vmbus.h                 |  3 +--
 src/interface/efi/efi_block.c            |  3 +--
 src/interface/efi/efi_bofm.c             |  3 +--
 src/interface/efi/efi_cachedhcp.c        | 10 ++++------
 src/interface/efi/efi_file.c             | 17 +++++++----------
 src/interface/hyperv/vmbus.c             |  4 ++--
 src/interface/linux/linux_acpi.c         |  1 +
 src/interface/linux/linux_smbios.c       |  1 +
 src/interface/linux/linux_sysfs.c        |  6 +++---
 src/tests/bofm_test.c                    |  5 ++---
 34 files changed, 69 insertions(+), 86 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/vram_settings.c b/src/arch/x86/core/vram_settings.c
index ceeada467..a97a463fe 100644
--- a/src/arch/x86/core/vram_settings.c
+++ b/src/arch/x86/core/vram_settings.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <ipxe/uaccess.h>
 #include <ipxe/settings.h>
 
@@ -47,12 +48,12 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * @ret len		Length of setting data, or negative error
  */
 static int vram_fetch ( void *data, size_t len ) {
-	userptr_t vram = phys_to_virt ( VRAM_BASE );
+	const void *vram = phys_to_virt ( VRAM_BASE );
 
 	/* Copy video RAM */
 	if ( len > VRAM_LEN )
 		len = VRAM_LEN;
-	copy_from_user ( data, vram, 0, len );
+	memcpy ( data, vram, len );
 
 	return VRAM_LEN;
 }
diff --git a/src/arch/x86/image/pxe_image.c b/src/arch/x86/image/pxe_image.c
index 5472ea594..9f8044fa1 100644
--- a/src/arch/x86/image/pxe_image.c
+++ b/src/arch/x86/image/pxe_image.c
@@ -54,7 +54,7 @@ const char *pxe_cmdline;
  * @ret rc		Return status code
  */
 static int pxe_exec ( struct image *image ) {
-	userptr_t buffer = real_to_virt ( 0, 0x7c00 );
+	void *buffer = real_to_virt ( 0, 0x7c00 );
 	struct net_device *netdev;
 	int rc;
 
diff --git a/src/arch/x86/include/realmode.h b/src/arch/x86/include/realmode.h
index 0017b42c0..75f7d16e7 100644
--- a/src/arch/x86/include/realmode.h
+++ b/src/arch/x86/include/realmode.h
@@ -87,7 +87,7 @@ real_to_virt ( unsigned int segment, unsigned int offset ) {
 static inline __always_inline void
 copy_to_real ( unsigned int dest_seg, unsigned int dest_off,
 	       void *src, size_t n ) {
-	copy_to_user ( real_to_virt ( dest_seg, dest_off ), 0, src, n );
+	memcpy ( real_to_virt ( dest_seg, dest_off ), src, n );
 }
 
 /**
@@ -101,7 +101,7 @@ copy_to_real ( unsigned int dest_seg, unsigned int dest_off,
 static inline __always_inline void
 copy_from_real ( void *dest, unsigned int src_seg,
 		 unsigned int src_off, size_t n ) {
-	copy_from_user ( dest, real_to_virt ( src_seg, src_off ), 0, n );
+	memcpy ( dest, real_to_virt ( src_seg, src_off ), n );
 }
 
 /**
diff --git a/src/arch/x86/interface/pxe/pxe_preboot.c b/src/arch/x86/interface/pxe/pxe_preboot.c
index 727d8e1ea..77dcf66e7 100644
--- a/src/arch/x86/interface/pxe/pxe_preboot.c
+++ b/src/arch/x86/interface/pxe/pxe_preboot.c
@@ -33,7 +33,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <string.h>
 #include <stdlib.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/dhcp.h>
 #include <ipxe/fakedhcp.h>
 #include <ipxe/device.h>
@@ -184,7 +183,7 @@ pxenv_get_cached_info ( struct s_PXENV_GET_CACHED_INFO *get_cached_info ) {
 	union pxe_cached_info *info;
 	unsigned int idx;
 	size_t len;
-	userptr_t buffer;
+	void *buffer;
 
 	DBGC ( &pxe_netdev, "PXENV_GET_CACHED_INFO %s to %04x:%04x+%x",
 	       pxenv_get_cached_info_name ( get_cached_info->PacketType ),
@@ -245,7 +244,7 @@ pxenv_get_cached_info ( struct s_PXENV_GET_CACHED_INFO *get_cached_info ) {
 			DBGC ( &pxe_netdev, " buffer may be too short" );
 		buffer = real_to_virt ( get_cached_info->Buffer.segment,
 					get_cached_info->Buffer.offset );
-		copy_to_user ( buffer, 0, info, len );
+		memcpy ( buffer, info, len );
 		get_cached_info->BufferSize = len;
 	}
 
diff --git a/src/arch/x86/interface/pxe/pxe_tftp.c b/src/arch/x86/interface/pxe/pxe_tftp.c
index 073414dce..aa675fd13 100644
--- a/src/arch/x86/interface/pxe/pxe_tftp.c
+++ b/src/arch/x86/interface/pxe/pxe_tftp.c
@@ -33,7 +33,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdio.h>
 #include <errno.h>
 #include <byteswap.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/in.h>
 #include <ipxe/tftp.h>
 #include <ipxe/iobuf.h>
@@ -49,7 +48,7 @@ struct pxe_tftp_connection {
 	/** Data transfer interface */
 	struct interface xfer;
 	/** Data buffer */
-	userptr_t buffer;
+	void *buffer;
 	/** Size of data buffer */
 	size_t size;
 	/** Starting offset of data buffer */
@@ -121,9 +120,8 @@ static int pxe_tftp_xfer_deliver ( struct pxe_tftp_connection *pxe_tftp,
 		      ( pxe_tftp->start + pxe_tftp->size ) );
 		rc = -ENOBUFS;
 	} else {
-		copy_to_user ( pxe_tftp->buffer,
-			       ( pxe_tftp->offset - pxe_tftp->start ),
-			       iobuf->data, len );
+		memcpy ( ( pxe_tftp->buffer + pxe_tftp->offset -
+			   pxe_tftp->start ), iobuf->data, len );
 	}
 
 	/* Calculate new buffer position */
@@ -385,7 +383,7 @@ static PXENV_EXIT_t pxenv_tftp_read ( struct s_PXENV_TFTP_READ *tftp_read ) {
 	while ( ( ( rc = pxe_tftp.rc ) == -EINPROGRESS ) &&
 		( pxe_tftp.offset == pxe_tftp.start ) )
 		step();
-	pxe_tftp.buffer = UNULL;
+	pxe_tftp.buffer = NULL;
 	tftp_read->BufferSize = ( pxe_tftp.offset - pxe_tftp.start );
 	tftp_read->PacketNumber = ++pxe_tftp.blkidx;
 
@@ -496,7 +494,7 @@ PXENV_EXIT_t pxenv_tftp_read_file ( struct s_PXENV_TFTP_READ_FILE
 	pxe_tftp.size = tftp_read_file->BufferSize;
 	while ( ( rc = pxe_tftp.rc ) == -EINPROGRESS )
 		step();
-	pxe_tftp.buffer = UNULL;
+	pxe_tftp.buffer = NULL;
 	tftp_read_file->BufferSize = pxe_tftp.max_offset;
 
 	/* Close TFTP file */
diff --git a/src/arch/x86/interface/pxe/pxe_udp.c b/src/arch/x86/interface/pxe/pxe_udp.c
index 47abb7df4..61c858dde 100644
--- a/src/arch/x86/interface/pxe/pxe_udp.c
+++ b/src/arch/x86/interface/pxe/pxe_udp.c
@@ -9,7 +9,6 @@
 #include <ipxe/iobuf.h>
 #include <ipxe/xfer.h>
 #include <ipxe/udp.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/process.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/malloc.h>
@@ -296,7 +295,7 @@ pxenv_udp_write ( struct s_PXENV_UDP_WRITE *pxenv_udp_write ) {
 	};
 	size_t len;
 	struct io_buffer *iobuf;
-	userptr_t buffer;
+	const void *buffer;
 	int rc;
 
 	DBG ( "PXENV_UDP_WRITE" );
@@ -330,7 +329,7 @@ pxenv_udp_write ( struct s_PXENV_UDP_WRITE *pxenv_udp_write ) {
 	}
 	buffer = real_to_virt ( pxenv_udp_write->buffer.segment,
 				pxenv_udp_write->buffer.offset );
-	copy_from_user ( iob_put ( iobuf, len ), buffer, 0, len );
+	memcpy ( iob_put ( iobuf, len ), buffer, len );
 
 	DBG ( " %04x:%04x+%x %d->%s:%d\n", pxenv_udp_write->buffer.segment,
 	      pxenv_udp_write->buffer.offset, pxenv_udp_write->buffer_size,
@@ -400,7 +399,7 @@ static PXENV_EXIT_t pxenv_udp_read ( struct s_PXENV_UDP_READ *pxenv_udp_read ) {
 	struct pxe_udp_pseudo_header *pshdr;
 	uint16_t d_port_wanted = pxenv_udp_read->d_port;
 	uint16_t d_port;
-	userptr_t buffer;
+	void *buffer;
 	size_t len;
 
 	/* Try receiving a packet, if the queue is empty */
@@ -443,7 +442,7 @@ static PXENV_EXIT_t pxenv_udp_read ( struct s_PXENV_UDP_READ *pxenv_udp_read ) {
 	len = iob_len ( iobuf );
 	if ( len > pxenv_udp_read->buffer_size )
 		len = pxenv_udp_read->buffer_size;
-	copy_to_user ( buffer, 0, iobuf->data, len );
+	memcpy ( buffer, iobuf->data, len );
 	pxenv_udp_read->buffer_size = len;
 
 	/* Fill in source/dest information */
diff --git a/src/core/cachedhcp.c b/src/core/cachedhcp.c
index 07589f0b8..0d400db16 100644
--- a/src/core/cachedhcp.c
+++ b/src/core/cachedhcp.c
@@ -198,7 +198,7 @@ static int cachedhcp_apply ( struct cached_dhcp_packet *cache,
  * @ret rc		Return status code
  */
 int cachedhcp_record ( struct cached_dhcp_packet *cache, unsigned int vlan,
-		       userptr_t data, size_t max_len ) {
+		       const void *data, size_t max_len ) {
 	struct dhcp_packet *dhcppkt;
 	struct dhcp_packet *tmp;
 	struct dhcphdr *dhcphdr;
@@ -216,7 +216,7 @@ int cachedhcp_record ( struct cached_dhcp_packet *cache, unsigned int vlan,
 		return -ENOMEM;
 	}
 	dhcphdr = ( ( ( void * ) dhcppkt ) + sizeof ( *dhcppkt ) );
-	copy_from_user ( dhcphdr, data, 0, max_len );
+	memcpy ( dhcphdr, data, max_len );
 	dhcppkt_init ( dhcppkt, dhcphdr, max_len );
 
 	/* Shrink packet to required length.  If reallocation fails,
diff --git a/src/core/dma.c b/src/core/dma.c
index 1f3c1d8a6..cf4b20379 100644
--- a/src/core/dma.c
+++ b/src/core/dma.c
@@ -136,7 +136,7 @@ static void * dma_op_umalloc ( struct dma_device *dma,
 	struct dma_operations *op = dma->op;
 
 	if ( ! op )
-		return UNULL;
+		return NULL;
 	return op->umalloc ( dma, map, len, align );
 }
 
diff --git a/src/core/fdt.c b/src/core/fdt.c
index 4c709b342..7c7127aed 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -1037,7 +1037,7 @@ static int fdt_urealloc ( struct fdt *fdt, size_t len ) {
 	assert ( len >= fdt->used );
 
 	/* Attempt reallocation */
-	new = urealloc ( virt_to_user ( fdt->raw ), len );
+	new = urealloc ( fdt->raw, len );
 	if ( ! new ) {
 		DBGC ( fdt, "FDT could not reallocate from +%#04zx to "
 		       "+%#04zx\n", fdt->len, len );
@@ -1129,7 +1129,7 @@ int fdt_create ( struct fdt_header **hdr, const char *cmdline ) {
 	return 0;
 
  err_bootargs:
-	ufree ( virt_to_user ( fdt.raw ) );
+	ufree ( fdt.raw );
  err_alloc:
  err_image:
 	return rc;
@@ -1143,7 +1143,7 @@ int fdt_create ( struct fdt_header **hdr, const char *cmdline ) {
 void fdt_remove ( struct fdt_header *hdr ) {
 
 	/* Free modifiable copy */
-	ufree ( virt_to_user ( hdr ) );
+	ufree ( hdr );
 }
 
 /* Drag in objects via fdt_describe() */
diff --git a/src/drivers/infiniband/arbel.c b/src/drivers/infiniband/arbel.c
index 4cb4167e0..0789ea593 100644
--- a/src/drivers/infiniband/arbel.c
+++ b/src/drivers/infiniband/arbel.c
@@ -2119,7 +2119,7 @@ static void arbel_stop_firmware ( struct arbel *arbel ) {
 		DBGC ( arbel, "Arbel %p FATAL could not stop firmware: %s\n",
 		       arbel, strerror ( rc ) );
 		/* Leak memory and return; at least we avoid corruption */
-		arbel->firmware_area = UNULL;
+		arbel->firmware_area = NULL;
 		return;
 	}
 }
diff --git a/src/drivers/infiniband/arbel.h b/src/drivers/infiniband/arbel.h
index 8a5a996a3..a31e59934 100644
--- a/src/drivers/infiniband/arbel.h
+++ b/src/drivers/infiniband/arbel.h
@@ -10,7 +10,6 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/ib_packet.h>
 #include "mlx_bitops.h"
 #include "MT25218_PRM.h"
@@ -492,7 +491,7 @@ struct arbel {
 	 * final teardown, in order to avoid memory map changes at
 	 * runtime.
 	 */
-	userptr_t firmware_area;
+	void *firmware_area;
 	/** ICM size */
 	size_t icm_len;
 	/** ICM AUX size */
@@ -503,7 +502,7 @@ struct arbel {
 	 * final teardown, in order to avoid memory map changes at
 	 * runtime.
 	 */
-	userptr_t icm;
+	void *icm;
 	/** Offset within ICM of doorbell records */
 	size_t db_rec_offset;
 	/** Doorbell records */
diff --git a/src/drivers/infiniband/golan.c b/src/drivers/infiniband/golan.c
index a33bad9ff..ffa78fabf 100755
--- a/src/drivers/infiniband/golan.c
+++ b/src/drivers/infiniband/golan.c
@@ -52,7 +52,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 
 struct golan_page {
 	struct list_head list;
-	userptr_t addr;
+	void *addr;
 };
 
 static void golan_free_fw_areas ( struct golan *golan ) {
@@ -61,7 +61,7 @@ static void golan_free_fw_areas ( struct golan *golan ) {
 	for (i = 0; i < GOLAN_FW_AREAS_NUM; i++) {
 		if ( golan->fw_areas[i].area ) {
 			ufree ( golan->fw_areas[i].area );
-			golan->fw_areas[i].area = UNULL;
+			golan->fw_areas[i].area = NULL;
 		}
 	}
 }
@@ -75,7 +75,7 @@ static int golan_init_fw_areas ( struct golan *golan ) {
 	}
 
 	for (i = 0; i < GOLAN_FW_AREAS_NUM; i++)
-		golan->fw_areas[i].area = UNULL;
+		golan->fw_areas[i].area = NULL;
 
 	return rc;
 
@@ -448,12 +448,12 @@ static inline int golan_provide_pages ( struct golan *golan , uint32_t pages
 	int size_ibox = 0;
 	int size_obox = 0;
 	int rc = 0;
-	userptr_t next_page_addr = UNULL;
+	void *next_page_addr = NULL;
 
 	DBGC(golan, "%s\n", __FUNCTION__);
 	if ( ! fw_area->area ) {
 		fw_area->area = umalloc ( GOLAN_PAGE_SIZE * pages );
-		if ( fw_area->area == UNULL ) {
+		if ( fw_area->area == NULL ) {
 			rc = -ENOMEM;
 			DBGC (golan ,"Failed to allocated %d pages \n",pages);
 			goto err_golan_alloc_fw_area;
@@ -467,7 +467,7 @@ static inline int golan_provide_pages ( struct golan *golan , uint32_t pages
 		unsigned i, j;
 		struct golan_cmd_layout	*cmd;
 		struct golan_manage_pages_inbox *in;
-		userptr_t addr = 0;
+		void *addr = NULL;
 
 		mailbox = GET_INBOX(golan, MEM_MBOX);
 		size_ibox = sizeof(struct golan_manage_pages_inbox) + (pas_num * GOLAN_PAS_SIZE);
diff --git a/src/drivers/infiniband/golan.h b/src/drivers/infiniband/golan.h
index f7da1e960..8122f8d38 100755
--- a/src/drivers/infiniband/golan.h
+++ b/src/drivers/infiniband/golan.h
@@ -121,7 +121,7 @@ struct golan_firmware_area {
 	 * final teardown, in order to avoid memory map changes at
 	 * runtime.
 	 */
-	userptr_t area;
+	void *area;
 };
 /* Queue Pair */
 #define GOLAN_SEND_WQE_BB_SIZE			64
diff --git a/src/drivers/infiniband/hermon.c b/src/drivers/infiniband/hermon.c
index 3138d8bfb..d25f4f011 100644
--- a/src/drivers/infiniband/hermon.c
+++ b/src/drivers/infiniband/hermon.c
@@ -2422,7 +2422,7 @@ static void hermon_stop_firmware ( struct hermon *hermon ) {
 		DBGC ( hermon, "Hermon %p FATAL could not stop firmware: %s\n",
 		       hermon, strerror ( rc ) );
 		/* Leak memory and return; at least we avoid corruption */
-		hermon->firmware_area = UNULL;
+		hermon->firmware_area = NULL;
 		return;
 	}
 }
diff --git a/src/drivers/infiniband/hermon.h b/src/drivers/infiniband/hermon.h
index a952bbd81..be79ff9d0 100644
--- a/src/drivers/infiniband/hermon.h
+++ b/src/drivers/infiniband/hermon.h
@@ -10,7 +10,6 @@
 FILE_LICENCE ( GPL2_OR_LATER );
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/ib_packet.h>
 #include <ipxe/bofm.h>
 #include <ipxe/nvsvpd.h>
@@ -887,7 +886,7 @@ struct hermon {
 	 * final teardown, in order to avoid memory map changes at
 	 * runtime.
 	 */
-	userptr_t firmware_area;
+	void *firmware_area;
 	/** ICM map */
 	struct hermon_icm_map icm_map[HERMON_ICM_NUM_REGIONS];
 	/** ICM size */
@@ -900,7 +899,7 @@ struct hermon {
 	 * final teardown, in order to avoid memory map changes at
 	 * runtime.
 	 */
-	userptr_t icm;
+	void *icm;
 
 	/** Event queue */
 	struct hermon_event_queue eq;
diff --git a/src/drivers/net/efi/nii.c b/src/drivers/net/efi/nii.c
index 6381fb2dd..c60d4ca18 100644
--- a/src/drivers/net/efi/nii.c
+++ b/src/drivers/net/efi/nii.c
@@ -177,7 +177,7 @@ struct nii_nic {
 	size_t mtu;
 
 	/** Hardware transmit/receive buffer */
-	userptr_t buffer;
+	void *buffer;
 	/** Hardware transmit/receive buffer length */
 	size_t buffer_len;
 
diff --git a/src/drivers/net/netvsc.c b/src/drivers/net/netvsc.c
index 5be52fb8e..4bdf7b517 100644
--- a/src/drivers/net/netvsc.c
+++ b/src/drivers/net/netvsc.c
@@ -622,7 +622,7 @@ static int netvsc_buffer_copy ( struct vmbus_xfer_pages *pages, void *data,
 		return -ERANGE;
 
 	/* Copy data from buffer */
-	copy_from_user ( data, buffer->data, offset, len );
+	memcpy ( data, ( buffer->data + offset ), len );
 
 	return 0;
 }
diff --git a/src/drivers/net/netvsc.h b/src/drivers/net/netvsc.h
index 93192357f..41db49af7 100644
--- a/src/drivers/net/netvsc.h
+++ b/src/drivers/net/netvsc.h
@@ -305,7 +305,7 @@ struct netvsc_buffer {
 	/** Buffer length */
 	size_t len;
 	/** Buffer */
-	userptr_t data;
+	void *data;
 	/** GPADL ID */
 	unsigned int gpadl;
 };
diff --git a/src/drivers/usb/xhci.h b/src/drivers/usb/xhci.h
index a3c8888af..22bc115c2 100644
--- a/src/drivers/usb/xhci.h
+++ b/src/drivers/usb/xhci.h
@@ -11,7 +11,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <assert.h>
 #include <ipxe/pci.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/usb.h>
 
 /** Minimum alignment required for data structures
@@ -1054,7 +1053,7 @@ struct xhci_scratchpad {
 	/** Number of page-sized scratchpad buffers */
 	unsigned int count;
 	/** Scratchpad buffer area */
-	userptr_t buffer;
+	void *buffer;
 	/** Buffer DMA mapping */
 	struct dma_mapping buffer_map;
 	/** Scratchpad array */
diff --git a/src/image/segment.c b/src/image/segment.c
index ebc2b703d..2cb637dc2 100644
--- a/src/image/segment.c
+++ b/src/image/segment.c
@@ -57,7 +57,7 @@ struct errortab segment_errors[] __errortab = {
  * @v memsz		Size of the segment
  * @ret rc		Return status code
  */
-int prep_segment ( userptr_t segment, size_t filesz, size_t memsz ) {
+int prep_segment ( void *segment, size_t filesz, size_t memsz ) {
 	struct memory_map memmap;
 	physaddr_t start = virt_to_phys ( segment );
 	physaddr_t mid = ( start + filesz );
diff --git a/src/include/ipxe/cachedhcp.h b/src/include/ipxe/cachedhcp.h
index 8ebee3b7b..5b19bc59e 100644
--- a/src/include/ipxe/cachedhcp.h
+++ b/src/include/ipxe/cachedhcp.h
@@ -10,7 +10,6 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stddef.h>
-#include <ipxe/uaccess.h>
 
 struct net_device;
 struct cached_dhcp_packet;
@@ -20,7 +19,7 @@ extern struct cached_dhcp_packet cached_proxydhcp;
 extern struct cached_dhcp_packet cached_pxebs;
 
 extern int cachedhcp_record ( struct cached_dhcp_packet *cache,
-			      unsigned int vlan, userptr_t data,
+			      unsigned int vlan, const void *data,
 			      size_t max_len );
 extern void cachedhcp_recycle ( struct net_device *netdev );
 
diff --git a/src/include/ipxe/linux_sysfs.h b/src/include/ipxe/linux_sysfs.h
index d97b649c0..fbe1e6e8a 100644
--- a/src/include/ipxe/linux_sysfs.h
+++ b/src/include/ipxe/linux_sysfs.h
@@ -9,8 +9,6 @@
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
-#include <ipxe/uaccess.h>
-
-extern int linux_sysfs_read ( const char *filename, userptr_t *data );
+extern int linux_sysfs_read ( const char *filename, void **data );
 
 #endif /* _IPXE_LINUX_SYSFS_H */
diff --git a/src/include/ipxe/memblock.h b/src/include/ipxe/memblock.h
index 2bb38c460..4b6c64156 100644
--- a/src/include/ipxe/memblock.h
+++ b/src/include/ipxe/memblock.h
@@ -10,8 +10,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 
-extern size_t largest_memblock ( userptr_t *start );
+extern size_t largest_memblock ( void **start );
 
 #endif /* _IPXE_MEMBLOCK_H */
diff --git a/src/include/ipxe/segment.h b/src/include/ipxe/segment.h
index 9d5ecbd9b..b37c93c93 100644
--- a/src/include/ipxe/segment.h
+++ b/src/include/ipxe/segment.h
@@ -10,8 +10,8 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
-#include <ipxe/uaccess.h>
+#include <stdint.h>
 
-extern int prep_segment ( userptr_t segment, size_t filesz, size_t memsz );
+extern int prep_segment ( void *segment, size_t filesz, size_t memsz );
 
 #endif /* _IPXE_SEGMENT_H */
diff --git a/src/include/ipxe/vmbus.h b/src/include/ipxe/vmbus.h
index 682441857..5eee230fe 100644
--- a/src/include/ipxe/vmbus.h
+++ b/src/include/ipxe/vmbus.h
@@ -13,7 +13,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/uuid.h>
 #include <ipxe/device.h>
 #include <ipxe/tables.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/iobuf.h>
 #include <ipxe/hyperv.h>
 
@@ -634,7 +633,7 @@ vmbus_gpadl_is_obsolete ( unsigned int gpadl ) {
 	return ( gpadl <= vmbus_obsolete_gpadl );
 }
 
-extern int vmbus_establish_gpadl ( struct vmbus_device *vmdev, userptr_t data,
+extern int vmbus_establish_gpadl ( struct vmbus_device *vmdev, void *data,
 				   size_t len );
 extern int vmbus_gpadl_teardown ( struct vmbus_device *vmdev,
 				  unsigned int gpadl );
diff --git a/src/interface/efi/efi_block.c b/src/interface/efi/efi_block.c
index 5165bd804..94e2aae06 100644
--- a/src/interface/efi/efi_block.c
+++ b/src/interface/efi/efi_block.c
@@ -110,8 +110,7 @@ static int efi_block_rw ( struct san_device *sandev, uint64_t lba,
 	}
 
 	/* Read from / write to block device */
-	if ( ( rc = sandev_rw ( sandev, lba, count,
-				virt_to_user ( data ) ) ) != 0 ) {
+	if ( ( rc = sandev_rw ( sandev, lba, count, data ) ) != 0 ) {
 		DBGC ( sandev->drive, "EFIBLK %#02x I/O failed: %s\n",
 		       sandev->drive, strerror ( rc ) );
 		return rc;
diff --git a/src/interface/efi/efi_bofm.c b/src/interface/efi/efi_bofm.c
index b64770d8a..7d1d3619f 100644
--- a/src/interface/efi/efi_bofm.c
+++ b/src/interface/efi/efi_bofm.c
@@ -284,8 +284,7 @@ static int efi_bofm_start ( struct efi_device *efidev ) {
 			efi_handle_name ( device ) );
 		DBGC2_HD ( device, bofmtab2, bofmtab2->Parameters.Length );
 	}
-	bofmrc = bofm ( virt_to_user ( bofmtab2 ? bofmtab2 : bofmtab ),
-			&efipci.pci );
+	bofmrc = bofm ( ( bofmtab2 ? bofmtab2 : bofmtab ), &efipci.pci );
 	DBGC ( device, "EFIBOFM %s status %08x\n",
 	       efi_handle_name ( device ), bofmrc );
 	DBGC2 ( device, "EFIBOFM %s version 1 after processing:\n",
diff --git a/src/interface/efi/efi_cachedhcp.c b/src/interface/efi/efi_cachedhcp.c
index eb41a8e43..6bba4173a 100644
--- a/src/interface/efi/efi_cachedhcp.c
+++ b/src/interface/efi/efi_cachedhcp.c
@@ -72,8 +72,7 @@ int efi_cachedhcp_record ( EFI_HANDLE device,
 
 	/* Record DHCPACK, if present */
 	if ( mode->DhcpAckReceived &&
-	     ( ( rc = cachedhcp_record ( &cached_dhcpack, vlan,
-					 virt_to_user ( &mode->DhcpAck ),
+	     ( ( rc = cachedhcp_record ( &cached_dhcpack, vlan, &mode->DhcpAck,
 					 sizeof ( mode->DhcpAck ) ) ) != 0 ) ) {
 		DBGC ( device, "EFI %s could not record DHCPACK: %s\n",
 		       efi_handle_name ( device ), strerror ( rc ) );
@@ -83,7 +82,7 @@ int efi_cachedhcp_record ( EFI_HANDLE device,
 	/* Record ProxyDHCPOFFER, if present */
 	if ( mode->ProxyOfferReceived &&
 	     ( ( rc = cachedhcp_record ( &cached_proxydhcp, vlan,
-					 virt_to_user ( &mode->ProxyOffer ),
+					 &mode->ProxyOffer,
 					 sizeof ( mode->ProxyOffer ) ) ) != 0)){
 		DBGC ( device, "EFI %s could not record ProxyDHCPOFFER: %s\n",
 		       efi_handle_name ( device ), strerror ( rc ) );
@@ -92,9 +91,8 @@ int efi_cachedhcp_record ( EFI_HANDLE device,
 
 	/* Record PxeBSACK, if present */
 	if ( mode->PxeReplyReceived &&
-	     ( ( rc = cachedhcp_record ( &cached_pxebs, vlan,
-					 virt_to_user ( &mode->PxeReply ),
-					 sizeof ( mode->PxeReply ) ) ) != 0)){
+	     ( ( rc = cachedhcp_record ( &cached_pxebs, vlan, &mode->PxeReply,
+					 sizeof ( mode->PxeReply ) ) ) != 0 )){
 		DBGC ( device, "EFI %s could not record PXEBSACK: %s\n",
 		       efi_handle_name ( device ), strerror ( rc ) );
 		return rc;
diff --git a/src/interface/efi/efi_file.c b/src/interface/efi/efi_file.c
index b7b97aee7..79330641d 100644
--- a/src/interface/efi/efi_file.c
+++ b/src/interface/efi/efi_file.c
@@ -177,12 +177,12 @@ static size_t efi_file_len ( struct efi_file *file ) {
  * Read chunk of EFI file
  *
  * @v reader		EFI file reader
- * @v data		Input data, or UNULL to zero-fill
+ * @v data		Input data, or NULL to zero-fill
  * @v len		Length of input data
  * @ret len		Length of output data
  */
 static size_t efi_file_read_chunk ( struct efi_file_reader *reader,
-				    userptr_t data, size_t len ) {
+				    const void *data, size_t len ) {
 	struct efi_file *file = reader->file;
 	size_t offset;
 
@@ -203,7 +203,7 @@ static size_t efi_file_read_chunk ( struct efi_file_reader *reader,
 
 	/* Copy or zero output data */
 	if ( data ) {
-		copy_from_user ( reader->data, data, offset, len );
+		memcpy ( reader->data, ( data + offset ), len );
 	} else {
 		memset ( reader->data, 0, len );
 	}
@@ -262,7 +262,7 @@ static size_t efi_file_read_initrd ( struct efi_file_reader *reader ) {
 			       efi_file_name ( file ), reader->pos,
 			       ( reader->pos + pad_len ) );
 		}
-		len += efi_file_read_chunk ( reader, UNULL, pad_len );
+		len += efi_file_read_chunk ( reader, NULL, pad_len );
 
 		/* Read CPIO header(s), if applicable */
 		name = cpio_name ( image );
@@ -274,13 +274,10 @@ static size_t efi_file_read_initrd ( struct efi_file_reader *reader ) {
 			       efi_file_name ( file ), reader->pos,
 			       ( reader->pos + cpio_len + pad_len ),
 			       image->name );
-			len += efi_file_read_chunk ( reader,
-						     virt_to_user ( &cpio ),
+			len += efi_file_read_chunk ( reader, &cpio,
 						     sizeof ( cpio ) );
-			len += efi_file_read_chunk ( reader,
-						     virt_to_user ( name ),
-						     name_len );
-			len += efi_file_read_chunk ( reader, UNULL, pad_len );
+			len += efi_file_read_chunk ( reader, name, name_len );
+			len += efi_file_read_chunk ( reader, NULL, pad_len );
 		}
 
 		/* Read file data */
diff --git a/src/interface/hyperv/vmbus.c b/src/interface/hyperv/vmbus.c
index 49ccf69c8..1c44cab5e 100644
--- a/src/interface/hyperv/vmbus.c
+++ b/src/interface/hyperv/vmbus.c
@@ -273,7 +273,7 @@ static int vmbus_negotiate_version ( struct hv_hypervisor *hv ) {
  * @v len		Length of data buffer
  * @ret gpadl		GPADL ID, or negative error
  */
-int vmbus_establish_gpadl ( struct vmbus_device *vmdev, userptr_t data,
+int vmbus_establish_gpadl ( struct vmbus_device *vmdev, void *data,
 			    size_t len ) {
 	struct hv_hypervisor *hv = vmdev->hv;
 	struct vmbus *vmbus = hv->vmbus;
@@ -442,7 +442,7 @@ int vmbus_open ( struct vmbus_device *vmdev,
 	memset ( ring, 0, len );
 
 	/* Establish GPADL for ring buffer */
-	gpadl = vmbus_establish_gpadl ( vmdev, virt_to_user ( ring ), len );
+	gpadl = vmbus_establish_gpadl ( vmdev, ring, len );
 	if ( gpadl < 0 ) {
 		rc = gpadl;
 		goto err_establish;
diff --git a/src/interface/linux/linux_acpi.c b/src/interface/linux/linux_acpi.c
index a2a8bf12e..21a2e27cc 100644
--- a/src/interface/linux/linux_acpi.c
+++ b/src/interface/linux/linux_acpi.c
@@ -21,6 +21,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/linux_api.h>
 #include <ipxe/linux_sysfs.h>
diff --git a/src/interface/linux/linux_smbios.c b/src/interface/linux/linux_smbios.c
index a12c936ed..1450fcf1b 100644
--- a/src/interface/linux/linux_smbios.c
+++ b/src/interface/linux/linux_smbios.c
@@ -19,6 +19,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
+#include <string.h>
 #include <errno.h>
 #include <ipxe/linux_api.h>
 #include <ipxe/linux_sysfs.h>
diff --git a/src/interface/linux/linux_sysfs.c b/src/interface/linux/linux_sysfs.c
index cbb23d81d..321824ba9 100644
--- a/src/interface/linux/linux_sysfs.c
+++ b/src/interface/linux/linux_sysfs.c
@@ -42,8 +42,8 @@ FILE_LICENCE ( GPL2_OR_LATER );
  * @v data		Data to fill in
  * @ret len		Length read, or negative error
  */
-int linux_sysfs_read ( const char *filename, userptr_t *data ) {
-	userptr_t tmp;
+int linux_sysfs_read ( const char *filename, void **data ) {
+	void *tmp;
 	ssize_t read;
 	size_t len;
 	int fd;
@@ -59,7 +59,7 @@ int linux_sysfs_read ( const char *filename, userptr_t *data ) {
 	}
 
 	/* Read file */
-	for ( *data = UNULL, len = 0 ; ; len += read ) {
+	for ( *data = NULL, len = 0 ; ; len += read ) {
 
 		/* (Re)allocate space */
 		tmp = urealloc ( *data, ( len + LINUX_SYSFS_BLKSIZE ) );
diff --git a/src/tests/bofm_test.c b/src/tests/bofm_test.c
index 829924887..dbef1eb90 100644
--- a/src/tests/bofm_test.c
+++ b/src/tests/bofm_test.c
@@ -26,7 +26,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <stdio.h>
 #include <string.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/init.h>
 #include <ipxe/pci.h>
 #include <ipxe/ethernet.h>
@@ -111,7 +110,7 @@ void bofm_test ( struct pci_device *pci ) {
 	printf ( "BOFMTEST performing harvest\n" );
 	bofmtab_harvest.en.busdevfn = pci->busdevfn;
 	DBG_HDA ( 0, &bofmtab_harvest, sizeof ( bofmtab_harvest ) );
-	bofmrc = bofm ( virt_to_user ( &bofmtab_harvest ), pci );
+	bofmrc = bofm ( &bofmtab_harvest, pci );
 	printf ( "BOFMTEST harvest result %08x\n", bofmrc );
 	if ( bofmtab_harvest.en.options & BOFM_EN_HVST ) {
 		printf ( "BOFMTEST harvested MAC address %s\n",
@@ -125,7 +124,7 @@ void bofm_test ( struct pci_device *pci ) {
 	printf ( "BOFMTEST performing update\n" );
 	bofmtab_update.en.busdevfn = pci->busdevfn;
 	DBG_HDA ( 0, &bofmtab_update, sizeof ( bofmtab_update ) );
-	bofmrc = bofm ( virt_to_user ( &bofmtab_update ), pci );
+	bofmrc = bofm ( &bofmtab_update, pci );
 	printf ( "BOFMTEST update result %08x\n", bofmrc );
 	if ( bofmtab_update.en.options & BOFM_EN_CSM_SUCCESS ) {
 		printf ( "BOFMTEST updated MAC address to %s\n",
-- 
cgit v1.2.3-55-g7522


From 2742ed5d77e1dd6cdcf20800d2b43295874ac621 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 24 Apr 2025 16:35:49 +0100
Subject: [uaccess] Remove now-obsolete memchr_user()

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/librm.h           |  7 -------
 src/arch/x86/transitions/librm_mgmt.c  |  1 -
 src/core/uaccess.c                     |  1 -
 src/include/ipxe/linux/linux_uaccess.h |  6 ------
 src/include/ipxe/uaccess.h             | 34 ----------------------------------
 src/interface/linux/linux_uaccess.c    |  1 -
 6 files changed, 50 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index 7755abdcf..379b6d849 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -131,13 +131,6 @@ UACCESS_INLINE ( librm, virt_to_user ) ( volatile const void *addr ) {
 	return trivial_virt_to_user ( addr );
 }
 
-static inline __always_inline off_t
-UACCESS_INLINE ( librm, memchr_user ) ( userptr_t buffer, off_t offset,
-					int c, size_t len ) {
-	return trivial_memchr_user ( buffer, offset, c, len );
-}
-
-
 /******************************************************************************
  *
  * Access to variables in .data16 and .text16
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index e0679f0ff..5a6942825 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -431,7 +431,6 @@ void setup_sipi ( unsigned int vector, uint32_t handler,
 PROVIDE_UACCESS_INLINE ( librm, phys_to_virt );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_phys );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_user );
-PROVIDE_UACCESS_INLINE ( librm, memchr_user );
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
 PROVIDE_IOMAP ( pages, ioremap, ioremap_pages );
 PROVIDE_IOMAP ( pages, iounmap, iounmap_pages );
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index 32bd1ac38..bf922f66d 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -35,4 +35,3 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 PROVIDE_UACCESS_INLINE ( flat, phys_to_virt );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_phys );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
-PROVIDE_UACCESS_INLINE ( flat, memchr_user );
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index b4f7e2fc6..7d5f5f642 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -62,10 +62,4 @@ UACCESS_INLINE ( linux, virt_to_user ) ( volatile const void *addr ) {
 	return trivial_virt_to_user ( addr );
 }
 
-static inline __always_inline off_t
-UACCESS_INLINE ( linux, memchr_user ) ( userptr_t buffer, off_t offset,
-					int c, size_t len ) {
-	return trivial_memchr_user ( buffer, offset, c, len );
-}
-
 #endif /* _IPXE_LINUX_UACCESS_H */
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 62030dd8a..d0c6882ed 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -51,23 +51,6 @@ trivial_virt_to_user ( volatile const void *addr ) {
 	return ( ( userptr_t ) addr );
 }
 
-/**
- * Find character in user buffer
- *
- * @v buffer		User buffer
- * @v offset		Starting offset within buffer
- * @v c			Character to search for
- * @v len		Length of user buffer
- * @ret offset		Offset of character, or <0 if not found
- */
-static inline __always_inline off_t
-trivial_memchr_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
-	void *found;
-
-	found = memchr ( ( ( void * ) buffer + offset ), c, len );
-	return ( found ? ( found - ( void * ) buffer ) : -1 );
-}
-
 /** @} */
 
 /**
@@ -114,12 +97,6 @@ UACCESS_INLINE ( flat, virt_to_user ) ( volatile const void *addr ) {
 	return trivial_virt_to_user ( addr );
 }
 
-static inline __always_inline off_t
-UACCESS_INLINE ( flat, memchr_user ) ( userptr_t buffer, off_t offset,
-				       int c, size_t len ) {
-	return trivial_memchr_user ( buffer, offset, c, len );
-}
-
 /* Include all architecture-independent user access API headers */
 #include <ipxe/linux/linux_uaccess.h>
 
@@ -179,15 +156,4 @@ copy_from_user ( void *dest, userptr_t src, off_t src_off, size_t len ) {
 	memcpy ( dest, ( src + src_off ), len );
 }
 
-/**
- * Find character in user buffer
- *
- * @v userptr		User buffer
- * @v offset		Starting offset within buffer
- * @v c			Character to search for
- * @v len		Length of user buffer
- * @ret offset		Offset of character, or <0 if not found
- */
-off_t memchr_user ( userptr_t userptr, off_t offset, int c, size_t len );
-
 #endif /* _IPXE_UACCESS_H */
diff --git a/src/interface/linux/linux_uaccess.c b/src/interface/linux/linux_uaccess.c
index 4fdd8c03a..436707757 100644
--- a/src/interface/linux/linux_uaccess.c
+++ b/src/interface/linux/linux_uaccess.c
@@ -30,4 +30,3 @@ FILE_LICENCE(GPL2_OR_LATER);
 PROVIDE_UACCESS_INLINE(linux, phys_to_virt);
 PROVIDE_UACCESS_INLINE(linux, virt_to_phys);
 PROVIDE_UACCESS_INLINE(linux, virt_to_user);
-PROVIDE_UACCESS_INLINE(linux, memchr_user);
-- 
cgit v1.2.3-55-g7522


From 2f11f466e6b6cb47ac3b703b145e01f87bf8092e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 24 Apr 2025 17:11:30 +0100
Subject: [block] Remove userptr_t from block device abstraction

Simplify the block device code by assuming that all read/write buffers
are directly accessible via pointer dereferences.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/interface/pcbios/int13.c | 17 ++++++++---------
 src/core/blockdev.c                   |  8 ++++----
 src/core/blocktrans.c                 |  8 ++++----
 src/core/dummy_sanboot.c              |  1 +
 src/core/sanboot.c                    | 23 ++++++++++++-----------
 src/drivers/block/ata.c               | 30 +++++++++++++++---------------
 src/drivers/block/scsi.c              | 16 ++++++++--------
 src/drivers/usb/usbblk.c              | 10 +++++-----
 src/include/ipxe/ata.h                |  5 ++---
 src/include/ipxe/blockdev.h           | 13 ++++++-------
 src/include/ipxe/blocktrans.h         |  7 +++----
 src/include/ipxe/sanboot.h            |  4 ++--
 src/include/ipxe/scsi.h               |  5 ++---
 src/interface/efi/efi_block.c         |  5 +++--
 src/net/aoe.c                         |  7 ++-----
 src/net/fcp.c                         |  6 +++---
 src/net/tcp/httpblock.c               |  5 ++---
 src/net/tcp/httpcore.c                |  2 +-
 src/net/tcp/iscsi.c                   |  7 +++----
 19 files changed, 86 insertions(+), 93 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/interface/pcbios/int13.c b/src/arch/x86/interface/pcbios/int13.c
index 498676b70..73fdfebd3 100644
--- a/src/arch/x86/interface/pcbios/int13.c
+++ b/src/arch/x86/interface/pcbios/int13.c
@@ -181,8 +181,7 @@ static int int13_parse_eltorito ( struct san_device *sandev, void *scratch ) {
 	int rc;
 
 	/* Read boot record volume descriptor */
-	if ( ( rc = sandev_read ( sandev, ELTORITO_LBA, 1,
-				  virt_to_user ( boot ) ) ) != 0 ) {
+	if ( ( rc = sandev_read ( sandev, ELTORITO_LBA, 1, boot ) ) != 0 ) {
 		DBGC ( sandev->drive, "INT13 drive %02x could not read El "
 		       "Torito boot record volume descriptor: %s\n",
 		       sandev->drive, strerror ( rc ) );
@@ -228,7 +227,7 @@ static int int13_guess_geometry_hdd ( struct san_device *sandev, void *scratch,
 	int rc;
 
 	/* Read partition table */
-	if ( ( rc = sandev_read ( sandev, 0, 1, virt_to_user ( mbr ) ) ) != 0 ) {
+	if ( ( rc = sandev_read ( sandev, 0, 1, mbr ) ) != 0 ) {
 		DBGC ( sandev->drive, "INT13 drive %02x could not read "
 		       "partition table to guess geometry: %s\n",
 		       sandev->drive, strerror ( rc ) );
@@ -517,12 +516,12 @@ static int int13_rw_sectors ( struct san_device *sandev,
 			      int ( * sandev_rw ) ( struct san_device *sandev,
 						    uint64_t lba,
 						    unsigned int count,
-						    userptr_t buffer ) ) {
+						    void *buffer ) ) {
 	struct int13_data *int13 = sandev->priv;
 	unsigned int cylinder, head, sector;
 	unsigned long lba;
 	unsigned int count;
-	userptr_t buffer;
+	void *buffer;
 	int rc;
 
 	/* Validate blocksize */
@@ -710,12 +709,12 @@ static int int13_extended_rw ( struct san_device *sandev,
 			       int ( * sandev_rw ) ( struct san_device *sandev,
 						     uint64_t lba,
 						     unsigned int count,
-						     userptr_t buffer ) ) {
+						     void *buffer ) ) {
 	struct int13_disk_address addr;
 	uint8_t bufsize;
 	uint64_t lba;
 	unsigned long count;
-	userptr_t buffer;
+	void *buffer;
 	int rc;
 
 	/* Extended reads are not allowed on floppy drives.
@@ -1455,8 +1454,8 @@ static int int13_load_eltorito ( unsigned int drive, struct segoff *address ) {
 		       "catalog (status %04x)\n", drive, status );
 		return -EIO;
 	}
-	copy_from_user ( &catalog, phys_to_virt ( eltorito_cmd.buffer ), 0,
-			 sizeof ( catalog ) );
+	memcpy ( &catalog, phys_to_virt ( eltorito_cmd.buffer ),
+		 sizeof ( catalog ) );
 
 	/* Sanity checks */
 	if ( catalog.valid.platform_id != ELTORITO_PLATFORM_X86 ) {
diff --git a/src/core/blockdev.c b/src/core/blockdev.c
index c219d9673..3513caafa 100644
--- a/src/core/blockdev.c
+++ b/src/core/blockdev.c
@@ -45,8 +45,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * @ret rc		Return status code
  */
 int block_read ( struct interface *control, struct interface *data,
-		 uint64_t lba, unsigned int count,
-		 userptr_t buffer, size_t len ) {
+		 uint64_t lba, unsigned int count, void *buffer,
+		 size_t len ) {
 	struct interface *dest;
 	block_read_TYPE ( void * ) *op =
 		intf_get_dest_op ( control, block_read, &dest );
@@ -76,8 +76,8 @@ int block_read ( struct interface *control, struct interface *data,
  * @ret rc		Return status code
  */
 int block_write ( struct interface *control, struct interface *data,
-		  uint64_t lba, unsigned int count,
-		  userptr_t buffer, size_t len ) {
+		  uint64_t lba, unsigned int count, void *buffer,
+		  size_t len ) {
 	struct interface *dest;
 	block_write_TYPE ( void * ) *op =
 		intf_get_dest_op ( control, block_write, &dest );
diff --git a/src/core/blocktrans.c b/src/core/blocktrans.c
index f3be2ba2b..ba70462f2 100644
--- a/src/core/blocktrans.c
+++ b/src/core/blocktrans.c
@@ -81,7 +81,7 @@ static void blktrans_xferbuf_write ( struct xfer_buffer *xferbuf, size_t offset,
 	if ( blktrans->buffer ) {
 
 		/* Write data to buffer */
-		copy_to_user ( blktrans->buffer, offset, data, len );
+		memcpy ( ( blktrans->buffer + offset ), data, len );
 
 	} else {
 
@@ -107,7 +107,7 @@ static void blktrans_xferbuf_read ( struct xfer_buffer *xferbuf, size_t offset,
 	if ( blktrans->buffer ) {
 
 		/* Read data from buffer */
-		copy_from_user ( data, blktrans->buffer, offset, len );
+		memcpy ( data, ( blktrans->buffer + offset ), len );
 
 	} else {
 
@@ -216,11 +216,11 @@ static struct interface_descriptor blktrans_xfer_desc =
  * Insert block device translator
  *
  * @v block		Block device interface
- * @v buffer		Data buffer (or UNULL)
+ * @v buffer		Data buffer (or NULL)
  * @v size		Length of data buffer, or block size
  * @ret rc		Return status code
  */
-int block_translate ( struct interface *block, userptr_t buffer, size_t size ) {
+int block_translate ( struct interface *block, void *buffer, size_t size ) {
 	struct block_translator *blktrans;
 	int rc;
 
diff --git a/src/core/dummy_sanboot.c b/src/core/dummy_sanboot.c
index e22998da5..5ca120aac 100644
--- a/src/core/dummy_sanboot.c
+++ b/src/core/dummy_sanboot.c
@@ -29,6 +29,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
+#include <string.h>
 #include <errno.h>
 #include <ipxe/sanboot.h>
 
diff --git a/src/core/sanboot.c b/src/core/sanboot.c
index 4facf86b8..bdac813ff 100644
--- a/src/core/sanboot.c
+++ b/src/core/sanboot.c
@@ -424,10 +424,10 @@ int sandev_reopen ( struct san_device *sandev ) {
 struct san_command_rw_params {
 	/** SAN device read/write operation */
 	int ( * block_rw ) ( struct interface *control, struct interface *data,
-			     uint64_t lba, unsigned int count,
-			     userptr_t buffer, size_t len );
+			     uint64_t lba, unsigned int count, void *buffer,
+			     size_t len );
 	/** Data buffer */
-	userptr_t buffer;
+	void *buffer;
 	/** Starting LBA */
 	uint64_t lba;
 	/** Block count */
@@ -594,11 +594,11 @@ int sandev_reset ( struct san_device *sandev ) {
  * @ret rc		Return status code
  */
 static int sandev_rw ( struct san_device *sandev, uint64_t lba,
-		       unsigned int count, userptr_t buffer,
+		       unsigned int count, void *buffer,
 		       int ( * block_rw ) ( struct interface *control,
 					    struct interface *data,
 					    uint64_t lba, unsigned int count,
-					    userptr_t buffer, size_t len ) ) {
+					    void *buffer, size_t len ) ) {
 	union san_command_params params;
 	unsigned int remaining;
 	size_t frag_len;
@@ -643,11 +643,12 @@ static int sandev_rw ( struct san_device *sandev, uint64_t lba,
  * @ret rc		Return status code
  */
 int sandev_read ( struct san_device *sandev, uint64_t lba,
-		  unsigned int count, userptr_t buffer ) {
+		  unsigned int count, void *buffer ) {
 	int rc;
 
 	/* Read from device */
-	if ( ( rc = sandev_rw ( sandev, lba, count, buffer, block_read ) ) != 0 )
+	if ( ( rc = sandev_rw ( sandev, lba, count, buffer,
+				block_read ) ) != 0 )
 		return rc;
 
 	return 0;
@@ -663,11 +664,12 @@ int sandev_read ( struct san_device *sandev, uint64_t lba,
  * @ret rc		Return status code
  */
 int sandev_write ( struct san_device *sandev, uint64_t lba,
-		   unsigned int count, userptr_t buffer ) {
+		   unsigned int count, void *buffer ) {
 	int rc;
 
 	/* Write to device */
-	if ( ( rc = sandev_rw ( sandev, lba, count, buffer, block_write ) ) != 0 )
+	if ( ( rc = sandev_rw ( sandev, lba, count, buffer,
+				block_write ) ) != 0 )
 		return rc;
 
 	/* Quiesce system.  This is a heuristic designed to ensure
@@ -799,8 +801,7 @@ static int sandev_parse_iso9660 ( struct san_device *sandev ) {
 	}
 
 	/* Read primary volume descriptor */
-	if ( ( rc = sandev_read ( sandev, lba, count,
-				  virt_to_user ( scratch ) ) ) != 0 ) {
+	if ( ( rc = sandev_read ( sandev, lba, count, scratch ) ) != 0 ) {
 		DBGC ( sandev->drive, "SAN %#02x could not read ISO9660 "
 		       "primary volume descriptor: %s\n",
 		       sandev->drive, strerror ( rc ) );
diff --git a/src/drivers/block/ata.c b/src/drivers/block/ata.c
index b1c6855a0..cf98d7c9f 100644
--- a/src/drivers/block/ata.c
+++ b/src/drivers/block/ata.c
@@ -147,8 +147,8 @@ struct ata_command_type {
 	 * @ret data_in		Data-in buffer
 	 * @ret data_in_len	Data-in buffer length
 	 */
-	void ( * data_in ) ( struct ata_command *atacmd, userptr_t buffer,
-			     size_t len, userptr_t *data_in,
+	void ( * data_in ) ( struct ata_command *atacmd, void *buffer,
+			     size_t len, void **data_in,
 			     size_t *data_in_len );
 	/**
 	 * Calculate data-out buffer
@@ -160,8 +160,8 @@ struct ata_command_type {
 	 * @ret data_out	Data-out buffer
 	 * @ret data_out_len	Data-out buffer length
 	 */
-	void ( * data_out ) ( struct ata_command *atacmd, userptr_t buffer,
-			      size_t len, userptr_t *data_out,
+	void ( * data_out ) ( struct ata_command *atacmd, void *buffer,
+			      size_t len, void **data_out,
 			      size_t *data_out_len );
 	/**
 	 * Handle ATA command completion
@@ -285,8 +285,8 @@ static void atacmd_done ( struct ata_command *atacmd, int rc ) {
  * @ret data_len	Data buffer length
  */
 static void atacmd_data_buffer ( struct ata_command *atacmd __unused,
-				 userptr_t buffer, size_t len,
-				 userptr_t *data, size_t *data_len ) {
+				 void *buffer, size_t len,
+				 void **data, size_t *data_len ) {
 	*data = buffer;
 	*data_len = len;
 }
@@ -301,8 +301,8 @@ static void atacmd_data_buffer ( struct ata_command *atacmd __unused,
  * @ret data_len	Data buffer length
  */
 static void atacmd_data_none ( struct ata_command *atacmd __unused,
-			       userptr_t buffer __unused, size_t len __unused,
-			       userptr_t *data __unused,
+			       void *buffer __unused, size_t len __unused,
+			       void **data __unused,
 			       size_t *data_len __unused ) {
 	/* Nothing to do */
 }
@@ -317,9 +317,9 @@ static void atacmd_data_none ( struct ata_command *atacmd __unused,
  * @ret data_len	Data buffer length
  */
 static void atacmd_data_priv ( struct ata_command *atacmd,
-			       userptr_t buffer __unused, size_t len __unused,
-			       userptr_t *data, size_t *data_len ) {
-	*data = virt_to_user ( atacmd_priv ( atacmd ) );
+			       void *buffer __unused, size_t len __unused,
+			       void **data, size_t *data_len ) {
+	*data = atacmd_priv ( atacmd );
 	*data_len = atacmd->type->priv_len;
 }
 
@@ -455,7 +455,7 @@ static int atadev_command ( struct ata_device *atadev,
 			    struct interface *block,
 			    struct ata_command_type *type,
 			    uint64_t lba, unsigned int count,
-			    userptr_t buffer, size_t len ) {
+			    void *buffer, size_t len ) {
 	struct ata_command *atacmd;
 	struct ata_cmd command;
 	int tag;
@@ -543,7 +543,7 @@ static int atadev_command ( struct ata_device *atadev,
 static int atadev_read ( struct ata_device *atadev,
 			 struct interface *block,
 			 uint64_t lba, unsigned int count,
-			 userptr_t buffer, size_t len ) {
+			 void *buffer, size_t len ) {
 	return atadev_command ( atadev, block, &atacmd_read,
 				lba, count, buffer, len );
 }
@@ -562,7 +562,7 @@ static int atadev_read ( struct ata_device *atadev,
 static int atadev_write ( struct ata_device *atadev,
 			  struct interface *block,
 			  uint64_t lba, unsigned int count,
-			  userptr_t buffer, size_t len ) {
+			  void *buffer, size_t len ) {
 	return atadev_command ( atadev, block, &atacmd_write,
 				lba, count, buffer, len );
 }
@@ -581,7 +581,7 @@ static int atadev_read_capacity ( struct ata_device *atadev,
 	assert ( atacmd_identify.priv_len == sizeof ( *identity ) );
 	assert ( atacmd_identify.priv_len == ATA_SECTOR_SIZE );
 	return atadev_command ( atadev, block, &atacmd_identify,
-				0, 1, UNULL, ATA_SECTOR_SIZE );
+				0, 1, NULL, ATA_SECTOR_SIZE );
 }
 
 /**
diff --git a/src/drivers/block/scsi.c b/src/drivers/block/scsi.c
index ff415f5c6..251210d4f 100644
--- a/src/drivers/block/scsi.c
+++ b/src/drivers/block/scsi.c
@@ -279,7 +279,7 @@ struct scsi_command {
 	/** Number of blocks */
 	unsigned int count;
 	/** Data buffer */
-	userptr_t buffer;
+	void *buffer;
 	/** Length of data buffer */
 	size_t len;
 	/** Command tag */
@@ -591,12 +591,12 @@ static void scsicmd_read_capacity_cmd ( struct scsi_command *scsicmd,
 		readcap16->service_action =
 			SCSI_SERVICE_ACTION_READ_CAPACITY_16;
 		readcap16->len = cpu_to_be32 ( sizeof ( *capacity16 ) );
-		command->data_in = virt_to_user ( capacity16 );
+		command->data_in = capacity16;
 		command->data_in_len = sizeof ( *capacity16 );
 	} else {
 		/* Use READ CAPACITY (10) */
 		readcap10->opcode = SCSI_OPCODE_READ_CAPACITY_10;
-		command->data_in = virt_to_user ( capacity10 );
+		command->data_in = capacity10;
 		command->data_in_len = sizeof ( *capacity10 );
 	}
 }
@@ -721,7 +721,7 @@ static int scsidev_command ( struct scsi_device *scsidev,
 			     struct interface *block,
 			     struct scsi_command_type *type,
 			     uint64_t lba, unsigned int count,
-			     userptr_t buffer, size_t len ) {
+			     void *buffer, size_t len ) {
 	struct scsi_command *scsicmd;
 	int rc;
 
@@ -773,7 +773,7 @@ static int scsidev_command ( struct scsi_device *scsidev,
 static int scsidev_read ( struct scsi_device *scsidev,
 			  struct interface *block,
 			  uint64_t lba, unsigned int count,
-			  userptr_t buffer, size_t len ) {
+			  void *buffer, size_t len ) {
 	return scsidev_command ( scsidev, block, &scsicmd_read,
 				 lba, count, buffer, len );
 }
@@ -792,7 +792,7 @@ static int scsidev_read ( struct scsi_device *scsidev,
 static int scsidev_write ( struct scsi_device *scsidev,
 			   struct interface *block,
 			   uint64_t lba, unsigned int count,
-			   userptr_t buffer, size_t len ) {
+			   void *buffer, size_t len ) {
 	return scsidev_command ( scsidev, block, &scsicmd_write,
 				 lba, count, buffer, len );
 }
@@ -807,7 +807,7 @@ static int scsidev_write ( struct scsi_device *scsidev,
 static int scsidev_read_capacity ( struct scsi_device *scsidev,
 				   struct interface *block ) {
 	return scsidev_command ( scsidev, block, &scsicmd_read_capacity,
-				 0, 0, UNULL, 0 );
+				 0, 0, NULL, 0 );
 }
 
 /**
@@ -820,7 +820,7 @@ static int scsidev_read_capacity ( struct scsi_device *scsidev,
 static int scsidev_test_unit_ready ( struct scsi_device *scsidev,
 				     struct interface *block ) {
 	return scsidev_command ( scsidev, block, &scsicmd_test_unit_ready,
-				 0, 0, UNULL, 0 );
+				 0, 0, NULL, 0 );
 }
 
 /**
diff --git a/src/drivers/usb/usbblk.c b/src/drivers/usb/usbblk.c
index 5a086d3f8..39adc012f 100644
--- a/src/drivers/usb/usbblk.c
+++ b/src/drivers/usb/usbblk.c
@@ -205,7 +205,7 @@ static int usbblk_out_data ( struct usbblk_device *usbblk ) {
 
 	/* Calculate length */
 	assert ( cmd->tag );
-	assert ( cmd->scsi.data_out != UNULL );
+	assert ( cmd->scsi.data_out != NULL );
 	assert ( cmd->offset < cmd->scsi.data_out_len );
 	len = ( cmd->scsi.data_out_len - cmd->offset );
 	if ( len > USBBLK_MAX_LEN )
@@ -220,8 +220,8 @@ static int usbblk_out_data ( struct usbblk_device *usbblk ) {
 	}
 
 	/* Populate I/O buffer */
-	copy_from_user ( iob_put ( iobuf, len ), cmd->scsi.data_out,
-			 cmd->offset, len );
+	memcpy ( iob_put ( iobuf, len ),
+		 ( cmd->scsi.data_out + cmd->offset ), len );
 
 	/* Send data */
 	if ( ( rc = usb_stream ( &usbblk->out, iobuf, 0 ) ) != 0 ) {
@@ -332,12 +332,12 @@ static int usbblk_in_data ( struct usbblk_device *usbblk, const void *data,
 
 	/* Sanity checks */
 	assert ( cmd->tag );
-	assert ( cmd->scsi.data_in != UNULL );
+	assert ( cmd->scsi.data_in != NULL );
 	assert ( cmd->offset <= cmd->scsi.data_in_len );
 	assert ( len <= ( cmd->scsi.data_in_len - cmd->offset ) );
 
 	/* Store data */
-	copy_to_user ( cmd->scsi.data_in, cmd->offset, data, len );
+	memcpy ( ( cmd->scsi.data_in + cmd->offset ), data, len );
 	cmd->offset += len;
 
 	return 0;
diff --git a/src/include/ipxe/ata.h b/src/include/ipxe/ata.h
index a10cfafcc..cd78cd795 100644
--- a/src/include/ipxe/ata.h
+++ b/src/include/ipxe/ata.h
@@ -2,7 +2,6 @@
 #define _IPXE_ATA_H
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/interface.h>
 
 /** @file
@@ -173,7 +172,7 @@ struct ata_cmd {
 	 * If non-NULL, this buffer must be ata_command::cb::count
 	 * sectors in size.
 	 */
-	userptr_t data_out;
+	void *data_out;
 	/** Data-out buffer length
 	 *
 	 * Must be zero if @c data_out is NULL
@@ -184,7 +183,7 @@ struct ata_cmd {
 	 * If non-NULL, this buffer must be ata_command::cb::count
 	 * sectors in size.
 	 */
-	userptr_t data_in;
+	void *data_in;
 	/** Data-in buffer length
 	 *
 	 * Must be zero if @c data_in is NULL
diff --git a/src/include/ipxe/blockdev.h b/src/include/ipxe/blockdev.h
index 418c43004..ef6fc8d5a 100644
--- a/src/include/ipxe/blockdev.h
+++ b/src/include/ipxe/blockdev.h
@@ -11,7 +11,6 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/interface.h>
 
 /** Block device capacity */
@@ -25,20 +24,20 @@ struct block_device_capacity {
 };
 
 extern int block_read ( struct interface *control, struct interface *data,
-			uint64_t lba, unsigned int count,
-			userptr_t buffer, size_t len );
+			uint64_t lba, unsigned int count, void *buffer,
+			size_t len );
 #define block_read_TYPE( object_type )					\
 	typeof ( int ( object_type, struct interface *data,		\
 		       uint64_t lba, unsigned int count,		\
-		       userptr_t buffer, size_t len ) )
+		       void *buffer, size_t len ) )
 
 extern int block_write ( struct interface *control, struct interface *data,
-			 uint64_t lba, unsigned int count,
-			 userptr_t buffer, size_t len );
+			 uint64_t lba, unsigned int count, void *buffer,
+			 size_t len );
 #define block_write_TYPE( object_type )					\
 	typeof ( int ( object_type, struct interface *data,		\
 		       uint64_t lba, unsigned int count,		\
-		       userptr_t buffer, size_t len ) )
+		       void *buffer, size_t len ) )
 
 extern int block_read_capacity ( struct interface *control,
 				 struct interface *data );
diff --git a/src/include/ipxe/blocktrans.h b/src/include/ipxe/blocktrans.h
index fee71b96c..1167a256e 100644
--- a/src/include/ipxe/blocktrans.h
+++ b/src/include/ipxe/blocktrans.h
@@ -13,7 +13,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/refcnt.h>
 #include <ipxe/interface.h>
 #include <ipxe/xferbuf.h>
-#include <ipxe/uaccess.h>
 
 /** A block device translator */
 struct block_translator {
@@ -27,12 +26,12 @@ struct block_translator {
 	/** Data transfer buffer */
 	struct xfer_buffer xferbuf;
 	/** Data buffer */
-	userptr_t buffer;
+	void *buffer;
 	/** Block size */
 	size_t blksize;
 };
 
-extern int block_translate ( struct interface *block,
-			     userptr_t buffer, size_t size );
+extern int block_translate ( struct interface *block, void *buffer,
+			     size_t size );
 
 #endif /* _IPXE_BLOCKTRANS_H */
diff --git a/src/include/ipxe/sanboot.h b/src/include/ipxe/sanboot.h
index e44367cdb..9d5fceee0 100644
--- a/src/include/ipxe/sanboot.h
+++ b/src/include/ipxe/sanboot.h
@@ -261,9 +261,9 @@ extern struct san_device * sandev_next ( unsigned int drive );
 extern int sandev_reopen ( struct san_device *sandev );
 extern int sandev_reset ( struct san_device *sandev );
 extern int sandev_read ( struct san_device *sandev, uint64_t lba,
-			 unsigned int count, userptr_t buffer );
+			 unsigned int count, void *buffer );
 extern int sandev_write ( struct san_device *sandev, uint64_t lba,
-			  unsigned int count, userptr_t buffer );
+			  unsigned int count, void *buffer );
 extern struct san_device * alloc_sandev ( struct uri **uris, unsigned int count,
 					  size_t priv_size );
 extern int register_sandev ( struct san_device *sandev, unsigned int drive,
diff --git a/src/include/ipxe/scsi.h b/src/include/ipxe/scsi.h
index 28b55b2d5..9bb38a059 100644
--- a/src/include/ipxe/scsi.h
+++ b/src/include/ipxe/scsi.h
@@ -2,7 +2,6 @@
 #define _IPXE_SCSI_H
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/interface.h>
 
 /** @file
@@ -252,14 +251,14 @@ struct scsi_cmd {
 	/** CDB for this command */
 	union scsi_cdb cdb;
 	/** Data-out buffer (may be NULL) */
-	userptr_t data_out;
+	void *data_out;
 	/** Data-out buffer length
 	 *
 	 * Must be zero if @c data_out is NULL
 	 */
 	size_t data_out_len;
 	/** Data-in buffer (may be NULL) */
-	userptr_t data_in;
+	void *data_in;
 	/** Data-in buffer length
 	 *
 	 * Must be zero if @c data_in is NULL
diff --git a/src/interface/efi/efi_block.c b/src/interface/efi/efi_block.c
index 94e2aae06..aa5ec4e0f 100644
--- a/src/interface/efi/efi_block.c
+++ b/src/interface/efi/efi_block.c
@@ -95,8 +95,9 @@ struct efi_block_data {
 static int efi_block_rw ( struct san_device *sandev, uint64_t lba,
 			  void *data, size_t len,
 			  int ( * sandev_rw ) ( struct san_device *sandev,
-						uint64_t lba, unsigned int count,
-						userptr_t buffer ) ) {
+						uint64_t lba,
+						unsigned int count,
+						void *buffer ) ) {
 	struct efi_block_data *block = sandev->priv;
 	unsigned int count;
 	int rc;
diff --git a/src/net/aoe.c b/src/net/aoe.c
index dba4f51b5..b484bdd33 100644
--- a/src/net/aoe.c
+++ b/src/net/aoe.c
@@ -33,7 +33,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/list.h>
 #include <ipxe/if_ether.h>
 #include <ipxe/iobuf.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/features.h>
 #include <ipxe/interface.h>
@@ -391,8 +390,7 @@ static void aoecmd_ata_cmd ( struct aoe_command *aoecmd,
 	if ( ! command->cb.lba48 )
 		aoeata->lba.bytes[3] |=
 			( command->cb.device & ATA_DEV_MASK );
-	copy_from_user ( aoeata->data, command->data_out, 0,
-			 command->data_out_len );
+	memcpy ( aoeata->data, command->data_out, command->data_out_len );
 
 	DBGC2 ( aoedev, "AoE %s/%08x ATA cmd %02x:%02x:%02x:%02x:%08llx",
 		aoedev_name ( aoedev ), aoecmd->tag, aoeata->aflags,
@@ -452,8 +450,7 @@ static int aoecmd_ata_rsp ( struct aoe_command *aoecmd, const void *data,
 	}
 
 	/* Copy out data payload */
-	copy_to_user ( command->data_in, 0, aoeata->data,
-		       command->data_in_len );
+	memcpy ( command->data_in, aoeata->data, command->data_in_len );
 
 	return 0;
 }
diff --git a/src/net/fcp.c b/src/net/fcp.c
index f78f7bd9b..9701b5d54 100644
--- a/src/net/fcp.c
+++ b/src/net/fcp.c
@@ -413,7 +413,7 @@ static int fcpcmd_recv_rddata ( struct fcp_command *fcpcmd,
 		fcpdev, fcpcmd->xchg_id, offset, ( offset + len ) );
 
 	/* Copy to user buffer */
-	copy_to_user ( command->data_in, offset, iobuf->data, len );
+	memcpy ( ( command->data_in + offset ), iobuf->data, len );
 	fcpcmd->offset += len;
 	assert ( fcpcmd->offset <= command->data_in_len );
 
@@ -464,8 +464,8 @@ static int fcpcmd_send_wrdata ( struct fcp_command *fcpcmd ) {
 	}
 
 	/* Construct data IU frame */
-	copy_from_user ( iob_put ( iobuf, len ), command->data_out,
-			 fcpcmd->offset, len );
+	memcpy ( iob_put ( iobuf, len ),
+		 ( command->data_out + fcpcmd->offset ), len );
 	memset ( &meta, 0, sizeof ( meta ) );
 	meta.flags = ( XFER_FL_RESPONSE | XFER_FL_ABS_OFFSET );
 	meta.offset = fcpcmd->offset;
diff --git a/src/net/tcp/httpblock.c b/src/net/tcp/httpblock.c
index 1abd6b34d..156f11e47 100644
--- a/src/net/tcp/httpblock.c
+++ b/src/net/tcp/httpblock.c
@@ -31,7 +31,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/blocktrans.h>
 #include <ipxe/blockdev.h>
 #include <ipxe/acpi.h>
@@ -52,7 +51,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * @ret rc		Return status code
  */
 int http_block_read ( struct http_transaction *http, struct interface *data,
-		      uint64_t lba, unsigned int count, userptr_t buffer,
+		      uint64_t lba, unsigned int count, void *buffer,
 		      size_t len ) {
 	struct http_request_range range;
 	int rc;
@@ -101,7 +100,7 @@ int http_block_read_capacity ( struct http_transaction *http,
 		goto err_open;
 
 	/* Insert block device translator */
-	if ( ( rc = block_translate ( data, UNULL, HTTP_BLKSIZE ) ) != 0 ) {
+	if ( ( rc = block_translate ( data, NULL, HTTP_BLKSIZE ) ) != 0 ) {
 		DBGC ( http, "HTTP %p could not insert block translator: %s\n",
 		       http, strerror ( rc ) );
 		goto err_translate;
diff --git a/src/net/tcp/httpcore.c b/src/net/tcp/httpcore.c
index 7052bbbad..57c31ac26 100644
--- a/src/net/tcp/httpcore.c
+++ b/src/net/tcp/httpcore.c
@@ -503,7 +503,7 @@ http_content_buffer ( struct http_transaction *http ) {
 __weak int http_block_read ( struct http_transaction *http __unused,
 			     struct interface *data __unused,
 			     uint64_t lba __unused, unsigned int count __unused,
-			     userptr_t buffer __unused, size_t len __unused ) {
+			     void *buffer __unused, size_t len __unused ) {
 
 	return -ENOTSUP;
 }
diff --git a/src/net/tcp/iscsi.c b/src/net/tcp/iscsi.c
index dd20849ce..b7b33a51a 100644
--- a/src/net/tcp/iscsi.c
+++ b/src/net/tcp/iscsi.c
@@ -39,7 +39,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/open.h>
 #include <ipxe/scsi.h>
 #include <ipxe/process.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/tcpip.h>
 #include <ipxe/settings.h>
 #include <ipxe/features.h>
@@ -478,7 +477,7 @@ static int iscsi_rx_data_in ( struct iscsi_session *iscsi,
 	assert ( iscsi->command != NULL );
 	assert ( iscsi->command->data_in );
 	assert ( ( offset + len ) <= iscsi->command->data_in_len );
-	copy_to_user ( iscsi->command->data_in, offset, data, len );
+	memcpy ( ( iscsi->command->data_in + offset ), data, len );
 
 	/* Wait for whole SCSI response to arrive */
 	if ( remaining )
@@ -598,8 +597,8 @@ static int iscsi_tx_data_out ( struct iscsi_session *iscsi ) {
 	if ( ! iobuf )
 		return -ENOMEM;
 	
-	copy_from_user ( iob_put ( iobuf, len ),
-			 iscsi->command->data_out, offset, len );
+	memcpy ( iob_put ( iobuf, len ),
+		 ( iscsi->command->data_out + offset ), len );
 	memset ( iob_put ( iobuf, pad_len ), 0, pad_len );
 
 	return xfer_deliver_iob ( &iscsi->socket, iobuf );
-- 
cgit v1.2.3-55-g7522


From aa3cc56ab20763eb1d8e04085ee6013636760606 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 25 Apr 2025 10:52:26 +0100
Subject: [fbcon] Remove userptr_t from framebuffer console drivers

Simplify the framebuffer console drivers by assuming that the raw
framebuffer, character cell array, background picture, and glyph data
are all directly accessible via pointer dereferences.

In particular, this avoids the need to copy each glyph during drawing:
the VESA framebuffer driver can simply return a pointer to the glyph
data stored in the video ROM.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/interface/pcbios/vesafb.c |  37 ++++-----
 src/core/fbcon.c                       | 137 +++++++++++++++------------------
 src/include/ipxe/fbcon.h               |  13 ++--
 src/include/ipxe/pixbuf.h              |  19 ++++-
 src/interface/efi/efi_fbcon.c          |  22 +++---
 5 files changed, 112 insertions(+), 116 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/interface/pcbios/vesafb.c b/src/arch/x86/interface/pcbios/vesafb.c
index cfa935126..961160ff8 100644
--- a/src/arch/x86/interface/pcbios/vesafb.c
+++ b/src/arch/x86/interface/pcbios/vesafb.c
@@ -103,7 +103,7 @@ struct vesafb {
 	/** Font definition */
 	struct fbcon_font font;
 	/** Character glyphs */
-	struct segoff glyphs;
+	const uint8_t *glyphs;
 	/** Saved VGA mode */
 	uint8_t saved_mode;
 };
@@ -140,11 +140,10 @@ static int vesafb_rc ( unsigned int status ) {
  * Get character glyph
  *
  * @v character		Unicode character
- * @v glyph		Character glyph to fill in
+ * @ret glyph		Character glyph
  */
-static void vesafb_glyph ( unsigned int character, uint8_t *glyph ) {
+static const uint8_t * vesafb_glyph ( unsigned int character ) {
 	unsigned int index;
-	size_t offset;
 
 	/* Identify glyph */
 	if ( character < VESAFB_ASCII ) {
@@ -155,10 +154,8 @@ static void vesafb_glyph ( unsigned int character, uint8_t *glyph ) {
 		index = VESAFB_UNKNOWN;
 	}
 
-	/* Copy glyph from BIOS font table */
-	offset = ( index * VESAFB_CHAR_HEIGHT );
-	copy_from_real ( glyph, vesafb.glyphs.segment,
-			 ( vesafb.glyphs.offset + offset ), VESAFB_CHAR_HEIGHT);
+	/* Return glyph in BIOS font table */
+	return &vesafb.glyphs[ index * VESAFB_CHAR_HEIGHT ];
 }
 
 /**
@@ -166,6 +163,7 @@ static void vesafb_glyph ( unsigned int character, uint8_t *glyph ) {
  *
  */
 static void vesafb_font ( void ) {
+	struct segoff glyphs;
 
 	/* Get font information
 	 *
@@ -186,12 +184,13 @@ static void vesafb_font ( void ) {
 					   "movw %%es, %%cx\n\t"
 					   "movw %%bp, %%dx\n\t"
 					   "popw %%bp\n\t" /* gcc bug */ )
-			       : "=c" ( vesafb.glyphs.segment ),
-				 "=d" ( vesafb.glyphs.offset )
+			       : "=c" ( glyphs.segment ),
+				 "=d" ( glyphs.offset )
 			       : "a" ( VBE_GET_FONT ),
 				 "b" ( VESAFB_FONT ) );
 	DBGC ( &vbe_buf, "VESAFB has font %04x at %04x:%04x\n",
-	       VESAFB_FONT, vesafb.glyphs.segment, vesafb.glyphs.offset );
+	       VESAFB_FONT, glyphs.segment, glyphs.offset );
+	vesafb.glyphs = real_to_virt ( glyphs.segment, glyphs.offset );
 	vesafb.font.height = VESAFB_CHAR_HEIGHT;
 	vesafb.font.glyph = vesafb_glyph;
 }
@@ -206,8 +205,8 @@ static void vesafb_font ( void ) {
  */
 static int vesafb_mode_list ( uint16_t **mode_numbers ) {
 	struct vbe_controller_info *controller = &vbe_buf.controller;
-	userptr_t video_mode_ptr;
-	uint16_t mode_number;
+	const uint16_t *video_mode_ptr;
+	const uint16_t *mode_number;
 	uint16_t status;
 	size_t len;
 	int rc;
@@ -245,18 +244,16 @@ static int vesafb_mode_list ( uint16_t **mode_numbers ) {
 	/* Calculate length of mode list */
 	video_mode_ptr = real_to_virt ( controller->video_mode_ptr.segment,
 					controller->video_mode_ptr.offset );
-	len = 0;
-	do {
-		copy_from_user ( &mode_number, video_mode_ptr, len,
-				 sizeof ( mode_number ) );
-		len += sizeof ( mode_number );
-	} while ( mode_number != VBE_MODE_END );
+	mode_number = video_mode_ptr;
+	while ( *(mode_number++) != VBE_MODE_END ) {}
+	len = ( ( ( const void * ) mode_number ) -
+		( ( const void * ) video_mode_ptr ) );
 
 	/* Allocate and fill mode list */
 	*mode_numbers = malloc ( len );
 	if ( ! *mode_numbers )
 		return -ENOMEM;
-	copy_from_user ( *mode_numbers, video_mode_ptr, 0, len );
+	memcpy ( *mode_numbers, video_mode_ptr, len );
 
 	return 0;
 }
diff --git a/src/core/fbcon.c b/src/core/fbcon.c
index 6d08ac419..f2b2ea566 100644
--- a/src/core/fbcon.c
+++ b/src/core/fbcon.c
@@ -102,6 +102,23 @@ static void fbcon_set_default_background ( struct fbcon *fbcon ) {
 	fbcon->background = FBCON_TRANSPARENT;
 }
 
+/**
+ * Get character cell
+ *
+ * @v fbcon		Frame buffer console
+ * @v xpos		X position
+ * @v ypos		Y position
+ * @ret cell		Text cell
+ */
+static inline struct fbcon_text_cell * fbcon_cell ( struct fbcon *fbcon,
+						    unsigned int xpos,
+						    unsigned int ypos ) {
+	unsigned int index;
+
+	index = ( ( ypos * fbcon->character.width ) + xpos );
+	return &fbcon->text.cells[index];
+}
+
 /**
  * Clear rows of characters
  *
@@ -109,43 +126,21 @@ static void fbcon_set_default_background ( struct fbcon *fbcon ) {
  * @v ypos		Starting Y position
  */
 static void fbcon_clear ( struct fbcon *fbcon, unsigned int ypos ) {
-	struct fbcon_text_cell cell = {
-		.foreground = fbcon->foreground,
-		.background = fbcon->background,
-		.character = ' ',
-	};
-	size_t offset;
+	struct fbcon_text_cell *cell;
 	unsigned int xpos;
 
 	/* Clear stored character array */
+	cell = fbcon_cell ( fbcon, 0, ypos );
 	for ( ; ypos < fbcon->character.height ; ypos++ ) {
-		offset = ( ypos * fbcon->character.width * sizeof ( cell ) );
 		for ( xpos = 0 ; xpos < fbcon->character.width ; xpos++ ) {
-			copy_to_user ( fbcon->text.start, offset, &cell,
-				       sizeof ( cell ) );
-			offset += sizeof ( cell );
+			cell->foreground = fbcon->foreground;
+			cell->background = fbcon->background;
+			cell->character = ' ';
+			cell++;
 		}
 	}
 }
 
-/**
- * Store character at specified position
- *
- * @v fbcon		Frame buffer console
- * @v cell		Text cell
- * @v xpos		X position
- * @v ypos		Y position
- */
-static void fbcon_store ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
-			  unsigned int xpos, unsigned int ypos ) {
-	size_t offset;
-
-	/* Store cell */
-	offset = ( ( ( ypos * fbcon->character.width ) + xpos ) *
-		   sizeof ( *cell ) );
-	copy_to_user ( fbcon->text.start, offset, cell, sizeof ( *cell ) );
-}
-
 /**
  * Draw character at specified position
  *
@@ -156,7 +151,7 @@ static void fbcon_store ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
  */
 static void fbcon_draw ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
 			 unsigned int xpos, unsigned int ypos ) {
-	uint8_t glyph[fbcon->font->height];
+	const uint8_t *glyph;
 	size_t offset;
 	size_t pixel_len;
 	size_t skip_len;
@@ -164,10 +159,10 @@ static void fbcon_draw ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
 	unsigned int column;
 	uint8_t bitmask;
 	int transparent;
-	void *src;
+	const void *src;
 
 	/* Get font character */
-	fbcon->font->glyph ( cell->character, glyph );
+	glyph = fbcon->font->glyph ( cell->character );
 
 	/* Calculate pixel geometry */
 	offset = ( fbcon->indent +
@@ -204,7 +199,7 @@ static void fbcon_draw ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
 			} else {
 				continue;
 			}
-			copy_to_user ( fbcon->start, offset, src, pixel_len );
+			memcpy ( ( fbcon->start + offset ), src, pixel_len );
 		}
 
 		/* Move to next row */
@@ -218,18 +213,16 @@ static void fbcon_draw ( struct fbcon *fbcon, struct fbcon_text_cell *cell,
  * @v fbcon		Frame buffer console
  */
 static void fbcon_redraw ( struct fbcon *fbcon ) {
-	struct fbcon_text_cell cell;
-	size_t offset = 0;
+	struct fbcon_text_cell *cell;
 	unsigned int xpos;
 	unsigned int ypos;
 
 	/* Redraw characters */
+	cell = fbcon_cell ( fbcon, 0, 0 );
 	for ( ypos = 0 ; ypos < fbcon->character.height ; ypos++ ) {
 		for ( xpos = 0 ; xpos < fbcon->character.width ; xpos++ ) {
-			copy_from_user ( &cell, fbcon->text.start, offset,
-					 sizeof ( cell ) );
-			fbcon_draw ( fbcon, &cell, xpos, ypos );
-			offset += sizeof ( cell );
+			fbcon_draw ( fbcon, cell, xpos, ypos );
+			cell++;
 		}
 	}
 }
@@ -246,8 +239,8 @@ static void fbcon_scroll ( struct fbcon *fbcon ) {
 	assert ( fbcon->ypos == fbcon->character.height );
 
 	/* Scroll up character array */
-	row_len = ( fbcon->character.width * sizeof ( struct fbcon_text_cell ));
-	memmove ( fbcon->text.start, ( fbcon->text.start + row_len ),
+	row_len = ( fbcon->character.width * sizeof ( fbcon->text.cells[0] ) );
+	memmove ( fbcon_cell ( fbcon, 0, 0 ), fbcon_cell ( fbcon, 0, 1 ),
 		  ( row_len * ( fbcon->character.height - 1 ) ) );
 	fbcon_clear ( fbcon, ( fbcon->character.height - 1 ) );
 
@@ -265,18 +258,19 @@ static void fbcon_scroll ( struct fbcon *fbcon ) {
  * @v show_cursor	Show cursor
  */
 static void fbcon_draw_cursor ( struct fbcon *fbcon, int show_cursor ) {
-	struct fbcon_text_cell cell;
-	size_t offset;
+	struct fbcon_text_cell *cell;
+	struct fbcon_text_cell cursor;
 
-	offset = ( ( ( fbcon->ypos * fbcon->character.width ) + fbcon->xpos ) *
-		   sizeof ( cell ) );
-	copy_from_user ( &cell, fbcon->text.start, offset, sizeof ( cell ) );
+	cell = fbcon_cell ( fbcon, fbcon->xpos, fbcon->ypos );
 	if ( show_cursor ) {
-		cell.background = fbcon->foreground;
-		cell.foreground = ( ( fbcon->background == FBCON_TRANSPARENT ) ?
-				    0 : fbcon->background );
+		cursor.background = fbcon->foreground;
+		cursor.foreground =
+			( ( fbcon->background == FBCON_TRANSPARENT ) ?
+			  0 : fbcon->background );
+		cursor.character = cell->character;
+		cell = &cursor;
 	}
-	fbcon_draw ( fbcon, &cell, fbcon->xpos, fbcon->ypos );
+	fbcon_draw ( fbcon, cell, fbcon->xpos, fbcon->ypos );
 }
 
 /**
@@ -439,7 +433,7 @@ static struct ansiesc_handler fbcon_ansiesc_handlers[] = {
  * @v character		Character
  */
 void fbcon_putchar ( struct fbcon *fbcon, int character ) {
-	struct fbcon_text_cell cell;
+	struct fbcon_text_cell *cell;
 
 	/* Intercept ANSI escape sequences */
 	character = ansiesc_process ( &fbcon->ctx, character );
@@ -473,11 +467,11 @@ void fbcon_putchar ( struct fbcon *fbcon, int character ) {
 		break;
 	default:
 		/* Print character at current cursor position */
-		cell.foreground = ( fbcon->foreground | fbcon->bold );
-		cell.background = fbcon->background;
-		cell.character = character;
-		fbcon_store ( fbcon, &cell, fbcon->xpos, fbcon->ypos );
-		fbcon_draw ( fbcon, &cell, fbcon->xpos, fbcon->ypos );
+		cell = fbcon_cell ( fbcon, fbcon->xpos, fbcon->ypos );
+		cell->foreground = ( fbcon->foreground | fbcon->bold );
+		cell->background = fbcon->background;
+		cell->character = character;
+		fbcon_draw ( fbcon, cell, fbcon->xpos, fbcon->ypos );
 
 		/* Advance cursor */
 		fbcon->xpos++;
@@ -508,12 +502,9 @@ static int fbcon_picture_init ( struct fbcon *fbcon,
 	struct fbcon_geometry *pixel = fbcon->pixel;
 	struct fbcon_picture *picture = &fbcon->picture;
 	size_t len;
-	size_t pixbuf_stride;
 	size_t indent;
-	size_t pixbuf_indent;
 	size_t offset;
-	size_t pixbuf_offset;
-	uint32_t rgb;
+	const uint32_t *rgb;
 	uint32_t raw;
 	unsigned int x;
 	unsigned int y;
@@ -534,13 +525,10 @@ static int fbcon_picture_init ( struct fbcon *fbcon,
 	}
 
 	/* Centre picture on console */
-	pixbuf_stride = ( pixbuf->width * sizeof ( rgb ) );
 	xgap = ( ( ( int ) ( pixel->width - pixbuf->width ) ) / 2 );
 	ygap = ( ( ( int ) ( pixel->height - pixbuf->height ) ) / 2 );
 	indent = ( ( ( ( ygap >= 0 ) ? ygap : 0 ) * pixel->stride ) +
 		   ( ( ( xgap >= 0 ) ? xgap : 0 ) * pixel->len ) );
-	pixbuf_indent =	( ( ( ( ygap < 0 ) ? -ygap : 0 ) * pixbuf_stride ) +
-			  ( ( ( xgap < 0 ) ? -xgap : 0 ) * sizeof ( rgb ) ) );
 	width = pixbuf->width;
 	if ( width > pixel->width )
 		width = pixel->width;
@@ -555,15 +543,14 @@ static int fbcon_picture_init ( struct fbcon *fbcon,
 	memset ( picture->start, 0, len );
 	for ( y = 0 ; y < height ; y++ ) {
 		offset = ( indent + ( y * pixel->stride ) );
-		pixbuf_offset = ( pixbuf_indent + ( y * pixbuf_stride ) );
+		rgb = pixbuf_pixel ( pixbuf, ( ( xgap < 0 ) ? -xgap : 0 ),
+				     ( ( ( ygap < 0 ) ? -ygap : 0 ) + y ) );
 		for ( x = 0 ; x < width ; x++ ) {
-			copy_from_user ( &rgb, pixbuf->data, pixbuf_offset,
-					 sizeof ( rgb ) );
-			raw = fbcon_colour ( fbcon, rgb );
-			copy_to_user ( picture->start, offset, &raw,
-				       pixel->len );
+			raw = fbcon_colour ( fbcon, *rgb );
+			memcpy ( ( picture->start + offset ), &raw,
+				 pixel->len );
 			offset += pixel->len;
-			pixbuf_offset += sizeof ( rgb );
+			rgb++;
 		}
 	}
 
@@ -585,7 +572,7 @@ static int fbcon_picture_init ( struct fbcon *fbcon,
  * @v config		Console configuration
  * @ret rc		Return status code
  */
-int fbcon_init ( struct fbcon *fbcon, userptr_t start,
+int fbcon_init ( struct fbcon *fbcon, void *start,
 		 struct fbcon_geometry *pixel,
 		 struct fbcon_colour_map *map,
 		 struct fbcon_font *font,
@@ -674,10 +661,10 @@ int fbcon_init ( struct fbcon *fbcon, userptr_t start,
 	fbcon_set_default_background ( fbcon );
 
 	/* Allocate and initialise stored character array */
-	fbcon->text.start = umalloc ( fbcon->character.width *
+	fbcon->text.cells = umalloc ( fbcon->character.width *
 				      fbcon->character.height *
-				      sizeof ( struct fbcon_text_cell ) );
-	if ( ! fbcon->text.start ) {
+				      sizeof ( fbcon->text.cells[0] ) );
+	if ( ! fbcon->text.cells ) {
 		rc = -ENOMEM;
 		goto err_text;
 	}
@@ -702,7 +689,7 @@ int fbcon_init ( struct fbcon *fbcon, userptr_t start,
 
 	ufree ( fbcon->picture.start );
  err_picture:
-	ufree ( fbcon->text.start );
+	ufree ( fbcon->text.cells );
  err_text:
  err_margin:
 	return rc;
@@ -715,6 +702,6 @@ int fbcon_init ( struct fbcon *fbcon, userptr_t start,
  */
 void fbcon_fini ( struct fbcon *fbcon ) {
 
-	ufree ( fbcon->text.start );
+	ufree ( fbcon->text.cells );
 	ufree ( fbcon->picture.start );
 }
diff --git a/src/include/ipxe/fbcon.h b/src/include/ipxe/fbcon.h
index a4c7a9ab3..5233b4d0e 100644
--- a/src/include/ipxe/fbcon.h
+++ b/src/include/ipxe/fbcon.h
@@ -12,7 +12,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <ipxe/ansiesc.h>
 #include <ipxe/utf8.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/console.h>
 
 /** Character width, in pixels */
@@ -38,9 +37,9 @@ struct fbcon_font {
 	 * Get character glyph
 	 *
 	 * @v character		Unicode character
-	 * @v glyph		Character glyph to fill in
+	 * @ret glyph		Character glyph
 	 */
-	void ( * glyph ) ( unsigned int character, uint8_t *glyph );
+	const uint8_t * ( * glyph ) ( unsigned int character );
 };
 
 /** A frame buffer geometry
@@ -100,19 +99,19 @@ struct fbcon_text_cell {
 /** A frame buffer text array */
 struct fbcon_text {
 	/** Stored text cells */
-	userptr_t start;
+	struct fbcon_text_cell *cells;
 };
 
 /** A frame buffer background picture */
 struct fbcon_picture {
 	/** Start address */
-	userptr_t start;
+	void *start;
 };
 
 /** A frame buffer console */
 struct fbcon {
 	/** Start address */
-	userptr_t start;
+	void *start;
 	/** Length of one complete displayed screen */
 	size_t len;
 	/** Pixel geometry */
@@ -149,7 +148,7 @@ struct fbcon {
 	int show_cursor;
 };
 
-extern int fbcon_init ( struct fbcon *fbcon, userptr_t start,
+extern int fbcon_init ( struct fbcon *fbcon, void *start,
 			struct fbcon_geometry *pixel,
 			struct fbcon_colour_map *map,
 			struct fbcon_font *font,
diff --git a/src/include/ipxe/pixbuf.h b/src/include/ipxe/pixbuf.h
index 615744812..6c70c1c05 100644
--- a/src/include/ipxe/pixbuf.h
+++ b/src/include/ipxe/pixbuf.h
@@ -11,7 +11,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stddef.h>
 #include <ipxe/refcnt.h>
-#include <ipxe/uaccess.h>
 
 /** A pixel buffer */
 struct pixel_buffer {
@@ -22,7 +21,7 @@ struct pixel_buffer {
 	/** Height */
 	unsigned int height;
 	/** 32-bit (8:8:8:8) xRGB pixel data, in host-endian order */
-	userptr_t data;
+	uint32_t *data;
 	/** Total length */
 	size_t len;
 };
@@ -49,6 +48,22 @@ pixbuf_put ( struct pixel_buffer *pixbuf ) {
 	ref_put ( &pixbuf->refcnt );
 }
 
+/**
+ * Get pixel
+ *
+ * @v pixbuf		Pixel buffer
+ * @v x			X position
+ * @v y			Y position
+ * @ret pixel		Pixel
+ */
+static inline __attribute__ (( always_inline )) uint32_t *
+pixbuf_pixel ( struct pixel_buffer *pixbuf, unsigned int x, unsigned int y ) {
+	unsigned int index;
+
+	index = ( ( y * pixbuf->width ) + x );
+	return &pixbuf->data[index];
+}
+
 extern struct pixel_buffer * alloc_pixbuf ( unsigned int width,
 					    unsigned int height );
 
diff --git a/src/interface/efi/efi_fbcon.c b/src/interface/efi/efi_fbcon.c
index 09cfde4c2..9c5d7063d 100644
--- a/src/interface/efi/efi_fbcon.c
+++ b/src/interface/efi/efi_fbcon.c
@@ -42,6 +42,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/ansicol.h>
 #include <ipxe/fbcon.h>
 #include <ipxe/console.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/rotate.h>
 #include <config/console.h>
@@ -91,7 +92,7 @@ struct efifb {
 	/** Font definition */
 	struct fbcon_font font;
 	/** Character glyph cache */
-	userptr_t glyphs;
+	uint8_t *glyphs;
 	/** Dynamic characters in cache */
 	unsigned int dynamic[EFIFB_DYNAMIC];
 	/** Next dynamic character cache entry to evict */
@@ -117,14 +118,14 @@ static int efifb_draw ( unsigned int character, unsigned int index,
 	unsigned int height;
 	unsigned int x;
 	unsigned int y;
+	uint8_t *glyph;
 	uint8_t bitmask;
-	size_t offset;
 	EFI_STATUS efirc;
 	int rc;
 
 	/* Clear existing glyph */
-	offset = ( index * efifb.font.height );
-	memset ( ( efifb.glyphs + offset ), 0, efifb.font.height );
+	glyph = &efifb.glyphs[ index * efifb.font.height ];
+	memset ( glyph, 0, efifb.font.height );
 
 	/* Get glyph */
 	blt = NULL;
@@ -157,8 +158,7 @@ static int efifb_draw ( unsigned int character, unsigned int index,
 			pixel++;
 		}
 		bitmask ^= toggle;
-		copy_to_user ( efifb.glyphs, offset++, &bitmask,
-			       sizeof ( bitmask ) );
+		*(glyph++) = bitmask;
 	}
 
 	/* Free glyph */
@@ -223,11 +223,10 @@ static unsigned int efifb_dynamic ( unsigned int character ) {
  * Get character glyph
  *
  * @v character		Unicode character
- * @v glyph		Character glyph to fill in
+ * @ret glyph		Character glyph to fill in
  */
-static void efifb_glyph ( unsigned int character, uint8_t *glyph ) {
+static const uint8_t * efifb_glyph ( unsigned int character ) {
 	unsigned int index;
-	size_t offset;
 
 	/* Identify glyph */
 	if ( character < EFIFB_ASCII ) {
@@ -241,9 +240,8 @@ static void efifb_glyph ( unsigned int character, uint8_t *glyph ) {
 		index = efifb_dynamic ( character );
 	}
 
-	/* Copy cached glyph */
-	offset = ( index * efifb.font.height );
-	copy_from_user ( glyph, efifb.glyphs, offset, efifb.font.height );
+	/* Return cached glyph */
+	return &efifb.glyphs[ index * efifb.font.height ];
 }
 
 /**
-- 
cgit v1.2.3-55-g7522


From 76a17b0986250117e15c2c64cccd0694acf8142b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 25 Apr 2025 13:24:21 +0100
Subject: [fbcon] Avoid redrawing unchanged characters when scrolling

Scrolling currently involves redrawing every character cell, which can
be frustratingly slow on large framebuffer consoles.  Accelerate this
operation by skipping the redraw for any unchanged character cells.

In the common case that large areas of the screen contain whitespace,
this optimises away the vast majority of the redrawing operations.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fbcon.c | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fbcon.c b/src/core/fbcon.c
index f2b2ea566..43f73fbac 100644
--- a/src/core/fbcon.c
+++ b/src/core/fbcon.c
@@ -233,22 +233,46 @@ static void fbcon_redraw ( struct fbcon *fbcon ) {
  * @v fbcon		Frame buffer console
  */
 static void fbcon_scroll ( struct fbcon *fbcon ) {
-	size_t row_len;
+	const struct fbcon_text_cell *old;
+	struct fbcon_text_cell *new;
+	unsigned int xpos;
+	unsigned int ypos;
+	unsigned int character;
+	uint32_t foreground;
+	uint32_t background;
 
 	/* Sanity check */
 	assert ( fbcon->ypos == fbcon->character.height );
 
 	/* Scroll up character array */
-	row_len = ( fbcon->character.width * sizeof ( fbcon->text.cells[0] ) );
-	memmove ( fbcon_cell ( fbcon, 0, 0 ), fbcon_cell ( fbcon, 0, 1 ),
-		  ( row_len * ( fbcon->character.height - 1 ) ) );
-	fbcon_clear ( fbcon, ( fbcon->character.height - 1 ) );
+	new = fbcon_cell ( fbcon, 0, 0 );
+	old = fbcon_cell ( fbcon, 0, 1 );
+	for ( ypos = 0 ; ypos < ( fbcon->character.height - 1 ) ; ypos++ ) {
+		for ( xpos = 0 ; xpos < fbcon->character.width ; xpos++ ) {
+			/* Redraw character (if changed) */
+			character = old->character;
+			foreground = old->foreground;
+			background = old->background;
+			if ( ( new->character != character ) ||
+			     ( new->foreground != foreground ) ||
+			     ( new->background != background ) ) {
+				new->character = character;
+				new->foreground = foreground;
+				new->background = background;
+				fbcon_draw ( fbcon, new, xpos, ypos );
+			}
+			new++;
+			old++;
+		}
+	}
+
+	/* Clear bottom row */
+	fbcon_clear ( fbcon, ypos );
+	for ( xpos = 0 ; xpos < fbcon->character.width ; xpos++ )
+		fbcon_draw ( fbcon, new++, xpos, ypos );
 
 	/* Update cursor position */
 	fbcon->ypos--;
-
-	/* Redraw all characters */
-	fbcon_redraw ( fbcon );
 }
 
 /**
-- 
cgit v1.2.3-55-g7522


From 4c8bf666f4afb578645269a5a81431d784fad771 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 25 Apr 2025 17:21:52 +0100
Subject: [pnm] Remove userptr_t from PNM image parsing

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/pixbuf.c         |  3 ++-
 src/image/pnm.c           | 55 +++++++++++++++++++++--------------------------
 src/include/ipxe/pixbuf.h |  2 ++
 src/include/ipxe/pnm.h    |  1 -
 4 files changed, 29 insertions(+), 32 deletions(-)

(limited to 'src/core')

diff --git a/src/core/pixbuf.c b/src/core/pixbuf.c
index 641a0fb53..d0b80b2a9 100644
--- a/src/core/pixbuf.c
+++ b/src/core/pixbuf.c
@@ -65,7 +65,8 @@ struct pixel_buffer * alloc_pixbuf ( unsigned int width, unsigned int height ) {
 	ref_init ( &pixbuf->refcnt, free_pixbuf );
 	pixbuf->width = width;
 	pixbuf->height = height;
-	pixbuf->len = ( width * height * sizeof ( uint32_t ) );
+	pixbuf->pixels = ( width * height );
+	pixbuf->len = ( pixbuf->pixels * sizeof ( uint32_t ) );
 
 	/* Check for multiplication overflow */
 	if ( ( width != 0 ) &&
diff --git a/src/image/pnm.c b/src/image/pnm.c
index f24b28841..4b5020b64 100644
--- a/src/image/pnm.c
+++ b/src/image/pnm.c
@@ -46,21 +46,21 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 static int pnm_ascii ( struct image *image, struct pnm_context *pnm ) {
 	char buf[ pnm->ascii_len + 1 /* NUL */ ];
 	char *endp;
+	char ch;
 	size_t len;
 	int value;
 	int in_comment = 0;
 
 	/* Skip any leading whitespace and comments */
 	for ( ; pnm->offset < image->len ; pnm->offset++ ) {
-		copy_from_user ( &buf[0], image->data, pnm->offset,
-				 sizeof ( buf[0] ) );
+		ch = *( ( ( const uint8_t * ) image->data ) + pnm->offset );
 		if ( in_comment ) {
-			if ( buf[0] == '\n' )
+			if ( ch == '\n' )
 				in_comment = 0;
 		} else {
-			if ( buf[0] == '#' ) {
+			if ( ch == '#' ) {
 				in_comment = 1;
-			} else if ( ! isspace ( buf[0] ) ) {
+			} else if ( ! isspace ( ch ) ) {
 				break;
 			}
 		}
@@ -76,7 +76,7 @@ static int pnm_ascii ( struct image *image, struct pnm_context *pnm ) {
 	/* Copy ASCII value to buffer and ensure string is NUL-terminated */
 	if ( len > ( sizeof ( buf ) - 1 /* NUL */ ) )
 		len = ( sizeof ( buf ) - 1 /* NUL */ );
-	copy_from_user ( buf, image->data, pnm->offset, len );
+	memcpy ( buf, ( image->data + pnm->offset ), len );
 	buf[len] = '\0';
 
 	/* Parse value and update offset */
@@ -104,7 +104,7 @@ static int pnm_ascii ( struct image *image, struct pnm_context *pnm ) {
  * @ret value		Value, or negative error
  */
 static int pnm_binary ( struct image *image, struct pnm_context *pnm ) {
-	uint8_t value;
+	const uint8_t *value;
 
 	/* Sanity check */
 	if ( pnm->offset == image->len ) {
@@ -114,10 +114,8 @@ static int pnm_binary ( struct image *image, struct pnm_context *pnm ) {
 	}
 
 	/* Extract value */
-	copy_from_user ( &value, image->data, pnm->offset, sizeof ( value ) );
-	pnm->offset++;
-
-	return value;
+	value = ( image->data + pnm->offset++ );
+	return *value;
 }
 
 /**
@@ -189,15 +187,15 @@ static uint32_t pnm_pixmap ( uint32_t composite, unsigned int index __unused ) {
 static int pnm_data ( struct image *image, struct pnm_context *pnm,
 		      struct pixel_buffer *pixbuf ) {
 	struct pnm_type *type = pnm->type;
-	size_t offset = 0;
+	unsigned int pixels = pixbuf->pixels;
+	unsigned int index = 0;
 	unsigned int xpos = 0;
 	int scalar;
 	uint32_t composite;
-	uint32_t rgb;
 	unsigned int i;
 
 	/* Fill pixel buffer */
-	while ( offset < pixbuf->len ) {
+	while ( index < pixels ) {
 
 		/* Extract a scaled composite scalar value from the file */
 		composite = 0;
@@ -213,15 +211,12 @@ static int pnm_data ( struct image *image, struct pnm_context *pnm,
 
 		/* Extract 24-bit RGB values from composite value */
 		for ( i = 0 ; i < type->packing ; i++ ) {
-			if ( offset >= pixbuf->len ) {
+			if ( index >= pixels ) {
 				DBGC ( image, "PNM %s has too many pixels\n",
 				       image->name );
 				return -EINVAL;
 			}
-			rgb = type->rgb ( composite, i );
-			copy_to_user ( pixbuf->data, offset, &rgb,
-				       sizeof ( rgb ) );
-			offset += sizeof ( rgb );
+			pixbuf->data[index++] = type->rgb ( composite, i );
 			if ( ++xpos == pixbuf->width ) {
 				xpos = 0;
 				break;
@@ -287,19 +282,19 @@ static struct pnm_type pnm_types[] = {
  * @ret type		PNM image type, or NULL if not found
  */
 static struct pnm_type * pnm_type ( struct image *image ) {
-	struct pnm_signature signature;
+	const struct pnm_signature *signature;
 	struct pnm_type *type;
 	unsigned int i;
 
 	/* Extract signature */
-	assert ( image->len >= sizeof ( signature ) );
-	copy_from_user ( &signature, image->data, 0, sizeof ( signature ) );
+	assert ( image->len >= sizeof ( *signature ) );
+	signature = image->data;
 
 	/* Check for supported types */
 	for ( i = 0 ; i < ( sizeof ( pnm_types ) /
 			    sizeof ( pnm_types[0] ) ) ; i++ ) {
 		type = &pnm_types[i];
-		if ( type->type == signature.type )
+		if ( type->type == signature->type )
 			return type;
 	}
 	return NULL;
@@ -390,23 +385,23 @@ static int pnm_pixbuf ( struct image *image, struct pixel_buffer **pixbuf ) {
  * @ret rc		Return status code
  */
 static int pnm_probe ( struct image *image ) {
-	struct pnm_signature signature;
+	const struct pnm_signature *signature;
 
 	/* Sanity check */
-	if ( image->len < sizeof ( signature ) ) {
+	if ( image->len < sizeof ( *signature ) ) {
 		DBGC ( image, "PNM %s is too short\n", image->name );
 		return -ENOEXEC;
 	}
 
 	/* Check signature */
-	copy_from_user ( &signature, image->data, 0, sizeof ( signature ) );
-	if ( ! ( ( signature.magic == PNM_MAGIC ) &&
-		 ( isdigit ( signature.type ) ) &&
-		 ( isspace ( signature.space ) ) ) ) {
+	signature = image->data;
+	if ( ! ( ( signature->magic == PNM_MAGIC ) &&
+		 ( isdigit ( signature->type ) ) &&
+		 ( isspace ( signature->space ) ) ) ) {
 		DBGC ( image, "PNM %s has invalid signature\n", image->name );
 		return -ENOEXEC;
 	}
-	DBGC ( image, "PNM %s is type %c\n", image->name, signature.type );
+	DBGC ( image, "PNM %s is type %c\n", image->name, signature->type );
 
 	return 0;
 }
diff --git a/src/include/ipxe/pixbuf.h b/src/include/ipxe/pixbuf.h
index 6c70c1c05..47ea0065e 100644
--- a/src/include/ipxe/pixbuf.h
+++ b/src/include/ipxe/pixbuf.h
@@ -22,6 +22,8 @@ struct pixel_buffer {
 	unsigned int height;
 	/** 32-bit (8:8:8:8) xRGB pixel data, in host-endian order */
 	uint32_t *data;
+	/** Total number of pixels */
+	unsigned int pixels;
 	/** Total length */
 	size_t len;
 };
diff --git a/src/include/ipxe/pnm.h b/src/include/ipxe/pnm.h
index 860968cbc..43f52cbdd 100644
--- a/src/include/ipxe/pnm.h
+++ b/src/include/ipxe/pnm.h
@@ -10,7 +10,6 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/image.h>
 
 /** PNM signature */
-- 
cgit v1.2.3-55-g7522


From 7eaa2daf6f978c6aa16f66e03aa42dd3b5a190ae Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 28 Apr 2025 13:42:32 +0100
Subject: [reboot] Generalise warm reboot indicator to a flags bitmask

Allow for the possibility of additional reboot types by extending the
reboot() function to use a flags bitmask rather than a single flag.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/interface/sbi/sbi_reboot.c   |  6 ++++--
 src/arch/x86/interface/pcbios/bios_reboot.c | 10 +++++-----
 src/core/null_reboot.c                      |  4 ++--
 src/hci/commands/reboot_cmd.c               |  5 ++++-
 src/include/ipxe/reboot.h                   |  6 ++++--
 src/interface/efi/efi_reboot.c              |  8 +++++---
 6 files changed, 24 insertions(+), 15 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/interface/sbi/sbi_reboot.c b/src/arch/riscv/interface/sbi/sbi_reboot.c
index 64365b0d3..3529c9d38 100644
--- a/src/arch/riscv/interface/sbi/sbi_reboot.c
+++ b/src/arch/riscv/interface/sbi/sbi_reboot.c
@@ -37,13 +37,15 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Reboot system
  *
- * @v warm		Perform a warm reboot
+ * @v flags		Reboot flags
  */
-static void sbi_reboot ( int warm ) {
+static void sbi_reboot ( int flags ) {
 	struct sbi_return ret;
+	int warm;
 	int rc;
 
 	/* Reboot system */
+	warm = ( flags & REBOOT_WARM );
 	ret = sbi_ecall_2 ( SBI_SRST, SBI_SRST_SYSTEM_RESET,
 			    ( warm ? SBI_RESET_WARM : SBI_RESET_COLD ), 0 );
 
diff --git a/src/arch/x86/interface/pcbios/bios_reboot.c b/src/arch/x86/interface/pcbios/bios_reboot.c
index 071173f19..463470245 100644
--- a/src/arch/x86/interface/pcbios/bios_reboot.c
+++ b/src/arch/x86/interface/pcbios/bios_reboot.c
@@ -38,14 +38,14 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Reboot system
  *
- * @v warm		Perform a warm reboot
+ * @v flags		Reboot flags
  */
-static void bios_reboot ( int warm ) {
-	uint16_t flag;
+static void bios_reboot ( int flags ) {
+	uint16_t type;
 
 	/* Configure BIOS for cold/warm reboot */
-	flag = ( warm ? BDA_REBOOT_WARM : 0 );
-	put_real ( flag, BDA_SEG, BDA_REBOOT );
+	type = ( ( flags & REBOOT_WARM ) ? BDA_REBOOT_WARM : 0 );
+	put_real ( type, BDA_SEG, BDA_REBOOT );
 
 	/* Jump to system reset vector */
 	__asm__ __volatile__ ( REAL_CODE ( "ljmp $0xf000, $0xfff0" ) : );
diff --git a/src/core/null_reboot.c b/src/core/null_reboot.c
index 7be5612a3..63b6e127e 100644
--- a/src/core/null_reboot.c
+++ b/src/core/null_reboot.c
@@ -37,9 +37,9 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Reboot system
  *
- * @v warm		Perform a warm reboot
+ * @v flags		Reboot flags
  */
-static void null_reboot ( int warm __unused ) {
+static void null_reboot ( int flags __unused ) {
 
 	printf ( "Cannot reboot; not implemented\n" );
 	while ( 1 ) {}
diff --git a/src/hci/commands/reboot_cmd.c b/src/hci/commands/reboot_cmd.c
index 45d54cc2c..f34468401 100644
--- a/src/hci/commands/reboot_cmd.c
+++ b/src/hci/commands/reboot_cmd.c
@@ -59,6 +59,7 @@ static struct command_descriptor reboot_cmd =
  */
 static int reboot_exec ( int argc, char **argv ) {
 	struct reboot_options opts;
+	int flags = 0;
 	int rc;
 
 	/* Parse options */
@@ -66,7 +67,9 @@ static int reboot_exec ( int argc, char **argv ) {
 		return rc;
 
 	/* Reboot system */
-	reboot ( opts.warm );
+	if ( opts.warm )
+		flags |= REBOOT_WARM;
+	reboot ( flags );
 
 	return 0;
 }
diff --git a/src/include/ipxe/reboot.h b/src/include/ipxe/reboot.h
index 33606d9d5..2d8dadeca 100644
--- a/src/include/ipxe/reboot.h
+++ b/src/include/ipxe/reboot.h
@@ -51,9 +51,11 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Reboot system
  *
- * @v warm		Perform a warm reboot
+ * @v flags		Reboot flags
  */
-void reboot ( int warm );
+void reboot ( int flags );
+
+#define REBOOT_WARM	0x00000001 /**< Perform a warm reboot */
 
 /**
  * Power off system
diff --git a/src/interface/efi/efi_reboot.c b/src/interface/efi/efi_reboot.c
index 35919221e..eb389a4b1 100644
--- a/src/interface/efi/efi_reboot.c
+++ b/src/interface/efi/efi_reboot.c
@@ -37,13 +37,15 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Reboot system
  *
- * @v warm		Perform a warm reboot
+ * @v flags		Reboot flags
  */
-static void efi_reboot ( int warm ) {
+static void efi_reboot ( int flags ) {
 	EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
+	EFI_RESET_TYPE type;
 
 	/* Use runtime services to reset system */
-	rs->ResetSystem ( ( warm ? EfiResetWarm : EfiResetCold ), 0, 0, NULL );
+	type = ( ( flags & REBOOT_WARM ) ? EfiResetWarm : EfiResetCold );
+	rs->ResetSystem ( type, 0, 0, NULL );
 }
 
 /**
-- 
cgit v1.2.3-55-g7522


From 837b77293beafa15f8a125a484a0d17453b021f8 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 29 Apr 2025 09:16:41 +0100
Subject: [xferbuf] Simplify and generalise data transfer buffers

Since all data transfer buffer contents are now accessible via direct
pointer dereferences, remove the unnecessary abstractions for read and
write operations and create two new data transfer buffer types: a
fixed-size buffer, and a void buffer that records its size but can
never receive non-zero lengths of data.  These replace the custom data
buffer types currently implemented for EFI PXE TFTP downloads and for
block device translations.

A new operation xferbuf_detach() is required to take ownership of the
data accumulated in the data transfer buffer, since we no longer rely
on the existence of an independently owned external data pointer for
data transfer buffers allocated via umalloc().

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/blocktrans.c         |  90 +-----------------------------
 src/core/downloader.c         |  16 ++++--
 src/core/xferbuf.c            | 124 ++++++++++++++++++++++--------------------
 src/include/ipxe/blocktrans.h |   2 -
 src/include/ipxe/xferbuf.h    |  67 +++++++++++++----------
 src/interface/efi/efi_pxe.c   |  47 +---------------
 src/net/peermux.c             |   7 +--
 7 files changed, 119 insertions(+), 234 deletions(-)

(limited to 'src/core')

diff --git a/src/core/blocktrans.c b/src/core/blocktrans.c
index ba70462f2..362721747 100644
--- a/src/core/blocktrans.c
+++ b/src/core/blocktrans.c
@@ -38,91 +38,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/blockdev.h>
 #include <ipxe/blocktrans.h>
 
-/**
- * Reallocate block device translator data buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v len		New length (or zero to free buffer)
- * @ret rc		Return status code
- */
-static int blktrans_xferbuf_realloc ( struct xfer_buffer *xferbuf,
-				      size_t len ) {
-	struct block_translator *blktrans =
-		container_of ( xferbuf, struct block_translator, xferbuf );
-
-	/* Record length, if applicable */
-	if ( blktrans->buffer ) {
-
-		/* We have a (non-reallocatable) data buffer */
-		return -ENOTSUP;
-
-	} else {
-
-		/* Record length (for block device capacity) */
-		xferbuf->len = len;
-		return 0;
-	}
-}
-
-/**
- * Write data to block device translator data buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to copy
- * @v len		Length of data
- */
-static void blktrans_xferbuf_write ( struct xfer_buffer *xferbuf, size_t offset,
-				     const void *data, size_t len ) {
-	struct block_translator *blktrans =
-		container_of ( xferbuf, struct block_translator, xferbuf );
-
-	/* Write data to buffer, if applicable */
-	if ( blktrans->buffer ) {
-
-		/* Write data to buffer */
-		memcpy ( ( blktrans->buffer + offset ), data, len );
-
-	} else {
-
-		/* Sanity check */
-		assert ( len == 0 );
-	}
-}
-
-/**
- * Read data from block device translator data buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to read
- * @v len		Length of data
- */
-static void blktrans_xferbuf_read ( struct xfer_buffer *xferbuf, size_t offset,
-				    void *data, size_t len ) {
-	struct block_translator *blktrans =
-		container_of ( xferbuf, struct block_translator, xferbuf );
-
-	/* Read data from buffer, if applicable */
-	if ( blktrans->buffer ) {
-
-		/* Read data from buffer */
-		memcpy ( data, ( blktrans->buffer + offset ), len );
-
-	} else {
-
-		/* Sanity check */
-		assert ( len == 0 );
-	}
-}
-
-/** Block device translator data transfer buffer operations */
-static struct xfer_buffer_operations blktrans_xferbuf_operations = {
-	.realloc = blktrans_xferbuf_realloc,
-	.write = blktrans_xferbuf_write,
-	.read = blktrans_xferbuf_read,
-};
-
 /**
  * Close block device translator
  *
@@ -233,11 +148,10 @@ int block_translate ( struct interface *block, void *buffer, size_t size ) {
 	ref_init ( &blktrans->refcnt, NULL );
 	intf_init ( &blktrans->block, &blktrans_block_desc, &blktrans->refcnt );
 	intf_init ( &blktrans->xfer, &blktrans_xfer_desc, &blktrans->refcnt );
-	blktrans->xferbuf.op = &blktrans_xferbuf_operations;
-	blktrans->buffer = buffer;
 	if ( buffer ) {
-		blktrans->xferbuf.len = size;
+		xferbuf_fixed_init ( &blktrans->xferbuf, buffer, size );
 	} else {
+		xferbuf_void_init ( &blktrans->xferbuf );
 		blktrans->blksize = size;
 	}
 
diff --git a/src/core/downloader.c b/src/core/downloader.c
index 33737bfac..449761836 100644
--- a/src/core/downloader.c
+++ b/src/core/downloader.c
@@ -67,6 +67,7 @@ static void downloader_free ( struct refcnt *refcnt ) {
 	struct downloader *downloader =
 		container_of ( refcnt, struct downloader, refcnt );
 
+	xferbuf_free ( &downloader->buffer );
 	image_put ( downloader->image );
 	free ( downloader );
 }
@@ -78,18 +79,21 @@ static void downloader_free ( struct refcnt *refcnt ) {
  * @v rc		Reason for termination
  */
 static void downloader_finished ( struct downloader *downloader, int rc ) {
+	struct xfer_buffer *buffer = &downloader->buffer;
+	struct image *image = downloader->image;
 
 	/* Log download status */
 	if ( rc == 0 ) {
-		syslog ( LOG_NOTICE, "Downloaded \"%s\"\n",
-			 downloader->image->name );
+		syslog ( LOG_NOTICE, "Downloaded \"%s\"\n", image->name );
 	} else {
 		syslog ( LOG_ERR, "Download of \"%s\" failed: %s\n",
-			 downloader->image->name, strerror ( rc ) );
+			 image->name, strerror ( rc ) );
 	}
 
-	/* Update image length */
-	downloader->image->len = downloader->buffer.len;
+	/* Transfer ownership from data transfer buffer to image */
+	image->data = buffer->data;
+	image->len = buffer->len;
+	xferbuf_detach ( buffer );
 
 	/* Shut down interfaces */
 	intf_shutdown ( &downloader->xfer, rc );
@@ -269,7 +273,7 @@ int create_downloader ( struct interface *job, struct image *image ) {
 	intf_init ( &downloader->xfer, &downloader_xfer_desc,
 		    &downloader->refcnt );
 	downloader->image = image_get ( image );
-	xferbuf_umalloc_init ( &downloader->buffer, &image->data );
+	xferbuf_umalloc_init ( &downloader->buffer );
 
 	/* Instantiate child objects and attach to our interfaces */
 	if ( ( rc = xfer_open_uri ( &downloader->xfer, image->uri ) ) != 0 )
diff --git a/src/core/xferbuf.c b/src/core/xferbuf.c
index 1c08f8bc3..d93526577 100644
--- a/src/core/xferbuf.c
+++ b/src/core/xferbuf.c
@@ -50,6 +50,21 @@ static struct profiler xferbuf_write_profiler __profiler =
 static struct profiler xferbuf_read_profiler __profiler =
 	{ .name = "xferbuf.read" };
 
+/**
+ * Detach data from data transfer buffer
+ *
+ * @v xferbuf		Data transfer buffer
+ *
+ * The caller assumes responsibility for eventually freeing the data
+ * previously owned by the data transfer buffer.
+ */
+void xferbuf_detach ( struct xfer_buffer *xferbuf ) {
+
+	xferbuf->data = NULL;
+	xferbuf->len = 0;
+	xferbuf->pos = 0;
+}
+
 /**
  * Free data transfer buffer
  *
@@ -58,8 +73,7 @@ static struct profiler xferbuf_read_profiler __profiler =
 void xferbuf_free ( struct xfer_buffer *xferbuf ) {
 
 	xferbuf->op->realloc ( xferbuf, 0 );
-	xferbuf->len = 0;
-	xferbuf->pos = 0;
+	xferbuf_detach ( xferbuf );
 }
 
 /**
@@ -109,9 +123,13 @@ int xferbuf_write ( struct xfer_buffer *xferbuf, size_t offset,
 	if ( ( rc = xferbuf_ensure_size ( xferbuf, max_len ) ) != 0 )
 		return rc;
 
+	/* Check that buffer is non-void */
+	if ( len && ( ! xferbuf->data ) )
+		return -ENOTTY;
+
 	/* Copy data to buffer */
 	profile_start ( &xferbuf_write_profiler );
-	xferbuf->op->write ( xferbuf, offset, data, len );
+	memcpy ( ( xferbuf->data + offset ), data, len );
 	profile_stop ( &xferbuf_write_profiler );
 
 	return 0;
@@ -133,9 +151,13 @@ int xferbuf_read ( struct xfer_buffer *xferbuf, size_t offset,
 	     ( len > ( xferbuf->len - offset ) ) )
 		return -ENOENT;
 
+	/* Check that buffer is non-void */
+	if ( len && ( ! xferbuf->data ) )
+		return -ENOTTY;
+
 	/* Copy data from buffer */
 	profile_start ( &xferbuf_read_profiler );
-	xferbuf->op->read ( xferbuf, offset, data, len );
+	memcpy ( data, ( xferbuf->data + offset ), len );
 	profile_stop ( &xferbuf_read_profiler );
 
 	return 0;
@@ -178,7 +200,7 @@ int xferbuf_deliver ( struct xfer_buffer *xferbuf, struct io_buffer *iobuf,
 }
 
 /**
- * Reallocate malloc()-based data buffer
+ * Reallocate malloc()-based data transfer buffer
  *
  * @v xferbuf		Data transfer buffer
  * @v len		New length (or zero to free buffer)
@@ -194,94 +216,76 @@ static int xferbuf_malloc_realloc ( struct xfer_buffer *xferbuf, size_t len ) {
 	return 0;
 }
 
-/**
- * Write data to malloc()-based data buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to copy
- * @v len		Length of data
- */
-static void xferbuf_malloc_write ( struct xfer_buffer *xferbuf, size_t offset,
-				   const void *data, size_t len ) {
-
-	memcpy ( ( xferbuf->data + offset ), data, len );
-}
-
-/**
- * Read data from malloc()-based data buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to read
- * @v len		Length of data
- */
-static void xferbuf_malloc_read ( struct xfer_buffer *xferbuf, size_t offset,
-				  void *data, size_t len ) {
-
-	memcpy ( data, ( xferbuf->data + offset ), len );
-}
-
 /** malloc()-based data buffer operations */
 struct xfer_buffer_operations xferbuf_malloc_operations = {
 	.realloc = xferbuf_malloc_realloc,
-	.write = xferbuf_malloc_write,
-	.read = xferbuf_malloc_read,
 };
 
 /**
- * Reallocate umalloc()-based data buffer
+ * Reallocate umalloc()-based data transfer buffer
  *
  * @v xferbuf		Data transfer buffer
  * @v len		New length (or zero to free buffer)
  * @ret rc		Return status code
  */
 static int xferbuf_umalloc_realloc ( struct xfer_buffer *xferbuf, size_t len ) {
-	void **udata = xferbuf->data;
 	void *new_udata;
 
-	new_udata = urealloc ( *udata, len );
+	new_udata = urealloc ( xferbuf->data, len );
 	if ( ! new_udata )
 		return -ENOSPC;
-	*udata = new_udata;
+	xferbuf->data = new_udata;
 	return 0;
 }
 
+/** umalloc()-based data buffer operations */
+struct xfer_buffer_operations xferbuf_umalloc_operations = {
+	.realloc = xferbuf_umalloc_realloc,
+};
+
 /**
- * Write data to umalloc()-based data buffer
+ * Reallocate fixed-size data transfer buffer
  *
  * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to copy
- * @v len		Length of data
+ * @v len		New length (or zero to free buffer)
+ * @ret rc		Return status code
  */
-static void xferbuf_umalloc_write ( struct xfer_buffer *xferbuf, size_t offset,
-				    const void *data, size_t len ) {
-	void **udata = xferbuf->data;
+static int xferbuf_fixed_realloc ( struct xfer_buffer *xferbuf, size_t len ) {
+
+	/* Refuse to allocate extra space */
+	if ( len > xferbuf->len ) {
+		/* Note that EFI relies upon this error mapping to
+		 * EFI_BUFFER_TOO_SMALL.
+		 */
+		return -ERANGE;
+	}
 
-	memcpy ( ( *udata + offset ), data, len );
+	return 0;
 }
 
+/** Fixed-size data buffer operations */
+struct xfer_buffer_operations xferbuf_fixed_operations = {
+	.realloc = xferbuf_fixed_realloc,
+};
+
 /**
- * Read data from umalloc()-based data buffer
+ * Reallocate void data transfer buffer
  *
  * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to read
- * @v len		Length of data
+ * @v len		New length (or zero to free buffer)
+ * @ret rc		Return status code
  */
-static void xferbuf_umalloc_read ( struct xfer_buffer *xferbuf, size_t offset,
-				   void *data, size_t len ) {
-	void **udata = xferbuf->data;
+static int xferbuf_void_realloc ( struct xfer_buffer *xferbuf,
+				  size_t len __unused ) {
 
-	memcpy ( data, ( *udata + offset ), len );
+	/* Succeed without ever allocating data */
+	assert ( xferbuf->data == NULL );
+	return 0;
 }
 
-/** umalloc()-based data buffer operations */
-struct xfer_buffer_operations xferbuf_umalloc_operations = {
-	.realloc = xferbuf_umalloc_realloc,
-	.write = xferbuf_umalloc_write,
-	.read = xferbuf_umalloc_read,
+/** Void data buffer operations */
+struct xfer_buffer_operations xferbuf_void_operations = {
+	.realloc = xferbuf_void_realloc,
 };
 
 /**
diff --git a/src/include/ipxe/blocktrans.h b/src/include/ipxe/blocktrans.h
index 1167a256e..1eb388854 100644
--- a/src/include/ipxe/blocktrans.h
+++ b/src/include/ipxe/blocktrans.h
@@ -25,8 +25,6 @@ struct block_translator {
 
 	/** Data transfer buffer */
 	struct xfer_buffer xferbuf;
-	/** Data buffer */
-	void *buffer;
 	/** Block size */
 	size_t blksize;
 };
diff --git a/src/include/ipxe/xferbuf.h b/src/include/ipxe/xferbuf.h
index 04635999d..04fcf2286 100644
--- a/src/include/ipxe/xferbuf.h
+++ b/src/include/ipxe/xferbuf.h
@@ -35,41 +35,19 @@ struct xfer_buffer_operations {
 	 * @ret rc		Return status code
 	 */
 	int ( * realloc ) ( struct xfer_buffer *xferbuf, size_t len );
-	/** Write data to buffer
-	 *
-	 * @v xferbuf		Data transfer buffer
-	 * @v offset		Starting offset
-	 * @v data		Data to write
-	 * @v len		Length of data
-	 *
-	 * This call is simply a wrapper for the appropriate
-	 * memcpy()-like operation: the caller is responsible for
-	 * ensuring that the write does not exceed the buffer length.
-	 */
-	void ( * write ) ( struct xfer_buffer *xferbuf, size_t offset,
-			   const void *data, size_t len );
-	/** Read data from buffer
-	 *
-	 * @v xferbuf		Data transfer buffer
-	 * @v offset		Starting offset
-	 * @v data		Data to read
-	 * @v len		Length of data
-	 *
-	 * This call is simply a wrapper for the appropriate
-	 * memcpy()-like operation: the caller is responsible for
-	 * ensuring that the read does not exceed the buffer length.
-	 */
-	void ( * read ) ( struct xfer_buffer *xferbuf, size_t offset,
-			  void *data, size_t len );
 };
 
 extern struct xfer_buffer_operations xferbuf_malloc_operations;
 extern struct xfer_buffer_operations xferbuf_umalloc_operations;
+extern struct xfer_buffer_operations xferbuf_fixed_operations;
+extern struct xfer_buffer_operations xferbuf_void_operations;
 
 /**
  * Initialise malloc()-based data transfer buffer
  *
  * @v xferbuf		Data transfer buffer
+ *
+ * Data will be automatically allocated using malloc().
  */
 static inline __attribute__ (( always_inline )) void
 xferbuf_malloc_init ( struct xfer_buffer *xferbuf ) {
@@ -80,14 +58,45 @@ xferbuf_malloc_init ( struct xfer_buffer *xferbuf ) {
  * Initialise umalloc()-based data transfer buffer
  *
  * @v xferbuf		Data transfer buffer
- * @v data		User pointer
+ *
+ * Data will be automatically allocated using umalloc() (and may
+ * therefore alter the system memory map).
  */
 static inline __attribute__ (( always_inline )) void
-xferbuf_umalloc_init ( struct xfer_buffer *xferbuf, void **data ) {
-	xferbuf->data = data;
+xferbuf_umalloc_init ( struct xfer_buffer *xferbuf ) {
 	xferbuf->op = &xferbuf_umalloc_operations;
 }
 
+/**
+ * Initialise fixed-size data transfer buffer
+ *
+ * @v xferbuf		Data transfer buffer
+ * @v data		Data buffer
+ * @v len		Length of data buffer
+ *
+ * Data will be never be automatically allocated.
+ */
+static inline __attribute__ (( always_inline )) void
+xferbuf_fixed_init ( struct xfer_buffer *xferbuf, void *data, size_t len ) {
+	xferbuf->data = data;
+	xferbuf->len = len;
+	xferbuf->op = &xferbuf_fixed_operations;
+}
+
+/**
+ * Initialise void data transfer buffer
+ *
+ * @v xferbuf		Data transfer buffer
+ *
+ * No data will be allocated, but the length will be recorded.  This
+ * can be used to capture xfer_seek() results.
+ */
+static inline __attribute__ (( always_inline )) void
+xferbuf_void_init ( struct xfer_buffer *xferbuf ) {
+	xferbuf->op = &xferbuf_void_operations;
+}
+
+extern void xferbuf_detach ( struct xfer_buffer *xferbuf );
 extern void xferbuf_free ( struct xfer_buffer *xferbuf );
 extern int xferbuf_write ( struct xfer_buffer *xferbuf, size_t offset,
 			   const void *data, size_t len );
diff --git a/src/interface/efi/efi_pxe.c b/src/interface/efi/efi_pxe.c
index 732ccdcdf..4ba057019 100644
--- a/src/interface/efi/efi_pxe.c
+++ b/src/interface/efi/efi_pxe.c
@@ -303,48 +303,6 @@ static int efi_pxe_ip_filter ( struct efi_pxe *pxe, EFI_IP_ADDRESS *ip ) {
 	return 0;
 }
 
-/******************************************************************************
- *
- * Data transfer buffer
- *
- ******************************************************************************
- */
-
-/**
- * Reallocate PXE data transfer buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v len		New length (or zero to free buffer)
- * @ret rc		Return status code
- */
-static int efi_pxe_buf_realloc ( struct xfer_buffer *xferbuf __unused,
-				 size_t len __unused ) {
-
-	/* Can never reallocate: return EFI_BUFFER_TOO_SMALL */
-	return -ERANGE;
-}
-
-/**
- * Write data to PXE data transfer buffer
- *
- * @v xferbuf		Data transfer buffer
- * @v offset		Starting offset
- * @v data		Data to copy
- * @v len		Length of data
- */
-static void efi_pxe_buf_write ( struct xfer_buffer *xferbuf, size_t offset,
-				const void *data, size_t len ) {
-
-	/* Copy data to buffer */
-	memcpy ( ( xferbuf->data + offset ), data, len );
-}
-
-/** PXE data transfer buffer operations */
-static struct xfer_buffer_operations efi_pxe_buf_operations = {
-	.realloc = efi_pxe_buf_realloc,
-	.write = efi_pxe_buf_write,
-};
-
 /******************************************************************************
  *
  * (M)TFTP download interface
@@ -966,8 +924,7 @@ efi_pxe_mtftp ( EFI_PXE_BASE_CODE_PROTOCOL *base,
 	pxe->blksize = ( ( callback && blksize ) ? *blksize : -1UL );
 
 	/* Initialise data transfer buffer */
-	pxe->buf.data = data;
-	pxe->buf.len = *len;
+	xferbuf_fixed_init ( &pxe->buf, data, *len );
 
 	/* Open download */
 	if ( ( rc = efi_pxe_tftp_open ( pxe, ip,
@@ -987,6 +944,7 @@ efi_pxe_mtftp ( EFI_PXE_BASE_CODE_PROTOCOL *base,
  err_download:
 	efi_pxe_tftp_close ( pxe, rc );
  err_open:
+	xferbuf_fixed_init ( &pxe->buf, NULL, 0 );
 	efi_snp_release();
  err_opcode:
 	return EFIRC ( rc );
@@ -1611,7 +1569,6 @@ int efi_pxe_install ( EFI_HANDLE handle, struct net_device *netdev ) {
 	pxe->base.Mode = &pxe->mode;
 	memcpy ( &pxe->apple, &efi_apple_net_boot_protocol,
 		 sizeof ( pxe->apple ) );
-	pxe->buf.op = &efi_pxe_buf_operations;
 	intf_init ( &pxe->tftp, &efi_pxe_tftp_desc, &pxe->refcnt );
 	intf_init ( &pxe->udp, &efi_pxe_udp_desc, &pxe->refcnt );
 	INIT_LIST_HEAD ( &pxe->queue );
diff --git a/src/net/peermux.c b/src/net/peermux.c
index a391ed373..431ca76e0 100644
--- a/src/net/peermux.c
+++ b/src/net/peermux.c
@@ -129,6 +129,7 @@ static int peermux_info_deliver ( struct peerdist_multiplexer *peermux,
  * @v rc		Reason for close
  */
 static void peermux_info_close ( struct peerdist_multiplexer *peermux, int rc ){
+	struct xfer_buffer *buffer = &peermux->buffer;
 	struct peerdist_info *info = &peermux->cache.info;
 	size_t len;
 
@@ -145,8 +146,7 @@ static void peermux_info_close ( struct peerdist_multiplexer *peermux, int rc ){
 	intf_shutdown ( &peermux->info, rc );
 
 	/* Parse content information */
-	if ( ( rc = peerdist_info ( info->raw.data, peermux->buffer.len,
-				    info ) ) != 0 ) {
+	if ( ( rc = peerdist_info ( buffer->data, buffer->len, info ) ) != 0 ) {
 		DBGC ( peermux, "PEERMUX %p could not parse content info: %s\n",
 		       peermux, strerror ( rc ) );
 		goto err;
@@ -422,8 +422,7 @@ int peermux_filter ( struct interface *xfer, struct interface *info,
 	intf_init ( &peermux->xfer, &peermux_xfer_desc, &peermux->refcnt );
 	intf_init ( &peermux->info, &peermux_info_desc, &peermux->refcnt );
 	peermux->uri = uri_get ( uri );
-	xferbuf_umalloc_init ( &peermux->buffer,
-			       &peermux->cache.info.raw.data );
+	xferbuf_umalloc_init ( &peermux->buffer );
 	process_init_stopped ( &peermux->process, &peermux_process_desc,
 			       &peermux->refcnt );
 	INIT_LIST_HEAD ( &peermux->busy );
-- 
cgit v1.2.3-55-g7522


From a69c42dd9fa97024f572b431f6527d359568c23e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 29 Apr 2025 16:28:03 +0100
Subject: [image] Clear recorded replacement image immediately after consuming

If an embedded script uses "chain --replace", the embedded image will
retain a reference to the replacement image in perpetuity.

Fix by clearing any recorded replacement image immediately in
image_exec(), instead of relying upon image_free() to drop the
reference.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/image.c | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/core')

diff --git a/src/core/image.c b/src/core/image.c
index a49ca7e1d..72885ec09 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -447,6 +447,10 @@ int image_exec ( struct image *image ) {
 	if ( replacement )
 		assert ( replacement->flags & IMAGE_REGISTERED );
 
+	/* Clear any recorded replacement image */
+	image_put ( image->replacement );
+	image->replacement = NULL;
+
  err:
 	/* Unregister image if applicable */
 	if ( image->flags & IMAGE_AUTO_UNREGISTER )
-- 
cgit v1.2.3-55-g7522


From b6f9e4bab082c3b7a9b587ef64109069fba59baa Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 30 Apr 2025 15:18:34 +0100
Subject: [uaccess] Remove redundant copy_from_user() and copy_to_user()

Remove the now-redundant copy_from_user() and copy_to_user() wrapper
functions.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/runtime.c                        |  1 +
 src/arch/x86/drivers/xen/hvm.c                     |  1 +
 src/arch/x86/image/elfboot.c                       |  1 +
 src/arch/x86/image/initrd.c                        |  1 +
 src/arch/x86/image/multiboot.c                     |  1 +
 src/arch/x86/image/nbi.c                           |  1 +
 src/arch/x86/image/pxe_image.c                     |  1 +
 src/arch/x86/image/ucode.c                         |  1 +
 src/arch/x86/include/realmode.h                    |  1 +
 src/arch/x86/interface/pcbios/acpipwr.c            |  1 +
 src/arch/x86/interface/pcbios/bios_cachedhcp.c     |  1 +
 src/arch/x86/interface/pcbios/bios_reboot.c        |  1 +
 src/arch/x86/interface/pcbios/biosint.c            |  1 +
 src/arch/x86/interface/pcbios/hidemem.c            |  1 +
 src/arch/x86/interface/pcbios/int13.c              |  1 +
 src/arch/x86/interface/pcbios/memmap.c             |  1 +
 src/arch/x86/interface/pcbios/memtop_umalloc.c     |  1 +
 src/arch/x86/interface/pcbios/rsdp.c               |  1 +
 src/core/blocktrans.c                              |  1 +
 src/core/cachedhcp.c                               |  1 +
 src/core/downloader.c                              |  1 +
 src/core/pixbuf.c                                  |  1 +
 src/core/sanboot.c                                 |  1 +
 src/drivers/bus/devtree.c                          |  1 +
 src/drivers/bus/ecam.c                             |  1 +
 src/drivers/bus/pci_settings.c                     |  1 +
 src/drivers/bus/usb_settings.c                     |  1 +
 src/drivers/infiniband/flexboot_nodnic.c           |  1 +
 src/drivers/infiniband/linda.c                     |  1 +
 .../mlx_utils_flexboot/src/mlx_memory_priv.c       |  1 +
 src/drivers/infiniband/qib7322.c                   |  1 +
 src/drivers/linux/slirp.c                          |  1 +
 src/drivers/net/ath/ath.h                          |  1 +
 src/drivers/net/ath/ath5k/ath5k.h                  |  1 +
 src/drivers/net/b44.c                              |  1 +
 src/drivers/net/bnxt/bnxt.c                        |  1 +
 src/drivers/net/eepro100.c                         |  1 +
 src/drivers/net/etherfabric.c                      |  1 +
 src/drivers/net/marvell/atl2_hw.c                  |  1 +
 src/drivers/net/marvell/atl_hw.c                   |  1 +
 src/drivers/net/myri10ge.c                         |  2 +-
 src/drivers/net/netvsc.c                           |  1 +
 src/drivers/net/rtl818x/rtl818x.c                  |  1 +
 src/drivers/net/sfc/efx_hunt.c                     |  1 +
 src/drivers/net/sfc/sfc_hunt.c                     |  1 +
 src/drivers/net/skge.c                             |  1 +
 src/drivers/net/sky2.c                             |  1 +
 src/drivers/net/tg3/tg3.c                          |  1 +
 src/drivers/net/tg3/tg3_hw.c                       |  1 +
 src/drivers/net/tg3/tg3_phy.c                      |  1 +
 src/drivers/net/vmxnet3.c                          |  1 +
 src/drivers/net/vxge/vxge_config.c                 |  1 +
 src/drivers/net/vxge/vxge_traffic.c                |  1 +
 src/drivers/nvs/nvsvpd.c                           |  1 +
 src/drivers/usb/usbblk.c                           |  1 +
 src/hci/commands/cert_cmd.c                        |  1 +
 src/hci/commands/image_cmd.c                       |  1 +
 src/hci/commands/image_crypt_cmd.c                 |  1 +
 src/hci/commands/image_trust_cmd.c                 |  1 +
 src/hci/commands/pci_cmd.c                         |  1 +
 src/hci/commands/usb_cmd.c                         |  1 +
 src/image/der.c                                    |  1 +
 src/image/efi_image.c                              |  1 +
 src/image/efi_siglist.c                            |  1 +
 src/image/elf.c                                    |  1 +
 src/image/pnm.c                                    |  1 +
 src/image/segment.c                                |  1 +
 src/include/ipxe/dummy_pio.h                       |  2 ++
 src/include/ipxe/iomap_virt.h                      |  2 ++
 src/include/ipxe/uaccess.h                         | 27 ----------------------
 src/interface/efi/efi_bofm.c                       |  1 +
 src/interface/efi/efi_cmdline.c                    |  1 +
 src/interface/efi/efi_pci.c                        |  1 +
 src/interface/xen/xenbus.c                         |  1 +
 src/net/eapol.c                                    |  1 +
 src/net/fcoe.c                                     |  1 +
 src/net/lldp.c                                     |  1 +
 src/net/peerblk.c                                  |  1 +
 src/net/peermux.c                                  |  1 +
 src/net/tcp/httpblock.c                            |  1 +
 src/net/tcp/syslogs.c                              |  1 +
 src/net/udp/syslog.c                               |  1 +
 src/tests/asn1_test.c                              |  1 +
 src/tests/cpio_test.c                              |  1 +
 src/tests/pixbuf_test.c                            |  1 +
 src/tests/test.c                                   |  1 +
 src/usr/imgarchive.c                               |  1 +
 src/usr/imgmgmt.c                                  |  1 +
 src/usr/imgtrust.c                                 |  1 +
 89 files changed, 90 insertions(+), 28 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/runtime.c b/src/arch/x86/core/runtime.c
index 1fdf80497..461188d04 100644
--- a/src/arch/x86/core/runtime.c
+++ b/src/arch/x86/core/runtime.c
@@ -32,6 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stddef.h>
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <ctype.h>
 #include <errno.h>
 #include <assert.h>
diff --git a/src/arch/x86/drivers/xen/hvm.c b/src/arch/x86/drivers/xen/hvm.c
index b77cdd14c..cf41cc955 100644
--- a/src/arch/x86/drivers/xen/hvm.c
+++ b/src/arch/x86/drivers/xen/hvm.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/malloc.h>
 #include <ipxe/pci.h>
diff --git a/src/arch/x86/image/elfboot.c b/src/arch/x86/image/elfboot.c
index 63a3460d3..f662e366f 100644
--- a/src/arch/x86/image/elfboot.c
+++ b/src/arch/x86/image/elfboot.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <errno.h>
 #include <elf.h>
 #include <ipxe/image.h>
diff --git a/src/arch/x86/image/initrd.c b/src/arch/x86/image/initrd.c
index 8acdd95f7..cb4879036 100644
--- a/src/arch/x86/image/initrd.c
+++ b/src/arch/x86/image/initrd.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <errno.h>
 #include <initrd.h>
 #include <ipxe/image.h>
diff --git a/src/arch/x86/image/multiboot.c b/src/arch/x86/image/multiboot.c
index 7c8963475..9444c4047 100644
--- a/src/arch/x86/image/multiboot.c
+++ b/src/arch/x86/image/multiboot.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <realmode.h>
diff --git a/src/arch/x86/image/nbi.c b/src/arch/x86/image/nbi.c
index 0a60283fb..0f57bdfcd 100644
--- a/src/arch/x86/image/nbi.c
+++ b/src/arch/x86/image/nbi.c
@@ -1,3 +1,4 @@
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <realmode.h>
diff --git a/src/arch/x86/image/pxe_image.c b/src/arch/x86/image/pxe_image.c
index d7acd0084..3e6cf7268 100644
--- a/src/arch/x86/image/pxe_image.c
+++ b/src/arch/x86/image/pxe_image.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
+#include <string.h>
 #include <pxe.h>
 #include <pxe_call.h>
 #include <pic8259.h>
diff --git a/src/arch/x86/image/ucode.c b/src/arch/x86/image/ucode.c
index 0ae3863cb..fd4689e00 100644
--- a/src/arch/x86/image/ucode.c
+++ b/src/arch/x86/image/ucode.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <assert.h>
 #include <errno.h>
 #include <ipxe/uaccess.h>
diff --git a/src/arch/x86/include/realmode.h b/src/arch/x86/include/realmode.h
index 75f7d16e7..5cf644a23 100644
--- a/src/arch/x86/include/realmode.h
+++ b/src/arch/x86/include/realmode.h
@@ -2,6 +2,7 @@
 #define REALMODE_H
 
 #include <stdint.h>
+#include <string.h>
 #include <registers.h>
 #include <ipxe/uaccess.h>
 
diff --git a/src/arch/x86/interface/pcbios/acpipwr.c b/src/arch/x86/interface/pcbios/acpipwr.c
index bff53806b..cb82ef1b4 100644
--- a/src/arch/x86/interface/pcbios/acpipwr.c
+++ b/src/arch/x86/interface/pcbios/acpipwr.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <unistd.h>
 #include <errno.h>
 #include <byteswap.h>
diff --git a/src/arch/x86/interface/pcbios/bios_cachedhcp.c b/src/arch/x86/interface/pcbios/bios_cachedhcp.c
index 05d89b3b7..897858143 100644
--- a/src/arch/x86/interface/pcbios/bios_cachedhcp.c
+++ b/src/arch/x86/interface/pcbios/bios_cachedhcp.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
+#include <string.h>
 #include <ipxe/init.h>
 #include <ipxe/cachedhcp.h>
 #include <realmode.h>
diff --git a/src/arch/x86/interface/pcbios/bios_reboot.c b/src/arch/x86/interface/pcbios/bios_reboot.c
index 463470245..c7f25405f 100644
--- a/src/arch/x86/interface/pcbios/bios_reboot.c
+++ b/src/arch/x86/interface/pcbios/bios_reboot.c
@@ -29,6 +29,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
+#include <string.h>
 #include <ipxe/reboot.h>
 #include <realmode.h>
 #include <bios.h>
diff --git a/src/arch/x86/interface/pcbios/biosint.c b/src/arch/x86/interface/pcbios/biosint.c
index 667e9ed81..f5e54ede8 100644
--- a/src/arch/x86/interface/pcbios/biosint.c
+++ b/src/arch/x86/interface/pcbios/biosint.c
@@ -1,3 +1,4 @@
+#include <string.h>
 #include <errno.h>
 #include <realmode.h>
 #include <biosint.h>
diff --git a/src/arch/x86/interface/pcbios/hidemem.c b/src/arch/x86/interface/pcbios/hidemem.c
index 1a3022c5d..6983c1f4a 100644
--- a/src/arch/x86/interface/pcbios/hidemem.c
+++ b/src/arch/x86/interface/pcbios/hidemem.c
@@ -22,6 +22,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <assert.h>
 #include <realmode.h>
 #include <biosint.h>
diff --git a/src/arch/x86/interface/pcbios/int13.c b/src/arch/x86/interface/pcbios/int13.c
index 73fdfebd3..045d78e8d 100644
--- a/src/arch/x86/interface/pcbios/int13.c
+++ b/src/arch/x86/interface/pcbios/int13.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <limits.h>
 #include <byteswap.h>
 #include <errno.h>
diff --git a/src/arch/x86/interface/pcbios/memmap.c b/src/arch/x86/interface/pcbios/memmap.c
index daae382b8..3bc1229aa 100644
--- a/src/arch/x86/interface/pcbios/memmap.c
+++ b/src/arch/x86/interface/pcbios/memmap.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
+#include <string.h>
 #include <errno.h>
 #include <realmode.h>
 #include <bios.h>
diff --git a/src/arch/x86/interface/pcbios/memtop_umalloc.c b/src/arch/x86/interface/pcbios/memtop_umalloc.c
index d4489fb01..bfaffc4bb 100644
--- a/src/arch/x86/interface/pcbios/memtop_umalloc.c
+++ b/src/arch/x86/interface/pcbios/memtop_umalloc.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <limits.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/uaccess.h>
 #include <ipxe/hidemem.h>
diff --git a/src/arch/x86/interface/pcbios/rsdp.c b/src/arch/x86/interface/pcbios/rsdp.c
index 6bcf19b18..6913be552 100644
--- a/src/arch/x86/interface/pcbios/rsdp.c
+++ b/src/arch/x86/interface/pcbios/rsdp.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdint.h>
+#include <string.h>
 #include <realmode.h>
 #include <bios.h>
 #include <ipxe/acpi.h>
diff --git a/src/core/blocktrans.c b/src/core/blocktrans.c
index 362721747..b793185fe 100644
--- a/src/core/blocktrans.c
+++ b/src/core/blocktrans.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <ipxe/iobuf.h>
diff --git a/src/core/cachedhcp.c b/src/core/cachedhcp.c
index 0d400db16..1510f3321 100644
--- a/src/core/cachedhcp.c
+++ b/src/core/cachedhcp.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/dhcppkt.h>
 #include <ipxe/init.h>
diff --git a/src/core/downloader.c b/src/core/downloader.c
index 449761836..9950fe5e4 100644
--- a/src/core/downloader.c
+++ b/src/core/downloader.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <syslog.h>
 #include <ipxe/iobuf.h>
diff --git a/src/core/pixbuf.c b/src/core/pixbuf.c
index d0b80b2a9..506a28c38 100644
--- a/src/core/pixbuf.c
+++ b/src/core/pixbuf.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/image.h>
diff --git a/src/core/sanboot.c b/src/core/sanboot.c
index bdac813ff..e90c5ef1d 100644
--- a/src/core/sanboot.c
+++ b/src/core/sanboot.c
@@ -32,6 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <ipxe/xfer.h>
diff --git a/src/drivers/bus/devtree.c b/src/drivers/bus/devtree.c
index cbd8ea8fa..654f8d14f 100644
--- a/src/drivers/bus/devtree.c
+++ b/src/drivers/bus/devtree.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/device.h>
 #include <ipxe/fdt.h>
diff --git a/src/drivers/bus/ecam.c b/src/drivers/bus/ecam.c
index 58d513e88..35556a8d9 100644
--- a/src/drivers/bus/ecam.c
+++ b/src/drivers/bus/ecam.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <errno.h>
 #include <ipxe/uaccess.h>
 #include <ipxe/ecam.h>
diff --git a/src/drivers/bus/pci_settings.c b/src/drivers/bus/pci_settings.c
index 98005559d..84aa76827 100644
--- a/src/drivers/bus/pci_settings.c
+++ b/src/drivers/bus/pci_settings.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/pci.h>
 #include <ipxe/settings.h>
diff --git a/src/drivers/bus/usb_settings.c b/src/drivers/bus/usb_settings.c
index db6f94d8a..4fd190d83 100644
--- a/src/drivers/bus/usb_settings.c
+++ b/src/drivers/bus/usb_settings.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/usb.h>
 #include <ipxe/settings.h>
diff --git a/src/drivers/infiniband/flexboot_nodnic.c b/src/drivers/infiniband/flexboot_nodnic.c
index c6e19b955..a9e6fdd71 100644
--- a/src/drivers/infiniband/flexboot_nodnic.c
+++ b/src/drivers/infiniband/flexboot_nodnic.c
@@ -20,6 +20,7 @@
 FILE_LICENCE ( GPL2_OR_LATER );
 
 #include <stdio.h>
+#include <string.h>
 #include <unistd.h>
 #include <errno.h>
 #include <ipxe/pci.h>
diff --git a/src/drivers/infiniband/linda.c b/src/drivers/infiniband/linda.c
index 0c8a043a1..2e2b469e4 100644
--- a/src/drivers/infiniband/linda.c
+++ b/src/drivers/infiniband/linda.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #include <assert.h>
diff --git a/src/drivers/infiniband/mlx_utils_flexboot/src/mlx_memory_priv.c b/src/drivers/infiniband/mlx_utils_flexboot/src/mlx_memory_priv.c
index e368d459b..b35c30dee 100644
--- a/src/drivers/infiniband/mlx_utils_flexboot/src/mlx_memory_priv.c
+++ b/src/drivers/infiniband/mlx_utils_flexboot/src/mlx_memory_priv.c
@@ -7,6 +7,7 @@
 
 #include <ipxe/malloc.h>
 #include <stddef.h>
+#include <string.h>
 #include <byteswap.h>
 #include <ipxe/io.h>
 #include "../../mlx_utils/include/private/mlx_memory_priv.h"
diff --git a/src/drivers/infiniband/qib7322.c b/src/drivers/infiniband/qib7322.c
index a011dafc1..a9e4566dc 100644
--- a/src/drivers/infiniband/qib7322.c
+++ b/src/drivers/infiniband/qib7322.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #include <assert.h>
diff --git a/src/drivers/linux/slirp.c b/src/drivers/linux/slirp.c
index 8341c9676..d7ab6419e 100644
--- a/src/drivers/linux/slirp.c
+++ b/src/drivers/linux/slirp.c
@@ -18,6 +18,7 @@
  */
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/ethernet.h>
diff --git a/src/drivers/net/ath/ath.h b/src/drivers/net/ath/ath.h
index 589bb5634..21f795b70 100644
--- a/src/drivers/net/ath/ath.h
+++ b/src/drivers/net/ath/ath.h
@@ -23,6 +23,7 @@
 FILE_LICENCE ( BSD2 );
 
 #include <unistd.h>
+#include <string.h>
 #include <ipxe/net80211.h>
 
 /* This block of functions are from kernel.h v3.0.1 */
diff --git a/src/drivers/net/ath/ath5k/ath5k.h b/src/drivers/net/ath/ath5k/ath5k.h
index fa62e8ce5..727d41279 100644
--- a/src/drivers/net/ath/ath5k/ath5k.h
+++ b/src/drivers/net/ath/ath5k/ath5k.h
@@ -24,6 +24,7 @@
 FILE_LICENCE ( MIT );
 
 #include <stddef.h>
+#include <string.h>
 #include <byteswap.h>
 #include <ipxe/io.h>
 #include <ipxe/netdevice.h>
diff --git a/src/drivers/net/b44.c b/src/drivers/net/b44.c
index 30ece5574..c6ca99865 100644
--- a/src/drivers/net/b44.c
+++ b/src/drivers/net/b44.c
@@ -31,6 +31,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <stdio.h>
diff --git a/src/drivers/net/bnxt/bnxt.c b/src/drivers/net/bnxt/bnxt.c
index 5de8d094e..402439eef 100644
--- a/src/drivers/net/bnxt/bnxt.c
+++ b/src/drivers/net/bnxt/bnxt.c
@@ -3,6 +3,7 @@ FILE_LICENCE ( GPL2_ONLY );
 
 #include <mii.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #include <byteswap.h>
diff --git a/src/drivers/net/eepro100.c b/src/drivers/net/eepro100.c
index 49b00d443..318db1883 100644
--- a/src/drivers/net/eepro100.c
+++ b/src/drivers/net/eepro100.c
@@ -101,6 +101,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
  */
 
 #include <stdint.h>
+#include <string.h>
 #include <byteswap.h>
 #include <errno.h>
 #include <stdio.h>
diff --git a/src/drivers/net/etherfabric.c b/src/drivers/net/etherfabric.c
index be30b71f7..a58b71568 100644
--- a/src/drivers/net/etherfabric.c
+++ b/src/drivers/net/etherfabric.c
@@ -21,6 +21,7 @@ FILE_LICENCE ( GPL_ANY );
 #include <stdint.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <unistd.h>
 #include <errno.h>
 #include <assert.h>
diff --git a/src/drivers/net/marvell/atl2_hw.c b/src/drivers/net/marvell/atl2_hw.c
index 805820709..07822a9c2 100644
--- a/src/drivers/net/marvell/atl2_hw.c
+++ b/src/drivers/net/marvell/atl2_hw.c
@@ -31,6 +31,7 @@
 
 FILE_LICENCE ( BSD2 );
 
+#include <string.h>
 #include <errno.h>
 #include <stdio.h>
 #include <unistd.h>
diff --git a/src/drivers/net/marvell/atl_hw.c b/src/drivers/net/marvell/atl_hw.c
index e0843e6f4..fa7f2a9b8 100644
--- a/src/drivers/net/marvell/atl_hw.c
+++ b/src/drivers/net/marvell/atl_hw.c
@@ -31,6 +31,7 @@
 
 FILE_LICENCE ( BSD2 );
 
+#include <string.h>
 #include <errno.h>
 #include <stdio.h>
 #include <unistd.h>
diff --git a/src/drivers/net/myri10ge.c b/src/drivers/net/myri10ge.c
index 6d0f723f2..fb9dc01b2 100644
--- a/src/drivers/net/myri10ge.c
+++ b/src/drivers/net/myri10ge.c
@@ -74,7 +74,7 @@ FILE_LICENCE ( GPL2_ONLY );
  */
 
 #include <stdint.h>
-
+#include <string.h>
 #include <byteswap.h>
 #include <errno.h>
 #include <ipxe/ethernet.h>
diff --git a/src/drivers/net/netvsc.c b/src/drivers/net/netvsc.c
index 4bdf7b517..9b6ee88b4 100644
--- a/src/drivers/net/netvsc.c
+++ b/src/drivers/net/netvsc.c
@@ -32,6 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * bus (VMBus).  It provides a transport layer for RNDIS packets.
  */
 
+#include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #include <byteswap.h>
diff --git a/src/drivers/net/rtl818x/rtl818x.c b/src/drivers/net/rtl818x/rtl818x.c
index 599d36fad..3bae8a797 100644
--- a/src/drivers/net/rtl818x/rtl818x.c
+++ b/src/drivers/net/rtl818x/rtl818x.c
@@ -20,6 +20,7 @@
 FILE_LICENCE(GPL2_ONLY);
 
 #include <stdint.h>
+#include <string.h>
 #include <errno.h>
 #include <stdio.h>
 #include <unistd.h>
diff --git a/src/drivers/net/sfc/efx_hunt.c b/src/drivers/net/sfc/efx_hunt.c
index abe3e8320..92c0fda62 100644
--- a/src/drivers/net/sfc/efx_hunt.c
+++ b/src/drivers/net/sfc/efx_hunt.c
@@ -21,6 +21,7 @@
 #include <stdint.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <unistd.h>
 #include <errno.h>
 #include <assert.h>
diff --git a/src/drivers/net/sfc/sfc_hunt.c b/src/drivers/net/sfc/sfc_hunt.c
index 43ac229ab..f763fc9d0 100644
--- a/src/drivers/net/sfc/sfc_hunt.c
+++ b/src/drivers/net/sfc/sfc_hunt.c
@@ -19,6 +19,7 @@
  ***************************************************************************/
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <unistd.h>
 #include <errno.h>
 #include <byteswap.h>
diff --git a/src/drivers/net/skge.c b/src/drivers/net/skge.c
index cc7f0b91b..828a2a4c9 100755
--- a/src/drivers/net/skge.c
+++ b/src/drivers/net/skge.c
@@ -31,6 +31,7 @@
 FILE_LICENCE ( GPL2_ONLY );
 
 #include <stdint.h>
+#include <string.h>
 #include <errno.h>
 #include <stdio.h>
 #include <unistd.h>
diff --git a/src/drivers/net/sky2.c b/src/drivers/net/sky2.c
index 4f8ec3e42..db3f6aaa1 100644
--- a/src/drivers/net/sky2.c
+++ b/src/drivers/net/sky2.c
@@ -28,6 +28,7 @@
 FILE_LICENCE ( GPL2_ONLY );
 
 #include <stdint.h>
+#include <string.h>
 #include <errno.h>
 #include <stdio.h>
 #include <unistd.h>
diff --git a/src/drivers/net/tg3/tg3.c b/src/drivers/net/tg3/tg3.c
index 05af22d61..a6736305c 100644
--- a/src/drivers/net/tg3/tg3.c
+++ b/src/drivers/net/tg3/tg3.c
@@ -3,6 +3,7 @@ FILE_LICENCE ( GPL2_ONLY );
 
 #include <mii.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #include <byteswap.h>
diff --git a/src/drivers/net/tg3/tg3_hw.c b/src/drivers/net/tg3/tg3_hw.c
index 9a70413b6..5c9506dce 100644
--- a/src/drivers/net/tg3/tg3_hw.c
+++ b/src/drivers/net/tg3/tg3_hw.c
@@ -18,6 +18,7 @@
 FILE_LICENCE ( GPL2_ONLY );
 
 #include <mii.h>
+#include <string.h>
 #include <stdio.h>
 #include <errno.h>
 #include <unistd.h>
diff --git a/src/drivers/net/tg3/tg3_phy.c b/src/drivers/net/tg3/tg3_phy.c
index e88b0be0f..a2322329e 100644
--- a/src/drivers/net/tg3/tg3_phy.c
+++ b/src/drivers/net/tg3/tg3_phy.c
@@ -1,6 +1,7 @@
 
 #include <mii.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #include <byteswap.h>
diff --git a/src/drivers/net/vmxnet3.c b/src/drivers/net/vmxnet3.c
index 3800d6b72..2cc6738f2 100644
--- a/src/drivers/net/vmxnet3.c
+++ b/src/drivers/net/vmxnet3.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <byteswap.h>
diff --git a/src/drivers/net/vxge/vxge_config.c b/src/drivers/net/vxge/vxge_config.c
index f4d217097..8c6ee9e96 100644
--- a/src/drivers/net/vxge/vxge_config.c
+++ b/src/drivers/net/vxge/vxge_config.c
@@ -16,6 +16,7 @@ FILE_LICENCE(GPL2_ONLY);
 
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <ipxe/malloc.h>
 #include <ipxe/pci.h>
 #include <ipxe/iobuf.h>
diff --git a/src/drivers/net/vxge/vxge_traffic.c b/src/drivers/net/vxge/vxge_traffic.c
index dbd799015..0adaea2aa 100644
--- a/src/drivers/net/vxge/vxge_traffic.c
+++ b/src/drivers/net/vxge/vxge_traffic.c
@@ -15,6 +15,7 @@
 FILE_LICENCE(GPL2_ONLY);
 
 #include <ipxe/netdevice.h>
+#include <string.h>
 #include <errno.h>
 
 #include "vxge_traffic.h"
diff --git a/src/drivers/nvs/nvsvpd.c b/src/drivers/nvs/nvsvpd.c
index 3e88531c7..195973319 100644
--- a/src/drivers/nvs/nvsvpd.c
+++ b/src/drivers/nvs/nvsvpd.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/nvs.h>
 #include <ipxe/pci.h>
diff --git a/src/drivers/usb/usbblk.c b/src/drivers/usb/usbblk.c
index 39adc012f..cb377efb0 100644
--- a/src/drivers/usb/usbblk.c
+++ b/src/drivers/usb/usbblk.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/usb.h>
 #include <ipxe/scsi.h>
diff --git a/src/hci/commands/cert_cmd.c b/src/hci/commands/cert_cmd.c
index 24b18bf5c..75d2ccbed 100644
--- a/src/hci/commands/cert_cmd.c
+++ b/src/hci/commands/cert_cmd.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <getopt.h>
 #include <ipxe/x509.h>
diff --git a/src/hci/commands/image_cmd.c b/src/hci/commands/image_cmd.c
index bf97b4deb..4b42695c4 100644
--- a/src/hci/commands/image_cmd.c
+++ b/src/hci/commands/image_cmd.c
@@ -26,6 +26,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <getopt.h>
 #include <ipxe/image.h>
diff --git a/src/hci/commands/image_crypt_cmd.c b/src/hci/commands/image_crypt_cmd.c
index 26e9d79f8..4dfb5b131 100644
--- a/src/hci/commands/image_crypt_cmd.c
+++ b/src/hci/commands/image_crypt_cmd.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdio.h>
+#include <string.h>
 #include <getopt.h>
 #include <ipxe/image.h>
 #include <ipxe/command.h>
diff --git a/src/hci/commands/image_trust_cmd.c b/src/hci/commands/image_trust_cmd.c
index b34378f93..9b9e3f859 100644
--- a/src/hci/commands/image_trust_cmd.c
+++ b/src/hci/commands/image_trust_cmd.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdio.h>
+#include <string.h>
 #include <getopt.h>
 #include <ipxe/image.h>
 #include <ipxe/command.h>
diff --git a/src/hci/commands/pci_cmd.c b/src/hci/commands/pci_cmd.c
index 5bae66fbe..fa1fa5ece 100644
--- a/src/hci/commands/pci_cmd.c
+++ b/src/hci/commands/pci_cmd.c
@@ -22,6 +22,7 @@
  */
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <getopt.h>
 #include <ipxe/pci.h>
diff --git a/src/hci/commands/usb_cmd.c b/src/hci/commands/usb_cmd.c
index d1086fd7e..4ee2f2ddb 100644
--- a/src/hci/commands/usb_cmd.c
+++ b/src/hci/commands/usb_cmd.c
@@ -22,6 +22,7 @@
  */
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <getopt.h>
 #include <ipxe/usb.h>
diff --git a/src/image/der.c b/src/image/der.c
index 600e163c9..67117d43b 100644
--- a/src/image/der.c
+++ b/src/image/der.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <ipxe/asn1.h>
diff --git a/src/image/efi_image.c b/src/image/efi_image.c
index f71630f4a..f7ee7ff50 100644
--- a/src/image/efi_image.c
+++ b/src/image/efi_image.c
@@ -21,6 +21,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 
 #include <errno.h>
 #include <stdlib.h>
+#include <string.h>
 #include <wchar.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/efi_snp.h>
diff --git a/src/image/efi_siglist.c b/src/image/efi_siglist.c
index 2bd273dbd..b264ac558 100644
--- a/src/image/efi_siglist.c
+++ b/src/image/efi_siglist.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/asn1.h>
 #include <ipxe/der.h>
diff --git a/src/image/elf.c b/src/image/elf.c
index 83712c3b0..97e07f37f 100644
--- a/src/image/elf.c
+++ b/src/image/elf.c
@@ -33,6 +33,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * common ELF-related functionality.
  */
 
+#include <string.h>
 #include <errno.h>
 #include <elf.h>
 #include <ipxe/segment.h>
diff --git a/src/image/pnm.c b/src/image/pnm.c
index 4b5020b64..489a43304 100644
--- a/src/image/pnm.c
+++ b/src/image/pnm.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <ctype.h>
 #include <ipxe/image.h>
diff --git a/src/image/segment.c b/src/image/segment.c
index 2cb637dc2..52272170a 100644
--- a/src/image/segment.c
+++ b/src/image/segment.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
+#include <string.h>
 #include <errno.h>
 #include <ipxe/uaccess.h>
 #include <ipxe/io.h>
diff --git a/src/include/ipxe/dummy_pio.h b/src/include/ipxe/dummy_pio.h
index 1cdabba14..e7a4cabef 100644
--- a/src/include/ipxe/dummy_pio.h
+++ b/src/include/ipxe/dummy_pio.h
@@ -13,6 +13,8 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
+
 #define DUMMY_INX( _prefix, _suffix, _type )				      \
 static inline __always_inline _type					      \
 IOAPI_INLINE ( _prefix, in ## _suffix ) ( volatile _type *io_addr __unused) { \
diff --git a/src/include/ipxe/iomap_virt.h b/src/include/ipxe/iomap_virt.h
index 4962b7c37..731d083d5 100644
--- a/src/include/ipxe/iomap_virt.h
+++ b/src/include/ipxe/iomap_virt.h
@@ -9,6 +9,8 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <stddef.h>
+
 #ifdef IOMAP_VIRT
 #define IOMAP_PREFIX_virt
 #else
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 948ef1fa2..82f29f793 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -11,7 +11,6 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <string.h>
 #include <ipxe/api.h>
 #include <config/ioapi.h>
 
@@ -127,30 +126,4 @@ virt_to_phys ( volatile const void *virt );
  */
 void * __attribute__ (( const )) phys_to_virt ( physaddr_t phys );
 
-/**
- * Copy data to user buffer
- *
- * @v dest		Destination
- * @v dest_off		Destination offset
- * @v src		Source
- * @v len		Length
- */
-static inline __always_inline void
-copy_to_user ( userptr_t dest, off_t dest_off, const void *src, size_t len ) {
-	memcpy ( ( dest + dest_off ), src, len );
-}
-
-/**
- * Copy data from user buffer
- *
- * @v dest		Destination
- * @v src		Source
- * @v src_off		Source offset
- * @v len		Length
- */
-static inline __always_inline void
-copy_from_user ( void *dest, userptr_t src, off_t src_off, size_t len ) {
-	memcpy ( dest, ( src + src_off ), len );
-}
-
 #endif /* _IPXE_UACCESS_H */
diff --git a/src/interface/efi/efi_bofm.c b/src/interface/efi/efi_bofm.c
index 7d1d3619f..3d956800e 100644
--- a/src/interface/efi/efi_bofm.c
+++ b/src/interface/efi/efi_bofm.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <errno.h>
 #include <ipxe/bofm.h>
 #include <ipxe/efi/efi.h>
diff --git a/src/interface/efi/efi_cmdline.c b/src/interface/efi/efi_cmdline.c
index b33bebd8c..13ad0fc35 100644
--- a/src/interface/efi/efi_cmdline.c
+++ b/src/interface/efi/efi_cmdline.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 #include <ctype.h>
 #include <errno.h>
 #include <ipxe/init.h>
diff --git a/src/interface/efi/efi_pci.c b/src/interface/efi/efi_pci.c
index b8c7df38d..1b1f05816 100644
--- a/src/interface/efi/efi_pci.c
+++ b/src/interface/efi/efi_pci.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/pci.h>
 #include <ipxe/acpi.h>
diff --git a/src/interface/xen/xenbus.c b/src/interface/xen/xenbus.c
index 5dd01dfa3..8b5ee0a0d 100644
--- a/src/interface/xen/xenbus.c
+++ b/src/interface/xen/xenbus.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/malloc.h>
 #include <ipxe/device.h>
diff --git a/src/net/eapol.c b/src/net/eapol.c
index 8b09ca231..0c573d198 100644
--- a/src/net/eapol.c
+++ b/src/net/eapol.c
@@ -23,6 +23,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <string.h>
 #include <assert.h>
 #include <errno.h>
 #include <byteswap.h>
diff --git a/src/net/fcoe.c b/src/net/fcoe.c
index 9f3ddf88b..d54f1d431 100644
--- a/src/net/fcoe.c
+++ b/src/net/fcoe.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stddef.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <byteswap.h>
 #include <ipxe/if_ether.h>
diff --git a/src/net/lldp.c b/src/net/lldp.c
index a854d0ace..2b707c874 100644
--- a/src/net/lldp.c
+++ b/src/net/lldp.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <byteswap.h>
 #include <ipxe/iobuf.h>
diff --git a/src/net/peerblk.c b/src/net/peerblk.c
index bbd5f16ed..58b185102 100644
--- a/src/net/peerblk.c
+++ b/src/net/peerblk.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/http.h>
 #include <ipxe/iobuf.h>
diff --git a/src/net/peermux.c b/src/net/peermux.c
index 431ca76e0..5c814b03e 100644
--- a/src/net/peermux.c
+++ b/src/net/peermux.c
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/uri.h>
 #include <ipxe/xferbuf.h>
diff --git a/src/net/tcp/httpblock.c b/src/net/tcp/httpblock.c
index 156f11e47..8eff1942c 100644
--- a/src/net/tcp/httpblock.c
+++ b/src/net/tcp/httpblock.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <stdint.h>
+#include <string.h>
 #include <ipxe/blocktrans.h>
 #include <ipxe/blockdev.h>
 #include <ipxe/acpi.h>
diff --git a/src/net/tcp/syslogs.c b/src/net/tcp/syslogs.c
index f1f70d59e..5676f3e3e 100644
--- a/src/net/tcp/syslogs.c
+++ b/src/net/tcp/syslogs.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <byteswap.h>
 #include <ipxe/xfer.h>
 #include <ipxe/open.h>
diff --git a/src/net/udp/syslog.c b/src/net/udp/syslog.c
index a45fc459d..198c86ef7 100644
--- a/src/net/udp/syslog.c
+++ b/src/net/udp/syslog.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <string.h>
 #include <ctype.h>
 #include <byteswap.h>
 #include <ipxe/xfer.h>
diff --git a/src/tests/asn1_test.c b/src/tests/asn1_test.c
index df3f01b63..b522b85d7 100644
--- a/src/tests/asn1_test.c
+++ b/src/tests/asn1_test.c
@@ -33,6 +33,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #undef NDEBUG
 
 #include <stdlib.h>
+#include <string.h>
 #include <assert.h>
 #include <ipxe/image.h>
 #include <ipxe/asn1.h>
diff --git a/src/tests/cpio_test.c b/src/tests/cpio_test.c
index 7eb8b2c74..24baf947b 100644
--- a/src/tests/cpio_test.c
+++ b/src/tests/cpio_test.c
@@ -33,6 +33,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #undef NDEBUG
 
 #include <stdlib.h>
+#include <string.h>
 #include <ipxe/cpio.h>
 #include <ipxe/test.h>
 
diff --git a/src/tests/pixbuf_test.c b/src/tests/pixbuf_test.c
index 1f82e0018..a8ea1151e 100644
--- a/src/tests/pixbuf_test.c
+++ b/src/tests/pixbuf_test.c
@@ -32,6 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /* Forcibly enable assertions */
 #undef NDEBUG
 
+#include <string.h>
 #include <assert.h>
 #include <ipxe/image.h>
 #include <ipxe/pixbuf.h>
diff --git a/src/tests/test.c b/src/tests/test.c
index 4c49d4c16..1ec4b21ef 100644
--- a/src/tests/test.c
+++ b/src/tests/test.c
@@ -34,6 +34,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stddef.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <assert.h>
 #include <ipxe/test.h>
diff --git a/src/usr/imgarchive.c b/src/usr/imgarchive.c
index 6849dd510..91600760e 100644
--- a/src/usr/imgarchive.c
+++ b/src/usr/imgarchive.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdio.h>
+#include <string.h>
 #include <ipxe/image.h>
 #include <usr/imgarchive.h>
 
diff --git a/src/usr/imgmgmt.c b/src/usr/imgmgmt.c
index 054137696..65b52fd3a 100644
--- a/src/usr/imgmgmt.c
+++ b/src/usr/imgmgmt.c
@@ -26,6 +26,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <string.h>
 #include <errno.h>
 #include <ipxe/image.h>
 #include <ipxe/downloader.h>
diff --git a/src/usr/imgtrust.c b/src/usr/imgtrust.c
index 7f7e7ed14..4eb631e79 100644
--- a/src/usr/imgtrust.c
+++ b/src/usr/imgtrust.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
 #include <time.h>
 #include <syslog.h>
-- 
cgit v1.2.3-55-g7522


From cd803ff2e2424b56a7ae5886e4cfe17b47652e6e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 30 Apr 2025 13:22:54 +0100
Subject: [image] Add the concept of a static image

Not all images are allocated via alloc_image().  For example: embedded
images, the static images created to hold a runtime command line, and
the images used by unit tests are all static structures.

Using image_set_cmdline() (via e.g. the "imgargs" command) to set the
command-line arguments of a static image will succeed but will leak
memory, since nothing will ever free the allocated command line.
There are no code paths that can lead to calling image_set_len() on a
static image, but there is no safety check against future code paths
attempting this.

Define a flag IMAGE_STATIC to mark an image as statically allocated,
generalise free_image() to also handle freeing dynamically allocated
portions of static images (such as the command line), and expose
free_image() for use by static images.

Define a related flag IMAGE_STATIC_NAME to mark the name as statically
allocated.  Allow a statically allocated name to be replaced with a
dynamically allocated name since this is a potentially valid use case
(e.g. if "imgdecrypt --name <name>" is used on an embedded image).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/runtime.c     |  2 ++
 src/core/image.c                | 44 ++++++++++++++++++++++++++++++++++++-----
 src/image/embedded.c            |  3 ++-
 src/include/ipxe/image.h        | 19 ++++++++++++++++--
 src/interface/efi/efi_cmdline.c |  2 ++
 src/tests/asn1_test.h           |  1 +
 src/tests/cms_test.c            |  3 +++
 src/tests/pixbuf_test.h         |  1 +
 src/tests/test.c                |  1 +
 9 files changed, 68 insertions(+), 8 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/runtime.c b/src/arch/x86/core/runtime.c
index 461188d04..86083b1f9 100644
--- a/src/arch/x86/core/runtime.c
+++ b/src/arch/x86/core/runtime.c
@@ -70,6 +70,7 @@ static void cmdline_image_free ( struct refcnt *refcnt ) {
 	struct image *image = container_of ( refcnt, struct image, refcnt );
 
 	DBGC ( image, "RUNTIME freeing command line\n" );
+	free_image ( refcnt );
 	free ( cmdline_copy );
 }
 
@@ -77,6 +78,7 @@ static void cmdline_image_free ( struct refcnt *refcnt ) {
 static struct image cmdline_image = {
 	.refcnt = REF_INIT ( cmdline_image_free ),
 	.name = "<CMDLINE>",
+	.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),
 	.type = &script_image_type,
 };
 
diff --git a/src/core/image.c b/src/core/image.c
index 72885ec09..4f92dfe57 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -76,22 +76,41 @@ static int require_trusted_images_permanent = 0;
  * Free executable image
  *
  * @v refcnt		Reference counter
+ *
+ * Image consumers must call image_put() rather than calling
+ * free_image() directly.  This function is exposed for use only by
+ * static images.
  */
-static void free_image ( struct refcnt *refcnt ) {
+void free_image ( struct refcnt *refcnt ) {
 	struct image *image = container_of ( refcnt, struct image, refcnt );
 	struct image_tag *tag;
 
+	/* Sanity check: free_image() should not be called directly on
+	 * dynamically allocated images.
+	 */
+	assert ( refcnt->count < 0 );
 	DBGC ( image, "IMAGE %s freed\n", image->name );
+
+	/* Clear any tag weak references */
 	for_each_table_entry ( tag, IMAGE_TAGS ) {
 		if ( tag->image == image )
 			tag->image = NULL;
 	}
-	free ( image->name );
+
+	/* Free dynamic allocations used by both static and dynamic images */
 	free ( image->cmdline );
 	uri_put ( image->uri );
-	ufree ( image->data );
 	image_put ( image->replacement );
-	free ( image );
+
+	/* Free image name, if dynamically allocated */
+	if ( ! ( image->flags & IMAGE_STATIC_NAME ) )
+		free ( image->name );
+
+	/* Free image data and image itself, if dynamically allocated */
+	if ( ! ( image->flags & IMAGE_STATIC ) ) {
+		ufree ( image->data );
+		free ( image );
+	}
 }
 
 /**
@@ -165,9 +184,13 @@ int image_set_name ( struct image *image, const char *name ) {
 	if ( ! name_copy )
 		return -ENOMEM;
 
+	/* Free existing name, if not statically allocated */
+	if ( ! ( image->flags & IMAGE_STATIC_NAME ) )
+		free ( image->name );
+
 	/* Replace existing name */
-	free ( image->name );
 	image->name = name_copy;
+	image->flags &= ~IMAGE_STATIC_NAME;
 
 	return 0;
 }
@@ -220,6 +243,10 @@ int image_set_cmdline ( struct image *image, const char *cmdline ) {
 int image_set_len ( struct image *image, size_t len ) {
 	void *new;
 
+	/* Refuse to reallocate static images */
+	if ( image->flags & IMAGE_STATIC )
+		return -ENOTTY;
+
 	/* (Re)allocate image data */
 	new = urealloc ( image->data, len );
 	if ( ! new )
@@ -288,6 +315,13 @@ int register_image ( struct image *image ) {
 	char name[8]; /* "imgXXXX" */
 	int rc;
 
+	/* Sanity checks */
+	if ( image->flags & IMAGE_STATIC ) {
+		assert ( ( image->name == NULL ) ||
+			 ( image->flags & IMAGE_STATIC_NAME ) );
+		assert ( image->cmdline == NULL );
+	}
+
 	/* Create image name if it doesn't already have one */
 	if ( ! image->name ) {
 		snprintf ( name, sizeof ( name ), "img%d", imgindex++ );
diff --git a/src/image/embedded.c b/src/image/embedded.c
index 58833ac30..028f49308 100644
--- a/src/image/embedded.c
+++ b/src/image/embedded.c
@@ -31,8 +31,9 @@ EMBED_ALL
 /* Image structures for all embedded images */
 #undef EMBED
 #define EMBED( _index, _path, _name ) {					\
-	.refcnt = REF_INIT ( ref_no_free ),				\
+	.refcnt = REF_INIT ( free_image ),				\
 	.name = _name,							\
+	.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),			\
 	.data = ( userptr_t ) ( embedded_image_ ## _index ## _data ),	\
 	.len = ( size_t ) embedded_image_ ## _index ## _len,		\
 },
diff --git a/src/include/ipxe/image.h b/src/include/ipxe/image.h
index bf2d77626..8ff938a17 100644
--- a/src/include/ipxe/image.h
+++ b/src/include/ipxe/image.h
@@ -30,14 +30,22 @@ struct image {
 
 	/** URI of image */
 	struct uri *uri;
-	/** Name */
+	/** Name
+	 *
+	 * If the @c IMAGE_STATIC_NAME flag is set, then this is a
+	 * statically allocated string.
+	 */
 	char *name;
 	/** Flags */
 	unsigned int flags;
 
 	/** Command line to pass to image */
 	char *cmdline;
-	/** Raw file image */
+	/** Raw file image
+	 *
+	 * If the @c IMAGE_STATIC flag is set, then this is a
+	 * statically allocated image.
+	 */
 	void *data;
 	/** Length of raw file image */
 	size_t len;
@@ -72,6 +80,12 @@ struct image {
 /** Image will be hidden from enumeration */
 #define IMAGE_HIDDEN 0x0008
 
+/** Image is statically allocated */
+#define IMAGE_STATIC 0x0010
+
+/** Image name is statically allocated */
+#define IMAGE_STATIC_NAME 0x0020
+
 /** An executable image type */
 struct image_type {
 	/** Name of this image type */
@@ -185,6 +199,7 @@ static inline struct image * first_image ( void ) {
 	return list_first_entry ( &images, struct image, list );
 }
 
+extern void free_image ( struct refcnt *refcnt );
 extern struct image * alloc_image ( struct uri *uri );
 extern int image_set_uri ( struct image *image, struct uri *uri );
 extern int image_set_name ( struct image *image, const char *name );
diff --git a/src/interface/efi/efi_cmdline.c b/src/interface/efi/efi_cmdline.c
index 13ad0fc35..59bce925f 100644
--- a/src/interface/efi/efi_cmdline.c
+++ b/src/interface/efi/efi_cmdline.c
@@ -58,6 +58,7 @@ static void efi_cmdline_free ( struct refcnt *refcnt ) {
 	struct image *image = container_of ( refcnt, struct image, refcnt );
 
 	DBGC ( image, "CMDLINE freeing command line\n" );
+	free_image ( refcnt );
 	free ( efi_cmdline_copy );
 }
 
@@ -65,6 +66,7 @@ static void efi_cmdline_free ( struct refcnt *refcnt ) {
 static struct image efi_cmdline_image = {
 	.refcnt = REF_INIT ( efi_cmdline_free ),
 	.name = "<CMDLINE>",
+	.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),
 	.type = &script_image_type,
 };
 
diff --git a/src/tests/asn1_test.h b/src/tests/asn1_test.h
index c8167ed36..f69a4bf2a 100644
--- a/src/tests/asn1_test.h
+++ b/src/tests/asn1_test.h
@@ -46,6 +46,7 @@ struct asn1_test {
 	static struct image _name ## __image = {			\
 		.refcnt = REF_INIT ( ref_no_free ),			\
 		.name = #_name,						\
+		.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),		\
 		.data = ( userptr_t ) ( _name ## __file ),		\
 		.len = sizeof ( _name ## __file ),			\
 	};								\
diff --git a/src/tests/cms_test.c b/src/tests/cms_test.c
index 5e186cdf0..f80fbaa86 100644
--- a/src/tests/cms_test.c
+++ b/src/tests/cms_test.c
@@ -85,6 +85,7 @@ struct cms_test_keypair {
 		.image = {						\
 			.refcnt = REF_INIT ( ref_no_free ),		\
 			.name = #NAME,					\
+			.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),	\
 			.data = ( userptr_t ) ( NAME ## _data ),	\
 			.len = sizeof ( NAME ## _data ),		\
 		},							\
@@ -97,6 +98,7 @@ struct cms_test_keypair {
 		.image = {						\
 			.refcnt = REF_INIT ( ref_no_free ),		\
 			.name = #NAME,					\
+			.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),	\
 			.data = ( userptr_t ) ( NAME ## _data ),	\
 			.len = sizeof ( NAME ## _data ),		\
 		},							\
@@ -109,6 +111,7 @@ struct cms_test_keypair {
 		.image = {						\
 			.refcnt = REF_INIT ( ref_no_free ),		\
 			.name = #NAME,					\
+			.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),	\
 			.type = &der_image_type,			\
 			.data = ( userptr_t ) ( NAME ## _data ),	\
 			.len = sizeof ( NAME ## _data ),		\
diff --git a/src/tests/pixbuf_test.h b/src/tests/pixbuf_test.h
index d12829d89..991c16ba3 100644
--- a/src/tests/pixbuf_test.h
+++ b/src/tests/pixbuf_test.h
@@ -41,6 +41,7 @@ struct pixel_buffer_test {
 	static struct image _name ## __image = {			\
 		.refcnt = REF_INIT ( ref_no_free ),			\
 		.name = #_name,						\
+		.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),		\
 		.data = ( userptr_t ) ( _name ## __file ),		\
 		.len = sizeof ( _name ## __file ),			\
 	};								\
diff --git a/src/tests/test.c b/src/tests/test.c
index 1ec4b21ef..9fa12e27a 100644
--- a/src/tests/test.c
+++ b/src/tests/test.c
@@ -162,6 +162,7 @@ static struct image_type test_image_type = {
 static struct image test_image = {
 	.refcnt = REF_INIT ( ref_no_free ),
 	.name = "<TESTS>",
+	.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),
 	.type = &test_image_type,
 };
 
-- 
cgit v1.2.3-55-g7522


From 05ad7833c51c942a5cb91540a054852bb991333b Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 30 Apr 2025 14:14:51 +0100
Subject: [image] Make image data read-only to most consumers

Almost all image consumers do not need to modify the content of the
image.  Now that the image data is a pointer type (rather than the
opaque userptr_t type), we can rely on the compiler to enforce this at
build time.

Change the .data field to be a const pointer, so that the compiler can
verify that image consumers do not modify the image content.  Provide
a transparent .rwdata field for consumers who have a legitimate (and
now explicit) reason to modify the image content.

We do not attempt to impose any runtime restriction on checking
whether or not an image is writable.  The only existing instances of
genuinely read-only images are the various unit test images, and it is
acceptable for defective test cases to result in a segfault rather
than a runtime error.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/image/initrd.c     | 11 +++++------
 src/arch/x86/image/sdi.c        |  2 +-
 src/core/fdt.c                  |  2 +-
 src/core/image.c                |  8 ++++----
 src/crypto/cms.c                |  6 +++---
 src/image/efi_image.c           | 18 ++++++++++++++----
 src/image/embedded.c            | 13 +------------
 src/image/zlib.c                |  3 ++-
 src/include/ipxe/image.h        |  7 ++++++-
 src/interface/efi/efi_cmdline.c |  2 +-
 src/tests/asn1_test.c           |  3 ---
 src/tests/asn1_test.h           |  2 +-
 src/tests/cms_test.c            | 32 +++-----------------------------
 src/tests/pixbuf_test.c         |  7 ++-----
 src/tests/pixbuf_test.h         |  2 +-
 15 files changed, 45 insertions(+), 73 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/image/initrd.c b/src/arch/x86/image/initrd.c
index cb4879036..98c7a3804 100644
--- a/src/arch/x86/image/initrd.c
+++ b/src/arch/x86/image/initrd.c
@@ -63,10 +63,9 @@ static physaddr_t initrd_squash_high ( physaddr_t top ) {
 		/* Find the highest image not yet in its final position */
 		highest = NULL;
 		for_each_image ( initrd ) {
-			data = initrd->data;
-			if ( ( virt_to_phys ( data ) < current ) &&
+			if ( ( virt_to_phys ( initrd->data ) < current ) &&
 			     ( ( highest == NULL ) ||
-			       ( virt_to_phys ( data ) >
+			       ( virt_to_phys ( initrd->data ) >
 				 virt_to_phys ( highest->data ) ) ) ) {
 				highest = initrd;
 			}
@@ -144,9 +143,9 @@ static void initrd_swap ( struct image *low, struct image *high,
 
 		/* Swap fragments */
 		memcpy ( free, ( high->data + len ), frag_len );
-		memmove ( ( low->data + new_len ), ( low->data + len ),
+		memmove ( ( low->rwdata + new_len ), ( low->data + len ),
 			  low->len );
-		memcpy ( ( low->data + len ), free, frag_len );
+		memcpy ( ( low->rwdata + len ), free, frag_len );
 		len = new_len;
 	}
 
@@ -165,8 +164,8 @@ static void initrd_swap ( struct image *low, struct image *high,
 static int initrd_swap_any ( void *free, size_t free_len ) {
 	struct image *low;
 	struct image *high;
+	const void *adjacent;
 	size_t padded_len;
-	void *adjacent;
 
 	/* Find any pair of initrds that can be swapped */
 	for_each_image ( low ) {
diff --git a/src/arch/x86/image/sdi.c b/src/arch/x86/image/sdi.c
index cdfdeb369..c0cded239 100644
--- a/src/arch/x86/image/sdi.c
+++ b/src/arch/x86/image/sdi.c
@@ -51,7 +51,7 @@ FEATURE ( FEATURE_IMAGE, "SDI", DHCP_EB_FEATURE_SDI, 1 );
  * @ret rc		Return status code
  */
 static int sdi_exec ( struct image *image ) {
-	struct sdi_header *sdi;
+	const struct sdi_header *sdi;
 	uint32_t sdiptr;
 
 	/* Sanity check */
diff --git a/src/core/fdt.c b/src/core/fdt.c
index 7c7127aed..744e0e705 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -734,7 +734,7 @@ static int fdt_parse_image ( struct fdt *fdt, struct image *image ) {
 	int rc;
 
 	/* Parse image */
-	if ( ( rc = fdt_parse ( fdt, image->data, image->len ) ) != 0 ) {
+	if ( ( rc = fdt_parse ( fdt, image->rwdata, image->len ) ) != 0 ) {
 		DBGC ( fdt, "FDT image \"%s\" is invalid: %s\n",
 		       image->name, strerror ( rc ) );
 		return rc;
diff --git a/src/core/image.c b/src/core/image.c
index 4f92dfe57..a06466b72 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -108,7 +108,7 @@ void free_image ( struct refcnt *refcnt ) {
 
 	/* Free image data and image itself, if dynamically allocated */
 	if ( ! ( image->flags & IMAGE_STATIC ) ) {
-		ufree ( image->data );
+		ufree ( image->rwdata );
 		free ( image );
 	}
 }
@@ -248,10 +248,10 @@ int image_set_len ( struct image *image, size_t len ) {
 		return -ENOTTY;
 
 	/* (Re)allocate image data */
-	new = urealloc ( image->data, len );
+	new = urealloc ( image->rwdata, len );
 	if ( ! new )
 		return -ENOMEM;
-	image->data = new;
+	image->rwdata = new;
 	image->len = len;
 
 	return 0;
@@ -273,7 +273,7 @@ int image_set_data ( struct image *image, const void *data, size_t len ) {
 		return rc;
 
 	/* Copy in new image data */
-	memcpy ( image->data, data, len );
+	memcpy ( image->rwdata, data, len );
 
 	return 0;
 }
diff --git a/src/crypto/cms.c b/src/crypto/cms.c
index 36b87c644..edfcc7fdc 100644
--- a/src/crypto/cms.c
+++ b/src/crypto/cms.c
@@ -1079,7 +1079,7 @@ int cms_decrypt ( struct cms_message *cms, struct image *image,
 	final_len = ( ( image->len && is_block_cipher ( cipher ) ) ?
 		      cipher->blocksize : 0 );
 	bulk_len = ( image->len - final_len );
-	cipher_decrypt ( cipher, ctx, image->data, image->data, bulk_len );
+	cipher_decrypt ( cipher, ctx, image->data, image->rwdata, bulk_len );
 
 	/* Decrypt final block */
 	cipher_decrypt ( cipher, ctx, ( image->data + bulk_len ), final,
@@ -1117,7 +1117,7 @@ int cms_decrypt ( struct cms_message *cms, struct image *image,
 	 * have to include include any error-handling code path to
 	 * reconstruct the block padding.
 	 */
-	memcpy ( ( image->data + bulk_len ), final, final_len );
+	memcpy ( ( image->rwdata + bulk_len ), final, final_len );
 	image->len -= pad_len;
 
 	/* Clear image type and re-register image, if applicable */
@@ -1137,7 +1137,7 @@ int cms_decrypt ( struct cms_message *cms, struct image *image,
 	 * containing the potentially invalid (and therefore
 	 * unreproducible) block padding.
 	 */
-	cipher_encrypt ( cipher, ctxdup, image->data, image->data, bulk_len );
+	cipher_encrypt ( cipher, ctxdup, image->data, image->rwdata, bulk_len );
 	if ( original_flags & IMAGE_REGISTERED ) {
 		register_image ( image ); /* Cannot fail on re-registration */
 		image_put ( image );
diff --git a/src/image/efi_image.c b/src/image/efi_image.c
index f7ee7ff50..e7b19c4ce 100644
--- a/src/image/efi_image.c
+++ b/src/image/efi_image.c
@@ -243,10 +243,15 @@ static int efi_image_exec ( struct image *image ) {
 		goto err_shim_install;
 	}
 
-	/* Attempt loading image */
+	/* Attempt loading image
+	 *
+	 * LoadImage() does not (allegedly) modify the image content,
+	 * but requires a non-const pointer to SourceBuffer.  We
+	 * therefore use the .rwdata field rather than .data.
+	 */
 	handle = NULL;
 	if ( ( efirc = bs->LoadImage ( FALSE, efi_image_handle, path,
-				       exec->data, exec->len,
+				       exec->rwdata, exec->len,
 				       &handle ) ) != 0 ) {
 		/* Not an EFI image */
 		rc = -EEFI_LOAD ( efirc );
@@ -377,10 +382,15 @@ static int efi_image_probe ( struct image *image ) {
 	EFI_STATUS efirc;
 	int rc;
 
-	/* Attempt loading image */
+	/* Attempt loading image
+	 *
+	 * LoadImage() does not (allegedly) modify the image content,
+	 * but requires a non-const pointer to SourceBuffer.  We
+	 * therefore use the .rwdata field rather than .data.
+	 */
 	handle = NULL;
 	if ( ( efirc = bs->LoadImage ( FALSE, efi_image_handle, &empty_path,
-				       image->data, image->len,
+				       image->rwdata, image->len,
 				       &handle ) ) != 0 ) {
 		/* Not an EFI image */
 		rc = -EEFI_LOAD ( efirc );
diff --git a/src/image/embedded.c b/src/image/embedded.c
index 028f49308..76d256c9b 100644
--- a/src/image/embedded.c
+++ b/src/image/embedded.c
@@ -10,7 +10,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <string.h>
 #include <ipxe/image.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/init.h>
 
 /* Raw image data for all embedded images */
@@ -34,7 +33,7 @@ EMBED_ALL
 	.refcnt = REF_INIT ( free_image ),				\
 	.name = _name,							\
 	.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),			\
-	.data = ( userptr_t ) ( embedded_image_ ## _index ## _data ),	\
+	.rwdata = embedded_image_ ## _index ## _data,			\
 	.len = ( size_t ) embedded_image_ ## _index ## _len,		\
 },
 static struct image embedded_images[] = {
@@ -58,18 +57,8 @@ static void embedded_init ( void ) {
 	for ( i = 0 ; i < ( int ) ( sizeof ( embedded_images ) /
 				    sizeof ( embedded_images[0] ) ) ; i++ ) {
 		image = &embedded_images[i];
-
-		/* virt_to_user() cannot be used in a static
-		 * initialiser, so we cast the pointer to a userptr_t
-		 * in the initialiser and fix it up here.  (This will
-		 * actually be a no-op on most platforms.)
-		 */
-		data = ( ( void * ) image->data );
-		image->data = virt_to_user ( data );
-
 		DBG ( "Embedded image \"%s\": %zd bytes at %p\n",
 		      image->name, image->len, data );
-
 		if ( ( rc = register_image ( image ) ) != 0 ) {
 			DBG ( "Could not register embedded image \"%s\": "
 			      "%s\n", image->name, strerror ( rc ) );
diff --git a/src/image/zlib.c b/src/image/zlib.c
index d7deee88b..23eb50e7d 100644
--- a/src/image/zlib.c
+++ b/src/image/zlib.c
@@ -65,7 +65,8 @@ int zlib_deflate ( enum deflate_format format, const void *data, size_t len,
 		deflate_init ( deflate, format );
 
 		/* Initialise output chunk */
-		deflate_chunk_init ( &out, extracted->data, 0, extracted->len );
+		deflate_chunk_init ( &out, extracted->rwdata, 0,
+				     extracted->len );
 
 		/* Decompress data */
 		if ( ( rc = deflate_inflate ( deflate, data, len,
diff --git a/src/include/ipxe/image.h b/src/include/ipxe/image.h
index 8ff938a17..fbf2b63b9 100644
--- a/src/include/ipxe/image.h
+++ b/src/include/ipxe/image.h
@@ -46,7 +46,12 @@ struct image {
 	 * If the @c IMAGE_STATIC flag is set, then this is a
 	 * statically allocated image.
 	 */
-	void *data;
+	union {
+		/** Read-only data */
+		const void *data;
+		/** Writable data */
+		void *rwdata;
+	};
 	/** Length of raw file image */
 	size_t len;
 
diff --git a/src/interface/efi/efi_cmdline.c b/src/interface/efi/efi_cmdline.c
index 59bce925f..d5ec6cee3 100644
--- a/src/interface/efi/efi_cmdline.c
+++ b/src/interface/efi/efi_cmdline.c
@@ -113,7 +113,7 @@ static int efi_cmdline_init ( void ) {
 	DBGC ( colour, "CMDLINE using command line \"%s\"\n", cmdline );
 
 	/* Prepare and register image */
-	efi_cmdline_image.data = virt_to_user ( cmdline );
+	efi_cmdline_image.data = cmdline;
 	efi_cmdline_image.len = strlen ( cmdline );
 	if ( efi_cmdline_image.len &&
 	     ( ( rc = register_image ( &efi_cmdline_image ) ) != 0 ) ) {
diff --git a/src/tests/asn1_test.c b/src/tests/asn1_test.c
index b522b85d7..4760b97fb 100644
--- a/src/tests/asn1_test.c
+++ b/src/tests/asn1_test.c
@@ -59,9 +59,6 @@ void asn1_okx ( struct asn1_test *test, const char *file, unsigned int line ) {
 	/* Sanity check */
 	assert ( sizeof ( out ) == digest->digestsize );
 
-	/* Correct image data pointer */
-	test->image->data = virt_to_user ( ( void * ) test->image->data );
-
 	/* Check that image is detected as correct type */
 	okx ( register_image ( test->image ) == 0, file, line );
 	okx ( test->image->type == test->type, file, line );
diff --git a/src/tests/asn1_test.h b/src/tests/asn1_test.h
index f69a4bf2a..f8310f5ba 100644
--- a/src/tests/asn1_test.h
+++ b/src/tests/asn1_test.h
@@ -47,7 +47,7 @@ struct asn1_test {
 		.refcnt = REF_INIT ( ref_no_free ),			\
 		.name = #_name,						\
 		.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),		\
-		.data = ( userptr_t ) ( _name ## __file ),		\
+		.data = _name ## __file,				\
 		.len = sizeof ( _name ## __file ),			\
 	};								\
 	static struct asn1_test_digest _name ## _expected[] = {		\
diff --git a/src/tests/cms_test.c b/src/tests/cms_test.c
index f80fbaa86..b71190cba 100644
--- a/src/tests/cms_test.c
+++ b/src/tests/cms_test.c
@@ -37,7 +37,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/sha256.h>
 #include <ipxe/x509.h>
 #include <ipxe/image.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/der.h>
 #include <ipxe/cms.h>
 #include <ipxe/privkey.h>
@@ -86,7 +85,7 @@ struct cms_test_keypair {
 			.refcnt = REF_INIT ( ref_no_free ),		\
 			.name = #NAME,					\
 			.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),	\
-			.data = ( userptr_t ) ( NAME ## _data ),	\
+			.data = NAME ## _data,				\
 			.len = sizeof ( NAME ## _data ),		\
 		},							\
 	}
@@ -99,7 +98,7 @@ struct cms_test_keypair {
 			.refcnt = REF_INIT ( ref_no_free ),		\
 			.name = #NAME,					\
 			.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),	\
-			.data = ( userptr_t ) ( NAME ## _data ),	\
+			.data = NAME ## _data,				\
 			.len = sizeof ( NAME ## _data ),		\
 		},							\
 	}
@@ -113,7 +112,7 @@ struct cms_test_keypair {
 			.name = #NAME,					\
 			.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),	\
 			.type = &der_image_type,			\
-			.data = ( userptr_t ) ( NAME ## _data ),	\
+			.data = NAME ## _data,				\
 			.len = sizeof ( NAME ## _data ),		\
 		},							\
 	}
@@ -1652,16 +1651,9 @@ static time_t test_expired = 1375573111ULL; /* Sat Aug  3 23:38:31 2013 */
  */
 static void cms_message_okx ( struct cms_test_message *msg,
 			      const char *file, unsigned int line ) {
-	const void *data = ( ( void * ) msg->image.data );
-
-	/* Fix up image data pointer */
-	msg->image.data = virt_to_user ( data );
 
 	/* Check ability to parse message */
 	okx ( cms_message ( &msg->image, &msg->cms ) == 0, file, line );
-
-	/* Reset image data pointer */
-	msg->image.data = ( ( userptr_t ) data );
 }
 #define cms_message_ok( msg ) \
 	cms_message_okx ( msg, __FILE__, __LINE__ )
@@ -1705,10 +1697,6 @@ static void cms_verify_okx ( struct cms_test_message *msg,
 			     time_t time, struct x509_chain *store,
 			     struct x509_root *root, const char *file,
 			     unsigned int line ) {
-	const void *data = ( ( void * ) img->image.data );
-
-	/* Fix up image data pointer */
-	img->image.data = virt_to_user ( data );
 
 	/* Invalidate any certificates from previous tests */
 	x509_invalidate_chain ( msg->cms->certificates );
@@ -1717,9 +1705,6 @@ static void cms_verify_okx ( struct cms_test_message *msg,
 	okx ( cms_verify ( msg->cms, &img->image, name, time, store,
 			   root ) == 0, file, line );
 	okx ( img->image.flags & IMAGE_TRUSTED, file, line );
-
-	/* Reset image data pointer */
-	img->image.data = ( ( userptr_t ) data );
 }
 #define cms_verify_ok( msg, img, name, time, store, root )		\
 	cms_verify_okx ( msg, img, name, time, store, root,		\
@@ -1742,10 +1727,6 @@ static void cms_verify_fail_okx ( struct cms_test_message *msg,
 				  time_t time, struct x509_chain *store,
 				  struct x509_root *root, const char *file,
 				  unsigned int line ) {
-	const void *data = ( ( void * ) img->image.data );
-
-	/* Fix up image data pointer */
-	img->image.data = virt_to_user ( data );
 
 	/* Invalidate any certificates from previous tests */
 	x509_invalidate_chain ( msg->cms->certificates );
@@ -1754,9 +1735,6 @@ static void cms_verify_fail_okx ( struct cms_test_message *msg,
 	okx ( cms_verify ( msg->cms, &img->image, name, time, store,
 			   root ) != 0, file, line );
 	okx ( ! ( img->image.flags & IMAGE_TRUSTED ), file, line );
-
-	/* Reset image data pointer */
-	img->image.data = ( ( userptr_t ) data );
 }
 #define cms_verify_fail_ok( msg, img, name, time, store, root )	\
 	cms_verify_fail_okx ( msg, img, name, time, store, root,	\
@@ -1777,10 +1755,6 @@ static void cms_decrypt_okx ( struct cms_test_image *img,
 			      struct cms_test_keypair *keypair,
 			      struct cms_test_image *expected,
 			      const char *file, unsigned int line ) {
-	const void *data = ( ( void * ) img->image.data );
-
-	/* Fix up image data pointer */
-	img->image.data = virt_to_user ( data );
 
 	/* Check ability to decrypt image */
 	okx ( cms_decrypt ( envelope->cms, &img->image, NULL,
diff --git a/src/tests/pixbuf_test.c b/src/tests/pixbuf_test.c
index a8ea1151e..cbc3a7617 100644
--- a/src/tests/pixbuf_test.c
+++ b/src/tests/pixbuf_test.c
@@ -55,9 +55,6 @@ void pixbuf_okx ( struct pixel_buffer_test *test, const char *file,
 	assert ( ( test->width * test->height * sizeof ( test->data[0] ) )
 		 == test->len );
 
-	/* Correct image data pointer */
-	test->image->data = virt_to_user ( ( void * ) test->image->data );
-
 	/* Check that image is detected as correct type */
 	okx ( register_image ( test->image ) == 0, file, line );
 	okx ( test->image->type == test->type, file, line );
@@ -72,8 +69,8 @@ void pixbuf_okx ( struct pixel_buffer_test *test, const char *file,
 
 		/* Check pixel buffer data */
 		okx ( pixbuf->len == test->len, file, line );
-		okx ( memcmp ( pixbuf->data, virt_to_user ( test->data ),
-			       test->len ) == 0, file, line );
+		okx ( memcmp ( pixbuf->data, test->data, test->len ) == 0,
+		      file, line );
 
 		pixbuf_put ( pixbuf );
 	}
diff --git a/src/tests/pixbuf_test.h b/src/tests/pixbuf_test.h
index 991c16ba3..cf3d548f9 100644
--- a/src/tests/pixbuf_test.h
+++ b/src/tests/pixbuf_test.h
@@ -42,7 +42,7 @@ struct pixel_buffer_test {
 		.refcnt = REF_INIT ( ref_no_free ),			\
 		.name = #_name,						\
 		.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),		\
-		.data = ( userptr_t ) ( _name ## __file ),		\
+		.data = _name ## __file,				\
 		.len = sizeof ( _name ## __file ),			\
 	};								\
 	static struct pixel_buffer_test _name = {			\
-- 
cgit v1.2.3-55-g7522


From a169d73593f6c471857a694edc22809608c7d9c0 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 30 Apr 2025 14:33:57 +0100
Subject: [uaccess] Reduce scope of included uaccess.h header

The uaccess.h header is no longer required for any code that touches
external ("user") memory, since such memory accesses are now performed
through pointer dereferences.  Reduce the number of files including
this header.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/image/elfboot.c          | 1 +
 src/arch/x86/image/pxe_image.c        | 1 -
 src/arch/x86/interface/pxe/pxe_file.c | 1 -
 src/core/cachedhcp.c                  | 1 +
 src/core/downloader.c                 | 1 -
 src/core/fbcon.c                      | 1 +
 src/core/image.c                      | 1 +
 src/drivers/bus/ecam.c                | 1 -
 src/hci/commands/image_mem_cmd.c      | 1 +
 src/image/elf.c                       | 1 +
 src/include/ipxe/dhcp.h               | 1 -
 src/include/ipxe/image.h              | 1 -
 src/include/ipxe/iomap.h              | 1 -
 src/include/ipxe/iomap_virt.h         | 1 +
 src/include/ipxe/xen.h                | 1 -
 src/interface/efi/efi_cmdline.c       | 1 +
 src/net/pccrc.c                       | 1 -
 src/usr/imgtrust.c                    | 1 -
 18 files changed, 8 insertions(+), 10 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/image/elfboot.c b/src/arch/x86/image/elfboot.c
index f662e366f..7f89e8b65 100644
--- a/src/arch/x86/image/elfboot.c
+++ b/src/arch/x86/image/elfboot.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/elf.h>
 #include <ipxe/features.h>
 #include <ipxe/init.h>
+#include <ipxe/uaccess.h>
 
 /**
  * @file
diff --git a/src/arch/x86/image/pxe_image.c b/src/arch/x86/image/pxe_image.c
index 3e6cf7268..ccb3a7d9d 100644
--- a/src/arch/x86/image/pxe_image.c
+++ b/src/arch/x86/image/pxe_image.c
@@ -34,7 +34,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <pxe.h>
 #include <pxe_call.h>
 #include <pic8259.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/image.h>
 #include <ipxe/segment.h>
 #include <ipxe/netdevice.h>
diff --git a/src/arch/x86/interface/pxe/pxe_file.c b/src/arch/x86/interface/pxe/pxe_file.c
index b934e8fef..997667ccf 100644
--- a/src/arch/x86/interface/pxe/pxe_file.c
+++ b/src/arch/x86/interface/pxe/pxe_file.c
@@ -8,7 +8,6 @@
 #include <stdio.h>
 #include <errno.h>
 #include <byteswap.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/posix_io.h>
 #include <ipxe/features.h>
 #include <pxe.h>
diff --git a/src/core/cachedhcp.c b/src/core/cachedhcp.c
index 1510f3321..eeb2fca58 100644
--- a/src/core/cachedhcp.c
+++ b/src/core/cachedhcp.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/init.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/vlan.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/cachedhcp.h>
 
 /** @file
diff --git a/src/core/downloader.c b/src/core/downloader.c
index 9950fe5e4..1c638f502 100644
--- a/src/core/downloader.c
+++ b/src/core/downloader.c
@@ -31,7 +31,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/xfer.h>
 #include <ipxe/open.h>
 #include <ipxe/job.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/image.h>
 #include <ipxe/xferbuf.h>
diff --git a/src/core/fbcon.c b/src/core/fbcon.c
index 43f73fbac..ef158aec7 100644
--- a/src/core/fbcon.c
+++ b/src/core/fbcon.c
@@ -36,6 +36,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/ansiesc.h>
 #include <ipxe/image.h>
 #include <ipxe/pixbuf.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/console.h>
 #include <ipxe/fbcon.h>
diff --git a/src/core/image.c b/src/core/image.c
index a06466b72..b2bd0956b 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -33,6 +33,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <libgen.h>
 #include <syslog.h>
 #include <ipxe/list.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/uri.h>
 #include <ipxe/image.h>
diff --git a/src/drivers/bus/ecam.c b/src/drivers/bus/ecam.c
index 35556a8d9..976254c18 100644
--- a/src/drivers/bus/ecam.c
+++ b/src/drivers/bus/ecam.c
@@ -25,7 +25,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <string.h>
 #include <errno.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/ecam.h>
 
 /** @file
diff --git a/src/hci/commands/image_mem_cmd.c b/src/hci/commands/image_mem_cmd.c
index 5f8363461..fcd766627 100644
--- a/src/hci/commands/image_mem_cmd.c
+++ b/src/hci/commands/image_mem_cmd.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <getopt.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/command.h>
 #include <ipxe/parseopt.h>
 #include <usr/imgmgmt.h>
diff --git a/src/image/elf.c b/src/image/elf.c
index 97e07f37f..8cbb610a6 100644
--- a/src/image/elf.c
+++ b/src/image/elf.c
@@ -38,6 +38,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <elf.h>
 #include <ipxe/segment.h>
 #include <ipxe/image.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/elf.h>
 
 /**
diff --git a/src/include/ipxe/dhcp.h b/src/include/ipxe/dhcp.h
index 51349efd9..4d68d3ca5 100644
--- a/src/include/ipxe/dhcp.h
+++ b/src/include/ipxe/dhcp.h
@@ -17,7 +17,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/tables.h>
 #include <ipxe/uuid.h>
 #include <ipxe/netdevice.h>
-#include <ipxe/uaccess.h>
 
 struct interface;
 struct dhcp_options;
diff --git a/src/include/ipxe/image.h b/src/include/ipxe/image.h
index fbf2b63b9..e0e70f360 100644
--- a/src/include/ipxe/image.h
+++ b/src/include/ipxe/image.h
@@ -12,7 +12,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <ipxe/tables.h>
 #include <ipxe/list.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/refcnt.h>
 
 struct uri;
diff --git a/src/include/ipxe/iomap.h b/src/include/ipxe/iomap.h
index b8ded38ef..7d1547d9c 100644
--- a/src/include/ipxe/iomap.h
+++ b/src/include/ipxe/iomap.h
@@ -14,7 +14,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <ipxe/api.h>
 #include <config/ioapi.h>
-#include <ipxe/uaccess.h>
 
 /**
  * Calculate static inline I/O mapping API function name
diff --git a/src/include/ipxe/iomap_virt.h b/src/include/ipxe/iomap_virt.h
index 731d083d5..3dd66bd75 100644
--- a/src/include/ipxe/iomap_virt.h
+++ b/src/include/ipxe/iomap_virt.h
@@ -10,6 +10,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stddef.h>
+#include <ipxe/uaccess.h>
 
 #ifdef IOMAP_VIRT
 #define IOMAP_PREFIX_virt
diff --git a/src/include/ipxe/xen.h b/src/include/ipxe/xen.h
index 0fb8b7625..382901ff3 100644
--- a/src/include/ipxe/xen.h
+++ b/src/include/ipxe/xen.h
@@ -14,7 +14,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
 #include <ipxe/bitops.h>
-#include <ipxe/uaccess.h>
 #include <xen/xen.h>
 #include <xen/event_channel.h>
 
diff --git a/src/interface/efi/efi_cmdline.c b/src/interface/efi/efi_cmdline.c
index d5ec6cee3..8b9d8efde 100644
--- a/src/interface/efi/efi_cmdline.c
+++ b/src/interface/efi/efi_cmdline.c
@@ -37,6 +37,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/init.h>
 #include <ipxe/image.h>
 #include <ipxe/script.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/efi_cmdline.h>
 
diff --git a/src/net/pccrc.c b/src/net/pccrc.c
index 29adc4b16..0db6e3cb5 100644
--- a/src/net/pccrc.c
+++ b/src/net/pccrc.c
@@ -25,7 +25,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <errno.h>
 #include <assert.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/sha256.h>
 #include <ipxe/sha512.h>
 #include <ipxe/hmac.h>
diff --git a/src/usr/imgtrust.c b/src/usr/imgtrust.c
index 4eb631e79..e60854c9f 100644
--- a/src/usr/imgtrust.c
+++ b/src/usr/imgtrust.c
@@ -28,7 +28,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <errno.h>
 #include <time.h>
 #include <syslog.h>
-#include <ipxe/uaccess.h>
 #include <ipxe/image.h>
 #include <ipxe/cms.h>
 #include <ipxe/validator.h>
-- 
cgit v1.2.3-55-g7522


From 1534b0a6e9545d3a75ef6ca7cf0e4d89704582a2 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 30 Apr 2025 16:07:04 +0100
Subject: [uaccess] Remove redundant virt_to_user() and userptr_t

Remove the last remaining traces of the concept of a user pointer,
leaving iPXE with a simpler and cleaner memory model that implicitly
assumes that all memory locations can be reached through pointer
dereferences.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/librm.h           |  5 ----
 src/arch/x86/transitions/librm_mgmt.c  |  1 -
 src/core/uaccess.c                     |  1 -
 src/include/ipxe/linux/linux_uaccess.h |  8 -------
 src/include/ipxe/uaccess.h             | 42 ----------------------------------
 src/interface/linux/linux_uaccess.c    |  1 -
 6 files changed, 58 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index 22b7e3933..4fce7e8c8 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -126,11 +126,6 @@ UACCESS_INLINE ( librm, virt_to_phys ) ( volatile const void *virt ) {
 	return ( addr + virt_offset );
 }
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( librm, virt_to_user ) ( volatile const void *addr ) {
-	return trivial_virt_to_user ( addr );
-}
-
 /******************************************************************************
  *
  * Access to variables in .data16 and .text16
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index da5055cd8..14e00eda8 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -431,7 +431,6 @@ void setup_sipi ( unsigned int vector, uint32_t handler,
 
 PROVIDE_UACCESS_INLINE ( librm, phys_to_virt );
 PROVIDE_UACCESS_INLINE ( librm, virt_to_phys );
-PROVIDE_UACCESS_INLINE ( librm, virt_to_user );
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
 PROVIDE_IOMAP ( pages, ioremap, ioremap_pages );
 PROVIDE_IOMAP ( pages, iounmap, iounmap_pages );
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index bf922f66d..e73f4d7fb 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -34,4 +34,3 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /* Flat address space user access API */
 PROVIDE_UACCESS_INLINE ( flat, phys_to_virt );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_phys );
-PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index 7d5f5f642..a5d7d73f3 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -5,9 +5,6 @@
  *
  * iPXE user access API for Linux
  *
- * We run with no distinction between internal and external addresses,
- * so can use trivial_virt_to_user() et al.
- *
  * We have no concept of the underlying physical addresses, since
  * these are not exposed to userspace.  We provide a stub
  * implementation of virt_to_phys() since this is required by
@@ -57,9 +54,4 @@ UACCESS_INLINE ( linux, phys_to_virt ) ( physaddr_t phys ) {
 	return ( ( void * ) phys );
 }
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( linux, virt_to_user ) ( volatile const void *addr ) {
-	return trivial_virt_to_user ( addr );
-}
-
 #endif /* _IPXE_LINUX_UACCESS_H */
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 82f29f793..8d93cbf4f 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -20,35 +20,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define UACCESS_PREFIX_flat __flat_
 #endif
 
-/**
- * A pointer to a user buffer
- *
- */
-typedef void * userptr_t;
-
-/**
- * @defgroup uaccess_trivial Trivial user access API implementations
- *
- * User access API implementations that can be used by environments in
- * which virtual addresses allow access to all of memory.
- *
- * @{
- *
- */
-
-/**
- * Convert virtual address to user pointer
- *
- * @v addr		Virtual address
- * @ret userptr		User pointer
- */
-static inline __always_inline userptr_t
-trivial_virt_to_user ( volatile const void *addr ) {
-	return ( ( userptr_t ) addr );
-}
-
-/** @} */
-
 /**
  * Calculate static inline user access API function name
  *
@@ -88,25 +59,12 @@ UACCESS_INLINE ( flat, virt_to_phys ) ( volatile const void *virt ) {
 	return ( ( physaddr_t ) virt );
 }
 
-static inline __always_inline userptr_t
-UACCESS_INLINE ( flat, virt_to_user ) ( volatile const void *addr ) {
-	return trivial_virt_to_user ( addr );
-}
-
 /* Include all architecture-independent user access API headers */
 #include <ipxe/linux/linux_uaccess.h>
 
 /* Include all architecture-dependent user access API headers */
 #include <bits/uaccess.h>
 
-/**
- * Convert virtual address to user pointer
- *
- * @v addr		Virtual address
- * @ret userptr		User pointer
- */
-userptr_t virt_to_user ( volatile const void *addr );
-
 /**
  * Convert virtual address to a physical address
  *
diff --git a/src/interface/linux/linux_uaccess.c b/src/interface/linux/linux_uaccess.c
index 436707757..7f7f8931b 100644
--- a/src/interface/linux/linux_uaccess.c
+++ b/src/interface/linux/linux_uaccess.c
@@ -29,4 +29,3 @@ FILE_LICENCE(GPL2_OR_LATER);
 
 PROVIDE_UACCESS_INLINE(linux, phys_to_virt);
 PROVIDE_UACCESS_INLINE(linux, virt_to_phys);
-PROVIDE_UACCESS_INLINE(linux, virt_to_user);
-- 
cgit v1.2.3-55-g7522


From 0279015d09f2653f5c47e8ad2d2dc180180271d1 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 7 May 2025 23:02:40 +0100
Subject: [uaccess] Generalise librm's virt_offset mechanism for RISC-V

The virtual offset memory model used for i386-pcbios and x86_64-pcbios
can be generalised to also cover riscv32-sbi and riscv64-sbi.  In both
architectures, the 32-bit builds will use a circular map of the 32-bit
address space, and the 64-bit builds will use an identity map for the
relevant portion of the physical address space, with iPXE itself
placed in the negative (kernel) address space.

Generalise and document the virt_offset mechanism, and set it as the
default for both PCBIOS and SBI platforms.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/libprefix.S       |   7 ++
 src/arch/x86/image/elfboot.c            |   2 +-
 src/arch/x86/include/bits/uaccess.h     |  14 ----
 src/arch/x86/include/librm.h            |  53 ------------
 src/arch/x86/include/realmode.h         |   1 +
 src/arch/x86/interface/pcbios/bios_mp.c |   1 +
 src/arch/x86/transitions/librm_mgmt.c   |   2 -
 src/config/defaults/pcbios.h            |   2 +-
 src/config/defaults/sbi.h               |   2 +-
 src/core/virt_offset.c                  |  36 ++++++++
 src/include/ipxe/uaccess.h              |   1 +
 src/include/ipxe/virt_offset.h          | 140 ++++++++++++++++++++++++++++++++
 12 files changed, 189 insertions(+), 72 deletions(-)
 delete mode 100644 src/arch/x86/include/bits/uaccess.h
 create mode 100644 src/core/virt_offset.c
 create mode 100644 src/include/ipxe/virt_offset.h

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index 7f4e2bc98..c43a2b1b2 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -41,6 +41,13 @@ prefix_virt:
 	.dword	_prefix
 	.size	prefix_virt, . - prefix_virt
 
+	/* Current virtual address offset */
+	.section ".data.virt_offset", "aw", @progbits
+	.globl	virt_offset
+virt_offset:
+	.space	( __riscv_xlen / 8 )
+	.size	virt_offset, . - virt_offset
+
 /*****************************************************************************
  *
  * Print message to debug console
diff --git a/src/arch/x86/image/elfboot.c b/src/arch/x86/image/elfboot.c
index 7f89e8b65..d0f91d1c0 100644
--- a/src/arch/x86/image/elfboot.c
+++ b/src/arch/x86/image/elfboot.c
@@ -26,11 +26,11 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <string.h>
 #include <errno.h>
 #include <elf.h>
+#include <librm.h>
 #include <ipxe/image.h>
 #include <ipxe/elf.h>
 #include <ipxe/features.h>
 #include <ipxe/init.h>
-#include <ipxe/uaccess.h>
 
 /**
  * @file
diff --git a/src/arch/x86/include/bits/uaccess.h b/src/arch/x86/include/bits/uaccess.h
deleted file mode 100644
index e9e7e5af5..000000000
--- a/src/arch/x86/include/bits/uaccess.h
+++ /dev/null
@@ -1,14 +0,0 @@
-#ifndef _BITS_UACCESS_H
-#define _BITS_UACCESS_H
-
-/** @file
- *
- * x86-specific user access API implementations
- *
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#include <librm.h>
-
-#endif /* _BITS_UACCESS_H */
diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index 4fce7e8c8..cbe7d7134 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -64,12 +64,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #else /* ASSEMBLY */
 
-#ifdef UACCESS_LIBRM
-#define UACCESS_PREFIX_librm
-#else
-#define UACCESS_PREFIX_librm __librm_
-#endif
-
 /**
  * Call C function from real-mode code
  *
@@ -79,53 +73,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 	"pushl $( " _S2 ( VIRTUAL ( function ) ) " )\n\t"		\
 	"call virt_call\n\t"
 
-/* Variables in librm.S */
-extern const unsigned long virt_offset;
-
-/**
- * Convert physical address to user pointer
- *
- * @v phys		Physical address
- * @ret virt		Virtual address
- */
-static inline __always_inline void *
-UACCESS_INLINE ( librm, phys_to_virt ) ( unsigned long phys ) {
-
-	/* In a 64-bit build, any valid physical address is directly
-	 * usable as a virtual address, since the low 4GB is
-	 * identity-mapped.
-	 */
-	if ( sizeof ( physaddr_t ) > sizeof ( uint32_t ) )
-		return ( ( void * ) phys );
-
-	/* In a 32-bit build, subtract virt_offset */
-	return ( ( void * ) ( phys - virt_offset ) );
-}
-
-/**
- * Convert virtual address to physical address
- *
- * @v virt		Virtual address
- * @ret phys		Physical address
- */
-static inline __always_inline physaddr_t
-UACCESS_INLINE ( librm, virt_to_phys ) ( volatile const void *virt ) {
-	physaddr_t addr = ( ( physaddr_t ) virt );
-
-	/* In a 64-bit build, any virtual address in the low 4GB is
-	 * directly usable as a physical address, since the low 4GB is
-	 * identity-mapped.
-	 */
-	if ( ( sizeof ( physaddr_t ) > sizeof ( uint32_t ) ) &&
-	     ( addr <= 0xffffffffUL ) )
-		return addr;
-
-	/* In a 32-bit build or in a 64-bit build with a virtual
-	 * address above 4GB: add virt_offset
-	 */
-	return ( addr + virt_offset );
-}
-
 /******************************************************************************
  *
  * Access to variables in .data16 and .text16
diff --git a/src/arch/x86/include/realmode.h b/src/arch/x86/include/realmode.h
index 5cf644a23..7baec56ca 100644
--- a/src/arch/x86/include/realmode.h
+++ b/src/arch/x86/include/realmode.h
@@ -4,6 +4,7 @@
 #include <stdint.h>
 #include <string.h>
 #include <registers.h>
+#include <librm.h>
 #include <ipxe/uaccess.h>
 
 /*
diff --git a/src/arch/x86/interface/pcbios/bios_mp.c b/src/arch/x86/interface/pcbios/bios_mp.c
index c903a81fc..4525a60cf 100644
--- a/src/arch/x86/interface/pcbios/bios_mp.c
+++ b/src/arch/x86/interface/pcbios/bios_mp.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 #include <registers.h>
+#include <librm.h>
 #include <ipxe/uaccess.h>
 #include <ipxe/timer.h>
 #include <ipxe/msr.h>
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index 14e00eda8..0328cb2a5 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -429,8 +429,6 @@ void setup_sipi ( unsigned int vector, uint32_t handler,
 	copy_to_real ( ( vector << 8 ), 0, sipi, ( ( size_t ) sipi_len ) );
 }
 
-PROVIDE_UACCESS_INLINE ( librm, phys_to_virt );
-PROVIDE_UACCESS_INLINE ( librm, virt_to_phys );
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
 PROVIDE_IOMAP ( pages, ioremap, ioremap_pages );
 PROVIDE_IOMAP ( pages, iounmap, iounmap_pages );
diff --git a/src/config/defaults/pcbios.h b/src/config/defaults/pcbios.h
index fa12a1005..13532e429 100644
--- a/src/config/defaults/pcbios.h
+++ b/src/config/defaults/pcbios.h
@@ -9,7 +9,7 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
-#define UACCESS_LIBRM
+#define UACCESS_OFFSET
 #define IOAPI_X86
 #define PCIAPI_PCBIOS
 #define DMAAPI_FLAT
diff --git a/src/config/defaults/sbi.h b/src/config/defaults/sbi.h
index 27fbe0e80..268bf0afe 100644
--- a/src/config/defaults/sbi.h
+++ b/src/config/defaults/sbi.h
@@ -12,7 +12,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define IOAPI_RISCV
 #define IOMAP_VIRT
 #define DMAAPI_FLAT
-#define UACCESS_FLAT
+#define UACCESS_OFFSET
 #define TIMER_ZICNTR
 #define ENTROPY_ZKR
 
diff --git a/src/core/virt_offset.c b/src/core/virt_offset.c
new file mode 100644
index 000000000..23862d934
--- /dev/null
+++ b/src/core/virt_offset.c
@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/uaccess.h>
+
+/**
+ * @file
+ *
+ * Virtual offset memory model
+ *
+ */
+
+PROVIDE_UACCESS_INLINE ( offset, phys_to_virt );
+PROVIDE_UACCESS_INLINE ( offset, virt_to_phys );
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index 8d93cbf4f..d97db95be 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -60,6 +60,7 @@ UACCESS_INLINE ( flat, virt_to_phys ) ( volatile const void *virt ) {
 }
 
 /* Include all architecture-independent user access API headers */
+#include <ipxe/virt_offset.h>
 #include <ipxe/linux/linux_uaccess.h>
 
 /* Include all architecture-dependent user access API headers */
diff --git a/src/include/ipxe/virt_offset.h b/src/include/ipxe/virt_offset.h
new file mode 100644
index 000000000..f8f902753
--- /dev/null
+++ b/src/include/ipxe/virt_offset.h
@@ -0,0 +1,140 @@
+#ifndef _IPXE_VIRT_OFFSET_H
+#define _IPXE_VIRT_OFFSET_H
+
+/**
+ * @file
+ *
+ * Virtual offset memory model
+ *
+ * No currently supported machine provides a full 64 bits of physical
+ * address space.  When we have ownership of the page tables (or
+ * segmentation mechanism), we can therefore use the following model:
+ *
+ *   - For 32-bit builds: set up a circular map so that all 32-bit
+ *     virtual addresses are at a fixed offset from the 32-bit
+ *     physical addresses.
+ *
+ *   - For 64-bit builds: identity-map the required portion of the
+ *     physical address space, then map iPXE itself using virtual
+ *     addresses in the negative (kernel) address space.
+ *
+ * In both cases, we can define "virt_offset" as "the value to be
+ * added to an address within iPXE's own image in order to obtain its
+ * physical address".  With this definition:
+ *
+ *   - For 32-bit builds: conversion between physical and virtual
+ *     addresses is a straightforward addition or subtraction of
+ *     virt_offset, since the whole 32-bit address space is circular.
+ *
+ *   - For 64-bit builds: conversion from any valid physical address
+ *     is a no-op (since all physical addresses are identity-mapped),
+ *     and conversion from a virtual address to a physical address
+ *     requires an addition of virt_offset if and only if the virtual
+ *     address lies in the negative portion of the address space
+ *     (i.e. has the MSB set).
+ *
+ * For x86_64-pcbios, we identity-map the low 4GB of address space
+ * since the only accesses required above 4GB are for MMIO (typically
+ * PCI devices with large memory BARs).
+ *
+ * For riscv64-sbi, we identity-map as much of the physical address
+ * space as can be mapped by the paging model (Sv39, Sv48, or Sv57).
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#ifdef UACCESS_OFFSET
+#define UACCESS_PREFIX_offset
+#else
+#define UACCESS_PREFIX_offset __offset_
+#endif
+
+/** Virtual address offset
+ *
+ * This is defined to be the value to be added to an address within
+ * iPXE's own image in order to obtain its physical address, as
+ * described above.
+ *
+ * Note that if iPXE's image is not yet writable (i.e. during early
+ * startup, prior to physical relocation), then this value may not yet
+ * be valid.  Under these circumstances, callers must use
+ * offset_phys_to_virt() and offset_virt_to_phys() instead (and so
+ * provide the virtual address offset as a function parameter).
+ */
+extern const unsigned long virt_offset;
+
+/**
+ * Convert physical address to virtual address
+ *
+ * @v phys		Physical address
+ * @v offset		Virtual address offset
+ * @ret virt		Virtual address
+ */
+static inline __always_inline void *
+offset_phys_to_virt ( unsigned long phys, unsigned long offset ) {
+
+	/* In a 64-bit build, any valid physical address is directly
+	 * usable as a virtual address, since physical addresses are
+	 * identity-mapped.
+	 */
+	if ( sizeof ( physaddr_t ) > sizeof ( uint32_t ) )
+		return ( ( void * ) phys );
+
+	/* In a 32-bit build: subtract virt_offset */
+	return ( ( void * ) ( phys - offset ) );
+}
+
+/**
+ * Convert virtual address to physical address
+ *
+ * @v virt		Virtual address
+ * @v offset		Virtual address offset
+ * @ret phys		Physical address
+ */
+static inline __always_inline physaddr_t
+offset_virt_to_phys ( volatile const void *virt, unsigned long offset ) {
+	physaddr_t addr = ( ( physaddr_t ) virt );
+
+	/* In a 64-bit build, any valid virtual address with the MSB
+	 * clear is directly usable as a physical address, since it
+	 * must lie within the identity-mapped portion.
+	 *
+	 * This test will typically reduce to a single "branch if less
+	 * than zero" instruction.
+	 */
+	if ( ( sizeof ( physaddr_t ) > sizeof ( uint32_t ) ) &&
+	     ( ! ( addr & ( 1ULL << ( 8 * sizeof ( physaddr_t ) - 1 ) ) ) ) ) {
+		return addr;
+	}
+
+	/* In a 32-bit build or in a 64-bit build with a virtual
+	 * address with the MSB set: add virt_offset
+	 */
+	return ( addr + offset );
+}
+
+/**
+ * Convert physical address to virtual address
+ *
+ * @v phys		Physical address
+ * @ret virt		Virtual address
+ */
+static inline __always_inline void *
+UACCESS_INLINE ( offset, phys_to_virt ) ( unsigned long phys ) {
+
+	return offset_phys_to_virt ( phys, virt_offset );
+}
+
+/**
+ * Convert virtual address to physical address
+ *
+ * @v virt		Virtual address
+ * @ret phys		Physical address
+ */
+static inline __always_inline physaddr_t
+UACCESS_INLINE ( offset, virt_to_phys ) ( volatile const void *virt ) {
+
+	return offset_virt_to_phys ( virt, virt_offset );
+}
+
+#endif /* _IPXE_VIRT_OFFSET_H */
-- 
cgit v1.2.3-55-g7522


From 134d76379e22d1554476cac3ef7baee14a3c27d3 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 9 May 2025 14:25:59 +0100
Subject: [build] Formalise mechanism for accessing absolute symbols

In a position-dependent executable, where all addresses are fixed
at link time, we can use the standard technique as documented by
GNU ld to get the value of an absolute symbol, e.g.:

    extern char _my_symbol[];

    printf ( "Absolute symbol value is %x\n", ( ( int ) _my_symbol ) );

This technique may not work in a position-independent executable.
When dynamic relocations are applied, the runtime addresses will no
longer be equal to the link-time addresses.  If the code to obtain the
address of _my_symbol uses PC-relative addressing, then it will
calculate the runtime "address" of the absolute symbol, which will no
longer be equal the the link-time "address" (i.e. the correct value)
of the absolute symbol.

Define macros ABS_SYMBOL(), ABS_VALUE_INIT(), and ABS_VALUE() that
provide access to the correct values of absolute symbols even in
position-independent code, and use these macros wherever absolute
symbols are accessed.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/librm.h            |  3 +-
 src/arch/x86/interface/pcbios/hidemem.c |  8 +--
 src/arch/x86/interface/pxe/pxe_call.c   |  8 +--
 src/arch/x86/transitions/librm_mgmt.c   |  2 +-
 src/core/version.c                      |  8 +--
 src/crypto/certstore.c                  |  4 +-
 src/crypto/privkey.c                    |  4 +-
 src/image/embedded.c                    |  4 +-
 src/include/compiler.h                  | 91 +++++++++++++++++++++++++++++++++
 9 files changed, 112 insertions(+), 20 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/include/librm.h b/src/arch/x86/include/librm.h
index cbe7d7134..55feeffc9 100644
--- a/src/arch/x86/include/librm.h
+++ b/src/arch/x86/include/librm.h
@@ -365,7 +365,8 @@ extern char __text16_array ( sipi, [] );
 #define sipi __use_text16 ( sipi )
 
 /** Length of startup IPI real-mode handler */
-extern char sipi_len[];
+extern size_t ABS_SYMBOL ( sipi_len );
+#define sipi_len ABS_VALUE ( sipi_len )
 
 /** Startup IPI real-mode handler copy of real-mode data segment */
 extern uint16_t __text16 ( sipi_ds );
diff --git a/src/arch/x86/interface/pcbios/hidemem.c b/src/arch/x86/interface/pcbios/hidemem.c
index 6983c1f4a..4063c0551 100644
--- a/src/arch/x86/interface/pcbios/hidemem.c
+++ b/src/arch/x86/interface/pcbios/hidemem.c
@@ -76,10 +76,10 @@ extern struct segoff __text16 ( int15_vector );
 /* The linker defines these symbols for us */
 extern char _textdata[];
 extern char _etextdata[];
-extern char _text16_memsz[];
-#define _text16_memsz ( ( size_t ) _text16_memsz )
-extern char _data16_memsz[];
-#define _data16_memsz ( ( size_t ) _data16_memsz )
+extern size_t ABS_SYMBOL ( _text16_memsz );
+#define _text16_memsz ABS_VALUE ( _text16_memsz )
+extern size_t ABS_SYMBOL ( _data16_memsz );
+#define _data16_memsz ABS_VALUE ( _data16_memsz )
 
 /**
  * Hide region of memory from system memory map
diff --git a/src/arch/x86/interface/pxe/pxe_call.c b/src/arch/x86/interface/pxe/pxe_call.c
index 2721d23e5..a530f919f 100644
--- a/src/arch/x86/interface/pxe/pxe_call.c
+++ b/src/arch/x86/interface/pxe/pxe_call.c
@@ -55,12 +55,12 @@ extern void pxe_int_1a ( void );
 static int int_1a_hooked = 0;
 
 /** Real-mode code segment size */
-extern char _text16_memsz[];
-#define _text16_memsz ( ( size_t ) _text16_memsz )
+extern size_t ABS_SYMBOL ( _text16_memsz );
+#define _text16_memsz ABS_VALUE ( _text16_memsz )
 
 /** Real-mode data segment size */
-extern char _data16_memsz[];
-#define _data16_memsz ( ( size_t ) _data16_memsz )
+extern size_t ABS_SYMBOL (_data16_memsz );
+#define _data16_memsz ABS_VALUE ( _data16_memsz )
 
 /** PXENV_UNDI_TRANSMIT API call profiler */
 static struct profiler pxe_api_tx_profiler __profiler =
diff --git a/src/arch/x86/transitions/librm_mgmt.c b/src/arch/x86/transitions/librm_mgmt.c
index 0328cb2a5..77aecdb7d 100644
--- a/src/arch/x86/transitions/librm_mgmt.c
+++ b/src/arch/x86/transitions/librm_mgmt.c
@@ -426,7 +426,7 @@ void setup_sipi ( unsigned int vector, uint32_t handler,
 	memcpy ( &sipi_regs, regs, sizeof ( sipi_regs ) );
 
 	/* Copy real-mode handler */
-	copy_to_real ( ( vector << 8 ), 0, sipi, ( ( size_t ) sipi_len ) );
+	copy_to_real ( ( vector << 8 ), 0, sipi, sipi_len );
 }
 
 PROVIDE_IOMAP_INLINE ( pages, io_to_bus );
diff --git a/src/core/version.c b/src/core/version.c
index 22f444065..cd69a8762 100644
--- a/src/core/version.c
+++ b/src/core/version.c
@@ -49,16 +49,16 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 FEATURE_VERSION ( VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH );
 
 /** Build timestamp (generated by linker) */
-extern char _build_timestamp[];
+extern unsigned long ABS_SYMBOL ( _build_timestamp );
 
 /** Build ID (generated by linker) */
-extern char _build_id[];
+extern unsigned long ABS_SYMBOL ( _build_id );
 
 /** Build timestamp */
-unsigned long build_timestamp = ( ( unsigned long ) _build_timestamp );
+unsigned long build_timestamp = ABS_VALUE_INIT ( _build_timestamp );
 
 /** Build ID */
-unsigned long build_id = ( ( unsigned long ) _build_id );
+unsigned long build_id = ABS_VALUE_INIT ( _build_id );
 
 /** Product major version */
 const int product_major_version = VERSION_MAJOR;
diff --git a/src/crypto/certstore.c b/src/crypto/certstore.c
index 86f67a0af..81179f9cc 100644
--- a/src/crypto/certstore.c
+++ b/src/crypto/certstore.c
@@ -44,7 +44,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #undef CERT
 #define CERT( _index, _path )						\
 	extern char stored_cert_ ## _index ## _data[];			\
-	extern char stored_cert_ ## _index ## _len[];			\
+	extern size_t ABS_SYMBOL ( stored_cert_ ## _index ## _len );	\
 	__asm__ ( ".section \".rodata\", \"a\", " PROGBITS "\n\t"	\
 		  "\nstored_cert_" #_index "_data:\n\t"			\
 		  ".incbin \"" _path "\"\n\t"				\
@@ -59,7 +59,7 @@ CERT_ALL
 #undef CERT
 #define CERT( _index, _path ) {						\
 	.data = stored_cert_ ## _index ## _data,			\
-	.len = ( size_t ) stored_cert_ ## _index ## _len, 		\
+	.len = ABS_VALUE_INIT ( stored_cert_ ## _index ## _len ), 	\
 },
 static struct asn1_cursor certstore_raw[] = {
 	CERT_ALL
diff --git a/src/crypto/privkey.c b/src/crypto/privkey.c
index c15edf130..cbe8deff3 100644
--- a/src/crypto/privkey.c
+++ b/src/crypto/privkey.c
@@ -53,7 +53,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 /* Raw private key data */
 extern char private_key_data[];
-extern char private_key_len[];
+extern size_t ABS_SYMBOL ( private_key_len );
 __asm__ ( ".section \".rodata\", \"a\", " PROGBITS "\n\t"
 	  "\nprivate_key_data:\n\t"
 #ifdef PRIVATE_KEY
@@ -68,7 +68,7 @@ struct private_key private_key = {
 	.refcnt = REF_INIT ( ref_no_free ),
 	.builder = {
 		.data = private_key_data,
-		.len = ( ( size_t ) private_key_len ),
+		.len = ABS_VALUE_INIT ( private_key_len ),
 	},
 };
 
diff --git a/src/image/embedded.c b/src/image/embedded.c
index 76d256c9b..2934d4ee7 100644
--- a/src/image/embedded.c
+++ b/src/image/embedded.c
@@ -16,7 +16,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #undef EMBED
 #define EMBED( _index, _path, _name )					\
 	extern char embedded_image_ ## _index ## _data[];		\
-	extern char embedded_image_ ## _index ## _len[];		\
+	extern size_t ABS_SYMBOL ( embedded_image_ ## _index ## _len );	\
 	__asm__ ( ".section \".data\", \"aw\", " PROGBITS "\n\t"	\
 		  "\nembedded_image_" #_index "_data:\n\t"		\
 		  ".incbin \"" _path "\"\n\t"				\
@@ -34,7 +34,7 @@ EMBED_ALL
 	.name = _name,							\
 	.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),			\
 	.rwdata = embedded_image_ ## _index ## _data,			\
-	.len = ( size_t ) embedded_image_ ## _index ## _len,		\
+	.len = ABS_VALUE_INIT ( embedded_image_ ## _index ## _len ),	\
 },
 static struct image embedded_images[] = {
 	EMBED_ALL
diff --git a/src/include/compiler.h b/src/include/compiler.h
index 5685ab154..ec03f6f96 100644
--- a/src/include/compiler.h
+++ b/src/include/compiler.h
@@ -662,6 +662,97 @@ char __debug_disable(OBJECT) = ( DBGLVL_MAX & ~DBGLVL_DFLT );
 #define ARRAY_SIZE(array) ( sizeof (array) / sizeof ( (array)[0] ) )
 #endif /* ASSEMBLY */
 
+/** @defgroup abs Absolute symbols
+ * @{
+ */
+#ifndef ASSEMBLY
+
+/** Declare an absolute symbol (e.g. a value defined by a linker script)
+ *
+ * Use as e.g.:
+ *
+ *    extern int ABS_SYMBOL ( _my_symbol );
+ *
+ */
+#define ABS_SYMBOL( name ) name[]
+
+/** Get value of an absolute symbol for use in a static initializer
+ *
+ * Use as e.g.:
+ *
+ *    extern int ABS_SYMBOL ( _my_symbol );
+ *    static int my_symbol = ABS_VALUE_INIT ( _my_symbol );
+ *
+ * Note that the declared type must be at least as large as a pointer
+ * type, since the compiler sees the absolute symbol as being an
+ * address.
+ */
+#define ABS_VALUE_INIT( name ) ( ( typeof ( name[0] ) ) name )
+
+/** Get value of an absolute symbol
+ *
+ * In a position-dependent executable, where all addresses are fixed
+ * at link time, we can use the standard technique as documented by
+ * GNU ld, e.g.:
+ *
+ *    extern char _my_symbol[];
+ *
+ *    printf ( "Absolute symbol value is %x\n", ( ( int ) _my_symbol ) );
+ *
+ * This technique may not work in a position-independent executable.
+ * When dynamic relocations are applied, the runtime addresses will no
+ * longer be equal to the link-time addresses.  If the code to obtain
+ * the address of _my_symbol uses PC-relative addressing, then it
+ * will calculate the runtime "address" of the absolute symbol, which
+ * will no longer be equal the the link-time "address" (i.e. the
+ * correct value) of the absolute symbol.
+ *
+ * We can work around this by instead declaring a static variable to
+ * contain the absolute value, and returning the contents of this
+ * static variable:
+ *
+ *    extern char _my_symbol[];
+ *    static void * volatile my_symbol = _my_symbol;
+ *
+ *    printf ( "Absolute symbol value is %x\n", ( ( int ) my_symbol ) );
+ *
+ * The value of the static variable cannot possibly use PC-relative
+ * addressing (since there is no applicable program counter for
+ * non-code), and so will instead be filled in with the correct
+ * absolute value at link time.  (No dynamic relocation will be
+ * generated that might change its value, since the symbol providing
+ * the value is an absolute symbol.)
+ *
+ * This second technique will work for both position-dependent and
+ * position-independent code, but incurs the unnecssary overhead of an
+ * additional static variable in position-dependent code.  The
+ * ABS_VALUE() macro abstracts away these differences, using the most
+ * efficient available technique.  Use as e.g.:
+ *
+ *    extern int ABS_SYMBOL ( _my_symbol );
+ *    #define my_symbol ABS_VALUE ( _my_symbol )
+ *
+ *    printf ( "Absolute symbol value is %x\n", my_symbol );
+ *
+ * The ABS_VALUE() macro uses the (otherwise redundant) type declared
+ * on the ABS_SYMBOL() array to automatically determine the correct
+ * type for the ABS_VALUE() expression.
+ *
+ * Unlike ABS_VALUE_INIT(), there is no restriction that the type must
+ * be at least as large as a pointer type.
+ */
+#ifndef __pie__
+#define ABS_VALUE( name ) ( ( typeof ( name[0] ) ) ( intptr_t ) name )
+#else
+#define ABS_VALUE( name ) ( {						\
+	static void * volatile static_ ## name = name;			\
+	( ( typeof ( name[0] ) ) ( intptr_t ) static_ ## name );	\
+	} )
+#endif
+
+#endif /* ASSEMBLY */
+/** @} */
+
 /**
  * @defgroup licences Licence declarations
  *
-- 
cgit v1.2.3-55-g7522


From f988ec09e01b54d21d1b1fa0e2b3121d926ed7df Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 9 May 2025 16:26:41 +0100
Subject: [fdt] Generalise access to "reg" property

The "reg" property is also used by non-device nodes, such as the nodes
describing the system memory map.

Provide generalised functionality for parsing the "#address-cells",
"#size-cells", and "reg" properties.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c             | 105 +++++++++++++++++++++++++++++++++++++++++++++
 src/drivers/bus/devtree.c  |  23 +++-------
 src/include/ipxe/devtree.h |  13 ++----
 src/include/ipxe/fdt.h     |  26 +++++++++++
 4 files changed, 141 insertions(+), 26 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 744e0e705..eee5b47b5 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -563,6 +563,111 @@ int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
 	return 0;
 }
 
+/**
+ * Get region cell size specification
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting (parent) node offset
+ * @v regs		Region cell size specification to fill in
+ *
+ * Note that #address-cells and #size-cells are defined on the
+ * immediate parent node, rather than on the node with the "reg"
+ * property itself.
+ */
+void fdt_reg_cells ( struct fdt *fdt, unsigned int offset,
+		     struct fdt_reg_cells *regs ) {
+	int rc;
+
+	/* Read #address-cells, if present */
+	if ( ( rc = fdt_u32 ( fdt, offset, "#address-cells",
+			      &regs->address_cells ) ) != 0 ) {
+		regs->address_cells = FDT_DEFAULT_ADDRESS_CELLS;
+	}
+
+	/* Read #size-cells, if present */
+	if ( ( rc = fdt_u32 ( fdt, offset, "#size-cells",
+			      &regs->size_cells ) ) != 0 ) {
+		regs->size_cells = FDT_DEFAULT_SIZE_CELLS;
+	}
+
+	/* Calculate stride */
+	regs->stride = ( regs->address_cells + regs->size_cells );
+}
+
+/**
+ * Get number of regions
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v regs		Region cell size specification
+ * @ret count		Number of regions, or negative error
+ */
+int fdt_reg_count ( struct fdt *fdt, unsigned int offset,
+		    struct fdt_reg_cells *regs ) {
+	struct fdt_descriptor desc;
+	const uint32_t *cell;
+	unsigned int count;
+	int rc;
+
+	/* Find property */
+	if ( ( rc = fdt_property ( fdt, offset, "reg", &desc ) ) != 0 )
+		return rc;
+
+	/* Determine number of regions */
+	count = ( desc.len / ( regs->stride * sizeof ( *cell ) ) );
+	return count;
+}
+
+/**
+ * Get region address
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v regs		Region cell size specification
+ * @v index		Region index
+ * @v address		Region starting address to fill in
+ * @ret rc		Return status code
+ */
+int fdt_reg_address ( struct fdt *fdt, unsigned int offset,
+		      struct fdt_reg_cells *regs, unsigned int index,
+		      uint64_t *address ) {
+	unsigned int cell = ( index * regs->stride );
+	int rc;
+
+	/* Read relevant portion of region array */
+	if ( ( rc = fdt_cells ( fdt, offset, "reg", cell, regs->address_cells,
+				address ) ) != 0 ) {
+		return rc;
+	}
+
+	return 0;
+}
+
+/**
+ * Get region size
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v regs		Region cell size specification
+ * @v index		Region index
+ * @v size		Region size to fill in
+ * @ret rc		Return status code
+ */
+int fdt_reg_size ( struct fdt *fdt, unsigned int offset,
+		   struct fdt_reg_cells *regs, unsigned int index,
+		   uint64_t *size ) {
+	unsigned int cell = ( ( index * regs->stride ) + regs->address_cells );
+	int rc;
+
+	/* Read relevant portion of region array */
+	if ( ( rc = fdt_cells ( fdt, offset, "reg", cell, regs->size_cells,
+				size ) ) != 0 ) {
+		return rc;
+	}
+
+	return 0;
+}
+
 /**
  * Get MAC address from property
  *
diff --git a/src/drivers/bus/devtree.c b/src/drivers/bus/devtree.c
index 654f8d14f..55f68ee33 100644
--- a/src/drivers/bus/devtree.c
+++ b/src/drivers/bus/devtree.c
@@ -56,27 +56,25 @@ void * dt_ioremap ( struct dt_device *dt, unsigned int offset,
 		    unsigned int index, size_t len ) {
 	struct dt_device *parent =
 		container_of ( dt->dev.parent, struct dt_device, dev );
+	struct fdt_reg_cells *regs = &parent->regs;
 	uint64_t address;
 	uint64_t size;
-	unsigned int cell;
 	void *io_addr;
 	int rc;
 
 	/* Read address */
-	cell = ( index * ( parent->address_cells + parent->size_cells ) );
-	if ( ( rc = fdt_cells ( &sysfdt, offset, "reg", cell,
-				parent->address_cells, &address ) ) != 0 ) {
+	if ( ( rc = fdt_reg_address ( &sysfdt, offset, regs, index,
+				      &address ) ) != 0 ) {
 		DBGC ( dt, "DT %s could not read region %d address: %s\n",
 		       dt->path, index, strerror ( rc ) );
 		return NULL;
 	}
-	cell += parent->address_cells;
 
 	/* Read size (or assume sufficient, if tree specifies no sizes) */
 	size = len;
-	if ( parent->size_cells &&
-	     ( rc = fdt_cells ( &sysfdt, offset, "reg", cell,
-				parent->size_cells, &size ) ) != 0 ) {
+	if ( regs->size_cells &&
+	     ( ( rc = fdt_reg_size ( &sysfdt, offset, regs, index,
+				     &size ) ) != 0 ) ) {
 		DBGC ( dt, "DT %s could not read region %d size: %s\n",
 		       dt->path, index, strerror ( rc ) );
 		return NULL;
@@ -225,14 +223,7 @@ static int dt_probe_node ( struct dt_device *parent, unsigned int offset,
 	list_add_tail ( &dt->dev.siblings, &dt->dev.parent->children );
 
 	/* Read #address-cells and #size-cells, if present */
-	if ( ( rc = fdt_u32 ( &sysfdt, offset, "#address-cells",
-			      &dt->address_cells ) ) != 0 ) {
-		dt->address_cells = DT_DEFAULT_ADDRESS_CELLS;
-	}
-	if ( ( rc = fdt_u32 ( &sysfdt, offset, "#size-cells",
-			      &dt->size_cells ) ) != 0 ) {
-		dt->size_cells = DT_DEFAULT_SIZE_CELLS;
-	}
+	fdt_reg_cells ( &sysfdt, offset, &dt->regs );
 
 	/* Probe device */
 	if ( ( rc = dt_probe ( dt, offset ) ) != 0 )
diff --git a/src/include/ipxe/devtree.h b/src/include/ipxe/devtree.h
index 04414f370..6e9286af4 100644
--- a/src/include/ipxe/devtree.h
+++ b/src/include/ipxe/devtree.h
@@ -11,6 +11,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <ipxe/device.h>
 #include <ipxe/dma.h>
+#include <ipxe/fdt.h>
 
 /** A devicetree device */
 struct dt_device {
@@ -25,18 +26,10 @@ struct dt_device {
 	/** Driver-private data */
 	void *priv;
 
-	/** Number of address cells for child devices */
-	uint32_t address_cells;
-	/** Number of size cells for child devices */
-	uint32_t size_cells;
+	/** Register cell size specification */
+	struct fdt_reg_cells regs;
 };
 
-/** Default number of address cells, if not specified */
-#define DT_DEFAULT_ADDRESS_CELLS 2
-
-/** Default number of size cells, if not specified */
-#define DT_DEFAULT_SIZE_CELLS 1
-
 /** A devicetree driver */
 struct dt_driver {
 	/** Driver name */
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index fb0ae7752..6c58f5687 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -124,6 +124,22 @@ struct fdt_descriptor {
 	int depth;
 };
 
+/** A device tree region cell size specification */
+struct fdt_reg_cells {
+	/** Number of address cells */
+	uint32_t address_cells;
+	/** Number of size cells */
+	uint32_t size_cells;
+	/** Number of address cells plus number of size cells */
+	unsigned int stride;
+};
+
+/** Default number of address cells, if not specified */
+#define FDT_DEFAULT_ADDRESS_CELLS 2
+
+/** Default number of size cells, if not specified */
+#define FDT_DEFAULT_SIZE_CELLS 1
+
 extern struct image_tag fdt_image __image_tag;
 extern struct fdt sysfdt;
 
@@ -144,6 +160,16 @@ extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint64_t *value );
 extern int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint32_t *value );
+extern void fdt_reg_cells ( struct fdt *fdt, unsigned int offset,
+			    struct fdt_reg_cells *regs );
+extern int fdt_reg_count ( struct fdt *fdt, unsigned int offset,
+			   struct fdt_reg_cells *regs );
+extern int fdt_reg_address ( struct fdt *fdt, unsigned int offset,
+			     struct fdt_reg_cells *regs, unsigned int index,
+			     uint64_t *address );
+extern int fdt_reg_size ( struct fdt *fdt, unsigned int offset,
+			  struct fdt_reg_cells *regs, unsigned int index,
+			  uint64_t *size );
 extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
 extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
-- 
cgit v1.2.3-55-g7522


From 95ede670bcfea5ea22965962fe764841243eb864 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Sun, 11 May 2025 13:04:51 +0100
Subject: [riscv] Hold virtual address offset in the thread pointer register

iPXE does not make use of any thread-local storage.  Use the otherwise
unused thread pointer register ("tp") to hold the current value of
the virtual address offset, rather than using a global variable.

This ensures that virt_offset can be made valid even during very early
initialisation (when iPXE may be executing directly from read-only
memory and so cannot update a global variable).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/include/bits/virt_offset.h |  33 +++++++
 src/arch/riscv/prefix/libprefix.S         | 158 +++++++++++++++---------------
 src/arch/riscv/prefix/sbiprefix.S         |   3 +
 src/core/fdt.c                            |   6 +-
 src/core/uaccess.c                        |   4 +
 src/core/virt_offset.c                    |  36 -------
 src/include/bits/virt_offset.h            |  15 +++
 src/include/ipxe/virt_offset.h            |  43 ++------
 8 files changed, 143 insertions(+), 155 deletions(-)
 create mode 100644 src/arch/riscv/include/bits/virt_offset.h
 delete mode 100644 src/core/virt_offset.c
 create mode 100644 src/include/bits/virt_offset.h

(limited to 'src/core')

diff --git a/src/arch/riscv/include/bits/virt_offset.h b/src/arch/riscv/include/bits/virt_offset.h
new file mode 100644
index 000000000..83ac17551
--- /dev/null
+++ b/src/arch/riscv/include/bits/virt_offset.h
@@ -0,0 +1,33 @@
+#ifndef _BITS_VIRT_OFFSET_H
+#define _BITS_VIRT_OFFSET_H
+
+/** @file
+ *
+ * RISCV-specific virtual address offset
+ *
+ * We use the thread pointer register (tp) to hold the virtual address
+ * offset, so that virtual-to-physical address translations work as
+ * expected even while we are executing directly from read-only memory
+ * (and so cannot store a value in a global virt_offset variable).
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/**
+ * Read virtual address offset held in thread pointer register
+ *
+ * @ret virt_offset	Virtual address offset
+ */
+static inline __attribute__ (( const, always_inline )) unsigned long
+tp_virt_offset ( void ) {
+	register unsigned long tp asm ( "tp" );
+
+	__asm__ ( "" : "=r" ( tp ) );
+	return tp;
+}
+
+/** Always read thread pointer register to get virtual address offset */
+#define virt_offset tp_virt_offset()
+
+#endif /* _BITS_VIRT_OFFSET_H */
diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index 92b7cc8fe..0143953f7 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -41,13 +41,6 @@ prefix_virt:
 	.dword	_prefix
 	.size	prefix_virt, . - prefix_virt
 
-	/* Current virtual address offset */
-	.section ".data.virt_offset", "aw", @progbits
-	.globl	virt_offset
-virt_offset:
-	.space	( __riscv_xlen / 8 )
-	.size	virt_offset, . - virt_offset
-
 /*****************************************************************************
  *
  * Print message to debug console
@@ -311,7 +304,7 @@ apply_relocs_done:
  *
  * Returns:
  *
- *   a0 - Virtual address offset
+ *   tp - Virtual address offset
  *   pc - Updated to a virtual address if paging enabled
  *
  */
@@ -418,10 +411,11 @@ paging_mode_names:
  *
  * Parameters:
  *
- *   a0 - Virtual address offset
+ *   tp - Virtual address offset
  *
  * Returns:
  *
+ *   tp - Virtual address offset (zeroed)
  *   pc - Updated to a physical address
  *
  */
@@ -449,7 +443,7 @@ paging_mode_names:
  *
  * Returns:
  *
- *   a0 - Virtual address offset
+ *   tp - Virtual address offset
  *   pc - Updated to a virtual address if paging enabled
  *
  * A 4kB 64-bit page table contains 512 8-byte PTEs.  We choose to use
@@ -510,21 +504,20 @@ paging_mode_names:
 enable_paging_64:
 	/* Register usage:
 	 *
-	 * a0 - return value (virtual address offset)
+	 * tp - return value (virtual address offset)
+	 * a0 - page table base address
 	 * a1 - currently attempted paging level
 	 * a2 - enabled paging level
-	 * a3 - page table base address
-	 * a4 - PTE pointer
-	 * a5 - PTE stride
+	 * a3 - PTE pointer
+	 * a4 - PTE stride
 	 */
 	progress " paging:"
-	mv	a3, a0
 	li	a1, SATP_MODE_SV57
 
 	/* Calculate virtual address offset */
 	LOADN	t0, prefix_virt
 	la	t1, _prefix
-	sub	a0, t1, t0
+	sub	tp, t1, t0
 
 enable_paging_64_loop:
 
@@ -534,50 +527,50 @@ enable_paging_64_loop:
 	 * a1 ==  9 == Sv48: PPN[3] LSB is PTE bit 37  =>  stride := 1 << 37
 	 * a1 ==  8 == Sv39: PPN[2] LSB is PTE bit 28  =>  stride := 1 << 28
 	 *
-	 * and so we calculate stride a5 := ( 1 << ( 9 * a1 - 44 ) )
+	 * and so we calculate stride a4 := ( 1 << ( 9 * a1 - 44 ) )
 	 */
-	slli	a5, a1, 3
-	add	a5, a5, a1
-	addi	a5, a5, -44
+	slli	a4, a1, 3
+	add	a4, a4, a1
+	addi	a4, a4, -44
 	li	t0, 1
-	sll	a5, t0, a5
+	sll	a4, t0, a4
 
 	/* Construct PTE[0-255] for identity map */
-	mv	a4, a3
+	mv	a3, a0
 	li	t0, ( PTE_COUNT / 2 )
 	li	t1, PTE_LEAF
-1:	STOREN	t1, (a4)
-	addi	a4, a4, PTE_SIZE
-	add	t1, t1, a5
+1:	STOREN	t1, (a3)
+	addi	a3, a3, PTE_SIZE
+	add	t1, t1, a4
 	addi	t0, t0, -1
 	bgtz	t0, 1b
 
 	/* Zero PTE[256-511] */
 	li	t0, ( PTE_COUNT / 2 )
-1:	STOREN	zero, (a4)
-	addi	a4, a4, PTE_SIZE
+1:	STOREN	zero, (a3)
+	addi	a3, a3, PTE_SIZE
 	addi	t0, t0, -1
 	bgtz	t0, 1b
 
 	/* Construct PTE[511] as next level page table pointer */
-	srli	t0, a3, PTE_PPN_SHIFT
+	srli	t0, a0, PTE_PPN_SHIFT
 	ori	t0, t0, PTE_V
-	STOREN	t0, -PTE_SIZE(a4)
+	STOREN	t0, -PTE_SIZE(a3)
 
 	/* Calculate PTE[x] address for iPXE virtual address map */
 	LOADN	t0, prefix_virt
 	srli	t0, t0, VPN1_LSB
 	andi	t0, t0, ( PTE_COUNT - 1 )
 	slli	t0, t0, PTE_SIZE_LOG2
-	add	a4, a3, t0
+	add	a3, a0, t0
 
 	/* Calculate PTE stride for iPXE virtual address map
 	 *
 	 * PPN[1] LSB is PTE bit 19 in all paging modes, and so the
 	 * stride is always ( 1 << 19 )
 	 */
-	li	a5, 1
-	slli	a5, a5, PTE_PPN1_LSB
+	li	a4, 1
+	slli	a4, a4, PTE_PPN1_LSB
 
 	/* Construct PTE[x-y] for iPXE virtual address map */
 	la	t0, _prefix
@@ -585,14 +578,14 @@ enable_paging_64_loop:
 	ori	t0, t0, PTE_LEAF
 	la	t1, _ebss
 	srli	t1, t1, PTE_PPN_SHIFT
-1:	STOREN	t0, (a4)
-	addi	a4, a4, PTE_SIZE
-	add	t0, t0, a5
+1:	STOREN	t0, (a3)
+	addi	a3, a3, PTE_SIZE
+	add	t0, t0, a4
 	ble	t0, t1, 1b
 
 	/* Attempt to enable paging, and read back active paging level */
 	slli	t0, a1, SATP_MODE_SHIFT
-	srli	t1, a3, PAGE_SHIFT
+	srli	t1, a0, PAGE_SHIFT
 	or	t0, t0, t1
 	csrrw	zero, satp, t0
 	sfence.vma
@@ -604,10 +597,10 @@ enable_paging_64_loop:
 	addi	a1, a1, -1
 	li	t0, SATP_MODE_SV39
 	bge	a1, t0, enable_paging_64_loop
-	mv	a0, zero
+	mv	tp, zero
 1:
 	/* Adjust return address to a virtual address */
-	sub	ra, ra, a0
+	sub	ra, ra, tp
 
 	/* Return, with or without paging enabled */
 	paging_mode_name a2
@@ -625,10 +618,11 @@ enable_paging_64_loop:
  *
  * Parameters:
  *
- *   a0 - Virtual address offset
+ *   tp - Virtual address offset
  *
  * Returns:
  *
+ *   tp - Virtual address offset (zeroed)
  *   pc - Updated to a physical address
  *
  */
@@ -637,13 +631,13 @@ enable_paging_64_loop:
 disable_paging_64:
 	/* Register usage:
 	 *
-	 * a0 - virtual address offset
+	 * tp - virtual address offset
 	 */
 
 	/* Jump to physical address */
 	la	t0, 1f
 	bgez	t0, 1f
-	add	t0, t0, a0
+	add	t0, t0, tp
 	jr	t0
 1:
 	/* Disable paging */
@@ -652,9 +646,10 @@ disable_paging_64:
 
 	/* Update return address to a physical address */
 	bgez	ra, 1f
-	add	ra, ra, a0
+	add	ra, ra, tp
 1:
-	/* Return with paging disabled */
+	/* Return with paging disabled and virtual offset zeroed */
+	mv	tp, zero
 	ret
 	.size	disable_paging_64, . - disable_paging_64
 
@@ -677,7 +672,7 @@ disable_paging_64:
  *
  * Returns:
  *
- *   a0 - Virtual address offset
+ *   tp - Virtual address offset
  *   pc - Updated to a virtual address if paging enabled
  *
  * A 4kB 32-bit page table contains 1024 4-byte PTEs.  We choose to
@@ -698,29 +693,28 @@ disable_paging_64:
 enable_paging_32:
 	/* Register usage:
 	 *
-	 * a0 - return value (virtual address offset)
+	 * tp - return value (virtual address offset)
+	 * a0 - page table base address
 	 * a1 - enabled paging level
-	 * a2 - page table base address
-	 * a3 - PTE pointer
-	 * a4 - saved content of temporarily modified PTE
+	 * a2 - PTE pointer
+	 * a3 - saved content of temporarily modified PTE
 	 */
 	progress " paging:"
-	mv	a2, a0
 
 	/* Calculate virtual address offset */
 	LOADN	t0, prefix_virt
 	la	t1, _prefix
-	sub	a0, t1, t0
+	sub	tp, t1, t0
 
 	/* Construct PTEs for circular map */
-	mv	a3, a2
+	mv	a2, a0
 	li	t0, PTE_COUNT
-	mv	t1, a0
+	mv	t1, tp
 	ori	t1, t1, ( PTE_LEAF << PTE_PPN_SHIFT )
 	li	t2, ( 1 << ( PTE_PPN1_LSB + PTE_PPN_SHIFT ) )
 1:	srli	t3, t1, PTE_PPN_SHIFT
-	STOREN	t3, (a3)
-	addi	a3, a3, PTE_SIZE
+	STOREN	t3, (a2)
+	addi	a2, a2, PTE_SIZE
 	add	t1, t1, t2
 	addi	t0, t0, -1
 	bgtz	t0, 1b
@@ -729,20 +723,20 @@ enable_paging_32:
 	la	t0, enable_paging_32_xstart
 	srli	t0, t0, VPN1_LSB
 	slli	t1, t0, PTE_SIZE_LOG2
-	add	a3, a2, t1
-	LOADN	a4, (a3)
+	add	a2, a0, t1
+	LOADN	a3, (a2)
 	slli	t0, t0, PTE_PPN1_LSB
 	ori	t0, t0, PTE_LEAF
-	STOREN	t0, (a3)
+	STOREN	t0, (a2)
 
 	/* Adjust PTE pointer to a virtual address */
-	sub	a3, a3, a0
+	sub	a2, a2, tp
 
 	/* Attempt to enable paging, and read back active paging level */
 	la	t0, 1f
-	sub	t0, t0, a0
+	sub	t0, t0, tp
 	li	t1, ( SATP_MODE_SV32 << SATP_MODE_SHIFT )
-	srli	t2, a2, PAGE_SHIFT
+	srli	t2, a0, PAGE_SHIFT
 	or	t1, t1, t2
 	.balign	enable_paging_32_xalign
 	/* Start of transition code */
@@ -753,7 +747,7 @@ enable_paging_32_xstart:
 	beqz	a1, 2f
 	jr	t0
 1:	/* Restore temporarily modified PTE */
-	STOREN	a4, (a3)
+	STOREN	a3, (a2)
 	sfence.vma
 	/* End of transition code */
 	.equ	enable_paging_32_xlen, . - enable_paging_32_xstart
@@ -761,10 +755,10 @@ enable_paging_32_xstart:
 
 	/* Clear virtual address offset if paging is not enabled */
 	bnez	a1, 1f
-	mv	a0, zero
+	mv	tp, zero
 1:
 	/* Adjust return address to a virtual address */
-	sub	ra, ra, a0
+	sub	ra, ra, tp
 
 	/* Return, with or without paging enabled */
 	paging_mode_name a1
@@ -786,10 +780,11 @@ enable_paging_32_xstart:
  *
  * Parameters:
  *
- *   a0 - Virtual address offset
+ *   tp - Virtual address offset
  *
  * Returns:
  *
+ *   tp - Virtual address offset (zeroed)
  *   pc - Updated to a physical address
  *
  */
@@ -800,34 +795,34 @@ enable_paging_32_xstart:
 disable_paging_32:
 	/* Register usage:
 	 *
-	 * a0 - virtual address offset
-	 * a1 - page table address
-	 * a2 - transition PTE pointer
-	 * a3 - transition PTE content
+	 * tp - virtual address offset
+	 * a0 - page table address
+	 * a1 - transition PTE pointer
+	 * a2 - transition PTE content
 	 */
 
 	/* Get page table address, and exit if paging is already disabled */
-	csrr	a1, satp
-	beqz	a1, 99f
-	slli	a1, a1, PAGE_SHIFT
-	sub	a1, a1, a0
+	csrr	a0, satp
+	beqz	a0, 99f
+	slli	a0, a0, PAGE_SHIFT
+	sub	a0, a0, tp
 
 	/* Prepare for modifying transition PTE */
 	la	t0, disable_paging_32_xstart
-	add	t0, t0, a0
+	add	t0, t0, tp
 	srli	t0, t0, VPN1_LSB
-	slli	a2, t0, PTE_SIZE_LOG2
-	add	a2, a2, a1
-	slli	a3, t0, PTE_PPN1_LSB
-	ori	a3, a3, PTE_LEAF
+	slli	a1, t0, PTE_SIZE_LOG2
+	add	a1, a1, a0
+	slli	a2, t0, PTE_PPN1_LSB
+	ori	a2, a2, PTE_LEAF
 
 	/* Jump to physical address in transition PTE, and disable paging */
 	la	t0, 1f
-	add	t0, t0, a0
+	add	t0, t0, tp
 	.balign	disable_paging_32_xalign
 	/* Start of transition code */
 disable_paging_32_xstart:
-	STOREN	a3, (a2)
+	STOREN	a2, (a1)
 	sfence.vma
 	jr	t0
 1:	csrw	satp, zero
@@ -836,9 +831,10 @@ disable_paging_32_xstart:
 	.equ	disable_paging_32_xlen, . - disable_paging_32_xstart
 
 	/* Update return address to a physical address */
-	add	ra, ra, a0
+	add	ra, ra, tp
 
-99:	/* Return with paging disabled */
+99:	/* Return with paging disabled and virtual offset zeroed */
+	mv	tp, zero
 	ret
 	.size	disable_paging_32, . - disable_paging_32
 
diff --git a/src/arch/riscv/prefix/sbiprefix.S b/src/arch/riscv/prefix/sbiprefix.S
index 6bddc9db7..3885c77be 100644
--- a/src/arch/riscv/prefix/sbiprefix.S
+++ b/src/arch/riscv/prefix/sbiprefix.S
@@ -57,6 +57,9 @@ progress_\@:
 	.org 0
 	.globl	_sbi_start
 _sbi_start:
+	/* Initialise virtual address offset */
+	mv	tp, zero
+
 	/* Preserve arguments */
 	mv	s0, a0
 	mv	s1, a1
diff --git a/src/core/fdt.c b/src/core/fdt.c
index eee5b47b5..d20c63c31 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -29,6 +29,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <byteswap.h>
 #include <ipxe/netdevice.h>
 #include <ipxe/image.h>
+#include <ipxe/uaccess.h>
 #include <ipxe/umalloc.h>
 #include <ipxe/fdt.h>
 
@@ -734,8 +735,9 @@ int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr, size_t max_len ) {
 		       fdt->len, max_len );
 		goto err;
 	}
-	DBGC ( fdt, "FDT version %d at %p+%#04zx\n",
-	       be32_to_cpu ( hdr->version ), fdt->hdr, fdt->len );
+	DBGC ( fdt, "FDT version %d at %p+%#04zx (phys %#08lx)\n",
+	       be32_to_cpu ( hdr->version ), fdt->hdr, fdt->len,
+	       virt_to_phys ( hdr ) );
 
 	/* Check signature */
 	if ( hdr->magic != cpu_to_be32 ( FDT_MAGIC ) ) {
diff --git a/src/core/uaccess.c b/src/core/uaccess.c
index e73f4d7fb..ae873d109 100644
--- a/src/core/uaccess.c
+++ b/src/core/uaccess.c
@@ -34,3 +34,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /* Flat address space user access API */
 PROVIDE_UACCESS_INLINE ( flat, phys_to_virt );
 PROVIDE_UACCESS_INLINE ( flat, virt_to_phys );
+
+/* Virtual address offset user access API */
+PROVIDE_UACCESS_INLINE ( offset, phys_to_virt );
+PROVIDE_UACCESS_INLINE ( offset, virt_to_phys );
diff --git a/src/core/virt_offset.c b/src/core/virt_offset.c
deleted file mode 100644
index 23862d934..000000000
--- a/src/core/virt_offset.c
+++ /dev/null
@@ -1,36 +0,0 @@
-/*
- * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301, USA.
- *
- * You can also choose to distribute this program under the terms of
- * the Unmodified Binary Distribution Licence (as given in the file
- * COPYING.UBDL), provided that you have satisfied its requirements.
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#include <ipxe/uaccess.h>
-
-/**
- * @file
- *
- * Virtual offset memory model
- *
- */
-
-PROVIDE_UACCESS_INLINE ( offset, phys_to_virt );
-PROVIDE_UACCESS_INLINE ( offset, virt_to_phys );
diff --git a/src/include/bits/virt_offset.h b/src/include/bits/virt_offset.h
new file mode 100644
index 000000000..5f026284c
--- /dev/null
+++ b/src/include/bits/virt_offset.h
@@ -0,0 +1,15 @@
+#ifndef _BITS_VIRT_OFFSET_H
+#define _BITS_VIRT_OFFSET_H
+
+/** @file
+ *
+ * Dummy architecture-specific virtual address offset
+ *
+ * This file is included only if the architecture does not provide its
+ * own version of this file.
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#endif /* _BITS_VIRT_OFFSET_H */
diff --git a/src/include/ipxe/virt_offset.h b/src/include/ipxe/virt_offset.h
index f8f902753..311bf12fe 100644
--- a/src/include/ipxe/virt_offset.h
+++ b/src/include/ipxe/virt_offset.h
@@ -54,24 +54,20 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * This is defined to be the value to be added to an address within
  * iPXE's own image in order to obtain its physical address, as
  * described above.
- *
- * Note that if iPXE's image is not yet writable (i.e. during early
- * startup, prior to physical relocation), then this value may not yet
- * be valid.  Under these circumstances, callers must use
- * offset_phys_to_virt() and offset_virt_to_phys() instead (and so
- * provide the virtual address offset as a function parameter).
  */
 extern const unsigned long virt_offset;
 
+/** Allow for architecture-specific overrides of virt_offset */
+#include <bits/virt_offset.h>
+
 /**
  * Convert physical address to virtual address
  *
  * @v phys		Physical address
- * @v offset		Virtual address offset
  * @ret virt		Virtual address
  */
 static inline __always_inline void *
-offset_phys_to_virt ( unsigned long phys, unsigned long offset ) {
+UACCESS_INLINE ( offset, phys_to_virt ) ( unsigned long phys ) {
 
 	/* In a 64-bit build, any valid physical address is directly
 	 * usable as a virtual address, since physical addresses are
@@ -81,18 +77,17 @@ offset_phys_to_virt ( unsigned long phys, unsigned long offset ) {
 		return ( ( void * ) phys );
 
 	/* In a 32-bit build: subtract virt_offset */
-	return ( ( void * ) ( phys - offset ) );
+	return ( ( void * ) ( phys - virt_offset ) );
 }
 
 /**
  * Convert virtual address to physical address
  *
  * @v virt		Virtual address
- * @v offset		Virtual address offset
  * @ret phys		Physical address
  */
 static inline __always_inline physaddr_t
-offset_virt_to_phys ( volatile const void *virt, unsigned long offset ) {
+UACCESS_INLINE ( offset, virt_to_phys ) ( volatile const void *virt ) {
 	physaddr_t addr = ( ( physaddr_t ) virt );
 
 	/* In a 64-bit build, any valid virtual address with the MSB
@@ -110,31 +105,7 @@ offset_virt_to_phys ( volatile const void *virt, unsigned long offset ) {
 	/* In a 32-bit build or in a 64-bit build with a virtual
 	 * address with the MSB set: add virt_offset
 	 */
-	return ( addr + offset );
-}
-
-/**
- * Convert physical address to virtual address
- *
- * @v phys		Physical address
- * @ret virt		Virtual address
- */
-static inline __always_inline void *
-UACCESS_INLINE ( offset, phys_to_virt ) ( unsigned long phys ) {
-
-	return offset_phys_to_virt ( phys, virt_offset );
-}
-
-/**
- * Convert virtual address to physical address
- *
- * @v virt		Virtual address
- * @ret phys		Physical address
- */
-static inline __always_inline physaddr_t
-UACCESS_INLINE ( offset, virt_to_phys ) ( volatile const void *virt ) {
-
-	return offset_virt_to_phys ( virt, virt_offset );
+	return ( addr + virt_offset );
 }
 
 #endif /* _IPXE_VIRT_OFFSET_H */
-- 
cgit v1.2.3-55-g7522


From 6fe9ce66ae14537290ac9a2eb081a9fed3a16d1f Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Sun, 11 May 2025 17:35:47 +0100
Subject: [fdtmem] Add ability to parse FDT memory map for a relocation address

Add code to parse the devicetree memory nodes, memory reservations
block, and reserved memory nodes to construct an ordered and
non-overlapping description of the system memory map, and use this to
identify a suitable address to which iPXE may be relocated at runtime.

We choose to place iPXE on a superpage boundary (as required by the
paging code), and to use the highest available address within
accessible memory.  This mirrors the approach taken for x86 BIOS
builds, where we have long assumed that any image format that we might
need to support may require specific fixed addresses towards the
bottom of the memory map, but is very unlikely to require specific
fixed addresses towards the top of the memory map (since those
addresses may not exist, depending on the amount of installed RAM).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/libprefix.S |   8 +
 src/arch/riscv/scripts/sbi.lds    |   6 +
 src/core/fdtmem.c                 | 357 ++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/fdt.h            |  25 +++
 src/include/ipxe/fdtmem.h         |  17 ++
 5 files changed, 413 insertions(+)
 create mode 100644 src/core/fdtmem.c
 create mode 100644 src/include/ipxe/fdtmem.h

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index e9caa3945..a9d2ac0f1 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -401,6 +401,14 @@ paging_mode_names:
 #endif
 	.endm
 
+	/* Maximum physical alignment
+	 *
+	 * We align to a "megapage" boundary to simplify the task of
+	 * setting up page table mappings.
+	 */
+	.globl	_max_align
+	.equ	_max_align, ( 1 << VPN1_LSB )
+
 /*****************************************************************************
  *
  * Disable paging
diff --git a/src/arch/riscv/scripts/sbi.lds b/src/arch/riscv/scripts/sbi.lds
index efda0aa81..f746097ba 100644
--- a/src/arch/riscv/scripts/sbi.lds
+++ b/src/arch/riscv/scripts/sbi.lds
@@ -87,6 +87,9 @@ SECTIONS {
 	}
     }
 
+    /* End virtual address */
+    _end = .;
+
     /* Base virtual address */
     _base = ABSOLUTE ( _prefix );
 
@@ -97,6 +100,9 @@ SECTIONS {
     /* Length of initialised data */
     _filesz = ( ABSOLUTE ( _edata ) - ABSOLUTE ( _prefix ) );
 
+    /* Length of in-memory image */
+    _memsz = ( ABSOLUTE ( _end ) - ABSOLUTE ( _prefix ) );
+
     /* Unwanted sections */
     /DISCARD/ : {
 	*(.comment)
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
new file mode 100644
index 000000000..3a4b3fb1a
--- /dev/null
+++ b/src/core/fdtmem.c
@@ -0,0 +1,357 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <string.h>
+#include <errno.h>
+#include <assert.h>
+#include <byteswap.h>
+#include <ipxe/uaccess.h>
+#include <ipxe/fdt.h>
+#include <ipxe/fdtmem.h>
+
+/** @file
+ *
+ * Flattened Device Tree memory map
+ *
+ */
+
+/** Start address of the iPXE image */
+extern char _prefix[];
+
+/** In-memory size of the iPXE image (defined by linker) */
+extern size_t ABS_SYMBOL ( _memsz );
+static size_t memsz = ABS_VALUE_INIT ( _memsz );
+
+/** Relocation required alignment (defined by prefix or linker) */
+extern physaddr_t ABS_SYMBOL ( _max_align );
+static physaddr_t max_align = ABS_VALUE_INIT ( _max_align );
+
+/** Colour for debug messages */
+#define colour &memsz
+
+/** A memory region descriptor */
+struct fdtmem_region {
+	/** Region start address */
+	physaddr_t start;
+	/** Region end address */
+	physaddr_t end;
+	/** Region flags */
+	int flags;
+	/** Region name (for debug messages) */
+	const char *name;
+};
+
+/** Region is usable as RAM */
+#define FDTMEM_RAM 0x0001
+
+/**
+ * Update memory region descriptor
+ *
+ * @v region		Memory region of interest to be updated
+ * @v start		Start address of this region
+ * @v size		Size of this region
+ * @v flags		Region flags
+ * @v name		Region name (for debugging)
+ */
+static void fdtmem_update ( struct fdtmem_region *region, uint64_t start,
+			    uint64_t size, int flags, const char *name ) {
+	uint64_t end;
+
+	/* Ignore empty regions */
+	if ( ! size )
+		return;
+
+	/* Calculate end address (and truncate if necessary) */
+	end = ( start + size - 1 );
+	if ( end < start ) {
+		end = ~( ( uint64_t ) 0 );
+		DBGC ( colour, "FDTMEM [%#08llx,%#08llx] %s truncated "
+		       "(invalid size %#08llx)\n",
+		       ( ( unsigned long long ) start ),
+		       ( ( unsigned long long ) end ), name,
+		       ( ( unsigned long long ) size ) );
+	}
+
+	/* Ignore regions entirely below the region of interest */
+	if ( end < region->start )
+		return;
+
+	/* Ignore regions entirely above the region of interest */
+	if ( start > region->end )
+		return;
+
+	/* Update region of interest as applicable */
+	if ( start <= region->start ) {
+
+		/* This region covers the region of interest */
+		region->flags = flags;
+		if ( DBG_LOG )
+			region->name = name;
+
+		/* Update end address if no closer boundary exists */
+		if ( end < region->end )
+			region->end = end;
+
+	} else if ( start < region->end ) {
+
+		/* Update end address if no closer boundary exists */
+		region->end = ( start - 1 );
+	}
+}
+
+/**
+ * Update memory region descriptor based on device tree node
+ *
+ * @v region		Memory region of interest to be updated
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v match		Required device type (or NULL)
+ * @v flags		Region flags
+ * @ret rc		Return status code
+ */
+static int fdtmem_update_node ( struct fdtmem_region *region, struct fdt *fdt,
+				unsigned int offset, const char *match,
+				int flags ) {
+	struct fdt_descriptor desc;
+	struct fdt_reg_cells regs;
+	const char *devtype;
+	uint64_t start;
+	uint64_t size;
+	int depth;
+	int count;
+	int index;
+	int rc;
+
+	/* Parse region cell sizes */
+	fdt_reg_cells ( fdt, offset, &regs );
+
+	/* Scan through reservations */
+	for ( depth = -1 ; ; depth += desc.depth, offset = desc.next ) {
+
+		/* Describe token */
+		if ( ( rc = fdt_describe ( fdt, offset, &desc ) ) != 0 ) {
+			DBGC ( colour, "FDTMEM has malformed node: %s\n",
+			       strerror ( rc ) );
+			return rc;
+		}
+
+		/* Terminate when we exit this node */
+		if ( ( depth == 0 ) && ( desc.depth < 0 ) )
+			break;
+
+		/* Ignore any non-immediate child nodes */
+		if ( ! ( ( depth == 0 ) && desc.name && ( ! desc.data ) ) )
+			continue;
+
+		/* Ignore any non-matching children */
+		if ( match ) {
+			devtype = fdt_string ( fdt, desc.offset,
+					       "device_type" );
+			if ( ! devtype )
+				continue;
+			if ( strcmp ( devtype, match ) != 0 )
+				continue;
+		}
+
+		/* Count regions */
+		count = fdt_reg_count ( fdt, desc.offset, &regs );
+		if ( count < 0 ) {
+			rc = count;
+			DBGC ( colour, "FDTMEM has malformed region %s: %s\n",
+			       desc.name, strerror ( rc ) );
+			continue;
+		}
+
+		/* Scan through this region */
+		for ( index = 0 ; index < count ; index++ ) {
+
+			/* Get region starting address and size */
+			if ( ( rc = fdt_reg_address ( fdt, desc.offset, &regs,
+						      index, &start ) ) != 0 ){
+				DBGC ( colour, "FDTMEM %s region %d has "
+				       "malformed start address: %s\n",
+				       desc.name, index, strerror ( rc ) );
+				break;
+			}
+			if ( ( rc = fdt_reg_size ( fdt, desc.offset, &regs,
+						   index, &size ) ) != 0 ) {
+				DBGC ( colour, "FDTMEM %s region %d has "
+				       "malformed size: %s\n",
+				       desc.name, index, strerror ( rc ) );
+				break;
+			}
+
+			/* Update memory region descriptor */
+			fdtmem_update ( region, start, size, flags,
+					desc.name );
+		}
+	}
+
+	return 0;
+}
+
+/**
+ * Update memory region descriptor based on device tree
+ *
+ * @v region		Memory region of interest to be updated
+ * @v fdt		Device tree
+ * @ret rc		Return status code
+ */
+static int fdtmem_update_tree ( struct fdtmem_region *region,
+				struct fdt *fdt ) {
+	const struct fdt_reservation *rsv;
+	unsigned int offset;
+	int rc;
+
+	/* Update based on memory regions in the root node */
+	if ( ( rc = fdtmem_update_node ( region, fdt, 0, "memory",
+					 FDTMEM_RAM ) ) != 0 )
+		return rc;
+
+	/* Update based on memory reservations block */
+	for_each_fdt_reservation ( rsv, fdt ) {
+		fdtmem_update ( region, be64_to_cpu ( rsv->start ),
+				be64_to_cpu ( rsv->size ), 0, "<rsv>" );
+	}
+
+	/* Locate reserved-memory node */
+	if ( ( rc = fdt_path ( fdt, "/reserved-memory", &offset ) ) != 0 ) {
+		DBGC ( colour, "FDTMEM could not locate /reserved-memory: "
+		       "%s\n", strerror ( rc ) );
+		return rc;
+	}
+
+	/* Update based on memory regions in the reserved-memory node */
+	if ( ( rc = fdtmem_update_node ( region, fdt, offset, NULL,
+					 0 ) ) != 0 )
+		return rc;
+
+	return 0;
+}
+
+/**
+ * Find a relocation address for iPXE
+ *
+ * @v hdr		FDT header
+ * @v limit		Size of accessible physical address space (or zero)
+ * @ret new		New physical address for relocation
+ *
+ * Find a suitably aligned address towards the top of existent memory
+ * to which iPXE may be relocated, along with a copy of the system
+ * device tree.
+ *
+ * This function may be called very early in initialisation, before
+ * .data is writable or .bss has been zeroed.  Neither this function
+ * nor any function that it calls may write to or rely upon the zero
+ * initialisation of any static variables.
+ */
+physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
+	struct fdt fdt;
+	struct fdtmem_region region;
+	physaddr_t old;
+	physaddr_t new;
+	physaddr_t try;
+	size_t len;
+	int rc;
+
+	/* Sanity check */
+	assert ( ( max_align & ( max_align - 1 ) ) == 0 );
+
+	/* Get current physical address */
+	old = virt_to_phys ( _prefix );
+
+	/* Parse FDT */
+	if ( ( rc = fdt_parse ( &fdt, hdr, -1UL ) ) != 0 ) {
+		DBGC ( colour, "FDTMEM could not parse FDT: %s\n",
+		       strerror ( rc ) );
+		/* Refuse relocation if we have no FDT */
+		return old;
+	}
+
+	/* Determine required length */
+	assert ( memsz > 0 );
+	assert ( ( memsz % FDT_MAX_ALIGN ) == 0 );
+	assert ( ( fdt.len % FDT_MAX_ALIGN ) == 0 );
+	len = ( memsz + fdt.len );
+	assert ( len > 0 );
+	DBGC ( colour, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
+	       "relocation\n", memsz, fdt.len, len );
+
+	/* Construct memory map and choose a relocation address */
+	region.start = 0;
+	new = old;
+	while ( 1 ) {
+
+		/* Initialise region */
+		region.end = ~( ( physaddr_t ) 0 );
+		region.flags = 0;
+		region.name = "<empty>";
+
+		/* Update region based on device tree */
+		if ( ( rc = fdtmem_update_tree ( &region, &fdt ) ) != 0 )
+			break;
+
+		/* Treat existing iPXE image as reserved */
+		fdtmem_update ( &region, old, memsz, 0, "iPXE" );
+
+		/* Treat existing device tree as reserved */
+		fdtmem_update ( &region, virt_to_phys ( hdr ), fdt.len, 0,
+				"FDT" );
+
+		/* Treat inaccessible physical memory as reserved */
+		if ( limit ) {
+			fdtmem_update ( &region, limit, -limit, 0,
+					"<inaccessible>" );
+		}
+
+		/* Dump region descriptor (for debugging) */
+		DBGC ( colour, "FDTMEM [%#08lx,%#08lx] %s\n",
+		       region.start, region.end, region.name );
+		assert ( region.end >= region.start );
+
+		/* Use highest possible region */
+		if ( ( region.flags & FDTMEM_RAM ) &&
+		     ( ( region.end - region.start ) > len ) ) {
+
+			/* Determine candidate address after alignment */
+			try = ( ( region.end - len - 1 ) &
+				~( max_align - 1 ) );
+
+			/* Use this address if within region */
+			if ( try >= region.start )
+				new = try;
+		}
+
+		/* Move to next region */
+		region.start = ( region.end + 1 );
+		if ( ! region.start )
+			break;
+	}
+
+	DBGC ( colour, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
+	       old, new, ( ( physaddr_t ) ( new + len - 1 ) ) );
+	return new;
+}
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 6c58f5687..45ae0f92b 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -76,6 +76,14 @@ struct fdt_prop {
 /** Maximum alignment of any block */
 #define FDT_MAX_ALIGN 8
 
+/** A memory reservation */
+struct fdt_reservation {
+	/** Starting address */
+	uint64_t start;
+	/** Length of reservation */
+	uint64_t size;
+} __attribute__ (( packed ));
+
 /** A device tree */
 struct fdt {
 	/** Tree data */
@@ -143,6 +151,23 @@ struct fdt_reg_cells {
 extern struct image_tag fdt_image __image_tag;
 extern struct fdt sysfdt;
 
+/**
+ * Get memory reservations
+ *
+ * @v fdt		Device tree
+ * @ret rsv		Memory reservations
+ */
+static inline const struct fdt_reservation *
+fdt_reservations ( struct fdt *fdt ) {
+
+	return ( fdt->raw + fdt->reservations );
+}
+
+/** Iterate over memory reservations */
+#define for_each_fdt_reservation( rsv, fdt )			\
+	for ( rsv = fdt_reservations ( (fdt) ) ;		\
+	      ( (rsv)->start || (rsv)->size ) ; rsv++ )
+
 extern int fdt_describe ( struct fdt *fdt, unsigned int offset,
 			  struct fdt_descriptor *desc );
 extern int fdt_path ( struct fdt *fdt, const char *path,
diff --git a/src/include/ipxe/fdtmem.h b/src/include/ipxe/fdtmem.h
new file mode 100644
index 000000000..98395b8e9
--- /dev/null
+++ b/src/include/ipxe/fdtmem.h
@@ -0,0 +1,17 @@
+#ifndef _IPXE_FDTMEM_H
+#define _IPXE_FDTMEM_H
+
+/** @file
+ *
+ * Flattened Device Tree memory map
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <ipxe/fdt.h>
+
+extern physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit );
+
+#endif /* _IPXE_FDTMEM_H */
-- 
cgit v1.2.3-55-g7522


From 17fd67ce03179cb3ed0e16c309d2a7f78e29c919 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 12 May 2025 11:58:23 +0100
Subject: [riscv] Relocate to a safe physical address on startup

On startup, we may be running from read-only memory.  We need to parse
the devicetree to obtain the system memory map, and identify a safe
location to which we can copy our own binary image along with a
stashed copy of the devicetree, and then transfer execution to this
new location.

Parsing the system memory map realistically requires running C code.
This in turn requires a small temporary stack, and some way to ensure
that symbol references are valid.

We first attempt to enable paging, to make the runtime virtual
addresses equal to the link-time virtual addresses.  If this fails,
then we attempt to apply the compressed relocation records.

Assuming that one of these has worked (i.e. that either the CPU
supports paging or that our image started execution in writable
memory), then we call fdtmem_relocate() to parse the system memory map
to find a suitable relocation target address.

After the copy we disable paging, jump to the relocated copy,
re-enable paging, and reapply relocation records (if needed).  At this
point, we have a full runtime environment, and can transfer control to
normal C code.

Provide this functionality as part of libprefix.S, since it is likely
to be shared by multiple prefixes.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/libprefix.S | 201 ++++++++++++++++++++++++++++++++++++++
 src/arch/riscv/prefix/sbiprefix.S |  78 +++------------
 src/arch/riscv/scripts/sbi.lds    |   2 +
 src/core/fdtmem.c                 |  14 ++-
 4 files changed, 230 insertions(+), 65 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index a24b34fa4..c5f4961c0 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -224,6 +224,17 @@ print_hex_value_alt:
 #endif
 	.endm
 
+	/*
+	 * Display hexadecimal data value (if debugging is enabled)
+	 */
+	.macro	print_hex_data sym
+#ifndef NDEBUG
+	LOADN	t1, \sym
+	li	t2, __riscv_xlen
+	jal	t0, print_hex_value_alt
+#endif
+	.endm
+
 /*****************************************************************************
  *
  * Apply compressed relocation records
@@ -296,8 +307,20 @@ apply_relocs_loop:
 	/* Loop until we have reached a terminator record (MSB=0, offset=0) */
 	bnez	a3, apply_relocs_loop
 
+	/* Check that relocations were applied successfully
+	 *
+	 * Failure to apply relocations (if relocations were needed)
+	 * is a fatal error.
+	 */
+	la	t0, _prefix
+	LOADN	t1, prefix_virt
+	beq	t0, t1, apply_relocs_done
+	progress " failed\n"
+	j	reset_system
+
 apply_relocs_done:
 	/* Return to caller */
+	progress " ok\n"
 	ret
 	.size	apply_relocs, . - apply_relocs
 
@@ -424,6 +447,21 @@ paging_mode_names:
 	.globl	_max_align
 	.equ	_max_align, ( 1 << VPN1_LSB )
 
+	/* Space for page table
+	 *
+	 * This can be used only once .bss is known to be writable.
+	 */
+	.section ".bss.page_table", "a", @nobits
+	.balign	PAGE_SIZE
+page_table:
+	.space	PAGE_SIZE
+	.size	page_table, . - page_table
+
+	/* Convert physical address to virtual address */
+	.macro	phys_to_virt rd, rs:vararg
+	_C2 ( phys_to_virt_, __riscv_xlen ) \rd, \rs
+	.endm
+
 /*****************************************************************************
  *
  * Disable paging
@@ -643,6 +681,13 @@ enable_paging_64_loop:
 	ret
 	.size	enable_paging_64, . - enable_paging_64
 
+	/* Convert 64-bit physical address to virtual address */
+	.macro	phys_to_virt_64 rd, rs:vararg
+	.ifnb	\rs
+	mv	\rd, \rs
+	.endif
+	.endm
+
 /*****************************************************************************
  *
  * Disable 64-bit paging
@@ -807,6 +852,15 @@ enable_paging_32_xstart:
 	.section ".bss.enable_paging_32_xcheck", "aw", @nobits
 	.org	. + enable_paging_32_xalign - enable_paging_32_xlen
 
+	/* Convert 32-bit physical address to virtual address */
+	.macro	phys_to_virt_32 rd, rs:vararg
+	.ifnb	\rs
+	sub	\rd, \rs, tp
+	.else
+	sub	\rd, \rd, tp
+	.endif
+	.endm
+
 /*****************************************************************************
  *
  * Disable 32-bit paging
@@ -880,6 +934,126 @@ disable_paging_32_xstart:
 	.section ".bss.disable_paging_32_xcheck", "aw", @nobits
 	.org	. + disable_paging_32_xalign - disable_paging_32_xlen
 
+/*****************************************************************************
+ *
+ * Install iPXE to a suitable runtime address
+ *
+ *****************************************************************************
+ *
+ * Identify a suitable runtime address for iPXE, relocate there, and
+ * set up for running normal C code.
+ *
+ * A valid temporary stack pointer is required.  A 4kB space for a
+ * temporary page table may be provided, and must be provided if the
+ * iPXE image is running from read-only memory.
+ *
+ * Note that this function does not preserve the callee-save registers.
+ *
+ * Parameters:
+ *
+ *   a0 - Boot hart ID
+ *   a1 - Device tree physical address
+ *   a2 - Optional temporary page table space (4kB, aligned to a 4kB boundary)
+ *   sp - Valid temporary stack pointer
+ *
+ * Returns:
+ *
+ *   pc - Updated to be within the relocated iPXE
+ *   sp - Top of internal stack
+ *   tp - Virtual address offset
+ *
+ */
+
+	.section ".prefix.install", "ax", @progbits
+	.globl	install
+install:
+	/* Register usage:
+	 *
+	 * s0 - boot hart ID
+	 * s1 - device tree physical address
+	 * s2 - saved return address
+	 * s3 - relocation records physical address
+	 * s4 - accessible physical address limit
+	 * s5 - relocation physical address
+	 * s6 - relocation offset
+	 * tp - virtual address offset
+	 */
+	progress "\nSBI->iPXE hart:"
+	print_hex_reg a0
+	progress " temp:"
+	print_hex_reg a2
+	progress " fdt:"
+	print_hex_reg a1
+	progress "\nSBI->iPXE phys:"
+	print_hex_addr _prefix
+	progress " virt:"
+	print_hex_data prefix_virt
+	mv	s0, a0
+	mv	s1, a1
+	mv	s2, ra
+	la	s3, _edata
+
+	/* Initialise virtual address offset */
+	mv	tp, zero
+
+	/* Attempt to enable paging, if we have temporary page table space */
+	mv	a0, a2
+	beqz	a2, 1f
+	call	enable_paging
+1:	mv	s4, a0
+
+	/* Apply relocations, if still needed after enabling paging */
+	mv	a0, s3
+	call	apply_relocs
+
+	/* Find a suitable address for relocation (using temporary stack) */
+	phys_to_virt a0, s1
+	mv	a1, s4
+	phys_to_virt sp
+	call	fdtmem_relocate
+	mv	s5, a0
+	progress "SBI->iPXE dest:"
+	print_hex_reg a0
+
+	/* Disable paging */
+	call	disable_paging
+
+	/* Determine relocation offset */
+	la	s6, _prefix
+	sub	s6, s5, s6
+
+	/* Jump to relocated copy */
+	la	t0, 1f
+	add	t0, t0, s6
+	jr	t0
+1:
+	/* Attempt to re-enable paging */
+	la	a0, page_table
+	call	enable_paging
+
+	/* Reapply relocations, if still needed after enabling paging */
+	phys_to_virt a0, s3
+	call	apply_relocs
+
+	/* Load stack pointer */
+	la	sp, _estack
+
+	/* Store boot hart */
+	STOREN	s0, boot_hart, t0
+
+	/* Register copy of device tree as system device tree */
+	la	a0, sysfdt
+	la	a1, _end
+	li	a2, -1
+	call	fdt_parse
+
+	/* Return to a virtual address in the relocated copy */
+	add	ra, s2, s6
+	sub	ra, ra, tp
+	progress "\n"
+	ret
+	.size	install, . - install
+
 /*****************************************************************************
  *
  * Reset (or lock up) system
@@ -921,3 +1095,30 @@ reset_system:
 1:	wfi
 	j	1b
 	.size	reset_system, . - reset_system
+
+/*****************************************************************************
+ *
+ * File split information for the compressor
+ *
+ *****************************************************************************
+ */
+
+/* ELF machine type */
+#define EM_RISCV 243
+
+	.section ".zinfo", "a", @progbits
+	.org	0
+	/* Copy initialised-data portion of image */
+	.ascii	"COPY"
+	.word	0
+	.word	_filesz
+	.word	1
+	/* Notify compressor of link-time base address */
+	.ascii	"BASE"
+	.word	0
+	.dword	_base
+	/* Construct compressed relocation records */
+	.ascii	"ZREL"
+	.word	_reloc_offset
+	.word	_reloc_filesz
+	.word	EM_RISCV
diff --git a/src/arch/riscv/prefix/sbiprefix.S b/src/arch/riscv/prefix/sbiprefix.S
index e83167602..da3202aa2 100644
--- a/src/arch/riscv/prefix/sbiprefix.S
+++ b/src/arch/riscv/prefix/sbiprefix.S
@@ -32,23 +32,8 @@
 	.section ".note.GNU-stack", "", @progbits
 	.text
 
-/* ELF machine type */
-#define EM_RISCV 243
-
-	/*
-	 * Display progress message via debug console
-	 */
-	.macro	progress message
-#ifndef NDEBUG
-	.section ".rodata.progress_\@", "a", @progbits
-progress_\@:
-	.asciz	"\message"
-	.size	progress_\@, . - progress_\@
-	.previous
-	la	t1, progress_\@
-	call	print_message
-#endif
-	.endm
+/* Page size */
+#define PAGE_SIZE 4096
 
 	/*
 	 * SBI entry point
@@ -57,42 +42,21 @@ progress_\@:
 	.org 0
 	.globl	_sbi_start
 _sbi_start:
-	/* Initialise virtual address offset */
-	mv	tp, zero
-
-	/* Preserve arguments */
-	mv	s0, a0
-	mv	s1, a1
-	progress "\nSBI->iPXE"
-
-	/* Apply dynamic relocations */
-	la	a0, _edata
-	call	apply_relocs
-	progress " .reloc"
-
-	/* Zero the bss */
-	la	t0, _bss
-	la	t1, _ebss
-1:	STOREN	zero, (t0)
-	addi	t0, t0, ( __riscv_xlen / 8 )
-	blt	t0, t1, 1b
-	progress " .bss"
-
-	/* Set up stack */
-	la	sp, _estack
-	progress " .stack"
-
-	/* Store boot hart */
-	STOREN	s0, boot_hart, t0
+	/* Identify temporary page table and stack space
+	 *
+	 * Assume that there is sufficient writable memory (~8kB)
+	 * directly below the device tree.
+	 */
+	li	t0, ~( PAGE_SIZE - 1 )
+	and	sp, a1, t0
+	li	t0, PAGE_SIZE
+	sub	sp, sp, t0
+	mv	a2, sp
 
-	/* Register device tree */
-	la	a0, sysfdt
-	mv	a1, s1
-	li	a2, -1
-	call	fdt_parse
+	/* Install iPXE */
+	call	install
 
 	/* Call main program */
-	progress "\n\n"
 	call	main
 
 	/* We have no return path, since the M-mode SBI implementation
@@ -104,17 +68,3 @@ _sbi_start:
 	 */
 	j	reset_system
 	.size	_sbi_start, . - _sbi_start
-
-	/* File split information for the compressor */
-	.section ".zinfo", "a", @progbits
-	.ascii	"COPY"
-	.word	0
-	.word	_filesz
-	.word	1
-	.ascii	"BASE"
-	.word	0
-	.dword	_base
-	.ascii	"ZREL"
-	.word	_reloc_offset
-	.word	_reloc_filesz
-	.word	EM_RISCV
diff --git a/src/arch/riscv/scripts/sbi.lds b/src/arch/riscv/scripts/sbi.lds
index f746097ba..9fec07ecb 100644
--- a/src/arch/riscv/scripts/sbi.lds
+++ b/src/arch/riscv/scripts/sbi.lds
@@ -53,6 +53,8 @@ SECTIONS {
 	KEEP(*(.provided.*))
 	*(.got)
 	*(.got.plt)
+	/* Ensure compressed relocations end up aligned */
+	. = ALIGN ( 16 );
 	_edata = .;
     }
 
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index 3a4b3fb1a..a41604eb5 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -41,6 +41,10 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /** Start address of the iPXE image */
 extern char _prefix[];
 
+/** Initialised-data size of the iPXE image (defined by linker) */
+extern size_t ABS_SYMBOL ( _filesz );
+static size_t filesz = ABS_VALUE_INIT ( _filesz );
+
 /** In-memory size of the iPXE image (defined by linker) */
 extern size_t ABS_SYMBOL ( _memsz );
 static size_t memsz = ABS_VALUE_INIT ( _memsz );
@@ -275,6 +279,7 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 	physaddr_t new;
 	physaddr_t try;
 	size_t len;
+	void *dest;
 	int rc;
 
 	/* Sanity check */
@@ -294,7 +299,6 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 	/* Determine required length */
 	assert ( memsz > 0 );
 	assert ( ( memsz % FDT_MAX_ALIGN ) == 0 );
-	assert ( ( fdt.len % FDT_MAX_ALIGN ) == 0 );
 	len = ( memsz + fdt.len );
 	assert ( len > 0 );
 	DBGC ( colour, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
@@ -351,6 +355,14 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 			break;
 	}
 
+	/* Copy iPXE and device tree to new location */
+	if ( new != old ) {
+		dest = phys_to_virt ( new );
+		memset ( dest, 0, len );
+		memcpy ( dest, _prefix, filesz );
+		memcpy ( ( dest + memsz ), hdr, fdt.len );
+	}
+
 	DBGC ( colour, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
 	       old, new, ( ( physaddr_t ) ( new + len - 1 ) ) );
 	return new;
-- 
cgit v1.2.3-55-g7522


From 4566f5975791dfc9454952ee5313e1e74fb42211 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 13 May 2025 13:46:35 +0100
Subject: [riscv] Avoid potentially overwriting the scratch area during
 relocation

We do not currently describe the temporary page table or the temporary
stack as areas to be avoided during relocation of the iPXE image to a
new physical address.

Perform the copy of the iPXE image and zeroing of the .bss within
libprefix.S, after we have no futher use for the temporary page table
or the temporary initial stack.  Perform the copy and registration of
the system device tree in C code after relocation is complete and the
new stack (within .bss) has been set up.

This provides a clean separation of responsibilities between the
RISC-V libprefix.S and the architecture-independent fdtmem.c.  The
prefix is responsible only for relocating iPXE to the new physical
address returned from fdtmem_relocate(), and doesn't need to know or
care where fdtmem.c is planning to place the copy of the device tree.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/libprefix.S | 23 +++++++++++++----
 src/core/fdtmem.c                 | 54 +++++++++++++++++++++++++++------------
 src/include/ipxe/fdtmem.h         |  1 +
 3 files changed, 56 insertions(+), 22 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index e47bab981..69b9f9ba2 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -1023,6 +1023,21 @@ install:
 	la	s6, _prefix
 	sub	s6, s5, s6
 
+	/* Copy iPXE image to new location and zero .bss */
+	mv	t0, s5
+	la	t1, _prefix
+	la	t2, _edata
+1:	LOADN	t3, (t1)
+	STOREN	t3, (t0)
+	addi	t0, t0, ( __riscv_xlen / 8 )
+	addi	t1, t1, ( __riscv_xlen / 8 )
+	blt	t1, t2, 1b
+	la	t1, _ebss
+	add	t1, t1, s6
+2:	STOREN	zero, (t0)
+	addi	t0, t0, ( __riscv_xlen / 8 )
+	blt	t0, t1, 2b
+
 	/* Jump to relocated copy */
 	la	t0, 1f
 	add	t0, t0, s6
@@ -1042,11 +1057,9 @@ install:
 	/* Store boot hart */
 	STOREN	s0, boot_hart, t0
 
-	/* Register copy of device tree as system device tree */
-	la	a0, sysfdt
-	la	a1, _end
-	li	a2, -1
-	call	fdt_parse
+	/* Copy and register system device tree */
+	phys_to_virt a0, s1
+	call	fdtmem_register
 
 	/* Return to a virtual address in the relocated copy */
 	add	ra, s2, s6
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index a41604eb5..9e8ab2406 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -41,20 +41,15 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /** Start address of the iPXE image */
 extern char _prefix[];
 
-/** Initialised-data size of the iPXE image (defined by linker) */
-extern size_t ABS_SYMBOL ( _filesz );
-static size_t filesz = ABS_VALUE_INIT ( _filesz );
-
-/** In-memory size of the iPXE image (defined by linker) */
-extern size_t ABS_SYMBOL ( _memsz );
-static size_t memsz = ABS_VALUE_INIT ( _memsz );
+/** End address of the iPXE image */
+extern char _end[];
 
 /** Relocation required alignment (defined by prefix or linker) */
 extern physaddr_t ABS_SYMBOL ( _max_align );
 static physaddr_t max_align = ABS_VALUE_INIT ( _max_align );
 
 /** Colour for debug messages */
-#define colour &memsz
+#define colour &_prefix[0]
 
 /** A memory region descriptor */
 struct fdtmem_region {
@@ -278,8 +273,8 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 	physaddr_t old;
 	physaddr_t new;
 	physaddr_t try;
+	size_t memsz;
 	size_t len;
-	void *dest;
 	int rc;
 
 	/* Sanity check */
@@ -297,6 +292,7 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 	}
 
 	/* Determine required length */
+	memsz = ( _end - _prefix );
 	assert ( memsz > 0 );
 	assert ( ( memsz % FDT_MAX_ALIGN ) == 0 );
 	len = ( memsz + fdt.len );
@@ -355,15 +351,39 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 			break;
 	}
 
-	/* Copy iPXE and device tree to new location */
-	if ( new != old ) {
-		dest = phys_to_virt ( new );
-		memset ( dest, 0, len );
-		memcpy ( dest, _prefix, filesz );
-		memcpy ( ( dest + memsz ), hdr, fdt.len );
-	}
-
 	DBGC ( colour, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
 	       old, new, ( ( physaddr_t ) ( new + len - 1 ) ) );
 	return new;
 }
+
+/**
+ * Copy and register system device tree
+ *
+ * @v hdr		FDT header
+ * @ret rc		Return status code
+ */
+int fdtmem_register ( struct fdt_header *hdr ) {
+	struct fdt_header *copy;
+	struct fdt fdt;
+	int rc;
+
+	/* Parse FDT to obtain length */
+	if ( ( rc = fdt_parse ( &fdt, hdr, -1UL ) ) != 0 ) {
+		DBGC ( colour, "FDTMEM could not parse FDT: %s\n",
+		       strerror ( rc ) );
+		return rc;
+	}
+
+	/* Copy device tree to end of iPXE image */
+	copy = ( ( void * ) _end );
+	memcpy ( copy, hdr, fdt.len );
+
+	/* Register copy as system device tree */
+	if ( ( rc = fdt_parse ( &sysfdt, copy, -1UL ) ) != 0 ) {
+		DBGC ( colour, "FDTMEM could not register FDT: %s\n",
+		       strerror ( rc ) );
+		return rc;
+	}
+
+	return 0;
+}
diff --git a/src/include/ipxe/fdtmem.h b/src/include/ipxe/fdtmem.h
index 98395b8e9..a5777f6a2 100644
--- a/src/include/ipxe/fdtmem.h
+++ b/src/include/ipxe/fdtmem.h
@@ -13,5 +13,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/fdt.h>
 
 extern physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit );
+extern int fdtmem_register ( struct fdt_header *hdr );
 
 #endif /* _IPXE_FDTMEM_H */
-- 
cgit v1.2.3-55-g7522


From e0c4cfa81e7ff919f594a6aca8416536c855838d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 14 May 2025 22:09:51 +0100
Subject: [fdtmem] Record size of accessible physical address space

The size of accessible physical address space will be required for the
runtime memory map, not just at relocation time.  Make this size an
additional parameter to fdt_register() (matching the prototype for
fdt_relocate()), and record the value for future reference.

Note that we cannot simply store the limit in fdt_relocate() since it
is called before .data is writable and before .bss is zeroed.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/libprefix.S | 1 +
 src/core/fdtmem.c                 | 9 ++++++++-
 src/include/ipxe/fdtmem.h         | 2 +-
 3 files changed, 10 insertions(+), 2 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index b011616da..834a48655 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -1088,6 +1088,7 @@ install:
 
 	/* Copy and register system device tree */
 	phys_to_virt a0, s1
+	mv	a1, s4
 	call	fdtmem_register
 
 	/* Return to a virtual address in the relocated copy */
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index 9e8ab2406..18ae5ce96 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -66,6 +66,9 @@ struct fdtmem_region {
 /** Region is usable as RAM */
 #define FDTMEM_RAM 0x0001
 
+/** Size of accessible physical address space (or zero for no limit) */
+static size_t fdtmem_limit;
+
 /**
  * Update memory region descriptor
  *
@@ -360,13 +363,17 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
  * Copy and register system device tree
  *
  * @v hdr		FDT header
+ * @v limit		Size of accessible physical address space (or zero)
  * @ret rc		Return status code
  */
-int fdtmem_register ( struct fdt_header *hdr ) {
+int fdtmem_register ( struct fdt_header *hdr, size_t limit ) {
 	struct fdt_header *copy;
 	struct fdt fdt;
 	int rc;
 
+	/* Record size of accessible physical address space */
+	fdtmem_limit = limit;
+
 	/* Parse FDT to obtain length */
 	if ( ( rc = fdt_parse ( &fdt, hdr, -1UL ) ) != 0 ) {
 		DBGC ( colour, "FDTMEM could not parse FDT: %s\n",
diff --git a/src/include/ipxe/fdtmem.h b/src/include/ipxe/fdtmem.h
index a5777f6a2..1bf0015b4 100644
--- a/src/include/ipxe/fdtmem.h
+++ b/src/include/ipxe/fdtmem.h
@@ -13,6 +13,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/fdt.h>
 
 extern physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit );
-extern int fdtmem_register ( struct fdt_header *hdr );
+extern int fdtmem_register ( struct fdt_header *hdr, size_t limit );
 
 #endif /* _IPXE_FDTMEM_H */
-- 
cgit v1.2.3-55-g7522


From bab3d7671790dd6a318cc5b72000419c5061e86f Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 14 May 2025 22:19:54 +0100
Subject: [memmap] Define an API for managing the system memory map

Define a generic system memory map API, based on the abstraction
created for parsing the FDT memory map and adding a concept of hidden
in-use memory regions as required to support patching the BIOS INT 15
memory map.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/config/defaults/efi.h      |   1 +
 src/config/defaults/linux.h    |   1 +
 src/config/defaults/pcbios.h   |   1 +
 src/config/defaults/sbi.h      |   1 +
 src/core/memmap.c              | 114 ++++++++++++++++++++
 src/include/bits/memmap.h      |  15 +++
 src/include/ipxe/memmap.h      | 235 +++++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/null_memmap.h |  44 ++++++++
 8 files changed, 412 insertions(+)
 create mode 100644 src/core/memmap.c
 create mode 100644 src/include/bits/memmap.h
 create mode 100644 src/include/ipxe/memmap.h
 create mode 100644 src/include/ipxe/null_memmap.h

(limited to 'src/core')

diff --git a/src/config/defaults/efi.h b/src/config/defaults/efi.h
index 0ba9f3ee7..ada08973e 100644
--- a/src/config/defaults/efi.h
+++ b/src/config/defaults/efi.h
@@ -16,6 +16,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_EFI
 #define TIMER_EFI
 #define UMALLOC_EFI
+#define MEMMAP_NULL
 #define SMBIOS_EFI
 #define SANBOOT_EFI
 #define BOFM_EFI
diff --git a/src/config/defaults/linux.h b/src/config/defaults/linux.h
index fae144b3d..bb14fd9a7 100644
--- a/src/config/defaults/linux.h
+++ b/src/config/defaults/linux.h
@@ -13,6 +13,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #define TIMER_LINUX
 #define UACCESS_LINUX
 #define UMALLOC_LINUX
+#define MEMMAP_NULL
 #define NAP_LINUX
 #define SMBIOS_LINUX
 #define SANBOOT_DUMMY
diff --git a/src/config/defaults/pcbios.h b/src/config/defaults/pcbios.h
index 13532e429..bdc62e8e0 100644
--- a/src/config/defaults/pcbios.h
+++ b/src/config/defaults/pcbios.h
@@ -17,6 +17,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_PCBIOS
 #define NAP_PCBIOS
 #define UMALLOC_MEMTOP
+#define MEMMAP_NULL
 #define SMBIOS_PCBIOS
 #define SANBOOT_PCBIOS
 #define ENTROPY_RTC
diff --git a/src/config/defaults/sbi.h b/src/config/defaults/sbi.h
index 268bf0afe..e12cf1af9 100644
--- a/src/config/defaults/sbi.h
+++ b/src/config/defaults/sbi.h
@@ -19,6 +19,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_SBI
 #define REBOOT_SBI
 #define UMALLOC_SBI
+#define MEMMAP_NULL
 
 #define ACPI_NULL
 #define MPAPI_NULL
diff --git a/src/core/memmap.c b/src/core/memmap.c
new file mode 100644
index 000000000..5b95b6c0a
--- /dev/null
+++ b/src/core/memmap.c
@@ -0,0 +1,114 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <assert.h>
+#include <ipxe/memmap.h>
+
+/** @file
+ *
+ * System memory map
+ *
+ */
+
+/**
+ * Update memory region descriptor
+ *
+ * @v region		Memory region of interest to be updated
+ * @v start		Start address of known region
+ * @v size		Size of known region
+ * @v flags		Flags for known region
+ * @v name		Name of known region (for debugging)
+ *
+ * Update a memory region descriptor based on a known existent region.
+ */
+void memmap_update ( struct memmap_region *region, uint64_t start,
+		     uint64_t size, unsigned int flags, const char *name ) {
+	uint64_t last;
+
+	/* Sanity check */
+	assert ( region->last >= region->addr );
+
+	/* Ignore empty regions */
+	if ( ! size )
+		return;
+
+	/* Calculate last addresses (and truncate if necessary) */
+	last = ( start + size - 1 );
+	if ( last < start ) {
+		last = ~( ( uint64_t ) 0 );
+		DBGC ( region, "MEMMAP [%#08llx,%#08llx] %s truncated "
+		       "(invalid size %#08llx)\n",
+		       ( ( unsigned long long ) start ),
+		       ( ( unsigned long long ) last ), name,
+		       ( ( unsigned long long ) size ) );
+	}
+
+	/* Ignore regions entirely below the region of interest */
+	if ( last < region->addr )
+		return;
+
+	/* Ignore regions entirely above the region of interest */
+	if ( start > region->last )
+		return;
+
+	/* Update region of interest as applicable */
+	if ( start <= region->addr ) {
+
+		/* Record this region as covering the region of interest */
+		region->flags |= flags;
+		if ( name )
+			region->name = name;
+
+		/* Update last address if no closer boundary exists */
+		if ( last < region->last )
+			region->last = last;
+
+	} else if ( start < region->last ) {
+
+		/* Update last address if no closer boundary exists */
+		region->last = ( start - 1 );
+	}
+
+	/* Sanity check */
+	assert ( region->last >= region->addr );
+}
+
+/**
+ * Update memory region descriptor based on all in-use memory regions
+ *
+ * @v region		Memory region of interest to be updated
+ */
+void memmap_update_used ( struct memmap_region *region ) {
+	struct used_region *used;
+
+	/* Update descriptor to hide all in-use regions */
+	for_each_table_entry ( used, USED_REGIONS ) {
+		memmap_update ( region, used->start, used->size,
+				MEMMAP_FL_USED, used->name );
+	}
+}
+
+PROVIDE_MEMMAP_INLINE ( null, memmap_describe );
+PROVIDE_MEMMAP_INLINE ( null, memmap_sync );
diff --git a/src/include/bits/memmap.h b/src/include/bits/memmap.h
new file mode 100644
index 000000000..d51ee4993
--- /dev/null
+++ b/src/include/bits/memmap.h
@@ -0,0 +1,15 @@
+#ifndef _BITS_MEMMAP_H
+#define _BITS_MEMMAP_H
+
+/** @file
+ *
+ * Dummy architecture-specific system memory map
+ *
+ * This file is included only if the architecture does not provide its
+ * own version of this file.
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#endif /* _BITS_MEMMAP_H */
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
new file mode 100644
index 000000000..382032ee9
--- /dev/null
+++ b/src/include/ipxe/memmap.h
@@ -0,0 +1,235 @@
+#ifndef _IPXE_MEMMAP_H
+#define _IPXE_MEMMAP_H
+
+/** @file
+ *
+ * System memory map
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stddef.h>
+#include <stdint.h>
+#include <ipxe/api.h>
+#include <ipxe/tables.h>
+#include <config/ioapi.h>
+
+/**
+ * Calculate static inline memory map API function name
+ *
+ * @v _prefix		Subsystem prefix
+ * @v _api_func		API function
+ * @ret _subsys_func	Subsystem API function
+ */
+#define MEMMAP_INLINE( _subsys, _api_func ) \
+	SINGLE_API_INLINE ( MEMMAP_PREFIX_ ## _subsys, _api_func )
+
+/**
+ * Provide a memory map API implementation
+ *
+ * @v _prefix		Subsystem prefix
+ * @v _api_func		API function
+ * @v _func		Implementing function
+ */
+#define PROVIDE_MEMMAP( _subsys, _api_func, _func ) \
+	PROVIDE_SINGLE_API ( MEMMAP_PREFIX_ ## _subsys, _api_func, _func )
+
+/**
+ * Provide a static inline memory map API implementation
+ *
+ * @v _prefix		Subsystem prefix
+ * @v _api_func		API function
+ */
+#define PROVIDE_MEMMAP_INLINE( _subsys, _api_func ) \
+	PROVIDE_SINGLE_API_INLINE ( MEMMAP_PREFIX_ ## _subsys, _api_func )
+
+/** A memory region descriptor */
+struct memmap_region {
+	/** The address being described */
+	uint64_t addr;
+	/** Last address with the same description
+	 *
+	 * Note that this is the last address with the same
+	 * description as the address being described, not the first
+	 * address with a different description.
+	 */
+	uint64_t last;
+	/** Region flags */
+	unsigned int flags;
+	/** Region name (for debug messages) */
+	const char *name;
+};
+
+#define MEMMAP_FL_MEMORY	0x0001	/**< Contains memory */
+#define MEMMAP_FL_RESERVED	0x0002	/**< Is reserved */
+#define MEMMAP_FL_USED		0x0004	/**< Is in use by iPXE */
+#define MEMMAP_FL_INACCESSIBLE	0x0008	/**< Outside of addressable range */
+
+/**
+ * Initialise memory region descriptor
+ *
+ * @v addr		Address within region
+ * @v region		Region descriptor to fill in
+ */
+static inline __attribute__ (( always_inline )) void
+memmap_init ( uint64_t addr, struct memmap_region *region ) {
+
+	region->addr = addr;
+	region->last = ~( ( uint64_t ) 0 );
+	region->flags = 0;
+	region->name = NULL;
+}
+
+/**
+ * Check if memory region is usable
+ *
+ * @v region		Region descriptor
+ * @ret is_usable	Memory region is usable
+ */
+static inline __attribute__ (( always_inline )) int
+memmap_is_usable ( const struct memmap_region *region ) {
+
+	return ( region->flags == MEMMAP_FL_MEMORY );
+}
+
+/**
+ * Get remaining size of memory region (from the described address upwards)
+ *
+ * @v region		Region descriptor
+ * @ret size		Size of memory region
+ */
+static inline __attribute__ (( always_inline )) uint64_t
+memmap_size ( const struct memmap_region *region ) {
+
+	/* Calculate size, assuming overflow is known to be impossible */
+	return ( ( region->last + 1 ) - region->addr );
+}
+
+/** An in-use memory region */
+struct used_region {
+	/** Region name */
+	const char *name;
+	/** Start address */
+	physaddr_t start;
+	/** Length of region */
+	size_t size;
+};
+
+/** In-use memory region table */
+#define USED_REGIONS __table ( struct used_region, "used_regions" )
+
+/** Declare an in-use memory region */
+#define __used_region __table_entry ( USED_REGIONS, 01 )
+
+/* Include all architecture-independent ACPI API headers */
+#include <ipxe/null_memmap.h>
+
+/* Include all architecture-dependent ACPI API headers */
+#include <bits/memmap.h>
+
+/**
+ * Describe memory region from system memory map
+ *
+ * @v addr		Address within region
+ * @v hide		Hide in-use regions from the memory map
+ * @v region		Region descriptor to fill in
+ */
+void memmap_describe ( uint64_t addr, int hide, struct memmap_region *region );
+
+/**
+ * Synchronise in-use regions with the externally visible system memory map
+ *
+ * In environments such as x86 BIOS, we need to patch the global
+ * system memory map to hide our in-use regions, since there is no
+ * other way to communicate this information to external code.
+ */
+void memmap_sync ( void );
+
+/**
+ * Update an in-use memory region
+ *
+ * @v used		In-use memory region
+ * @v start		Start address
+ * @v size		Length of region
+ */
+static inline __attribute__ (( always_inline )) void
+memmap_use ( struct used_region *used, physaddr_t start, size_t size ) {
+
+	/* Record region */
+	used->start = start;
+	used->size = size;
+
+	/* Synchronise externally visible memory map */
+	memmap_sync();
+}
+
+/**
+ * Iterate over memory regions from a given starting address
+ *
+ * @v region		Region descriptor
+ * @v start		Starting address
+ * @v hide		Hide in-use regions from the memory map
+ */
+#define for_each_memmap_from( region, start, hide )			\
+	for ( (region)->addr = (start), (region)->last = 0 ;		\
+	      ( ( ( (region)->last + 1 ) != 0 ) &&			\
+		( memmap_describe ( (region)->addr, (hide),		\
+				    (region) ), 1 ) ) ;			\
+	      (region)->addr = ( (region)->last + 1 ) )
+
+/**
+ * Iterate over memory regions
+ *
+ * @v region		Region descriptor
+ * @v hide		Hide in-use regions from the memory map
+ */
+#define for_each_memmap( region, hide )					\
+	for_each_memmap_from ( (region), 0, (hide) )
+
+
+/**
+ * Dump memory region descriptor (for debugging)
+ *
+ * @v region		Region descriptor
+ */
+static inline void memmap_dump ( const struct memmap_region *region ) {
+	const char *name = region->name;
+	unsigned int flags = region->flags;
+
+	/* Dump region information */
+	DBGC ( region, "MEMMAP (%s%s%s%s) [%#08llx,%#08llx]%s%s\n",
+	       ( ( flags & MEMMAP_FL_MEMORY ) ? "M" : "-" ),
+	       ( ( flags & MEMMAP_FL_RESERVED ) ? "R" : "-" ),
+	       ( ( flags & MEMMAP_FL_USED ) ? "U" : "-" ),
+	       ( ( flags & MEMMAP_FL_INACCESSIBLE ) ? "X" : "-" ),
+	       ( ( unsigned long long ) region->addr ),
+	       ( ( unsigned long long ) region->last ),
+	       ( name ? " " : "" ), ( name ? name : "" ) );
+}
+
+/**
+ * Dump system memory map (for debugging)
+ *
+ * @v hide		Hide in-use regions from the memory map
+ */
+static inline void memmap_dump_all ( int hide ) {
+	struct memmap_region region;
+
+	/* Do nothing unless debugging is enabled */
+	if ( ! DBG_LOG )
+		return;
+
+	/* Describe all memory regions */
+	DBGC ( &region, "MEMMAP with in-use regions %s:\n",
+	       ( hide ? "hidden" : "ignored" ) );
+	for_each_memmap ( &region, hide )
+		memmap_dump ( &region );
+}
+
+extern void memmap_update ( struct memmap_region *region, uint64_t start,
+			    uint64_t size, unsigned int flags,
+			    const char *name );
+extern void memmap_update_used ( struct memmap_region *region );
+
+#endif /* _IPXE_MEMMAP_H */
diff --git a/src/include/ipxe/null_memmap.h b/src/include/ipxe/null_memmap.h
new file mode 100644
index 000000000..43c0f2a29
--- /dev/null
+++ b/src/include/ipxe/null_memmap.h
@@ -0,0 +1,44 @@
+#ifndef _IPXE_NULL_MEMMAP_H
+#define _IPXE_NULL_MEMMAP_H
+
+#include <stdint.h>
+
+/** @file
+ *
+ * Null system memory map API
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#ifdef MEMMAP_NULL
+#define MEMMAP_PREFIX_null
+#else
+#define MEMMAP_PREFIX_null __null_
+#endif
+
+/**
+ * Describe memory region from system memory map
+ *
+ * @v addr		Address within region
+ * @v hide		Hide in-use regions from the memory map
+ * @v region		Region descriptor to fill in
+ */
+static inline __attribute__ (( always_inline )) void
+MEMMAP_INLINE ( null, memmap_describe ) ( uint64_t addr, int hide __unused,
+					  struct memmap_region *region ) {
+
+	/* Initialise region as empty */
+	memmap_init ( addr, region );
+}
+
+/**
+ * Synchronise in-use regions with the externally visible system memory map
+ *
+ */
+static inline __attribute__ (( always_inline )) void
+MEMMAP_INLINE ( null, memmap_sync ) ( void ) {
+	/* Nothing to do */
+}
+
+#endif /* _IPXE_NULL_MEMMAP_H */
-- 
cgit v1.2.3-55-g7522


From 3f6ee9573761af711f2b7752bd042d387c52b1bb Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 14 May 2025 22:30:13 +0100
Subject: [fdtmem] Update to use the generic system memory map API

Provide an implementation of the system memory map API based on the
system device tree, excluding any memory outside the size of the
accessible physical address space and defining an in-use region to
cover the relocated copy of iPXE and the system device tree.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/prefix/libprefix.S |   4 +-
 src/config/defaults/sbi.h         |   2 +-
 src/core/fdtmem.c                 | 270 ++++++++++++++++++--------------------
 src/include/ipxe/fdtmem.h         |  22 +++-
 src/include/ipxe/memmap.h         |   1 +
 5 files changed, 151 insertions(+), 148 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/prefix/libprefix.S b/src/arch/riscv/prefix/libprefix.S
index 834a48655..a101ba1cd 100644
--- a/src/arch/riscv/prefix/libprefix.S
+++ b/src/arch/riscv/prefix/libprefix.S
@@ -1003,7 +1003,7 @@ install:
 	 * s1 - device tree physical address
 	 * s2 - saved return address
 	 * s3 - relocation records physical address
-	 * s4 - accessible physical address limit
+	 * s4 - maximum accessible physical address
 	 * s5 - relocation physical address
 	 * s6 - relocation offset
 	 * tp - virtual address offset
@@ -1030,7 +1030,7 @@ install:
 	mv	a0, a2
 	beqz	a2, 1f
 	call	enable_paging
-1:	mv	s4, a0
+1:	addi	s4, a0, -1
 
 	/* Apply relocations, if still needed after enabling paging */
 	mv	a0, s3
diff --git a/src/config/defaults/sbi.h b/src/config/defaults/sbi.h
index e12cf1af9..8e02bc3d1 100644
--- a/src/config/defaults/sbi.h
+++ b/src/config/defaults/sbi.h
@@ -19,7 +19,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_SBI
 #define REBOOT_SBI
 #define UMALLOC_SBI
-#define MEMMAP_NULL
+#define MEMMAP_FDT
 
 #define ACPI_NULL
 #define MPAPI_NULL
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index 18ae5ce96..b357287c5 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -29,6 +29,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <assert.h>
 #include <byteswap.h>
 #include <ipxe/uaccess.h>
+#include <ipxe/memmap.h>
+#include <ipxe/io.h>
 #include <ipxe/fdt.h>
 #include <ipxe/fdtmem.h>
 
@@ -44,85 +46,21 @@ extern char _prefix[];
 /** End address of the iPXE image */
 extern char _end[];
 
-/** Relocation required alignment (defined by prefix or linker) */
-extern physaddr_t ABS_SYMBOL ( _max_align );
-static physaddr_t max_align = ABS_VALUE_INIT ( _max_align );
-
-/** Colour for debug messages */
-#define colour &_prefix[0]
-
-/** A memory region descriptor */
-struct fdtmem_region {
-	/** Region start address */
-	physaddr_t start;
-	/** Region end address */
-	physaddr_t end;
-	/** Region flags */
-	int flags;
-	/** Region name (for debug messages) */
-	const char *name;
-};
-
-/** Region is usable as RAM */
-#define FDTMEM_RAM 0x0001
-
-/** Size of accessible physical address space (or zero for no limit) */
-static size_t fdtmem_limit;
-
-/**
- * Update memory region descriptor
- *
- * @v region		Memory region of interest to be updated
- * @v start		Start address of this region
- * @v size		Size of this region
- * @v flags		Region flags
- * @v name		Region name (for debugging)
- */
-static void fdtmem_update ( struct fdtmem_region *region, uint64_t start,
-			    uint64_t size, int flags, const char *name ) {
-	uint64_t end;
-
-	/* Ignore empty regions */
-	if ( ! size )
-		return;
-
-	/* Calculate end address (and truncate if necessary) */
-	end = ( start + size - 1 );
-	if ( end < start ) {
-		end = ~( ( uint64_t ) 0 );
-		DBGC ( colour, "FDTMEM [%#08llx,%#08llx] %s truncated "
-		       "(invalid size %#08llx)\n",
-		       ( ( unsigned long long ) start ),
-		       ( ( unsigned long long ) end ), name,
-		       ( ( unsigned long long ) size ) );
-	}
-
-	/* Ignore regions entirely below the region of interest */
-	if ( end < region->start )
-		return;
-
-	/* Ignore regions entirely above the region of interest */
-	if ( start > region->end )
-		return;
-
-	/* Update region of interest as applicable */
-	if ( start <= region->start ) {
-
-		/* This region covers the region of interest */
-		region->flags = flags;
-		if ( DBG_LOG )
-			region->name = name;
+/** Total in-memory size (calculated by linker) */
+extern size_t ABS_SYMBOL ( _memsz );
+static size_t memsz = ABS_VALUE_INIT ( _memsz );
 
-		/* Update end address if no closer boundary exists */
-		if ( end < region->end )
-			region->end = end;
+/** Relocation required alignment (defined by prefix or linker) */
+extern size_t ABS_SYMBOL ( _max_align );
+static size_t max_align = ABS_VALUE_INIT ( _max_align );
 
-	} else if ( start < region->end ) {
+/** In-use memory region for iPXE and system device tree copy */
+struct used_region fdtmem_used __used_region = {
+	.name = "iPXE/FDT",
+};
 
-		/* Update end address if no closer boundary exists */
-		region->end = ( start - 1 );
-	}
-}
+/** Maximum accessible physical address */
+static physaddr_t fdtmem_max;
 
 /**
  * Update memory region descriptor based on device tree node
@@ -134,9 +72,9 @@ static void fdtmem_update ( struct fdtmem_region *region, uint64_t start,
  * @v flags		Region flags
  * @ret rc		Return status code
  */
-static int fdtmem_update_node ( struct fdtmem_region *region, struct fdt *fdt,
+static int fdtmem_update_node ( struct memmap_region *region, struct fdt *fdt,
 				unsigned int offset, const char *match,
-				int flags ) {
+				unsigned int flags ) {
 	struct fdt_descriptor desc;
 	struct fdt_reg_cells regs;
 	const char *devtype;
@@ -155,7 +93,7 @@ static int fdtmem_update_node ( struct fdtmem_region *region, struct fdt *fdt,
 
 		/* Describe token */
 		if ( ( rc = fdt_describe ( fdt, offset, &desc ) ) != 0 ) {
-			DBGC ( colour, "FDTMEM has malformed node: %s\n",
+			DBGC ( region, "FDTMEM has malformed node: %s\n",
 			       strerror ( rc ) );
 			return rc;
 		}
@@ -182,7 +120,7 @@ static int fdtmem_update_node ( struct fdtmem_region *region, struct fdt *fdt,
 		count = fdt_reg_count ( fdt, desc.offset, &regs );
 		if ( count < 0 ) {
 			rc = count;
-			DBGC ( colour, "FDTMEM has malformed region %s: %s\n",
+			DBGC ( region, "FDTMEM has malformed region %s: %s\n",
 			       desc.name, strerror ( rc ) );
 			continue;
 		}
@@ -193,21 +131,21 @@ static int fdtmem_update_node ( struct fdtmem_region *region, struct fdt *fdt,
 			/* Get region starting address and size */
 			if ( ( rc = fdt_reg_address ( fdt, desc.offset, &regs,
 						      index, &start ) ) != 0 ){
-				DBGC ( colour, "FDTMEM %s region %d has "
+				DBGC ( region, "FDTMEM %s region %d has "
 				       "malformed start address: %s\n",
 				       desc.name, index, strerror ( rc ) );
 				break;
 			}
 			if ( ( rc = fdt_reg_size ( fdt, desc.offset, &regs,
 						   index, &size ) ) != 0 ) {
-				DBGC ( colour, "FDTMEM %s region %d has "
+				DBGC ( region, "FDTMEM %s region %d has "
 				       "malformed size: %s\n",
 				       desc.name, index, strerror ( rc ) );
 				break;
 			}
 
 			/* Update memory region descriptor */
-			fdtmem_update ( region, start, size, flags,
+			memmap_update ( region, start, size, flags,
 					desc.name );
 		}
 	}
@@ -222,7 +160,7 @@ static int fdtmem_update_node ( struct fdtmem_region *region, struct fdt *fdt,
  * @v fdt		Device tree
  * @ret rc		Return status code
  */
-static int fdtmem_update_tree ( struct fdtmem_region *region,
+static int fdtmem_update_tree ( struct memmap_region *region,
 				struct fdt *fdt ) {
 	const struct fdt_reservation *rsv;
 	unsigned int offset;
@@ -230,35 +168,80 @@ static int fdtmem_update_tree ( struct fdtmem_region *region,
 
 	/* Update based on memory regions in the root node */
 	if ( ( rc = fdtmem_update_node ( region, fdt, 0, "memory",
-					 FDTMEM_RAM ) ) != 0 )
+					 MEMMAP_FL_MEMORY ) ) != 0 )
 		return rc;
 
 	/* Update based on memory reservations block */
 	for_each_fdt_reservation ( rsv, fdt ) {
-		fdtmem_update ( region, be64_to_cpu ( rsv->start ),
-				be64_to_cpu ( rsv->size ), 0, "<rsv>" );
+		memmap_update ( region, be64_to_cpu ( rsv->start ),
+				be64_to_cpu ( rsv->size ), MEMMAP_FL_RESERVED,
+				NULL );
 	}
 
 	/* Locate reserved-memory node */
 	if ( ( rc = fdt_path ( fdt, "/reserved-memory", &offset ) ) != 0 ) {
-		DBGC ( colour, "FDTMEM could not locate /reserved-memory: "
+		DBGC ( region, "FDTMEM could not locate /reserved-memory: "
 		       "%s\n", strerror ( rc ) );
 		return rc;
 	}
 
 	/* Update based on memory regions in the reserved-memory node */
 	if ( ( rc = fdtmem_update_node ( region, fdt, offset, NULL,
-					 0 ) ) != 0 )
+					 MEMMAP_FL_RESERVED ) ) != 0 )
 		return rc;
 
 	return 0;
 }
 
+/**
+ * Describe memory region
+ *
+ * @v addr		Address within region
+ * @v fdt		Device tree
+ * @v max		Maximum accessible physical address
+ * @v region		Region descriptor to fill in
+ */
+static void fdtmem_describe ( uint64_t addr, struct fdt *fdt, physaddr_t max,
+			      struct memmap_region *region ) {
+	uint64_t inaccessible = ( ( ( uint64_t ) max ) + 1 );
+
+	/* Initialise region */
+	memmap_init ( addr, region );
+
+	/* Update region based on device tree */
+	fdtmem_update_tree ( region, fdt );
+
+	/* Treat inaccessible physical memory as such */
+	memmap_update ( region, inaccessible, -inaccessible,
+			MEMMAP_FL_INACCESSIBLE, NULL );
+}
+
+/**
+ * Get length for copy of iPXE and device tree
+ *
+ * @v fdt		Device tree
+ * @ret len		Total length
+ */
+static size_t fdtmem_len ( struct fdt *fdt ) {
+	size_t len;
+
+	/* Calculate total length and check device tree alignment */
+	len = ( memsz + fdt->len );
+	assert ( ( memsz % FDT_MAX_ALIGN ) == 0 );
+
+	/* Align length.  Not technically necessary, but keeps the
+	 * resulting memory maps looking relatively sane.
+	 */
+	len = ( ( len + PAGE_SIZE - 1 ) & ~( PAGE_SIZE - 1 ) );
+
+	return len;
+}
+
 /**
  * Find a relocation address for iPXE
  *
  * @v hdr		FDT header
- * @v limit		Size of accessible physical address space (or zero)
+ * @v max		Maximum accessible physical address
  * @ret new		New physical address for relocation
  *
  * Find a suitably aligned address towards the top of existent memory
@@ -270,13 +253,14 @@ static int fdtmem_update_tree ( struct fdtmem_region *region,
  * nor any function that it calls may write to or rely upon the zero
  * initialisation of any static variables.
  */
-physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
+physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 	struct fdt fdt;
-	struct fdtmem_region region;
+	struct memmap_region region;
+	physaddr_t addr;
+	physaddr_t next;
 	physaddr_t old;
 	physaddr_t new;
 	physaddr_t try;
-	size_t memsz;
 	size_t len;
 	int rc;
 
@@ -288,73 +272,46 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
 
 	/* Parse FDT */
 	if ( ( rc = fdt_parse ( &fdt, hdr, -1UL ) ) != 0 ) {
-		DBGC ( colour, "FDTMEM could not parse FDT: %s\n",
+		DBGC ( &region, "FDTMEM could not parse FDT: %s\n",
 		       strerror ( rc ) );
 		/* Refuse relocation if we have no FDT */
 		return old;
 	}
 
 	/* Determine required length */
-	memsz = ( _end - _prefix );
-	assert ( memsz > 0 );
-	assert ( ( memsz % FDT_MAX_ALIGN ) == 0 );
-	len = ( memsz + fdt.len );
+	len = fdtmem_len ( &fdt );
 	assert ( len > 0 );
-	DBGC ( colour, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
+	DBGC ( &region, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
 	       "relocation\n", memsz, fdt.len, len );
 
 	/* Construct memory map and choose a relocation address */
-	region.start = 0;
 	new = old;
-	while ( 1 ) {
-
-		/* Initialise region */
-		region.end = ~( ( physaddr_t ) 0 );
-		region.flags = 0;
-		region.name = "<empty>";
-
-		/* Update region based on device tree */
-		if ( ( rc = fdtmem_update_tree ( &region, &fdt ) ) != 0 )
-			break;
-
-		/* Treat existing iPXE image as reserved */
-		fdtmem_update ( &region, old, memsz, 0, "iPXE" );
+	for ( addr = 0, next = 1 ; next ; addr = next ) {
 
-		/* Treat existing device tree as reserved */
-		fdtmem_update ( &region, virt_to_phys ( hdr ), fdt.len, 0,
-				"FDT" );
-
-		/* Treat inaccessible physical memory as reserved */
-		if ( limit ) {
-			fdtmem_update ( &region, limit, -limit, 0,
-					"<inaccessible>" );
-		}
+		/* Describe region and in-use memory */
+		fdtmem_describe ( addr, &fdt, max, &region );
+		memmap_update ( &region, old, memsz, MEMMAP_FL_USED, "iPXE" );
+		memmap_update ( &region, virt_to_phys ( hdr ), fdt.len,
+				MEMMAP_FL_RESERVED, "FDT" );
+		next = ( region.last + 1 );
 
 		/* Dump region descriptor (for debugging) */
-		DBGC ( colour, "FDTMEM [%#08lx,%#08lx] %s\n",
-		       region.start, region.end, region.name );
-		assert ( region.end >= region.start );
+		memmap_dump ( &region );
+		assert ( region.last >= region.addr );
 
 		/* Use highest possible region */
-		if ( ( region.flags & FDTMEM_RAM ) &&
-		     ( ( region.end - region.start ) > len ) ) {
+		if ( memmap_is_usable ( &region ) && ( next >= len ) ) {
 
 			/* Determine candidate address after alignment */
-			try = ( ( region.end - len - 1 ) &
-				~( max_align - 1 ) );
+			try = ( ( next - len ) & ~( max_align - 1 ) );
 
 			/* Use this address if within region */
-			if ( try >= region.start )
+			if ( try >= addr )
 				new = try;
 		}
-
-		/* Move to next region */
-		region.start = ( region.end + 1 );
-		if ( ! region.start )
-			break;
 	}
 
-	DBGC ( colour, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
+	DBGC ( &region, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
 	       old, new, ( ( physaddr_t ) ( new + len - 1 ) ) );
 	return new;
 }
@@ -363,20 +320,20 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit ) {
  * Copy and register system device tree
  *
  * @v hdr		FDT header
- * @v limit		Size of accessible physical address space (or zero)
+ * @v max		Maximum accessible physical address
  * @ret rc		Return status code
  */
-int fdtmem_register ( struct fdt_header *hdr, size_t limit ) {
+int fdtmem_register ( struct fdt_header *hdr, physaddr_t max ) {
 	struct fdt_header *copy;
 	struct fdt fdt;
 	int rc;
 
-	/* Record size of accessible physical address space */
-	fdtmem_limit = limit;
+	/* Record maximum accessible physical address */
+	fdtmem_max = max;
 
 	/* Parse FDT to obtain length */
 	if ( ( rc = fdt_parse ( &fdt, hdr, -1UL ) ) != 0 ) {
-		DBGC ( colour, "FDTMEM could not parse FDT: %s\n",
+		DBGC ( hdr, "FDTMEM could not parse FDT: %s\n",
 		       strerror ( rc ) );
 		return rc;
 	}
@@ -385,12 +342,41 @@ int fdtmem_register ( struct fdt_header *hdr, size_t limit ) {
 	copy = ( ( void * ) _end );
 	memcpy ( copy, hdr, fdt.len );
 
+	/* Update in-use memory region */
+	memmap_use ( &fdtmem_used, virt_to_phys ( _prefix ),
+		     fdtmem_len ( &fdt ) );
+
 	/* Register copy as system device tree */
 	if ( ( rc = fdt_parse ( &sysfdt, copy, -1UL ) ) != 0 ) {
-		DBGC ( colour, "FDTMEM could not register FDT: %s\n",
+		DBGC ( hdr, "FDTMEM could not register FDT: %s\n",
 		       strerror ( rc ) );
 		return rc;
 	}
+	assert ( sysfdt.len == fdt.len );
+
+	/* Dump system memory map (for debugging) */
+	memmap_dump_all ( 1 );
 
 	return 0;
 }
+
+/**
+ * Describe memory region from system memory map
+ *
+ * @v addr		Address within region
+ * @v hide		Hide in-use regions from the memory map
+ * @v region		Region descriptor to fill in
+ */
+static void fdtmem_describe_region ( uint64_t addr, int hide,
+				     struct memmap_region *region ) {
+
+	/* Describe memory region based on device tree */
+	fdtmem_describe ( addr, &sysfdt, fdtmem_max, region );
+
+	/* Update memory region based on in-use regions, if applicable */
+	if ( hide )
+		memmap_update_used ( region );
+}
+
+PROVIDE_MEMMAP ( fdt, memmap_describe, fdtmem_describe_region );
+PROVIDE_MEMMAP_INLINE ( fdt, memmap_sync );
diff --git a/src/include/ipxe/fdtmem.h b/src/include/ipxe/fdtmem.h
index 1bf0015b4..8d7ebfe7e 100644
--- a/src/include/ipxe/fdtmem.h
+++ b/src/include/ipxe/fdtmem.h
@@ -10,9 +10,25 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
-#include <ipxe/fdt.h>
 
-extern physaddr_t fdtmem_relocate ( struct fdt_header *hdr, size_t limit );
-extern int fdtmem_register ( struct fdt_header *hdr, size_t limit );
+#ifdef MEMMAP_FDT
+#define MEMMAP_PREFIX_fdt
+#else
+#define MEMMAP_PREFIX_fdt __fdt_
+#endif
+
+/**
+ * Synchronise in-use regions with the externally visible system memory map
+ *
+ */
+static inline __attribute__ (( always_inline )) void
+MEMMAP_INLINE ( fdt, memmap_sync ) ( void ) {
+	/* Nothing to do */
+}
+
+struct fdt_header;
+
+extern physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max );
+extern int fdtmem_register ( struct fdt_header *hdr, physaddr_t max );
 
 #endif /* _IPXE_FDTMEM_H */
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
index 382032ee9..0262c68da 100644
--- a/src/include/ipxe/memmap.h
+++ b/src/include/ipxe/memmap.h
@@ -124,6 +124,7 @@ struct used_region {
 
 /* Include all architecture-independent ACPI API headers */
 #include <ipxe/null_memmap.h>
+#include <ipxe/fdtmem.h>
 
 /* Include all architecture-dependent ACPI API headers */
 #include <bits/memmap.h>
-- 
cgit v1.2.3-55-g7522


From 4c4c94ca09473ecbfce7e47edd0012949f4d25a3 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 15 May 2025 01:21:48 +0100
Subject: [bios] Update to use the generic system memory map API

Provide an implementation of the system memory map API based on the
assorted BIOS INT 15 calls, and a temporary implementation of the
legacy get_memmap() function using the new API.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/include/bits/memmap.h          |  14 +++
 src/arch/x86/include/ipxe/int15.h           |  20 ++++
 src/arch/x86/interface/pcbios/e820mangler.S |   8 ++
 src/arch/x86/interface/pcbios/hidemem.c     |  16 ++++
 src/arch/x86/interface/pcbios/int15.c       | 136 +++++++++++++++-------------
 src/config/defaults/pcbios.h                |   2 +-
 src/core/memmap.c                           |  25 +++++
 7 files changed, 157 insertions(+), 64 deletions(-)
 create mode 100644 src/arch/x86/include/bits/memmap.h
 create mode 100644 src/arch/x86/include/ipxe/int15.h

(limited to 'src/core')

diff --git a/src/arch/x86/include/bits/memmap.h b/src/arch/x86/include/bits/memmap.h
new file mode 100644
index 000000000..8f821563c
--- /dev/null
+++ b/src/arch/x86/include/bits/memmap.h
@@ -0,0 +1,14 @@
+#ifndef _BITS_MEMMAP_H
+#define _BITS_MEMMAP_H
+
+/** @file
+ *
+ * x86-specific system memory map API implementations
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/int15.h>
+
+#endif /* _BITS_MEMMAP_H */
diff --git a/src/arch/x86/include/ipxe/int15.h b/src/arch/x86/include/ipxe/int15.h
new file mode 100644
index 000000000..fbd70f8d6
--- /dev/null
+++ b/src/arch/x86/include/ipxe/int15.h
@@ -0,0 +1,20 @@
+#ifndef _IPXE_INT15_H
+#define _IPXE_INT15_H
+
+/** @file
+ *
+ * INT15-based memory map
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#ifdef MEMMAP_INT15
+#define MEMMAP_PREFIX_int15
+#else
+#define MEMMAP_PREFIX_int15 __int15_
+#endif
+
+extern void int15_intercept ( int intercept );
+
+#endif /* _IPXE_INT15_H */
diff --git a/src/arch/x86/interface/pcbios/e820mangler.S b/src/arch/x86/interface/pcbios/e820mangler.S
index ef5dc2754..b9e891dff 100644
--- a/src/arch/x86/interface/pcbios/e820mangler.S
+++ b/src/arch/x86/interface/pcbios/e820mangler.S
@@ -564,6 +564,8 @@ int15_88:
 int15:
 	/* See if we want to intercept this call */
 	pushfw
+	cmpb	$0, %cs:int15_intercept_flag
+	je	3f
 	cmpw	$0xe820, %ax
 	jne	1f
 	cmpl	$SMAP, %edx
@@ -587,3 +589,9 @@ int15:
 int15_vector:
 	.long 0
 	.size int15_vector, . - int15_vector
+
+	.section ".text16.data", "aw", @progbits
+	.globl int15_intercept_flag
+int15_intercept_flag:
+	.byte 1
+	.size int15_intercept_flag, . - int15_intercept_flag
diff --git a/src/arch/x86/interface/pcbios/hidemem.c b/src/arch/x86/interface/pcbios/hidemem.c
index 4063c0551..f201742cf 100644
--- a/src/arch/x86/interface/pcbios/hidemem.c
+++ b/src/arch/x86/interface/pcbios/hidemem.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <fakee820.h>
 #include <ipxe/init.h>
 #include <ipxe/io.h>
+#include <ipxe/memmap.h>
 #include <ipxe/hidemem.h>
 
 /** Set to true if you want to test a fake E820 map */
@@ -73,6 +74,10 @@ extern void int15();
 extern struct segoff __text16 ( int15_vector );
 #define int15_vector __use_text16 ( int15_vector )
 
+/** INT 15 interception flag */
+extern uint8_t __text16 ( int15_intercept_flag );
+#define int15_intercept_flag __use_text16 ( int15_intercept_flag )
+
 /* The linker defines these symbols for us */
 extern char _textdata[];
 extern char _etextdata[];
@@ -131,6 +136,17 @@ void hide_textdata ( void ) {
 		      virt_to_phys ( _etextdata ) );
 }
 
+/**
+ * Set INT 15 interception flag
+ *
+ * @v intercept		Intercept INT 15 calls to modify memory map
+ */
+void int15_intercept ( int intercept ) {
+
+	/* Set flag for INT 15 handler */
+	int15_intercept_flag = intercept;
+}
+
 /**
  * Hide Etherboot
  *
diff --git a/src/arch/x86/interface/pcbios/int15.c b/src/arch/x86/interface/pcbios/int15.c
index 3bc1229aa..ff90f551c 100644
--- a/src/arch/x86/interface/pcbios/int15.c
+++ b/src/arch/x86/interface/pcbios/int15.c
@@ -26,10 +26,12 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdint.h>
 #include <string.h>
 #include <errno.h>
+#include <assert.h>
 #include <realmode.h>
 #include <bios.h>
 #include <memsizes.h>
 #include <ipxe/io.h>
+#include <ipxe/memmap.h>
 
 /**
  * @file
@@ -152,7 +154,7 @@ static unsigned int extmemsize_88 ( void ) {
  * @ret extmem		Extended memory size, in kB
  *
  * Note that this is only an approximation; for an accurate picture,
- * use the E820 memory map obtained via get_memmap();
+ * use the E820 memory map obtained via memmap_describe();
  */
 unsigned int extmemsize ( void ) {
 	unsigned int extmem_e801;
@@ -167,12 +169,13 @@ unsigned int extmemsize ( void ) {
 /**
  * Get e820 memory map
  *
- * @v memmap		Memory map to fill in
+ * @v region		Memory region of interest to be updated
  * @ret rc		Return status code
  */
-static int meme820 ( struct memory_map *memmap ) {
-	struct memory_region *region = memmap->regions;
-	struct memory_region *prev_region = NULL;
+static int meme820 ( struct memmap_region *region ) {
+	unsigned int count = 0;
+	uint64_t start = 0;
+	uint64_t len = 0;
 	uint32_t next = 0;
 	uint32_t smap;
 	uint32_t size;
@@ -226,13 +229,6 @@ static int meme820 ( struct memory_map *memmap ) {
 			break;
 		}
 
-		/* If first region is not RAM, assume map is invalid */
-		if ( ( memmap->count == 0 ) &&
-		     ( e820buf.type != E820_TYPE_RAM ) ) {
-		       DBG ( "INT 15,e820 failed, first entry not RAM\n" );
-		       return -EINVAL;
-		}
-
 		DBG ( "INT 15,e820 region [%llx,%llx) type %d",
 		      e820buf.start, ( e820buf.start + e820buf.len ),
 		      ( int ) e820buf.type );
@@ -259,27 +255,36 @@ static int meme820 ( struct memory_map *memmap ) {
 				continue;
 		}
 
-		region->start = e820buf.start;
-		region->end = e820buf.start + e820buf.len;
-
 		/* Check for adjacent regions and merge them */
-		if ( prev_region && ( region->start == prev_region->end ) ) {
-			prev_region->end = region->end;
+		if ( e820buf.start == ( start + len ) ) {
+			len += e820buf.len;
 		} else {
-			prev_region = region;
-			region++;
-			memmap->count++;
+			start = e820buf.start;
+			len = e820buf.len;
 		}
 
-		if ( memmap->count >= ( sizeof ( memmap->regions ) /
-					sizeof ( memmap->regions[0] ) ) ) {
-			DBG ( "INT 15,e820 too many regions returned\n" );
-			/* Not a fatal error; what we've got so far at
-			 * least represents valid regions of memory,
-			 * even if we couldn't get them all.
-			 */
-			break;
+		/* Sanity check: first region (base memory) should
+		 * start at address zero.
+		 */
+		if ( ( count == 0 ) && ( start != 0 ) ) {
+			DBG ( "INT 15,e820 region 0 starts at %llx (expected "
+			      "0); assuming insane\n", start );
+			return -EINVAL;
+		}
+
+		/* Sanity check: second region (extended memory)
+		 * should start at address 0x100000.
+		 */
+		if ( ( count == 1 ) && ( start != 0x100000 ) ) {
+			DBG ( "INT 15,e820 region 1 starts at %llx (expected "
+			      "100000); assuming insane\n", start );
+			return -EINVAL;
 		}
+
+		/* Update region of interest */
+		memmap_update ( region, start, len, MEMMAP_FL_MEMORY, "e820" );
+		count++;
+
 	} while ( next != 0 );
 
 	/* Sanity checks.  Some BIOSes report complete garbage via INT
@@ -288,19 +293,9 @@ static int meme820 ( struct memory_map *memmap ) {
 	 * region (starting at 0) and at least one high memory region
 	 * (starting at 0x100000).
 	 */
-	if ( memmap->count < 2 ) {
+	if ( count < 2 ) {
 		DBG ( "INT 15,e820 returned only %d regions; assuming "
-		      "insane\n", memmap->count );
-		return -EINVAL;
-	}
-	if ( memmap->regions[0].start != 0 ) {
-		DBG ( "INT 15,e820 region 0 starts at %llx (expected 0); "
-		      "assuming insane\n", memmap->regions[0].start );
-		return -EINVAL;
-	}
-	if ( memmap->regions[1].start != 0x100000 ) {
-		DBG ( "INT 15,e820 region 1 starts at %llx (expected 100000); "
-		      "assuming insane\n", memmap->regions[0].start );
+		      "insane\n", count );
 		return -EINVAL;
 	}
 
@@ -308,37 +303,52 @@ static int meme820 ( struct memory_map *memmap ) {
 }
 
 /**
- * Get memory map
+ * Describe memory region from system memory map
  *
- * @v memmap		Memory map to fill in
+ * @v addr		Address within region
+ * @v hide		Hide in-use regions from the memory map
+ * @v region		Region descriptor to fill in
  */
-void x86_get_memmap ( struct memory_map *memmap ) {
-	unsigned int basemem, extmem;
+static void int15_describe ( uint64_t addr, int hide,
+			     struct memmap_region *region ) {
+	unsigned int basemem;
+	unsigned int extmem;
+	uint64_t inaccessible;
 	int rc;
 
-	DBG ( "Fetching system memory map\n" );
+	/* Initialise region */
+	memmap_init ( addr, region );
 
-	/* Clear memory map */
-	memset ( memmap, 0, sizeof ( *memmap ) );
+	/* Mark addresses above 4GB as inaccessible: we have no way to
+	 * access them either in a 32-bit build or in a 64-bit build
+	 * (since the 64-bit build identity-maps only the 32-bit
+	 * address space).
+	 */
+	inaccessible = ( 1ULL << 32 );
+	memmap_update ( region, inaccessible, -inaccessible,
+			MEMMAP_FL_INACCESSIBLE, NULL );
 
-	/* Get base and extended memory sizes */
-	basemem = basememsize();
-	DBG ( "FBMS base memory size %d kB [0,%x)\n",
-	      basemem, ( basemem * 1024 ) );
-	extmem = extmemsize();
-	
-	/* Try INT 15,e820 first */
-	if ( ( rc = meme820 ( memmap ) ) == 0 ) {
+	/* Enable/disable INT 15 interception as applicable */
+	int15_intercept ( hide );
+
+	/* Try INT 15,e820 first, falling back to constructing a map
+	 * from basemem and extmem sizes
+	 */
+	if ( ( rc = meme820 ( region ) ) == 0 ) {
 		DBG ( "Obtained system memory map via INT 15,e820\n" );
-		return;
+	} else {
+		basemem = basememsize();
+		DBG ( "FBMS base memory size %d kB [0,%x)\n",
+		      basemem, ( basemem * 1024 ) );
+		extmem = extmemsize();
+		memmap_update ( region, 0, ( basemem * 1024 ),
+				MEMMAP_FL_MEMORY, "basemem" );
+		memmap_update ( region, 0x100000, ( extmem * 1024 ),
+				MEMMAP_FL_MEMORY, "extmem" );
 	}
 
-	/* Fall back to constructing a map from basemem and extmem sizes */
-	DBG ( "INT 15,e820 failed; constructing map\n" );
-	memmap->regions[0].end = ( basemem * 1024 );
-	memmap->regions[1].start = 0x100000;
-	memmap->regions[1].end = 0x100000 + ( extmem * 1024 );
-	memmap->count = 2;
+	/* Restore INT 15 interception */
+	int15_intercept ( 1 );
 }
 
-PROVIDE_IOAPI ( x86, get_memmap, x86_get_memmap );
+PROVIDE_MEMMAP ( int15, memmap_describe, int15_describe );
diff --git a/src/config/defaults/pcbios.h b/src/config/defaults/pcbios.h
index bdc62e8e0..0f25669e4 100644
--- a/src/config/defaults/pcbios.h
+++ b/src/config/defaults/pcbios.h
@@ -17,7 +17,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_PCBIOS
 #define NAP_PCBIOS
 #define UMALLOC_MEMTOP
-#define MEMMAP_NULL
+#define MEMMAP_INT15
 #define SMBIOS_PCBIOS
 #define SANBOOT_PCBIOS
 #define ENTROPY_RTC
diff --git a/src/core/memmap.c b/src/core/memmap.c
index 5b95b6c0a..a6ba5205e 100644
--- a/src/core/memmap.c
+++ b/src/core/memmap.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <assert.h>
+#include <ipxe/io.h>
 #include <ipxe/memmap.h>
 
 /** @file
@@ -110,5 +111,29 @@ void memmap_update_used ( struct memmap_region *region ) {
 	}
 }
 
+/**
+ * Get legacy system memory map
+ *
+ * @v memmap		Legacy memory map to fill in
+ */
+void get_memmap ( struct memory_map *memmap ) {
+	struct memmap_region region;
+	struct memory_region *usable;
+
+	/* Clear legacy memory map */
+	memmap->count = 0;
+
+	/* Populate legacy memory map */
+	for_each_memmap ( &region, 1 ) {
+		if ( memmap_is_usable ( &region ) ) {
+			usable = &memmap->regions[memmap->count++];
+			usable->start = region.addr;
+			usable->end = ( region.last + 1 );
+			if ( memmap->count == MAX_MEMORY_REGIONS )
+				break;
+		}
+	}
+}
+
 PROVIDE_MEMMAP_INLINE ( null, memmap_describe );
 PROVIDE_MEMMAP_INLINE ( null, memmap_sync );
-- 
cgit v1.2.3-55-g7522


From 79c30b92a32e3ceee89969b18b3776e81ad9ed8d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 16 May 2025 15:47:51 +0100
Subject: [settings] Use memmap_describe() to construct memory map settings

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/memmap_settings.c | 56 +++++++++++++++++++++++++---------------------
 1 file changed, 30 insertions(+), 26 deletions(-)

(limited to 'src/core')

diff --git a/src/core/memmap_settings.c b/src/core/memmap_settings.c
index c620a0343..430065dc9 100644
--- a/src/core/memmap_settings.c
+++ b/src/core/memmap_settings.c
@@ -28,7 +28,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <byteswap.h>
 #include <ipxe/init.h>
 #include <ipxe/settings.h>
-#include <ipxe/io.h>
+#include <ipxe/memmap.h>
 
 /** @file
  *
@@ -139,16 +139,15 @@ static int memmap_settings_applies ( struct settings *settings __unused,
 static int memmap_settings_fetch ( struct settings *settings,
 				   struct setting *setting,
 				   void *data, size_t len ) {
-	struct memory_map memmap;
-	struct memory_region *region;
+	struct memmap_region region;
 	uint64_t result = 0;
+	unsigned int index = 0;
 	unsigned int start;
 	unsigned int count;
 	unsigned int scale;
 	int include_start;
 	int include_length;
 	int ignore_nonexistent;
-	unsigned int i;
 
 	/* Parse settings tag */
 	start = MEMMAP_START ( setting->tag );
@@ -163,35 +162,40 @@ static int memmap_settings_fetch ( struct settings *settings,
 	       ( include_length ? "length" : "" ),
 	       ( ignore_nonexistent ? " ignore" : "" ), scale );
 
-	/* Fetch memory map */
-	get_memmap ( &memmap );
-
 	/* Extract results from memory map */
-	for ( i = start ; count-- ; i++ ) {
-
-		/* Check that region exists */
-		if ( i >= memmap.count ) {
-			if ( ignore_nonexistent ) {
-				continue;
-			} else {
-				DBGC ( settings, "MEMMAP region %d does not "
-				       "exist\n", i );
-				return -ENOENT;
-			}
-		}
+	for_each_memmap ( &region, 0 ) {
+
+		/* Skip non-memory regions */
+		if ( ! ( region.flags & MEMMAP_FL_MEMORY ) )
+			continue;
+
+		/* Ignore unwanted regions */
+		if ( index++ < start )
+			continue;
 
 		/* Extract results from this region */
-		region = &memmap.regions[i];
 		if ( include_start ) {
-			result += region->start;
-			DBGC ( settings, "MEMMAP %d start %08llx\n",
-			       i, region->start );
+			result += region.addr;
+			DBGC ( settings, "MEMMAP %d start %#08llx\n", index,
+			       ( ( unsigned long long ) region.addr ) );
 		}
 		if ( include_length ) {
-			result += ( region->end - region->start );
-			DBGC ( settings, "MEMMAP %d length %08llx\n",
-			       i, ( region->end - region->start ) );
+			result += memmap_size ( &region );
+			DBGC ( settings, "MEMMAP %d length %#08llx\n", index,
+			       ( ( unsigned long long )
+				 memmap_size ( &region ) ) );
 		}
+
+		/* Stop when we have accumulated sufficient regions */
+		if ( --count == 0 )
+			break;
+	}
+
+	/* Check for nonexistent regions */
+	if ( count && ( ! ignore_nonexistent ) ) {
+		DBGC ( settings, "MEMMAP regions %d-%d do not exist\n",
+		       index, ( index + count - 1 ) );
+		return -ENOENT;
 	}
 
 	/* Scale result */
-- 
cgit v1.2.3-55-g7522


From 83449702e09236dccebd4913d5823d5e00b643e0 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 16 May 2025 18:13:38 +0100
Subject: [memmap] Remove now-obsolete get_memmap()

All memory map users have been updated to use the new system memory
map API.  Remove get_memmap() and its associated definitions.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/memmap.c     | 24 ------------------------
 src/include/ipxe/io.h | 26 --------------------------
 2 files changed, 50 deletions(-)

(limited to 'src/core')

diff --git a/src/core/memmap.c b/src/core/memmap.c
index a6ba5205e..5d81d9984 100644
--- a/src/core/memmap.c
+++ b/src/core/memmap.c
@@ -111,29 +111,5 @@ void memmap_update_used ( struct memmap_region *region ) {
 	}
 }
 
-/**
- * Get legacy system memory map
- *
- * @v memmap		Legacy memory map to fill in
- */
-void get_memmap ( struct memory_map *memmap ) {
-	struct memmap_region region;
-	struct memory_region *usable;
-
-	/* Clear legacy memory map */
-	memmap->count = 0;
-
-	/* Populate legacy memory map */
-	for_each_memmap ( &region, 1 ) {
-		if ( memmap_is_usable ( &region ) ) {
-			usable = &memmap->regions[memmap->count++];
-			usable->start = region.addr;
-			usable->end = ( region.last + 1 );
-			if ( memmap->count == MAX_MEMORY_REGIONS )
-				break;
-		}
-	}
-}
-
 PROVIDE_MEMMAP_INLINE ( null, memmap_describe );
 PROVIDE_MEMMAP_INLINE ( null, memmap_sync );
diff --git a/src/include/ipxe/io.h b/src/include/ipxe/io.h
index fe1388191..41ee48ffb 100644
--- a/src/include/ipxe/io.h
+++ b/src/include/ipxe/io.h
@@ -484,30 +484,4 @@ void mb ( void );
 #define rmb()	mb()
 #define wmb()	mb()
 
-/** A usable memory region */
-struct memory_region {
-	/** Physical start address */
-	uint64_t start;
-	/** Physical end address */
-	uint64_t end;
-};
-
-/** Maximum number of memory regions we expect to encounter */
-#define MAX_MEMORY_REGIONS 8
-
-/** A memory map */
-struct memory_map {
-	/** Memory regions */
-	struct memory_region regions[MAX_MEMORY_REGIONS];
-	/** Number of used regions */
-	unsigned int count;
-};
-
-/**
- * Get memory map
- *
- * @v memmap		Memory map to fill in
- */
-void get_memmap ( struct memory_map *memmap );
-
 #endif /* _IPXE_IO_H */
-- 
cgit v1.2.3-55-g7522


From c6ca3d3af83be57da8ba63df86185dc10fe7b715 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 19 May 2025 12:01:58 +0100
Subject: [malloc] Allow for the existence of multiple heaps

Create a generic model of a heap as a list of free blocks with
optional methods for growing and shrinking the heap.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/malloc.c                      | 268 +++++++++++++++++++++------------
 src/include/ipxe/linux/linux_uaccess.h |  16 +-
 src/include/ipxe/malloc.h              |  91 +++++------
 3 files changed, 219 insertions(+), 156 deletions(-)

(limited to 'src/core')

diff --git a/src/core/malloc.c b/src/core/malloc.c
index ec29513ef..dc67a594e 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -71,18 +71,6 @@ struct autosized_block {
 	char data[0];
 };
 
-/** List of free memory blocks */
-static LIST_HEAD ( free_blocks );
-
-/** Total amount of free memory */
-size_t freemem;
-
-/** Total amount of used memory */
-size_t usedmem;
-
-/** Maximum amount of used memory */
-size_t maxusedmem;
-
 /**
  * Heap size
  *
@@ -90,14 +78,15 @@ size_t maxusedmem;
  */
 #define HEAP_SIZE ( 512 * 1024 )
 
-/** The heap itself */
-static char heap[HEAP_SIZE];
+/** The heap area */
+static char heap_area[HEAP_SIZE];
 
 /**
  * Mark all blocks in free list as defined
  *
+ * @v heap		Heap
  */
-static inline void valgrind_make_blocks_defined ( void ) {
+static inline void valgrind_make_blocks_defined ( struct heap *heap ) {
 	struct memory_block *block;
 
 	/* Do nothing unless running under Valgrind */
@@ -110,18 +99,18 @@ static inline void valgrind_make_blocks_defined ( void ) {
 	 */
 
 	/* Mark block list itself as defined */
-	VALGRIND_MAKE_MEM_DEFINED ( &free_blocks, sizeof ( free_blocks ) );
+	VALGRIND_MAKE_MEM_DEFINED ( &heap->blocks, sizeof ( heap->blocks ) );
 
 	/* Mark areas accessed by list_check() as defined */
-	VALGRIND_MAKE_MEM_DEFINED ( &free_blocks.prev->next,
-				    sizeof ( free_blocks.prev->next ) );
-	VALGRIND_MAKE_MEM_DEFINED ( free_blocks.next,
-				    sizeof ( *free_blocks.next ) );
-	VALGRIND_MAKE_MEM_DEFINED ( &free_blocks.next->next->prev,
-				    sizeof ( free_blocks.next->next->prev ) );
+	VALGRIND_MAKE_MEM_DEFINED ( &heap->blocks.prev->next,
+				    sizeof ( heap->blocks.prev->next ) );
+	VALGRIND_MAKE_MEM_DEFINED ( heap->blocks.next,
+				    sizeof ( *heap->blocks.next ) );
+	VALGRIND_MAKE_MEM_DEFINED ( &heap->blocks.next->next->prev,
+				    sizeof ( heap->blocks.next->next->prev ) );
 
 	/* Mark each block in list as defined */
-	list_for_each_entry ( block, &free_blocks, list ) {
+	list_for_each_entry ( block, &heap->blocks, list ) {
 
 		/* Mark block as defined */
 		VALGRIND_MAKE_MEM_DEFINED ( block, sizeof ( *block ) );
@@ -137,8 +126,9 @@ static inline void valgrind_make_blocks_defined ( void ) {
 /**
  * Mark all blocks in free list as inaccessible
  *
+ * @v heap		Heap
  */
-static inline void valgrind_make_blocks_noaccess ( void ) {
+static inline void valgrind_make_blocks_noaccess ( struct heap *heap ) {
 	struct memory_block *block;
 	struct memory_block *prev = NULL;
 
@@ -152,7 +142,7 @@ static inline void valgrind_make_blocks_noaccess ( void ) {
 	 */
 
 	/* Mark each block in list as inaccessible */
-	list_for_each_entry ( block, &free_blocks, list ) {
+	list_for_each_entry ( block, &heap->blocks, list ) {
 
 		/* Mark previous block (if any) as inaccessible. (Current
 		 * block will be accessed by list_check().)
@@ -165,8 +155,8 @@ static inline void valgrind_make_blocks_noaccess ( void ) {
 		 * accessing the first list item.  Temporarily mark
 		 * this area as defined.
 		 */
-		VALGRIND_MAKE_MEM_DEFINED ( &free_blocks.next->prev,
-					    sizeof ( free_blocks.next->prev ) );
+		VALGRIND_MAKE_MEM_DEFINED ( &heap->blocks.next->prev,
+					    sizeof ( heap->blocks.next->prev ));
 	}
 	/* Mark last block (if any) as inaccessible */
 	if ( prev )
@@ -175,25 +165,26 @@ static inline void valgrind_make_blocks_noaccess ( void ) {
 	/* Mark as inaccessible the area that was temporarily marked
 	 * as defined to avoid errors from list_check().
 	 */
-	VALGRIND_MAKE_MEM_NOACCESS ( &free_blocks.next->prev,
-				     sizeof ( free_blocks.next->prev ) );
+	VALGRIND_MAKE_MEM_NOACCESS ( &heap->blocks.next->prev,
+				     sizeof ( heap->blocks.next->prev ) );
 
 	/* Mark block list itself as inaccessible */
-	VALGRIND_MAKE_MEM_NOACCESS ( &free_blocks, sizeof ( free_blocks ) );
+	VALGRIND_MAKE_MEM_NOACCESS ( &heap->blocks, sizeof ( heap->blocks ) );
 }
 
 /**
  * Check integrity of the blocks in the free list
  *
+ * @v heap		Heap
  */
-static inline void check_blocks ( void ) {
+static inline void check_blocks ( struct heap *heap ) {
 	struct memory_block *block;
 	struct memory_block *prev = NULL;
 
 	if ( ! ASSERTING )
 		return;
 
-	list_for_each_entry ( block, &free_blocks, list ) {
+	list_for_each_entry ( block, &heap->blocks, list ) {
 
 		/* Check alignment */
 		assert ( ( virt_to_phys ( block ) &
@@ -225,9 +216,10 @@ static inline void check_blocks ( void ) {
 /**
  * Discard some cached data
  *
+ * @v size		Failed allocation size
  * @ret discarded	Number of cached items discarded
  */
-static unsigned int discard_cache ( void ) {
+static unsigned int discard_cache ( size_t size __unused ) {
 	struct cache_discarder *discarder;
 	unsigned int discarded;
 
@@ -247,13 +239,14 @@ static void discard_all_cache ( void ) {
 	unsigned int discarded;
 
 	do {
-		discarded = discard_cache();
+		discarded = discard_cache ( 0 );
 	} while ( discarded );
 }
 
 /**
  * Allocate a memory block
  *
+ * @v heap		Heap
  * @v size		Requested size
  * @v align		Physical alignment
  * @v offset		Offset from physical alignment
@@ -264,7 +257,8 @@ static void discard_all_cache ( void ) {
  *
  * @c align must be a power of two.  @c size may not be zero.
  */
-void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
+static void * heap_alloc_block ( struct heap *heap, size_t size, size_t align,
+				 size_t offset ) {
 	struct memory_block *block;
 	size_t actual_offset;
 	size_t align_mask;
@@ -273,14 +267,14 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 	size_t post_size;
 	struct memory_block *pre;
 	struct memory_block *post;
-	unsigned int discarded;
+	unsigned int grown;
 	void *ptr;
 
 	/* Sanity checks */
 	assert ( size != 0 );
 	assert ( ( align == 0 ) || ( ( align & ( align - 1 ) ) == 0 ) );
-	valgrind_make_blocks_defined();
-	check_blocks();
+	valgrind_make_blocks_defined ( heap );
+	check_blocks ( heap );
 
 	/* Calculate offset of memory block */
 	actual_offset = ( offset & ~( MEMBLOCK_ALIGN - 1 ) );
@@ -303,11 +297,11 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 	/* Calculate alignment mask */
 	align_mask = ( ( align - 1 ) | ( MEMBLOCK_ALIGN - 1 ) );
 
-	DBGC2 ( &heap, "HEAP allocating %#zx (aligned %#zx+%zx)\n",
+	DBGC2 ( heap, "HEAP allocating %#zx (aligned %#zx+%#zx)\n",
 		size, align, offset );
 	while ( 1 ) {
 		/* Search through blocks for the first one with enough space */
-		list_for_each_entry ( block, &free_blocks, list ) {
+		list_for_each_entry ( block, &heap->blocks, list ) {
 			pre_size = ( ( actual_offset - virt_to_phys ( block ) )
 				     & align_mask );
 			if ( ( block->size < pre_size ) ||
@@ -322,7 +316,7 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 			pre   = block;
 			block = ( ( ( void * ) pre   ) + pre_size );
 			post  = ( ( ( void * ) block ) + actual_size );
-			DBGC2 ( &heap, "HEAP splitting [%p,%p) -> [%p,%p) "
+			DBGC2 ( heap, "HEAP splitting [%p,%p) -> [%p,%p) "
 				"+ [%p,%p)\n", pre,
 				( ( ( void * ) pre ) + pre->size ), pre, block,
 				post, ( ( ( void * ) pre ) + pre->size ) );
@@ -352,30 +346,30 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 				assert ( pre_size >= MEMBLOCK_ALIGN );
 			}
 			/* Update memory usage statistics */
-			freemem -= actual_size;
-			usedmem += actual_size;
-			if ( usedmem > maxusedmem )
-				maxusedmem = usedmem;
+			heap->freemem -= actual_size;
+			heap->usedmem += actual_size;
+			if ( heap->usedmem > heap->maxusedmem )
+				heap->maxusedmem = heap->usedmem;
 			/* Return allocated block */
 			ptr = ( ( ( void * ) block ) + offset - actual_offset );
-			DBGC2 ( &heap, "HEAP allocated [%p,%p) within "
+			DBGC2 ( heap, "HEAP allocated [%p,%p) within "
 				"[%p,%p)\n", ptr, ( ptr + size ), block,
 				( ( ( void * ) block ) + actual_size ) );
 			VALGRIND_MAKE_MEM_UNDEFINED ( ptr, size );
 			goto done;
 		}
 
-		/* Try discarding some cached data to free up memory */
-		DBGC ( &heap, "HEAP attempting discard for %#zx (aligned "
+		/* Attempt to grow heap to satisfy allocation */
+		DBGC ( heap, "HEAP attempting to grow for %#zx (aligned "
 		       "%#zx+%zx), used %zdkB\n", size, align, offset,
-		       ( usedmem >> 10 ) );
-		valgrind_make_blocks_noaccess();
-		discarded = discard_cache();
-		valgrind_make_blocks_defined();
-		check_blocks();
-		if ( ! discarded ) {
-			/* Nothing available to discard */
-			DBGC ( &heap, "HEAP failed to allocate %#zx (aligned "
+		       ( heap->usedmem >> 10 ) );
+		valgrind_make_blocks_noaccess ( heap );
+		grown = ( heap->grow ? heap->grow ( actual_size ) : 0 );
+		valgrind_make_blocks_defined ( heap );
+		check_blocks ( heap );
+		if ( ! grown ) {
+			/* Heap did not grow: fail allocation */
+			DBGC ( heap, "HEAP failed to allocate %#zx (aligned "
 			       "%#zx)\n", size, align );
 			ptr = NULL;
 			goto done;
@@ -383,20 +377,21 @@ void * alloc_memblock ( size_t size, size_t align, size_t offset ) {
 	}
 
  done:
-	check_blocks();
-	valgrind_make_blocks_noaccess();
+	check_blocks ( heap );
+	valgrind_make_blocks_noaccess ( heap );
 	return ptr;
 }
 
 /**
  * Free a memory block
  *
- * @v ptr		Memory allocated by alloc_memblock(), or NULL
+ * @v heap		Heap
+ * @v ptr		Memory allocated by heap_alloc_block(), or NULL
  * @v size		Size of the memory
  *
  * If @c ptr is NULL, no action is taken.
  */
-void free_memblock ( void *ptr, size_t size ) {
+static void heap_free_block ( struct heap *heap, void *ptr, size_t size ) {
 	struct memory_block *freeing;
 	struct memory_block *block;
 	struct memory_block *tmp;
@@ -411,10 +406,10 @@ void free_memblock ( void *ptr, size_t size ) {
 	VALGRIND_MAKE_MEM_NOACCESS ( ptr, size );
 
 	/* Sanity checks */
-	valgrind_make_blocks_defined();
-	check_blocks();
+	valgrind_make_blocks_defined ( heap );
+	check_blocks ( heap );
 
-	/* Round up to match actual block that alloc_memblock() would
+	/* Round up to match actual block that heap_alloc_block() would
 	 * have allocated.
 	 */
 	assert ( size != 0 );
@@ -422,20 +417,20 @@ void free_memblock ( void *ptr, size_t size ) {
 	freeing = ( ptr - sub_offset );
 	actual_size = ( ( size + sub_offset + MEMBLOCK_ALIGN - 1 ) &
 			~( MEMBLOCK_ALIGN - 1 ) );
-	DBGC2 ( &heap, "HEAP freeing [%p,%p) within [%p,%p)\n",
+	DBGC2 ( heap, "HEAP freeing [%p,%p) within [%p,%p)\n",
 		ptr, ( ptr + size ), freeing,
 		( ( ( void * ) freeing ) + actual_size ) );
 	VALGRIND_MAKE_MEM_UNDEFINED ( freeing, sizeof ( *freeing ) );
 
 	/* Check that this block does not overlap the free list */
 	if ( ASSERTING ) {
-		list_for_each_entry ( block, &free_blocks, list ) {
+		list_for_each_entry ( block, &heap->blocks, list ) {
 			if ( ( ( ( void * ) block ) <
 			       ( ( void * ) freeing + actual_size ) ) &&
 			     ( ( void * ) freeing <
 			       ( ( void * ) block + block->size ) ) ) {
 				assert ( 0 );
-				DBGC ( &heap, "HEAP double free of [%p,%p) "
+				DBGC ( heap, "HEAP double free of [%p,%p) "
 				       "overlapping [%p,%p) detected from %p\n",
 				       freeing,
 				       ( ( ( void * ) freeing ) + size ), block,
@@ -447,7 +442,7 @@ void free_memblock ( void *ptr, size_t size ) {
 
 	/* Insert/merge into free list */
 	freeing->size = actual_size;
-	list_for_each_entry_safe ( block, tmp, &free_blocks, list ) {
+	list_for_each_entry_safe ( block, tmp, &heap->blocks, list ) {
 		/* Calculate gaps before and after the "freeing" block */
 		gap_before = ( ( ( void * ) freeing ) - 
 			       ( ( ( void * ) block ) + block->size ) );
@@ -455,7 +450,7 @@ void free_memblock ( void *ptr, size_t size ) {
 			      ( ( ( void * ) freeing ) + freeing->size ) );
 		/* Merge with immediately preceding block, if possible */
 		if ( gap_before == 0 ) {
-			DBGC2 ( &heap, "HEAP merging [%p,%p) + [%p,%p) -> "
+			DBGC2 ( heap, "HEAP merging [%p,%p) + [%p,%p) -> "
 				"[%p,%p)\n", block,
 				( ( ( void * ) block ) + block->size ), freeing,
 				( ( ( void * ) freeing ) + freeing->size ),
@@ -476,11 +471,11 @@ void free_memblock ( void *ptr, size_t size ) {
 	 * possible, merge the following block into the "freeing"
 	 * block.
 	 */
-	DBGC2 ( &heap, "HEAP freed [%p,%p)\n",
+	DBGC2 ( heap, "HEAP freed [%p,%p)\n",
 		freeing, ( ( ( void * ) freeing ) + freeing->size ) );
 	list_add_tail ( &freeing->list, &block->list );
 	if ( gap_after == 0 ) {
-		DBGC2 ( &heap, "HEAP merging [%p,%p) + [%p,%p) -> [%p,%p)\n",
+		DBGC2 ( heap, "HEAP merging [%p,%p) + [%p,%p) -> [%p,%p)\n",
 			freeing, ( ( ( void * ) freeing ) + freeing->size ),
 			block, ( ( ( void * ) block ) + block->size ), freeing,
 			( ( ( void * ) block ) + block->size ) );
@@ -490,17 +485,26 @@ void free_memblock ( void *ptr, size_t size ) {
 	}
 
 	/* Update memory usage statistics */
-	freemem += actual_size;
-	usedmem -= actual_size;
+	heap->freemem += actual_size;
+	heap->usedmem -= actual_size;
+
+	/* Allow heap to shrink */
+	if ( heap->shrink && heap->shrink ( freeing, freeing->size ) ) {
+		list_del ( &freeing->list );
+		heap->freemem -= freeing->size;
+		VALGRIND_MAKE_MEM_UNDEFINED ( freeing, freeing->size );
+	}
 
-	check_blocks();
-	valgrind_make_blocks_noaccess();
+	/* Sanity checks */
+	check_blocks ( heap );
+	valgrind_make_blocks_noaccess ( heap );
 }
 
 /**
  * Reallocate memory
  *
- * @v old_ptr		Memory previously allocated by malloc(), or NULL
+ * @v heap		Heap
+ * @v old_ptr		Memory previously allocated by heap_realloc(), or NULL
  * @v new_size		Requested size
  * @ret new_ptr		Allocated memory, or NULL
  *
@@ -514,26 +518,26 @@ void free_memblock ( void *ptr, size_t size ) {
  * If allocation fails the previously allocated block is left
  * untouched and NULL is returned.
  *
- * Calling realloc() with a new size of zero is a valid way to free a
- * memory block.
+ * Calling heap_realloc() with a new size of zero is a valid way to
+ * free a memory block.
  */
-void * realloc ( void *old_ptr, size_t new_size ) {
+void * heap_realloc ( struct heap *heap, void *old_ptr, size_t new_size ) {
 	struct autosized_block *old_block;
 	struct autosized_block *new_block;
 	size_t old_total_size;
 	size_t new_total_size;
 	size_t old_size;
+	size_t offset = offsetof ( struct autosized_block, data );
 	void *new_ptr = NOWHERE;
 
 	/* Allocate new memory if necessary.  If allocation fails,
 	 * return without touching the old block.
 	 */
 	if ( new_size ) {
-		new_total_size = ( new_size +
-				   offsetof ( struct autosized_block, data ) );
+		new_total_size = ( new_size + offset );
 		if ( new_total_size < new_size )
 			return NULL;
-		new_block = alloc_memblock ( new_total_size, 1, 0 );
+		new_block = heap_alloc_block ( heap, new_total_size, 1, 0 );
 		if ( ! new_block )
 			return NULL;
 		new_block->size = new_total_size;
@@ -555,21 +559,38 @@ void * realloc ( void *old_ptr, size_t new_size ) {
 					    sizeof ( old_block->size ) );
 		old_total_size = old_block->size;
 		assert ( old_total_size != 0 );
-		old_size = ( old_total_size -
-			     offsetof ( struct autosized_block, data ) );
+		old_size = ( old_total_size - offset );
 		memcpy ( new_ptr, old_ptr,
 			 ( ( old_size < new_size ) ? old_size : new_size ) );
 		VALGRIND_FREELIKE_BLOCK ( old_ptr, 0 );
-		free_memblock ( old_block, old_total_size );
+		heap_free_block ( heap, old_block, old_total_size );
 	}
 
 	if ( ASSERTED ) {
-		DBGC ( &heap, "HEAP detected possible memory corruption "
+		DBGC ( heap, "HEAP detected possible memory corruption "
 		       "from %p\n", __builtin_return_address ( 0 ) );
 	}
 	return new_ptr;
 }
 
+/** The global heap */
+static struct heap heap = {
+	.blocks = LIST_HEAD_INIT ( heap.blocks ),
+	.grow = discard_cache,
+};
+
+/**
+ * Reallocate memory
+ *
+ * @v old_ptr		Memory previously allocated by malloc(), or NULL
+ * @v new_size		Requested size
+ * @ret new_ptr		Allocated memory, or NULL
+ */
+void * realloc ( void *old_ptr, size_t new_size ) {
+
+	return heap_realloc ( &heap, old_ptr, new_size );
+}
+
 /**
  * Allocate memory
  *
@@ -633,16 +654,70 @@ void * zalloc ( size_t size ) {
 	return data;
 }
 
+/**
+ * Allocate memory with specified physical alignment and offset
+ *
+ * @v size		Requested size
+ * @v align		Physical alignment
+ * @v offset		Offset from physical alignment
+ * @ret ptr		Memory, or NULL
+ *
+ * @c align must be a power of two.  @c size may not be zero.
+ */
+void * malloc_phys_offset ( size_t size, size_t phys_align, size_t offset ) {
+	void * ptr;
+
+	ptr = heap_alloc_block ( &heap, size, phys_align, offset );
+	if ( ptr && size ) {
+		assert ( ( phys_align == 0 ) ||
+			 ( ( ( virt_to_phys ( ptr ) ^ offset ) &
+			     ( phys_align - 1 ) ) == 0 ) );
+		VALGRIND_MALLOCLIKE_BLOCK ( ptr, size, 0, 0 );
+	}
+	return ptr;
+}
+
+/**
+ * Allocate memory with specified physical alignment
+ *
+ * @v size		Requested size
+ * @v align		Physical alignment
+ * @ret ptr		Memory, or NULL
+ *
+ * @c align must be a power of two.  @c size may not be zero.
+ */
+void * malloc_phys ( size_t size, size_t phys_align ) {
+
+	return malloc_phys_offset ( size, phys_align, 0 );
+}
+
+/**
+ * Free memory allocated with malloc_phys()
+ *
+ * @v ptr		Memory allocated by malloc_phys(), or NULL
+ * @v size		Size of memory, as passed to malloc_phys()
+ *
+ * Memory allocated with malloc_phys() can only be freed with
+ * free_phys(); it cannot be freed with the standard free().
+ *
+ * If @c ptr is NULL, no action is taken.
+ */
+void free_phys ( void *ptr, size_t size ) {
+
+	VALGRIND_FREELIKE_BLOCK ( ptr, 0 );
+	heap_free_block ( &heap, ptr, size );
+}
+
 /**
  * Add memory to allocation pool
  *
+ * @v heap		Heap
  * @v start		Start address
  * @v len		Length of memory
  *
- * Adds a block of memory to the allocation pool.  This is a one-way
- * operation; there is no way to reclaim this memory.
+ * Adds a block of memory to the allocation pool.
  */
-static void mpopulate ( void *start, size_t len ) {
+void heap_populate ( struct heap *heap, void *start, size_t len ) {
 	size_t skip;
 
 	/* Align start of block */
@@ -658,10 +733,10 @@ static void mpopulate ( void *start, size_t len ) {
 		return;
 
 	/* Add to allocation pool */
-	free_memblock ( start, len );
+	heap_free_block ( heap, start, len );
 
 	/* Fix up memory usage statistics */
-	usedmem += len;
+	heap->usedmem += len;
 }
 
 /**
@@ -669,9 +744,9 @@ static void mpopulate ( void *start, size_t len ) {
  *
  */
 static void init_heap ( void ) {
-	VALGRIND_MAKE_MEM_NOACCESS ( heap, sizeof ( heap ) );
-	VALGRIND_MAKE_MEM_NOACCESS ( &free_blocks, sizeof ( free_blocks ) );
-	mpopulate ( heap, sizeof ( heap ) );
+	VALGRIND_MAKE_MEM_NOACCESS ( heap_area, sizeof ( heap_area ) );
+	VALGRIND_MAKE_MEM_NOACCESS ( &heap.blocks, sizeof ( heap.blocks ) );
+	heap_populate ( &heap, heap_area, sizeof ( heap_area ) );
 }
 
 /** Memory allocator initialisation function */
@@ -685,7 +760,8 @@ struct init_fn heap_init_fn __init_fn ( INIT_EARLY ) = {
  */
 static void shutdown_cache ( int booting __unused ) {
 	discard_all_cache();
-	DBGC ( &heap, "HEAP maximum usage %zdkB\n", ( maxusedmem >> 10 ) );
+	DBGC ( &heap, "HEAP maximum usage %zdkB\n",
+	       ( heap.maxusedmem >> 10 ) );
 }
 
 /** Memory allocator shutdown function */
@@ -698,11 +774,11 @@ struct startup_fn heap_startup_fn __startup_fn ( STARTUP_EARLY ) = {
  * Dump free block list (for debugging)
  *
  */
-void mdumpfree ( void ) {
+void heap_dump ( struct heap *heap ) {
 	struct memory_block *block;
 
 	dbg_printf ( "HEAP free block list:\n" );
-	list_for_each_entry ( block, &free_blocks, list ) {
+	list_for_each_entry ( block, &heap->blocks, list ) {
 		dbg_printf ( "...[%p,%p] (size %#zx)\n", block,
 			     ( ( ( void * ) block ) + block->size ),
 			     block->size );
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index a5d7d73f3..7770ea90e 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -7,9 +7,9 @@
  *
  * We have no concept of the underlying physical addresses, since
  * these are not exposed to userspace.  We provide a stub
- * implementation of virt_to_phys() since this is required by
- * alloc_memblock().  We provide a matching stub implementation of
- * phys_to_virt().
+ * implementation of virt_to_phys() since this is required by the heap
+ * allocator to determine physical address alignment.  We provide a
+ * matching stub implementation of phys_to_virt().
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
@@ -31,11 +31,11 @@ UACCESS_INLINE ( linux, virt_to_phys ) ( volatile const void *virt ) {
 
 	/* We do not know the real underlying physical address.  We
 	 * provide this stub implementation only because it is
-	 * required by alloc_memblock() (which allocates memory with
-	 * specified physical address alignment).  We assume that the
-	 * low-order bits of virtual addresses match the low-order
-	 * bits of physical addresses, and so simply returning the
-	 * virtual address will suffice for the purpose of determining
+	 * required in order to allocate memory with a specified
+	 * physical address alignment.  We assume that the low-order
+	 * bits of virtual addresses match the low-order bits of
+	 * physical addresses, and so simply returning the virtual
+	 * address will suffice for the purpose of determining
 	 * alignment.
 	 */
 	return ( ( physaddr_t ) virt );
diff --git a/src/include/ipxe/malloc.h b/src/include/ipxe/malloc.h
index 8c3a7769d..6f30916d7 100644
--- a/src/include/ipxe/malloc.h
+++ b/src/include/ipxe/malloc.h
@@ -18,6 +18,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 #include <stdlib.h>
+#include <ipxe/list.h>
 #include <ipxe/tables.h>
 #include <valgrind/memcheck.h>
 
@@ -39,62 +40,48 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 #define NOWHERE ( ( void * ) ~( ( intptr_t ) 0 ) )
 
-extern size_t freemem;
-extern size_t usedmem;
-extern size_t maxusedmem;
+/** A heap */
+struct heap {
+	/** List of free memory blocks */
+	struct list_head blocks;
 
-extern void * __malloc alloc_memblock ( size_t size, size_t align,
-					size_t offset );
-extern void free_memblock ( void *ptr, size_t size );
-extern void mdumpfree ( void );
+	/** Total amount of free memory */
+	size_t freemem;
+	/** Total amount of used memory */
+	size_t usedmem;
+	/** Maximum amount of used memory */
+	size_t maxusedmem;
 
-/**
- * Allocate memory with specified physical alignment and offset
- *
- * @v size		Requested size
- * @v align		Physical alignment
- * @v offset		Offset from physical alignment
- * @ret ptr		Memory, or NULL
- *
- * @c align must be a power of two.  @c size may not be zero.
- */
-static inline void * __malloc malloc_phys_offset ( size_t size,
-						   size_t phys_align,
-						   size_t offset ) {
-	void * ptr = alloc_memblock ( size, phys_align, offset );
-	if ( ptr && size )
-		VALGRIND_MALLOCLIKE_BLOCK ( ptr, size, 0, 0 );
-	return ptr;
-}
+	/**
+	 * Attempt to grow heap (optional)
+	 *
+	 * @v size		Failed allocation size
+	 * @ret grown		Heap has grown: retry allocations
+	 */
+	unsigned int ( * grow ) ( size_t size );
+	/**
+	 * Allow heap to shrink (optional)
+	 *
+	 * @v ptr		Start of free block
+	 * @v size		Size of free block
+	 * @ret shrunk		Heap has shrunk: discard block
+	 *
+	 * Note that the discarded block will be accessed once after
+	 * this method returns, in order to clear the free block
+	 * metadata.
+	 */
+	unsigned int ( * shrink ) ( void *ptr, size_t size );
+};
 
-/**
- * Allocate memory with specified physical alignment
- *
- * @v size		Requested size
- * @v align		Physical alignment
- * @ret ptr		Memory, or NULL
- *
- * @c align must be a power of two.  @c size may not be zero.
- */
-static inline void * __malloc malloc_phys ( size_t size, size_t phys_align ) {
-	return malloc_phys_offset ( size, phys_align, 0 );
-}
+extern void * heap_realloc ( struct heap *heap, void *old_ptr,
+			     size_t new_size );
+extern void heap_dump ( struct heap *heap );
+extern void heap_populate ( struct heap *heap, void *start, size_t len );
 
-/**
- * Free memory allocated with malloc_phys()
- *
- * @v ptr		Memory allocated by malloc_phys(), or NULL
- * @v size		Size of memory, as passed to malloc_phys()
- *
- * Memory allocated with malloc_phys() can only be freed with
- * free_phys(); it cannot be freed with the standard free().
- *
- * If @c ptr is NULL, no action is taken.
- */
-static inline void free_phys ( void *ptr, size_t size ) {
-	VALGRIND_FREELIKE_BLOCK ( ptr, 0 );
-	free_memblock ( ptr, size );
-}
+extern void * __malloc malloc_phys_offset ( size_t size, size_t phys_align,
+					    size_t offset );
+extern void * __malloc malloc_phys ( size_t size, size_t phys_align );
+extern void free_phys ( void *ptr, size_t size );
 
 /** A cache discarder */
 struct cache_discarder {
-- 
cgit v1.2.3-55-g7522


From 490f1ecad8ddf2f6135d0926aef240dbb3026be9 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 19 May 2025 16:07:27 +0100
Subject: [malloc] Allow heap to specify block and pointer alignments

Size-tracked pointers allocated via umalloc() have historically been
aligned to a page boundary, as have the edges of the hidden memory
region covering the external heap.

Allow the block and size-tracked pointer alignments to be specified as
heap configuration parameters.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/malloc.c         | 76 ++++++++++++++++++++++++++++-------------------
 src/include/ipxe/malloc.h |  5 ++++
 2 files changed, 50 insertions(+), 31 deletions(-)

(limited to 'src/core')

diff --git a/src/core/malloc.c b/src/core/malloc.c
index dc67a594e..545927a30 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -26,7 +26,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stddef.h>
 #include <stdint.h>
 #include <string.h>
-#include <strings.h>
 #include <ipxe/io.h>
 #include <ipxe/list.h>
 #include <ipxe/init.h>
@@ -59,9 +58,12 @@ struct memory_block {
 	struct list_head list;
 };
 
-/** Physical address alignment maintained for free blocks of memory */
-#define MEMBLOCK_ALIGN \
-	( ( size_t ) ( 1 << ( fls ( sizeof ( struct memory_block ) - 1 ) ) ) )
+/** Physical address alignment maintained for free blocks of memory
+ *
+ * We keep memory blocks aligned on a power of two that is at least
+ * large enough to hold a @c struct @c memory_block.
+ */
+#define MIN_MEMBLOCK_ALIGN ( 4 * sizeof ( void * ) )
 
 /** A block of allocated memory complete with size information */
 struct autosized_block {
@@ -72,14 +74,17 @@ struct autosized_block {
 };
 
 /**
- * Heap size
+ * Heap area size
  *
  * Currently fixed at 512kB.
  */
 #define HEAP_SIZE ( 512 * 1024 )
 
+/** Heap area alignment */
+#define HEAP_ALIGN MIN_MEMBLOCK_ALIGN
+
 /** The heap area */
-static char heap_area[HEAP_SIZE];
+static char __attribute__ (( aligned ( HEAP_ALIGN ) )) heap_area[HEAP_SIZE];
 
 /**
  * Mark all blocks in free list as defined
@@ -188,14 +193,14 @@ static inline void check_blocks ( struct heap *heap ) {
 
 		/* Check alignment */
 		assert ( ( virt_to_phys ( block ) &
-			   ( MEMBLOCK_ALIGN - 1 ) ) == 0 );
+			   ( heap->align - 1 ) ) == 0 );
 
 		/* Check that list structure is intact */
 		list_check ( &block->list );
 
 		/* Check that block size is not too small */
 		assert ( block->size >= sizeof ( *block ) );
-		assert ( block->size >= MEMBLOCK_ALIGN );
+		assert ( block->size >= heap->align );
 
 		/* Check that block does not wrap beyond end of address space */
 		assert ( ( ( void * ) block + block->size ) >
@@ -276,13 +281,16 @@ static void * heap_alloc_block ( struct heap *heap, size_t size, size_t align,
 	valgrind_make_blocks_defined ( heap );
 	check_blocks ( heap );
 
+	/* Limit offset to requested alignment */
+	offset &= ( align ? ( align - 1 ) : 0 );
+
 	/* Calculate offset of memory block */
-	actual_offset = ( offset & ~( MEMBLOCK_ALIGN - 1 ) );
+	actual_offset = ( offset & ~( heap->align - 1 ) );
 	assert ( actual_offset <= offset );
 
 	/* Calculate size of memory block */
-	actual_size = ( ( size + offset - actual_offset + MEMBLOCK_ALIGN - 1 )
-			& ~( MEMBLOCK_ALIGN - 1 ) );
+	actual_size = ( ( size + offset - actual_offset + heap->align - 1 )
+			& ~( heap->align - 1 ) );
 	if ( ! actual_size ) {
 		/* The requested size is not permitted to be zero.  A
 		 * zero result at this point indicates that either the
@@ -295,7 +303,7 @@ static void * heap_alloc_block ( struct heap *heap, size_t size, size_t align,
 	assert ( actual_size >= size );
 
 	/* Calculate alignment mask */
-	align_mask = ( ( align - 1 ) | ( MEMBLOCK_ALIGN - 1 ) );
+	align_mask = ( ( align - 1 ) | ( heap->align - 1 ) );
 
 	DBGC2 ( heap, "HEAP allocating %#zx (aligned %#zx+%#zx)\n",
 		size, align, offset );
@@ -324,7 +332,9 @@ static void * heap_alloc_block ( struct heap *heap, size_t size, size_t align,
 			 * the free list.
 			 */
 			if ( post_size ) {
-				assert ( post_size >= MEMBLOCK_ALIGN );
+				assert ( post_size >= sizeof ( *block ) );
+				assert ( ( post_size &
+					   ( heap->align - 1 ) ) == 0 );
 				VALGRIND_MAKE_MEM_UNDEFINED ( post,
 							      sizeof ( *post ));
 				post->size = post_size;
@@ -343,7 +353,9 @@ static void * heap_alloc_block ( struct heap *heap, size_t size, size_t align,
 				VALGRIND_MAKE_MEM_NOACCESS ( pre,
 							     sizeof ( *pre ) );
 			} else {
-				assert ( pre_size >= MEMBLOCK_ALIGN );
+				assert ( pre_size >= sizeof ( *block ) );
+				assert ( ( pre_size &
+					   ( heap->align - 1 ) ) == 0 );
 			}
 			/* Update memory usage statistics */
 			heap->freemem -= actual_size;
@@ -413,10 +425,10 @@ static void heap_free_block ( struct heap *heap, void *ptr, size_t size ) {
 	 * have allocated.
 	 */
 	assert ( size != 0 );
-	sub_offset = ( virt_to_phys ( ptr ) & ( MEMBLOCK_ALIGN - 1) );
+	sub_offset = ( virt_to_phys ( ptr ) & ( heap->align - 1 ) );
 	freeing = ( ptr - sub_offset );
-	actual_size = ( ( size + sub_offset + MEMBLOCK_ALIGN - 1 ) &
-			~( MEMBLOCK_ALIGN - 1 ) );
+	actual_size = ( ( size + sub_offset + heap->align - 1 ) &
+			~( heap->align - 1 ) );
 	DBGC2 ( heap, "HEAP freeing [%p,%p) within [%p,%p)\n",
 		ptr, ( ptr + size ), freeing,
 		( ( ( void * ) freeing ) + actual_size ) );
@@ -537,7 +549,8 @@ void * heap_realloc ( struct heap *heap, void *old_ptr, size_t new_size ) {
 		new_total_size = ( new_size + offset );
 		if ( new_total_size < new_size )
 			return NULL;
-		new_block = heap_alloc_block ( heap, new_total_size, 1, 0 );
+		new_block = heap_alloc_block ( heap, new_total_size,
+					       heap->ptr_align, -offset );
 		if ( ! new_block )
 			return NULL;
 		new_block->size = new_total_size;
@@ -545,6 +558,8 @@ void * heap_realloc ( struct heap *heap, void *old_ptr, size_t new_size ) {
 					     sizeof ( new_block->size ) );
 		new_ptr = &new_block->data;
 		VALGRIND_MALLOCLIKE_BLOCK ( new_ptr, new_size, 0, 0 );
+		assert ( ( ( ( intptr_t ) new_ptr ) &
+			   ( heap->ptr_align - 1 ) ) == 0 );
 	}
 
 	/* Copy across relevant part of the old data region (if any),
@@ -576,6 +591,8 @@ void * heap_realloc ( struct heap *heap, void *old_ptr, size_t new_size ) {
 /** The global heap */
 static struct heap heap = {
 	.blocks = LIST_HEAD_INIT ( heap.blocks ),
+	.align = MIN_MEMBLOCK_ALIGN,
+	.ptr_align = sizeof ( void * ),
 	.grow = discard_cache,
 };
 
@@ -715,22 +732,14 @@ void free_phys ( void *ptr, size_t size ) {
  * @v start		Start address
  * @v len		Length of memory
  *
- * Adds a block of memory to the allocation pool.
+ * Adds a block of memory to the allocation pool.  The memory must be
+ * aligned to the heap's required free memory block alignment.
  */
 void heap_populate ( struct heap *heap, void *start, size_t len ) {
-	size_t skip;
-
-	/* Align start of block */
-	skip = ( ( -virt_to_phys ( start ) ) & ( MEMBLOCK_ALIGN - 1 ) );
-	if ( skip > len )
-		return;
-	start += skip;
-	len -= skip;
 
-	/* Align end of block */
-	len &= ~( MEMBLOCK_ALIGN - 1 );
-	if ( ! len )
-		return;
+	/* Sanity checks */
+	assert ( ( virt_to_phys ( start ) & ( heap->align - 1 ) ) == 0 );
+	assert ( ( len & ( heap->align - 1 ) ) == 0 );
 
 	/* Add to allocation pool */
 	heap_free_block ( heap, start, len );
@@ -744,6 +753,11 @@ void heap_populate ( struct heap *heap, void *start, size_t len ) {
  *
  */
 static void init_heap ( void ) {
+
+	/* Sanity check */
+	build_assert ( MIN_MEMBLOCK_ALIGN >= sizeof ( struct memory_block ) );
+
+	/* Populate heap */
 	VALGRIND_MAKE_MEM_NOACCESS ( heap_area, sizeof ( heap_area ) );
 	VALGRIND_MAKE_MEM_NOACCESS ( &heap.blocks, sizeof ( heap.blocks ) );
 	heap_populate ( &heap, heap_area, sizeof ( heap_area ) );
diff --git a/src/include/ipxe/malloc.h b/src/include/ipxe/malloc.h
index 6f30916d7..d3f056c15 100644
--- a/src/include/ipxe/malloc.h
+++ b/src/include/ipxe/malloc.h
@@ -45,6 +45,11 @@ struct heap {
 	/** List of free memory blocks */
 	struct list_head blocks;
 
+	/** Alignment for free memory blocks */
+	size_t align;
+	/** Alignment for size-tracked allocations */
+	size_t ptr_align;
+
 	/** Total amount of free memory */
 	size_t freemem;
 	/** Total amount of used memory */
-- 
cgit v1.2.3-55-g7522


From 4d560af2b0261b2954efba384f32035e6150987c Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 19 May 2025 16:11:59 +0100
Subject: [uheap] Add a generic external heap based on the system memory map

Add an implementation of umalloc() using the generalised model of a
heap, placing the external heap in the largest usable region obtained
from the system memory map.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/memmap.c          |  29 +++++++
 src/core/uheap.c           | 191 +++++++++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/memmap.h  |   1 +
 src/include/ipxe/uheap.h   |  18 +++++
 src/include/ipxe/umalloc.h |   1 +
 5 files changed, 240 insertions(+)
 create mode 100644 src/core/uheap.c
 create mode 100644 src/include/ipxe/uheap.h

(limited to 'src/core')

diff --git a/src/core/memmap.c b/src/core/memmap.c
index 5d81d9984..6c814a9ed 100644
--- a/src/core/memmap.c
+++ b/src/core/memmap.c
@@ -111,5 +111,34 @@ void memmap_update_used ( struct memmap_region *region ) {
 	}
 }
 
+/**
+ * Find largest usable memory region
+ *
+ * @v start		Start address to fill in
+ * @ret len		Length of region
+ */
+size_t memmap_largest ( physaddr_t *start ) {
+	struct memmap_region region;
+	size_t largest;
+	size_t size;
+
+	/* Find largest usable region */
+	DBGC ( &region, "MEMMAP finding largest usable region\n" );
+	*start = 0;
+	largest = 0;
+	for_each_memmap ( &region, 1 ) {
+		memmap_dump ( &region );
+		if ( ! memmap_is_usable ( &region ) )
+			continue;
+		size = memmap_size ( &region );
+		if ( size > largest ) {
+			DBGC ( &region, "...new largest region found\n" );
+			largest = size;
+			*start = region.addr;
+		}
+	}
+	return largest;
+}
+
 PROVIDE_MEMMAP_INLINE ( null, memmap_describe );
 PROVIDE_MEMMAP_INLINE ( null, memmap_sync );
diff --git a/src/core/uheap.c b/src/core/uheap.c
new file mode 100644
index 000000000..60efcf050
--- /dev/null
+++ b/src/core/uheap.c
@@ -0,0 +1,191 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/io.h>
+#include <ipxe/memmap.h>
+#include <ipxe/malloc.h>
+#include <ipxe/umalloc.h>
+
+/** @file
+ *
+ * External ("user") heap
+ *
+ * This file implements an external heap (for umalloc()) that grows
+ * downwards from the top of the largest contiguous accessible block
+ * in the system memory map.
+ */
+
+/**
+ * Alignment for external heap allocations
+ *
+ * Historically, umalloc() has produced page-aligned allocations, and
+ * the hidden region in the system memory map has been aligned to a
+ * page boundary.  Preserve this behaviour, to avoid needing to
+ * inspect and update large amounts of driver code, and also because
+ * it keeps the resulting memory maps easy to read.
+ */
+#define UHEAP_ALIGN PAGE_SIZE
+
+static struct heap uheap;
+
+/** In-use memory region */
+struct used_region uheap_used __used_region = {
+	.name = "uheap",
+};
+
+/** External heap maximum size */
+static size_t uheap_max;
+
+/**
+ * Adjust size of external heap in-use memory region
+ *
+ * @v delta		Size change
+ */
+static void uheap_resize ( ssize_t delta ) {
+	physaddr_t top;
+
+	/* Update in-use memory region */
+	assert ( ( uheap_used.start & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	assert ( ( uheap_used.size & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	assert ( ( delta & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	memmap_use ( &uheap_used, ( uheap_used.start - delta ),
+		     ( uheap_used.size + delta ) );
+	top = ( uheap_used.start + uheap_used.size );
+	DBGC ( &uheap, "UHEAP now at [%#08lx,%#08lx)\n",
+	       uheap_used.start, top );
+	memmap_dump_all ( 1 );
+}
+
+/**
+ * Find an external heap region
+ *
+ */
+static void uheap_find ( void ) {
+	physaddr_t start;
+	physaddr_t end;
+	size_t before;
+	size_t after;
+	size_t strip;
+	size_t size;
+
+	/* Sanity checks */
+	assert ( uheap_used.size == 0 );
+	assert ( uheap_max == 0 );
+
+	/* Find the largest region within the system memory map */
+	size = memmap_largest ( &start );
+	end = ( start + size );
+	DBGC ( &uheap, "UHEAP largest region is [%#08lx,%#08lx)\n",
+	       start, end );
+
+	/* Align start and end addresses */
+	after = ( end & ( UHEAP_ALIGN - 1 ) );
+	before = ( ( -start ) & ( UHEAP_ALIGN - 1 ) );
+	strip = ( before + after );
+	if ( strip > size )
+		return;
+	start += before;
+	end -= after;
+	size -= strip;
+	assert ( ( end - start ) == size );
+
+	/* Record region */
+	assert ( ( start & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	assert ( ( size & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	assert ( ( end & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	uheap_max = size;
+	uheap_used.start = end;
+	DBGC ( &uheap, "UHEAP grows downwards from %#08lx\n", end );
+}
+
+/**
+ * Attempt to grow external heap
+ *
+ * @v size		Failed allocation size
+ * @ret grown		Heap has grown: retry allocations
+ */
+static unsigned int uheap_grow ( size_t size ) {
+	void *new;
+
+	/* Initialise heap, if it does not yet exist */
+	if ( ! uheap_max )
+		uheap_find();
+
+	/* Fail if insufficient space remains */
+	if ( size > ( uheap_max - uheap_used.size ) )
+		return 0;
+
+	/* Grow heap */
+	new = ( phys_to_virt ( uheap_used.start ) - size );
+	heap_populate ( &uheap, new, size );
+	uheap_resize ( size );
+
+	return 1;
+}
+
+/**
+ * Allow external heap to shrink
+ *
+ * @v ptr		Start of free block
+ * @v size		Size of free block
+ * @ret shrunk		Heap has shrunk: discard block
+ */
+static unsigned int uheap_shrink ( void *ptr, size_t size ) {
+
+	/* Do nothing unless this is the lowest block in the heap */
+	if ( virt_to_phys ( ptr ) != uheap_used.start )
+		return 0;
+
+	/* Shrink heap */
+	uheap_resize ( -size );
+
+	return 1;
+}
+
+/** The external heap */
+static struct heap uheap = {
+	.blocks = LIST_HEAD_INIT ( uheap.blocks ),
+	.align = UHEAP_ALIGN,
+	.ptr_align = UHEAP_ALIGN,
+	.grow = uheap_grow,
+	.shrink = uheap_shrink,
+};
+
+/**
+ * Reallocate external memory
+ *
+ * @v old_ptr		Memory previously allocated by umalloc(), or NULL
+ * @v new_size		Requested size
+ * @ret new_ptr		Allocated memory, or NULL
+ *
+ * Calling urealloc() with a new size of zero is a valid way to free a
+ * memory block.
+ */
+static void * uheap_realloc ( void *old_ptr, size_t new_size ) {
+
+	return heap_realloc ( &uheap, old_ptr, new_size );
+}
+
+PROVIDE_UMALLOC ( uheap, urealloc, uheap_realloc );
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
index cfb9ac934..1d0aaa372 100644
--- a/src/include/ipxe/memmap.h
+++ b/src/include/ipxe/memmap.h
@@ -234,5 +234,6 @@ extern void memmap_update ( struct memmap_region *region, uint64_t start,
 			    uint64_t size, unsigned int flags,
 			    const char *name );
 extern void memmap_update_used ( struct memmap_region *region );
+extern size_t memmap_largest ( physaddr_t *start );
 
 #endif /* _IPXE_MEMMAP_H */
diff --git a/src/include/ipxe/uheap.h b/src/include/ipxe/uheap.h
new file mode 100644
index 000000000..194c13175
--- /dev/null
+++ b/src/include/ipxe/uheap.h
@@ -0,0 +1,18 @@
+#ifndef _IPXE_UHEAP_H
+#define _IPXE_UHEAP_H
+
+/** @file
+ *
+ * External ("user") heap
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#ifdef UMALLOC_UHEAP
+#define UMALLOC_PREFIX_uheap
+#else
+#define UMALLOC_PREFIX_uheap __uheap_
+#endif
+
+#endif /* _IPXE_UHEAP_H */
diff --git a/src/include/ipxe/umalloc.h b/src/include/ipxe/umalloc.h
index a6476a390..da6c34143 100644
--- a/src/include/ipxe/umalloc.h
+++ b/src/include/ipxe/umalloc.h
@@ -26,6 +26,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 	PROVIDE_SINGLE_API ( UMALLOC_PREFIX_ ## _subsys, _api_func, _func )
 
 /* Include all architecture-independent I/O API headers */
+#include <ipxe/uheap.h>
 #include <ipxe/efi/efi_umalloc.h>
 #include <ipxe/linux/linux_umalloc.h>
 
-- 
cgit v1.2.3-55-g7522


From d15a11f3a4f49999447e9bd0c499455d1d9ef078 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 20 May 2025 15:27:49 +0100
Subject: [image] Use image replacement when executing extracted images

Use image_replace() to transfer execution to the extracted image,
rather than calling image_exec() directly.  This allows the original
archive image to be freed immediately if it was marked as an
automatically freeable image (e.g. via "chain --autofree").

In particular, this ensures that in the case of an archive image
containing another archive image (such as an EFI zboot kernel wrapper
image containing a gzip-compressed kernel image), the intermediate
extracted image will be freed as early as possible, since extracted
images are always marked as automatically freeable.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/archive.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'src/core')

diff --git a/src/core/archive.c b/src/core/archive.c
index 3d3f00cc6..8b6accc6a 100644
--- a/src/core/archive.c
+++ b/src/core/archive.c
@@ -119,9 +119,14 @@ int image_extract_exec ( struct image *image ) {
 	/* Set auto-unregister flag */
 	extracted->flags |= IMAGE_AUTO_UNREGISTER;
 
-	/* Tail-recurse into extracted image */
-	return image_exec ( extracted );
+	/* Replace current image */
+	if ( ( rc = image_replace ( extracted ) ) != 0 )
+		goto err_replace;
 
+	/* Return to allow replacement image to be executed */
+	return 0;
+
+ err_replace:
  err_set_cmdline:
 	unregister_image ( extracted );
  err_extract:
-- 
cgit v1.2.3-55-g7522


From 9bc559850c53eb630f9bb1089c98bae1d776d3d8 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 21 May 2025 14:26:56 +0100
Subject: [fdt] Allow an initrd to be specified when creating a device tree

Allow an initrd location to be specified in our constructed device
tree via the "linux,initrd-start" and "linux,initrd-end" properties.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c              | 52 ++++++++++++++++++++++++++++++++-------------
 src/image/lkrn.c            |  2 +-
 src/include/ipxe/fdt.h      |  3 ++-
 src/interface/efi/efi_fdt.c |  2 +-
 4 files changed, 41 insertions(+), 18 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index d20c63c31..c8ae4d949 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -1055,18 +1055,17 @@ static int fdt_ensure_child ( struct fdt *fdt, unsigned int offset,
 }
 
 /**
- * Ensure property exists with specified value
+ * Set property value
  *
  * @v fdt		Device tree
  * @v offset		Starting node offset
  * @v name		Property name
- * @v data		Property data
+ * @v data		Property data, or NULL to delete property
  * @v len		Length of property data
  * @ret rc		Return status code
  */
-static int fdt_ensure_property ( struct fdt *fdt, unsigned int offset,
-				 const char *name, const void *data,
-				 size_t len ) {
+static int fdt_set ( struct fdt *fdt, unsigned int offset, const char *name,
+		     const void *data, size_t len ) {
 	struct fdt_descriptor desc;
 	struct {
 		fdt_token_t token;
@@ -1112,6 +1111,10 @@ static int fdt_ensure_property ( struct fdt *fdt, unsigned int offset,
 		insert = ( sizeof ( *hdr ) + len );
 	}
 
+	/* Leave property erased if applicable */
+	if ( ! data )
+		return 0;
+
 	/* Insert space */
 	if ( ( rc = fdt_insert_nop ( fdt, desc.offset, insert ) ) != 0 )
 		return rc;
@@ -1166,10 +1169,15 @@ static int fdt_urealloc ( struct fdt *fdt, size_t len ) {
  *
  * @v fdt		Device tree
  * @v cmdline		Command line, or NULL
+ * @v initrd		Initial ramdisk address (or 0 for no initrd)
+ * @v initrd_len	Initial ramdisk length (or 0 for no initrd)
  * @ret rc		Return status code
  */
-static int fdt_bootargs ( struct fdt *fdt, const char *cmdline ) {
+static int fdt_bootargs ( struct fdt *fdt, const char *cmdline,
+			  physaddr_t initrd, size_t initrd_len ) {
 	unsigned int chosen;
+	physaddr_t addr;
+	const void *data;
 	size_t len;
 	int rc;
 
@@ -1177,14 +1185,25 @@ static int fdt_bootargs ( struct fdt *fdt, const char *cmdline ) {
 	if ( ( rc = fdt_ensure_child ( fdt, 0, "chosen", &chosen ) ) != 0 )
 		return rc;
 
-	/* Use empty command line if none specified */
-	if ( ! cmdline )
-		cmdline = "";
+	/* Set or clear "bootargs" property */
+	len = ( cmdline ? ( strlen ( cmdline ) + 1 /* NUL */ ) : 0 );
+	if ( ( rc = fdt_set ( fdt, chosen, "bootargs", cmdline, len ) ) != 0 )
+		return rc;
 
-	/* Ensure "bootargs" property exists */
-	len = ( strlen ( cmdline ) + 1 /* NUL */ );
-	if ( ( rc = fdt_ensure_property ( fdt, chosen, "bootargs", cmdline,
-					  len ) ) != 0 )
+	/* Set or clear initrd properties */
+	data = ( initrd_len ? &addr : NULL );
+	len = ( initrd_len ? sizeof ( addr ) : 0 );
+	addr = initrd;
+	addr = ( ( sizeof ( addr ) == sizeof ( uint64_t ) ) ?
+		 cpu_to_be64 ( addr ) : cpu_to_be32 ( addr ) );
+	if ( ( rc = fdt_set ( fdt, chosen, "linux,initrd-start", data,
+			      len ) ) != 0 )
+		return rc;
+	addr = ( initrd + initrd_len );
+	addr = ( ( sizeof ( addr ) == sizeof ( uint64_t ) ) ?
+		 cpu_to_be64 ( addr ) : cpu_to_be32 ( addr ) );
+	if ( ( rc = fdt_set ( fdt, chosen, "linux,initrd-end", data,
+			      len ) ) != 0 )
 		return rc;
 
 	return 0;
@@ -1195,9 +1214,12 @@ static int fdt_bootargs ( struct fdt *fdt, const char *cmdline ) {
  *
  * @v hdr		Device tree header to fill in (may be set to NULL)
  * @v cmdline		Command line, or NULL
+ * @v initrd		Initial ramdisk address (or 0 for no initrd)
+ * @v initrd_len	Initial ramdisk length (or 0 for no initrd)
  * @ret rc		Return status code
  */
-int fdt_create ( struct fdt_header **hdr, const char *cmdline ) {
+int fdt_create ( struct fdt_header **hdr, const char *cmdline,
+		 physaddr_t initrd, size_t initrd_len ) {
 	struct image *image;
 	struct fdt fdt;
 	void *copy;
@@ -1228,7 +1250,7 @@ int fdt_create ( struct fdt_header **hdr, const char *cmdline ) {
 	fdt.realloc = fdt_urealloc;
 
 	/* Populate boot arguments */
-	if ( ( rc = fdt_bootargs ( &fdt, cmdline ) ) != 0 )
+	if ( ( rc = fdt_bootargs ( &fdt, cmdline, initrd, initrd_len ) ) != 0 )
 		goto err_bootargs;
 
  no_fdt:
diff --git a/src/image/lkrn.c b/src/image/lkrn.c
index f8929f3b3..4f04c3ff6 100644
--- a/src/image/lkrn.c
+++ b/src/image/lkrn.c
@@ -153,7 +153,7 @@ static int lkrn_fdt ( struct image *image, struct lkrn_context *ctx ) {
 	int rc;
 
 	/* Build device tree (which may change system memory map) */
-	if ( ( rc = fdt_create ( &fdt, image->cmdline ) ) != 0 )
+	if ( ( rc = fdt_create ( &fdt, image->cmdline, 0, 0 ) ) != 0 )
 		goto err_create;
 	len = be32_to_cpu ( fdt->totalsize );
 
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 45ae0f92b..461b09632 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -199,7 +199,8 @@ extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
 extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
 		       size_t max_len );
-extern int fdt_create ( struct fdt_header **hdr, const char *cmdline );
+extern int fdt_create ( struct fdt_header **hdr, const char *cmdline,
+			physaddr_t initrd, size_t initrd_len );
 extern void fdt_remove ( struct fdt_header *hdr );
 
 #endif /* _IPXE_FDT_H */
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index 1e0d4b8b7..3a90fd7ce 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -114,7 +114,7 @@ int efi_fdt_install ( const char *cmdline ) {
 	int rc;
 
 	/* Create device tree */
-	if ( ( rc = fdt_create ( &efi_fdt_installed, cmdline ) ) != 0 ) {
+	if ( ( rc = fdt_create ( &efi_fdt_installed, cmdline, 0, 0 ) ) != 0 ) {
 		DBGC ( &efi_fdt, "EFI_FDT could not install: %s\n",
 		       strerror ( rc ) );
 		goto err_create;
-- 
cgit v1.2.3-55-g7522


From b9095a045aeebefc0beff8ea2d30d7d0b73e44a0 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 22 May 2025 16:13:36 +0100
Subject: [fdtmem] Allow iPXE to be relocated to the top of the address space

Allow for relocation to a region at the very end of the physical
address space (where the next address wraps to zero).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdtmem.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'src/core')

diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index b357287c5..ef1ceb59d 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -300,7 +300,8 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 		assert ( region.last >= region.addr );
 
 		/* Use highest possible region */
-		if ( memmap_is_usable ( &region ) && ( next >= len ) ) {
+		if ( memmap_is_usable ( &region ) &&
+		     ( ( next == 0 ) || ( next >= len ) ) ) {
 
 			/* Determine candidate address after alignment */
 			try = ( ( next - len ) & ~( max_align - 1 ) );
-- 
cgit v1.2.3-55-g7522


From e056041074b9ed625791d8a688ef8a8cd8e9f7fd Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 22 May 2025 16:05:37 +0100
Subject: [uheap] Prevent allocation of blocks with zero physical addresses

If the external heap ends up at the top of the system memory map then
leave a gap after the heap to ensure that no block ends up being
allocated with either a start or end address of zero, since this is
frequently confusing to both code and humans.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/uheap.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src/core')

diff --git a/src/core/uheap.c b/src/core/uheap.c
index 60efcf050..f5154a0d1 100644
--- a/src/core/uheap.c
+++ b/src/core/uheap.c
@@ -100,8 +100,8 @@ static void uheap_find ( void ) {
 	DBGC ( &uheap, "UHEAP largest region is [%#08lx,%#08lx)\n",
 	       start, end );
 
-	/* Align start and end addresses */
-	after = ( end & ( UHEAP_ALIGN - 1 ) );
+	/* Align start and end addresses, and prevent overflow to zero */
+	after = ( end ? ( end & ( UHEAP_ALIGN - 1 ) ) : UHEAP_ALIGN );
 	before = ( ( -start ) & ( UHEAP_ALIGN - 1 ) );
 	strip = ( before + after );
 	if ( strip > size )
-- 
cgit v1.2.3-55-g7522


From 11e01f0652daaf198317e2e13c8bb1d19f664ce9 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 22 May 2025 11:58:11 +0100
Subject: [uheap] Expose external heap region directly

We currently rely on implicit detection of the external heap region.
The INT 15 memory map mangler relies on examining the corresponding
in-use memory region, and the initrd reshuffler relies on performing a
separate detection of the largest free memory block after startup has
completed.

Replace these with explicit public symbols to describe the external
heap region.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/interface/pcbios/hidemem.c | 13 +++++----
 src/core/uheap.c                        | 50 ++++++++++++++++++---------------
 src/image/initrd.c                      | 37 +++++++++++-------------
 src/include/ipxe/memmap.h               |  2 --
 src/include/ipxe/uheap.h                |  4 +++
 5 files changed, 55 insertions(+), 51 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/interface/pcbios/hidemem.c b/src/arch/x86/interface/pcbios/hidemem.c
index 9a445d063..2b85459b6 100644
--- a/src/arch/x86/interface/pcbios/hidemem.c
+++ b/src/arch/x86/interface/pcbios/hidemem.c
@@ -30,6 +30,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <fakee820.h>
 #include <ipxe/init.h>
 #include <ipxe/io.h>
+#include <ipxe/uheap.h>
 #include <ipxe/memmap.h>
 
 /** Set to true if you want to test a fake E820 map */
@@ -132,18 +133,18 @@ void hide_textdata ( void ) {
  */
 static void int15_sync ( void ) {
 	physaddr_t start;
-	size_t size;
+	physaddr_t end;
 
 	/* Besides our fixed base memory and textdata regions, we
 	 * support hiding only a single in-use memory region (the
 	 * umalloc region), which must be placed before the hidden
 	 * textdata region (even if zero-length).
 	 */
-	start = uheap_used.start;
-	size = uheap_used.size;
-	if ( ! size )
-		start = virt_to_phys ( _textdata );
-	hide_region ( &hidemem_umalloc, start, ( start + size ) );
+	start = uheap_start;
+	end = uheap_end;
+	if ( start == end )
+		start = end = virt_to_phys ( _textdata );
+	hide_region ( &hidemem_umalloc, start, end );
 }
 
 /**
diff --git a/src/core/uheap.c b/src/core/uheap.c
index f5154a0d1..3f93bc030 100644
--- a/src/core/uheap.c
+++ b/src/core/uheap.c
@@ -50,31 +50,38 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 static struct heap uheap;
 
+/** Minimum possible start of external heap */
+physaddr_t uheap_limit;
+
+/** Start of external heap */
+physaddr_t uheap_start;
+
+/** End of external heap */
+physaddr_t uheap_end;
+
 /** In-use memory region */
 struct used_region uheap_used __used_region = {
 	.name = "uheap",
 };
 
-/** External heap maximum size */
-static size_t uheap_max;
-
 /**
  * Adjust size of external heap in-use memory region
  *
  * @v delta		Size change
  */
 static void uheap_resize ( ssize_t delta ) {
-	physaddr_t top;
 
 	/* Update in-use memory region */
-	assert ( ( uheap_used.start & ( UHEAP_ALIGN - 1 ) ) == 0 );
-	assert ( ( uheap_used.size & ( UHEAP_ALIGN - 1 ) ) == 0 );
 	assert ( ( delta & ( UHEAP_ALIGN - 1 ) ) == 0 );
-	memmap_use ( &uheap_used, ( uheap_used.start - delta ),
-		     ( uheap_used.size + delta ) );
-	top = ( uheap_used.start + uheap_used.size );
-	DBGC ( &uheap, "UHEAP now at [%#08lx,%#08lx)\n",
-	       uheap_used.start, top );
+	uheap_start -= delta;
+	assert ( uheap_limit <= uheap_start );
+	assert ( uheap_start <= uheap_end );
+	assert ( ( uheap_limit & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	assert ( ( uheap_start & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	assert ( ( uheap_end & ( UHEAP_ALIGN - 1 ) ) == 0 );
+	memmap_use ( &uheap_used, uheap_start, ( uheap_end - uheap_start ) );
+	DBGC ( &uheap, "UHEAP now at (%#08lx)...[%#08lx,%#08lx)\n",
+	       uheap_limit, uheap_start, uheap_end );
 	memmap_dump_all ( 1 );
 }
 
@@ -91,8 +98,9 @@ static void uheap_find ( void ) {
 	size_t size;
 
 	/* Sanity checks */
+	assert ( uheap_start == uheap_end );
+	assert ( uheap_limit == uheap_end );
 	assert ( uheap_used.size == 0 );
-	assert ( uheap_max == 0 );
 
 	/* Find the largest region within the system memory map */
 	size = memmap_largest ( &start );
@@ -112,12 +120,10 @@ static void uheap_find ( void ) {
 	assert ( ( end - start ) == size );
 
 	/* Record region */
-	assert ( ( start & ( UHEAP_ALIGN - 1 ) ) == 0 );
-	assert ( ( size & ( UHEAP_ALIGN - 1 ) ) == 0 );
-	assert ( ( end & ( UHEAP_ALIGN - 1 ) ) == 0 );
-	uheap_max = size;
-	uheap_used.start = end;
-	DBGC ( &uheap, "UHEAP grows downwards from %#08lx\n", end );
+	uheap_limit = start;
+	uheap_start = end;
+	uheap_end = end;
+	uheap_resize ( 0 );
 }
 
 /**
@@ -130,15 +136,15 @@ static unsigned int uheap_grow ( size_t size ) {
 	void *new;
 
 	/* Initialise heap, if it does not yet exist */
-	if ( ! uheap_max )
+	if ( uheap_limit == uheap_end )
 		uheap_find();
 
 	/* Fail if insufficient space remains */
-	if ( size > ( uheap_max - uheap_used.size ) )
+	if ( size > ( uheap_start - uheap_limit ) )
 		return 0;
 
 	/* Grow heap */
-	new = ( phys_to_virt ( uheap_used.start ) - size );
+	new = ( phys_to_virt ( uheap_start ) - size );
 	heap_populate ( &uheap, new, size );
 	uheap_resize ( size );
 
@@ -155,7 +161,7 @@ static unsigned int uheap_grow ( size_t size ) {
 static unsigned int uheap_shrink ( void *ptr, size_t size ) {
 
 	/* Do nothing unless this is the lowest block in the heap */
-	if ( virt_to_phys ( ptr ) != uheap_used.start )
+	if ( virt_to_phys ( ptr ) != uheap_start )
 		return 0;
 
 	/* Shrink heap */
diff --git a/src/image/initrd.c b/src/image/initrd.c
index 71634324d..511f95f10 100644
--- a/src/image/initrd.c
+++ b/src/image/initrd.c
@@ -28,8 +28,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/image.h>
 #include <ipxe/uaccess.h>
 #include <ipxe/init.h>
-#include <ipxe/memmap.h>
 #include <ipxe/cpio.h>
+#include <ipxe/uheap.h>
 #include <ipxe/initrd.h>
 
 /** @file
@@ -41,9 +41,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /** Maximum address available for initrd */
 static physaddr_t initrd_top;
 
-/** Minimum address available for initrd */
-static physaddr_t initrd_bottom;
-
 /**
  * Squash initrds as high as possible in memory
  *
@@ -236,9 +233,8 @@ void initrd_reshuffle ( physaddr_t bottom ) {
 	size_t free_len;
 
 	/* Calculate limits of available space for initrds */
-	top = initrd_top;
-	if ( initrd_bottom > bottom )
-		bottom = initrd_bottom;
+	top = ( initrd_top ? initrd_top : uheap_end );
+	assert ( bottom >= uheap_limit );
 
 	/* Debug */
 	DBGC ( &images, "INITRD region [%#08lx,%#08lx)\n", bottom, top );
@@ -270,9 +266,8 @@ int initrd_reshuffle_check ( size_t len, physaddr_t bottom ) {
 	size_t available;
 
 	/* Calculate limits of available space for initrds */
-	top = initrd_top;
-	if ( initrd_bottom > bottom )
-		bottom = initrd_bottom;
+	top = ( initrd_top ? initrd_top : uheap_end );
+	assert ( bottom >= uheap_limit );
 	available = ( top - bottom );
 
 	/* Allow for a sensible minimum amount of free space */
@@ -287,19 +282,19 @@ int initrd_reshuffle_check ( size_t len, physaddr_t bottom ) {
  *
  */
 static void initrd_startup ( void ) {
-	size_t len;
 
-	/* Record largest memory block available.  Do this after any
-	 * allocations made during driver startup (e.g. large host
-	 * memory blocks for Infiniband devices, which may still be in
-	 * use at the time of rearranging if a SAN device is hooked)
-	 * but before any allocations for downloaded images (which we
-	 * can safely reuse when rearranging).
+	/* Record address above which reshuffling cannot take place.
+	 * If any external heap allocations have been made during
+	 * driver startup (e.g. large host memory blocks for
+	 * Infiniband devices, which may still be in use at the time
+	 * of rearranging if a SAN device is hooked), then we must not
+	 * overwrite these allocations during reshuffling.
 	 */
-	len = memmap_largest ( &initrd_bottom );
-	initrd_top = ( initrd_bottom + len );
-	DBGC ( &images, "INITRD largest memory block is [%#08lx,%#08lx)\n",
-	       initrd_bottom, initrd_top );
+	initrd_top = uheap_start;
+	if ( initrd_top ) {
+		DBGC ( &images, "INITRD limiting reshuffling to below "
+		       "%#08lx\n", initrd_top );
+	}
 }
 
 /** initrd startup function */
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
index 1283421bb..0175be11a 100644
--- a/src/include/ipxe/memmap.h
+++ b/src/include/ipxe/memmap.h
@@ -228,8 +228,6 @@ static inline void memmap_dump_all ( int hide ) {
 		memmap_dump ( &region );
 }
 
-extern struct used_region uheap_used __used_region;
-
 extern void memmap_update ( struct memmap_region *region, uint64_t start,
 			    uint64_t size, unsigned int flags,
 			    const char *name );
diff --git a/src/include/ipxe/uheap.h b/src/include/ipxe/uheap.h
index 194c13175..d356786d3 100644
--- a/src/include/ipxe/uheap.h
+++ b/src/include/ipxe/uheap.h
@@ -15,4 +15,8 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define UMALLOC_PREFIX_uheap __uheap_
 #endif
 
+extern physaddr_t uheap_limit;
+extern physaddr_t uheap_start;
+extern physaddr_t uheap_end;
+
 #endif /* _IPXE_UHEAP_H */
-- 
cgit v1.2.3-55-g7522


From 036e43334ad94125dfe212480957fd397e51a053 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 23 May 2025 16:55:42 +0100
Subject: [memmap] Rename addr/last fields to min/max for clarity

Use the terminology "min" and "max" for addresses covered by a memory
region descriptor, since this is sufficiently intuitive to generally
not require further explanation.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/relocate.c          |  4 ++--
 src/arch/x86/image/bzimage.c          |  6 +++---
 src/arch/x86/image/multiboot.c        |  2 +-
 src/arch/x86/interface/pcbios/int15.c |  6 +++---
 src/core/fdtmem.c                     | 23 +++++++++++----------
 src/core/memmap.c                     | 36 ++++++++++++++++----------------
 src/core/memmap_settings.c            |  4 ++--
 src/image/initrd.c                    |  4 ++--
 src/image/lkrn.c                      |  4 ++--
 src/image/segment.c                   |  8 +++----
 src/include/ipxe/memmap.h             | 39 +++++++++++++++--------------------
 src/include/ipxe/null_memmap.h        |  6 +++---
 12 files changed, 69 insertions(+), 73 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/relocate.c b/src/arch/x86/core/relocate.c
index 0d0c5b409..0a8f0b8dc 100644
--- a/src/arch/x86/core/relocate.c
+++ b/src/arch/x86/core/relocate.c
@@ -81,11 +81,11 @@ __asmcall void relocate ( struct i386_all_regs *ix86 ) {
 		 * stage.
 		 */
 		memmap_dump ( &region );
-		if ( region.addr > max ) {
+		if ( region.min > max ) {
 			DBGC ( &region, "...starts after max=%#08lx\n", max );
 			break;
 		}
-		r_start = region.addr;
+		r_start = region.min;
 		if ( ! memmap_is_usable ( &region ) ) {
 			DBGC ( &region, "...not usable\n" );
 			continue;
diff --git a/src/arch/x86/image/bzimage.c b/src/arch/x86/image/bzimage.c
index 764f37bbc..16a47fc57 100644
--- a/src/arch/x86/image/bzimage.c
+++ b/src/arch/x86/image/bzimage.c
@@ -347,11 +347,11 @@ static int bzimage_check_initrds ( struct image *image,
 
 	/* Limit region to avoiding kernel itself */
 	min = virt_to_phys ( bzimg->pm_kernel + bzimg->pm_sz );
-	if ( min < region.addr )
-		min = region.addr;
+	if ( min < region.min )
+		min = region.min;
 
 	/* Limit region to kernel's memory limit */
-	max = region.last;
+	max = region.max;
 	if ( max > bzimg->mem_limit )
 		max = bzimg->mem_limit;
 
diff --git a/src/arch/x86/image/multiboot.c b/src/arch/x86/image/multiboot.c
index 3d679aed9..c6bc01d4c 100644
--- a/src/arch/x86/image/multiboot.c
+++ b/src/arch/x86/image/multiboot.c
@@ -132,7 +132,7 @@ static void multiboot_build_memmap ( struct image *image,
 		/* Populate Multiboot memory map entry */
 		mbmemmap->size = ( sizeof ( *mbmemmap ) -
 				   sizeof ( mbmemmap->size ) );
-		mbmemmap->base_addr = region.addr;
+		mbmemmap->base_addr = region.min;
 		mbmemmap->length = memmap_size ( &region );
 		mbmemmap->type = MBMEM_RAM;
 
diff --git a/src/arch/x86/interface/pcbios/int15.c b/src/arch/x86/interface/pcbios/int15.c
index ff90f551c..73bdbbe4a 100644
--- a/src/arch/x86/interface/pcbios/int15.c
+++ b/src/arch/x86/interface/pcbios/int15.c
@@ -305,11 +305,11 @@ static int meme820 ( struct memmap_region *region ) {
 /**
  * Describe memory region from system memory map
  *
- * @v addr		Address within region
+ * @v min		Minimum address
  * @v hide		Hide in-use regions from the memory map
  * @v region		Region descriptor to fill in
  */
-static void int15_describe ( uint64_t addr, int hide,
+static void int15_describe ( uint64_t min, int hide,
 			     struct memmap_region *region ) {
 	unsigned int basemem;
 	unsigned int extmem;
@@ -317,7 +317,7 @@ static void int15_describe ( uint64_t addr, int hide,
 	int rc;
 
 	/* Initialise region */
-	memmap_init ( addr, region );
+	memmap_init ( min, region );
 
 	/* Mark addresses above 4GB as inaccessible: we have no way to
 	 * access them either in a 32-bit build or in a 64-bit build
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index ef1ceb59d..bb8786d3c 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -196,22 +196,23 @@ static int fdtmem_update_tree ( struct memmap_region *region,
 /**
  * Describe memory region
  *
- * @v addr		Address within region
- * @v fdt		Device tree
+ * @v min		Minimum address
  * @v max		Maximum accessible physical address
+ * @v fdt		Device tree
  * @v region		Region descriptor to fill in
  */
-static void fdtmem_describe ( uint64_t addr, struct fdt *fdt, physaddr_t max,
+static void fdtmem_describe ( uint64_t min, uint64_t max, struct fdt *fdt,
 			      struct memmap_region *region ) {
-	uint64_t inaccessible = ( ( ( uint64_t ) max ) + 1 );
+	uint64_t inaccessible;
 
 	/* Initialise region */
-	memmap_init ( addr, region );
+	memmap_init ( min, region );
 
 	/* Update region based on device tree */
 	fdtmem_update_tree ( region, fdt );
 
 	/* Treat inaccessible physical memory as such */
+	inaccessible = ( max + 1 );
 	memmap_update ( region, inaccessible, -inaccessible,
 			MEMMAP_FL_INACCESSIBLE, NULL );
 }
@@ -289,15 +290,15 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 	for ( addr = 0, next = 1 ; next ; addr = next ) {
 
 		/* Describe region and in-use memory */
-		fdtmem_describe ( addr, &fdt, max, &region );
+		fdtmem_describe ( addr, max, &fdt, &region );
 		memmap_update ( &region, old, memsz, MEMMAP_FL_USED, "iPXE" );
 		memmap_update ( &region, virt_to_phys ( hdr ), fdt.len,
 				MEMMAP_FL_RESERVED, "FDT" );
-		next = ( region.last + 1 );
+		next = ( region.max + 1 );
 
 		/* Dump region descriptor (for debugging) */
 		memmap_dump ( &region );
-		assert ( region.last >= region.addr );
+		assert ( region.max >= region.min );
 
 		/* Use highest possible region */
 		if ( memmap_is_usable ( &region ) &&
@@ -364,15 +365,15 @@ int fdtmem_register ( struct fdt_header *hdr, physaddr_t max ) {
 /**
  * Describe memory region from system memory map
  *
- * @v addr		Address within region
+ * @v min		Minimum address
  * @v hide		Hide in-use regions from the memory map
  * @v region		Region descriptor to fill in
  */
-static void fdtmem_describe_region ( uint64_t addr, int hide,
+static void fdtmem_describe_region ( uint64_t min, int hide,
 				     struct memmap_region *region ) {
 
 	/* Describe memory region based on device tree */
-	fdtmem_describe ( addr, &sysfdt, fdtmem_max, region );
+	fdtmem_describe ( min, fdtmem_max, &sysfdt, region );
 
 	/* Update memory region based on in-use regions, if applicable */
 	if ( hide )
diff --git a/src/core/memmap.c b/src/core/memmap.c
index 6c814a9ed..2939e855b 100644
--- a/src/core/memmap.c
+++ b/src/core/memmap.c
@@ -46,54 +46,54 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 void memmap_update ( struct memmap_region *region, uint64_t start,
 		     uint64_t size, unsigned int flags, const char *name ) {
-	uint64_t last;
+	uint64_t max;
 
 	/* Sanity check */
-	assert ( region->last >= region->addr );
+	assert ( region->max >= region->min );
 
 	/* Ignore empty regions */
 	if ( ! size )
 		return;
 
-	/* Calculate last addresses (and truncate if necessary) */
-	last = ( start + size - 1 );
-	if ( last < start ) {
-		last = ~( ( uint64_t ) 0 );
+	/* Calculate max addresses (and truncate if necessary) */
+	max = ( start + size - 1 );
+	if ( max < start ) {
+		max = ~( ( uint64_t ) 0 );
 		DBGC ( region, "MEMMAP [%#08llx,%#08llx] %s truncated "
 		       "(invalid size %#08llx)\n",
 		       ( ( unsigned long long ) start ),
-		       ( ( unsigned long long ) last ), name,
+		       ( ( unsigned long long ) max ), name,
 		       ( ( unsigned long long ) size ) );
 	}
 
 	/* Ignore regions entirely below the region of interest */
-	if ( last < region->addr )
+	if ( max < region->min )
 		return;
 
 	/* Ignore regions entirely above the region of interest */
-	if ( start > region->last )
+	if ( start > region->max )
 		return;
 
 	/* Update region of interest as applicable */
-	if ( start <= region->addr ) {
+	if ( start <= region->min ) {
 
 		/* Record this region as covering the region of interest */
 		region->flags |= flags;
 		if ( name )
 			region->name = name;
 
-		/* Update last address if no closer boundary exists */
-		if ( last < region->last )
-			region->last = last;
+		/* Update max address if no closer boundary exists */
+		if ( max < region->max )
+			region->max = max;
 
-	} else if ( start < region->last ) {
+	} else if ( start < region->max ) {
 
-		/* Update last address if no closer boundary exists */
-		region->last = ( start - 1 );
+		/* Update max address if no closer boundary exists */
+		region->max = ( start - 1 );
 	}
 
 	/* Sanity check */
-	assert ( region->last >= region->addr );
+	assert ( region->max >= region->min );
 }
 
 /**
@@ -134,7 +134,7 @@ size_t memmap_largest ( physaddr_t *start ) {
 		if ( size > largest ) {
 			DBGC ( &region, "...new largest region found\n" );
 			largest = size;
-			*start = region.addr;
+			*start = region.min;
 		}
 	}
 	return largest;
diff --git a/src/core/memmap_settings.c b/src/core/memmap_settings.c
index 430065dc9..d07e9747e 100644
--- a/src/core/memmap_settings.c
+++ b/src/core/memmap_settings.c
@@ -175,9 +175,9 @@ static int memmap_settings_fetch ( struct settings *settings,
 
 		/* Extract results from this region */
 		if ( include_start ) {
-			result += region.addr;
+			result += region.min;
 			DBGC ( settings, "MEMMAP %d start %#08llx\n", index,
-			       ( ( unsigned long long ) region.addr ) );
+			       ( ( unsigned long long ) region.min ) );
 		}
 		if ( include_length ) {
 			result += memmap_size ( &region );
diff --git a/src/image/initrd.c b/src/image/initrd.c
index fec799ce7..ba550a8f2 100644
--- a/src/image/initrd.c
+++ b/src/image/initrd.c
@@ -364,8 +364,8 @@ int initrd_region ( size_t len, struct memmap_region *region ) {
 	       min, ( min + available ) );
 
 	/* Populate region descriptor */
-	region->addr = min;
-	region->last = ( min + available - 1 );
+	region->min = min;
+	region->max = ( min + available - 1 );
 	region->flags = MEMMAP_FL_MEMORY;
 	region->name = "initrd";
 
diff --git a/src/image/lkrn.c b/src/image/lkrn.c
index 7110a95ef..8a7c577cd 100644
--- a/src/image/lkrn.c
+++ b/src/image/lkrn.c
@@ -105,7 +105,7 @@ static int lkrn_ram ( struct image *image, struct lkrn_context *ctx ) {
 		memmap_dump ( &region );
 		if ( ! ( region.flags & MEMMAP_FL_MEMORY ) )
 			continue;
-		ctx->ram = region.addr;
+		ctx->ram = region.min;
 		DBGC ( image, "LKRN %s RAM starts at %#08lx\n",
 		       image->name, ctx->ram );
 		return 0;
@@ -181,7 +181,7 @@ static int lkrn_exec ( struct image *image ) {
 
 	/* Check that everything can be placed at its target addresses */
 	totalsz = ( ctx.fdt + fdtimg.len - ctx.ram );
-	if ( ( ctx.entry >= region.addr ) &&
+	if ( ( ctx.entry >= region.min ) &&
 	     ( ( ctx.offset + totalsz ) <= memmap_size ( &region ) ) ) {
 		/* Target addresses are within the reshuffle region */
 		DBGC ( image, "LKRN %s fits within reshuffle region\n",
diff --git a/src/image/segment.c b/src/image/segment.c
index 848831ace..469a66321 100644
--- a/src/image/segment.c
+++ b/src/image/segment.c
@@ -63,7 +63,7 @@ int prep_segment ( void *segment, size_t filesz, size_t memsz ) {
 	physaddr_t start = virt_to_phys ( segment );
 	physaddr_t mid = ( start + filesz );
 	physaddr_t end = ( start + memsz );
-	physaddr_t last;
+	physaddr_t max;
 
 	DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx)\n", start, mid, end );
 
@@ -77,10 +77,10 @@ int prep_segment ( void *segment, size_t filesz, size_t memsz ) {
 	/* Zero-length segments do not need a memory region */
 	if ( memsz == 0 )
 		return 0;
-	last = ( end - 1 );
+	max = ( end - 1 );
 
 	/* Check for address space overflow */
-	if ( last < start ) {
+	if ( max < start ) {
 		DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx) wraps "
 		       "around\n", start, mid, end );
 		return -EINVAL;
@@ -91,7 +91,7 @@ int prep_segment ( void *segment, size_t filesz, size_t memsz ) {
 	memmap_dump ( &region );
 
 	/* Fail unless region is usable and sufficiently large */
-	if ( ( ! memmap_is_usable ( &region ) ) || ( region.last < last ) ) {
+	if ( ( ! memmap_is_usable ( &region ) ) || ( region.max < max ) ) {
 		DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx) does not fit "
 		       "into available memory\n", start, mid, end );
 		return -ERANGE_SEGMENT;
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
index 0175be11a..405a74baf 100644
--- a/src/include/ipxe/memmap.h
+++ b/src/include/ipxe/memmap.h
@@ -46,15 +46,10 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 /** A memory region descriptor */
 struct memmap_region {
-	/** The address being described */
-	uint64_t addr;
-	/** Last address with the same description
-	 *
-	 * Note that this is the last address with the same
-	 * description as the address being described, not the first
-	 * address with a different description.
-	 */
-	uint64_t last;
+	/** Minimum address in region */
+	uint64_t min;
+	/** Maximum address in region */
+	uint64_t max;
 	/** Region flags */
 	unsigned int flags;
 	/** Region name (for debug messages) */
@@ -69,14 +64,14 @@ struct memmap_region {
 /**
  * Initialise memory region descriptor
  *
- * @v addr		Address within region
+ * @v min		Minimum address
  * @v region		Region descriptor to fill in
  */
 static inline __attribute__ (( always_inline )) void
-memmap_init ( uint64_t addr, struct memmap_region *region ) {
+memmap_init ( uint64_t min, struct memmap_region *region ) {
 
-	region->addr = addr;
-	region->last = ~( ( uint64_t ) 0 );
+	region->min = min;
+	region->max = ~( ( uint64_t ) 0 );
 	region->flags = 0;
 	region->name = NULL;
 }
@@ -103,7 +98,7 @@ static inline __attribute__ (( always_inline )) uint64_t
 memmap_size ( const struct memmap_region *region ) {
 
 	/* Calculate size, assuming overflow is known to be impossible */
-	return ( ( region->last + 1 ) - region->addr );
+	return ( region->max - region->min + 1 );
 }
 
 /** An in-use memory region */
@@ -132,11 +127,11 @@ struct used_region {
 /**
  * Describe memory region from system memory map
  *
- * @v addr		Address within region
+ * @v min		Minimum address
  * @v hide		Hide in-use regions from the memory map
  * @v region		Region descriptor to fill in
  */
-void memmap_describe ( uint64_t addr, int hide, struct memmap_region *region );
+void memmap_describe ( uint64_t min, int hide, struct memmap_region *region );
 
 /**
  * Synchronise in-use regions with the externally visible system memory map
@@ -173,11 +168,11 @@ memmap_use ( struct used_region *used, physaddr_t start, size_t size ) {
  * @v hide		Hide in-use regions from the memory map
  */
 #define for_each_memmap_from( region, start, hide )			\
-	for ( (region)->addr = (start), (region)->last = 0 ;		\
-	      ( ( ( (region)->last + 1 ) != 0 ) &&			\
-		( memmap_describe ( (region)->addr, (hide),		\
+	for ( (region)->min = (start), (region)->max = 0 ;		\
+	      ( ( ( (region)->max + 1 ) != 0 ) &&			\
+		( memmap_describe ( (region)->min, (hide),		\
 				    (region) ), 1 ) ) ;			\
-	      (region)->addr = ( (region)->last + 1 ) )
+	      (region)->min = ( (region)->max + 1 ) )
 
 /**
  * Iterate over memory regions
@@ -204,8 +199,8 @@ static inline void memmap_dump ( const struct memmap_region *region ) {
 	       ( ( flags & MEMMAP_FL_RESERVED ) ? "R" : "-" ),
 	       ( ( flags & MEMMAP_FL_USED ) ? "U" : "-" ),
 	       ( ( flags & MEMMAP_FL_INACCESSIBLE ) ? "X" : "-" ),
-	       ( ( unsigned long long ) region->addr ),
-	       ( ( unsigned long long ) region->last ),
+	       ( ( unsigned long long ) region->min ),
+	       ( ( unsigned long long ) region->max ),
 	       ( name ? " " : "" ), ( name ? name : "" ) );
 }
 
diff --git a/src/include/ipxe/null_memmap.h b/src/include/ipxe/null_memmap.h
index 43c0f2a29..0933d45be 100644
--- a/src/include/ipxe/null_memmap.h
+++ b/src/include/ipxe/null_memmap.h
@@ -20,16 +20,16 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 /**
  * Describe memory region from system memory map
  *
- * @v addr		Address within region
+ * @v min		Minimum address
  * @v hide		Hide in-use regions from the memory map
  * @v region		Region descriptor to fill in
  */
 static inline __attribute__ (( always_inline )) void
-MEMMAP_INLINE ( null, memmap_describe ) ( uint64_t addr, int hide __unused,
+MEMMAP_INLINE ( null, memmap_describe ) ( uint64_t min, int hide __unused,
 					  struct memmap_region *region ) {
 
 	/* Initialise region as empty */
-	memmap_init ( addr, region );
+	memmap_init ( min, region );
 }
 
 /**
-- 
cgit v1.2.3-55-g7522


From 09140ab2c1a14b77d1e8beb407e500cb4deeb0ae Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Sun, 25 May 2025 12:06:53 +0100
Subject: [memmap] Allow explicit colour selection for memory map debug
 messages

Provide DBGC_MEMMAP() as a replacement for memmap_dump(), allowing the
colour used to match other messages within the same message group.

Retain a dedicated colour for output from memmap_dump_all(), on the
basis that it is generally most useful to visually compare full memory
dumps against previous full memory dumps.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/relocate.c   |  2 +-
 src/arch/x86/image/multiboot.c |  2 +-
 src/core/fdtmem.c              |  8 +++----
 src/core/memmap.c              |  2 +-
 src/image/lkrn.c               |  2 +-
 src/image/segment.c            | 10 ++++-----
 src/include/ipxe/memmap.h      | 47 ++++++++++++++++++++++--------------------
 7 files changed, 38 insertions(+), 35 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/relocate.c b/src/arch/x86/core/relocate.c
index 0a8f0b8dc..3cdc53c2e 100644
--- a/src/arch/x86/core/relocate.c
+++ b/src/arch/x86/core/relocate.c
@@ -80,7 +80,7 @@ __asmcall void relocate ( struct i386_all_regs *ix86 ) {
 		 * away with using just 32-bit arithmetic after this
 		 * stage.
 		 */
-		memmap_dump ( &region );
+		DBGC_MEMMAP ( &region, &region );
 		if ( region.min > max ) {
 			DBGC ( &region, "...starts after max=%#08lx\n", max );
 			break;
diff --git a/src/arch/x86/image/multiboot.c b/src/arch/x86/image/multiboot.c
index c6bc01d4c..40d6941da 100644
--- a/src/arch/x86/image/multiboot.c
+++ b/src/arch/x86/image/multiboot.c
@@ -120,7 +120,7 @@ static void multiboot_build_memmap ( struct image *image,
 		/* Ignore any non-memory regions */
 		if ( ! ( region.flags & MEMMAP_FL_MEMORY ) )
 			continue;
-		memmap_dump ( &region );
+		DBGC_MEMMAP ( image, &region );
 
 		/* Check Multiboot memory map limit */
 		if ( ! remaining ) {
diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index bb8786d3c..fb44397af 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -273,7 +273,7 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 
 	/* Parse FDT */
 	if ( ( rc = fdt_parse ( &fdt, hdr, -1UL ) ) != 0 ) {
-		DBGC ( &region, "FDTMEM could not parse FDT: %s\n",
+		DBGC ( hdr, "FDTMEM could not parse FDT: %s\n",
 		       strerror ( rc ) );
 		/* Refuse relocation if we have no FDT */
 		return old;
@@ -282,7 +282,7 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 	/* Determine required length */
 	len = fdtmem_len ( &fdt );
 	assert ( len > 0 );
-	DBGC ( &region, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
+	DBGC ( hdr, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
 	       "relocation\n", memsz, fdt.len, len );
 
 	/* Construct memory map and choose a relocation address */
@@ -297,7 +297,7 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 		next = ( region.max + 1 );
 
 		/* Dump region descriptor (for debugging) */
-		memmap_dump ( &region );
+		DBGC_MEMMAP ( hdr, &region );
 		assert ( region.max >= region.min );
 
 		/* Use highest possible region */
@@ -313,7 +313,7 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 		}
 	}
 
-	DBGC ( &region, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
+	DBGC ( hdr, "FDTMEM relocating %#08lx => [%#08lx,%#08lx]\n",
 	       old, new, ( ( physaddr_t ) ( new + len - 1 ) ) );
 	return new;
 }
diff --git a/src/core/memmap.c b/src/core/memmap.c
index 2939e855b..4a96055e6 100644
--- a/src/core/memmap.c
+++ b/src/core/memmap.c
@@ -127,7 +127,7 @@ size_t memmap_largest ( physaddr_t *start ) {
 	*start = 0;
 	largest = 0;
 	for_each_memmap ( &region, 1 ) {
-		memmap_dump ( &region );
+		DBGC_MEMMAP ( &region, &region );
 		if ( ! memmap_is_usable ( &region ) )
 			continue;
 		size = memmap_size ( &region );
diff --git a/src/image/lkrn.c b/src/image/lkrn.c
index 8a7c577cd..a2044cb82 100644
--- a/src/image/lkrn.c
+++ b/src/image/lkrn.c
@@ -102,7 +102,7 @@ static int lkrn_ram ( struct image *image, struct lkrn_context *ctx ) {
 
 	/* Locate start of RAM */
 	for_each_memmap ( &region, 0 ) {
-		memmap_dump ( &region );
+		DBGC_MEMMAP ( image, &region );
 		if ( ! ( region.flags & MEMMAP_FL_MEMORY ) )
 			continue;
 		ctx->ram = region.min;
diff --git a/src/image/segment.c b/src/image/segment.c
index 469a66321..d90da709c 100644
--- a/src/image/segment.c
+++ b/src/image/segment.c
@@ -65,11 +65,11 @@ int prep_segment ( void *segment, size_t filesz, size_t memsz ) {
 	physaddr_t end = ( start + memsz );
 	physaddr_t max;
 
-	DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx)\n", start, mid, end );
+	DBGC ( segment, "SEGMENT [%#08lx,%#08lx,%#08lx)\n", start, mid, end );
 
 	/* Check for malformed lengths */
 	if ( filesz > memsz ) {
-		DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx) is "
+		DBGC ( segment, "SEGMENT [%#08lx,%#08lx,%#08lx) is "
 		       "malformed\n", start, mid, end );
 		return -EINVAL;
 	}
@@ -81,18 +81,18 @@ int prep_segment ( void *segment, size_t filesz, size_t memsz ) {
 
 	/* Check for address space overflow */
 	if ( max < start ) {
-		DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx) wraps "
+		DBGC ( segment, "SEGMENT [%#08lx,%#08lx,%#08lx) wraps "
 		       "around\n", start, mid, end );
 		return -EINVAL;
 	}
 
 	/* Describe region containing this segment */
 	memmap_describe ( start, 1, &region );
-	memmap_dump ( &region );
+	DBGC_MEMMAP ( segment, &region );
 
 	/* Fail unless region is usable and sufficiently large */
 	if ( ( ! memmap_is_usable ( &region ) ) || ( region.max < max ) ) {
-		DBGC ( &region, "SEGMENT [%#08lx,%#08lx,%#08lx) does not fit "
+		DBGC ( segment, "SEGMENT [%#08lx,%#08lx,%#08lx) does not fit "
 		       "into available memory\n", start, mid, end );
 		return -ERANGE_SEGMENT;
 	}
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
index 405a74baf..c16e25daa 100644
--- a/src/include/ipxe/memmap.h
+++ b/src/include/ipxe/memmap.h
@@ -183,26 +183,29 @@ memmap_use ( struct used_region *used, physaddr_t start, size_t size ) {
 #define for_each_memmap( region, hide )					\
 	for_each_memmap_from ( (region), 0, (hide) )
 
-
-/**
- * Dump memory region descriptor (for debugging)
- *
- * @v region		Region descriptor
- */
-static inline void memmap_dump ( const struct memmap_region *region ) {
-	const char *name = region->name;
-	unsigned int flags = region->flags;
-
-	/* Dump region information */
-	DBGC ( region, "MEMMAP (%s%s%s%s) [%#08llx,%#08llx]%s%s\n",
-	       ( ( flags & MEMMAP_FL_MEMORY ) ? "M" : "-" ),
-	       ( ( flags & MEMMAP_FL_RESERVED ) ? "R" : "-" ),
-	       ( ( flags & MEMMAP_FL_USED ) ? "U" : "-" ),
-	       ( ( flags & MEMMAP_FL_INACCESSIBLE ) ? "X" : "-" ),
-	       ( ( unsigned long long ) region->min ),
-	       ( ( unsigned long long ) region->max ),
-	       ( name ? " " : "" ), ( name ? name : "" ) );
-}
+#define DBG_MEMMAP_IF( level, region ) do {				\
+	const char *name = (region)->name;				\
+	unsigned int flags = (region)->flags;				\
+									\
+	DBG_IF ( level, "MEMMAP (%s%s%s%s) [%#08llx,%#08llx]%s%s\n",	\
+		 ( ( flags & MEMMAP_FL_MEMORY ) ? "M" : "-" ),		\
+		 ( ( flags & MEMMAP_FL_RESERVED ) ? "R" : "-" ),	\
+		 ( ( flags & MEMMAP_FL_USED ) ? "U" : "-" ),		\
+		 ( ( flags & MEMMAP_FL_INACCESSIBLE ) ? "X" : "-" ),	\
+		 ( ( unsigned long long ) (region)->min ),		\
+		 ( ( unsigned long long ) (region)->max ),		\
+		 ( name ? " " : "" ), ( name ? name : "" ) );		\
+	} while ( 0 )
+
+#define DBGC_MEMMAP_IF( level, id, ... ) do {				\
+		DBG_AC_IF ( level, id );				\
+		DBG_MEMMAP_IF ( level, __VA_ARGS__ );			\
+		DBG_DC_IF ( level );					\
+	} while ( 0 )
+
+#define DBGC_MEMMAP( ... )	DBGC_MEMMAP_IF ( LOG, ##__VA_ARGS__ )
+#define DBGC2_MEMMAP( ... )	DBGC_MEMMAP_IF ( EXTRA, ##__VA_ARGS__ )
+#define DBGCP_MEMMAP( ... )	DBGC_MEMMAP_IF ( PROFILE, ##__VA_ARGS__ )
 
 /**
  * Dump system memory map (for debugging)
@@ -217,10 +220,10 @@ static inline void memmap_dump_all ( int hide ) {
 		return;
 
 	/* Describe all memory regions */
-	DBGC ( &region, "MEMMAP with in-use regions %s:\n",
+	DBGC ( &memmap_describe, "MEMMAP with in-use regions %s:\n",
 	       ( hide ? "hidden" : "ignored" ) );
 	for_each_memmap ( &region, hide )
-		memmap_dump ( &region );
+		DBGC_MEMMAP ( &memmap_describe, &region );
 }
 
 extern void memmap_update ( struct memmap_region *region, uint64_t start,
-- 
cgit v1.2.3-55-g7522


From 6af4a022b267750ec436e1bbe23e0cf91fbbd148 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 26 May 2025 00:22:52 +0100
Subject: [fdtmem] Ignore reservation regions with no fixed addresses

Do not print an error message for unused reservation regions that have
no fixed reserved address ranges.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdtmem.c | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/core')

diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index fb44397af..f048e45dd 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -119,6 +119,10 @@ static int fdtmem_update_node ( struct memmap_region *region, struct fdt *fdt,
 		/* Count regions */
 		count = fdt_reg_count ( fdt, desc.offset, &regs );
 		if ( count < 0 ) {
+			if ( flags & MEMMAP_FL_RESERVED ) {
+				/* Assume this is a non-fixed reservation */
+				continue;
+			}
 			rc = count;
 			DBGC ( region, "FDTMEM has malformed region %s: %s\n",
 			       desc.name, strerror ( rc ) );
-- 
cgit v1.2.3-55-g7522


From 192cfc3cc5af26e9aabdb50bd3488b8a7ad6bbf7 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 26 May 2025 18:22:07 +0100
Subject: [image] Use image name rather than pointer value in all debug
 messages

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/image/com32.c     | 38 +++++++++++++++++-----------------
 src/arch/x86/image/comboot.c   | 35 +++++++++++++++-----------------
 src/arch/x86/image/nbi.c       | 46 +++++++++++++++++++++++-------------------
 src/arch/x86/image/pxe_image.c | 12 +++++------
 src/core/cpio.c                |  8 ++++----
 src/image/gzip.c               | 28 ++++++++++++-------------
 src/image/zlib.c               | 16 +++++++--------
 7 files changed, 91 insertions(+), 92 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/image/com32.c b/src/arch/x86/image/com32.c
index fe55a3ee0..2b31fb2e5 100644
--- a/src/arch/x86/image/com32.c
+++ b/src/arch/x86/image/com32.c
@@ -62,8 +62,8 @@ static int com32_exec_loop ( struct image *image ) {
 		memmap_describe ( COM32_START_PHYS, 1, &region );
 		assert ( memmap_is_usable ( &region ) );
 		avail_mem_top = ( COM32_START_PHYS + memmap_size ( &region ) );
-		DBGC ( image, "COM32 %p: available memory top = 0x%x\n",
-		       image, avail_mem_top );
+		DBGC ( image, "COM32 %s: available memory top = 0x%x\n",
+		       image->name, avail_mem_top );
 		assert ( avail_mem_top != 0 );
 
 		/* Hook COMBOOT API interrupts */
@@ -114,22 +114,22 @@ static int com32_exec_loop ( struct image *image ) {
 					       image->cmdline : "" ) ),
 			  "i" ( COM32_START_PHYS )
 			: "memory" );
-		DBGC ( image, "COM32 %p: returned\n", image );
+		DBGC ( image, "COM32 %s: returned\n", image->name );
 		break;
 
 	case COMBOOT_EXIT:
-		DBGC ( image, "COM32 %p: exited\n", image );
+		DBGC ( image, "COM32 %s: exited\n", image->name );
 		break;
 
 	case COMBOOT_EXIT_RUN_KERNEL:
 		assert ( image->replacement );
-		DBGC ( image, "COM32 %p: exited to run kernel %s\n",
-		       image, image->replacement->name );
+		DBGC ( image, "COM32 %s: exited to run kernel %s\n",
+		       image->name, image->replacement->name );
 		break;
 
 	case COMBOOT_EXIT_COMMAND:
-		DBGC ( image, "COM32 %p: exited after executing command\n",
-		       image );
+		DBGC ( image, "COM32 %s: exited after executing command\n",
+		       image->name );
 		break;
 
 	default:
@@ -159,8 +159,8 @@ static int com32_identify ( struct image *image ) {
 		 * B8 FF 4C CD 21
 		 */
 		if ( memcmp ( image->data, magic, sizeof ( magic) ) == 0 ) {
-			DBGC ( image, "COM32 %p: found magic number\n",
-			       image );
+			DBGC ( image, "COM32 %s: found magic number\n",
+			       image->name );
 			return 0;
 		}
 	}
@@ -170,16 +170,16 @@ static int com32_identify ( struct image *image ) {
 	ext = strrchr( image->name, '.' );
 
 	if ( ! ext ) {
-		DBGC ( image, "COM32 %p: no extension\n",
-		       image );
+		DBGC ( image, "COM32 %s: no extension\n",
+		       image->name );
 		return -ENOEXEC;
 	}
 
 	++ext;
 
 	if ( strcasecmp( ext, "c32" ) ) {
-		DBGC ( image, "COM32 %p: unrecognized extension %s\n",
-		       image, ext );
+		DBGC ( image, "COM32 %s: unrecognized extension %s\n",
+		       image->name, ext );
 		return -ENOEXEC;
 	}
 
@@ -201,8 +201,8 @@ static int com32_load_image ( struct image *image ) {
 	memsz = filesz;
 	buffer = phys_to_virt ( COM32_START_PHYS );
 	if ( ( rc = prep_segment ( buffer, filesz, memsz ) ) != 0 ) {
-		DBGC ( image, "COM32 %p: could not prepare segment: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "COM32 %s: could not prepare segment: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
@@ -230,8 +230,8 @@ static int com32_prepare_bounce_buffer ( struct image * image ) {
 
 	/* Prepare, verify, and load the real-mode segment */
 	if ( ( rc = prep_segment ( seg, filesz, memsz ) ) != 0 ) {
-		DBGC ( image, "COM32 %p: could not prepare bounce buffer segment: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "COM32 %s: could not prepare bounce buffer segment: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
@@ -247,8 +247,6 @@ static int com32_prepare_bounce_buffer ( struct image * image ) {
 static int com32_probe ( struct image *image ) {
 	int rc;
 
-	DBGC ( image, "COM32 %p: name '%s'\n", image, image->name );
-
 	/* Check if this is a COMBOOT image */
 	if ( ( rc = com32_identify ( image ) ) != 0 ) {
 		return rc;
diff --git a/src/arch/x86/image/comboot.c b/src/arch/x86/image/comboot.c
index f717e1d32..6eba027c6 100644
--- a/src/arch/x86/image/comboot.c
+++ b/src/arch/x86/image/comboot.c
@@ -108,8 +108,8 @@ static void comboot_init_psp ( struct image * image, void *seg ) {
 	 * kilobytes; x * 1024 / 16 == x * 64 == x << 6 */
 	psp->first_non_free_para = get_fbms() << 6;
 
-	DBGC ( image, "COMBOOT %p: first non-free paragraph = 0x%x\n",
-	       image, psp->first_non_free_para );
+	DBGC ( image, "COMBOOT %s: first non-free paragraph = 0x%x\n",
+	       image->name, psp->first_non_free_para );
 
 	/* Copy the command line to the PSP */
 	comboot_copy_cmdline ( image, seg );
@@ -172,22 +172,22 @@ static int comboot_exec_loop ( struct image *image ) {
 				    "xorw %%bp, %%bp\n\t"
 				    "lret\n\t" )
 					 : : "R" ( COMBOOT_PSP_SEG ) : "eax" );
-		DBGC ( image, "COMBOOT %p: returned\n", image );
+		DBGC ( image, "COMBOOT %s: returned\n", image->name );
 		break;
 
 	case COMBOOT_EXIT:
-		DBGC ( image, "COMBOOT %p: exited\n", image );
+		DBGC ( image, "COMBOOT %s: exited\n", image->name );
 		break;
 
 	case COMBOOT_EXIT_RUN_KERNEL:
 		assert ( image->replacement );
-		DBGC ( image, "COMBOOT %p: exited to run kernel %s\n",
-		       image, image->replacement->name );
+		DBGC ( image, "COMBOOT %s: exited to run kernel %s\n",
+		       image->name, image->replacement->name );
 		break;
 
 	case COMBOOT_EXIT_COMMAND:
-		DBGC ( image, "COMBOOT %p: exited after executing command\n",
-		       image );
+		DBGC ( image, "COMBOOT %s: exited after executing command\n",
+		       image->name );
 		break;
 
 	default:
@@ -213,16 +213,16 @@ static int comboot_identify ( struct image *image ) {
 	ext = strrchr( image->name, '.' );
 
 	if ( ! ext ) {
-		DBGC ( image, "COMBOOT %p: no extension\n",
-		       image );
+		DBGC ( image, "COMBOOT %s: no extension\n",
+		       image->name );
 		return -ENOEXEC;
 	}
 
 	++ext;
 
 	if ( strcasecmp( ext, "cbt" ) ) {
-		DBGC ( image, "COMBOOT %p: unrecognized extension %s\n",
-		       image, ext );
+		DBGC ( image, "COMBOOT %s: unrecognized extension %s\n",
+		       image->name, ext );
 		return -ENOEXEC;
 	}
 
@@ -251,8 +251,8 @@ static int comboot_prepare_segment ( struct image *image )
 
 	/* Prepare, verify, and load the real-mode segment */
 	if ( ( rc = prep_segment ( seg, filesz, memsz ) ) != 0 ) {
-		DBGC ( image, "COMBOOT %p: could not prepare segment: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "COMBOOT %s: could not prepare segment: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
@@ -274,9 +274,6 @@ static int comboot_prepare_segment ( struct image *image )
 static int comboot_probe ( struct image *image ) {
 	int rc;
 
-	DBGC ( image, "COMBOOT %p: name '%s'\n",
-	       image, image->name );
-
 	/* Check if this is a COMBOOT image */
 	if ( ( rc = comboot_identify ( image ) ) != 0 ) {
 
@@ -297,8 +294,8 @@ static int comboot_exec ( struct image *image ) {
 
 	/* Sanity check for filesize */
 	if( image->len >= 0xFF00 ) {
-		DBGC( image, "COMBOOT %p: image too large\n",
-		      image );
+		DBGC( image, "COMBOOT %s: image too large\n",
+		      image->name );
 		return -ENOEXEC;
 	}
 
diff --git a/src/arch/x86/image/nbi.c b/src/arch/x86/image/nbi.c
index 0f57bdfcd..e0a46758e 100644
--- a/src/arch/x86/image/nbi.c
+++ b/src/arch/x86/image/nbi.c
@@ -111,8 +111,8 @@ static int nbi_prepare_segment ( struct image *image, size_t offset __unused,
 	int rc;
 
 	if ( ( rc = prep_segment ( dest, filesz, memsz ) ) != 0 ) {
-		DBGC ( image, "NBI %p could not prepare segment: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "NBI %s could not prepare segment: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
@@ -174,8 +174,8 @@ static int nbi_process_segments ( struct image *image,
 		sh = ( image->data + sh_off );
 		if ( sh->length == 0 ) {
 			/* Avoid infinite loop? */
-			DBGC ( image, "NBI %p invalid segheader length 0\n",
-			       image );
+			DBGC ( image, "NBI %s invalid segheader length 0\n",
+			       image->name );
 			return -ENOEXEC;
 		}
 		
@@ -207,7 +207,8 @@ static int nbi_process_segments ( struct image *image,
 		filesz = sh->imglength;
 		memsz = sh->memlength;
 		if ( ( offset + filesz ) > image->len ) {
-			DBGC ( image, "NBI %p segment outside file\n", image );
+			DBGC ( image, "NBI %s segment outside file\n",
+			       image->name );
 			return -ENOEXEC;
 		}
 		if ( ( rc = process ( image, offset, dest,
@@ -219,15 +220,16 @@ static int nbi_process_segments ( struct image *image,
 		/* Next segheader */
 		sh_off += NBI_LENGTH ( sh->length );
 		if ( sh_off >= NBI_HEADER_LENGTH ) {
-			DBGC ( image, "NBI %p header overflow\n", image );
+			DBGC ( image, "NBI %s header overflow\n",
+			       image->name );
 			return -ENOEXEC;
 		}
 
 	} while ( ! NBI_LAST_SEGHEADER ( sh->flags ) );
 
 	if ( offset != image->len ) {
-		DBGC ( image, "NBI %p length wrong (file %zd, metadata %zd)\n",
-		       image, image->len, offset );
+		DBGC ( image, "NBI %s length wrong (file %zd, metadata %zd)\n",
+		       image->name, image->len, offset );
 		return -ENOEXEC;
 	}
 
@@ -245,8 +247,8 @@ static int nbi_boot16 ( struct image *image,
 	int discard_D, discard_S, discard_b;
 	int32_t rc;
 
-	DBGC ( image, "NBI %p executing 16-bit image at %04x:%04x\n", image,
-	       imgheader->execaddr.segoff.segment,
+	DBGC ( image, "NBI %s executing 16-bit image at %04x:%04x\n",
+	       image->name, imgheader->execaddr.segoff.segment,
 	       imgheader->execaddr.segoff.offset );
 
 	__asm__ __volatile__ (
@@ -288,8 +290,8 @@ static int nbi_boot32 ( struct image *image,
 	int discard_D, discard_S, discard_b;
 	int32_t rc;
 
-	DBGC ( image, "NBI %p executing 32-bit image at %lx\n",
-	       image, imgheader->execaddr.linear );
+	DBGC ( image, "NBI %s executing 32-bit image at %lx\n",
+	       image->name, imgheader->execaddr.linear );
 
 	/* Jump to OS with flat physical addressing */
 	__asm__ __volatile__ (
@@ -324,14 +326,15 @@ static int nbi_prepare_dhcp ( struct image *image ) {
 
 	boot_netdev = last_opened_netdev();
 	if ( ! boot_netdev ) {
-		DBGC ( image, "NBI %p could not identify a network device\n",
-		       image );
+		DBGC ( image, "NBI %s could not identify a network device\n",
+		       image->name );
 		return -ENODEV;
 	}
 
 	if ( ( rc = create_fakedhcpack ( boot_netdev, basemem_packet,
 					 sizeof ( basemem_packet ) ) ) != 0 ) {
-		DBGC ( image, "NBI %p failed to build DHCP packet\n", image );
+		DBGC ( image, "NBI %s failed to build DHCP packet\n",
+		       image->name );
 		return rc;
 	}
 
@@ -352,7 +355,7 @@ static int nbi_exec ( struct image *image ) {
 	/* Retrieve image header */
 	imgheader = image->data;
 
-	DBGC ( image, "NBI %p placing header at %hx:%hx\n", image,
+	DBGC ( image, "NBI %s placing header at %hx:%hx\n", image->name,
 	       imgheader->location.segment, imgheader->location.offset );
 
 	/* NBI files can have overlaps between segments; the bss of
@@ -387,12 +390,12 @@ static int nbi_exec ( struct image *image ) {
 
 	if ( ! may_return ) {
 		/* Cannot continue after shutdown() called */
-		DBGC ( image, "NBI %p returned %d from non-returnable image\n",
-		       image, rc  );
+		DBGC ( image, "NBI %s returned %d from non-returnable image\n",
+		       image->name, rc  );
 		while ( 1 ) {}
 	}
 
-	DBGC ( image, "NBI %p returned %d\n", image, rc );
+	DBGC ( image, "NBI %s returned %d\n", image->name, rc );
 
 	return rc;
 }
@@ -408,14 +411,15 @@ static int nbi_probe ( struct image *image ) {
 
 	/* If we don't have enough data give up */
 	if ( image->len < NBI_HEADER_LENGTH ) {
-		DBGC ( image, "NBI %p too short for an NBI image\n", image );
+		DBGC ( image, "NBI %s too short for an NBI image\n",
+		       image->name );
 		return -ENOEXEC;
 	}
 	imgheader = image->data;
 
 	/* Check image header */
 	if ( imgheader->magic != NBI_MAGIC ) {
-		DBGC ( image, "NBI %p has no NBI signature\n", image );
+		DBGC ( image, "NBI %s has no NBI signature\n", image->name );
 		return -ENOEXEC;
 	}
 
diff --git a/src/arch/x86/image/pxe_image.c b/src/arch/x86/image/pxe_image.c
index ccb3a7d9d..f88eadc09 100644
--- a/src/arch/x86/image/pxe_image.c
+++ b/src/arch/x86/image/pxe_image.c
@@ -60,8 +60,8 @@ static int pxe_exec ( struct image *image ) {
 
 	/* Verify and prepare segment */
 	if ( ( rc = prep_segment ( buffer, image->len, image->len ) ) != 0 ) {
-		DBGC ( image, "IMAGE %p could not prepare segment: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "IMAGE %s could not prepare segment: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
@@ -70,8 +70,8 @@ static int pxe_exec ( struct image *image ) {
 
 	/* Arbitrarily pick the most recently opened network device */
 	if ( ( netdev = last_opened_netdev() ) == NULL ) {
-		DBGC ( image, "IMAGE %p could not locate PXE net device\n",
-		       image );
+		DBGC ( image, "IMAGE %s could not locate PXE net device\n",
+		       image->name );
 		return -ENODEV;
 	}
 	netdev_get ( netdev );
@@ -155,8 +155,8 @@ int pxe_probe_no_mz ( struct image *image ) {
 	if ( image->len >= sizeof ( *magic ) ) {
 		magic = image->data;
 		if ( *magic == cpu_to_le16 ( EFI_IMAGE_DOS_SIGNATURE ) ) {
-			DBGC ( image, "IMAGE %p may be an EFI image\n",
-			       image );
+			DBGC ( image, "IMAGE %s may be an EFI image\n",
+			       image->name );
 			return -ENOTTY;
 		}
 	}
diff --git a/src/core/cpio.c b/src/core/cpio.c
index 9f5d772e9..15e33d206 100644
--- a/src/core/cpio.c
+++ b/src/core/cpio.c
@@ -125,8 +125,8 @@ static void cpio_parse_cmdline ( struct image *image, unsigned int *mode,
 	if ( ( arg = image_argument ( image, "mode=" ) ) ) {
 		*mode = strtoul ( arg, &end, 8 /* Octal for file mode */ );
 		if ( *end && ( *end != ' ' ) ) {
-			DBGC ( image, "CPIO %p strange \"mode=\" "
-			       "terminator '%c'\n", image, *end );
+			DBGC ( image, "CPIO %s strange \"mode=\" "
+			       "terminator '%c'\n", image->name, *end );
 		}
 	}
 
@@ -134,8 +134,8 @@ static void cpio_parse_cmdline ( struct image *image, unsigned int *mode,
 	if ( ( arg = image_argument ( image, "mkdir=" ) ) ) {
 		*count += strtoul ( arg, &end, 10 );
 		if ( *end && ( *end != ' ' ) ) {
-			DBGC ( image, "CPIO %p strange \"mkdir=\" "
-			       "terminator '%c'\n", image, *end );
+			DBGC ( image, "CPIO %s strange \"mkdir=\" "
+			       "terminator '%c'\n", image->name, *end );
 		}
 	}
 
diff --git a/src/image/gzip.c b/src/image/gzip.c
index b72c3243e..17ccd2492 100644
--- a/src/image/gzip.c
+++ b/src/image/gzip.c
@@ -76,8 +76,8 @@ static int gzip_extract ( struct image *image, struct image *extracted ) {
 	/* Skip extra header, if present */
 	if ( header->flags & GZIP_FL_EXTRA ) {
 		if ( len < sizeof ( *extra ) ) {
-			DBGC ( image, "GZIP %p overlength extra header\n",
-			       image );
+			DBGC ( image, "GZIP %s overlength extra header\n",
+			       image->name );
 			return -EINVAL;
 		}
 		extra = data;
@@ -85,8 +85,8 @@ static int gzip_extract ( struct image *image, struct image *extracted ) {
 		len -= sizeof ( *extra );
 		extra_len = le16_to_cpu ( extra->len );
 		if ( len < extra_len ) {
-			DBGC ( image, "GZIP %p overlength extra header\n",
-			       image );
+			DBGC ( image, "GZIP %s overlength extra header\n",
+			       image->name );
 			return -EINVAL;
 		}
 		data += extra_len;
@@ -102,8 +102,8 @@ static int gzip_extract ( struct image *image, struct image *extracted ) {
 	while ( strings-- ) {
 		string_len = strnlen ( data, len );
 		if ( string_len == len ) {
-			DBGC ( image, "GZIP %p overlength name/comment\n",
-			       image );
+			DBGC ( image, "GZIP %s overlength name/comment\n",
+			       image->name );
 			return -EINVAL;
 		}
 		data += ( string_len + 1 /* NUL */ );
@@ -113,8 +113,8 @@ static int gzip_extract ( struct image *image, struct image *extracted ) {
 	/* Skip CRC, if present */
 	if ( header->flags & GZIP_FL_HCRC ) {
 		if ( len < sizeof ( *crc ) ) {
-			DBGC ( image, "GZIP %p overlength CRC header\n",
-			       image );
+			DBGC ( image, "GZIP %s overlength CRC header\n",
+			       image->name );
 			return -EINVAL;
 		}
 		data += sizeof ( *crc );
@@ -124,16 +124,16 @@ static int gzip_extract ( struct image *image, struct image *extracted ) {
 	/* Presize extracted image */
 	if ( ( rc = image_set_len ( extracted,
 				    le32_to_cpu ( footer->len ) ) ) != 0 ) {
-		DBGC ( image, "GZIP %p could not presize: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "GZIP %s could not presize: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
 	/* Decompress image (expanding if necessary) */
 	if ( ( rc = zlib_deflate ( DEFLATE_RAW, data, len,
 				   extracted ) ) != 0 ) {
-		DBGC ( image, "GZIP %p could not decompress: %s\n",
-		       image, strerror ( rc ) );
+		DBGC ( image, "GZIP %s could not decompress: %s\n",
+		       image->name, strerror ( rc ) );
 		return rc;
 	}
 
@@ -152,14 +152,14 @@ static int gzip_probe ( struct image *image ) {
 
 	/* Sanity check */
 	if ( image->len < ( sizeof ( *header ) + sizeof ( *footer ) ) ) {
-		DBGC ( image, "GZIP %p image too short\n", image );
+		DBGC ( image, "GZIP %s image too short\n", image->name );
 		return -ENOEXEC;
 	}
 	header = image->data;
 
 	/* Check magic header */
 	if ( header->magic != cpu_to_be16 ( GZIP_MAGIC ) ) {
-		DBGC ( image, "GZIP %p invalid magic\n", image );
+		DBGC ( image, "GZIP %s invalid magic\n", image->name );
 		return -ENOEXEC;
 	}
 
diff --git a/src/image/zlib.c b/src/image/zlib.c
index 23eb50e7d..f0f8f5622 100644
--- a/src/image/zlib.c
+++ b/src/image/zlib.c
@@ -71,15 +71,15 @@ int zlib_deflate ( enum deflate_format format, const void *data, size_t len,
 		/* Decompress data */
 		if ( ( rc = deflate_inflate ( deflate, data, len,
 					      &out ) ) != 0 ) {
-			DBGC ( extracted, "ZLIB %p could not decompress: %s\n",
-			       extracted, strerror ( rc ) );
+			DBGC ( extracted, "ZLIB %s could not decompress: %s\n",
+			       extracted->name, strerror ( rc ) );
 			goto err_inflate;
 		}
 
 		/* Check that decompression is valid */
 		if ( ! deflate_finished ( deflate ) ) {
-			DBGC ( extracted, "ZLIB %p decompression incomplete\n",
-			       extracted );
+			DBGC ( extracted, "ZLIB %s decompression incomplete\n",
+			       extracted->name );
 			rc = -EINVAL;
 			goto err_unfinished;
 		}
@@ -90,8 +90,8 @@ int zlib_deflate ( enum deflate_format format, const void *data, size_t len,
 
 		/* Otherwise, resize output image and retry */
 		if ( ( rc = image_set_len ( extracted, out.offset ) ) != 0 ) {
-			DBGC ( extracted, "ZLIB %p could not resize: %s\n",
-			       extracted, strerror ( rc ) );
+			DBGC ( extracted, "ZLIB %s could not resize: %s\n",
+			       extracted->name, strerror ( rc ) );
 			goto err_set_size;
 		}
 	}
@@ -136,14 +136,14 @@ static int zlib_probe ( struct image *image ) {
 
 	/* Sanity check */
 	if ( image->len < sizeof ( *magic ) ) {
-		DBGC ( image, "ZLIB %p image too short\n", image );
+		DBGC ( image, "ZLIB %s image too short\n", image->name );
 		return -ENOEXEC;
 	}
 	magic = image->data;
 
 	/* Check magic header */
 	if ( ! zlib_magic_is_valid ( magic ) ) {
-		DBGC ( image, "ZLIB %p invalid magic data\n", image );
+		DBGC ( image, "ZLIB %s invalid magic data\n", image->name );
 		return -ENOEXEC;
 	}
 
-- 
cgit v1.2.3-55-g7522


From 1762568ec52b8b29b5bc3b870adb00f46178b51e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 30 May 2025 16:37:28 +0100
Subject: [fdt] Provide ability to locate the parent device node

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         | 96 +++++++++++++++++++++++++++++++++++++++++++++++++-
 src/include/ipxe/fdt.h |  2 ++
 src/tests/fdt_test.c   | 12 +++++++
 3 files changed, 109 insertions(+), 1 deletion(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index c8ae4d949..b2ee0133b 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -181,7 +181,7 @@ static int fdt_next ( struct fdt *fdt, struct fdt_descriptor *desc ) {
  * @ret rc		Return status code
  */
 static int fdt_enter ( struct fdt *fdt, unsigned int offset,
-		struct fdt_descriptor *desc ) {
+		       struct fdt_descriptor *desc ) {
 	int rc;
 
 	/* Find begin node token */
@@ -212,6 +212,100 @@ static int fdt_enter ( struct fdt *fdt, unsigned int offset,
 	}
 }
 
+/**
+ * Find node relative depth
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v target		Target node offset
+ * @ret depth		Depth, or negative error
+ */
+static int fdt_depth ( struct fdt *fdt, unsigned int offset,
+		       unsigned int target ) {
+	struct fdt_descriptor desc;
+	int depth;
+	int rc;
+
+	/* Enter node */
+	if ( ( rc = fdt_enter ( fdt, offset, &desc ) ) != 0 )
+		return rc;
+
+	/* Find target node */
+	for ( depth = 0 ; depth >= 0 ; depth += desc.depth ) {
+
+		/* Describe token */
+		if ( ( rc = fdt_next ( fdt, &desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       offset, strerror ( rc ) );
+			return rc;
+		}
+
+		/* Check for target node */
+		if ( desc.offset == target ) {
+			DBGC2 ( fdt, "FDT +%#04x has descendant node +%#04x "
+				"at depth +%d\n", offset, target, depth );
+			return depth;
+		}
+	}
+
+	DBGC ( fdt, "FDT +#%04x has no descendant node +%#04x\n",
+	       offset, target );
+	return -ENOENT;
+}
+
+/**
+ * Find parent node
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v parent		Parent node offset to fill in
+ * @ret rc		Return status code
+ */
+int fdt_parent ( struct fdt *fdt, unsigned int offset, unsigned int *parent ) {
+	struct fdt_descriptor desc;
+	int pdepth;
+	int depth;
+	int rc;
+
+	/* Find depth from root of tree */
+	depth = fdt_depth ( fdt, 0, offset );
+	if ( depth < 0 ) {
+		rc = depth;
+		return rc;
+	}
+	pdepth = ( depth - 1 );
+
+	/* Enter root node */
+	if ( ( rc = fdt_enter ( fdt, 0, &desc ) ) != 0 )
+		return rc;
+	*parent = desc.offset;
+
+	/* Find parent node */
+	for ( depth = 0 ; depth >= 0 ; depth += desc.depth ) {
+
+		/* Describe token */
+		if ( ( rc = fdt_next ( fdt, &desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       offset, strerror ( rc ) );
+			return rc;
+		}
+
+		/* Record possible parent node */
+		if ( ( depth == pdepth ) && desc.name && ( ! desc.data ) )
+			*parent = desc.offset;
+
+		/* Check for target node */
+		if ( desc.offset == offset ) {
+			DBGC2 ( fdt, "FDT +%#04x has parent node at +%#04x\n",
+				offset, *parent );
+			return 0;
+		}
+	}
+
+	DBGC ( fdt, "FDT +#%04x has no parent node\n", offset );
+	return -ENOENT;
+}
+
 /**
  * Find child node
  *
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index 461b09632..d5a0d2179 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -170,6 +170,8 @@ fdt_reservations ( struct fdt *fdt ) {
 
 extern int fdt_describe ( struct fdt *fdt, unsigned int offset,
 			  struct fdt_descriptor *desc );
+extern int fdt_parent ( struct fdt *fdt, unsigned int offset,
+			unsigned int *parent );
 extern int fdt_path ( struct fdt *fdt, const char *path,
 		      unsigned int *offset );
 extern int fdt_alias ( struct fdt *fdt, const char *name,
diff --git a/src/tests/fdt_test.c b/src/tests/fdt_test.c
index 1dead2126..408f77c6d 100644
--- a/src/tests/fdt_test.c
+++ b/src/tests/fdt_test.c
@@ -263,6 +263,18 @@ static void fdt_test_exec ( void ) {
 	ok ( strcmp ( desc.data, "memory" ) == 0 );
 	ok ( desc.depth == 0 );
 
+	/* Verify parent lookup */
+	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000/ethernet-phy@0",
+			&offset ) == 0 );
+	ok ( fdt_parent ( &fdt, offset, &offset ) == 0 );
+	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
+	ok ( strcmp ( desc.name, "ethernet@10090000" ) == 0 );
+	ok ( fdt_parent ( &fdt, offset, &offset ) == 0 );
+	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
+	ok ( strcmp ( desc.name, "soc" ) == 0 );
+	ok ( fdt_parent ( &fdt, offset, &offset ) == 0 );
+	ok ( offset == 0 );
+
 	/* Verify device tree creation */
 	image = image_memory ( "test.dtb", sifive_u, sizeof ( sifive_u ) );
 	ok ( image != NULL );
-- 
cgit v1.2.3-55-g7522


From 3e8909cf5feb9f2b695f5ec15427a90a9fc6d46e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 11 Jun 2025 13:48:12 +0100
Subject: [fdtmem] Limit relocation to 32-bit address space

Devices with only 32-bit DMA addressing are relatively common even on
systems with 64-bit CPUs.  Limit relocation of iPXE to 32-bit address
space so that I/O buffers and other DMA allocations will be accessible
by 32-bit devices.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdtmem.c | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdtmem.c b/src/core/fdtmem.c
index f048e45dd..97e3bb2f6 100644
--- a/src/core/fdtmem.c
+++ b/src/core/fdtmem.c
@@ -62,6 +62,9 @@ struct used_region fdtmem_used __used_region = {
 /** Maximum accessible physical address */
 static physaddr_t fdtmem_max;
 
+/** Maximum 32-bit physical address */
+#define FDTMEM_MAX32 0xffffffff
+
 /**
  * Update memory region descriptor based on device tree node
  *
@@ -249,9 +252,9 @@ static size_t fdtmem_len ( struct fdt *fdt ) {
  * @v max		Maximum accessible physical address
  * @ret new		New physical address for relocation
  *
- * Find a suitably aligned address towards the top of existent memory
- * to which iPXE may be relocated, along with a copy of the system
- * device tree.
+ * Find a suitably aligned address towards the top of existent 32-bit
+ * memory to which iPXE may be relocated, along with a copy of the
+ * system device tree.
  *
  * This function may be called very early in initialisation, before
  * .data is writable or .bss has been zeroed.  Neither this function
@@ -289,6 +292,16 @@ physaddr_t fdtmem_relocate ( struct fdt_header *hdr, physaddr_t max ) {
 	DBGC ( hdr, "FDTMEM requires %#zx + %#zx => %#zx bytes for "
 	       "relocation\n", memsz, fdt.len, len );
 
+	/* Limit relocation to 32-bit address space
+	 *
+	 * Devices with only 32-bit DMA addressing are relatively
+	 * common even on systems with 64-bit CPUs.  Limit relocation
+	 * of iPXE to 32-bit address space so that I/O buffers and
+	 * other DMA allocations will be accessible by 32-bit devices.
+	 */
+	if ( max > FDTMEM_MAX32 )
+		max = FDTMEM_MAX32;
+
 	/* Construct memory map and choose a relocation address */
 	new = old;
 	for ( addr = 0, next = 1 ; next ; addr = next ) {
-- 
cgit v1.2.3-55-g7522


From 7e96e5f2ef074c6c17a75dad20beb2a61ecca2f8 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 11 Jun 2025 16:08:42 +0100
Subject: [fdt] Allow paths and aliases to be terminated with separator
 characters

Non-permitted name characters such as a colon are sometimes used to
separate alias names or paths from additional metadata, such as the
baud rate for a UART in the "/chosen/stdout-path" property.

Support the use of such alias names and paths by allowing any
character not permitted in a property name to terminate a property or
node name match.  (This is a very relaxed matching rule that will
produce false positive matches on invalid input, but this is unlikely
to cause problems in practice.)

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c       | 39 ++++++++++++++++++++++++++++++---------
 src/tests/fdt_test.c |  7 +++++++
 2 files changed, 37 insertions(+), 9 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index b2ee0133b..149348199 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -24,6 +24,7 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <string.h>
+#include <ctype.h>
 #include <errno.h>
 #include <assert.h>
 #include <byteswap.h>
@@ -50,6 +51,33 @@ struct image_tag fdt_image __image_tag = {
 /** Amount of free space to add whenever we have to reallocate a tree */
 #define FDT_INSERT_PAD 1024
 
+/**
+ * Check if character is permitted in a name
+ *
+ * @v ch		Character
+ * @ret is_permitted	Character is permitted in a name
+ */
+static int fdt_permitted ( char ch ) {
+	static const char permitted[] = ",._+?#-";
+
+	return ( isalnum ( ch ) || strchr ( permitted, ch ) );
+}
+
+/**
+ * Compare node name
+ *
+ * @v desc		Token descriptor
+ * @v name		Name (terminated by NUL or any non-permitted character)
+ * @ret is_match	Name matches token descriptor
+ */
+static int fdt_match ( const struct fdt_descriptor *desc, const char *name ) {
+	size_t len = strlen ( desc->name );
+
+	/* Check name and terminator */
+	return ( ( memcmp ( desc->name, name, len ) == 0 ) &&
+		 ( ! ( name[len] && fdt_permitted ( name[len] ) ) ) );
+}
+
 /**
  * Describe device tree token
  *
@@ -318,15 +346,9 @@ int fdt_parent ( struct fdt *fdt, unsigned int offset, unsigned int *parent ) {
 static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 		       unsigned int *child ) {
 	struct fdt_descriptor desc;
-	const char *sep;
-	size_t name_len;
 	int depth;
 	int rc;
 
-	/* Determine length of name (may be terminated with NUL or '/') */
-	sep = strchr ( name, '/' );
-	name_len = ( sep ? ( ( size_t ) ( sep - name ) ) : strlen ( name ) );
-
 	/* Enter node */
 	if ( ( rc = fdt_enter ( fdt, offset, &desc ) ) != 0 )
 		return rc;
@@ -346,8 +368,7 @@ static int fdt_child ( struct fdt *fdt, unsigned int offset, const char *name,
 			DBGC2 ( fdt, "FDT +%#04x has child node \"%s\" at "
 				"+%#04x\n", offset, desc.name, desc.offset );
 			assert ( desc.depth > 0 );
-			if ( ( strlen ( desc.name ) == name_len ) &&
-			     ( memcmp ( name, desc.name, name_len ) == 0 ) ) {
+			if ( fdt_match ( &desc, name ) ) {
 				*child = desc.offset;
 				return 0;
 			}
@@ -495,7 +516,7 @@ static int fdt_property ( struct fdt *fdt, unsigned int offset,
 				"+%#04x len %#zx\n", offset, desc->name,
 				desc->offset, desc->len );
 			assert ( desc->depth == 0 );
-			if ( strcmp ( name, desc->name ) == 0 ) {
+			if ( fdt_match ( desc, name ) ) {
 				DBGC2_HDA ( fdt, 0, desc->data, desc->len );
 				return 0;
 			}
diff --git a/src/tests/fdt_test.c b/src/tests/fdt_test.c
index 408f77c6d..0be0acdbc 100644
--- a/src/tests/fdt_test.c
+++ b/src/tests/fdt_test.c
@@ -213,6 +213,10 @@ static void fdt_test_exec ( void ) {
 	ok ( strcmp ( string, "sifive,uart0" ) == 0 );
 	ok ( fdt_path ( &fdt, "/nonexistent", &offset ) != 0 );
 	ok ( fdt_path ( &fdt, "/cpus/nonexistent", &offset ) != 0 );
+	ok ( fdt_path ( &fdt, "/soc/serial@10010000:115200n8",
+			&offset ) == 0 );
+	ok ( ( string = fdt_string ( &fdt, offset, "compatible" ) ) != NULL );
+	ok ( strcmp ( string, "sifive,uart0" ) == 0 );
 
 	/* Verify 64-bit integer properties */
 	ok ( fdt_u64 ( &fdt, 0, "#address-cells", &u64 ) == 0 );
@@ -249,6 +253,9 @@ static void fdt_test_exec ( void ) {
 	ok ( ( string = fdt_string ( &fdt, offset, "compatible" ) ) != NULL );
 	ok ( strcmp ( string, "sifive,uart0" ) == 0 );
 	ok ( fdt_alias ( &fdt, "nonexistent0", &offset ) != 0 );
+	ok ( fdt_alias ( &fdt, "ethernet0:params", &offset ) == 0 );
+	ok ( ( string = fdt_string ( &fdt, offset, "phy-mode" ) ) != NULL );
+	ok ( strcmp ( string, "gmii" ) == 0 );
 
 	/* Verify node description */
 	ok ( fdt_path ( &fdt, "/memory@80000000", &offset ) == 0 );
-- 
cgit v1.2.3-55-g7522


From 60e167c00b138fdb162e7b2192e9cbb196ed3cbd Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 17 Jun 2025 15:44:12 +0100
Subject: [uart] Remove ability to use frame formats other than 8n1

In the context of serial consoles, the use of any frame formats other
than the standard 8 data bits, no parity, and one stop bit is so rare
as to be nonexistent.

Remove the almost certainly unused support for custom frame formats.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/config/serial.h          |  5 +----
 src/core/gdbserial.c         | 13 +++----------
 src/core/serial.c            | 14 +++-----------
 src/core/uart.c              | 10 +++-------
 src/include/ipxe/gdbserial.h |  5 +----
 src/include/ipxe/uart.h      |  4 +---
 6 files changed, 12 insertions(+), 39 deletions(-)

(limited to 'src/core')

diff --git a/src/config/serial.h b/src/config/serial.h
index 09068d8e0..69d8d8ef3 100644
--- a/src/config/serial.h
+++ b/src/config/serial.h
@@ -16,15 +16,12 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #define	COMCONSOLE	COM1		/* I/O port address */
 
 /* Keep settings from a previous user of the serial port (e.g. lilo or
- * LinuxBIOS), ignoring COMSPEED, COMDATA, COMPARITY and COMSTOP.
+ * LinuxBIOS), ignoring COMSPEED.
  */
 #undef	COMPRESERVE
 
 #ifndef COMPRESERVE
 #define	COMSPEED	115200		/* Baud rate */
-#define	COMDATA		8		/* Data bits */
-#define	COMPARITY	0		/* Parity: 0=None, 1=Odd, 2=Even */
-#define	COMSTOP		1		/* Stop bits */
 #endif
 
 /* Early UART configuration (for bare metal prefix debugging only) */
diff --git a/src/core/gdbserial.c b/src/core/gdbserial.c
index 0983f2557..1edc28109 100644
--- a/src/core/gdbserial.c
+++ b/src/core/gdbserial.c
@@ -46,13 +46,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define GDBSERIAL_BAUD COMSPEED
 #endif
 
-/* UART line control register value */
-#ifdef COMPRESERVE
-#define GDBSERIAL_LCR 0
-#else
-#define GDBSERIAL_LCR UART_LCR_WPS ( COMDATA, COMPARITY, COMSTOP )
-#endif
-
 /** GDB serial UART */
 static struct uart gdbserial_uart;
 
@@ -90,7 +83,7 @@ static int gdbserial_init ( int argc, char **argv ) {
 		return 1;
 	}
 
-	if ( ! gdbserial_configure ( port, GDBSERIAL_BAUD, GDBSERIAL_LCR ) ) {
+	if ( ! gdbserial_configure ( port, GDBSERIAL_BAUD ) ) {
 		printf ( "serial: unable to configure\n" );
 		return 1;
 	}
@@ -106,13 +99,13 @@ struct gdb_transport serial_gdb_transport __gdb_transport = {
 };
 
 struct gdb_transport * gdbserial_configure ( unsigned int port,
-					     unsigned int baud, uint8_t lcr ) {
+					     unsigned int baud ) {
 	int rc;
 
 	if ( ( rc = uart_select ( &gdbserial_uart, port ) ) != 0 )
 		return NULL;
 
-	if ( ( rc = uart_init ( &gdbserial_uart, baud, lcr ) ) != 0 )
+	if ( ( rc = uart_init ( &gdbserial_uart, baud ) ) != 0 )
 		return NULL;
 
 	return &serial_gdb_transport;
diff --git a/src/core/serial.c b/src/core/serial.c
index bef9ccbab..2866681a8 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -58,13 +58,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_BAUD COMSPEED
 #endif
 
-/* UART line control register value */
-#ifdef COMPRESERVE
-#define CONSOLE_LCR 0
-#else
-#define CONSOLE_LCR UART_LCR_WPS ( COMDATA, COMPARITY, COMSTOP )
-#endif
-
 /** Serial console UART */
 struct uart serial_console;
 
@@ -149,10 +142,9 @@ static void serial_init ( void ) {
 	}
 
 	/* Initialise UART */
-	if ( ( rc = uart_init ( &serial_console, CONSOLE_BAUD,
-				CONSOLE_LCR ) ) != 0 ) {
-		DBG ( "Could not initialise UART %d baud %d LCR %#02x: %s\n",
-		      CONSOLE_PORT, CONSOLE_BAUD, CONSOLE_LCR, strerror ( rc ));
+	if ( ( rc = uart_init ( &serial_console, CONSOLE_BAUD ) ) != 0 ) {
+		DBG ( "Could not initialise UART %d baud %d: %s\n",
+		      CONSOLE_PORT, CONSOLE_BAUD, strerror ( rc ) );
 		return;
 	}
 }
diff --git a/src/core/uart.c b/src/core/uart.c
index b85fe0767..4dc307fce 100644
--- a/src/core/uart.c
+++ b/src/core/uart.c
@@ -107,10 +107,9 @@ int uart_exists ( struct uart *uart ) {
  *
  * @v uart		UART
  * @v baud		Baud rate, or zero to leave unchanged
- * @v lcr		Line control register value, or zero to leave unchanged
  * @ret rc		Return status code
  */
-int uart_init ( struct uart *uart, unsigned int baud, uint8_t lcr ) {
+int uart_init ( struct uart *uart, unsigned int baud ) {
 	uint8_t dlm;
 	uint8_t dll;
 	int rc;
@@ -120,10 +119,7 @@ int uart_init ( struct uart *uart, unsigned int baud, uint8_t lcr ) {
 		return rc;
 
 	/* Configure divisor and line control register, if applicable */
-	if ( ! lcr )
-		lcr = uart_read ( uart, UART_LCR );
-	uart->lcr = lcr;
-	uart_write ( uart, UART_LCR, ( lcr | UART_LCR_DLAB ) );
+	uart_write ( uart, UART_LCR, ( UART_LCR_8N1 | UART_LCR_DLAB ) );
 	if ( baud ) {
 		uart->divisor = ( UART_MAX_BAUD / baud );
 		dlm = ( ( uart->divisor >> 8 ) & 0xff );
@@ -135,7 +131,7 @@ int uart_init ( struct uart *uart, unsigned int baud, uint8_t lcr ) {
 		dll = uart_read ( uart, UART_DLL );
 		uart->divisor = ( ( dlm << 8 ) | dll );
 	}
-	uart_write ( uart, UART_LCR, ( lcr & ~UART_LCR_DLAB ) );
+	uart_write ( uart, UART_LCR, UART_LCR_8N1 );
 
 	/* Disable interrupts */
 	uart_write ( uart, UART_IER, 0 );
diff --git a/src/include/ipxe/gdbserial.h b/src/include/ipxe/gdbserial.h
index e1040c94e..166eb4f0d 100644
--- a/src/include/ipxe/gdbserial.h
+++ b/src/include/ipxe/gdbserial.h
@@ -9,12 +9,9 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
-#include <stdint.h>
-
 struct gdb_transport;
 
 extern struct gdb_transport * gdbserial_configure ( unsigned int port,
-						    unsigned int baud,
-						    uint8_t lcr );
+						    unsigned int baud );
 
 #endif /* _IPXE_GDBSERIAL_H */
diff --git a/src/include/ipxe/uart.h b/src/include/ipxe/uart.h
index c63eae615..86583ee2f 100644
--- a/src/include/ipxe/uart.h
+++ b/src/include/ipxe/uart.h
@@ -82,8 +82,6 @@ struct uart {
 	void *base;
 	/** Baud rate divisor */
 	uint16_t divisor;
-	/** Line control register */
-	uint8_t lcr;
 };
 
 /** Symbolic names for port indexes */
@@ -127,6 +125,6 @@ static inline uint8_t uart_receive ( struct uart *uart ) {
 extern void uart_transmit ( struct uart *uart, uint8_t data );
 extern void uart_flush ( struct uart *uart );
 extern int uart_exists ( struct uart *uart );
-extern int uart_init ( struct uart *uart, unsigned int baud, uint8_t lcr );
+extern int uart_init ( struct uart *uart, unsigned int baud );
 
 #endif /* _IPXE_UART_H */
-- 
cgit v1.2.3-55-g7522


From 6c8fb4b89d49c40339fe61b7ec549d90f1ce9480 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 17 Jun 2025 14:28:18 +0100
Subject: [uart] Allow for the existence of non-16550 UARTs

Remove the assumption that all platforms use a fixed number of 16550
UARTs identifiable by a simple numeric index.  Create an abstraction
allowing for dynamic instantiation and registration of any number of
arbitrary UART models.

The common case of the serial console on x86 uses a single fixed UART
specified at compile time.  Avoid unnecessarily dragging in the
dynamic instantiation code in this use case by allowing COMCONSOLE to
refer to a single static UART object representing the relevant port.

When selecting a UART by command-line argument (as used in the
"gdbstub serial <port>" command), allow the UART to be specified as
either a numeric index (to retain backwards compatiblity) or a
case-insensitive port name such as "COM2".

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/Makefile                                   |   1 +
 src/arch/x86/core/x86_uart.c                   |  58 +++----
 src/arch/x86/include/bits/ns16550.h            |  60 +++++++
 src/arch/x86/include/bits/uart.h               |  41 -----
 src/arch/x86/interface/syslinux/comboot_call.c |  17 +-
 src/core/gdbserial.c                           |  42 ++---
 src/core/serial.c                              |  62 ++++---
 src/core/uart.c                                | 176 ++++++++++----------
 src/drivers/uart/ns16550.c                     | 179 +++++++++++++++++++++
 src/include/bits/ns16550.h                     |  15 ++
 src/include/bits/uart.h                        |  15 --
 src/include/ipxe/errfile.h                     |   1 +
 src/include/ipxe/gdbserial.h                   |   2 +-
 src/include/ipxe/ns16550.h                     | 112 +++++++++++++
 src/include/ipxe/serial.h                      |   2 +-
 src/include/ipxe/uart.h                        | 214 +++++++++++++++----------
 16 files changed, 683 insertions(+), 314 deletions(-)
 create mode 100644 src/arch/x86/include/bits/ns16550.h
 delete mode 100644 src/arch/x86/include/bits/uart.h
 create mode 100644 src/drivers/uart/ns16550.c
 create mode 100644 src/include/bits/ns16550.h
 delete mode 100644 src/include/bits/uart.h
 create mode 100644 src/include/ipxe/ns16550.h

(limited to 'src/core')

diff --git a/src/Makefile b/src/Makefile
index 6367b13ea..f3d378e05 100644
--- a/src/Makefile
+++ b/src/Makefile
@@ -94,6 +94,7 @@ SRCDIRS		+= drivers/infiniband/mlx_utils/mlx_lib/mlx_link_speed
 SRCDIRS		+= drivers/infiniband/mlx_utils/mlx_lib/mlx_mtu
 SRCDIRS		+= drivers/infiniband/mlx_nodnic/src
 SRCDIRS		+= drivers/usb
+SRCDIRS		+= drivers/uart
 SRCDIRS		+= interface/pxe interface/efi interface/smbios
 SRCDIRS		+= interface/bofm
 SRCDIRS		+= interface/xen
diff --git a/src/arch/x86/core/x86_uart.c b/src/arch/x86/core/x86_uart.c
index e455775bf..2580b931b 100644
--- a/src/arch/x86/core/x86_uart.c
+++ b/src/arch/x86/core/x86_uart.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
@@ -29,41 +29,45 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *
  */
 
-#include <errno.h>
-#include <ipxe/uart.h>
+#include <string.h>
+#include <ipxe/serial.h>
+#include <ipxe/ns16550.h>
 
-/** UART port bases */
-static uint16_t uart_base[] = {
-	[COM1] = 0x3f8,
-	[COM2] = 0x2f8,
-	[COM3] = 0x3e8,
-	[COM4] = 0x2e8,
-};
+/** Define a fixed ISA UART */
+#define ISA_UART( NAME, BASE )						\
+	struct ns16550_uart NAME = {					\
+		.uart = {						\
+			.refcnt = REF_INIT ( ref_no_free ),		\
+			.name = #NAME,					\
+			.op = &ns16550_operations,			\
+		},							\
+		.base = ( ( void * ) (BASE) ),				\
+	}
+
+/* Fixed ISA UARTs */
+ISA_UART ( com1, COM1_BASE );
+ISA_UART ( com2, COM2_BASE );
+ISA_UART ( com3, COM3_BASE );
+ISA_UART ( com4, COM4_BASE );
 
 /**
- * Select UART port
+ * Register fixed ISA UARTs
  *
- * @v uart		UART
- * @v port		Port number, or 0 to disable
  * @ret rc		Return status code
  */
-int uart_select ( struct uart *uart, unsigned int port ) {
+int uart_register_fixed ( void ) {
+	static struct uart *ports[] = { COM1, COM2, COM3, COM4 };
+	unsigned int i;
 	int rc;
 
-	/* Set new UART base */
-	if ( port >= ( sizeof ( uart_base ) / sizeof ( uart_base[0] ) ) ) {
-		rc = -ENODEV;
-		goto err;
+	/* Register all fixed ISA UARTs */
+	for ( i = 0 ; i < ( sizeof ( ports ) / sizeof ( ports[0] ) ) ; i++ ) {
+		if ( ( rc = uart_register ( ports[i] ) ) != 0 ) {
+			DBGC ( ports[i], "UART could not register %s: %s\n",
+			       ports[i]->name, strerror ( rc ) );
+			return rc;
+		}
 	}
-	uart->base = ( ( void * ) ( intptr_t ) uart_base[port] );
-
-	/* Check that UART exists */
-	if ( ( rc = uart_exists ( uart ) ) != 0 )
-		goto err;
 
 	return 0;
-
- err:
-	uart->base = NULL;
-	return rc;
 }
diff --git a/src/arch/x86/include/bits/ns16550.h b/src/arch/x86/include/bits/ns16550.h
new file mode 100644
index 000000000..9f7d741ae
--- /dev/null
+++ b/src/arch/x86/include/bits/ns16550.h
@@ -0,0 +1,60 @@
+#ifndef _BITS_NS16550_H
+#define _BITS_NS16550_H
+
+/** @file
+ *
+ * 16550-compatible UART
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <ipxe/io.h>
+
+/**
+ * Write to UART register
+ *
+ * @v ns16550		16550 UART
+ * @v address		Register address
+ * @v data		Data
+ */
+static inline __attribute__ (( always_inline )) void
+ns16550_write ( struct ns16550_uart *ns16550, unsigned int address,
+		uint8_t data ) {
+
+	outb ( data, ( ns16550->base + address ) );
+}
+
+/**
+ * Read from UART register
+ *
+ * @v ns16550		16550 UART
+ * @v address		Register address
+ * @ret data		Data
+ */
+static inline __attribute__ (( always_inline )) uint8_t
+ns16550_read ( struct ns16550_uart *ns16550, unsigned int address ) {
+
+	return inb ( ns16550->base + address );
+}
+
+/* Fixed ISA serial port base addresses */
+#define COM1_BASE 0x3f8
+#define COM2_BASE 0x2f8
+#define COM3_BASE 0x3e8
+#define COM4_BASE 0x2e8
+
+/* Fixed ISA serial ports */
+extern struct ns16550_uart com1;
+extern struct ns16550_uart com2;
+extern struct ns16550_uart com3;
+extern struct ns16550_uart com4;
+
+/* Fixed ISA serial port names */
+#define COM1 &com1.uart
+#define COM2 &com2.uart
+#define COM3 &com3.uart
+#define COM4 &com4.uart
+
+#endif /* _BITS_NS16550_H */
diff --git a/src/arch/x86/include/bits/uart.h b/src/arch/x86/include/bits/uart.h
deleted file mode 100644
index e09cd3f4c..000000000
--- a/src/arch/x86/include/bits/uart.h
+++ /dev/null
@@ -1,41 +0,0 @@
-#ifndef _BITS_UART_H
-#define _BITS_UART_H
-
-/** @file
- *
- * 16550-compatible UART
- *
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#include <stdint.h>
-#include <ipxe/io.h>
-
-/**
- * Write to UART register
- *
- * @v uart		UART
- * @v addr		Register address
- * @v data		Data
- */
-static inline __attribute__ (( always_inline )) void
-uart_write ( struct uart *uart, unsigned int addr, uint8_t data ) {
-	outb ( data, ( uart->base + addr ) );
-}
-
-/**
- * Read from UART register
- *
- * @v uart		UART
- * @v addr		Register address
- * @ret data		Data
- */
-static inline __attribute__ (( always_inline )) uint8_t
-uart_read ( struct uart *uart, unsigned int addr ) {
-	return inb ( uart->base + addr );
-}
-
-extern int uart_select ( struct uart *uart, unsigned int port );
-
-#endif /* _BITS_UART_H */
diff --git a/src/arch/x86/interface/syslinux/comboot_call.c b/src/arch/x86/interface/syslinux/comboot_call.c
index f7cceb30f..97bdaeae3 100644
--- a/src/arch/x86/interface/syslinux/comboot_call.c
+++ b/src/arch/x86/interface/syslinux/comboot_call.c
@@ -37,6 +37,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #include <ipxe/posix_io.h>
 #include <ipxe/process.h>
 #include <ipxe/serial.h>
+#include <ipxe/ns16550.h>
 #include <ipxe/init.h>
 #include <ipxe/image.h>
 #include <ipxe/version.h>
@@ -253,8 +254,8 @@ static __asmcall __used void int21 ( struct i386_all_regs *ix86 ) {
 		break;
 
 	case 0x04: /* Write Character to Serial Port */
-		if ( serial_console.base ) {
-			uart_transmit ( &serial_console, ix86->regs.dl );
+		if ( serial_console ) {
+			uart_transmit ( serial_console, ix86->regs.dl );
 			ix86->flags &= ~CF;
 		}
 		break;
@@ -445,9 +446,13 @@ static __asmcall __used void int22 ( struct i386_all_regs *ix86 ) {
 		break;
 
 	case 0x000B: /* Get Serial Console Configuration */
-		if ( serial_console.base ) {
-			ix86->regs.dx = ( ( intptr_t ) serial_console.base );
-			ix86->regs.cx = serial_console.divisor;
+		if ( serial_console ) {
+			struct ns16550_uart *comport =
+				container_of ( serial_console,
+					       struct ns16550_uart, uart );
+
+			ix86->regs.dx = ( ( intptr_t ) comport->base );
+			ix86->regs.cx = comport->divisor;
 			ix86->regs.bx = 0;
 			ix86->flags &= ~CF;
 		}
@@ -685,4 +690,4 @@ void unhook_comboot_interrupts ( ) {
 }
 
 /* Avoid dragging in serial console support unconditionally */
-struct uart serial_console __attribute__ (( weak ));
+struct uart *serial_console __attribute__ (( weak ));
diff --git a/src/core/gdbserial.c b/src/core/gdbserial.c
index 1edc28109..0f74e5fe0 100644
--- a/src/core/gdbserial.c
+++ b/src/core/gdbserial.c
@@ -25,20 +25,12 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stddef.h>
 #include <stdio.h>
-#include <stdlib.h>
 #include <assert.h>
 #include <ipxe/uart.h>
 #include <ipxe/gdbstub.h>
 #include <ipxe/gdbserial.h>
 #include <config/serial.h>
 
-/* UART port number */
-#ifdef COMCONSOLE
-#define GDBSERIAL_PORT COMCONSOLE
-#else
-#define GDBSERIAL_PORT 0
-#endif
-
 /* UART baud rate */
 #ifdef COMPRESERVE
 #define GDBSERIAL_BAUD 0
@@ -47,37 +39,30 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #endif
 
 /** GDB serial UART */
-static struct uart gdbserial_uart;
+static struct uart *gdbserial_uart;
 
 struct gdb_transport serial_gdb_transport __gdb_transport;
 
 static size_t gdbserial_recv ( char *buf, size_t len ) {
 
 	assert ( len > 0 );
-	while ( ! uart_data_ready ( &gdbserial_uart ) ) {}
-	buf[0] = uart_receive ( &gdbserial_uart );
+	while ( ! uart_data_ready ( gdbserial_uart ) ) {}
+	buf[0] = uart_receive ( gdbserial_uart );
 	return 1;
 }
 
 static void gdbserial_send ( const char *buf, size_t len ) {
 
 	while ( len-- > 0 ) {
-		uart_transmit ( &gdbserial_uart, *buf++ );
+		uart_transmit ( gdbserial_uart, *buf++ );
 	}
 }
 
 static int gdbserial_init ( int argc, char **argv ) {
-	unsigned int port;
-	char *endp;
-
-	if ( argc == 0 ) {
-		port = GDBSERIAL_PORT;
-	} else if ( argc == 1 ) {
-		port = strtoul ( argv[0], &endp, 10 );
-		if ( *endp ) {
-			printf ( "serial: invalid port\n" );
-			return 1;
-		}
+	const char *port;
+
+	if ( argc == 1 ) {
+		port = argv[0];
 	} else {
 		printf ( "serial: syntax <port>\n" );
 		return 1;
@@ -98,14 +83,19 @@ struct gdb_transport serial_gdb_transport __gdb_transport = {
 	.send = gdbserial_send,
 };
 
-struct gdb_transport * gdbserial_configure ( unsigned int port,
+struct gdb_transport * gdbserial_configure ( const char *name,
 					     unsigned int baud ) {
 	int rc;
 
-	if ( ( rc = uart_select ( &gdbserial_uart, port ) ) != 0 )
+	uart_put ( gdbserial_uart );
+	gdbserial_uart = NULL;
+
+	gdbserial_uart = uart_find ( name );
+	if ( ! gdbserial_uart )
 		return NULL;
+	uart_get ( gdbserial_uart );
 
-	if ( ( rc = uart_init ( &gdbserial_uart, baud ) ) != 0 )
+	if ( ( rc = uart_init ( gdbserial_uart, baud ) ) != 0 )
 		return NULL;
 
 	return &serial_gdb_transport;
diff --git a/src/core/serial.c b/src/core/serial.c
index 2866681a8..e718f0d42 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -35,6 +35,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/uart.h>
 #include <ipxe/console.h>
 #include <ipxe/serial.h>
+#include <ipxe/ns16550.h>
 #include <config/console.h>
 #include <config/serial.h>
 
@@ -44,22 +45,21 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_SERIAL ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )
 #endif
 
-/* UART port number */
-#ifdef COMCONSOLE
-#define CONSOLE_PORT COMCONSOLE
-#else
-#define CONSOLE_PORT 0
+/* Serial console UART */
+#ifndef COMCONSOLE
+#define COMCONSOLE NULL
 #endif
 
-/* UART baud rate */
-#ifdef COMPRESERVE
-#define CONSOLE_BAUD 0
-#else
-#define CONSOLE_BAUD COMSPEED
+/* Serial console baud rate */
+#ifndef COMSPEED
+#define COMSPEED 0
 #endif
 
-/** Serial console UART */
-struct uart serial_console;
+/** Default serial console UART */
+static struct uart * const default_serial_console = COMCONSOLE;
+
+/** Active serial console UART */
+struct uart *serial_console;
 
 /**
  * Print a character to serial console
@@ -69,11 +69,11 @@ struct uart serial_console;
 static void serial_putchar ( int character ) {
 
 	/* Do nothing if we have no UART */
-	if ( ! serial_console.base )
+	if ( ! serial_console )
 		return;
 
 	/* Transmit character */
-	uart_transmit ( &serial_console, character );
+	uart_transmit ( serial_console, character );
 }
 
 /**
@@ -85,14 +85,14 @@ static int serial_getchar ( void ) {
 	uint8_t data;
 
 	/* Do nothing if we have no UART */
-	if ( ! serial_console.base )
+	if ( ! serial_console )
 		return 0;
 
 	/* Wait for data to be ready */
-	while ( ! uart_data_ready ( &serial_console ) ) {}
+	while ( ! uart_data_ready ( serial_console ) ) {}
 
 	/* Receive data */
-	data = uart_receive ( &serial_console );
+	data = uart_receive ( serial_console );
 
 	/* Strip any high bit and convert DEL to backspace */
 	data &= 0x7f;
@@ -111,11 +111,11 @@ static int serial_getchar ( void ) {
 static int serial_iskey ( void ) {
 
 	/* Do nothing if we have no UART */
-	if ( ! serial_console.base )
+	if ( ! serial_console )
 		return 0;
 
 	/* Check UART */
-	return uart_data_ready ( &serial_console );
+	return uart_data_ready ( serial_console );
 }
 
 /** Serial console */
@@ -128,25 +128,23 @@ struct console_driver serial_console_driver __console_driver = {
 
 /** Initialise serial console */
 static void serial_init ( void ) {
+	struct uart *uart = default_serial_console;
 	int rc;
 
 	/* Do nothing if we have no default port */
-	if ( ! CONSOLE_PORT )
+	if ( ! uart )
 		return;
 
-	/* Select UART */
-	if ( ( rc = uart_select ( &serial_console, CONSOLE_PORT ) ) != 0 ) {
-		DBG ( "Could not select UART %d: %s\n",
-		      CONSOLE_PORT, strerror ( rc ) );
-		return;
-	}
-
 	/* Initialise UART */
-	if ( ( rc = uart_init ( &serial_console, CONSOLE_BAUD ) ) != 0 ) {
-		DBG ( "Could not initialise UART %d baud %d: %s\n",
-		      CONSOLE_PORT, CONSOLE_BAUD, strerror ( rc ) );
+	if ( ( rc = uart_init ( uart, COMSPEED ) ) != 0 ) {
+		DBGC ( uart, "SERIAL could not initialise %s baud %d: %s\n",
+		       uart->name, COMSPEED, strerror ( rc ) );
 		return;
 	}
+
+	/* Record UART as serial console */
+	serial_console = uart;
+	DBGC ( uart, "SERIAL using %s\n", uart->name );
 }
 
 /**
@@ -157,11 +155,11 @@ static void serial_init ( void ) {
 static void serial_shutdown ( int flags __unused ) {
 
 	/* Do nothing if we have no UART */
-	if ( ! serial_console.base )
+	if ( ! serial_console )
 		return;
 
 	/* Flush any pending output */
-	uart_flush ( &serial_console );
+	uart_flush ( serial_console );
 
 	/* Leave console enabled; it's still usable */
 }
diff --git a/src/core/uart.c b/src/core/uart.c
index 4dc307fce..a645bd398 100644
--- a/src/core/uart.c
+++ b/src/core/uart.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
@@ -25,125 +25,139 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 /** @file
  *
- * 16550-compatible UART
+ * Generic UARTs
  *
  */
 
-#include <unistd.h>
+#include <stdlib.h>
+#include <strings.h>
 #include <errno.h>
 #include <ipxe/uart.h>
 
-/** Timeout for transmit holding register to become empty */
-#define UART_THRE_TIMEOUT_MS 100
+/** List of registered UARTs */
+LIST_HEAD ( uarts );
 
-/** Timeout for transmitter to become empty */
-#define UART_TEMT_TIMEOUT_MS 1000
+static void null_uart_transmit ( struct uart *uart __unused,
+				 uint8_t byte __unused ) {
+}
+
+static int null_uart_data_ready ( struct uart *uart __unused ) {
+	return 0;
+}
+
+static uint8_t null_uart_receive ( struct uart *uart __unused ) {
+	return 0;
+}
+
+static int null_uart_init ( struct uart *uart __unused,
+			    unsigned int baud __unused ) {
+	return 0;
+}
+
+static void null_uart_flush ( struct uart *uart __unused ) {
+}
+
+/** Null UART operations */
+struct uart_operations null_uart_operations = {
+	.transmit = null_uart_transmit,
+	.data_ready = null_uart_data_ready,
+	.receive = null_uart_receive,
+	.init = null_uart_init,
+	.flush = null_uart_flush,
+};
 
 /**
- * Transmit data
+ * Allocate UART
  *
- * @v uart		UART
- * @v data		Data
+ * @v priv_len		Length of private data
+ * @ret uart		UART, or NULL on error
  */
-void uart_transmit ( struct uart *uart, uint8_t data ) {
-	unsigned int i;
-	uint8_t lsr;
-
-	/* Wait for transmitter holding register to become empty */
-	for ( i = 0 ; i < UART_THRE_TIMEOUT_MS ; i++ ) {
-		lsr = uart_read ( uart, UART_LSR );
-		if ( lsr & UART_LSR_THRE )
-			break;
-		mdelay ( 1 );
-	}
+struct uart * alloc_uart ( size_t priv_len ) {
+	struct uart *uart;
+
+	/* Allocate and initialise UART */
+	uart = zalloc ( sizeof ( *uart ) + priv_len );
+	if ( ! uart )
+		return NULL;
+	uart->priv = ( ( ( void * ) uart ) + sizeof ( *uart ) );
 
-	/* Transmit data (even if we timed out) */
-	uart_write ( uart, UART_THR, data );
+	return uart;
 }
 
 /**
- * Flush data
+ * Register fixed UARTs (when not provided by platform)
  *
- * @v uart		UART
+ * @ret rc		Return status code
  */
-void uart_flush ( struct uart *uart ) {
-	unsigned int i;
-	uint8_t lsr;
-
-	/* Wait for transmitter and receiver to become empty */
-	for ( i = 0 ; i < UART_TEMT_TIMEOUT_MS ; i++ ) {
-		uart_read ( uart, UART_RBR );
-		lsr = uart_read ( uart, UART_LSR );
-		if ( ( lsr & UART_LSR_TEMT ) && ! ( lsr & UART_LSR_DR ) )
-			break;
-	}
+__weak int uart_register_fixed ( void ) {
+
+	return 0;
 }
 
 /**
- * Check for existence of UART
+ * Register UART
  *
  * @v uart		UART
  * @ret rc		Return status code
  */
-int uart_exists ( struct uart *uart ) {
-
-	/* Fail if no UART port is defined */
-	if ( ! uart->base )
-		return -ENODEV;
+int uart_register ( struct uart *uart ) {
 
-	/* Fail if UART scratch register seems not to be present */
-	uart_write ( uart, UART_SCR, 0x18 );
-	if ( uart_read ( uart, UART_SCR ) != 0x18 )
-		return -ENODEV;
-	uart_write ( uart, UART_SCR, 0xae );
-	if ( uart_read ( uart, UART_SCR ) != 0xae )
-		return -ENODEV;
+	/* Add to list of registered UARTs */
+	uart_get ( uart );
+	list_add_tail ( &uart->list, &uarts );
+	DBGC ( uart, "UART %s registered\n", uart->name );
 
 	return 0;
 }
 
 /**
- * Initialise UART
+ * Unregister UART
  *
  * @v uart		UART
- * @v baud		Baud rate, or zero to leave unchanged
- * @ret rc		Return status code
  */
-int uart_init ( struct uart *uart, unsigned int baud ) {
-	uint8_t dlm;
-	uint8_t dll;
+void uart_unregister ( struct uart *uart ) {
+
+	/* Remove from list of registered UARTs */
+	list_del ( &uart->list );
+	uart_put ( uart );
+}
+
+/**
+ * Find named UART
+ *
+ * @v name		UART name
+ * @ret uart		UART, or NULL if not found
+ */
+struct uart * uart_find ( const char *name ) {
+	struct uart *uart;
+	unsigned int index;
+	char *endp;
 	int rc;
 
-	/* Check for existence of UART */
-	if ( ( rc = uart_exists ( uart ) ) != 0 )
-		return rc;
-
-	/* Configure divisor and line control register, if applicable */
-	uart_write ( uart, UART_LCR, ( UART_LCR_8N1 | UART_LCR_DLAB ) );
-	if ( baud ) {
-		uart->divisor = ( UART_MAX_BAUD / baud );
-		dlm = ( ( uart->divisor >> 8 ) & 0xff );
-		dll = ( ( uart->divisor >> 0 ) & 0xff );
-		uart_write ( uart, UART_DLM, dlm );
-		uart_write ( uart, UART_DLL, dll );
-	} else {
-		dlm = uart_read ( uart, UART_DLM );
-		dll = uart_read ( uart, UART_DLL );
-		uart->divisor = ( ( dlm << 8 ) | dll );
+	/* Register fixed platform UARTs if not already registered */
+	if ( list_empty ( &uarts ) ) {
+		if ( ( rc = uart_register_fixed() ) != 0 ) {
+			DBGC ( &uarts, "UART could not register fixed UARTs: "
+			       "%s\n", strerror ( rc ) );
+			/* Continue anyway */
+		}
 	}
-	uart_write ( uart, UART_LCR, UART_LCR_8N1 );
 
-	/* Disable interrupts */
-	uart_write ( uart, UART_IER, 0 );
+	/* Try parsing name as a numeric index */
+	index = strtoul ( name, &endp, 10 );
 
-	/* Enable FIFOs */
-	uart_write ( uart, UART_FCR, UART_FCR_FE );
+	/* Find matching UART, if any */
+	list_for_each_entry ( uart, &uarts, list ) {
 
-	/* Assert DTR and RTS */
-	uart_write ( uart, UART_MCR, ( UART_MCR_DTR | UART_MCR_RTS ) );
+		/* Check for a matching name */
+		if ( strcasecmp ( name, uart->name ) == 0 )
+			return uart;
 
-	/* Flush any stale data */
-	uart_flush ( uart );
+		/* Check for a matching numeric index */
+		if ( ( *endp == '\0' ) && ( index-- == 0 ) )
+			return uart;
+	}
 
-	return 0;
+	DBGC ( &uarts, "UART %s not found\n", name );
+	return NULL;
 }
diff --git a/src/drivers/uart/ns16550.c b/src/drivers/uart/ns16550.c
new file mode 100644
index 000000000..58a71261b
--- /dev/null
+++ b/src/drivers/uart/ns16550.c
@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * 16550-compatible UART
+ *
+ */
+
+#include <unistd.h>
+#include <errno.h>
+#include <ipxe/uart.h>
+#include <ipxe/ns16550.h>
+
+/** Timeout for transmit holding register to become empty */
+#define NS16550_THRE_TIMEOUT_MS 100
+
+/** Timeout for transmitter to become empty */
+#define NS16550_TEMT_TIMEOUT_MS 1000
+
+/**
+ * Transmit data
+ *
+ * @v uart		UART
+ * @v data		Data
+ */
+static void ns16550_transmit ( struct uart *uart, uint8_t data ) {
+	struct ns16550_uart *ns16550 =
+		container_of ( uart, struct ns16550_uart, uart );
+	unsigned int i;
+	uint8_t lsr;
+
+	/* Wait for transmitter holding register to become empty */
+	for ( i = 0 ; i < NS16550_THRE_TIMEOUT_MS ; i++ ) {
+		lsr = ns16550_read ( ns16550, NS16550_LSR );
+		if ( lsr & NS16550_LSR_THRE )
+			break;
+		mdelay ( 1 );
+	}
+
+	/* Transmit data (even if we timed out) */
+	ns16550_write ( ns16550, NS16550_THR, data );
+}
+
+/**
+ * Check if data is ready
+ *
+ * @v uart		UART
+ * @ret ready		Data is ready
+ */
+static int ns16550_data_ready ( struct uart *uart ) {
+	struct ns16550_uart *ns16550 =
+		container_of ( uart, struct ns16550_uart, uart );
+	uint8_t lsr;
+
+	/* Check for receive data ready */
+	lsr = ns16550_read ( ns16550, NS16550_LSR );
+	return ( lsr & NS16550_LSR_DR );
+}
+
+/**
+ * Receive data
+ *
+ * @v uart		UART
+ * @ret data		Data
+ */
+static uint8_t ns16550_receive ( struct uart *uart ) {
+	struct ns16550_uart *ns16550 =
+		container_of ( uart, struct ns16550_uart, uart );
+	uint8_t rbr;
+
+	/* Receive byte */
+	rbr = ns16550_read ( ns16550, NS16550_RBR );
+	return rbr;
+}
+
+/**
+ * Flush transmitted data
+ *
+ * @v uart		UART
+ */
+static void ns16550_flush ( struct uart *uart ) {
+	struct ns16550_uart *ns16550 =
+		container_of ( uart, struct ns16550_uart, uart );
+	unsigned int i;
+	uint8_t lsr;
+
+	/* Wait for transmitter to become empty */
+	for ( i = 0 ; i < NS16550_TEMT_TIMEOUT_MS ; i++ ) {
+		lsr = ns16550_read ( ns16550, NS16550_LSR );
+		if ( lsr & NS16550_LSR_TEMT )
+			break;
+	}
+}
+
+/**
+ * Initialise UART
+ *
+ * @v uart		UART
+ * @v baud		Baud rate, or zero to leave unchanged
+ * @ret rc		Return status code
+ */
+static int ns16550_init ( struct uart *uart, unsigned int baud ) {
+	struct ns16550_uart *ns16550 =
+		container_of ( uart, struct ns16550_uart, uart );
+	uint8_t dlm;
+	uint8_t dll;
+
+	/* Fail if UART scratch register seems not to be present */
+	ns16550_write ( ns16550, NS16550_SCR, 0x18 );
+	if ( ns16550_read ( ns16550, NS16550_SCR ) != 0x18 )
+		return -ENODEV;
+	ns16550_write ( ns16550, NS16550_SCR, 0xae );
+	if ( ns16550_read ( ns16550, NS16550_SCR ) != 0xae )
+		return -ENODEV;
+
+	/* Configure divisor and line control register, if applicable */
+	ns16550_write ( ns16550, NS16550_LCR,
+			( NS16550_LCR_8N1 | NS16550_LCR_DLAB ) );
+	if ( baud ) {
+		ns16550->divisor = ( NS16550_MAX_BAUD / baud );
+		dlm = ( ( ns16550->divisor >> 8 ) & 0xff );
+		dll = ( ( ns16550->divisor >> 0 ) & 0xff );
+		ns16550_write ( ns16550, NS16550_DLM, dlm );
+		ns16550_write ( ns16550, NS16550_DLL, dll );
+	} else {
+		dlm = ns16550_read ( ns16550, NS16550_DLM );
+		dll = ns16550_read ( ns16550, NS16550_DLL );
+		ns16550->divisor = ( ( dlm << 8 ) | dll );
+	}
+	ns16550_write ( ns16550, NS16550_LCR, NS16550_LCR_8N1 );
+
+	/* Disable interrupts */
+	ns16550_write ( ns16550, NS16550_IER, 0 );
+
+	/* Enable FIFOs */
+	ns16550_write ( ns16550, NS16550_FCR, NS16550_FCR_FE );
+
+	/* Assert DTR and RTS */
+	ns16550_write ( ns16550, NS16550_MCR,
+			( NS16550_MCR_DTR | NS16550_MCR_RTS ) );
+
+	/* Flush any stale received data */
+	while ( ns16550_data_ready ( uart ) )
+		ns16550_receive ( uart );
+
+	return 0;
+}
+
+/** 16550 UART operations */
+struct uart_operations ns16550_operations = {
+	.transmit = ns16550_transmit,
+	.data_ready = ns16550_data_ready,
+	.receive = ns16550_receive,
+	.init = ns16550_init,
+	.flush = ns16550_flush,
+};
diff --git a/src/include/bits/ns16550.h b/src/include/bits/ns16550.h
new file mode 100644
index 000000000..4b3e30c76
--- /dev/null
+++ b/src/include/bits/ns16550.h
@@ -0,0 +1,15 @@
+#ifndef _BITS_NS16550_H
+#define _BITS_NS16550_H
+
+/** @file
+ *
+ * Dummy architecture-specific 16550-compatible UART
+ *
+ * This file is included only if the architecture does not provide its
+ * own version of this file.
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#endif /* _BITS_NS16550_H */
diff --git a/src/include/bits/uart.h b/src/include/bits/uart.h
deleted file mode 100644
index e132d5c3d..000000000
--- a/src/include/bits/uart.h
+++ /dev/null
@@ -1,15 +0,0 @@
-#ifndef _BITS_UART_H
-#define _BITS_UART_H
-
-/** @file
- *
- * Dummy architecture-specific UART
- *
- * This file is included only if the architecture does not provide its
- * own version of this file.
- *
- */
-
-FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
-
-#endif /* _BITS_UART_H */
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index d00191fbe..1a39af43f 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -109,6 +109,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define ERRFILE_spi_bit		     ( ERRFILE_DRIVER | 0x00130000 )
 #define ERRFILE_nvsvpd		     ( ERRFILE_DRIVER | 0x00140000 )
 #define ERRFILE_uart		     ( ERRFILE_DRIVER | 0x00150000 )
+#define ERRFILE_ns16550		     ( ERRFILE_DRIVER | 0x00160000 )
 
 #define ERRFILE_3c509		     ( ERRFILE_DRIVER | 0x00200000 )
 #define ERRFILE_bnx2		     ( ERRFILE_DRIVER | 0x00210000 )
diff --git a/src/include/ipxe/gdbserial.h b/src/include/ipxe/gdbserial.h
index 166eb4f0d..62cc16014 100644
--- a/src/include/ipxe/gdbserial.h
+++ b/src/include/ipxe/gdbserial.h
@@ -11,7 +11,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 struct gdb_transport;
 
-extern struct gdb_transport * gdbserial_configure ( unsigned int port,
+extern struct gdb_transport * gdbserial_configure ( const char *port,
 						    unsigned int baud );
 
 #endif /* _IPXE_GDBSERIAL_H */
diff --git a/src/include/ipxe/ns16550.h b/src/include/ipxe/ns16550.h
new file mode 100644
index 000000000..f7bb55a84
--- /dev/null
+++ b/src/include/ipxe/ns16550.h
@@ -0,0 +1,112 @@
+#ifndef _IPXE_NS16550_H
+#define _IPXE_NS16550_H
+
+/** @file
+ *
+ * 16550-compatible UART
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/uart.h>
+
+/** Transmitter holding register */
+#define NS16550_THR 0x00
+
+/** Receiver buffer register */
+#define NS16550_RBR 0x00
+
+/** Interrupt enable register */
+#define NS16550_IER 0x01
+
+/** FIFO control register */
+#define NS16550_FCR 0x02
+#define NS16550_FCR_FE	0x01	/**< FIFO enable */
+
+/** Line control register */
+#define NS16550_LCR 0x03
+#define NS16550_LCR_WLS0	0x01	/**< Word length select bit 0 */
+#define NS16550_LCR_WLS1	0x02	/**< Word length select bit 1 */
+#define NS16550_LCR_STB		0x04	/**< Number of stop bits */
+#define NS16550_LCR_PEN		0x08	/**< Parity enable */
+#define NS16550_LCR_EPS		0x10	/**< Even parity select */
+#define NS16550_LCR_DLAB	0x80	/**< Divisor latch access bit */
+
+#define NS16550_LCR_WORD_LEN(x)	( ( (x) - 5 ) << 0 )	/**< Word length */
+#define NS16550_LCR_STOP_BITS(x) ( ( (x) - 1 ) << 2 )	/**< Stop bits */
+#define NS16550_LCR_PARITY(x)	( ( (x) - 0 ) << 3 )	/**< Parity */
+
+/**
+ * Calculate line control register value
+ *
+ * @v word_len		Word length (5-8)
+ * @v parity		Parity (0=none, 1=odd, 3=even)
+ * @v stop_bits		Stop bits (1-2)
+ * @ret lcr		Line control register value
+ */
+#define NS16550_LCR_WPS( word_len, parity, stop_bits )	\
+	( NS16550_LCR_WORD_LEN ( (word_len) ) |		\
+	  NS16550_LCR_PARITY ( (parity) ) |		\
+	  NS16550_LCR_STOP_BITS ( (stop_bits) ) )
+
+/** Default LCR value: 8 data bits, no parity, one stop bit */
+#define NS16550_LCR_8N1 NS16550_LCR_WPS ( 8, 0, 1 )
+
+/** Modem control register */
+#define NS16550_MCR 0x04
+#define NS16550_MCR_DTR		0x01	/**< Data terminal ready */
+#define NS16550_MCR_RTS		0x02	/**< Request to send */
+
+/** Line status register */
+#define NS16550_LSR 0x05
+#define NS16550_LSR_DR 		0x01	/**< Data ready */
+#define NS16550_LSR_THRE	0x20	/**< Transmitter holding reg. empty */
+#define NS16550_LSR_TEMT	0x40	/**< Transmitter empty */
+
+/** Scratch register */
+#define NS16550_SCR 0x07
+
+/** Divisor latch (least significant byte) */
+#define NS16550_DLL 0x00
+
+/** Divisor latch (most significant byte) */
+#define NS16550_DLM 0x01
+
+/** Maximum baud rate */
+#define NS16550_MAX_BAUD 115200
+
+/** A 16550-compatible UART */
+struct ns16550_uart {
+	/** Generic UART */
+	struct uart uart;
+	/** Register base address */
+	void *base;
+	/** Baud rate divisor */
+	uint16_t divisor;
+};
+
+#include <bits/ns16550.h>
+
+/** Dummy COM1 UART for non-x86 platforms
+ *
+ * The architecture-independent config/serial.h header has long
+ * included the line
+ *
+ *   #define COMCONSOLE COM1
+ *
+ * which is meaningless on non-x86 platforms where there is no COM1
+ * port.  Allow COM1 to be treated as equivalent to "no UART" on
+ * non-x86 platforms, to avoid breaking existing build configurations.
+ */
+#ifndef COM1
+#define COM1 NULL
+#endif
+
+void ns16550_write ( struct ns16550_uart *ns16550, unsigned int address,
+		     uint8_t data );
+uint8_t ns16550_read ( struct ns16550_uart *ns16550, unsigned int address );
+
+extern struct uart_operations ns16550_operations;
+
+#endif /* _IPXE_NS16550_H */
diff --git a/src/include/ipxe/serial.h b/src/include/ipxe/serial.h
index 83be59c31..86a618670 100644
--- a/src/include/ipxe/serial.h
+++ b/src/include/ipxe/serial.h
@@ -11,6 +11,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <ipxe/uart.h>
 
-extern struct uart serial_console;
+extern struct uart *serial_console;
 
 #endif /* _IPXE_SERIAL_H */
diff --git a/src/include/ipxe/uart.h b/src/include/ipxe/uart.h
index 86583ee2f..15adfa932 100644
--- a/src/include/ipxe/uart.h
+++ b/src/include/ipxe/uart.h
@@ -3,128 +3,174 @@
 
 /** @file
  *
- * 16550-compatible UART
+ * Generic UART
  *
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <stdint.h>
+#include <ipxe/refcnt.h>
+#include <ipxe/list.h>
 
-/** Transmitter holding register */
-#define UART_THR 0x00
-
-/** Receiver buffer register */
-#define UART_RBR 0x00
-
-/** Interrupt enable register */
-#define UART_IER 0x01
+/** A generic UART */
+struct uart {
+	/** Reference count */
+	struct refcnt refcnt;
+	/** Name */
+	const char *name;
+	/** List of registered UARTs */
+	struct list_head list;
+
+	/** UART operations */
+	struct uart_operations *op;
+	/** Driver-private data */
+	void *priv;
+};
 
-/** FIFO control register */
-#define UART_FCR 0x02
-#define UART_FCR_FE	0x01	/**< FIFO enable */
+/** UART operations */
+struct uart_operations {
+	/**
+	 * Transmit byte
+	 *
+	 * @v uart		UART
+	 * @v byte		Byte to transmit
+	 * @ret rc		Return status code
+	 */
+	void ( * transmit ) ( struct uart *uart, uint8_t byte );
+	/**
+	 * Check if data is ready
+	 *
+	 * @v uart		UART
+	 * @ret ready		Data is ready
+	 */
+	int ( * data_ready ) ( struct uart *uart );
+	/**
+	 * Receive byte
+	 *
+	 * @v uart		UART
+	 * @ret byte		Received byte
+	 */
+	uint8_t ( * receive ) ( struct uart *uart );
+	/**
+	 * Initialise UART
+	 *
+	 * @v uart		UART
+	 * @v baud		Baud rate, or zero to leave unchanged
+	 * @ret rc		Return status code
+	 */
+	int ( * init ) ( struct uart *uart, unsigned int baud );
+	/**
+	 * Flush transmitted data
+	 *
+	 * @v uart		UART
+	 */
+	void ( * flush ) ( struct uart *uart );
+};
 
-/** Line control register */
-#define UART_LCR 0x03
-#define UART_LCR_WLS0	0x01	/**< Word length select bit 0 */
-#define UART_LCR_WLS1	0x02	/**< Word length select bit 1 */
-#define UART_LCR_STB	0x04	/**< Number of stop bits */
-#define UART_LCR_PEN	0x08	/**< Parity enable */
-#define UART_LCR_EPS	0x10	/**< Even parity select */
-#define UART_LCR_DLAB	0x80	/**< Divisor latch access bit */
+/**
+ * Transmit byte
+ *
+ * @v uart		UART
+ * @v byte		Byte to transmit
+ * @ret rc		Return status code
+ */
+static inline __attribute__ (( always_inline )) void
+uart_transmit ( struct uart *uart, uint8_t byte ) {
 
-#define UART_LCR_WORD_LEN(x)	( ( (x) - 5 ) << 0 )	/**< Word length */
-#define UART_LCR_STOP_BITS(x)	( ( (x) - 1 ) << 2 )	/**< Stop bits */
-#define UART_LCR_PARITY(x)	( ( (x) - 0 ) << 3 )	/**< Parity */
+	uart->op->transmit ( uart, byte );
+}
 
 /**
- * Calculate line control register value
+ * Check if data is ready
  *
- * @v word_len		Word length (5-8)
- * @v parity		Parity (0=none, 1=odd, 3=even)
- * @v stop_bits		Stop bits (1-2)
- * @ret lcr		Line control register value
+ * @v uart		UART
+ * @ret ready		Data is ready
  */
-#define UART_LCR_WPS( word_len, parity, stop_bits )	\
-	( UART_LCR_WORD_LEN ( (word_len) ) |		\
-	  UART_LCR_PARITY ( (parity) ) |		\
-	  UART_LCR_STOP_BITS ( (stop_bits) ) )
-
-/** Default LCR value: 8 data bits, no parity, one stop bit */
-#define UART_LCR_8N1 UART_LCR_WPS ( 8, 0, 1 )
+static inline __attribute__ (( always_inline )) int
+uart_data_ready ( struct uart *uart ) {
 
-/** Modem control register */
-#define UART_MCR 0x04
-#define UART_MCR_DTR	0x01	/**< Data terminal ready */
-#define UART_MCR_RTS	0x02	/**< Request to send */
+	return uart->op->data_ready ( uart );
+}
 
-/** Line status register */
-#define UART_LSR 0x05
-#define UART_LSR_DR	0x01	/**< Data ready */
-#define UART_LSR_THRE	0x20	/**< Transmitter holding register empty */
-#define UART_LSR_TEMT	0x40	/**< Transmitter empty */
+/**
+ * Receive byte
+ *
+ * @v uart		UART
+ * @ret byte		Received byte
+ */
+static inline __attribute__ (( always_inline )) uint8_t
+uart_receive ( struct uart *uart ) {
 
-/** Scratch register */
-#define UART_SCR 0x07
+	return uart->op->receive ( uart );
+}
 
-/** Divisor latch (least significant byte) */
-#define UART_DLL 0x00
+/**
+ * Initialise UART
+ *
+ * @v uart		UART
+ * @v baud		Baud rate, or zero to leave unchanged
+ * @ret rc		Return status code
+ */
+static inline __attribute__ (( always_inline )) int
+uart_init ( struct uart *uart, unsigned int baud ) {
 
-/** Divisor latch (most significant byte) */
-#define UART_DLM 0x01
+	return uart->op->init ( uart, baud );
+}
 
-/** Maximum baud rate */
-#define UART_MAX_BAUD 115200
+/**
+ * Flush transmitted data
+ *
+ * @v uart		UART
+ */
+static inline __attribute__ (( always_inline )) void
+uart_flush ( struct uart *uart ) {
 
-/** A 16550-compatible UART */
-struct uart {
-	/** I/O port base address */
-	void *base;
-	/** Baud rate divisor */
-	uint16_t divisor;
-};
+	uart->op->flush ( uart );
+}
 
-/** Symbolic names for port indexes */
-enum uart_port {
-	COM1 = 1,
-	COM2 = 2,
-	COM3 = 3,
-	COM4 = 4,
-};
+extern struct list_head uarts;
+extern struct uart_operations null_uart_operations;
 
-#include <bits/uart.h>
+/**
+ * Get reference to UART
+ *
+ * @v uart		UART
+ * @ret uart		UART
+ */
+static inline __attribute__ (( always_inline )) struct uart *
+uart_get ( struct uart *uart ) {
 
-void uart_write ( struct uart *uart, unsigned int addr, uint8_t data );
-uint8_t uart_read ( struct uart *uart, unsigned int addr );
-int uart_select ( struct uart *uart, unsigned int port );
+	ref_get ( &uart->refcnt );
+	return uart;
+}
 
 /**
- * Check if received data is ready
+ * Drop reference to UART
  *
  * @v uart		UART
- * @ret ready		Data is ready
  */
-static inline int uart_data_ready ( struct uart *uart ) {
-	uint8_t lsr;
+static inline __attribute__ (( always_inline )) void
+uart_put ( struct uart *uart ) {
 
-	lsr = uart_read ( uart, UART_LSR );
-	return ( lsr & UART_LSR_DR );
+	ref_put ( &uart->refcnt );
 }
 
 /**
- * Receive data
+ * Nullify UART
  *
  * @v uart		UART
- * @ret data		Data
  */
-static inline uint8_t uart_receive ( struct uart *uart ) {
+static inline __attribute__ (( always_inline )) void
+uart_nullify ( struct uart *uart ) {
 
-	return uart_read ( uart, UART_RBR );
+	uart->op = &null_uart_operations;
 }
 
-extern void uart_transmit ( struct uart *uart, uint8_t data );
-extern void uart_flush ( struct uart *uart );
-extern int uart_exists ( struct uart *uart );
-extern int uart_init ( struct uart *uart, unsigned int baud );
+extern struct uart * alloc_uart ( size_t priv_len );
+extern int uart_register ( struct uart *uart );
+extern int uart_register_fixed ( void );
+extern void uart_unregister ( struct uart *uart );
+extern struct uart * uart_find ( const char *name );
 
 #endif /* _IPXE_UART_H */
-- 
cgit v1.2.3-55-g7522


From 2ce1b185b239b220cc6c1847f7014df83b1a8862 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 23 Jun 2025 16:19:07 +0100
Subject: [serial] Allow platform to specify mechanism for identifying console

Allow the platform configuration to provide a mechanism for
identifying the serial console UART.  Provide two globally available
mechanisms: "null" (i.e. no serial console), and "fixed" (i.e. use
whatever is specified by COMCONSOLE in config/serial.h).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/config/defaults/efi.h    |  1 +
 src/config/defaults/linux.h  |  1 +
 src/config/defaults/pcbios.h |  1 +
 src/config/defaults/sbi.h    |  1 +
 src/config/serial.h          |  2 ++
 src/core/serial.c            | 27 ++++++++++++++++++----
 src/include/ipxe/serial.h    | 54 ++++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 82 insertions(+), 5 deletions(-)

(limited to 'src/core')

diff --git a/src/config/defaults/efi.h b/src/config/defaults/efi.h
index ada08973e..ed7d37f26 100644
--- a/src/config/defaults/efi.h
+++ b/src/config/defaults/efi.h
@@ -28,6 +28,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define FDT_EFI
 #define MPAPI_EFI
 #define NAP_EFI
+#define SERIAL_FIXED
 
 #define	NET_PROTO_IPV6		/* IPv6 protocol */
 #define	NET_PROTO_LLDP		/* Link Layer Discovery protocol */
diff --git a/src/config/defaults/linux.h b/src/config/defaults/linux.h
index bb14fd9a7..4fb9ad6f3 100644
--- a/src/config/defaults/linux.h
+++ b/src/config/defaults/linux.h
@@ -24,6 +24,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #define DMAAPI_FLAT
 #define ACPI_LINUX
 #define MPAPI_NULL
+#define SERIAL_NULL
 
 #define DRIVERS_LINUX
 
diff --git a/src/config/defaults/pcbios.h b/src/config/defaults/pcbios.h
index 4ccc2b0da..9be9ff834 100644
--- a/src/config/defaults/pcbios.h
+++ b/src/config/defaults/pcbios.h
@@ -26,6 +26,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define REBOOT_PCBIOS
 #define ACPI_RSDP
 #define MPAPI_PCBIOS
+#define SERIAL_FIXED
 
 #ifdef __x86_64__
 #define IOMAP_PAGES
diff --git a/src/config/defaults/sbi.h b/src/config/defaults/sbi.h
index 5dfeaf951..9505e25b4 100644
--- a/src/config/defaults/sbi.h
+++ b/src/config/defaults/sbi.h
@@ -25,6 +25,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define REBOOT_SBI
 #define UMALLOC_UHEAP
 #define MEMMAP_FDT
+#define SERIAL_NULL
 
 #define ACPI_NULL
 #define MPAPI_NULL
diff --git a/src/config/serial.h b/src/config/serial.h
index 69d8d8ef3..6dc051df4 100644
--- a/src/config/serial.h
+++ b/src/config/serial.h
@@ -13,6 +13,8 @@
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
+#include <config/defaults.h>
+
 #define	COMCONSOLE	COM1		/* I/O port address */
 
 /* Keep settings from a previous user of the serial port (e.g. lilo or
diff --git a/src/core/serial.c b/src/core/serial.c
index e718f0d42..4b569ffad 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -45,6 +45,12 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define CONSOLE_SERIAL ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )
 #endif
 
+#ifdef SERIAL_FIXED
+#define SERIAL_PREFIX_fixed
+#else
+#define SERIAL_PREFIX_fixed __fixed_
+#endif
+
 /* Serial console UART */
 #ifndef COMCONSOLE
 #define COMCONSOLE NULL
@@ -55,12 +61,19 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define COMSPEED 0
 #endif
 
-/** Default serial console UART */
-static struct uart * const default_serial_console = COMCONSOLE;
-
 /** Active serial console UART */
 struct uart *serial_console;
 
+/**
+ * Get fixed serial console UART
+ *
+ * @ret uart		Serial console UART, or NULL
+ */
+static struct uart * serial_comconsole ( void ) {
+
+	return COMCONSOLE;
+}
+
 /**
  * Print a character to serial console
  *
@@ -128,10 +141,11 @@ struct console_driver serial_console_driver __console_driver = {
 
 /** Initialise serial console */
 static void serial_init ( void ) {
-	struct uart *uart = default_serial_console;
+	struct uart *uart;
 	int rc;
 
-	/* Do nothing if we have no default port */
+	/* Get default serial console, if any */
+	uart = default_serial_console();
 	if ( ! uart )
 		return;
 
@@ -174,3 +188,6 @@ struct startup_fn serial_startup_fn __startup_fn ( STARTUP_EARLY ) = {
 	.name = "serial",
 	.shutdown = serial_shutdown,
 };
+
+PROVIDE_SERIAL_INLINE ( null, default_serial_console );
+PROVIDE_SERIAL ( fixed, default_serial_console, serial_comconsole );
diff --git a/src/include/ipxe/serial.h b/src/include/ipxe/serial.h
index 86a618670..1eb58bbb8 100644
--- a/src/include/ipxe/serial.h
+++ b/src/include/ipxe/serial.h
@@ -9,7 +9,61 @@
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
+#include <ipxe/api.h>
 #include <ipxe/uart.h>
+#include <config/serial.h>
+
+#ifdef SERIAL_NULL
+#define SERIAL_PREFIX_null
+#else
+#define SERIAL_PREFIX_null __null_
+#endif
+
+/**
+ * Calculate static inline serial API function name
+ *
+ * @v _prefix		Subsystem prefix
+ * @v _api_func		API function
+ * @ret _subsys_func	Subsystem API function
+ */
+#define SERIAL_INLINE( _subsys, _api_func ) \
+	SINGLE_API_INLINE ( SERIAL_PREFIX_ ## _subsys, _api_func )
+
+/**
+ * Provide a serial API implementation
+ *
+ * @v _prefix		Subsystem prefix
+ * @v _api_func		API function
+ * @v _func		Implementing function
+ */
+#define PROVIDE_SERIAL( _subsys, _api_func, _func ) \
+	PROVIDE_SINGLE_API ( SERIAL_PREFIX_ ## _subsys, _api_func, _func )
+
+/**
+ * Provide a static inline serial API implementation
+ *
+ * @v _prefix		Subsystem prefix
+ * @v _api_func		API function
+ */
+#define PROVIDE_SERIAL_INLINE( _subsys, _api_func ) \
+	PROVIDE_SINGLE_API_INLINE ( SERIAL_PREFIX_ ## _subsys, _api_func )
+
+/**
+ * Get null serial console UART
+ *
+ * @ret uart		Serial console UART, or NULL
+ */
+static inline __always_inline struct uart *
+SERIAL_INLINE ( null, default_serial_console ) ( void ) {
+	return NULL;
+}
+
+/**
+ * Get serial console UART
+ *
+ * @ret uart		Serial console UART, or NULL
+ */
+struct uart * default_serial_console ( void );
 
 extern struct uart *serial_console;
 
-- 
cgit v1.2.3-55-g7522


From c33ff76d8d8112aae1501c21c4906ae17662459e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 23 Jun 2025 16:25:19 +0100
Subject: [fdtcon] Add basic support for FDT-based system serial console

Add support for probing a device based on the path or alias found in
the "/chosen/stdout-path" node, and using a consequently instantiated
UART as the default serial console.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/config/defaults/sbi.h |   3 +-
 src/core/fdtcon.c         | 108 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 110 insertions(+), 1 deletion(-)
 create mode 100644 src/core/fdtcon.c

(limited to 'src/core')

diff --git a/src/config/defaults/sbi.h b/src/config/defaults/sbi.h
index 9505e25b4..cf6774090 100644
--- a/src/config/defaults/sbi.h
+++ b/src/config/defaults/sbi.h
@@ -22,10 +22,11 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #endif
 
 #define CONSOLE_SBI
+#define CONSOLE_SERIAL
 #define REBOOT_SBI
 #define UMALLOC_UHEAP
 #define MEMMAP_FDT
-#define SERIAL_NULL
+#define SERIAL_FDT
 
 #define ACPI_NULL
 #define MPAPI_NULL
diff --git a/src/core/fdtcon.c b/src/core/fdtcon.c
new file mode 100644
index 000000000..3dc71af6d
--- /dev/null
+++ b/src/core/fdtcon.c
@@ -0,0 +1,108 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <string.h>
+#include <ipxe/serial.h>
+#include <ipxe/devtree.h>
+#include <ipxe/fdt.h>
+
+/** @file
+ *
+ * Flattened Device Tree serial console
+ *
+ */
+
+#ifdef SERIAL_FDT
+#define SERIAL_PREFIX_fdt
+#else
+#define SERIAL_PREFIX_fdt __fdt_
+#endif
+
+/** FDT console parent device */
+static struct device fdtcon_parent = {
+	.name = "fdtcon",
+	.siblings = LIST_HEAD_INIT ( fdtcon_parent.siblings ),
+	.children = LIST_HEAD_INIT ( fdtcon_parent.children ),
+};
+
+/** Colour for debug messages */
+#define colour &fdtcon_parent
+
+/**
+ * Identify default serial console
+ *
+ * @ret uart		Default serial console UART, or NULL
+ */
+static struct uart * fdtcon_default ( void ) {
+	unsigned int chosen;
+	unsigned int stdout;
+	const char *path;
+	struct uart *prev;
+	struct uart *uart;
+	int rc;
+
+	/* Record existing UART, if any */
+	prev = list_last_entry ( &uarts, struct uart, list );
+
+	/* Locate "/chosen" node */
+	if ( ( rc = fdt_path ( &sysfdt, "/chosen", &chosen ) ) != 0 ) {
+		DBGC ( colour, "FDTCON could not locate \"/chosen\": %s\n",
+		       strerror ( rc ) );
+		return NULL;
+	}
+
+	/* Get console device path (or alias) */
+	path = fdt_string ( &sysfdt, chosen, "stdout-path" );
+	if ( ! path ) {
+		DBGC ( colour, "FDTCON has no console device\n" );
+		return NULL;
+	}
+	DBGC ( colour, "FDTCON console device is \"%s\"\n", path );
+
+	/* Locate device */
+	if ( ( ( rc = fdt_path ( &sysfdt, path, &stdout ) ) != 0 ) &&
+	     ( ( rc = fdt_alias ( &sysfdt, path, &stdout ) ) != 0 ) ) {
+		DBGC ( colour, "FDTCON could not locate \"/%s\": %s\n",
+		       path, strerror ( rc ) );
+		return NULL;
+	}
+
+	/* Probe device */
+	if ( ( rc = dt_probe_node ( &fdtcon_parent, stdout ) ) != 0 ) {
+		DBGC ( colour, "FDTCON could not probe \"%s\": %s\n",
+		       path, strerror ( rc ) );
+		return NULL;
+	}
+
+	/* Use newly added UART, if any */
+	uart = list_last_entry ( &uarts, struct uart, list );
+	if ( uart == prev )
+		return NULL;
+
+	DBGC ( colour, "FDTCON using UART %s\n", uart->name );
+	return uart;
+}
+
+PROVIDE_SERIAL ( fdt, default_serial_console, fdtcon_default );
-- 
cgit v1.2.3-55-g7522


From 19f1407ad90d39d3bab9293bf2849afc42dd2e9d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 7 Jul 2025 13:21:24 +0100
Subject: [iobuf] Ensure I/O buffer data sits within unshared cachelines

On platforms where DMA devices are not in the same coherency domain as
the CPU cache, we must ensure that DMA I/O buffers do not share
cachelines with other data.

Align the start and end of I/O buffers to IOB_ZLEN, which is larger
than any cacheline size we expect to encounter.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/iobuf.c         | 38 +++++++++++++++++++-------------------
 src/include/ipxe/iobuf.h |  6 +++++-
 src/tests/iobuf_test.c   |  8 +++++++-
 3 files changed, 31 insertions(+), 21 deletions(-)

(limited to 'src/core')

diff --git a/src/core/iobuf.c b/src/core/iobuf.c
index 9f8a263d2..78fa23924 100644
--- a/src/core/iobuf.c
+++ b/src/core/iobuf.c
@@ -47,22 +47,26 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 struct io_buffer * alloc_iob_raw ( size_t len, size_t align, size_t offset ) {
 	struct io_buffer *iobuf;
+	size_t headroom;
+	size_t tailroom;
 	size_t padding;
 	size_t threshold;
 	unsigned int align_log2;
 	void *data;
 
-	/* Calculate padding required below alignment boundary to
-	 * ensure that a correctly aligned inline struct io_buffer
-	 * could fit (regardless of the requested offset).
+	/* Round up requested alignment and calculate initial headroom
+	 * and tailroom to ensure that no cachelines are shared
+	 * between I/O buffer data and other data structures.
 	 */
-	padding = ( sizeof ( *iobuf ) + __alignof__ ( *iobuf ) - 1 );
-
-	/* Round up requested alignment to at least the size of the
-	 * padding, to simplify subsequent calculations.
-	 */
-	if ( align < padding )
-		align = padding;
+	if ( align < IOB_ZLEN )
+		align = IOB_ZLEN;
+	headroom = ( offset & ( IOB_ZLEN - 1 ) );
+	tailroom = ( ( - len - offset ) & ( IOB_ZLEN - 1 ) );
+	padding = ( headroom + tailroom );
+	offset -= headroom;
+	len += padding;
+	if ( len < padding )
+		return NULL;
 
 	/* Round up alignment to the nearest power of two, avoiding
 	 * a potentially undefined shift operation.
@@ -73,8 +77,8 @@ struct io_buffer * alloc_iob_raw ( size_t len, size_t align, size_t offset ) {
 	align = ( 1UL << align_log2 );
 
 	/* Calculate length threshold */
-	assert ( align >= padding );
-	threshold = ( align - padding );
+	assert ( align >= sizeof ( *iobuf ) );
+	threshold = ( align - sizeof ( *iobuf ) );
 
 	/* Allocate buffer plus an inline descriptor as a single unit,
 	 * unless doing so would push the total size over the
@@ -82,11 +86,6 @@ struct io_buffer * alloc_iob_raw ( size_t len, size_t align, size_t offset ) {
 	 */
 	if ( len <= threshold ) {
 
-		/* Round up buffer length to ensure that struct
-		 * io_buffer is aligned.
-		 */
-		len += ( ( - len - offset ) & ( __alignof__ ( *iobuf ) - 1 ) );
-
 		/* Allocate memory for buffer plus descriptor */
 		data = malloc_phys_offset ( len + sizeof ( *iobuf ), align,
 					    offset );
@@ -111,7 +110,8 @@ struct io_buffer * alloc_iob_raw ( size_t len, size_t align, size_t offset ) {
 
 	/* Populate descriptor */
 	memset ( &iobuf->map, 0, sizeof ( iobuf->map ) );
-	iobuf->head = iobuf->data = iobuf->tail = data;
+	iobuf->head = data;
+	iobuf->data = iobuf->tail = ( data + headroom );
 	iobuf->end = ( data + len );
 
 	return iobuf;
@@ -266,7 +266,7 @@ struct io_buffer * iob_concatenate ( struct list_head *list ) {
 		len += iob_len ( iobuf );
 
 	/* Allocate new I/O buffer */
-	concatenated = alloc_iob_raw ( len, __alignof__ ( *iobuf ), 0 );
+	concatenated = alloc_iob_raw ( len, IOB_ZLEN, 0 );
 	if ( ! concatenated )
 		return NULL;
 
diff --git a/src/include/ipxe/iobuf.h b/src/include/ipxe/iobuf.h
index 3e079c064..2bdca6b5d 100644
--- a/src/include/ipxe/iobuf.h
+++ b/src/include/ipxe/iobuf.h
@@ -15,11 +15,15 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/dma.h>
 
 /**
- * Minimum I/O buffer length
+ * Minimum I/O buffer length and alignment
  *
  * alloc_iob() will round up the allocated length to this size if
  * necessary.  This is used on behalf of hardware that is not capable
  * of auto-padding.
+ *
+ * This length must be at least as large as the largest cacheline size
+ * that we expect to encounter, to allow for platforms where DMA
+ * devices are not in the same coherency domain as the CPU cache.
  */
 #define IOB_ZLEN 128
 
diff --git a/src/tests/iobuf_test.c b/src/tests/iobuf_test.c
index a417c2e8c..27fbccf0d 100644
--- a/src/tests/iobuf_test.c
+++ b/src/tests/iobuf_test.c
@@ -62,7 +62,7 @@ static inline void alloc_iob_okx ( size_t len, size_t align, size_t offset,
 	       "offset %#zx\n", iobuf, virt_to_phys ( iobuf->data ),
 	       iob_tailroom ( iobuf ), len, align, offset );
 
-	/* Validate requested length and alignment */
+	/* Validate requested length and data alignment */
 	okx ( ( ( ( intptr_t ) iobuf ) & ( __alignof__ ( *iobuf ) - 1 ) ) == 0,
 		file, line );
 	okx ( iob_tailroom ( iobuf ) >= len, file, line );
@@ -70,6 +70,12 @@ static inline void alloc_iob_okx ( size_t len, size_t align, size_t offset,
 		( ( virt_to_phys ( iobuf->data ) & ( align - 1 ) ) ==
 		  ( offset & ( align - 1 ) ) ) ), file, line );
 
+	/* Validate overall buffer alignment */
+	okx ( ( ( ( intptr_t ) iobuf->head ) & ( IOB_ZLEN - 1 ) ) == 0,
+	      file, line );
+	okx ( ( ( ( intptr_t ) iobuf->end ) & ( IOB_ZLEN - 1 ) ) == 0,
+	      file, line );
+
 	/* Overwrite entire content of I/O buffer (for Valgrind) */
 	memset ( iob_put ( iobuf, len ), 0x55, len );
 
-- 
cgit v1.2.3-55-g7522


From 22de0c4edf2fe1cdbca5e22c52c86a2289d04816 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 8 Jul 2025 12:38:05 +0100
Subject: [dma] Use virtual addresses for dma_map()

Cache management operations must generally be performed on virtual
addresses rather than physical addresses.

Change the address parameter in dma_map() to be a virtual address, and
make dma() the API-level primitive instead of dma_phys().

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/dma.c              |  6 +++---
 src/drivers/net/intelxl.c   |  4 ++--
 src/include/ipxe/dma.h      | 42 +++++++++++++-----------------------------
 src/include/ipxe/iobuf.h    |  3 +--
 src/interface/efi/efi_pci.c | 19 ++++++++++---------
 5 files changed, 29 insertions(+), 45 deletions(-)

(limited to 'src/core')

diff --git a/src/core/dma.c b/src/core/dma.c
index cf4b20379..cbc9b8d10 100644
--- a/src/core/dma.c
+++ b/src/core/dma.c
@@ -47,7 +47,7 @@ PROVIDE_DMAAPI_INLINE ( flat, dma_free );
 PROVIDE_DMAAPI_INLINE ( flat, dma_umalloc );
 PROVIDE_DMAAPI_INLINE ( flat, dma_ufree );
 PROVIDE_DMAAPI_INLINE ( flat, dma_set_mask );
-PROVIDE_DMAAPI_INLINE ( flat, dma_phys );
+PROVIDE_DMAAPI_INLINE ( flat, dma );
 
 /******************************************************************************
  *
@@ -67,7 +67,7 @@ PROVIDE_DMAAPI_INLINE ( flat, dma_phys );
  * @ret rc		Return status code
  */
 static int dma_op_map ( struct dma_device *dma, struct dma_mapping *map,
-			physaddr_t addr, size_t len, int flags ) {
+			void *addr, size_t len, int flags ) {
 	struct dma_operations *op = dma->op;
 
 	if ( ! op )
@@ -175,4 +175,4 @@ PROVIDE_DMAAPI ( op, dma_free, dma_op_free );
 PROVIDE_DMAAPI ( op, dma_umalloc, dma_op_umalloc );
 PROVIDE_DMAAPI ( op, dma_ufree, dma_op_ufree );
 PROVIDE_DMAAPI ( op, dma_set_mask, dma_op_set_mask );
-PROVIDE_DMAAPI_INLINE ( op, dma_phys );
+PROVIDE_DMAAPI_INLINE ( op, dma );
diff --git a/src/drivers/net/intelxl.c b/src/drivers/net/intelxl.c
index 82b07833c..1d4c22a09 100644
--- a/src/drivers/net/intelxl.c
+++ b/src/drivers/net/intelxl.c
@@ -65,8 +65,8 @@ int intelxl_msix_enable ( struct intelxl_nic *intelxl,
 
 	/* Map dummy target location */
 	if ( ( rc = dma_map ( intelxl->dma, &intelxl->msix.map,
-			      virt_to_phys ( &intelxl->msix.msg ),
-			      sizeof ( intelxl->msix.msg ), DMA_RX ) ) != 0 ) {
+			      &intelxl->msix.msg, sizeof ( intelxl->msix.msg ),
+			      DMA_RX ) ) != 0 ) {
 		DBGC ( intelxl, "INTELXL %p could not map MSI-X target: %s\n",
 		       intelxl, strerror ( rc ) );
 		goto err_map;
diff --git a/src/include/ipxe/dma.h b/src/include/ipxe/dma.h
index 6e5c43289..d450ef523 100644
--- a/src/include/ipxe/dma.h
+++ b/src/include/ipxe/dma.h
@@ -68,7 +68,7 @@ struct dma_operations {
 	 * @ret rc		Return status code
 	 */
 	int ( * map ) ( struct dma_device *dma, struct dma_mapping *map,
-			physaddr_t addr, size_t len, int flags );
+			void *addr, size_t len, int flags );
 	/**
 	 * Unmap buffer
 	 *
@@ -178,8 +178,7 @@ struct dma_operations {
  */
 static inline __always_inline int
 DMAAPI_INLINE ( flat, dma_map ) ( struct dma_device *dma,
-				  struct dma_mapping *map,
-				  physaddr_t addr __unused,
+				  struct dma_mapping *map, void *addr __unused,
 				  size_t len __unused, int flags __unused ) {
 
 	/* Increment mapping count (for debugging) */
@@ -319,32 +318,31 @@ DMAAPI_INLINE ( flat, dma_set_mask ) ( struct dma_device *dma __unused,
 }
 
 /**
- * Get DMA address from physical address
+ * Get DMA address from virtual address
  *
  * @v map		DMA mapping
- * @v addr		Physical address within the mapped region
+ * @v addr		Address within the mapped region
  * @ret addr		Device-side DMA address
  */
 static inline __always_inline physaddr_t
-DMAAPI_INLINE ( flat, dma_phys ) ( struct dma_mapping *map __unused,
-				   physaddr_t addr ) {
+DMAAPI_INLINE ( flat, dma ) ( struct dma_mapping *map __unused, void *addr ) {
 
 	/* Use physical address as device address */
-	return addr;
+	return virt_to_phys ( addr );
 }
 
 /**
- * Get DMA address from physical address
+ * Get DMA address from virtual address
  *
  * @v map		DMA mapping
- * @v addr		Physical address within the mapped region
+ * @v addr		Address within the mapped region
  * @ret addr		Device-side DMA address
  */
 static inline __always_inline physaddr_t
-DMAAPI_INLINE ( op, dma_phys ) ( struct dma_mapping *map, physaddr_t addr ) {
+DMAAPI_INLINE ( op, dma ) ( struct dma_mapping *map, void *addr ) {
 
 	/* Adjust physical address using mapping offset */
-	return ( addr + map->offset );
+	return ( virt_to_phys ( addr ) + map->offset );
 }
 
 /**
@@ -358,7 +356,7 @@ DMAAPI_INLINE ( op, dma_phys ) ( struct dma_mapping *map, physaddr_t addr ) {
  * @ret rc		Return status code
  */
 int dma_map ( struct dma_device *dma, struct dma_mapping *map,
-	      physaddr_t addr, size_t len, int flags );
+	      void *addr, size_t len, int flags );
 
 /**
  * Unmap buffer
@@ -417,28 +415,14 @@ void dma_ufree ( struct dma_mapping *map, void *addr, size_t len );
  */
 void dma_set_mask ( struct dma_device *dma, physaddr_t mask );
 
-/**
- * Get DMA address from physical address
- *
- * @v map		DMA mapping
- * @v addr		Physical address within the mapped region
- * @ret addr		Device-side DMA address
- */
-physaddr_t dma_phys ( struct dma_mapping *map, physaddr_t addr );
-
 /**
  * Get DMA address from virtual address
  *
  * @v map		DMA mapping
- * @v addr		Virtual address within the mapped region
+ * @v addr		Address within the mapped region
  * @ret addr		Device-side DMA address
  */
-static inline __always_inline physaddr_t dma ( struct dma_mapping *map,
-					       void *addr ) {
-
-	/* Get DMA address from corresponding physical address */
-	return dma_phys ( map, virt_to_phys ( addr ) );
-}
+physaddr_t dma ( struct dma_mapping *map, void *addr );
 
 /**
  * Check if DMA unmapping is required
diff --git a/src/include/ipxe/iobuf.h b/src/include/ipxe/iobuf.h
index 2bdca6b5d..df8d0b854 100644
--- a/src/include/ipxe/iobuf.h
+++ b/src/include/ipxe/iobuf.h
@@ -230,8 +230,7 @@ static inline void iob_populate ( struct io_buffer *iobuf,
 static inline __always_inline int iob_map ( struct io_buffer *iobuf,
 					    struct dma_device *dma,
 					    size_t len, int flags ) {
-	return dma_map ( dma, &iobuf->map, virt_to_phys ( iobuf->data ),
-			 len, flags );
+	return dma_map ( dma, &iobuf->map, iobuf->data, len, flags );
 }
 
 /**
diff --git a/src/interface/efi/efi_pci.c b/src/interface/efi/efi_pci.c
index 1b1f05816..ae0ec4264 100644
--- a/src/interface/efi/efi_pci.c
+++ b/src/interface/efi/efi_pci.c
@@ -455,7 +455,7 @@ PROVIDE_PCIAPI ( efi, pci_ioremap, efipci_ioremap );
  * @ret rc		Return status code
  */
 static int efipci_dma_map ( struct dma_device *dma, struct dma_mapping *map,
-			    physaddr_t addr, size_t len, int flags ) {
+			    void *addr, size_t len, int flags ) {
 	struct efi_pci_device *efipci =
 		container_of ( dma, struct efi_pci_device, pci.dma );
 	struct pci_device *pci = &efipci->pci;
@@ -464,6 +464,7 @@ static int efipci_dma_map ( struct dma_device *dma, struct dma_mapping *map,
 	EFI_PHYSICAL_ADDRESS bus;
 	UINTN count;
 	VOID *mapping;
+	physaddr_t phys;
 	EFI_STATUS efirc;
 	int rc;
 
@@ -486,18 +487,19 @@ static int efipci_dma_map ( struct dma_device *dma, struct dma_mapping *map,
 	}
 
 	/* Map buffer (if non-zero length) */
+	phys = virt_to_phys ( addr );
 	count = len;
 	if ( len ) {
-		if ( ( efirc = pci_io->Map ( pci_io, op, phys_to_virt ( addr ),
-					     &count, &bus, &mapping ) ) != 0 ) {
+		if ( ( efirc = pci_io->Map ( pci_io, op, addr, &count, &bus,
+					     &mapping ) ) != 0 ) {
 			rc = -EEFI ( efirc );
-			DBGC ( pci, "EFIPCI " PCI_FMT " cannot map %08lx+%zx: "
+			DBGC ( pci, "EFIPCI " PCI_FMT " cannot map %p+%zx: "
 			       "%s\n", PCI_ARGS ( pci ), addr, len,
 			       strerror ( rc ) );
 			goto err_map;
 		}
 	} else {
-		bus = addr;
+		bus = phys;
 		mapping = NULL;
 	}
 
@@ -508,14 +510,14 @@ static int efipci_dma_map ( struct dma_device *dma, struct dma_mapping *map,
 	 */
 	if ( count != len ) {
 		DBGC ( pci, "EFIPCI " PCI_FMT " attempted split mapping for "
-		       "%08lx+%zx\n", PCI_ARGS ( pci ), addr, len );
+		       "%p+%zx\n", PCI_ARGS ( pci ), addr, len );
 		rc = -ENOTSUP;
 		goto err_len;
 	}
 
 	/* Populate mapping */
 	map->dma = dma;
-	map->offset = ( bus - addr );
+	map->offset = ( bus - phys );
 	map->token = mapping;
 
 	/* Increment mapping count (for debugging) */
@@ -594,8 +596,7 @@ static void * efipci_dma_alloc ( struct dma_device *dma,
 	memset ( addr, 0, ( pages * EFI_PAGE_SIZE ) );
 
 	/* Map buffer */
-	if ( ( rc = efipci_dma_map ( dma, map, virt_to_phys ( addr ),
-				     ( pages * EFI_PAGE_SIZE ),
+	if ( ( rc = efipci_dma_map ( dma, map, addr, ( pages * EFI_PAGE_SIZE ),
 				     DMA_BI ) ) != 0 )
 		goto err_map;
 
-- 
cgit v1.2.3-55-g7522


From bbabde8ff8182fcef738893c29a698783758a489 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 10 Jul 2025 14:33:34 +0100
Subject: [riscv] Invalidate data cache on completed RX DMA buffers

The data cache must be invalidated twice for RX DMA buffers: once
before passing ownership to the DMA device (in case the cache happens
to contain dirty data that will be written back at an undefined future
point), and once after receiving ownership from the DMA device (in
case the CPU happens to have speculatively accessed data in the buffer
while it was owned by the hardware).

Only the used portion of the buffer needs to be invalidated after
completion, since we do not care about data within the unused portion.

Update the DMA API to include the used length as an additional
parameter to dma_unmap(), and add the necessary second cache
invalidation pass to the RISC-V DMA API implementation.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/riscv/core/riscv_dma.c         | 52 +++++++++++++++++++++++++++++----
 src/arch/riscv/include/ipxe/riscv_dma.h | 11 -------
 src/core/dma.c                          |  5 ++--
 src/drivers/net/intelxl.c               |  4 +--
 src/include/ipxe/dma.h                  | 11 +++++--
 src/include/ipxe/iobuf.h                |  2 +-
 src/interface/efi/efi_pci.c             |  7 +++--
 7 files changed, 65 insertions(+), 27 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/riscv/core/riscv_dma.c b/src/arch/riscv/core/riscv_dma.c
index d215fba2c..ab88f2785 100644
--- a/src/arch/riscv/core/riscv_dma.c
+++ b/src/arch/riscv/core/riscv_dma.c
@@ -44,24 +44,57 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * @v flags		Mapping flags
  * @ret rc		Return status code
  */
-static int riscv_dma_map ( struct dma_device *dma __unused,
-			   struct dma_mapping *map __unused,
+static int riscv_dma_map ( struct dma_device *dma,
+			   struct dma_mapping *map,
 			   void *addr, size_t len, int flags ) {
 
 	/* Sanity check: we cannot support bidirectional mappings */
 	assert ( ! ( ( flags & DMA_TX ) & ( flags & DMA_RX ) ) );
 
+	/* Populate mapping */
+	map->dma = dma;
+	map->offset = 0;
+	map->token = NULL;
+
 	/* Flush cached data to transmit buffers */
 	if ( flags & DMA_TX )
 		cache_clean ( addr, len );
 
-	/* Invalidate cached data in receive buffers */
-	if ( flags & DMA_RX )
+	/* Invalidate cached data in receive buffers and record address */
+	if ( flags & DMA_RX ) {
 		cache_invalidate ( addr, len );
+		map->token = addr;
+	}
+
+	/* Increment mapping count (for debugging) */
+	if ( DBG_LOG )
+		dma->mapped++;
 
 	return 0;
 }
 
+/**
+ * Unmap buffer
+ *
+ * @v map		DMA mapping
+ * @v len		Used length
+ */
+static void riscv_dma_unmap ( struct dma_mapping *map, size_t len ) {
+	struct dma_device *dma = map->dma;
+	void *addr = map->token;
+
+	/* Invalidate cached data in receive buffers */
+	if ( addr )
+		cache_invalidate ( addr, len );
+
+	/* Clear mapping */
+	map->dma = NULL;
+
+	/* Decrement mapping count (for debugging) */
+	if ( DBG_LOG )
+		dma->mapped--;
+}
+
 /**
  * Allocate and map DMA-coherent buffer
  *
@@ -98,6 +131,10 @@ static void * riscv_dma_alloc ( struct dma_device *dma,
 	DBGC ( dma, "DMA allocated [%#08lx,%#08lx) via %p\n",
 	       phys, ( phys + len ), caddr );
 
+	/* Increment allocation count (for debugging) */
+	if ( DBG_LOG )
+		dma->allocated++;
+
 	return caddr;
 }
 
@@ -111,6 +148,7 @@ static void * riscv_dma_alloc ( struct dma_device *dma,
  */
 static void riscv_dma_free ( struct dma_mapping *map,
 			     void *addr, size_t len ) {
+	struct dma_device *dma = map->dma;
 
 	/* Sanity check */
 	assert ( virt_to_phys ( addr ) == virt_to_phys ( map->token ) );
@@ -121,10 +159,14 @@ static void riscv_dma_free ( struct dma_mapping *map,
 	/* Clear mapping */
 	map->dma = NULL;
 	map->token = NULL;
+
+	/* Decrement allocation count (for debugging) */
+	if ( DBG_LOG )
+		dma->allocated--;
 }
 
 PROVIDE_DMAAPI ( riscv, dma_map, riscv_dma_map );
-PROVIDE_DMAAPI_INLINE ( riscv, dma_unmap );
+PROVIDE_DMAAPI ( riscv, dma_unmap, riscv_dma_unmap );
 PROVIDE_DMAAPI ( riscv, dma_alloc, riscv_dma_alloc );
 PROVIDE_DMAAPI ( riscv, dma_free, riscv_dma_free );
 PROVIDE_DMAAPI ( riscv, dma_umalloc, riscv_dma_alloc );
diff --git a/src/arch/riscv/include/ipxe/riscv_dma.h b/src/arch/riscv/include/ipxe/riscv_dma.h
index 568f28afe..d35904d88 100644
--- a/src/arch/riscv/include/ipxe/riscv_dma.h
+++ b/src/arch/riscv/include/ipxe/riscv_dma.h
@@ -15,17 +15,6 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define DMAAPI_PREFIX_riscv __riscv_
 #endif
 
-/**
- * Unmap buffer
- *
- * @v map		DMA mapping
- */
-static inline __always_inline void
-DMAAPI_INLINE ( riscv, dma_unmap ) ( struct dma_mapping *map __unused ) {
-
-	/* Nothing to do */
-}
-
 /**
  * Set addressable space mask
  *
diff --git a/src/core/dma.c b/src/core/dma.c
index cbc9b8d10..3f3023c4d 100644
--- a/src/core/dma.c
+++ b/src/core/dma.c
@@ -79,13 +79,14 @@ static int dma_op_map ( struct dma_device *dma, struct dma_mapping *map,
  * Unmap buffer
  *
  * @v map		DMA mapping
+ * @v len		Used length
  */
-static void dma_op_unmap ( struct dma_mapping *map ) {
+static void dma_op_unmap ( struct dma_mapping *map, size_t len ) {
 	struct dma_device *dma = map->dma;
 
 	assert ( dma != NULL );
 	assert ( dma->op != NULL );
-	dma->op->unmap ( dma, map );
+	dma->op->unmap ( dma, map, len );
 }
 
 /**
diff --git a/src/drivers/net/intelxl.c b/src/drivers/net/intelxl.c
index 1d4c22a09..31a3e2577 100644
--- a/src/drivers/net/intelxl.c
+++ b/src/drivers/net/intelxl.c
@@ -90,7 +90,7 @@ int intelxl_msix_enable ( struct intelxl_nic *intelxl,
 
 	pci_msix_disable ( pci, &intelxl->msix.cap );
  err_enable:
-	dma_unmap ( &intelxl->msix.map );
+	dma_unmap ( &intelxl->msix.map, sizeof ( intelxl->msix.msg ) );
  err_map:
 	return rc;
 }
@@ -112,7 +112,7 @@ void intelxl_msix_disable ( struct intelxl_nic *intelxl,
 	pci_msix_disable ( pci, &intelxl->msix.cap );
 
 	/* Unmap dummy target location */
-	dma_unmap ( &intelxl->msix.map );
+	dma_unmap ( &intelxl->msix.map, sizeof ( intelxl->msix.msg ) );
 }
 
 /******************************************************************************
diff --git a/src/include/ipxe/dma.h b/src/include/ipxe/dma.h
index b675df212..a6e41c1ab 100644
--- a/src/include/ipxe/dma.h
+++ b/src/include/ipxe/dma.h
@@ -74,8 +74,10 @@ struct dma_operations {
 	 *
 	 * @v dma		DMA device
 	 * @v map		DMA mapping
+	 * @v len		Used length
 	 */
-	void ( * unmap ) ( struct dma_device *dma, struct dma_mapping *map );
+	void ( * unmap ) ( struct dma_device *dma, struct dma_mapping *map,
+			   size_t len );
 	/**
 	 * Allocate and map DMA-coherent buffer
 	 *
@@ -194,9 +196,11 @@ DMAAPI_INLINE ( flat, dma_map ) ( struct dma_device *dma,
  * Unmap buffer
  *
  * @v map		DMA mapping
+ * @v len		Used length
  */
 static inline __always_inline void
-DMAAPI_INLINE ( flat, dma_unmap ) ( struct dma_mapping *map ) {
+DMAAPI_INLINE ( flat, dma_unmap ) ( struct dma_mapping *map,
+				    size_t len __unused ) {
 
 	/* Decrement mapping count (for debugging) */
 	if ( DBG_LOG ) {
@@ -365,8 +369,9 @@ int dma_map ( struct dma_device *dma, struct dma_mapping *map,
  * Unmap buffer
  *
  * @v map		DMA mapping
+ * @v len		Used length
  */
-void dma_unmap ( struct dma_mapping *map );
+void dma_unmap ( struct dma_mapping *map, size_t len );
 
 /**
  * Allocate and map DMA-coherent buffer
diff --git a/src/include/ipxe/iobuf.h b/src/include/ipxe/iobuf.h
index df8d0b854..46b350458 100644
--- a/src/include/ipxe/iobuf.h
+++ b/src/include/ipxe/iobuf.h
@@ -276,7 +276,7 @@ static inline __always_inline physaddr_t iob_dma ( struct io_buffer *iobuf ) {
  * @ret rc		Return status code
  */
 static inline __always_inline void iob_unmap ( struct io_buffer *iobuf ) {
-	dma_unmap ( &iobuf->map );
+	dma_unmap ( &iobuf->map, iob_len ( iobuf ) );
 }
 
 extern struct io_buffer * __malloc alloc_iob_raw ( size_t len, size_t align,
diff --git a/src/interface/efi/efi_pci.c b/src/interface/efi/efi_pci.c
index ae0ec4264..fbf06300b 100644
--- a/src/interface/efi/efi_pci.c
+++ b/src/interface/efi/efi_pci.c
@@ -537,9 +537,10 @@ static int efipci_dma_map ( struct dma_device *dma, struct dma_mapping *map,
  *
  * @v dma		DMA device
  * @v map		DMA mapping
+ * @v len		Used length
  */
 static void efipci_dma_unmap ( struct dma_device *dma,
-			       struct dma_mapping *map ) {
+			       struct dma_mapping *map, size_t len __unused ) {
 	struct efi_pci_device *efipci =
 		container_of ( dma, struct efi_pci_device, pci.dma );
 	EFI_PCI_IO_PROTOCOL *pci_io = efipci->io;
@@ -606,7 +607,7 @@ static void * efipci_dma_alloc ( struct dma_device *dma,
 
 	return addr;
 
-	efipci_dma_unmap ( dma, map );
+	efipci_dma_unmap ( dma, map, len );
  err_map:
 	pci_io->FreeBuffer ( pci_io, pages, addr );
  err_alloc:
@@ -632,7 +633,7 @@ static void efipci_dma_free ( struct dma_device *dma, struct dma_mapping *map,
 	pages = ( ( len + EFI_PAGE_SIZE - 1 ) / EFI_PAGE_SIZE );
 
 	/* Unmap buffer */
-	efipci_dma_unmap ( dma, map );
+	efipci_dma_unmap ( dma, map, len );
 
 	/* Free buffer */
 	pci_io->FreeBuffer ( pci_io, pages, addr );
-- 
cgit v1.2.3-55-g7522


From 1e3fb1b37e16cd7cd30f6b20b9eee929568f35a9 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 15 Jul 2025 14:08:15 +0100
Subject: [init] Show initialisation function names in debug messages

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/cpuid_settings.c             | 1 +
 src/arch/x86/core/debugcon.c                   | 1 +
 src/arch/x86/core/pci_autoboot.c               | 1 +
 src/arch/x86/core/video_subr.c                 | 1 +
 src/arch/x86/interface/pcbios/bios_cachedhcp.c | 1 +
 src/arch/x86/interface/pcbios/int13con.c       | 1 +
 src/arch/x86/interface/pcbios/pcicloud.c       | 1 +
 src/arch/x86/interface/pxe/pxe_call.c          | 1 +
 src/arch/x86/interface/vmware/guestinfo.c      | 1 +
 src/arch/x86/interface/vmware/vmconsole.c      | 1 +
 src/core/acpi_settings.c                       | 1 +
 src/core/fnrec.c                               | 1 +
 src/core/init.c                                | 4 +++-
 src/core/malloc.c                              | 1 +
 src/core/memmap_settings.c                     | 1 +
 src/core/process.c                             | 1 +
 src/core/serial.c                              | 1 +
 src/core/settings.c                            | 1 +
 src/core/timer.c                               | 1 +
 src/crypto/certstore.c                         | 1 +
 src/crypto/des.c                               | 1 +
 src/crypto/x25519.c                            | 1 +
 src/drivers/bus/pci_settings.c                 | 1 +
 src/drivers/bus/usb_settings.c                 | 1 +
 src/drivers/net/efi/snponly.c                  | 1 +
 src/image/embedded.c                           | 1 +
 src/include/ipxe/init.h                        | 1 +
 src/interface/efi/efi_cacert.c                 | 1 +
 src/interface/efi/efi_console.c                | 1 +
 src/interface/efi/efi_fdt.c                    | 1 +
 src/interface/efi/efi_settings.c               | 1 +
 src/interface/efi/efiprefix.c                  | 1 +
 src/interface/smbios/smbios_settings.c         | 1 +
 src/net/netdev_settings.c                      | 1 +
 src/tests/bofm_test.c                          | 1 +
 src/tests/test.c                               | 1 +
 36 files changed, 38 insertions(+), 1 deletion(-)

(limited to 'src/core')

diff --git a/src/arch/x86/core/cpuid_settings.c b/src/arch/x86/core/cpuid_settings.c
index 9bc69f477..44d38debc 100644
--- a/src/arch/x86/core/cpuid_settings.c
+++ b/src/arch/x86/core/cpuid_settings.c
@@ -250,6 +250,7 @@ static void cpuid_settings_init ( void ) {
 
 /** CPUID settings initialiser */
 struct init_fn cpuid_settings_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "cpuid",
 	.initialise = cpuid_settings_init,
 };
 
diff --git a/src/arch/x86/core/debugcon.c b/src/arch/x86/core/debugcon.c
index 60de61f55..0e3a5dfc7 100644
--- a/src/arch/x86/core/debugcon.c
+++ b/src/arch/x86/core/debugcon.c
@@ -86,5 +86,6 @@ static void debugcon_init ( void ) {
  * Debug port console initialisation function
  */
 struct init_fn debugcon_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "debugcon",
 	.initialise = debugcon_init,
 };
diff --git a/src/arch/x86/core/pci_autoboot.c b/src/arch/x86/core/pci_autoboot.c
index 337598091..243e45026 100644
--- a/src/arch/x86/core/pci_autoboot.c
+++ b/src/arch/x86/core/pci_autoboot.c
@@ -44,5 +44,6 @@ static void pci_autoboot_init ( void ) {
 
 /** PCI autoboot device initialisation function */
 struct init_fn pci_autoboot_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "autoboot",
 	.initialise = pci_autoboot_init,
 };
diff --git a/src/arch/x86/core/video_subr.c b/src/arch/x86/core/video_subr.c
index f5cc4cdd4..4e9ef466f 100644
--- a/src/arch/x86/core/video_subr.c
+++ b/src/arch/x86/core/video_subr.c
@@ -109,5 +109,6 @@ struct console_driver vga_console __console_driver = {
 };
 
 struct init_fn video_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "video",
 	.initialise = video_init,
 };
diff --git a/src/arch/x86/interface/pcbios/bios_cachedhcp.c b/src/arch/x86/interface/pcbios/bios_cachedhcp.c
index 897858143..60191c9c5 100644
--- a/src/arch/x86/interface/pcbios/bios_cachedhcp.c
+++ b/src/arch/x86/interface/pcbios/bios_cachedhcp.c
@@ -74,5 +74,6 @@ static void cachedhcp_init ( void ) {
 
 /** Cached DHCPACK initialisation function */
 struct init_fn cachedhcp_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "cachedhcp",
 	.initialise = cachedhcp_init,
 };
diff --git a/src/arch/x86/interface/pcbios/int13con.c b/src/arch/x86/interface/pcbios/int13con.c
index 8106cd153..925228874 100644
--- a/src/arch/x86/interface/pcbios/int13con.c
+++ b/src/arch/x86/interface/pcbios/int13con.c
@@ -288,6 +288,7 @@ static void int13con_init ( void ) {
  * INT13 console initialisation function
  */
 struct init_fn int13con_init_fn __init_fn ( INIT_CONSOLE ) = {
+	.name = "int13con",
 	.initialise = int13con_init,
 };
 
diff --git a/src/arch/x86/interface/pcbios/pcicloud.c b/src/arch/x86/interface/pcbios/pcicloud.c
index f7d4a2da1..5d4d02ac4 100644
--- a/src/arch/x86/interface/pcbios/pcicloud.c
+++ b/src/arch/x86/interface/pcbios/pcicloud.c
@@ -191,5 +191,6 @@ static void pcicloud_init ( void ) {
 
 /** Cloud VM PCI configuration space access initialisation function */
 struct init_fn pcicloud_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "pcicloud",
 	.initialise = pcicloud_init,
 };
diff --git a/src/arch/x86/interface/pxe/pxe_call.c b/src/arch/x86/interface/pxe/pxe_call.c
index a530f919f..9a6a20dd3 100644
--- a/src/arch/x86/interface/pxe/pxe_call.c
+++ b/src/arch/x86/interface/pxe/pxe_call.c
@@ -257,6 +257,7 @@ static void pxe_init_structures ( void ) {
 
 /** PXE structure initialiser */
 struct init_fn pxe_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "pxe",
 	.initialise = pxe_init_structures,
 };
 
diff --git a/src/arch/x86/interface/vmware/guestinfo.c b/src/arch/x86/interface/vmware/guestinfo.c
index 4134515c1..c181d96e9 100644
--- a/src/arch/x86/interface/vmware/guestinfo.c
+++ b/src/arch/x86/interface/vmware/guestinfo.c
@@ -200,6 +200,7 @@ static void guestinfo_init ( void ) {
 
 /** GuestInfo settings initialiser */
 struct init_fn guestinfo_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "guestinfo",
 	.initialise = guestinfo_init,
 };
 
diff --git a/src/arch/x86/interface/vmware/vmconsole.c b/src/arch/x86/interface/vmware/vmconsole.c
index f7df4f75b..3b892c837 100644
--- a/src/arch/x86/interface/vmware/vmconsole.c
+++ b/src/arch/x86/interface/vmware/vmconsole.c
@@ -134,5 +134,6 @@ static void vmconsole_init ( void ) {
  * VMware logfile console initialisation function
  */
 struct init_fn vmconsole_init_fn __init_fn ( INIT_CONSOLE ) = {
+	.name = "vmconsole",
 	.initialise = vmconsole_init,
 };
diff --git a/src/core/acpi_settings.c b/src/core/acpi_settings.c
index cdee1f865..63f271855 100644
--- a/src/core/acpi_settings.c
+++ b/src/core/acpi_settings.c
@@ -156,5 +156,6 @@ static void acpi_settings_init ( void ) {
 
 /** ACPI settings initialiser */
 struct init_fn acpi_settings_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "acpi",
 	.initialise = acpi_settings_init,
 };
diff --git a/src/core/fnrec.c b/src/core/fnrec.c
index 0430817f8..b63ffc1f5 100644
--- a/src/core/fnrec.c
+++ b/src/core/fnrec.c
@@ -177,6 +177,7 @@ static void fnrec_init ( void ) {
 }
 
 struct init_fn fnrec_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "fnrec",
 	.initialise = fnrec_init,
 };
 
diff --git a/src/core/init.c b/src/core/init.c
index c13fd1667..406d22d7b 100644
--- a/src/core/init.c
+++ b/src/core/init.c
@@ -53,8 +53,10 @@ void initialise ( void ) {
 	struct init_fn *init_fn;
 
 	/* Call registered initialisation functions */
-	for_each_table_entry ( init_fn, INIT_FNS )
+	for_each_table_entry ( init_fn, INIT_FNS ) {
+		DBGC ( colour, "INIT initialising %s...\n", init_fn->name );
 		init_fn->initialise ();
+	}
 }
 
 /**
diff --git a/src/core/malloc.c b/src/core/malloc.c
index 545927a30..a05871085 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -765,6 +765,7 @@ static void init_heap ( void ) {
 
 /** Memory allocator initialisation function */
 struct init_fn heap_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "heap",
 	.initialise = init_heap,
 };
 
diff --git a/src/core/memmap_settings.c b/src/core/memmap_settings.c
index d07e9747e..f54de9150 100644
--- a/src/core/memmap_settings.c
+++ b/src/core/memmap_settings.c
@@ -243,6 +243,7 @@ static void memmap_settings_init ( void ) {
 
 /** Memory map settings initialiser */
 struct init_fn memmap_settings_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "memmap",
 	.initialise = memmap_settings_init,
 };
 
diff --git a/src/core/process.c b/src/core/process.c
index 69852c416..c944b6f50 100644
--- a/src/core/process.c
+++ b/src/core/process.c
@@ -133,5 +133,6 @@ static void init_processes ( void ) {
 
 /** Process initialiser */
 struct init_fn process_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "process",
 	.initialise = init_processes,
 };
diff --git a/src/core/serial.c b/src/core/serial.c
index 4b569ffad..0883ad051 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -180,6 +180,7 @@ static void serial_shutdown ( int flags __unused ) {
 
 /** Serial console initialisation function */
 struct init_fn serial_console_init_fn __init_fn ( INIT_CONSOLE ) = {
+	.name = "serial",
 	.initialise = serial_init,
 };
 
diff --git a/src/core/settings.c b/src/core/settings.c
index 9fbf753ab..05e495dcf 100644
--- a/src/core/settings.c
+++ b/src/core/settings.c
@@ -2819,5 +2819,6 @@ static void builtin_init ( void ) {
 
 /** Built-in settings initialiser */
 struct init_fn builtin_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "builtin",
 	.initialise = builtin_init,
 };
diff --git a/src/core/timer.c b/src/core/timer.c
index 24745cef7..d45797adb 100644
--- a/src/core/timer.c
+++ b/src/core/timer.c
@@ -170,6 +170,7 @@ static void timer_probe ( void ) {
 
 /** Timer initialisation function */
 struct init_fn timer_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "timer",
 	.initialise = timer_probe,
 };
 
diff --git a/src/crypto/certstore.c b/src/crypto/certstore.c
index 81179f9cc..aad874297 100644
--- a/src/crypto/certstore.c
+++ b/src/crypto/certstore.c
@@ -210,6 +210,7 @@ static void certstore_init ( void ) {
 
 /** Certificate store initialisation function */
 struct init_fn certstore_init_fn __init_fn ( INIT_LATE ) = {
+	.name = "certstore",
 	.initialise = certstore_init,
 };
 
diff --git a/src/crypto/des.c b/src/crypto/des.c
index 6918bec3e..206f78d50 100644
--- a/src/crypto/des.c
+++ b/src/crypto/des.c
@@ -369,6 +369,7 @@ static void des_init ( void ) {
 
 /** Initialisation function */
 struct init_fn des_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "des",
 	.initialise = des_init,
 };
 
diff --git a/src/crypto/x25519.c b/src/crypto/x25519.c
index 995cfa352..41bc5fc5e 100644
--- a/src/crypto/x25519.c
+++ b/src/crypto/x25519.c
@@ -334,6 +334,7 @@ static void x25519_init_constants ( void ) {
 
 /** Initialisation function */
 struct init_fn x25519_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "x25519",
 	.initialise = x25519_init_constants,
 };
 
diff --git a/src/drivers/bus/pci_settings.c b/src/drivers/bus/pci_settings.c
index 84aa76827..fc73c651e 100644
--- a/src/drivers/bus/pci_settings.c
+++ b/src/drivers/bus/pci_settings.c
@@ -125,5 +125,6 @@ static void pci_settings_init ( void ) {
 
 /** PCI device settings initialiser */
 struct init_fn pci_settings_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "pci",
 	.initialise = pci_settings_init,
 };
diff --git a/src/drivers/bus/usb_settings.c b/src/drivers/bus/usb_settings.c
index 4fd190d83..bb01f34d5 100644
--- a/src/drivers/bus/usb_settings.c
+++ b/src/drivers/bus/usb_settings.c
@@ -173,5 +173,6 @@ static void usb_settings_init ( void ) {
 
 /** USB device settings initialiser */
 struct init_fn usb_settings_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "usb",
 	.initialise = usb_settings_init,
 };
diff --git a/src/drivers/net/efi/snponly.c b/src/drivers/net/efi/snponly.c
index f0a5277a2..876479133 100644
--- a/src/drivers/net/efi/snponly.c
+++ b/src/drivers/net/efi/snponly.c
@@ -259,5 +259,6 @@ static void chained_init ( void ) {
 
 /** EFI chainloaded-device-only initialisation function */
 struct init_fn chained_init_fn __init_fn ( INIT_LATE ) = {
+	.name = "chained",
 	.initialise = chained_init,
 };
diff --git a/src/image/embedded.c b/src/image/embedded.c
index 2934d4ee7..652cfc85f 100644
--- a/src/image/embedded.c
+++ b/src/image/embedded.c
@@ -80,5 +80,6 @@ static void embedded_init ( void ) {
 
 /** Embedded image initialisation function */
 struct init_fn embedded_init_fn __init_fn ( INIT_LATE ) = {
+	.name = "embedded",
 	.initialise = embedded_init,
 };
diff --git a/src/include/ipxe/init.h b/src/include/ipxe/init.h
index 32927e3a6..da01b2953 100644
--- a/src/include/ipxe/init.h
+++ b/src/include/ipxe/init.h
@@ -12,6 +12,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * call to initialise().
  */
 struct init_fn {
+	const char *name;
 	void ( * initialise ) ( void );
 };
 
diff --git a/src/interface/efi/efi_cacert.c b/src/interface/efi/efi_cacert.c
index 2b6c5c343..64bb0bae2 100644
--- a/src/interface/efi/efi_cacert.c
+++ b/src/interface/efi/efi_cacert.c
@@ -178,6 +178,7 @@ static void efi_cacert_init ( void ) {
 
 /** EFI CA certificates initialisation function */
 struct init_fn efi_cacert_init_fn __init_fn ( INIT_LATE ) = {
+	.name = "eficacert",
 	.initialise = efi_cacert_init,
 };
 
diff --git a/src/interface/efi/efi_console.c b/src/interface/efi/efi_console.c
index 9fc3c65c0..4557671a0 100644
--- a/src/interface/efi/efi_console.c
+++ b/src/interface/efi/efi_console.c
@@ -448,5 +448,6 @@ static void efi_console_init ( void ) {
  * EFI console initialisation function
  */
 struct init_fn efi_console_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "eficonsole",
 	.initialise = efi_console_init,
 };
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index 3a90fd7ce..3c249693e 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -77,6 +77,7 @@ static void efi_fdt_init ( void ) {
 
 /** EFI Flattened Device Tree initialisation function */
 struct init_fn efi_fdt_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "efifdt",
 	.initialise = efi_fdt_init,
 };
 
diff --git a/src/interface/efi/efi_settings.c b/src/interface/efi/efi_settings.c
index cde0ff8d1..5ddbe12f1 100644
--- a/src/interface/efi/efi_settings.c
+++ b/src/interface/efi/efi_settings.c
@@ -232,5 +232,6 @@ static void efivars_init ( void ) {
 
 /** EFI variable settings initialiser */
 struct init_fn efivars_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "efivars",
 	.initialise = efivars_init,
 };
diff --git a/src/interface/efi/efiprefix.c b/src/interface/efi/efiprefix.c
index 10d8f0bf6..ddce6aa60 100644
--- a/src/interface/efi/efiprefix.c
+++ b/src/interface/efi/efiprefix.c
@@ -98,6 +98,7 @@ static void efi_init_application ( void ) {
 
 /** EFI application initialisation function */
 struct init_fn efi_init_application_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "efi",
 	.initialise = efi_init_application,
 };
 
diff --git a/src/interface/smbios/smbios_settings.c b/src/interface/smbios/smbios_settings.c
index 1fe545f38..6358a4709 100644
--- a/src/interface/smbios/smbios_settings.c
+++ b/src/interface/smbios/smbios_settings.c
@@ -200,6 +200,7 @@ static void smbios_init ( void ) {
 
 /** SMBIOS settings initialiser */
 struct init_fn smbios_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "smbios",
 	.initialise = smbios_init,
 };
 
diff --git a/src/net/netdev_settings.c b/src/net/netdev_settings.c
index 9432dc2fa..90b804c6c 100644
--- a/src/net/netdev_settings.c
+++ b/src/net/netdev_settings.c
@@ -429,6 +429,7 @@ static void netdev_redirect_settings_init ( void ) {
 
 /** "netX" settings initialiser */
 struct init_fn netdev_redirect_settings_init_fn __init_fn ( INIT_LATE ) = {
+	.name = "netX",
 	.initialise = netdev_redirect_settings_init,
 };
 
diff --git a/src/tests/bofm_test.c b/src/tests/bofm_test.c
index 6d472bc7e..bc400284f 100644
--- a/src/tests/bofm_test.c
+++ b/src/tests/bofm_test.c
@@ -278,5 +278,6 @@ static void bofm_test_init ( void ) {
 
 /** BOFM test initialisation function */
 struct init_fn bofm_test_init_fn __init_fn ( INIT_NORMAL ) = {
+	.name = "bofm",
 	.initialise = bofm_test_init,
 };
diff --git a/src/tests/test.c b/src/tests/test.c
index 9fa12e27a..e4f5eb838 100644
--- a/src/tests/test.c
+++ b/src/tests/test.c
@@ -180,5 +180,6 @@ static void test_init ( void ) {
 
 /** Self-test initialisation function */
 struct init_fn test_init_fn __init_fn ( INIT_EARLY ) = {
+	.name = "test",
 	.initialise = test_init,
 };
-- 
cgit v1.2.3-55-g7522


From fb082bd4cd6a49609785b3b3537b1713d568f7c4 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 22 Jul 2025 13:37:05 +0100
Subject: [fdt] Add ability to locate node by phandle

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c         |  51 ++++++++++++++++++
 src/include/ipxe/fdt.h |   2 +
 src/tests/fdt_test.c   | 143 +++++++++++++++++++++++++++----------------------
 3 files changed, 131 insertions(+), 65 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 149348199..6989690bf 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -482,6 +482,57 @@ int fdt_alias ( struct fdt *fdt, const char *name, unsigned int *offset ) {
 	return 0;
 }
 
+/**
+ * Find node by package handle (phandle)
+ *
+ * @v fdt		Device tree
+ * @v phandle		Package handle
+ * @v offset		Offset to fill in
+ * @ret rc		Return status code
+ */
+int fdt_phandle ( struct fdt *fdt, uint32_t phandle, unsigned int *offset ) {
+	struct fdt_descriptor desc;
+	uint32_t value;
+	int depth;
+	int rc;
+
+	/* Initialise offset */
+	*offset = 0;
+
+	/* Find node with matching phandle */
+	for ( depth = -1 ; ; depth += desc.depth, *offset = desc.next ) {
+
+		/* Describe token */
+		if ( ( rc = fdt_describe ( fdt, *offset, &desc ) ) != 0 ) {
+			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
+			       *offset, strerror ( rc ) );
+			return rc;
+		}
+
+		/* Terminate when we exit the root node */
+		if ( ( depth == 0 ) && ( desc.depth < 0 ) )
+			break;
+
+		/* Ignore non-nodes */
+		if ( ( ! desc.name ) || desc.data )
+			continue;
+
+		/* Check for matching "phandle" or "linux-phandle" property */
+		if ( ( ( ( rc = fdt_u32 ( fdt, *offset, "phandle",
+					  &value ) ) == 0 ) ||
+		       ( ( rc = fdt_u32 ( fdt, *offset, "linux,phandle",
+					  &value ) ) == 0 ) ) &&
+		     ( value == phandle ) ) {
+			DBGC2 ( fdt, "FDT +%#04x has phandle %#02x\n",
+				*offset, phandle );
+			return 0;
+		}
+	}
+
+	DBGC ( fdt, "FDT has no phandle %#02x\n", phandle );
+	return -ENOENT;
+}
+
 /**
  * Find property
  *
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index d5a0d2179..c73389ad7 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -176,6 +176,8 @@ extern int fdt_path ( struct fdt *fdt, const char *path,
 		      unsigned int *offset );
 extern int fdt_alias ( struct fdt *fdt, const char *name,
 		       unsigned int *offset );
+extern int fdt_phandle ( struct fdt *fdt, uint32_t phandle,
+			 unsigned int *offset );
 extern const char * fdt_strings ( struct fdt *fdt, unsigned int offset,
 				  const char *name, unsigned int *count );
 extern const char * fdt_string ( struct fdt *fdt, unsigned int offset,
diff --git a/src/tests/fdt_test.c b/src/tests/fdt_test.c
index 0be0acdbc..099a093b4 100644
--- a/src/tests/fdt_test.c
+++ b/src/tests/fdt_test.c
@@ -39,10 +39,10 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 /** Simplified QEMU sifive_u device tree blob */
 static const uint8_t sifive_u[] = {
-	0xd0, 0x0d, 0xfe, 0xed, 0x00, 0x00, 0x05, 0x61, 0x00, 0x00, 0x00, 0x38,
-	0x00, 0x00, 0x04, 0x7c, 0x00, 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x11,
-	0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xe5,
-	0x00, 0x00, 0x04, 0x44, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0xd0, 0x0d, 0xfe, 0xed, 0x00, 0x00, 0x05, 0x8f, 0x00, 0x00, 0x00, 0x38,
+	0x00, 0x00, 0x04, 0x9c, 0x00, 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x11,
+	0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf3,
+	0x00, 0x00, 0x04, 0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01,
 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04,
 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x03,
@@ -90,70 +90,74 @@ static const uint8_t sifive_u[] = {
 	0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x00,
 	0x00, 0x00, 0x00, 0x8f, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x0f,
 	0x00, 0x00, 0x00, 0x1b, 0x72, 0x69, 0x73, 0x63, 0x76, 0x2c, 0x63, 0x70,
-	0x75, 0x2d, 0x69, 0x6e, 0x74, 0x63, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02,
-	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x01,
-	0x6d, 0x65, 0x6d, 0x6f, 0x72, 0x79, 0x40, 0x38, 0x30, 0x30, 0x30, 0x30,
-	0x30, 0x30, 0x30, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x07,
-	0x00, 0x00, 0x00, 0x5d, 0x6d, 0x65, 0x6d, 0x6f, 0x72, 0x79, 0x00, 0x00,
+	0x75, 0x2d, 0x69, 0x6e, 0x74, 0x63, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0xa4, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02,
+	0x00, 0x00, 0x00, 0x01, 0x6d, 0x65, 0x6d, 0x6f, 0x72, 0x79, 0x40, 0x38,
+	0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x00, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x07, 0x00, 0x00, 0x00, 0x5d, 0x6d, 0x65, 0x6d, 0x6f,
+	0x72, 0x79, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x10,
+	0x00, 0x00, 0x00, 0x69, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02,
+	0x00, 0x00, 0x00, 0x01, 0x73, 0x6f, 0x63, 0x00, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02,
+	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x0f,
+	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x0b,
+	0x00, 0x00, 0x00, 0x1b, 0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x2d, 0x62,
+	0x75, 0x73, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0xb2, 0x00, 0x00, 0x00, 0x01, 0x73, 0x65, 0x72, 0x69,
+	0x61, 0x6c, 0x40, 0x31, 0x30, 0x30, 0x31, 0x30, 0x30, 0x30, 0x30, 0x00,
 	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x69,
-	0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-	0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x01,
-	0x73, 0x6f, 0x63, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04,
-	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x03,
-	0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00, 0x02,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x0b, 0x00, 0x00, 0x00, 0x1b,
-	0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x2d, 0x62, 0x75, 0x73, 0x00, 0x00,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xa4,
-	0x00, 0x00, 0x00, 0x01, 0x73, 0x65, 0x72, 0x69, 0x61, 0x6c, 0x40, 0x31,
-	0x30, 0x30, 0x31, 0x30, 0x30, 0x30, 0x30, 0x00, 0x00, 0x00, 0x00, 0x03,
-	0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x69, 0x00, 0x00, 0x00, 0x00,
-	0x10, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x0d, 0x00, 0x00, 0x00, 0x1b,
-	0x73, 0x69, 0x66, 0x69, 0x76, 0x65, 0x2c, 0x75, 0x61, 0x72, 0x74, 0x30,
-	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x01,
-	0x65, 0x74, 0x68, 0x65, 0x72, 0x6e, 0x65, 0x74, 0x40, 0x31, 0x30, 0x30,
-	0x39, 0x30, 0x30, 0x30, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
-	0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00, 0x00,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
-	0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x06,
-	0x00, 0x00, 0x00, 0xab, 0x52, 0x54, 0x00, 0x12, 0x34, 0x56, 0x00, 0x00,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0xbd,
-	0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x05,
-	0x00, 0x00, 0x00, 0xc8, 0x67, 0x6d, 0x69, 0x69, 0x00, 0x00, 0x00, 0x00,
-	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0xd1,
-	0x63, 0x6f, 0x6e, 0x74, 0x72, 0x6f, 0x6c, 0x00, 0x00, 0x00, 0x00, 0x03,
-	0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x69, 0x00, 0x00, 0x00, 0x00,
-	0x10, 0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x20, 0x00,
-	0x00, 0x00, 0x00, 0x00, 0x10, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-	0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x16,
-	0x00, 0x00, 0x00, 0x1b, 0x73, 0x69, 0x66, 0x69, 0x76, 0x65, 0x2c, 0x66,
-	0x75, 0x35, 0x34, 0x30, 0x2d, 0x63, 0x30, 0x30, 0x30, 0x2d, 0x67, 0x65,
-	0x6d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x08,
-	0x00, 0x00, 0x00, 0xdb, 0x00, 0x00, 0x00, 0x02, 0x54, 0x0b, 0xe4, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x10, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x0d,
+	0x00, 0x00, 0x00, 0x1b, 0x73, 0x69, 0x66, 0x69, 0x76, 0x65, 0x2c, 0x75,
+	0x61, 0x72, 0x74, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02,
 	0x00, 0x00, 0x00, 0x01, 0x65, 0x74, 0x68, 0x65, 0x72, 0x6e, 0x65, 0x74,
-	0x2d, 0x70, 0x68, 0x79, 0x40, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
-	0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x69, 0x00, 0x00, 0x00, 0x00,
+	0x40, 0x31, 0x30, 0x30, 0x39, 0x30, 0x30, 0x30, 0x30, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x0f,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0xb9, 0x52, 0x54, 0x00, 0x12,
+	0x34, 0x56, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04,
+	0x00, 0x00, 0x00, 0xcb, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x05, 0x00, 0x00, 0x00, 0xd6, 0x67, 0x6d, 0x69, 0x69,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x08,
+	0x00, 0x00, 0x00, 0xdf, 0x63, 0x6f, 0x6e, 0x74, 0x72, 0x6f, 0x6c, 0x00,
+	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x69,
+	0x00, 0x00, 0x00, 0x00, 0x10, 0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x0a, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x16, 0x00, 0x00, 0x00, 0x1b, 0x73, 0x69, 0x66, 0x69,
+	0x76, 0x65, 0x2c, 0x66, 0x75, 0x35, 0x34, 0x30, 0x2d, 0x63, 0x30, 0x30,
+	0x30, 0x2d, 0x67, 0x65, 0x6d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
+	0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0xe9, 0x00, 0x00, 0x00, 0x02,
+	0x54, 0x0b, 0xe4, 0x00, 0x00, 0x00, 0x00, 0x01, 0x65, 0x74, 0x68, 0x65,
+	0x72, 0x6e, 0x65, 0x74, 0x2d, 0x70, 0x68, 0x79, 0x40, 0x30, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x69,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x04,
+	0x00, 0x00, 0x00, 0xaa, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x02,
 	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x02,
-	0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x09, 0x23, 0x61, 0x64, 0x64,
-	0x72, 0x65, 0x73, 0x73, 0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x23,
-	0x73, 0x69, 0x7a, 0x65, 0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x63,
-	0x6f, 0x6d, 0x70, 0x61, 0x74, 0x69, 0x62, 0x6c, 0x65, 0x00, 0x6d, 0x6f,
-	0x64, 0x65, 0x6c, 0x00, 0x73, 0x74, 0x64, 0x6f, 0x75, 0x74, 0x2d, 0x70,
-	0x61, 0x74, 0x68, 0x00, 0x73, 0x65, 0x72, 0x69, 0x61, 0x6c, 0x30, 0x00,
-	0x65, 0x74, 0x68, 0x65, 0x72, 0x6e, 0x65, 0x74, 0x30, 0x00, 0x74, 0x69,
-	0x6d, 0x65, 0x62, 0x61, 0x73, 0x65, 0x2d, 0x66, 0x72, 0x65, 0x71, 0x75,
-	0x65, 0x6e, 0x63, 0x79, 0x00, 0x64, 0x65, 0x76, 0x69, 0x63, 0x65, 0x5f,
-	0x74, 0x79, 0x70, 0x65, 0x00, 0x72, 0x65, 0x67, 0x00, 0x73, 0x74, 0x61,
-	0x74, 0x75, 0x73, 0x00, 0x72, 0x69, 0x73, 0x63, 0x76, 0x2c, 0x69, 0x73,
-	0x61, 0x00, 0x23, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x72, 0x75, 0x70, 0x74,
-	0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x69, 0x6e, 0x74, 0x65, 0x72,
-	0x72, 0x75, 0x70, 0x74, 0x2d, 0x63, 0x6f, 0x6e, 0x74, 0x72, 0x6f, 0x6c,
-	0x6c, 0x65, 0x72, 0x00, 0x72, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x00, 0x6c,
-	0x6f, 0x63, 0x61, 0x6c, 0x2d, 0x6d, 0x61, 0x63, 0x2d, 0x61, 0x64, 0x64,
-	0x72, 0x65, 0x73, 0x73, 0x00, 0x70, 0x68, 0x79, 0x2d, 0x68, 0x61, 0x6e,
-	0x64, 0x6c, 0x65, 0x00, 0x70, 0x68, 0x79, 0x2d, 0x6d, 0x6f, 0x64, 0x65,
-	0x00, 0x72, 0x65, 0x67, 0x2d, 0x6e, 0x61, 0x6d, 0x65, 0x73, 0x00, 0x6d,
-	0x61, 0x78, 0x2d, 0x73, 0x70, 0x65, 0x65, 0x64, 0x00
+	0x00, 0x00, 0x00, 0x09, 0x23, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73,
+	0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x23, 0x73, 0x69, 0x7a, 0x65,
+	0x2d, 0x63, 0x65, 0x6c, 0x6c, 0x73, 0x00, 0x63, 0x6f, 0x6d, 0x70, 0x61,
+	0x74, 0x69, 0x62, 0x6c, 0x65, 0x00, 0x6d, 0x6f, 0x64, 0x65, 0x6c, 0x00,
+	0x73, 0x74, 0x64, 0x6f, 0x75, 0x74, 0x2d, 0x70, 0x61, 0x74, 0x68, 0x00,
+	0x73, 0x65, 0x72, 0x69, 0x61, 0x6c, 0x30, 0x00, 0x65, 0x74, 0x68, 0x65,
+	0x72, 0x6e, 0x65, 0x74, 0x30, 0x00, 0x74, 0x69, 0x6d, 0x65, 0x62, 0x61,
+	0x73, 0x65, 0x2d, 0x66, 0x72, 0x65, 0x71, 0x75, 0x65, 0x6e, 0x63, 0x79,
+	0x00, 0x64, 0x65, 0x76, 0x69, 0x63, 0x65, 0x5f, 0x74, 0x79, 0x70, 0x65,
+	0x00, 0x72, 0x65, 0x67, 0x00, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x00,
+	0x72, 0x69, 0x73, 0x63, 0x76, 0x2c, 0x69, 0x73, 0x61, 0x00, 0x23, 0x69,
+	0x6e, 0x74, 0x65, 0x72, 0x72, 0x75, 0x70, 0x74, 0x2d, 0x63, 0x65, 0x6c,
+	0x6c, 0x73, 0x00, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x72, 0x75, 0x70, 0x74,
+	0x2d, 0x63, 0x6f, 0x6e, 0x74, 0x72, 0x6f, 0x6c, 0x6c, 0x65, 0x72, 0x00,
+	0x6c, 0x69, 0x6e, 0x75, 0x78, 0x2c, 0x70, 0x68, 0x61, 0x6e, 0x64, 0x6c,
+	0x65, 0x00, 0x72, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x00, 0x6c, 0x6f, 0x63,
+	0x61, 0x6c, 0x2d, 0x6d, 0x61, 0x63, 0x2d, 0x61, 0x64, 0x64, 0x72, 0x65,
+	0x73, 0x73, 0x00, 0x70, 0x68, 0x79, 0x2d, 0x68, 0x61, 0x6e, 0x64, 0x6c,
+	0x65, 0x00, 0x70, 0x68, 0x79, 0x2d, 0x6d, 0x6f, 0x64, 0x65, 0x00, 0x72,
+	0x65, 0x67, 0x2d, 0x6e, 0x61, 0x6d, 0x65, 0x73, 0x00, 0x6d, 0x61, 0x78,
+	0x2d, 0x73, 0x70, 0x65, 0x65, 0x64, 0x00
 };
 
 /**
@@ -257,6 +261,15 @@ static void fdt_test_exec ( void ) {
 	ok ( ( string = fdt_string ( &fdt, offset, "phy-mode" ) ) != NULL );
 	ok ( strcmp ( string, "gmii" ) == 0 );
 
+	/* Verify phandle lookup */
+	ok ( fdt_phandle ( &fdt, 0x03, &offset ) == 0 );
+	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
+	ok ( strcmp ( desc.name, "interrupt-controller" ) == 0 );
+	ok ( fdt_phandle ( &fdt, 0x08, &offset ) == 0 );
+	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
+	ok ( strcmp ( desc.name, "ethernet-phy@0" ) == 0 );
+	ok ( fdt_phandle ( &fdt, 0x2a, &offset ) != 0 );
+
 	/* Verify node description */
 	ok ( fdt_path ( &fdt, "/memory@80000000", &offset ) == 0 );
 	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
-- 
cgit v1.2.3-55-g7522


From be551d420e6c839d5059290f563fb5b1fe46c6bb Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 30 Jul 2025 13:40:36 +0100
Subject: [serial] Explicitly initialise serial console UART to NULL

When debugging is enabled for the device tree or memory map parsing
code, the active serial console UART variable will be accessed during
early initialisation, before the .bss section has been zeroed.

Place this variable in the .data section (by providing an explicit
initialiser), so that reading this variable is well defined even
during early initialisation.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/serial.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'src/core')

diff --git a/src/core/serial.c b/src/core/serial.c
index 0883ad051..f3b33cd90 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -61,8 +61,12 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define COMSPEED 0
 #endif
 
-/** Active serial console UART */
-struct uart *serial_console;
+/** Active serial console UART
+ *
+ * Explicitly initialised to @c NULL since this variable may be
+ * accessed before .bss has been zeroed.
+ */
+struct uart *serial_console = NULL;
 
 /**
  * Get fixed serial console UART
-- 
cgit v1.2.3-55-g7522


From 5f10b7455547fc563caab58f8941111346346433 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Mon, 4 Aug 2025 14:52:00 +0100
Subject: [fdt] Use phandle as device location

Consumption of phandles will be in the form of locating a functional
device (e.g. a GPIO device, or an I2C device, or a reset controller)
by phandle, rather than locating the device tree node to which the
phandle refers.

Repurpose fdt_phandle() to obtain the phandle value (instead of
searching by phandle), and record this value as the bus location
within the generic device structure.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c            | 73 ++++++++++++++---------------------------------
 src/drivers/bus/devtree.c |  1 +
 src/include/ipxe/fdt.h    |  3 +-
 src/tests/fdt_test.c      | 19 ++++++------
 4 files changed, 34 insertions(+), 62 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index 6989690bf..ae723213b 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -482,57 +482,6 @@ int fdt_alias ( struct fdt *fdt, const char *name, unsigned int *offset ) {
 	return 0;
 }
 
-/**
- * Find node by package handle (phandle)
- *
- * @v fdt		Device tree
- * @v phandle		Package handle
- * @v offset		Offset to fill in
- * @ret rc		Return status code
- */
-int fdt_phandle ( struct fdt *fdt, uint32_t phandle, unsigned int *offset ) {
-	struct fdt_descriptor desc;
-	uint32_t value;
-	int depth;
-	int rc;
-
-	/* Initialise offset */
-	*offset = 0;
-
-	/* Find node with matching phandle */
-	for ( depth = -1 ; ; depth += desc.depth, *offset = desc.next ) {
-
-		/* Describe token */
-		if ( ( rc = fdt_describe ( fdt, *offset, &desc ) ) != 0 ) {
-			DBGC ( fdt, "FDT +%#04x has malformed node: %s\n",
-			       *offset, strerror ( rc ) );
-			return rc;
-		}
-
-		/* Terminate when we exit the root node */
-		if ( ( depth == 0 ) && ( desc.depth < 0 ) )
-			break;
-
-		/* Ignore non-nodes */
-		if ( ( ! desc.name ) || desc.data )
-			continue;
-
-		/* Check for matching "phandle" or "linux-phandle" property */
-		if ( ( ( ( rc = fdt_u32 ( fdt, *offset, "phandle",
-					  &value ) ) == 0 ) ||
-		       ( ( rc = fdt_u32 ( fdt, *offset, "linux,phandle",
-					  &value ) ) == 0 ) ) &&
-		     ( value == phandle ) ) {
-			DBGC2 ( fdt, "FDT +%#04x has phandle %#02x\n",
-				*offset, phandle );
-			return 0;
-		}
-	}
-
-	DBGC ( fdt, "FDT has no phandle %#02x\n", phandle );
-	return -ENOENT;
-}
-
 /**
  * Find property
  *
@@ -730,6 +679,28 @@ int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
 	return 0;
 }
 
+/**
+ * Get package handle (phandle) property
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @ret phandle		Package handle, or 0 on error
+ */
+uint32_t fdt_phandle ( struct fdt *fdt, unsigned int offset ) {
+	uint32_t phandle;
+	int rc;
+
+	/* Get "phandle" or "linux,phandle" property */
+	if ( ( ( rc = fdt_u32 ( fdt, offset, "phandle", &phandle ) ) == 0 ) ||
+	     ( ( rc = fdt_u32 ( fdt, offset, "linux,phandle",
+				&phandle ) ) == 0 ) ) {
+		assert ( phandle != 0 );
+		return phandle;
+	}
+
+	return 0;
+}
+
 /**
  * Get region cell size specification
  *
diff --git a/src/drivers/bus/devtree.c b/src/drivers/bus/devtree.c
index 59bbc9bf7..cd5bb09a0 100644
--- a/src/drivers/bus/devtree.c
+++ b/src/drivers/bus/devtree.c
@@ -219,6 +219,7 @@ int dt_probe_node ( struct device *parent, unsigned int offset ) {
 	dt->name = dt->dev.name;
 	snprintf ( dt->dev.name, sizeof ( dt->dev.name ), "%s", name );
 	dt->dev.desc.bus_type = BUS_TYPE_DT;
+	dt->dev.desc.location = fdt_phandle ( &sysfdt, offset );
 	dt->dev.parent = parent;
 	INIT_LIST_HEAD ( &dt->dev.children );
 	list_add_tail ( &dt->dev.siblings, &parent->children );
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index c73389ad7..eec02c5b3 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -176,8 +176,6 @@ extern int fdt_path ( struct fdt *fdt, const char *path,
 		      unsigned int *offset );
 extern int fdt_alias ( struct fdt *fdt, const char *name,
 		       unsigned int *offset );
-extern int fdt_phandle ( struct fdt *fdt, uint32_t phandle,
-			 unsigned int *offset );
 extern const char * fdt_strings ( struct fdt *fdt, unsigned int offset,
 				  const char *name, unsigned int *count );
 extern const char * fdt_string ( struct fdt *fdt, unsigned int offset,
@@ -189,6 +187,7 @@ extern int fdt_u64 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint64_t *value );
 extern int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
 		     uint32_t *value );
+extern uint32_t fdt_phandle ( struct fdt *fdt, unsigned int offset );
 extern void fdt_reg_cells ( struct fdt *fdt, unsigned int offset,
 			    struct fdt_reg_cells *regs );
 extern int fdt_reg_count ( struct fdt *fdt, unsigned int offset,
diff --git a/src/tests/fdt_test.c b/src/tests/fdt_test.c
index 099a093b4..07f7e8911 100644
--- a/src/tests/fdt_test.c
+++ b/src/tests/fdt_test.c
@@ -237,6 +237,16 @@ static void fdt_test_exec ( void ) {
 	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000", &offset ) == 0 );
 	ok ( fdt_u32 ( &fdt, offset, "max-speed", &u32 ) != 0 );
 
+	/* Verify phandle properties */
+	ok ( fdt_path ( &fdt, "/cpus/cpu@0/interrupt-controller",
+			&offset ) == 0 );
+	ok ( fdt_phandle ( &fdt, offset ) == 0x03 );
+	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000/ethernet-phy@0",
+			&offset ) == 0 );
+	ok ( fdt_phandle ( &fdt, offset ) == 0x08 );
+	ok ( fdt_path ( &fdt, "/soc/serial@10010000", &offset ) == 0 );
+	ok ( fdt_phandle ( &fdt, offset ) == 0 );
+
 	/* Verify cell properties */
 	ok ( fdt_path ( &fdt, "/soc/ethernet@10090000", &offset ) == 0 );
 	ok ( fdt_cells ( &fdt, offset, "reg", 4, 2, &u64 ) == 0 );
@@ -261,15 +271,6 @@ static void fdt_test_exec ( void ) {
 	ok ( ( string = fdt_string ( &fdt, offset, "phy-mode" ) ) != NULL );
 	ok ( strcmp ( string, "gmii" ) == 0 );
 
-	/* Verify phandle lookup */
-	ok ( fdt_phandle ( &fdt, 0x03, &offset ) == 0 );
-	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
-	ok ( strcmp ( desc.name, "interrupt-controller" ) == 0 );
-	ok ( fdt_phandle ( &fdt, 0x08, &offset ) == 0 );
-	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
-	ok ( strcmp ( desc.name, "ethernet-phy@0" ) == 0 );
-	ok ( fdt_phandle ( &fdt, 0x2a, &offset ) != 0 );
-
 	/* Verify node description */
 	ok ( fdt_path ( &fdt, "/memory@80000000", &offset ) == 0 );
 	ok ( fdt_describe ( &fdt, offset, &desc ) == 0 );
-- 
cgit v1.2.3-55-g7522


From 90fe3a2924962af6cc35023f6eb68bc43318ab21 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 5 Aug 2025 13:54:27 +0100
Subject: [gpio] Add a framework for GPIO controllers

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/gpio.c            | 165 +++++++++++++++++++++++++++++++++++++
 src/include/ipxe/errfile.h |   1 +
 src/include/ipxe/gpio.h    | 199 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 365 insertions(+)
 create mode 100644 src/core/gpio.c
 create mode 100644 src/include/ipxe/gpio.h

(limited to 'src/core')

diff --git a/src/core/gpio.c b/src/core/gpio.c
new file mode 100644
index 000000000..f57139a11
--- /dev/null
+++ b/src/core/gpio.c
@@ -0,0 +1,165 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdlib.h>
+#include <errno.h>
+#include <ipxe/gpio.h>
+
+/** @file
+ *
+ * General purpose I/O
+ *
+ */
+
+/** List of GPIO controllers */
+static LIST_HEAD ( all_gpios );
+
+/**
+ * Allocate GPIO controller
+ *
+ * @v count		Number of GPIO pins
+ * @v priv_len		Size of driver-private data
+ * @ret gpios		GPIO controller, or NULL
+ */
+struct gpios * alloc_gpios ( unsigned int count, size_t priv_len ) {
+	struct gpios *gpios;
+	struct gpio *gpio;
+	size_t len;
+	unsigned int i;
+
+	/* Allocate and initialise structure */
+	len = ( sizeof ( *gpios ) + ( count * sizeof ( *gpio ) ) + priv_len );
+	gpios = zalloc ( len );
+	if ( ! gpios )
+		return NULL;
+	gpios->count = count;
+	gpios->gpio = ( ( ( void * ) gpios ) + sizeof ( *gpios ) );
+	gpios->priv = ( ( ( void * ) gpios ) + sizeof ( *gpios ) +
+			( count * sizeof ( *gpio ) ) );
+
+	/* Initialise GPIO pins */
+	for ( i = 0 ; i < count ; i++ ) {
+		gpio = &gpios->gpio[i];
+		gpio->gpios = gpios;
+		gpio->index = i;
+	}
+
+	return gpios;
+}
+
+/**
+ * Register GPIO controller
+ *
+ * @v gpios		GPIO controller
+ * @ret rc		Return status code
+ */
+int gpios_register ( struct gpios *gpios ) {
+
+	/* Add to list of GPIO controllers */
+	gpios_get ( gpios );
+	list_add_tail ( &gpios->list, &all_gpios );
+	DBGC ( gpios, "GPIO %s registered with %d GPIOs\n",
+	       gpios->dev->name, gpios->count );
+
+	return 0;
+}
+
+/**
+ * Unregister GPIO controller
+ *
+ * @v gpios		GPIO controller
+ */
+void gpios_unregister ( struct gpios *gpios ) {
+
+	/* Remove from list of GPIO controllers */
+	DBGC ( gpios, "GPIO %s unregistered\n", gpios->dev->name );
+	list_del ( &gpios->list );
+	gpios_put ( gpios );
+}
+
+/**
+ * Find GPIO controller
+ *
+ * @v bus_type		Bus type
+ * @v location		Bus location
+ * @ret gpios		GPIO controller, or NULL
+ */
+struct gpios * gpios_find ( unsigned int bus_type, unsigned int location ) {
+	struct gpios *gpios;
+
+	/* Scan through list of registered GPIO controllers */
+	list_for_each_entry ( gpios, &all_gpios, list ) {
+		if ( ( gpios->dev->desc.bus_type == bus_type ) &&
+		     ( gpios->dev->desc.location == location ) )
+			return gpios;
+	}
+
+	return NULL;
+}
+
+/**
+ * Get null GPIO input value
+ *
+ * @v gpios		GPIO controller
+ * @v gpio		GPIO pin
+ * @ret active		Pin is in the active state
+ */
+static int null_gpio_in ( struct gpios *gpios __unused,
+			  struct gpio *gpio __unused ) {
+	return 0;
+}
+
+/**
+ * Set null GPIO output value
+ *
+ * @v gpios		GPIO controller
+ * @v gpio		GPIO pin
+ * @v active		Set pin to active state
+ */
+static void null_gpio_out ( struct gpios *gpios __unused,
+			    struct gpio *gpio __unused, int active __unused ) {
+	/* Nothing to do */
+}
+
+/**
+ * Configure null GPIO pin
+ *
+ * @v gpios		GPIO controller
+ * @v gpio		GPIO pin
+ * @v config		Configuration
+ * @ret rc		Return status code
+ */
+static int null_gpio_config ( struct gpios *gpios __unused,
+			      struct gpio *gpio __unused,
+			      unsigned int config __unused ) {
+	return -ENODEV;
+}
+
+/** Null GPIO operations */
+struct gpio_operations null_gpio_operations = {
+	.in = null_gpio_in,
+	.out = null_gpio_out,
+	.config = null_gpio_config,
+};
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index 7db8d5679..b99d2101e 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -87,6 +87,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define ERRFILE_efi_open	       ( ERRFILE_CORE | 0x002f0000 )
 #define ERRFILE_efi_table	       ( ERRFILE_CORE | 0x00300000 )
 #define ERRFILE_efi_connect	       ( ERRFILE_CORE | 0x00310000 )
+#define ERRFILE_gpio		       ( ERRFILE_CORE | 0x00320000 )
 
 #define ERRFILE_eisa		     ( ERRFILE_DRIVER | 0x00000000 )
 #define ERRFILE_isa		     ( ERRFILE_DRIVER | 0x00010000 )
diff --git a/src/include/ipxe/gpio.h b/src/include/ipxe/gpio.h
new file mode 100644
index 000000000..fa9e19089
--- /dev/null
+++ b/src/include/ipxe/gpio.h
@@ -0,0 +1,199 @@
+#ifndef _IPXE_GPIO_H
+#define _IPXE_GPIO_H
+
+/** @file
+ *
+ * General purpose I/O
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <ipxe/list.h>
+#include <ipxe/refcnt.h>
+#include <ipxe/device.h>
+
+/** A GPIO pin */
+struct gpio {
+	/** GPIO controller */
+	struct gpios *gpios;
+	/** Pin index */
+	unsigned int index;
+	/** Configuration */
+	unsigned int config;
+};
+
+/** GPIO is active low
+ *
+ * This bit is chosen to match the devicetree standard usage.
+ */
+#define GPIO_CFG_ACTIVE_LOW 0x01
+
+/** GPIO is an output */
+#define GPIO_CFG_OUTPUT 0x0100
+
+/** A GPIO controller */
+struct gpios {
+	/** Reference count */
+	struct refcnt refcnt;
+	/** List of GPIO controllers */
+	struct list_head list;
+	/** Generic device */
+	struct device *dev;
+	/** Number of GPIOs */
+	unsigned int count;
+
+	/** Individual GPIOs */
+	struct gpio *gpio;
+	/** GPIO operations */
+	struct gpio_operations *op;
+
+	/** Driver-private data */
+	void *priv;
+};
+
+/** GPIO operations */
+struct gpio_operations {
+	/**
+	 * Get current GPIO input value
+	 *
+	 * @v gpios		GPIO controller
+	 * @v gpio		GPIO pin
+	 * @ret active		Pin is in the active state
+	 */
+	int ( * in ) ( struct gpios *gpios, struct gpio *gpio );
+	/**
+	 * Set current GPIO output value
+	 *
+	 * @v gpios		GPIO controller
+	 * @v gpio		GPIO pin
+	 * @v active		Set pin to active state
+	 */
+	void ( * out ) ( struct gpios *gpios, struct gpio *gpio, int active );
+	/**
+	 * Configure GPIO pin
+	 *
+	 * @v gpios		GPIO controller
+	 * @v gpio		GPIO pin
+	 * @v config		Configuration
+	 * @ret rc		Return status code
+	 */
+	int ( * config ) ( struct gpios *gpios, struct gpio *gpio,
+			   unsigned int config );
+};
+
+extern struct gpio_operations null_gpio_operations;
+
+/**
+ * Get reference to GPIO controller
+ *
+ * @v gpios		GPIO controller
+ * @ret gpios		GPIO controller
+ */
+static inline __attribute__ (( always_inline )) struct gpios *
+gpios_get ( struct gpios *gpios ) {
+	ref_get ( &gpios->refcnt );
+	return gpios;
+}
+
+/**
+ * Drop reference to GPIO controller
+ *
+ * @v gpios		GPIO controller
+ */
+static inline __attribute__ (( always_inline )) void
+gpios_put ( struct gpios *gpios ) {
+	ref_put ( &gpios->refcnt );
+}
+
+/**
+ * Get reference to GPIO pin
+ *
+ * @v gpio		GPIO pin
+ * @ret gpio		GPIO pin
+ */
+static inline __attribute__ (( always_inline )) struct gpio *
+gpio_get ( struct gpio *gpio ) {
+	gpios_get ( gpio->gpios );
+	return gpio;
+}
+
+/**
+ * Drop reference to GPIO ping
+ *
+ * @v gpio		GPIO pin
+ */
+static inline __attribute__ (( always_inline )) void
+gpio_put ( struct gpio *gpio ) {
+	gpios_put ( gpio->gpios );
+}
+
+/**
+ * Initialise a GPIO controller
+ *
+ * @v gpios		GPIO controller
+ * @v op		GPIO operations
+ */
+static inline __attribute__ (( always_inline )) void
+gpios_init ( struct gpios *gpios, struct gpio_operations *op ) {
+	gpios->op = op;
+}
+
+/**
+ * Stop using a GPIO controller
+ *
+ * @v gpios		GPIO controller
+ *
+ * Drivers should call this method immediately before the final call
+ * to gpios_put().
+ */
+static inline __attribute__ (( always_inline )) void
+gpios_nullify ( struct gpios *gpios ) {
+	gpios->op = &null_gpio_operations;
+}
+
+/**
+ * Get current GPIO input value
+ *
+ * @v gpio		GPIO pin
+ * @ret active		Pin is in the active state
+ */
+static inline int gpio_in ( struct gpio *gpio ) {
+	struct gpios *gpios = gpio->gpios;
+
+	return gpios->op->in ( gpios, gpio );
+}
+
+/**
+ * Set current GPIO output value
+ *
+ * @v gpio		GPIO pin
+ * @v active		Set pin to active state
+ */
+static inline void gpio_out ( struct gpio *gpio, int active ) {
+	struct gpios *gpios = gpio->gpios;
+
+	gpios->op->out ( gpios, gpio, active );
+}
+
+/**
+ * Configure GPIO pin
+ *
+ * @v gpio		GPIO pin
+ * @v config		Configuration
+ * @ret rc		Return status code
+ */
+static inline int gpio_config ( struct gpio *gpio, unsigned int config ) {
+	struct gpios *gpios = gpio->gpios;
+
+	return gpios->op->config ( gpios, gpio, config );
+}
+
+extern struct gpios * alloc_gpios ( unsigned int count, size_t priv_len );
+extern int gpios_register ( struct gpios *gpios );
+extern void gpios_unregister ( struct gpios *gpios );
+extern struct gpios * gpios_find ( unsigned int bus_type,
+				   unsigned int location );
+
+#endif /* _IPXE_GPIO_H */
-- 
cgit v1.2.3-55-g7522


From 9d4a2ee3538f28a21a77c55c272c84b4e346dd92 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 6 Aug 2025 16:29:32 +0100
Subject: [cmdline] Show commands in alphabetical order

Commands were originally ordered by functional group (e.g. keeping the
image management commands together), with arrays used to impose a
functionally meaningful order within the group.

As the number of commands and functional groups has expanded over the
years, this has become essentially useless as an organising principle.
Switch to sorting commands alphabetically (using the linker table
mechanism).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/hci/commands/cpuid_cmd.c |  5 +--
 src/arch/x86/hci/commands/pxe_cmd.c   | 12 +-----
 src/core/exec.c                       | 25 +++----------
 src/crypto/mishmash/cmd_md4.c         |  5 +--
 src/crypto/mishmash/cmd_sha224.c      |  5 +--
 src/crypto/mishmash/cmd_sha256.c      |  5 +--
 src/crypto/mishmash/cmd_sha384.c      |  5 +--
 src/crypto/mishmash/cmd_sha512.c      |  5 +--
 src/hci/commands/autoboot_cmd.c       |  7 +---
 src/hci/commands/cert_cmd.c           | 17 ++-------
 src/hci/commands/config_cmd.c         |  5 +--
 src/hci/commands/console_cmd.c        | 17 ++-------
 src/hci/commands/dhcp_cmd.c           | 12 +-----
 src/hci/commands/digest_cmd.c         | 11 +-----
 src/hci/commands/dynui_cmd.c          | 27 +++-----------
 src/hci/commands/fcmgmt_cmd.c         | 12 +-----
 src/hci/commands/fdt_cmd.c            |  7 +---
 src/hci/commands/gdbstub_cmd.c        |  7 +---
 src/hci/commands/ibmgmt_cmd.c         |  7 +---
 src/hci/commands/ifmgmt_cmd.c         | 27 +++-----------
 src/hci/commands/image_archive_cmd.c  |  7 +---
 src/hci/commands/image_cmd.c          | 70 ++++++++++-------------------------
 src/hci/commands/image_crypt_cmd.c    |  7 +---
 src/hci/commands/image_mem_cmd.c      |  7 +---
 src/hci/commands/image_trust_cmd.c    | 12 +-----
 src/hci/commands/ipstat_cmd.c         |  7 +---
 src/hci/commands/iwmgmt_cmd.c         | 12 +-----
 src/hci/commands/login_cmd.c          |  5 +--
 src/hci/commands/lotest_cmd.c         |  5 +--
 src/hci/commands/neighbour_cmd.c      |  7 +---
 src/hci/commands/nslookup_cmd.c       |  5 +--
 src/hci/commands/ntp_cmd.c            |  5 +--
 src/hci/commands/nvo_cmd.c            | 27 +++-----------
 src/hci/commands/param_cmd.c          | 12 +-----
 src/hci/commands/pci_cmd.c            |  7 +---
 src/hci/commands/ping_cmd.c           |  5 +--
 src/hci/commands/poweroff_cmd.c       |  5 +--
 src/hci/commands/profstat_cmd.c       |  7 +---
 src/hci/commands/reboot_cmd.c         |  5 +--
 src/hci/commands/route_cmd.c          |  7 +---
 src/hci/commands/sanboot_cmd.c        | 17 ++-------
 src/hci/commands/shim_cmd.c           |  7 +---
 src/hci/commands/sync_cmd.c           |  5 +--
 src/hci/commands/time_cmd.c           |  5 +--
 src/hci/commands/usb_cmd.c            |  7 +---
 src/hci/commands/vlan_cmd.c           | 12 +-----
 src/hci/shell.c                       | 10 +----
 src/image/script.c                    | 10 +----
 src/include/ipxe/command.h            |  7 +++-
 49 files changed, 104 insertions(+), 423 deletions(-)

(limited to 'src/core')

diff --git a/src/arch/x86/hci/commands/cpuid_cmd.c b/src/arch/x86/hci/commands/cpuid_cmd.c
index d73ce2a3e..b1978d5f2 100644
--- a/src/arch/x86/hci/commands/cpuid_cmd.c
+++ b/src/arch/x86/hci/commands/cpuid_cmd.c
@@ -95,7 +95,4 @@ static int cpuid_exec ( int argc, char **argv ) {
 }
 
 /** x86 CPU feature detection command */
-struct command cpuid_command __command = {
-	.name = "cpuid",
-	.exec = cpuid_exec,
-};
+COMMAND ( cpuid, cpuid_exec );
diff --git a/src/arch/x86/hci/commands/pxe_cmd.c b/src/arch/x86/hci/commands/pxe_cmd.c
index 473b97f97..cf1a36ed6 100644
--- a/src/arch/x86/hci/commands/pxe_cmd.c
+++ b/src/arch/x86/hci/commands/pxe_cmd.c
@@ -105,13 +105,5 @@ static int stoppxe_exec ( int argc __unused, char **argv __unused ) {
 }
 
 /** PXE commands */
-struct command pxe_commands[] __command = {
-	{
-		.name = "startpxe",
-		.exec = startpxe_exec,
-	},
-	{
-		.name = "stoppxe",
-		.exec = stoppxe_exec,
-	},
-};
+COMMAND ( startpxe, startpxe_exec );
+COMMAND ( stoppxe, stoppxe_exec );
diff --git a/src/core/exec.c b/src/core/exec.c
index a13884b68..534fb9993 100644
--- a/src/core/exec.c
+++ b/src/core/exec.c
@@ -428,10 +428,7 @@ static int echo_exec ( int argc, char **argv ) {
 }
 
 /** "echo" command */
-struct command echo_command __command = {
-	.name = "echo",
-	.exec = echo_exec,
-};
+COMMAND ( echo, echo_exec );
 
 /** "exit" options */
 struct exit_options {};
@@ -472,10 +469,7 @@ static int exit_exec ( int argc, char **argv ) {
 }
 
 /** "exit" command */
-struct command exit_command __command = {
-	.name = "exit",
-	.exec = exit_exec,
-};
+COMMAND ( exit, exit_exec );
 
 /** "isset" options */
 struct isset_options {};
@@ -507,10 +501,7 @@ static int isset_exec ( int argc, char **argv ) {
 }
 
 /** "isset" command */
-struct command isset_command __command = {
-	.name = "isset",
-	.exec = isset_exec,
-};
+COMMAND ( isset, isset_exec );
 
 /** "iseq" options */
 struct iseq_options {};
@@ -544,10 +535,7 @@ static int iseq_exec ( int argc, char **argv ) {
 }
 
 /** "iseq" command */
-struct command iseq_command __command = {
-	.name = "iseq",
-	.exec = iseq_exec,
-};
+COMMAND ( iseq, iseq_exec );
 
 /** "sleep" options */
 struct sleep_options {};
@@ -587,7 +575,4 @@ static int sleep_exec ( int argc, char **argv ) {
 }
 
 /** "sleep" command */
-struct command sleep_command __command = {
-	.name = "sleep",
-	.exec = sleep_exec,
-};
+COMMAND ( sleep, sleep_exec );
diff --git a/src/crypto/mishmash/cmd_md4.c b/src/crypto/mishmash/cmd_md4.c
index 6413d565a..8991b0250 100644
--- a/src/crypto/mishmash/cmd_md4.c
+++ b/src/crypto/mishmash/cmd_md4.c
@@ -30,7 +30,4 @@ static int md4sum_exec ( int argc, char **argv ) {
 	return digest_exec ( argc, argv, &md4_algorithm );
 }
 
-struct command md4sum_command __command = {
-	.name = "md4sum",
-	.exec = md4sum_exec,
-};
+COMMAND ( md4sum, md4sum_exec );
diff --git a/src/crypto/mishmash/cmd_sha224.c b/src/crypto/mishmash/cmd_sha224.c
index ffc4bf87d..3975a37c5 100644
--- a/src/crypto/mishmash/cmd_sha224.c
+++ b/src/crypto/mishmash/cmd_sha224.c
@@ -30,7 +30,4 @@ static int sha224sum_exec ( int argc, char **argv ) {
 	return digest_exec ( argc, argv, &sha224_algorithm );
 }
 
-struct command sha224sum_command __command = {
-	.name = "sha224sum",
-	.exec = sha224sum_exec,
-};
+COMMAND ( sha224sum, sha224sum_exec );
diff --git a/src/crypto/mishmash/cmd_sha256.c b/src/crypto/mishmash/cmd_sha256.c
index 918c3350b..8076e8dbf 100644
--- a/src/crypto/mishmash/cmd_sha256.c
+++ b/src/crypto/mishmash/cmd_sha256.c
@@ -30,7 +30,4 @@ static int sha256sum_exec ( int argc, char **argv ) {
 	return digest_exec ( argc, argv, &sha256_algorithm );
 }
 
-struct command sha256sum_command __command = {
-	.name = "sha256sum",
-	.exec = sha256sum_exec,
-};
+COMMAND ( sha256sum, sha256sum_exec );
diff --git a/src/crypto/mishmash/cmd_sha384.c b/src/crypto/mishmash/cmd_sha384.c
index c1c505818..ed7265ab9 100644
--- a/src/crypto/mishmash/cmd_sha384.c
+++ b/src/crypto/mishmash/cmd_sha384.c
@@ -30,7 +30,4 @@ static int sha384sum_exec ( int argc, char **argv ) {
 	return digest_exec ( argc, argv, &sha384_algorithm );
 }
 
-struct command sha384sum_command __command = {
-	.name = "sha384sum",
-	.exec = sha384sum_exec,
-};
+COMMAND ( sha384sum, sha384sum_exec );
diff --git a/src/crypto/mishmash/cmd_sha512.c b/src/crypto/mishmash/cmd_sha512.c
index 1bb8e1286..96b8ade88 100644
--- a/src/crypto/mishmash/cmd_sha512.c
+++ b/src/crypto/mishmash/cmd_sha512.c
@@ -30,7 +30,4 @@ static int sha512sum_exec ( int argc, char **argv ) {
 	return digest_exec ( argc, argv, &sha512_algorithm );
 }
 
-struct command sha512sum_command __command = {
-	.name = "sha512sum",
-	.exec = sha512sum_exec,
-};
+COMMAND ( sha512sum, sha512sum_exec );
diff --git a/src/hci/commands/autoboot_cmd.c b/src/hci/commands/autoboot_cmd.c
index 56f39a1ce..010c6fcb0 100644
--- a/src/hci/commands/autoboot_cmd.c
+++ b/src/hci/commands/autoboot_cmd.c
@@ -73,9 +73,4 @@ static int autoboot_exec ( int argc, char **argv ) {
 }
 
 /** Booting commands */
-struct command autoboot_commands[] __command = {
-	{
-		.name = "autoboot",
-		.exec = autoboot_exec,
-	},
-};
+COMMAND ( autoboot, autoboot_exec );
diff --git a/src/hci/commands/cert_cmd.c b/src/hci/commands/cert_cmd.c
index 75d2ccbed..efa4c3c12 100644
--- a/src/hci/commands/cert_cmd.c
+++ b/src/hci/commands/cert_cmd.c
@@ -289,17 +289,6 @@ static int certfree_exec ( int argc, char **argv ) {
 }
 
 /** Certificate management commands */
-struct command certmgmt_commands[] __command = {
-	{
-		.name = "certstat",
-		.exec = certstat_exec,
-	},
-	{
-		.name = "certstore",
-		.exec = certstore_exec,
-	},
-	{
-		.name = "certfree",
-		.exec = certfree_exec,
-	},
-};
+COMMAND ( certstat, certstat_exec );
+COMMAND ( certstore, certstore_exec );
+COMMAND ( certfree, certfree_exec );
diff --git a/src/hci/commands/config_cmd.c b/src/hci/commands/config_cmd.c
index ad415e045..39272196a 100644
--- a/src/hci/commands/config_cmd.c
+++ b/src/hci/commands/config_cmd.c
@@ -79,7 +79,4 @@ static int config_exec ( int argc, char **argv ) {
 }
 
 /** Configuration UI commands */
-struct command config_command __command = {
-	.name = "config",
-	.exec = config_exec,
-};
+COMMAND ( config, config_exec );
diff --git a/src/hci/commands/console_cmd.c b/src/hci/commands/console_cmd.c
index ba472b9f6..19d19ef1b 100644
--- a/src/hci/commands/console_cmd.c
+++ b/src/hci/commands/console_cmd.c
@@ -251,17 +251,6 @@ static int cpair_exec ( int argc, char **argv ) {
 }
 
 /** Console management commands */
-struct command console_commands[] __command = {
-	{
-		.name = "console",
-		.exec = console_exec,
-	},
-	{
-		.name = "colour",
-		.exec = colour_exec,
-	},
-	{
-		.name = "cpair",
-		.exec = cpair_exec,
-	},
-};
+COMMAND ( console, console_exec );
+COMMAND ( colour, colour_exec );
+COMMAND ( cpair, cpair_exec );
diff --git a/src/hci/commands/dhcp_cmd.c b/src/hci/commands/dhcp_cmd.c
index 45a922b51..33c23fc6e 100644
--- a/src/hci/commands/dhcp_cmd.c
+++ b/src/hci/commands/dhcp_cmd.c
@@ -92,13 +92,5 @@ static int pxebs_exec ( int argc, char **argv ) {
 }
 
 /** DHCP management commands */
-struct command dhcp_commands[] __command = {
-	{
-		.name = "dhcp",
-		.exec = ifconf_exec, /* synonym for "ifconf" */
-	},
-	{
-		.name = "pxebs",
-		.exec = pxebs_exec,
-	},
-};
+COMMAND ( dhcp, ifconf_exec ); /* synonym for "ifconf" */
+COMMAND ( pxebs, pxebs_exec );
diff --git a/src/hci/commands/digest_cmd.c b/src/hci/commands/digest_cmd.c
index 20d33a5d8..a7f43f69e 100644
--- a/src/hci/commands/digest_cmd.c
+++ b/src/hci/commands/digest_cmd.c
@@ -128,15 +128,8 @@ static int sha1sum_exec ( int argc, char **argv ) {
 	return digest_exec ( argc, argv, &sha1_algorithm );
 }
 
-struct command md5sum_command __command = {
-	.name = "md5sum",
-	.exec = md5sum_exec,
-};
-
-struct command sha1sum_command __command = {
-	.name = "sha1sum",
-	.exec = sha1sum_exec,
-};
+COMMAND ( md5sum, md5sum_exec );
+COMMAND ( sha1sum, sha1sum_exec );
 
 /* Drag in commands for any other enabled algorithms */
 REQUIRING_SYMBOL ( digest_exec );
diff --git a/src/hci/commands/dynui_cmd.c b/src/hci/commands/dynui_cmd.c
index 6cad63868..56a4acd06 100644
--- a/src/hci/commands/dynui_cmd.c
+++ b/src/hci/commands/dynui_cmd.c
@@ -350,25 +350,8 @@ static int present_exec ( int argc, char **argv ) {
 }
 
 /** Dynamic user interface commands */
-struct command dynui_commands[] __command = {
-	{
-		.name = "menu",
-		.exec = dynui_exec,
-	},
-	{
-		.name = "form",
-		.exec = dynui_exec,
-	},
-	{
-		.name = "item",
-		.exec = item_exec,
-	},
-	{
-		.name = "choose",
-		.exec = choose_exec,
-	},
-	{
-		.name = "present",
-		.exec = present_exec,
-	},
-};
+COMMAND ( menu, dynui_exec );
+COMMAND ( form, dynui_exec );
+COMMAND ( item, item_exec );
+COMMAND ( choose, choose_exec );
+COMMAND ( present, present_exec );
diff --git a/src/hci/commands/fcmgmt_cmd.c b/src/hci/commands/fcmgmt_cmd.c
index 97f10f4dd..c03ebb05f 100644
--- a/src/hci/commands/fcmgmt_cmd.c
+++ b/src/hci/commands/fcmgmt_cmd.c
@@ -207,13 +207,5 @@ static int fcels_exec ( int argc, char **argv ) {
 }
 
 /** Fibre Channel management commands */
-struct command fcmgmt_commands[] __command = {
-	{
-		.name = "fcstat",
-		.exec = fcstat_exec,
-	},
-	{
-		.name = "fcels",
-		.exec = fcels_exec,
-	},
-};
+COMMAND ( fcstat, fcstat_exec );
+COMMAND ( fcels, fcels_exec );
diff --git a/src/hci/commands/fdt_cmd.c b/src/hci/commands/fdt_cmd.c
index dbcbf4447..7cd39279b 100644
--- a/src/hci/commands/fdt_cmd.c
+++ b/src/hci/commands/fdt_cmd.c
@@ -88,9 +88,4 @@ static int fdt_exec ( int argc, char **argv ) {
 }
 
 /** Flattened Device Tree commands */
-struct command fdt_commands[] __command = {
-	{
-		.name = "fdt",
-		.exec = fdt_exec,
-	},
-};
+COMMAND ( fdt, fdt_exec );
diff --git a/src/hci/commands/gdbstub_cmd.c b/src/hci/commands/gdbstub_cmd.c
index c4a831e7a..ba5edde3a 100644
--- a/src/hci/commands/gdbstub_cmd.c
+++ b/src/hci/commands/gdbstub_cmd.c
@@ -107,9 +107,4 @@ static int gdbstub_exec ( int argc, char **argv ) {
 }
 
 /** GDB stub commands */
-struct command gdbstub_commands[] __command = {
-	{
-		.name = "gdbstub",
-		.exec = gdbstub_exec,
-	},
-};
+COMMAND ( gdbstub, gdbstub_exec );
diff --git a/src/hci/commands/ibmgmt_cmd.c b/src/hci/commands/ibmgmt_cmd.c
index 1154d749e..be8b58cc2 100644
--- a/src/hci/commands/ibmgmt_cmd.c
+++ b/src/hci/commands/ibmgmt_cmd.c
@@ -71,9 +71,4 @@ static int ibstat_exec ( int argc, char **argv ) {
 }
 
 /** Infiniband commands */
-struct command ibmgmt_commands[] __command = {
-	{
-		.name = "ibstat",
-		.exec = ibstat_exec,
-	},
-};
+COMMAND ( ibstat, ibstat_exec );
diff --git a/src/hci/commands/ifmgmt_cmd.c b/src/hci/commands/ifmgmt_cmd.c
index 591cb3da8..2906d1d45 100644
--- a/src/hci/commands/ifmgmt_cmd.c
+++ b/src/hci/commands/ifmgmt_cmd.c
@@ -303,25 +303,8 @@ static int iflinkwait_exec ( int argc, char **argv ) {
 }
 
 /** Interface management commands */
-struct command ifmgmt_commands[] __command = {
-	{
-		.name = "ifopen",
-		.exec = ifopen_exec,
-	},
-	{
-		.name = "ifclose",
-		.exec = ifclose_exec,
-	},
-	{
-		.name = "ifstat",
-		.exec = ifstat_exec,
-	},
-	{
-		.name = "ifconf",
-		.exec = ifconf_exec,
-	},
-	{
-		.name = "iflinkwait",
-		.exec = iflinkwait_exec,
-	},
-};
+COMMAND ( ifopen, ifopen_exec );
+COMMAND ( ifclose, ifclose_exec );
+COMMAND ( ifstat, ifstat_exec );
+COMMAND ( ifconf, ifconf_exec );
+COMMAND ( iflinkwait, iflinkwait_exec );
diff --git a/src/hci/commands/image_archive_cmd.c b/src/hci/commands/image_archive_cmd.c
index a2212aecf..6b907830e 100644
--- a/src/hci/commands/image_archive_cmd.c
+++ b/src/hci/commands/image_archive_cmd.c
@@ -97,9 +97,4 @@ static int imgextract_exec ( int argc, char **argv ) {
 }
 
 /** Archive image commands */
-struct command image_archive_commands[] __command = {
-	{
-		.name = "imgextract",
-		.exec = imgextract_exec,
-	},
-};
+COMMAND ( imgextract, imgextract_exec );
diff --git a/src/hci/commands/image_cmd.c b/src/hci/commands/image_cmd.c
index 4b42695c4..179256862 100644
--- a/src/hci/commands/image_cmd.c
+++ b/src/hci/commands/image_cmd.c
@@ -393,54 +393,22 @@ static int imgfree_exec ( int argc, char **argv ) {
 	return imgmulti_exec ( argc, argv, unregister_image );
 }
 
-/** Image management commands */
-struct command image_commands[] __command = {
-	{
-		.name = "imgfetch",
-		.exec = imgfetch_exec,
-	},
-	{
-		.name = "module",
-		.exec = imgfetch_exec, /* synonym for "imgfetch" */
-	},
-	{
-		.name = "initrd",
-		.exec = imgfetch_exec, /* synonym for "imgfetch" */
-	},
-	{
-		.name = "kernel",
-		.exec = imgselect_exec, /* synonym for "imgselect" */
-	},
-	{
-		.name = "chain",
-		.exec = imgexec_exec, /* synonym for "imgexec" */
-	},
-	{
-		.name = "imgselect",
-		.exec = imgselect_exec,
-	},
-	{
-		.name = "imgload",
-		.exec = imgselect_exec, /* synonym for "imgselect" */
-	},
-	{
-		.name = "imgargs",
-		.exec = imgargs_exec,
-	},
-	{
-		.name = "imgexec",
-		.exec = imgexec_exec,
-	},
-	{
-		.name = "boot", /* synonym for "imgexec" */
-		.exec = imgexec_exec,
-	},
-	{
-		.name = "imgstat",
-		.exec = imgstat_exec,
-	},
-	{
-		.name = "imgfree",
-		.exec = imgfree_exec,
-	},
-};
+/* "imgfetch" and synonyms */
+COMMAND ( imgfetch, imgfetch_exec );
+COMMAND ( module, imgfetch_exec );
+COMMAND ( initrd, imgfetch_exec );
+
+/* "imgselect" and synonyms */
+COMMAND ( imgselect, imgselect_exec );
+COMMAND ( imgload, imgselect_exec );
+COMMAND ( kernel, imgselect_exec );
+
+/* "imgexec" and synonyms */
+COMMAND ( imgexec, imgexec_exec );
+COMMAND ( chain, imgexec_exec );
+COMMAND ( boot, imgexec_exec );
+
+/* Other image management commands */
+COMMAND ( imgargs, imgargs_exec );
+COMMAND ( imgstat, imgstat_exec );
+COMMAND ( imgfree, imgfree_exec );
diff --git a/src/hci/commands/image_crypt_cmd.c b/src/hci/commands/image_crypt_cmd.c
index 4dfb5b131..54568cc28 100644
--- a/src/hci/commands/image_crypt_cmd.c
+++ b/src/hci/commands/image_crypt_cmd.c
@@ -117,9 +117,4 @@ static int imgdecrypt_exec ( int argc, char **argv ) {
 }
 
 /** Image encryption management commands */
-struct command image_crypt_commands[] __command = {
-	{
-		.name = "imgdecrypt",
-		.exec = imgdecrypt_exec,
-	},
-};
+COMMAND ( imgdecrypt, imgdecrypt_exec );
diff --git a/src/hci/commands/image_mem_cmd.c b/src/hci/commands/image_mem_cmd.c
index fcd766627..60c0bf92a 100644
--- a/src/hci/commands/image_mem_cmd.c
+++ b/src/hci/commands/image_mem_cmd.c
@@ -89,9 +89,4 @@ static int imgmem_exec ( int argc, char **argv ) {
 }
 
 /** Read memory command */
-struct command imgmem_commands[] __command = {
-	{
-		.name = "imgmem",
-		.exec = imgmem_exec,
-	},
-};
+COMMAND ( imgmem, imgmem_exec );
diff --git a/src/hci/commands/image_trust_cmd.c b/src/hci/commands/image_trust_cmd.c
index 9b9e3f859..314aa0998 100644
--- a/src/hci/commands/image_trust_cmd.c
+++ b/src/hci/commands/image_trust_cmd.c
@@ -163,13 +163,5 @@ static int imgverify_exec ( int argc, char **argv ) {
 }
 
 /** Image trust management commands */
-struct command image_trust_commands[] __command = {
-	{
-		.name = "imgtrust",
-		.exec = imgtrust_exec,
-	},
-	{
-		.name = "imgverify",
-		.exec = imgverify_exec,
-	},
-};
+COMMAND ( imgtrust, imgtrust_exec );
+COMMAND ( imgverify, imgverify_exec );
diff --git a/src/hci/commands/ipstat_cmd.c b/src/hci/commands/ipstat_cmd.c
index 763e4dfd6..488016e3a 100644
--- a/src/hci/commands/ipstat_cmd.c
+++ b/src/hci/commands/ipstat_cmd.c
@@ -66,9 +66,4 @@ static int ipstat_exec ( int argc, char **argv ) {
 }
 
 /** Routing table management commands */
-struct command ipstat_commands[] __command = {
-	{
-		.name = "ipstat",
-		.exec = ipstat_exec,
-	},
-};
+COMMAND ( ipstat, ipstat_exec );
diff --git a/src/hci/commands/iwmgmt_cmd.c b/src/hci/commands/iwmgmt_cmd.c
index b61ee8c7b..b430353d9 100644
--- a/src/hci/commands/iwmgmt_cmd.c
+++ b/src/hci/commands/iwmgmt_cmd.c
@@ -113,13 +113,5 @@ static int iwlist_exec ( int argc, char **argv ) {
 }
 
 /** Wireless interface management commands */
-struct command iwmgmt_commands[] __command = {
-	{
-		.name = "iwstat",
-		.exec = iwstat_exec,
-	},
-	{
-		.name = "iwlist",
-		.exec = iwlist_exec,
-	},
-};
+COMMAND ( iwstat, iwstat_exec );
+COMMAND ( iwlist, iwlist_exec );
diff --git a/src/hci/commands/login_cmd.c b/src/hci/commands/login_cmd.c
index c9e196437..005d40342 100644
--- a/src/hci/commands/login_cmd.c
+++ b/src/hci/commands/login_cmd.c
@@ -71,7 +71,4 @@ static int login_exec ( int argc, char **argv ) {
 }
 
 /** Login commands */
-struct command login_command __command = {
-	.name = "login",
-	.exec = login_exec,
-};
+COMMAND ( login, login_exec );
diff --git a/src/hci/commands/lotest_cmd.c b/src/hci/commands/lotest_cmd.c
index 393b3c36e..ee3b0d3b5 100644
--- a/src/hci/commands/lotest_cmd.c
+++ b/src/hci/commands/lotest_cmd.c
@@ -100,7 +100,4 @@ static int lotest_exec ( int argc, char **argv ) {
 }
 
 /** Loopback testing commands */
-struct command lotest_command __command = {
-	.name = "lotest",
-	.exec = lotest_exec,
-};
+COMMAND ( lotest, lotest_exec );
diff --git a/src/hci/commands/neighbour_cmd.c b/src/hci/commands/neighbour_cmd.c
index 816e87357..520d5aa06 100644
--- a/src/hci/commands/neighbour_cmd.c
+++ b/src/hci/commands/neighbour_cmd.c
@@ -65,9 +65,4 @@ static int nstat_exec ( int argc, char **argv ) {
 }
 
 /** Neighbour management commands */
-struct command neighbour_commands[] __command = {
-	{
-		.name = "nstat",
-		.exec = nstat_exec,
-	},
-};
+COMMAND ( nstat, nstat_exec );
diff --git a/src/hci/commands/nslookup_cmd.c b/src/hci/commands/nslookup_cmd.c
index 265afdc3d..dc9d61704 100644
--- a/src/hci/commands/nslookup_cmd.c
+++ b/src/hci/commands/nslookup_cmd.c
@@ -73,7 +73,4 @@ static int nslookup_exec ( int argc, char **argv ) {
 }
 
 /** The "nslookup" command */
-struct command nslookup_command __command = {
-	.name = "nslookup",
-	.exec = nslookup_exec,
-};
+COMMAND ( nslookup, nslookup_exec );
diff --git a/src/hci/commands/ntp_cmd.c b/src/hci/commands/ntp_cmd.c
index 8f741a512..fed126f4c 100644
--- a/src/hci/commands/ntp_cmd.c
+++ b/src/hci/commands/ntp_cmd.c
@@ -75,7 +75,4 @@ static int ntp_exec ( int argc, char **argv ) {
 }
 
 /** NTP command */
-struct command ntp_command __command = {
-	.name = "ntp",
-	.exec = ntp_exec,
-};
+COMMAND ( ntp, ntp_exec );
diff --git a/src/hci/commands/nvo_cmd.c b/src/hci/commands/nvo_cmd.c
index 6ad7e7428..69ab97dca 100644
--- a/src/hci/commands/nvo_cmd.c
+++ b/src/hci/commands/nvo_cmd.c
@@ -356,25 +356,8 @@ static int inc_exec ( int argc, char **argv ) {
 }
 
 /** Non-volatile option commands */
-struct command nvo_commands[] __command = {
-	{
-		.name = "show",
-		.exec = show_exec,
-	},
-	{
-		.name = "set",
-		.exec = set_exec,
-	},	
-	{
-		.name = "clear",
-		.exec = clear_exec,
-	},
-	{
-		.name = "read",
-		.exec = read_exec,
-	},
-	{
-		.name = "inc",
-		.exec = inc_exec,
-	},
-};
+COMMAND ( show, show_exec );
+COMMAND ( set, set_exec );
+COMMAND ( clear, clear_exec );
+COMMAND ( read, read_exec );
+COMMAND ( inc, inc_exec );
diff --git a/src/hci/commands/param_cmd.c b/src/hci/commands/param_cmd.c
index dad99f840..0924df597 100644
--- a/src/hci/commands/param_cmd.c
+++ b/src/hci/commands/param_cmd.c
@@ -163,13 +163,5 @@ static int param_exec ( int argc, char **argv ) {
 }
 
 /** Request parameter commands */
-struct command param_commands[] __command = {
-	{
-		.name = "params",
-		.exec = params_exec,
-	},
-	{
-		.name = "param",
-		.exec = param_exec,
-	},
-};
+COMMAND ( params, params_exec );
+COMMAND ( param, param_exec );
diff --git a/src/hci/commands/pci_cmd.c b/src/hci/commands/pci_cmd.c
index fa1fa5ece..0b54902fb 100644
--- a/src/hci/commands/pci_cmd.c
+++ b/src/hci/commands/pci_cmd.c
@@ -115,9 +115,4 @@ static int pciscan_exec ( int argc, char **argv ) {
 }
 
 /** PCI commands */
-struct command pci_commands[] __command = {
-	{
-		.name = "pciscan",
-		.exec = pciscan_exec,
-	},
-};
+COMMAND ( pciscan, pciscan_exec );
diff --git a/src/hci/commands/ping_cmd.c b/src/hci/commands/ping_cmd.c
index ab271e75a..4e86ae1c0 100644
--- a/src/hci/commands/ping_cmd.c
+++ b/src/hci/commands/ping_cmd.c
@@ -107,7 +107,4 @@ static int ping_exec ( int argc, char **argv ) {
 }
 
 /** Ping command */
-struct command ping_command __command = {
-	.name = "ping",
-	.exec = ping_exec,
-};
+COMMAND ( ping, ping_exec );
diff --git a/src/hci/commands/poweroff_cmd.c b/src/hci/commands/poweroff_cmd.c
index afdf12dde..2c6f1369a 100644
--- a/src/hci/commands/poweroff_cmd.c
+++ b/src/hci/commands/poweroff_cmd.c
@@ -70,7 +70,4 @@ static int poweroff_exec ( int argc, char **argv ) {
 }
 
 /** "poweroff" command */
-struct command poweroff_command __command = {
-	.name = "poweroff",
-	.exec = poweroff_exec,
-};
+COMMAND ( poweroff, poweroff_exec );
diff --git a/src/hci/commands/profstat_cmd.c b/src/hci/commands/profstat_cmd.c
index dc6f649e3..da01068b2 100644
--- a/src/hci/commands/profstat_cmd.c
+++ b/src/hci/commands/profstat_cmd.c
@@ -66,9 +66,4 @@ static int profstat_exec ( int argc, char **argv ) {
 }
 
 /** Profiling commands */
-struct command profstat_commands[] __command = {
-	{
-		.name = "profstat",
-		.exec = profstat_exec,
-	},
-};
+COMMAND ( profstat, profstat_exec );
diff --git a/src/hci/commands/reboot_cmd.c b/src/hci/commands/reboot_cmd.c
index 5d4e151b8..c5b71c045 100644
--- a/src/hci/commands/reboot_cmd.c
+++ b/src/hci/commands/reboot_cmd.c
@@ -81,7 +81,4 @@ static int reboot_exec ( int argc, char **argv ) {
 }
 
 /** "reboot" command */
-struct command reboot_command __command = {
-	.name = "reboot",
-	.exec = reboot_exec,
-};
+COMMAND ( reboot, reboot_exec );
diff --git a/src/hci/commands/route_cmd.c b/src/hci/commands/route_cmd.c
index 8aa535363..a33754399 100644
--- a/src/hci/commands/route_cmd.c
+++ b/src/hci/commands/route_cmd.c
@@ -66,9 +66,4 @@ static int route_exec ( int argc, char **argv ) {
 }
 
 /** Routing table management commands */
-struct command route_commands[] __command = {
-	{
-		.name = "route",
-		.exec = route_exec,
-	},
-};
+COMMAND ( route, route_exec );
diff --git a/src/hci/commands/sanboot_cmd.c b/src/hci/commands/sanboot_cmd.c
index 6ab9e8844..122bee527 100644
--- a/src/hci/commands/sanboot_cmd.c
+++ b/src/hci/commands/sanboot_cmd.c
@@ -204,17 +204,6 @@ static int sanunhook_exec ( int argc, char **argv ) {
 }
 
 /** SAN commands */
-struct command sanboot_commands[] __command = {
-	{
-		.name = "sanhook",
-		.exec = sanhook_exec,
-	},
-	{
-		.name = "sanboot",
-		.exec = sanboot_exec,
-	},
-	{
-		.name = "sanunhook",
-		.exec = sanunhook_exec,
-	},
-};
+COMMAND ( sanhook, sanhook_exec );
+COMMAND ( sanboot, sanboot_exec );
+COMMAND ( sanunhook, sanunhook_exec );
diff --git a/src/hci/commands/shim_cmd.c b/src/hci/commands/shim_cmd.c
index 11956290a..a53bb3fde 100644
--- a/src/hci/commands/shim_cmd.c
+++ b/src/hci/commands/shim_cmd.c
@@ -123,9 +123,4 @@ static int shim_exec ( int argc, char **argv ) {
 }
 
 /** Shim commands */
-struct command shim_commands[] __command = {
-	{
-		.name = "shim",
-		.exec = shim_exec,
-	},
-};
+COMMAND ( shim, shim_exec );
diff --git a/src/hci/commands/sync_cmd.c b/src/hci/commands/sync_cmd.c
index 54799d422..9d6e6a284 100644
--- a/src/hci/commands/sync_cmd.c
+++ b/src/hci/commands/sync_cmd.c
@@ -77,7 +77,4 @@ static int sync_exec ( int argc, char **argv ) {
 }
 
 /** Sync commands */
-struct command sync_command __command = {
-	.name = "sync",
-	.exec = sync_exec,
-};
+COMMAND ( sync, sync_exec );
diff --git a/src/hci/commands/time_cmd.c b/src/hci/commands/time_cmd.c
index 08148bf38..aba080792 100644
--- a/src/hci/commands/time_cmd.c
+++ b/src/hci/commands/time_cmd.c
@@ -77,7 +77,4 @@ static int time_exec ( int argc, char **argv ) {
 }
 
 /** "time" command */
-struct command time_command __command = {
-	.name = "time",
-	.exec = time_exec,
-};
+COMMAND ( time, time_exec );
diff --git a/src/hci/commands/usb_cmd.c b/src/hci/commands/usb_cmd.c
index 4ee2f2ddb..2e3a82371 100644
--- a/src/hci/commands/usb_cmd.c
+++ b/src/hci/commands/usb_cmd.c
@@ -115,9 +115,4 @@ static int usbscan_exec ( int argc, char **argv ) {
 }
 
 /** USB commands */
-struct command usb_commands[] __command = {
-	{
-		.name = "usbscan",
-		.exec = usbscan_exec,
-	},
-};
+COMMAND ( usbscan, usbscan_exec );
diff --git a/src/hci/commands/vlan_cmd.c b/src/hci/commands/vlan_cmd.c
index 8a2f0c749..636e5927f 100644
--- a/src/hci/commands/vlan_cmd.c
+++ b/src/hci/commands/vlan_cmd.c
@@ -131,13 +131,5 @@ static int vdestroy_exec ( int argc, char **argv ) {
 }
 
 /** VLAN commands */
-struct command vlan_commands[] __command = {
-	{
-		.name = "vcreate",
-		.exec = vcreate_exec,
-	},
-	{
-		.name = "vdestroy",
-		.exec = vdestroy_exec,
-	},
-};
+COMMAND ( vcreate, vcreate_exec );
+COMMAND ( vdestroy, vdestroy_exec );
diff --git a/src/hci/shell.c b/src/hci/shell.c
index 8ecf73a6f..7e2ecaab6 100644
--- a/src/hci/shell.c
+++ b/src/hci/shell.c
@@ -72,10 +72,7 @@ static int help_exec ( int argc __unused, char **argv __unused ) {
 }
 
 /** "help" command */
-struct command help_command __command = {
-	.name = "help",
-	.exec = help_exec,
-};
+COMMAND ( help, help_exec );
 
 /**
  * Start command shell
@@ -137,7 +134,4 @@ static int shell_exec ( int argc, char **argv ) {
 }
 
 /** "shell" command */
-struct command shell_command __command = {
-	.name = "shell",
-	.exec = shell_exec,
-};
+COMMAND ( shell, shell_exec );
diff --git a/src/image/script.c b/src/image/script.c
index 01e38cd6f..257e59a09 100644
--- a/src/image/script.c
+++ b/src/image/script.c
@@ -352,10 +352,7 @@ static int goto_exec ( int argc, char **argv ) {
 }
 
 /** "goto" command */
-struct command goto_command __command = {
-	.name = "goto",
-	.exec = goto_exec,
-};
+COMMAND ( goto, goto_exec );
 
 /** "prompt" options */
 struct prompt_options {
@@ -418,7 +415,4 @@ static int prompt_exec ( int argc, char **argv ) {
 }
 
 /** "prompt" command */
-struct command prompt_command __command = {
-	.name = "prompt",
-	.exec = prompt_exec,
-};
+COMMAND ( prompt, prompt_exec );
diff --git a/src/include/ipxe/command.h b/src/include/ipxe/command.h
index a208e7d8f..331536313 100644
--- a/src/include/ipxe/command.h
+++ b/src/include/ipxe/command.h
@@ -21,7 +21,12 @@ struct command {
 
 #define COMMANDS __table ( struct command, "commands" )
 
-#define __command __table_entry ( COMMANDS, 01 )
+#define __command( name ) __table_entry ( COMMANDS, _C2 ( 01., name ) )
+
+#define COMMAND( name, exec )						\
+	struct command name ## _command __command ( name ) = {		\
+		#name, exec						\
+	}
 
 extern char * concat_args ( char **args );
 
-- 
cgit v1.2.3-55-g7522


From 88ba0117649bd8ec711ec0d799acb649284dc492 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 7 Aug 2025 15:41:42 +0100
Subject: [fdt] Provide fdt_reg() for unsized single-entry regions

Many region types (e.g. I2C bus addresses) can only ever contain a
single region with no size cells specified.  Provide fdt_reg() to
reduce boilerplate in this common use case.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/fdt.c            | 49 +++++++++++++++++++++++++++++++++++++++++++++++
 src/drivers/bus/devtree.c | 10 +++-------
 src/include/ipxe/fdt.h    |  3 +++
 3 files changed, 55 insertions(+), 7 deletions(-)

(limited to 'src/core')

diff --git a/src/core/fdt.c b/src/core/fdt.c
index ae723213b..08adb166e 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -732,6 +732,29 @@ void fdt_reg_cells ( struct fdt *fdt, unsigned int offset,
 	regs->stride = ( regs->address_cells + regs->size_cells );
 }
 
+/**
+ * Get parent region cell size specification
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v regs		Region cell size specification to fill in
+ * @ret rc		Return status code
+ */
+int fdt_parent_reg_cells ( struct fdt *fdt, unsigned int offset,
+			   struct fdt_reg_cells *regs ) {
+	unsigned int parent;
+	int rc;
+
+	/* Get parent node */
+	if ( ( rc = fdt_parent ( fdt, offset, &parent ) ) != 0 )
+		return rc;
+
+	/* Read #address-cells and #size-cells, if present */
+	fdt_reg_cells ( fdt, parent, regs );
+
+	return 0;
+}
+
 /**
  * Get number of regions
  *
@@ -806,6 +829,32 @@ int fdt_reg_size ( struct fdt *fdt, unsigned int offset,
 	return 0;
 }
 
+/**
+ * Get unsized single-entry region address
+ *
+ * @v fdt		Device tree
+ * @v offset		Starting node offset
+ * @v address		Region address to fill in
+ * @ret rc		Return status code
+ *
+ * Many region types (e.g. I2C bus addresses) can only ever contain a
+ * single region with no size cells specified.
+ */
+int fdt_reg ( struct fdt *fdt, unsigned int offset, uint64_t *region ) {
+	struct fdt_reg_cells regs;
+	int rc;
+
+	/* Get parent region cell size specification */
+	if ( ( rc = fdt_parent_reg_cells ( fdt, offset, &regs ) ) != 0 )
+		return rc;
+
+	/* Get first region address */
+	if ( ( rc = fdt_reg_address ( fdt, offset, &regs, 0, region ) ) != 0 )
+		return rc;
+
+	return 0;
+}
+
 /**
  * Get MAC address from property
  *
diff --git a/src/drivers/bus/devtree.c b/src/drivers/bus/devtree.c
index 32ab1c2cb..f71ad1ea4 100644
--- a/src/drivers/bus/devtree.c
+++ b/src/drivers/bus/devtree.c
@@ -52,22 +52,18 @@ static struct dt_driver dt_node_driver __dt_driver;
 void * dt_ioremap ( struct dt_device *dt, unsigned int offset,
 		    unsigned int index, size_t len ) {
 	struct fdt_reg_cells regs;
-	unsigned int parent;
 	uint64_t address;
 	uint64_t size;
 	void *io_addr;
 	int rc;
 
-	/* Get parent node */
-	if ( ( rc = fdt_parent ( &sysfdt, offset, &parent ) ) != 0 ) {
-		DBGC ( dt, "DT %s could not locate parent: %s\n",
+	/* Get parent region cell size specification */
+	if ( ( rc = fdt_parent_reg_cells ( &sysfdt, offset, &regs ) ) != 0 ) {
+		DBGC ( dt, "DT %s could not get region cell sizes: %s\n",
 		       dt->name, strerror ( rc ) );
 		return NULL;
 	}
 
-	/* Read #address-cells and #size-cells, if present */
-	fdt_reg_cells ( &sysfdt, parent, &regs );
-
 	/* Read address */
 	if ( ( rc = fdt_reg_address ( &sysfdt, offset, &regs, index,
 				      &address ) ) != 0 ) {
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index eec02c5b3..e951aea59 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -190,6 +190,8 @@ extern int fdt_u32 ( struct fdt *fdt, unsigned int offset, const char *name,
 extern uint32_t fdt_phandle ( struct fdt *fdt, unsigned int offset );
 extern void fdt_reg_cells ( struct fdt *fdt, unsigned int offset,
 			    struct fdt_reg_cells *regs );
+extern int fdt_parent_reg_cells ( struct fdt *fdt, unsigned int offset,
+				  struct fdt_reg_cells *regs );
 extern int fdt_reg_count ( struct fdt *fdt, unsigned int offset,
 			   struct fdt_reg_cells *regs );
 extern int fdt_reg_address ( struct fdt *fdt, unsigned int offset,
@@ -198,6 +200,7 @@ extern int fdt_reg_address ( struct fdt *fdt, unsigned int offset,
 extern int fdt_reg_size ( struct fdt *fdt, unsigned int offset,
 			  struct fdt_reg_cells *regs, unsigned int index,
 			  uint64_t *size );
+extern int fdt_reg ( struct fdt *fdt, unsigned int offset, uint64_t *region );
 extern int fdt_mac ( struct fdt *fdt, unsigned int offset,
 		     struct net_device *netdev );
 extern int fdt_parse ( struct fdt *fdt, struct fdt_header *hdr,
-- 
cgit v1.2.3-55-g7522


From 5bec2604a3565f6db31419a4630e0317384ebe61 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 28 Aug 2025 15:12:41 +0100
Subject: [libc] Add wcsnlen()

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/wchar.c        | 19 ++++++++++++++++---
 src/include/wchar.h     |  1 +
 src/tests/string_test.c | 18 ++++++++++++++++++
 3 files changed, 35 insertions(+), 3 deletions(-)

(limited to 'src/core')

diff --git a/src/core/wchar.c b/src/core/wchar.c
index 860322820..b06cf452a 100644
--- a/src/core/wchar.c
+++ b/src/core/wchar.c
@@ -36,12 +36,25 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  * Calculate length of wide-character string
  *
  * @v string		String
- * @ret len		Length (excluding terminating NUL)
+ * @v max		Maximum length (in wide characters)
+ * @ret len		Length (in wide characters, excluding terminating NUL)
  */
-size_t wcslen ( const wchar_t *string ) {
+size_t wcsnlen ( const wchar_t *string, size_t max ) {
 	size_t len = 0;
 
-	while ( *(string++) )
+	while ( max-- && *(string++) )
 		len++;
 	return len;
 }
+
+/**
+ * Calculate length of wide-character string
+ *
+ * @v string		String
+ * @ret len		Length (in wide characters, excluding terminating NUL)
+ */
+size_t wcslen ( const wchar_t *string ) {
+
+	return wcsnlen ( string, ( ( ~( ( size_t ) 0 ) ) /
+				   sizeof ( string[0] ) ) );
+}
diff --git a/src/include/wchar.h b/src/include/wchar.h
index d054b8d5b..a7e9de4f2 100644
--- a/src/include/wchar.h
+++ b/src/include/wchar.h
@@ -24,6 +24,7 @@ size_t wcrtomb ( char *buf, wchar_t wc, mbstate_t *ps __unused ) {
 	return 1;
 }
 
+extern size_t wcsnlen ( const wchar_t *string, size_t max );
 extern size_t wcslen ( const wchar_t *string );
 
 #endif /* WCHAR_H */
diff --git a/src/tests/string_test.c b/src/tests/string_test.c
index c0436c3ad..6662848d3 100644
--- a/src/tests/string_test.c
+++ b/src/tests/string_test.c
@@ -38,6 +38,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <stdio.h>
 #include <string.h>
 #include <strings.h>
+#include <wchar.h>
 #include <ipxe/string.h>
 #include <ipxe/test.h>
 
@@ -322,6 +323,23 @@ static void string_test_exec ( void ) {
 			 + 17 ) * 26 + 10 ) );
 		ok ( endp == &string[6] );
 	}
+
+	/* Test wcslen() */
+	ok ( wcslen ( L"" ) == 0 );
+	ok ( wcslen ( L"Helloo" ) == 6 );
+	ok ( wcslen ( L"Helloo woorld!" ) == 14 );
+	ok ( wcslen ( L"Helloo\0woorld!" ) == 6 );
+
+	/* Test wcsnlen() */
+	ok ( wcsnlen ( L"", 0 ) == 0 );
+	ok ( wcsnlen ( L"", 10 ) == 0 );
+	ok ( wcsnlen ( L"Helloo", 0 ) == 0 );
+	ok ( wcsnlen ( L"Helloo", 3 ) == 3 );
+	ok ( wcsnlen ( L"Helloo", 5 ) == 5 );
+	ok ( wcsnlen ( L"Helloo", 16 ) == 6 );
+	ok ( wcsnlen ( L"Helloo woorld!", 5 ) == 5 );
+	ok ( wcsnlen ( L"Helloo woorld!", 11 ) == 11 );
+	ok ( wcsnlen ( L"Helloo woorld!", 16 ) == 14 );
 }
 
 /** String self-test */
-- 
cgit v1.2.3-55-g7522


From 08d4d7fe9db04c8f44ac063d4b722fb3e8f3fffe Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 5 Nov 2025 12:16:22 +0000
Subject: [uart] Make baud rate a property of the UART

Make the current baud rate (if specified) a property of the UART, to
allow the default_serial_console() function to specify the default
baud rate as well as the default UART device.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/gdbserial.c       |  4 +++-
 src/core/serial.c          | 14 ++++++++++----
 src/core/uart.c            |  3 +--
 src/drivers/uart/ns16550.c |  7 +++----
 src/include/ipxe/uart.h    | 11 ++++++-----
 5 files changed, 23 insertions(+), 16 deletions(-)

(limited to 'src/core')

diff --git a/src/core/gdbserial.c b/src/core/gdbserial.c
index 0f74e5fe0..61add5d47 100644
--- a/src/core/gdbserial.c
+++ b/src/core/gdbserial.c
@@ -95,7 +95,9 @@ struct gdb_transport * gdbserial_configure ( const char *name,
 		return NULL;
 	uart_get ( gdbserial_uart );
 
-	if ( ( rc = uart_init ( gdbserial_uart, baud ) ) != 0 )
+	gdbserial_uart->baud = baud;
+
+	if ( ( rc = uart_init ( gdbserial_uart ) ) != 0 )
 		return NULL;
 
 	return &serial_gdb_transport;
diff --git a/src/core/serial.c b/src/core/serial.c
index f3b33cd90..34ae4a17b 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -74,8 +74,14 @@ struct uart *serial_console = NULL;
  * @ret uart		Serial console UART, or NULL
  */
 static struct uart * serial_comconsole ( void ) {
+	struct uart *uart = COMCONSOLE;
+	unsigned int baud = COMSPEED;
 
-	return COMCONSOLE;
+	/* Set default baud rate, if applicable */
+	if ( uart && baud )
+		uart->baud = baud;
+
+	return uart;
 }
 
 /**
@@ -154,9 +160,9 @@ static void serial_init ( void ) {
 		return;
 
 	/* Initialise UART */
-	if ( ( rc = uart_init ( uart, COMSPEED ) ) != 0 ) {
-		DBGC ( uart, "SERIAL could not initialise %s baud %d: %s\n",
-		       uart->name, COMSPEED, strerror ( rc ) );
+	if ( ( rc = uart_init ( uart ) ) != 0 ) {
+		DBGC ( uart, "SERIAL could not initialise %s: %s\n",
+		       uart->name, strerror ( rc ) );
 		return;
 	}
 
diff --git a/src/core/uart.c b/src/core/uart.c
index a645bd398..5bff9fdd5 100644
--- a/src/core/uart.c
+++ b/src/core/uart.c
@@ -49,8 +49,7 @@ static uint8_t null_uart_receive ( struct uart *uart __unused ) {
 	return 0;
 }
 
-static int null_uart_init ( struct uart *uart __unused,
-			    unsigned int baud __unused ) {
+static int null_uart_init ( struct uart *uart __unused ) {
 	return 0;
 }
 
diff --git a/src/drivers/uart/ns16550.c b/src/drivers/uart/ns16550.c
index 428771ab5..f00e834b4 100644
--- a/src/drivers/uart/ns16550.c
+++ b/src/drivers/uart/ns16550.c
@@ -115,10 +115,9 @@ static void ns16550_flush ( struct uart *uart ) {
  * Initialise UART
  *
  * @v uart		UART
- * @v baud		Baud rate, or zero to leave unchanged
  * @ret rc		Return status code
  */
-static int ns16550_init ( struct uart *uart, unsigned int baud ) {
+static int ns16550_init ( struct uart *uart ) {
 	struct ns16550_uart *ns16550 = uart->priv;
 	uint8_t dlm;
 	uint8_t dll;
@@ -137,8 +136,8 @@ static int ns16550_init ( struct uart *uart, unsigned int baud ) {
 	/* Configure divisor and line control register, if applicable */
 	ns16550_write ( ns16550, NS16550_LCR,
 			( NS16550_LCR_8N1 | NS16550_LCR_DLAB ) );
-	if ( baud ) {
-		ns16550->divisor = ( ( ns16550->clock / baud ) /
+	if ( uart->baud ) {
+		ns16550->divisor = ( ( ns16550->clock / uart->baud ) /
 				     NS16550_CLK_BIT );
 		dlm = ( ( ns16550->divisor >> 8 ) & 0xff );
 		dll = ( ( ns16550->divisor >> 0 ) & 0xff );
diff --git a/src/include/ipxe/uart.h b/src/include/ipxe/uart.h
index 15adfa932..f2ecf3ce9 100644
--- a/src/include/ipxe/uart.h
+++ b/src/include/ipxe/uart.h
@@ -22,6 +22,9 @@ struct uart {
 	/** List of registered UARTs */
 	struct list_head list;
 
+	/** Baud rate (if specified) */
+	unsigned int baud;
+
 	/** UART operations */
 	struct uart_operations *op;
 	/** Driver-private data */
@@ -56,10 +59,9 @@ struct uart_operations {
 	 * Initialise UART
 	 *
 	 * @v uart		UART
-	 * @v baud		Baud rate, or zero to leave unchanged
 	 * @ret rc		Return status code
 	 */
-	int ( * init ) ( struct uart *uart, unsigned int baud );
+	int ( * init ) ( struct uart *uart );
 	/**
 	 * Flush transmitted data
 	 *
@@ -109,13 +111,12 @@ uart_receive ( struct uart *uart ) {
  * Initialise UART
  *
  * @v uart		UART
- * @v baud		Baud rate, or zero to leave unchanged
  * @ret rc		Return status code
  */
 static inline __attribute__ (( always_inline )) int
-uart_init ( struct uart *uart, unsigned int baud ) {
+uart_init ( struct uart *uart ) {
 
-	return uart->op->init ( uart, baud );
+	return uart->op->init ( uart );
 }
 
 /**
-- 
cgit v1.2.3-55-g7522


From 8fd5e277275141866feea80870f8b94b23a0e82d Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 5 Nov 2025 14:07:27 +0000
Subject: [acpi] Add acpi_ioremap() to map an ACPI-described address

An ACPI Generic Address Structure (GAS) may be used to describe the
location of a peripheral such as an early boot console.  Add the
relevant definitions and provide acpi_ioremap() as a helper function
to map a region described using this structure.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/acpi.c         | 19 +++++++++++++++++++
 src/include/ipxe/acpi.h | 30 ++++++++++++++++++++++++------
 2 files changed, 43 insertions(+), 6 deletions(-)

(limited to 'src/core')

diff --git a/src/core/acpi.c b/src/core/acpi.c
index 6c5d1e079..fa8ed34ff 100644
--- a/src/core/acpi.c
+++ b/src/core/acpi.c
@@ -27,6 +27,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <errno.h>
 #include <byteswap.h>
 #include <ipxe/uaccess.h>
+#include <ipxe/iomap.h>
 #include <ipxe/acpi.h>
 #include <ipxe/interface.h>
 
@@ -258,6 +259,24 @@ int acpi_extract ( uint32_t signature, void *data,
 	return -ENOENT;
 }
 
+/**
+ * Map an ACPI generic address
+ *
+ * @v address		Generic address
+ * @v len		Length of region
+ * @ret io_addr		I/O address, or NULL on error
+ */
+void * acpi_ioremap ( struct acpi_address *address, size_t len ) {
+	physaddr_t base = le64_to_cpu ( address->address );
+
+	switch ( address->type ) {
+	case ACPI_ADDRESS_TYPE_MEM:
+		return ioremap ( base, len );
+	default:
+		return NULL;
+	}
+}
+
 /******************************************************************************
  *
  * Descriptors
diff --git a/src/include/ipxe/acpi.h b/src/include/ipxe/acpi.h
index 40a44cffc..5e9fb5eba 100644
--- a/src/include/ipxe/acpi.h
+++ b/src/include/ipxe/acpi.h
@@ -18,6 +18,29 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/api.h>
 #include <config/general.h>
 
+/** An ACPI generic address structure */
+struct acpi_address {
+	/** Address space type */
+	uint8_t type;
+	/** Register bit width */
+	uint8_t width;
+	/** Register bit offset */
+	uint8_t offset;
+	/** Access size */
+	uint8_t access;
+	/** Address */
+	uint64_t address;
+} __attribute__ (( packed ));
+
+/** A memory address space type */
+#define ACPI_ADDRESS_TYPE_MEM 0x00
+
+/** An I/O address space type */
+#define ACPI_ADDRESS_TYPE_IO 0x01
+
+/** A bus number address space type */
+#define ACPI_ADDRESS_TYPE_BUS 0x02
+
 /** An ACPI small resource descriptor header */
 struct acpi_small_resource {
 	/** Tag byte */
@@ -74,12 +97,6 @@ struct acpi_qword_address_space_resource {
 	uint64_t len;
 } __attribute__ (( packed ));
 
-/** A memory address space type */
-#define ACPI_ADDRESS_TYPE_MEM 0x00
-
-/** A bus number address space type */
-#define ACPI_ADDRESS_TYPE_BUS 0x02
-
 /** An ACPI resource descriptor */
 union acpi_resource {
 	/** Tag byte */
@@ -397,6 +414,7 @@ extern int acpi_extract ( uint32_t signature, void *data,
 			  int ( * extract ) ( const struct acpi_header *zsdt,
 					      size_t len, size_t offset,
 					      void *data ) );
+extern void * acpi_ioremap ( struct acpi_address *address, size_t len );
 extern void acpi_add ( struct acpi_descriptor *desc );
 extern void acpi_del ( struct acpi_descriptor *desc );
 extern int acpi_install ( int ( * install ) ( struct acpi_header *acpi ) );
-- 
cgit v1.2.3-55-g7522


From 595ff240304e98a725624c71a5735c2013562810 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 5 Nov 2025 14:12:57 +0000
Subject: [spcr] Add support for the ACPI Serial Port Console Redirection table

The BIOS may provide an ACPI Serial Port Console Redirection (SPCR)
table to describe the serial port to be used for early boot messages.

Add support for parsing the SPCR and instantiating a 16550-based UART.
We do not currently attempt to support other types of UART, since iPXE
does not yet have drivers for other types.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/serial.c          |   4 +-
 src/core/spcr.c            | 162 +++++++++++++++++++++++++++++++++++++++++++++
 src/include/ipxe/errfile.h |   1 +
 src/include/ipxe/ns16550.h |   3 +
 src/include/ipxe/serial.h  |   2 +
 src/include/ipxe/spcr.h    |  90 +++++++++++++++++++++++++
 6 files changed, 260 insertions(+), 2 deletions(-)
 create mode 100644 src/core/spcr.c
 create mode 100644 src/include/ipxe/spcr.h

(limited to 'src/core')

diff --git a/src/core/serial.c b/src/core/serial.c
index 34ae4a17b..728ad7785 100644
--- a/src/core/serial.c
+++ b/src/core/serial.c
@@ -73,7 +73,7 @@ struct uart *serial_console = NULL;
  *
  * @ret uart		Serial console UART, or NULL
  */
-static struct uart * serial_comconsole ( void ) {
+struct uart * fixed_serial_console ( void ) {
 	struct uart *uart = COMCONSOLE;
 	unsigned int baud = COMSPEED;
 
@@ -201,4 +201,4 @@ struct startup_fn serial_startup_fn __startup_fn ( STARTUP_EARLY ) = {
 };
 
 PROVIDE_SERIAL_INLINE ( null, default_serial_console );
-PROVIDE_SERIAL ( fixed, default_serial_console, serial_comconsole );
+PROVIDE_SERIAL ( fixed, default_serial_console, fixed_serial_console );
diff --git a/src/core/spcr.c b/src/core/spcr.c
new file mode 100644
index 000000000..88914cac7
--- /dev/null
+++ b/src/core/spcr.c
@@ -0,0 +1,162 @@
+/*
+ * Copyright (C) 2025 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <errno.h>
+#include <ipxe/serial.h>
+#include <ipxe/pci.h>
+#include <ipxe/ns16550.h>
+#include <ipxe/spcr.h>
+
+/** @file
+ *
+ * ACPI Serial Port Console Redirection (SPCR)
+ *
+ */
+
+#ifdef SERIAL_SPCR
+#define SERIAL_PREFIX_spcr
+#else
+#define SERIAL_PREFIX_spcr __spcr_
+#endif
+
+/** SPCR-defined UART */
+static struct uart spcr_uart = {
+	.refcnt = REF_INIT ( ref_no_free ),
+	.name = "SPCR",
+};
+
+/** SPCR-defined 16550 UART */
+static struct ns16550_uart spcr_ns16550 = {
+	.clock = NS16550_CLK_DEFAULT,
+};
+
+/** Base baud rate for SPCR divisors */
+#define SPCR_BAUD_BASE 115200
+
+/** SPCR baud rate divisors */
+static const uint8_t spcr_baud_divisor[SPCR_BAUD_MAX] = {
+	[SPCR_BAUD_2400] = ( SPCR_BAUD_BASE / 2400 ),
+	[SPCR_BAUD_4800] = ( SPCR_BAUD_BASE / 4800 ),
+	[SPCR_BAUD_9600] = ( SPCR_BAUD_BASE / 9600 ),
+	[SPCR_BAUD_19200] = ( SPCR_BAUD_BASE / 19200 ),
+	[SPCR_BAUD_38400] = ( SPCR_BAUD_BASE / 38400 ),
+	[SPCR_BAUD_57600] = ( SPCR_BAUD_BASE / 57600 ),
+	[SPCR_BAUD_115200] = ( SPCR_BAUD_BASE / 115200 ),
+};
+
+/**
+ * Configure 16550-based serial console
+ *
+ * @v spcr		SPCR table
+ * @v uart		UART to configure
+ * @ret rc		Return status code
+ */
+static int spcr_16550 ( struct spcr_table *spcr, struct uart *uart ) {
+	struct ns16550_uart *ns16550 = &spcr_ns16550;
+
+	/* Set base address */
+	ns16550->base = acpi_ioremap ( &spcr->base, NS16550_LEN );
+	if ( ! ns16550->base ) {
+		DBGC ( uart, "SPCR could not map registers\n" );
+		return -ENODEV;
+	}
+
+	/* Set clock frequency, if specified */
+	if ( spcr->clock )
+		ns16550->clock = le32_to_cpu ( spcr->clock );
+
+	/* Configure UART as a 16550 */
+	uart->op = &ns16550_operations;
+	uart->priv = ns16550;
+
+	return 0;
+}
+
+/**
+ * Identify default serial console
+ *
+ * @ret uart		Default serial console UART, or NULL
+ */
+static struct uart * spcr_console ( void ) {
+	struct uart *uart = &spcr_uart;
+	struct spcr_table *spcr;
+	unsigned int baud;
+	int rc;
+
+	/* Locate SPCR table */
+	spcr = container_of ( acpi_table ( SPCR_SIGNATURE, 0 ),
+			      struct spcr_table, acpi );
+	if ( ! spcr ) {
+		DBGC ( uart, "SPCR found no table\n" );
+		goto err_table;
+	}
+	DBGC2 ( uart, "SPCR found table:\n" );
+	DBGC2_HDA ( uart, 0, spcr, sizeof ( *spcr ) );
+	DBGC ( uart, "SPCR is type %d at %02x:%08llx\n",
+	       spcr->type, spcr->base.type,
+	       ( ( unsigned long long ) le64_to_cpu ( spcr->base.address ) ) );
+	if ( spcr->pci_vendor_id != cpu_to_le16 ( PCI_ANY_ID ) ) {
+		DBGC ( uart, "SPCR is PCI " PCI_FMT " (%04x:%04x)\n",
+		       spcr->pci_segment, spcr->pci_bus, spcr->pci_dev,
+		       spcr->pci_func, le16_to_cpu ( spcr->pci_vendor_id ),
+		       le16_to_cpu ( spcr->pci_device_id ) );
+	}
+
+	/* Get baud rate */
+	baud = 0;
+	if ( le32_to_cpu ( spcr->acpi.length ) >=
+	     ( offsetof ( typeof ( *spcr ), precise ) +
+	       sizeof ( spcr->precise ) ) ) {
+		baud = le32_to_cpu ( spcr->precise );
+		if ( baud )
+			DBGC ( uart, "SPCR has precise baud rate %d\n", baud );
+	}
+	if ( ( ! baud ) && spcr->baud && ( spcr->baud < SPCR_BAUD_MAX ) ) {
+		baud = ( SPCR_BAUD_BASE / spcr_baud_divisor[spcr->baud] );
+		DBGC ( uart, "SPCR has baud rate %d\n", baud );
+	}
+	uart->baud = baud;
+
+	/* Initialise according to type */
+	switch ( spcr->type ) {
+	case SPCR_TYPE_16550:
+	case SPCR_TYPE_16450:
+		if ( ( rc = spcr_16550 ( spcr, uart ) ) != 0 )
+			goto err_type;
+		break;
+	default:
+		DBGC ( uart, "SPCR unsupported type %d\n", spcr->type );
+		goto err_type;
+	}
+
+	return uart;
+
+ err_type:
+ err_table:
+	/* Fall back to using fixed serial console */
+	return fixed_serial_console();
+}
+
+PROVIDE_SERIAL ( spcr, default_serial_console, spcr_console );
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index 1a8bddbcf..0c28810ea 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -88,6 +88,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define ERRFILE_efi_table	       ( ERRFILE_CORE | 0x00300000 )
 #define ERRFILE_efi_connect	       ( ERRFILE_CORE | 0x00310000 )
 #define ERRFILE_gpio		       ( ERRFILE_CORE | 0x00320000 )
+#define ERRFILE_spcr		       ( ERRFILE_CORE | 0x00330000 )
 
 #define ERRFILE_eisa		     ( ERRFILE_DRIVER | 0x00000000 )
 #define ERRFILE_isa		     ( ERRFILE_DRIVER | 0x00010000 )
diff --git a/src/include/ipxe/ns16550.h b/src/include/ipxe/ns16550.h
index 693094866..156249292 100644
--- a/src/include/ipxe/ns16550.h
+++ b/src/include/ipxe/ns16550.h
@@ -11,6 +11,9 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <ipxe/uart.h>
 
+/** Length of register region */
+#define NS16550_LEN 8
+
 /** Transmitter holding register */
 #define NS16550_THR 0x00
 
diff --git a/src/include/ipxe/serial.h b/src/include/ipxe/serial.h
index 1eb58bbb8..04347a89e 100644
--- a/src/include/ipxe/serial.h
+++ b/src/include/ipxe/serial.h
@@ -67,4 +67,6 @@ struct uart * default_serial_console ( void );
 
 extern struct uart *serial_console;
 
+extern struct uart * fixed_serial_console ( void );
+
 #endif /* _IPXE_SERIAL_H */
diff --git a/src/include/ipxe/spcr.h b/src/include/ipxe/spcr.h
new file mode 100644
index 000000000..ff41a4b89
--- /dev/null
+++ b/src/include/ipxe/spcr.h
@@ -0,0 +1,90 @@
+#ifndef _IPXE_SPCR_H
+#define _IPXE_SPCR_H
+
+/** @file
+ *
+ * ACPI Serial Port Console Redirection (SPCR)
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <ipxe/acpi.h>
+
+/** Serial Port Console Redirection table signature */
+#define SPCR_SIGNATURE ACPI_SIGNATURE ( 'S', 'P', 'C', 'R' )
+
+/** A Serial Port Console Redirection table */
+struct spcr_table {
+	/** ACPI header */
+	struct acpi_header acpi;
+	/** Interface type */
+	uint8_t type;
+	/** Reserved */
+	uint8_t reserved_a[3];
+	/** Base address */
+	struct acpi_address base;
+	/** Reserved */
+	uint8_t reserved_b[6];
+	/** Baud rate
+	 *
+	 *  0: leave unchanged
+	 *  1:   2400 = 115200 / 48   (not defined in standard)
+	 *  2:   4800 = 115200 / 24   (not defined in standard)
+	 *  3:   9600 = 115200 / 12
+	 *  4:  19200 = 115200 / 6
+	 *  5:  38400 = 115200 / 3    (not defined in standard)
+	 *  6:  57600 = 115200 / 2
+	 *  7: 115200 = 115200 / 1
+	 */
+	uint8_t baud;
+	/** Parity */
+	uint8_t parity;
+	/** Stop bits */
+	uint8_t stop;
+	/** Flow control */
+	uint8_t flow;
+	/** Terminal type */
+	uint8_t terminal;
+	/** Language */
+	uint8_t lang;
+	/** PCI device ID */
+	uint16_t pci_device_id;
+	/** PCI vendor ID */
+	uint16_t pci_vendor_id;
+	/** PCI bus number */
+	uint8_t pci_bus;
+	/** PCI device number */
+	uint8_t pci_dev;
+	/** PCI function number */
+	uint8_t pci_func;
+	/** Reserved */
+	uint8_t reserved_c[4];
+	/** PCI segment */
+	uint8_t pci_segment;
+	/** Clock frequency */
+	uint32_t clock;
+	/** Precise baud rate */
+	uint32_t precise;
+	/** Reserved */
+	uint8_t reserved_d[4];
+} __attribute__ (( packed ));
+
+/* SPCR interface types */
+#define SPCR_TYPE_16550		0x0000		/**< 16550-compatible */
+#define SPCR_TYPE_16450		0x0001		/**< 16450-compatible */
+
+/** SPCR baud rates */
+enum spcr_baud {
+	SPCR_BAUD_2400 = 1,
+	SPCR_BAUD_4800 = 2,
+	SPCR_BAUD_9600 = 3,
+	SPCR_BAUD_19200 = 4,
+	SPCR_BAUD_38400 = 5,
+	SPCR_BAUD_57600 = 6,
+	SPCR_BAUD_115200 = 7,
+	SPCR_BAUD_MAX
+};
+
+#endif /* _IPXE_SPCR_H */
-- 
cgit v1.2.3-55-g7522


From 6d9374e5a39337ff755f0e425fb987e6c672d151 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 5 Nov 2025 17:39:43 +0000
Subject: [acpi] Allow acpi_ioremap() to map a port I/O address

Assume that on any platforms where port I/O is used (i.e. x86), a port
I/O address may be used directly for the combined MMIO and port I/O
accessors without requiring an explicit mapping operation.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/acpi.c | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/core')

diff --git a/src/core/acpi.c b/src/core/acpi.c
index fa8ed34ff..3fbf25bd1 100644
--- a/src/core/acpi.c
+++ b/src/core/acpi.c
@@ -272,6 +272,8 @@ void * acpi_ioremap ( struct acpi_address *address, size_t len ) {
 	switch ( address->type ) {
 	case ACPI_ADDRESS_TYPE_MEM:
 		return ioremap ( base, len );
+	case ACPI_ADDRESS_TYPE_IO:
+		return ( ( void * ) base );
 	default:
 		return NULL;
 	}
-- 
cgit v1.2.3-55-g7522


From b41bda4413bf286d7b7a449bc05e1531da1eec2e Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 5 Nov 2025 20:06:53 +0000
Subject: [spcr] Accept alternative type value for a 16550-compatible UART

Some systems (observed on an AWS EC2 m7i.metal-24xl instance in
eu-south-2) use the newer "16550-compatible with parameters defined in
Generic Address Structure" type value.  (There does not appear to be
any particular reason why the newer value needs to be used: the UART
is still a standard 16550 with single-byte registers.)

Accept this additional type value for a 16550-compatible UART.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/spcr.c         | 1 +
 src/include/ipxe/spcr.h | 1 +
 2 files changed, 2 insertions(+)

(limited to 'src/core')

diff --git a/src/core/spcr.c b/src/core/spcr.c
index 88914cac7..b1cee1608 100644
--- a/src/core/spcr.c
+++ b/src/core/spcr.c
@@ -143,6 +143,7 @@ static struct uart * spcr_console ( void ) {
 	switch ( spcr->type ) {
 	case SPCR_TYPE_16550:
 	case SPCR_TYPE_16450:
+	case SPCR_TYPE_16550_GAS:
 		if ( ( rc = spcr_16550 ( spcr, uart ) ) != 0 )
 			goto err_type;
 		break;
diff --git a/src/include/ipxe/spcr.h b/src/include/ipxe/spcr.h
index ff41a4b89..366092ade 100644
--- a/src/include/ipxe/spcr.h
+++ b/src/include/ipxe/spcr.h
@@ -74,6 +74,7 @@ struct spcr_table {
 /* SPCR interface types */
 #define SPCR_TYPE_16550		0x0000		/**< 16550-compatible */
 #define SPCR_TYPE_16450		0x0001		/**< 16450-compatible */
+#define SPCR_TYPE_16550_GAS	0x0012		/**< 16550-compatible */
 
 /** SPCR baud rates */
 enum spcr_baud {
-- 
cgit v1.2.3-55-g7522


From a8c89276cced1c89149cb4d30cda9aa2e6495be7 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Fri, 9 Jan 2026 14:40:31 +0000
Subject: [malloc] Increase heap size to 4MB

Commit 2d180ce ("[tcp] Update maximum window size to 2MB") increased
the TCP window size to avoid filling the TCP window on typical modern
links.

The total heap size is only 512kB.  Given that RX I/O buffers are
typically subject to alignment constraints, it is plausible that we
may be able to actually buffer only 256kB of data before having to
discard queued out-of-order packets.

On a low latency network, this behaviour is not a problem: the sender
will rapidly retransmit the lost or discarded packets.  On a high
latency network, the sender's congestion control algorithm will end up
calculating a congestion window that is substantially smaller than our
advertised 2MB, which will result in a drastic reduction in actual
throughput.

We do not want to increase the heap size arbitrarily, since we still
have the constraint that memory used by iPXE may be permanently lost
to the operating system (depending on how the operating system is
booted).  However, the cost of keeping the heap size down to 512kB is
no longer acceptable given that large downloads over high-speed
wide-area networks are now routine.

Increase the heap size from 512kB to 4MB.  This should be sufficient
to hold an entire 2MB TCP window for a single connection under most
sensible conditions.  For example:

  * 1460-byte MSS => 1436 packets => 2872kB of 2kB RX I/O buffers

  * 8960-byte MSS => 234 packets => 3744kB of 16kB RX I/O buffers

The notable exception is that of a network where jumbo frames are in
use, but the TCP connection ends up using a standard 1460-byte MSS.
If this is found to be an issue in practice, then one possible
solution would be to shrink (or reallocate) I/O buffers for
out-of-order queued data.

Experimentation shows that before this change, an induced latency of
25ms (representative of a typical connection to a public cloud
provider) would cause the download speed to vary unpredictably between
2MB/s and 25MB/s.  After this change, the speed in this test scenario
remains consistently high at 25MB/s.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/malloc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src/core')

diff --git a/src/core/malloc.c b/src/core/malloc.c
index a05871085..877687d81 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -76,9 +76,9 @@ struct autosized_block {
 /**
  * Heap area size
  *
- * Currently fixed at 512kB.
+ * Currently fixed at 4MB.
  */
-#define HEAP_SIZE ( 512 * 1024 )
+#define HEAP_SIZE ( 4096 * 1024 )
 
 /** Heap area alignment */
 #define HEAP_ALIGN MIN_MEMBLOCK_ALIGN
-- 
cgit v1.2.3-55-g7522


From 6cccb3bdc00359068c07125258d71ce24db5118a Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 14 Jan 2026 13:25:34 +0000
Subject: [build] Mark core files as permitted for UEFI Secure Boot

Mark all files used in a standard build of bin-x86_64-efi/snponly.efi
as permitted for UEFI Secure Boot.  These files represent the core
functionality of iPXE that is guaranteed to have been included in
every binary that was previously subject to a security review and
signed by Microsoft.  It is therefore legitimate to assume that at
least these files have already been reviewed to the required standard
multiple times.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/cpuid.c                    | 1 +
 src/arch/x86/core/x86_string.c               | 1 +
 src/arch/x86/core/x86_tcpip.c                | 1 +
 src/arch/x86/hci/commands/cpuid_cmd.c        | 1 +
 src/arch/x86/include/bits/acpi.h             | 1 +
 src/arch/x86/include/bits/endian.h           | 1 +
 src/arch/x86/include/bits/errfile.h          | 1 +
 src/arch/x86/include/bits/io.h               | 1 +
 src/arch/x86/include/bits/iomap.h            | 1 +
 src/arch/x86/include/bits/memmap.h           | 1 +
 src/arch/x86/include/bits/nap.h              | 1 +
 src/arch/x86/include/bits/pci_io.h           | 1 +
 src/arch/x86/include/bits/reboot.h           | 1 +
 src/arch/x86/include/bits/sanboot.h          | 1 +
 src/arch/x86/include/bits/smbios.h           | 1 +
 src/arch/x86/include/bits/string.h           | 1 +
 src/arch/x86/include/bits/tcpip.h            | 1 +
 src/arch/x86/include/bits/time.h             | 1 +
 src/arch/x86/include/ipxe/bios_nap.h         | 1 +
 src/arch/x86/include/ipxe/bios_reboot.h      | 1 +
 src/arch/x86/include/ipxe/bios_sanboot.h     | 1 +
 src/arch/x86/include/ipxe/bios_smbios.h      | 1 +
 src/arch/x86/include/ipxe/cpuid.h            | 1 +
 src/arch/x86/include/ipxe/int15.h            | 1 +
 src/arch/x86/include/ipxe/iomap_pages.h      | 1 +
 src/arch/x86/include/ipxe/pcibios.h          | 1 +
 src/arch/x86/include/ipxe/pcidirect.h        | 1 +
 src/arch/x86/include/ipxe/rsdp.h             | 1 +
 src/arch/x86/include/ipxe/rtc_time.h         | 1 +
 src/arch/x86/include/ipxe/x86_io.h           | 1 +
 src/arch/x86_64/include/bits/byteswap.h      | 1 +
 src/arch/x86_64/include/bits/compiler.h      | 1 +
 src/arch/x86_64/include/bits/profile.h       | 1 +
 src/arch/x86_64/include/bits/stdint.h        | 1 +
 src/arch/x86_64/include/bits/strings.h       | 1 +
 src/arch/x86_64/include/ipxe/efi/dhcparch.h  | 1 +
 src/arch/x86_64/include/limits.h             | 1 +
 src/config/branding.h                        | 1 +
 src/config/colour.h                          | 1 +
 src/config/config.c                          | 1 +
 src/config/config_eap.c                      | 1 +
 src/config/config_efi.c                      | 1 +
 src/config/config_ethernet.c                 | 1 +
 src/config/config_http.c                     | 1 +
 src/config/config_pci.c                      | 1 +
 src/config/config_route.c                    | 1 +
 src/config/config_timer.c                    | 1 +
 src/config/console.h                         | 1 +
 src/config/defaults.h                        | 1 +
 src/config/defaults/efi.h                    | 1 +
 src/config/dhcp.h                            | 1 +
 src/config/fault.h                           | 1 +
 src/config/general.h                         | 1 +
 src/config/ioapi.h                           | 1 +
 src/config/named.h                           | 1 +
 src/config/nap.h                             | 1 +
 src/config/reboot.h                          | 1 +
 src/config/sanboot.h                         | 1 +
 src/config/settings.h                        | 1 +
 src/config/sideband.h                        | 1 +
 src/config/time.h                            | 1 +
 src/config/timer.h                           | 1 +
 src/config/umalloc.h                         | 1 +
 src/core/acpi.c                              | 1 +
 src/core/ansicol.c                           | 1 +
 src/core/ansiesc.c                           | 1 +
 src/core/asprintf.c                          | 1 +
 src/core/base16.c                            | 1 +
 src/core/base64.c                            | 1 +
 src/core/basename.c                          | 1 +
 src/core/bitmap.c                            | 1 +
 src/core/blockdev.c                          | 1 +
 src/core/blocktrans.c                        | 1 +
 src/core/cachedhcp.c                         | 1 +
 src/core/console.c                           | 1 +
 src/core/cpio.c                              | 1 +
 src/core/ctype.c                             | 1 +
 src/core/cwuri.c                             | 1 +
 src/core/debug.c                             | 1 +
 src/core/device.c                            | 1 +
 src/core/dma.c                               | 1 +
 src/core/downloader.c                        | 1 +
 src/core/dynui.c                             | 1 +
 src/core/edd.c                               | 1 +
 src/core/errno.c                             | 1 +
 src/core/exec.c                              | 1 +
 src/core/getkey.c                            | 1 +
 src/core/getopt.c                            | 1 +
 src/core/image.c                             | 1 +
 src/core/init.c                              | 1 +
 src/core/interface.c                         | 1 +
 src/core/iobuf.c                             | 1 +
 src/core/job.c                               | 1 +
 src/core/keymap.c                            | 1 +
 src/core/linebuf.c                           | 1 +
 src/core/list.c                              | 1 +
 src/core/main.c                              | 1 +
 src/core/malloc.c                            | 1 +
 src/core/monojob.c                           | 1 +
 src/core/nvo.c                               | 1 +
 src/core/open.c                              | 1 +
 src/core/params.c                            | 1 +
 src/core/parseopt.c                          | 1 +
 src/core/pending.c                           | 1 +
 src/core/pool.c                              | 1 +
 src/core/process.c                           | 1 +
 src/core/quiesce.c                           | 1 +
 src/core/random.c                            | 1 +
 src/core/refcnt.c                            | 1 +
 src/core/resolv.c                            | 1 +
 src/core/sanboot.c                           | 1 +
 src/core/settings.c                          | 1 +
 src/core/string.c                            | 1 +
 src/core/time.c                              | 1 +
 src/core/timer.c                             | 1 +
 src/core/uri.c                               | 1 +
 src/core/utf8.c                              | 1 +
 src/core/uuid.c                              | 1 +
 src/core/version.c                           | 1 +
 src/core/vsprintf.c                          | 1 +
 src/core/wchar.c                             | 1 +
 src/core/xfer.c                              | 1 +
 src/core/xferbuf.c                           | 1 +
 src/crypto/chap.c                            | 1 +
 src/crypto/crc32.c                           | 1 +
 src/crypto/md5.c                             | 1 +
 src/drivers/block/ata.c                      | 1 +
 src/drivers/block/ibft.c                     | 1 +
 src/drivers/block/scsi.c                     | 1 +
 src/drivers/bus/pci.c                        | 1 +
 src/drivers/bus/pci_settings.c               | 1 +
 src/drivers/net/efi/mnpnet.c                 | 1 +
 src/drivers/net/efi/nii.c                    | 1 +
 src/drivers/net/efi/nii.h                    | 1 +
 src/drivers/net/efi/snpnet.c                 | 1 +
 src/drivers/net/efi/snpnet.h                 | 1 +
 src/drivers/net/efi/snponly.c                | 1 +
 src/drivers/nvs/nvs.c                        | 1 +
 src/hci/commands/autoboot_cmd.c              | 1 +
 src/hci/commands/config_cmd.c                | 1 +
 src/hci/commands/dhcp_cmd.c                  | 1 +
 src/hci/commands/dynui_cmd.c                 | 1 +
 src/hci/commands/ifmgmt_cmd.c                | 1 +
 src/hci/commands/image_cmd.c                 | 1 +
 src/hci/commands/login_cmd.c                 | 1 +
 src/hci/commands/nvo_cmd.c                   | 1 +
 src/hci/commands/reboot_cmd.c                | 1 +
 src/hci/commands/route_cmd.c                 | 1 +
 src/hci/commands/sanboot_cmd.c               | 1 +
 src/hci/commands/shim_cmd.c                  | 1 +
 src/hci/commands/sync_cmd.c                  | 1 +
 src/hci/editstring.c                         | 1 +
 src/hci/jumpscroll.c                         | 1 +
 src/hci/mucurses/ansi_screen.c               | 1 +
 src/hci/mucurses/clear.c                     | 1 +
 src/hci/mucurses/cursor.h                    | 1 +
 src/hci/mucurses/mucurses.c                  | 1 +
 src/hci/mucurses/mucurses.h                  | 1 +
 src/hci/mucurses/print.c                     | 1 +
 src/hci/mucurses/widgets/editbox.c           | 1 +
 src/hci/mucurses/winattrs.c                  | 1 +
 src/hci/mucurses/wininit.c                   | 1 +
 src/hci/readline.c                           | 1 +
 src/hci/shell.c                              | 1 +
 src/hci/strerror.c                           | 1 +
 src/hci/tui/form_ui.c                        | 1 +
 src/hci/tui/login_ui.c                       | 1 +
 src/hci/tui/menu_ui.c                        | 1 +
 src/hci/tui/message.c                        | 1 +
 src/hci/tui/settings_ui.c                    | 1 +
 src/image/efi_image.c                        | 1 +
 src/image/embedded.c                         | 1 +
 src/image/script.c                           | 1 +
 src/include/assert.h                         | 1 +
 src/include/bits/dma.h                       | 1 +
 src/include/bits/uaccess.h                   | 1 +
 src/include/bits/umalloc.h                   | 1 +
 src/include/bits/virt_offset.h               | 1 +
 src/include/byteswap.h                       | 1 +
 src/include/ctype.h                          | 1 +
 src/include/curses.h                         | 1 +
 src/include/endian.h                         | 1 +
 src/include/errno.h                          | 1 +
 src/include/getopt.h                         | 1 +
 src/include/hci/ifmgmt_cmd.h                 | 1 +
 src/include/ipxe/acpi.h                      | 1 +
 src/include/ipxe/ansicol.h                   | 1 +
 src/include/ipxe/ansiesc.h                   | 1 +
 src/include/ipxe/aoe.h                       | 1 +
 src/include/ipxe/api.h                       | 1 +
 src/include/ipxe/arp.h                       | 1 +
 src/include/ipxe/asn1.h                      | 1 +
 src/include/ipxe/ata.h                       | 1 +
 src/include/ipxe/base16.h                    | 1 +
 src/include/ipxe/base64.h                    | 1 +
 src/include/ipxe/bitmap.h                    | 1 +
 src/include/ipxe/blockdev.h                  | 1 +
 src/include/ipxe/blocktrans.h                | 1 +
 src/include/ipxe/cachedhcp.h                 | 1 +
 src/include/ipxe/chap.h                      | 1 +
 src/include/ipxe/command.h                   | 1 +
 src/include/ipxe/console.h                   | 1 +
 src/include/ipxe/cpio.h                      | 1 +
 src/include/ipxe/crc32.h                     | 1 +
 src/include/ipxe/crypto.h                    | 1 +
 src/include/ipxe/device.h                    | 1 +
 src/include/ipxe/dhcp.h                      | 1 +
 src/include/ipxe/dhcparch.h                  | 1 +
 src/include/ipxe/dhcpopts.h                  | 1 +
 src/include/ipxe/dhcppkt.h                   | 1 +
 src/include/ipxe/dhcpv6.h                    | 1 +
 src/include/ipxe/dma.h                       | 1 +
 src/include/ipxe/dns.h                       | 1 +
 src/include/ipxe/downloader.h                | 1 +
 src/include/ipxe/dummy_sanboot.h             | 1 +
 src/include/ipxe/dynui.h                     | 1 +
 src/include/ipxe/eap.h                       | 1 +
 src/include/ipxe/eapol.h                     | 1 +
 src/include/ipxe/ecam_io.h                   | 1 +
 src/include/ipxe/edd.h                       | 1 +
 src/include/ipxe/editbox.h                   | 1 +
 src/include/ipxe/editstring.h                | 1 +
 src/include/ipxe/efi/ProcessorBind.h         | 1 +
 src/include/ipxe/efi/Protocol/AppleNetBoot.h | 1 +
 src/include/ipxe/efi/Protocol/ShimLock.h     | 1 +
 src/include/ipxe/efi/efi.h                   | 1 +
 src/include/ipxe/efi/efi_acpi.h              | 1 +
 src/include/ipxe/efi/efi_autoboot.h          | 1 +
 src/include/ipxe/efi/efi_autoexec.h          | 1 +
 src/include/ipxe/efi/efi_block.h             | 1 +
 src/include/ipxe/efi/efi_cachedhcp.h         | 1 +
 src/include/ipxe/efi/efi_cmdline.h           | 1 +
 src/include/ipxe/efi/efi_download.h          | 1 +
 src/include/ipxe/efi/efi_driver.h            | 1 +
 src/include/ipxe/efi/efi_fdt.h               | 1 +
 src/include/ipxe/efi/efi_file.h              | 1 +
 src/include/ipxe/efi/efi_hii.h               | 1 +
 src/include/ipxe/efi/efi_image.h             | 1 +
 src/include/ipxe/efi/efi_nap.h               | 1 +
 src/include/ipxe/efi/efi_null.h              | 1 +
 src/include/ipxe/efi/efi_path.h              | 1 +
 src/include/ipxe/efi/efi_pci.h               | 1 +
 src/include/ipxe/efi/efi_pci_api.h           | 1 +
 src/include/ipxe/efi/efi_pxe.h               | 1 +
 src/include/ipxe/efi/efi_reboot.h            | 1 +
 src/include/ipxe/efi/efi_service.h           | 1 +
 src/include/ipxe/efi/efi_shim.h              | 1 +
 src/include/ipxe/efi/efi_smbios.h            | 1 +
 src/include/ipxe/efi/efi_snp.h               | 1 +
 src/include/ipxe/efi/efi_strings.h           | 1 +
 src/include/ipxe/efi/efi_table.h             | 1 +
 src/include/ipxe/efi/efi_time.h              | 1 +
 src/include/ipxe/efi/efi_umalloc.h           | 1 +
 src/include/ipxe/efi/efi_utils.h             | 1 +
 src/include/ipxe/efi/efi_veto.h              | 1 +
 src/include/ipxe/efi/efi_watchdog.h          | 1 +
 src/include/ipxe/efi/efi_wrap.h              | 1 +
 src/include/ipxe/efi/mnpnet.h                | 1 +
 src/include/ipxe/errfile.h                   | 1 +
 src/include/ipxe/errno/efi.h                 | 1 +
 src/include/ipxe/errortab.h                  | 1 +
 src/include/ipxe/eth_slow.h                  | 1 +
 src/include/ipxe/ethernet.h                  | 1 +
 src/include/ipxe/fakedhcp.h                  | 1 +
 src/include/ipxe/fault.h                     | 1 +
 src/include/ipxe/fc.h                        | 1 +
 src/include/ipxe/fcels.h                     | 1 +
 src/include/ipxe/fcp.h                       | 1 +
 src/include/ipxe/fdtmem.h                    | 1 +
 src/include/ipxe/features.h                  | 1 +
 src/include/ipxe/fragment.h                  | 1 +
 src/include/ipxe/http.h                      | 1 +
 src/include/ipxe/ib_mad.h                    | 1 +
 src/include/ipxe/ib_packet.h                 | 1 +
 src/include/ipxe/ib_srp.h                    | 1 +
 src/include/ipxe/ibft.h                      | 1 +
 src/include/ipxe/icmp.h                      | 1 +
 src/include/ipxe/icmpv6.h                    | 1 +
 src/include/ipxe/if_arp.h                    | 1 +
 src/include/ipxe/if_ether.h                  | 1 +
 src/include/ipxe/image.h                     | 1 +
 src/include/ipxe/in.h                        | 1 +
 src/include/ipxe/infiniband.h                | 1 +
 src/include/ipxe/init.h                      | 1 +
 src/include/ipxe/initrd.h                    | 1 +
 src/include/ipxe/interface.h                 | 1 +
 src/include/ipxe/io.h                        | 1 +
 src/include/ipxe/iobuf.h                     | 1 +
 src/include/ipxe/iomap.h                     | 1 +
 src/include/ipxe/iomap_virt.h                | 1 +
 src/include/ipxe/ip.h                        | 1 +
 src/include/ipxe/ipstat.h                    | 1 +
 src/include/ipxe/ipv6.h                      | 1 +
 src/include/ipxe/iscsi.h                     | 1 +
 src/include/ipxe/iso9660.h                   | 1 +
 src/include/ipxe/job.h                       | 1 +
 src/include/ipxe/jumpscroll.h                | 1 +
 src/include/ipxe/keymap.h                    | 1 +
 src/include/ipxe/keys.h                      | 1 +
 src/include/ipxe/linebuf.h                   | 1 +
 src/include/ipxe/linux/linux_acpi.h          | 1 +
 src/include/ipxe/linux/linux_nap.h           | 1 +
 src/include/ipxe/linux/linux_pci.h           | 1 +
 src/include/ipxe/linux/linux_smbios.h        | 1 +
 src/include/ipxe/linux/linux_time.h          | 1 +
 src/include/ipxe/linux/linux_uaccess.h       | 1 +
 src/include/ipxe/linux/linux_umalloc.h       | 1 +
 src/include/ipxe/list.h                      | 1 +
 src/include/ipxe/lldp.h                      | 1 +
 src/include/ipxe/login_ui.h                  | 1 +
 src/include/ipxe/malloc.h                    | 1 +
 src/include/ipxe/md5.h                       | 1 +
 src/include/ipxe/memmap.h                    | 1 +
 src/include/ipxe/message.h                   | 1 +
 src/include/ipxe/monojob.h                   | 1 +
 src/include/ipxe/nap.h                       | 1 +
 src/include/ipxe/ndp.h                       | 1 +
 src/include/ipxe/neighbour.h                 | 1 +
 src/include/ipxe/netdevice.h                 | 1 +
 src/include/ipxe/ntlm.h                      | 1 +
 src/include/ipxe/null_acpi.h                 | 1 +
 src/include/ipxe/null_memmap.h               | 1 +
 src/include/ipxe/null_nap.h                  | 1 +
 src/include/ipxe/null_pci.h                  | 1 +
 src/include/ipxe/null_reboot.h               | 1 +
 src/include/ipxe/null_sanboot.h              | 1 +
 src/include/ipxe/null_smbios.h               | 1 +
 src/include/ipxe/null_time.h                 | 1 +
 src/include/ipxe/nvo.h                       | 1 +
 src/include/ipxe/nvs.h                       | 1 +
 src/include/ipxe/open.h                      | 1 +
 src/include/ipxe/params.h                    | 1 +
 src/include/ipxe/parseopt.h                  | 1 +
 src/include/ipxe/pci.h                       | 1 +
 src/include/ipxe/pci_io.h                    | 1 +
 src/include/ipxe/pcicloud.h                  | 1 +
 src/include/ipxe/pending.h                   | 1 +
 src/include/ipxe/ping.h                      | 1 +
 src/include/ipxe/pool.h                      | 1 +
 src/include/ipxe/process.h                   | 1 +
 src/include/ipxe/profile.h                   | 1 +
 src/include/ipxe/quiesce.h                   | 1 +
 src/include/ipxe/reboot.h                    | 1 +
 src/include/ipxe/refcnt.h                    | 1 +
 src/include/ipxe/resolv.h                    | 1 +
 src/include/ipxe/retry.h                     | 1 +
 src/include/ipxe/rotate.h                    | 1 +
 src/include/ipxe/sanboot.h                   | 1 +
 src/include/ipxe/sbat.h                      | 1 +
 src/include/ipxe/script.h                    | 1 +
 src/include/ipxe/scsi.h                      | 1 +
 src/include/ipxe/settings.h                  | 1 +
 src/include/ipxe/settings_ui.h               | 1 +
 src/include/ipxe/shell.h                     | 1 +
 src/include/ipxe/smbios.h                    | 1 +
 src/include/ipxe/socket.h                    | 1 +
 src/include/ipxe/srp.h                       | 1 +
 src/include/ipxe/stp.h                       | 1 +
 src/include/ipxe/string.h                    | 1 +
 src/include/ipxe/tables.h                    | 1 +
 src/include/ipxe/tcp.h                       | 1 +
 src/include/ipxe/tcpip.h                     | 1 +
 src/include/ipxe/tftp.h                      | 1 +
 src/include/ipxe/time.h                      | 1 +
 src/include/ipxe/timer.h                     | 1 +
 src/include/ipxe/uaccess.h                   | 1 +
 src/include/ipxe/udp.h                       | 1 +
 src/include/ipxe/uheap.h                     | 1 +
 src/include/ipxe/umalloc.h                   | 1 +
 src/include/ipxe/uri.h                       | 1 +
 src/include/ipxe/usb.h                       | 1 +
 src/include/ipxe/utf8.h                      | 1 +
 src/include/ipxe/uuid.h                      | 1 +
 src/include/ipxe/version.h                   | 1 +
 src/include/ipxe/virt_offset.h               | 1 +
 src/include/ipxe/vlan.h                      | 1 +
 src/include/ipxe/vsprintf.h                  | 1 +
 src/include/ipxe/widget.h                    | 1 +
 src/include/ipxe/xfer.h                      | 1 +
 src/include/ipxe/xferbuf.h                   | 1 +
 src/include/libgen.h                         | 1 +
 src/include/readline/readline.h              | 1 +
 src/include/stdarg.h                         | 1 +
 src/include/stdbool.h                        | 1 +
 src/include/stddef.h                         | 1 +
 src/include/stdint.h                         | 1 +
 src/include/stdio.h                          | 1 +
 src/include/stdlib.h                         | 1 +
 src/include/string.h                         | 1 +
 src/include/strings.h                        | 1 +
 src/include/sys/time.h                       | 1 +
 src/include/syslog.h                         | 1 +
 src/include/time.h                           | 1 +
 src/include/unistd.h                         | 1 +
 src/include/usr/autoboot.h                   | 1 +
 src/include/usr/dhcpmgmt.h                   | 1 +
 src/include/usr/ifmgmt.h                     | 1 +
 src/include/usr/imgmgmt.h                    | 1 +
 src/include/usr/prompt.h                     | 1 +
 src/include/usr/route.h                      | 1 +
 src/include/usr/shimmgmt.h                   | 1 +
 src/include/usr/sync.h                       | 1 +
 src/include/valgrind/memcheck.h              | 1 +
 src/include/valgrind/valgrind.h              | 1 +
 src/include/wchar.h                          | 1 +
 src/interface/efi/efi_acpi.c                 | 1 +
 src/interface/efi/efi_autoboot.c             | 1 +
 src/interface/efi/efi_autoexec.c             | 1 +
 src/interface/efi/efi_block.c                | 1 +
 src/interface/efi/efi_cachedhcp.c            | 1 +
 src/interface/efi/efi_cmdline.c              | 1 +
 src/interface/efi/efi_connect.c              | 1 +
 src/interface/efi/efi_console.c              | 1 +
 src/interface/efi/efi_download.c             | 1 +
 src/interface/efi/efi_driver.c               | 1 +
 src/interface/efi/efi_file.c                 | 1 +
 src/interface/efi/efi_guid.c                 | 1 +
 src/interface/efi/efi_hii.c                  | 1 +
 src/interface/efi/efi_init.c                 | 1 +
 src/interface/efi/efi_local.c                | 1 +
 src/interface/efi/efi_nap.c                  | 1 +
 src/interface/efi/efi_null.c                 | 1 +
 src/interface/efi/efi_open.c                 | 1 +
 src/interface/efi/efi_path.c                 | 1 +
 src/interface/efi/efi_pci.c                  | 1 +
 src/interface/efi/efi_pxe.c                  | 1 +
 src/interface/efi/efi_reboot.c               | 1 +
 src/interface/efi/efi_service.c              | 1 +
 src/interface/efi/efi_settings.c             | 1 +
 src/interface/efi/efi_shim.c                 | 2 ++
 src/interface/efi/efi_smbios.c               | 1 +
 src/interface/efi/efi_snp.c                  | 1 +
 src/interface/efi/efi_snp_hii.c              | 1 +
 src/interface/efi/efi_strings.c              | 1 +
 src/interface/efi/efi_table.c                | 1 +
 src/interface/efi/efi_time.c                 | 1 +
 src/interface/efi/efi_timer.c                | 1 +
 src/interface/efi/efi_umalloc.c              | 1 +
 src/interface/efi/efi_utils.c                | 1 +
 src/interface/efi/efi_veto.c                 | 1 +
 src/interface/efi/efi_watchdog.c             | 1 +
 src/interface/efi/efi_wrap.c                 | 1 +
 src/interface/efi/efiprefix.c                | 1 +
 src/interface/smbios/smbios.c                | 1 +
 src/interface/smbios/smbios_settings.c       | 1 +
 src/net/aoe.c                                | 1 +
 src/net/arp.c                                | 1 +
 src/net/dhcpopts.c                           | 1 +
 src/net/dhcppkt.c                            | 1 +
 src/net/eap.c                                | 1 +
 src/net/eap_md5.c                            | 1 +
 src/net/eapol.c                              | 1 +
 src/net/eth_slow.c                           | 1 +
 src/net/ethernet.c                           | 1 +
 src/net/fakedhcp.c                           | 1 +
 src/net/fragment.c                           | 1 +
 src/net/icmp.c                               | 1 +
 src/net/icmpv4.c                             | 1 +
 src/net/icmpv6.c                             | 1 +
 src/net/iobpad.c                             | 1 +
 src/net/ipv4.c                               | 1 +
 src/net/ipv6.c                               | 1 +
 src/net/lldp.c                               | 1 +
 src/net/ndp.c                                | 1 +
 src/net/neighbour.c                          | 1 +
 src/net/netdev_settings.c                    | 1 +
 src/net/netdevice.c                          | 1 +
 src/net/nullnet.c                            | 1 +
 src/net/retry.c                              | 1 +
 src/net/socket.c                             | 1 +
 src/net/stp.c                                | 1 +
 src/net/tcp.c                                | 1 +
 src/net/tcp/http.c                           | 1 +
 src/net/tcp/httpauth.c                       | 1 +
 src/net/tcp/httpbasic.c                      | 1 +
 src/net/tcp/httpblock.c                      | 1 +
 src/net/tcp/httpconn.c                       | 1 +
 src/net/tcp/httpcore.c                       | 1 +
 src/net/tcp/httpdigest.c                     | 1 +
 src/net/tcp/iscsi.c                          | 1 +
 src/net/tcpip.c                              | 1 +
 src/net/udp.c                                | 1 +
 src/net/udp/dhcp.c                           | 1 +
 src/net/udp/dhcpv6.c                         | 1 +
 src/net/udp/dns.c                            | 1 +
 src/net/udp/tftp.c                           | 1 +
 src/net/vlan.c                               | 1 +
 src/usr/autoboot.c                           | 1 +
 src/usr/dhcpmgmt.c                           | 1 +
 src/usr/ifmgmt.c                             | 1 +
 src/usr/imgmgmt.c                            | 1 +
 src/usr/prompt.c                             | 1 +
 src/usr/route.c                              | 1 +
 src/usr/route_ipv4.c                         | 1 +
 src/usr/route_ipv6.c                         | 1 +
 src/usr/shimmgmt.c                           | 1 +
 src/usr/sync.c                               | 1 +
 497 files changed, 498 insertions(+)

(limited to 'src/core')

diff --git a/src/arch/x86/core/cpuid.c b/src/arch/x86/core/cpuid.c
index b7d9fb6c6..0461b846e 100644
--- a/src/arch/x86/core/cpuid.c
+++ b/src/arch/x86/core/cpuid.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/arch/x86/core/x86_string.c b/src/arch/x86/core/x86_string.c
index 1a1e79dac..923552f66 100644
--- a/src/arch/x86/core/x86_string.c
+++ b/src/arch/x86/core/x86_string.c
@@ -28,6 +28,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <config/defaults.h>
diff --git a/src/arch/x86/core/x86_tcpip.c b/src/arch/x86/core/x86_tcpip.c
index ed323d5d0..b3bfe2546 100644
--- a/src/arch/x86/core/x86_tcpip.c
+++ b/src/arch/x86/core/x86_tcpip.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/arch/x86/hci/commands/cpuid_cmd.c b/src/arch/x86/hci/commands/cpuid_cmd.c
index b1978d5f2..f4d7305e8 100644
--- a/src/arch/x86/hci/commands/cpuid_cmd.c
+++ b/src/arch/x86/hci/commands/cpuid_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/arch/x86/include/bits/acpi.h b/src/arch/x86/include/bits/acpi.h
index a6ff90804..287bdafeb 100644
--- a/src/arch/x86/include/bits/acpi.h
+++ b/src/arch/x86/include/bits/acpi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsdp.h>
 
diff --git a/src/arch/x86/include/bits/endian.h b/src/arch/x86/include/bits/endian.h
index 85718cfdd..72279117d 100644
--- a/src/arch/x86/include/bits/endian.h
+++ b/src/arch/x86/include/bits/endian.h
@@ -2,6 +2,7 @@
 #define _BITS_ENDIAN_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #define __BYTE_ORDER __LITTLE_ENDIAN
 
diff --git a/src/arch/x86/include/bits/errfile.h b/src/arch/x86/include/bits/errfile.h
index 4fa9acef6..e7aec6f39 100644
--- a/src/arch/x86/include/bits/errfile.h
+++ b/src/arch/x86/include/bits/errfile.h
@@ -2,6 +2,7 @@
 #define _BITS_ERRFILE_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @addtogroup errfile Error file identifiers
diff --git a/src/arch/x86/include/bits/io.h b/src/arch/x86/include/bits/io.h
index 95673ad8d..cde0b6829 100644
--- a/src/arch/x86/include/bits/io.h
+++ b/src/arch/x86/include/bits/io.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Page shift */
 #define PAGE_SHIFT 12
diff --git a/src/arch/x86/include/bits/iomap.h b/src/arch/x86/include/bits/iomap.h
index d6fff257e..d524bd805 100644
--- a/src/arch/x86/include/bits/iomap.h
+++ b/src/arch/x86/include/bits/iomap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/iomap_pages.h>
 
diff --git a/src/arch/x86/include/bits/memmap.h b/src/arch/x86/include/bits/memmap.h
index 8f821563c..e68550fb8 100644
--- a/src/arch/x86/include/bits/memmap.h
+++ b/src/arch/x86/include/bits/memmap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/int15.h>
 
diff --git a/src/arch/x86/include/bits/nap.h b/src/arch/x86/include/bits/nap.h
index b7dea736d..52c8d81ba 100644
--- a/src/arch/x86/include/bits/nap.h
+++ b/src/arch/x86/include/bits/nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/bios_nap.h>
 
diff --git a/src/arch/x86/include/bits/pci_io.h b/src/arch/x86/include/bits/pci_io.h
index b41e562ee..b6c01e5c4 100644
--- a/src/arch/x86/include/bits/pci_io.h
+++ b/src/arch/x86/include/bits/pci_io.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/pcibios.h>
 #include <ipxe/pcidirect.h>
diff --git a/src/arch/x86/include/bits/reboot.h b/src/arch/x86/include/bits/reboot.h
index e702dd3d0..8d8d0b40e 100644
--- a/src/arch/x86/include/bits/reboot.h
+++ b/src/arch/x86/include/bits/reboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/bios_reboot.h>
 
diff --git a/src/arch/x86/include/bits/sanboot.h b/src/arch/x86/include/bits/sanboot.h
index 1b9924e64..ff7b88d14 100644
--- a/src/arch/x86/include/bits/sanboot.h
+++ b/src/arch/x86/include/bits/sanboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/bios_sanboot.h>
 
diff --git a/src/arch/x86/include/bits/smbios.h b/src/arch/x86/include/bits/smbios.h
index 9977c87ac..2be98d887 100644
--- a/src/arch/x86/include/bits/smbios.h
+++ b/src/arch/x86/include/bits/smbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/bios_smbios.h>
 
diff --git a/src/arch/x86/include/bits/string.h b/src/arch/x86/include/bits/string.h
index c26fe30d5..8b2b3070b 100644
--- a/src/arch/x86/include/bits/string.h
+++ b/src/arch/x86/include/bits/string.h
@@ -25,6 +25,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/arch/x86/include/bits/tcpip.h b/src/arch/x86/include/bits/tcpip.h
index 0ac55b1a0..52d032427 100644
--- a/src/arch/x86/include/bits/tcpip.h
+++ b/src/arch/x86/include/bits/tcpip.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern uint16_t tcpip_continue_chksum ( uint16_t partial, const void *data,
 					size_t len );
diff --git a/src/arch/x86/include/bits/time.h b/src/arch/x86/include/bits/time.h
index 556d96f64..a4aa8cc6e 100644
--- a/src/arch/x86/include/bits/time.h
+++ b/src/arch/x86/include/bits/time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rtc_time.h>
 
diff --git a/src/arch/x86/include/ipxe/bios_nap.h b/src/arch/x86/include/ipxe/bios_nap.h
index c9b82c1e5..7d94b3c4a 100644
--- a/src/arch/x86/include/ipxe/bios_nap.h
+++ b/src/arch/x86/include/ipxe/bios_nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef NAP_PCBIOS
 #define NAP_PREFIX_pcbios
diff --git a/src/arch/x86/include/ipxe/bios_reboot.h b/src/arch/x86/include/ipxe/bios_reboot.h
index 3f6df9073..bd1bb42cc 100644
--- a/src/arch/x86/include/ipxe/bios_reboot.h
+++ b/src/arch/x86/include/ipxe/bios_reboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef REBOOT_PCBIOS
 #define REBOOT_PREFIX_pcbios
diff --git a/src/arch/x86/include/ipxe/bios_sanboot.h b/src/arch/x86/include/ipxe/bios_sanboot.h
index 85d698039..d28339e4e 100644
--- a/src/arch/x86/include/ipxe/bios_sanboot.h
+++ b/src/arch/x86/include/ipxe/bios_sanboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SANBOOT_PCBIOS
 #define SANBOOT_PREFIX_pcbios
diff --git a/src/arch/x86/include/ipxe/bios_smbios.h b/src/arch/x86/include/ipxe/bios_smbios.h
index 9f7f9c8ff..1815e3617 100644
--- a/src/arch/x86/include/ipxe/bios_smbios.h
+++ b/src/arch/x86/include/ipxe/bios_smbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SMBIOS_PCBIOS
 #define SMBIOS_PREFIX_pcbios
diff --git a/src/arch/x86/include/ipxe/cpuid.h b/src/arch/x86/include/ipxe/cpuid.h
index 99b91c5c8..1851a859b 100644
--- a/src/arch/x86/include/ipxe/cpuid.h
+++ b/src/arch/x86/include/ipxe/cpuid.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/arch/x86/include/ipxe/int15.h b/src/arch/x86/include/ipxe/int15.h
index e8aa9e2f5..590c0e9a7 100644
--- a/src/arch/x86/include/ipxe/int15.h
+++ b/src/arch/x86/include/ipxe/int15.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef MEMMAP_INT15
 #define MEMMAP_PREFIX_int15
diff --git a/src/arch/x86/include/ipxe/iomap_pages.h b/src/arch/x86/include/ipxe/iomap_pages.h
index 18e0a3002..e74dabd90 100644
--- a/src/arch/x86/include/ipxe/iomap_pages.h
+++ b/src/arch/x86/include/ipxe/iomap_pages.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef IOMAP_PAGES
 #define IOMAP_PREFIX_pages
diff --git a/src/arch/x86/include/ipxe/pcibios.h b/src/arch/x86/include/ipxe/pcibios.h
index b62b470f0..2fd03198e 100644
--- a/src/arch/x86/include/ipxe/pcibios.h
+++ b/src/arch/x86/include/ipxe/pcibios.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef PCIAPI_PCBIOS
 #define PCIAPI_PREFIX_pcbios
diff --git a/src/arch/x86/include/ipxe/pcidirect.h b/src/arch/x86/include/ipxe/pcidirect.h
index 1515b20d4..5863b4d16 100644
--- a/src/arch/x86/include/ipxe/pcidirect.h
+++ b/src/arch/x86/include/ipxe/pcidirect.h
@@ -2,6 +2,7 @@
 #define _PCIDIRECT_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/io.h>
diff --git a/src/arch/x86/include/ipxe/rsdp.h b/src/arch/x86/include/ipxe/rsdp.h
index daaa43077..f371d9a20 100644
--- a/src/arch/x86/include/ipxe/rsdp.h
+++ b/src/arch/x86/include/ipxe/rsdp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef ACPI_RSDP
 #define ACPI_PREFIX_rsdp
diff --git a/src/arch/x86/include/ipxe/rtc_time.h b/src/arch/x86/include/ipxe/rtc_time.h
index cb8c7f49e..49c6313ed 100644
--- a/src/arch/x86/include/ipxe/rtc_time.h
+++ b/src/arch/x86/include/ipxe/rtc_time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef TIME_RTC
 #define TIME_PREFIX_rtc
diff --git a/src/arch/x86/include/ipxe/x86_io.h b/src/arch/x86/include/ipxe/x86_io.h
index eeb3f8454..164b57e92 100644
--- a/src/arch/x86/include/ipxe/x86_io.h
+++ b/src/arch/x86/include/ipxe/x86_io.h
@@ -16,6 +16,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef IOAPI_X86
 #define IOAPI_PREFIX_x86
diff --git a/src/arch/x86_64/include/bits/byteswap.h b/src/arch/x86_64/include/bits/byteswap.h
index d8c5098ef..7c48a27ca 100644
--- a/src/arch/x86_64/include/bits/byteswap.h
+++ b/src/arch/x86_64/include/bits/byteswap.h
@@ -10,6 +10,7 @@
 #include <stdint.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 static inline __attribute__ (( always_inline, const )) uint16_t
 __bswap_variable_16 ( uint16_t x ) {
diff --git a/src/arch/x86_64/include/bits/compiler.h b/src/arch/x86_64/include/bits/compiler.h
index 1c04a7b30..99185b058 100644
--- a/src/arch/x86_64/include/bits/compiler.h
+++ b/src/arch/x86_64/include/bits/compiler.h
@@ -2,6 +2,7 @@
 #define _BITS_COMPILER_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Dummy relocation type */
 #define RELOC_TYPE_NONE R_X86_64_NONE
diff --git a/src/arch/x86_64/include/bits/profile.h b/src/arch/x86_64/include/bits/profile.h
index c85b6fe5c..c8e0a21f1 100644
--- a/src/arch/x86_64/include/bits/profile.h
+++ b/src/arch/x86_64/include/bits/profile.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/arch/x86_64/include/bits/stdint.h b/src/arch/x86_64/include/bits/stdint.h
index fe1f9946a..e75bed502 100644
--- a/src/arch/x86_64/include/bits/stdint.h
+++ b/src/arch/x86_64/include/bits/stdint.h
@@ -2,6 +2,7 @@
 #define _BITS_STDINT_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 typedef __SIZE_TYPE__		size_t;
 typedef signed long		ssize_t;
diff --git a/src/arch/x86_64/include/bits/strings.h b/src/arch/x86_64/include/bits/strings.h
index 3b7911f3b..6da8f1350 100644
--- a/src/arch/x86_64/include/bits/strings.h
+++ b/src/arch/x86_64/include/bits/strings.h
@@ -2,6 +2,7 @@
 #define _BITS_STRINGS_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Find first (i.e. least significant) set bit
diff --git a/src/arch/x86_64/include/ipxe/efi/dhcparch.h b/src/arch/x86_64/include/ipxe/efi/dhcparch.h
index ccf0f46a0..f75bf9145 100644
--- a/src/arch/x86_64/include/ipxe/efi/dhcparch.h
+++ b/src/arch/x86_64/include/ipxe/efi/dhcparch.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/dhcp.h>
 
diff --git a/src/arch/x86_64/include/limits.h b/src/arch/x86_64/include/limits.h
index a1374a17f..e75461acb 100644
--- a/src/arch/x86_64/include/limits.h
+++ b/src/arch/x86_64/include/limits.h
@@ -2,6 +2,7 @@
 #define LIMITS_H	1
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /* Number of bits in a `char' */
 #define CHAR_BIT	8
diff --git a/src/config/branding.h b/src/config/branding.h
index 454bf0c03..f28e1b5d2 100644
--- a/src/config/branding.h
+++ b/src/config/branding.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/colour.h b/src/config/colour.h
index 98198f12f..bde6f9719 100644
--- a/src/config/colour.h
+++ b/src/config/colour.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #define COLOR_NORMAL_FG		COLOR_WHITE
 #define COLOR_NORMAL_BG		COLOR_BLUE
diff --git a/src/config/config.c b/src/config/config.c
index e49f236a3..c32bcee88 100644
--- a/src/config/config.c
+++ b/src/config/config.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 #include <config/console.h>
diff --git a/src/config/config_eap.c b/src/config/config_eap.c
index e18c48cae..0c9b7b687 100644
--- a/src/config/config_eap.c
+++ b/src/config/config_eap.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_efi.c b/src/config/config_efi.c
index 92678d12d..8daaa4329 100644
--- a/src/config/config_efi.c
+++ b/src/config/config_efi.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 #include <config/console.h>
diff --git a/src/config/config_ethernet.c b/src/config/config_ethernet.c
index c1b35bfe6..03ed371a7 100644
--- a/src/config/config_ethernet.c
+++ b/src/config/config_ethernet.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_http.c b/src/config/config_http.c
index 4373ea2c0..ee0643c91 100644
--- a/src/config/config_http.c
+++ b/src/config/config_http.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_pci.c b/src/config/config_pci.c
index b2adae995..c6c9b92a5 100644
--- a/src/config/config_pci.c
+++ b/src/config/config_pci.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/settings.h>
 #include <config/ioapi.h>
diff --git a/src/config/config_route.c b/src/config/config_route.c
index c0b4ee91d..59d8f3550 100644
--- a/src/config/config_route.c
+++ b/src/config/config_route.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_timer.c b/src/config/config_timer.c
index a4fe69b00..12b806129 100644
--- a/src/config/config_timer.c
+++ b/src/config/config_timer.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/timer.h>
 
diff --git a/src/config/console.h b/src/config/console.h
index 0ff328b7c..028021fa2 100644
--- a/src/config/console.h
+++ b/src/config/console.h
@@ -11,6 +11,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/defaults.h b/src/config/defaults.h
index 32d6dbcce..767b67fdf 100644
--- a/src/config/defaults.h
+++ b/src/config/defaults.h
@@ -2,6 +2,7 @@
 #define CONFIG_DEFAULTS_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #define CONFIG_DEFAULTS(_platform) <config/defaults/_platform.h>
 
diff --git a/src/config/defaults/efi.h b/src/config/defaults/efi.h
index 4c9ba9d2a..524b2b0ea 100644
--- a/src/config/defaults/efi.h
+++ b/src/config/defaults/efi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #define UACCESS_FLAT
 #define IOMAP_VIRT
diff --git a/src/config/dhcp.h b/src/config/dhcp.h
index adfa74a15..65180c38c 100644
--- a/src/config/dhcp.h
+++ b/src/config/dhcp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/fault.h b/src/config/fault.h
index 5912ae1a6..ab5503fa2 100644
--- a/src/config/fault.h
+++ b/src/config/fault.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/general.h b/src/config/general.h
index 683c02ffb..f77248836 100644
--- a/src/config/general.h
+++ b/src/config/general.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/ioapi.h b/src/config/ioapi.h
index a1498482d..d4ef91f76 100644
--- a/src/config/ioapi.h
+++ b/src/config/ioapi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/named.h b/src/config/named.h
index ddde6f0a6..f46524f81 100644
--- a/src/config/named.h
+++ b/src/config/named.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /* config/<name>/<header>.h */
 #ifdef CONFIG
diff --git a/src/config/nap.h b/src/config/nap.h
index e4fe97964..55ff64116 100644
--- a/src/config/nap.h
+++ b/src/config/nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/reboot.h b/src/config/reboot.h
index 2d1648e7b..a7f90ead1 100644
--- a/src/config/reboot.h
+++ b/src/config/reboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/sanboot.h b/src/config/sanboot.h
index ccc4bda1f..962caec40 100644
--- a/src/config/sanboot.h
+++ b/src/config/sanboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/settings.h b/src/config/settings.h
index 7b4af4fdf..bba8c631a 100644
--- a/src/config/settings.h
+++ b/src/config/settings.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/sideband.h b/src/config/sideband.h
index dd704f9bb..039d28df0 100644
--- a/src/config/sideband.h
+++ b/src/config/sideband.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 //#define	CONFIG_BOFM	/* IBM's BladeCenter Open Fabric Manager */
 
diff --git a/src/config/time.h b/src/config/time.h
index 678f6f864..f938f3aa7 100644
--- a/src/config/time.h
+++ b/src/config/time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/timer.h b/src/config/timer.h
index 5a54d398c..d2368a13a 100644
--- a/src/config/timer.h
+++ b/src/config/timer.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/umalloc.h b/src/config/umalloc.h
index 832dd21d1..87fb34527 100644
--- a/src/config/umalloc.h
+++ b/src/config/umalloc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/core/acpi.c b/src/core/acpi.c
index 3fbf25bd1..d8c1903f3 100644
--- a/src/core/acpi.c
+++ b/src/core/acpi.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/core/ansicol.c b/src/core/ansicol.c
index ddf9ba77c..d53ebeeb6 100644
--- a/src/core/ansicol.c
+++ b/src/core/ansicol.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <errno.h>
diff --git a/src/core/ansiesc.c b/src/core/ansiesc.c
index 7f545db0e..57a2345d7 100644
--- a/src/core/ansiesc.c
+++ b/src/core/ansiesc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <assert.h>
diff --git a/src/core/asprintf.c b/src/core/asprintf.c
index 00edf8e11..17a65c715 100644
--- a/src/core/asprintf.c
+++ b/src/core/asprintf.c
@@ -5,6 +5,7 @@
 #include <errno.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Write a formatted string to newly allocated memory.
diff --git a/src/core/base16.c b/src/core/base16.c
index 47e35f414..0c597480f 100644
--- a/src/core/base16.c
+++ b/src/core/base16.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/core/base64.c b/src/core/base64.c
index ec11be261..fe7198c42 100644
--- a/src/core/base64.c
+++ b/src/core/base64.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/core/basename.c b/src/core/basename.c
index f4f929517..7a903c25f 100644
--- a/src/core/basename.c
+++ b/src/core/basename.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/bitmap.c b/src/core/bitmap.c
index 2aac33870..e3570c629 100644
--- a/src/core/bitmap.c
+++ b/src/core/bitmap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/bitmap.h>
diff --git a/src/core/blockdev.c b/src/core/blockdev.c
index 3513caafa..ff0f3b68b 100644
--- a/src/core/blockdev.c
+++ b/src/core/blockdev.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/interface.h>
diff --git a/src/core/blocktrans.c b/src/core/blocktrans.c
index b793185fe..d9c24582c 100644
--- a/src/core/blocktrans.c
+++ b/src/core/blocktrans.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/cachedhcp.c b/src/core/cachedhcp.c
index eeb2fca58..3f6564efd 100644
--- a/src/core/cachedhcp.c
+++ b/src/core/cachedhcp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/core/console.c b/src/core/console.c
index 2b90809bf..240dde3d6 100644
--- a/src/core/console.c
+++ b/src/core/console.c
@@ -6,6 +6,7 @@
 /** @file */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Current console usage */
 int console_usage = CONSOLE_USAGE_STDOUT;
diff --git a/src/core/cpio.c b/src/core/cpio.c
index 15e33d206..d2f9d0c2d 100644
--- a/src/core/cpio.c
+++ b/src/core/cpio.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/ctype.c b/src/core/ctype.c
index 891af71ea..d7de060e3 100644
--- a/src/core/ctype.c
+++ b/src/core/ctype.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/cwuri.c b/src/core/cwuri.c
index 612f0b179..36475b159 100644
--- a/src/core/cwuri.c
+++ b/src/core/cwuri.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/uri.h>
diff --git a/src/core/debug.c b/src/core/debug.c
index 9b2a823f5..3f7661dda 100644
--- a/src/core/debug.c
+++ b/src/core/debug.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <stdint.h>
diff --git a/src/core/device.c b/src/core/device.c
index efe4eb687..2ab5fa117 100644
--- a/src/core/device.c
+++ b/src/core/device.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/list.h>
diff --git a/src/core/dma.c b/src/core/dma.c
index 3f3023c4d..dc266545b 100644
--- a/src/core/dma.c
+++ b/src/core/dma.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 #include <errno.h>
diff --git a/src/core/downloader.c b/src/core/downloader.c
index 1c638f502..aa81e7365 100644
--- a/src/core/downloader.c
+++ b/src/core/downloader.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/core/dynui.c b/src/core/dynui.c
index 3d139c02a..c2af95f86 100644
--- a/src/core/dynui.c
+++ b/src/core/dynui.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/edd.c b/src/core/edd.c
index a50b74ab1..4fcccf117 100644
--- a/src/core/edd.c
+++ b/src/core/edd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/interface.h>
diff --git a/src/core/errno.c b/src/core/errno.c
index 5de15bb92..7afa40859 100644
--- a/src/core/errno.c
+++ b/src/core/errno.c
@@ -1,6 +1,7 @@
 #include <errno.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/exec.c b/src/core/exec.c
index 534fb9993..4db1248b0 100644
--- a/src/core/exec.c
+++ b/src/core/exec.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/core/getkey.c b/src/core/getkey.c
index 0c280d23b..c952e0aea 100644
--- a/src/core/getkey.c
+++ b/src/core/getkey.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ctype.h>
 #include <ipxe/console.h>
diff --git a/src/core/getopt.c b/src/core/getopt.c
index e6c3948d1..cb4cbf118 100644
--- a/src/core/getopt.c
+++ b/src/core/getopt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/core/image.c b/src/core/image.c
index b2bd0956b..7df125971 100644
--- a/src/core/image.c
+++ b/src/core/image.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <string.h>
diff --git a/src/core/init.c b/src/core/init.c
index 406d22d7b..2a32f5795 100644
--- a/src/core/init.c
+++ b/src/core/init.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/device.h>
 #include <ipxe/console.h>
diff --git a/src/core/interface.c b/src/core/interface.c
index ea0606893..0ebcc8e51 100644
--- a/src/core/interface.c
+++ b/src/core/interface.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/interface.h>
diff --git a/src/core/iobuf.c b/src/core/iobuf.c
index 78fa23924..7e9a4156d 100644
--- a/src/core/iobuf.c
+++ b/src/core/iobuf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <strings.h>
diff --git a/src/core/job.c b/src/core/job.c
index 65df80056..f83ce0552 100644
--- a/src/core/job.c
+++ b/src/core/job.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/core/keymap.c b/src/core/keymap.c
index 36db7bd4c..e2244fdcb 100644
--- a/src/core/keymap.c
+++ b/src/core/keymap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ctype.h>
diff --git a/src/core/linebuf.c b/src/core/linebuf.c
index c197e383c..8995dca66 100644
--- a/src/core/linebuf.c
+++ b/src/core/linebuf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/list.c b/src/core/list.c
index 5175c84ec..8d38d690a 100644
--- a/src/core/list.c
+++ b/src/core/list.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/main.c b/src/core/main.c
index 3db836491..95e16132f 100644
--- a/src/core/main.c
+++ b/src/core/main.c
@@ -13,6 +13,7 @@ Literature dealing with the network protocols:
 **************************************************************************/
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdio.h>
diff --git a/src/core/malloc.c b/src/core/malloc.c
index 877687d81..3a9f23ee4 100644
--- a/src/core/malloc.c
+++ b/src/core/malloc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/core/monojob.c b/src/core/monojob.c
index 2f066331c..ff22b4ac8 100644
--- a/src/core/monojob.c
+++ b/src/core/monojob.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdio.h>
diff --git a/src/core/nvo.c b/src/core/nvo.c
index d2c9b5e73..8e500f816 100644
--- a/src/core/nvo.c
+++ b/src/core/nvo.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/core/open.c b/src/core/open.c
index f9198c9d9..8daa90f55 100644
--- a/src/core/open.c
+++ b/src/core/open.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdarg.h>
 #include <string.h>
diff --git a/src/core/params.c b/src/core/params.c
index 58c829f62..d3fffc312 100644
--- a/src/core/params.c
+++ b/src/core/params.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/parseopt.c b/src/core/parseopt.c
index b657c3fce..b920a7d84 100644
--- a/src/core/parseopt.c
+++ b/src/core/parseopt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/core/pending.c b/src/core/pending.c
index 96d0cf197..4a1dd6a34 100644
--- a/src/core/pending.c
+++ b/src/core/pending.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/process.h>
diff --git a/src/core/pool.c b/src/core/pool.c
index 0163405f7..daf761aa3 100644
--- a/src/core/pool.c
+++ b/src/core/pool.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/process.c b/src/core/process.c
index c944b6f50..883469dc5 100644
--- a/src/core/process.c
+++ b/src/core/process.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 #include <ipxe/init.h>
diff --git a/src/core/quiesce.c b/src/core/quiesce.c
index 5d2a919d0..9c4e37849 100644
--- a/src/core/quiesce.c
+++ b/src/core/quiesce.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/random.c b/src/core/random.c
index e3251964b..e8fbe6966 100644
--- a/src/core/random.c
+++ b/src/core/random.c
@@ -5,6 +5,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/core/refcnt.c b/src/core/refcnt.c
index 47c975a0b..a66511291 100644
--- a/src/core/refcnt.c
+++ b/src/core/refcnt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <ipxe/refcnt.h>
diff --git a/src/core/resolv.c b/src/core/resolv.c
index fab8def4b..0fc02ccf4 100644
--- a/src/core/resolv.c
+++ b/src/core/resolv.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/core/sanboot.c b/src/core/sanboot.c
index e90c5ef1d..45cd5eff3 100644
--- a/src/core/sanboot.c
+++ b/src/core/sanboot.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/settings.c b/src/core/settings.c
index 05e495dcf..129620e00 100644
--- a/src/core/settings.c
+++ b/src/core/settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/core/string.c b/src/core/string.c
index 364c4cf0e..2af19b7fe 100644
--- a/src/core/string.c
+++ b/src/core/string.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/core/time.c b/src/core/time.c
index c353ac5bd..6d33f6caf 100644
--- a/src/core/time.c
+++ b/src/core/time.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <time.h>
 
diff --git a/src/core/timer.c b/src/core/timer.c
index d45797adb..db0f32cf1 100644
--- a/src/core/timer.c
+++ b/src/core/timer.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/process.h>
diff --git a/src/core/uri.c b/src/core/uri.c
index b82472ef0..9da5e298b 100644
--- a/src/core/uri.c
+++ b/src/core/uri.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/utf8.c b/src/core/utf8.c
index 4ee01baf9..871044fec 100644
--- a/src/core/utf8.c
+++ b/src/core/utf8.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <assert.h>
diff --git a/src/core/uuid.c b/src/core/uuid.c
index b6600af71..0f93e9f8f 100644
--- a/src/core/uuid.c
+++ b/src/core/uuid.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/core/version.c b/src/core/version.c
index cd69a8762..75f3160db 100644
--- a/src/core/version.c
+++ b/src/core/version.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/vsprintf.c b/src/core/vsprintf.c
index 9d3a97c2d..f6032014a 100644
--- a/src/core/vsprintf.c
+++ b/src/core/vsprintf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdarg.h>
diff --git a/src/core/wchar.c b/src/core/wchar.c
index b06cf452a..27a608bf4 100644
--- a/src/core/wchar.c
+++ b/src/core/wchar.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/xfer.c b/src/core/xfer.c
index 269359e15..5ab303bc7 100644
--- a/src/core/xfer.c
+++ b/src/core/xfer.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdlib.h>
diff --git a/src/core/xferbuf.c b/src/core/xferbuf.c
index d93526577..ca3baaab5 100644
--- a/src/core/xferbuf.c
+++ b/src/core/xferbuf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/crypto/chap.c b/src/crypto/chap.c
index c90c16def..008229133 100644
--- a/src/crypto/chap.c
+++ b/src/crypto/chap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/crypto/crc32.c b/src/crypto/crc32.c
index cfef68c02..9ab4899c6 100644
--- a/src/crypto/crc32.c
+++ b/src/crypto/crc32.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crc32.h>
 
diff --git a/src/crypto/md5.c b/src/crypto/md5.c
index 5c62513e2..9418b006c 100644
--- a/src/crypto/md5.c
+++ b/src/crypto/md5.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/drivers/block/ata.c b/src/drivers/block/ata.c
index cf98d7c9f..ee2acdebb 100644
--- a/src/drivers/block/ata.c
+++ b/src/drivers/block/ata.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/drivers/block/ibft.c b/src/drivers/block/ibft.c
index ca5fad9ff..6120b37dd 100644
--- a/src/drivers/block/ibft.c
+++ b/src/drivers/block/ibft.c
@@ -26,6 +26,7 @@
  */
 
 FILE_LICENCE ( BSD2 );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/drivers/block/scsi.c b/src/drivers/block/scsi.c
index 251210d4f..67bf48201 100644
--- a/src/drivers/block/scsi.c
+++ b/src/drivers/block/scsi.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/drivers/bus/pci.c b/src/drivers/bus/pci.c
index 3908871b8..30163300a 100644
--- a/src/drivers/bus/pci.c
+++ b/src/drivers/bus/pci.c
@@ -25,6 +25,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/drivers/bus/pci_settings.c b/src/drivers/bus/pci_settings.c
index fc73c651e..3e320da43 100644
--- a/src/drivers/bus/pci_settings.c
+++ b/src/drivers/bus/pci_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/drivers/net/efi/mnpnet.c b/src/drivers/net/efi/mnpnet.c
index 902eb91f3..fe0ebaadb 100644
--- a/src/drivers/net/efi/mnpnet.c
+++ b/src/drivers/net/efi/mnpnet.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/drivers/net/efi/nii.c b/src/drivers/net/efi/nii.c
index c60d4ca18..d1adf3d44 100644
--- a/src/drivers/net/efi/nii.c
+++ b/src/drivers/net/efi/nii.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <strings.h>
diff --git a/src/drivers/net/efi/nii.h b/src/drivers/net/efi/nii.h
index df7ab7dbe..e0b07f0a5 100644
--- a/src/drivers/net/efi/nii.h
+++ b/src/drivers/net/efi/nii.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct efi_device;
 
diff --git a/src/drivers/net/efi/snpnet.c b/src/drivers/net/efi/snpnet.c
index 8427b6ce3..6046f0a1e 100644
--- a/src/drivers/net/efi/snpnet.c
+++ b/src/drivers/net/efi/snpnet.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/drivers/net/efi/snpnet.h b/src/drivers/net/efi/snpnet.h
index 507350210..a361a99c0 100644
--- a/src/drivers/net/efi/snpnet.h
+++ b/src/drivers/net/efi/snpnet.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 struct efi_device;
 
diff --git a/src/drivers/net/efi/snponly.c b/src/drivers/net/efi/snponly.c
index 876479133..b7231ce01 100644
--- a/src/drivers/net/efi/snponly.c
+++ b/src/drivers/net/efi/snponly.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/drivers/nvs/nvs.c b/src/drivers/nvs/nvs.c
index af7c466c4..42b54123e 100644
--- a/src/drivers/nvs/nvs.c
+++ b/src/drivers/nvs/nvs.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/hci/commands/autoboot_cmd.c b/src/hci/commands/autoboot_cmd.c
index 010c6fcb0..a61333a9d 100644
--- a/src/hci/commands/autoboot_cmd.c
+++ b/src/hci/commands/autoboot_cmd.c
@@ -30,6 +30,7 @@
 #include <usr/autoboot.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/config_cmd.c b/src/hci/commands/config_cmd.c
index 39272196a..cc21ad3fe 100644
--- a/src/hci/commands/config_cmd.c
+++ b/src/hci/commands/config_cmd.c
@@ -31,6 +31,7 @@
 #include <ipxe/settings_ui.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/dhcp_cmd.c b/src/hci/commands/dhcp_cmd.c
index 33c23fc6e..ccc115b87 100644
--- a/src/hci/commands/dhcp_cmd.c
+++ b/src/hci/commands/dhcp_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <stdint.h>
diff --git a/src/hci/commands/dynui_cmd.c b/src/hci/commands/dynui_cmd.c
index 56a4acd06..9d1ea0e93 100644
--- a/src/hci/commands/dynui_cmd.c
+++ b/src/hci/commands/dynui_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/ifmgmt_cmd.c b/src/hci/commands/ifmgmt_cmd.c
index 2906d1d45..f4b9fef3a 100644
--- a/src/hci/commands/ifmgmt_cmd.c
+++ b/src/hci/commands/ifmgmt_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <errno.h>
diff --git a/src/hci/commands/image_cmd.c b/src/hci/commands/image_cmd.c
index 179256862..aaed0ea9b 100644
--- a/src/hci/commands/image_cmd.c
+++ b/src/hci/commands/image_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/hci/commands/login_cmd.c b/src/hci/commands/login_cmd.c
index 005d40342..f8cd73f23 100644
--- a/src/hci/commands/login_cmd.c
+++ b/src/hci/commands/login_cmd.c
@@ -28,6 +28,7 @@
 #include <ipxe/login_ui.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/nvo_cmd.c b/src/hci/commands/nvo_cmd.c
index 69ab97dca..70086afce 100644
--- a/src/hci/commands/nvo_cmd.c
+++ b/src/hci/commands/nvo_cmd.c
@@ -34,6 +34,7 @@
 #include <readline/readline.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/reboot_cmd.c b/src/hci/commands/reboot_cmd.c
index c5b71c045..daef92dc0 100644
--- a/src/hci/commands/reboot_cmd.c
+++ b/src/hci/commands/reboot_cmd.c
@@ -27,6 +27,7 @@
 #include <ipxe/reboot.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/route_cmd.c b/src/hci/commands/route_cmd.c
index a33754399..ff841ec15 100644
--- a/src/hci/commands/route_cmd.c
+++ b/src/hci/commands/route_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <getopt.h>
diff --git a/src/hci/commands/sanboot_cmd.c b/src/hci/commands/sanboot_cmd.c
index 122bee527..7bc60e641 100644
--- a/src/hci/commands/sanboot_cmd.c
+++ b/src/hci/commands/sanboot_cmd.c
@@ -32,6 +32,7 @@
 #include <usr/autoboot.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/shim_cmd.c b/src/hci/commands/shim_cmd.c
index a53bb3fde..1566af4e9 100644
--- a/src/hci/commands/shim_cmd.c
+++ b/src/hci/commands/shim_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <getopt.h>
 #include <ipxe/command.h>
diff --git a/src/hci/commands/sync_cmd.c b/src/hci/commands/sync_cmd.c
index 9d6e6a284..e3b97298c 100644
--- a/src/hci/commands/sync_cmd.c
+++ b/src/hci/commands/sync_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdio.h>
diff --git a/src/hci/editstring.c b/src/hci/editstring.c
index be9ca06a5..f88b81f7f 100644
--- a/src/hci/editstring.c
+++ b/src/hci/editstring.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 #include <errno.h>
diff --git a/src/hci/jumpscroll.c b/src/hci/jumpscroll.c
index 641f781a0..c6ee5bda0 100644
--- a/src/hci/jumpscroll.c
+++ b/src/hci/jumpscroll.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Jump scrolling
diff --git a/src/hci/mucurses/ansi_screen.c b/src/hci/mucurses/ansi_screen.c
index 1cf3309dd..7c607b5cc 100644
--- a/src/hci/mucurses/ansi_screen.c
+++ b/src/hci/mucurses/ansi_screen.c
@@ -4,6 +4,7 @@
 #include <ipxe/console.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 static void ansiscr_reset(struct _curses_screen *scr) __nonnull;
 static void ansiscr_movetoyx(struct _curses_screen *scr,
diff --git a/src/hci/mucurses/clear.c b/src/hci/mucurses/clear.c
index 2054f72cc..d93e9630e 100644
--- a/src/hci/mucurses/clear.c
+++ b/src/hci/mucurses/clear.c
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Clear a window to the bottom from current cursor position
diff --git a/src/hci/mucurses/cursor.h b/src/hci/mucurses/cursor.h
index 2e0c896a6..6f47becae 100644
--- a/src/hci/mucurses/cursor.h
+++ b/src/hci/mucurses/cursor.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct cursor_pos {
 	unsigned int y, x;
diff --git a/src/hci/mucurses/mucurses.c b/src/hci/mucurses/mucurses.c
index 98a8a2c59..7f1779e8f 100644
--- a/src/hci/mucurses/mucurses.c
+++ b/src/hci/mucurses/mucurses.c
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 static void _wupdcurs ( WINDOW *win ) __nonnull;
 void _wputch ( WINDOW *win, chtype ch, int wrap ) __nonnull;
diff --git a/src/hci/mucurses/mucurses.h b/src/hci/mucurses/mucurses.h
index 270394787..dc6187741 100644
--- a/src/hci/mucurses/mucurses.h
+++ b/src/hci/mucurses/mucurses.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #define WRAP 0
 #define NOWRAP 1
diff --git a/src/hci/mucurses/print.c b/src/hci/mucurses/print.c
index e8831c58f..f7e0c8483 100644
--- a/src/hci/mucurses/print.c
+++ b/src/hci/mucurses/print.c
@@ -11,6 +11,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Add a single-byte character and rendition to a window and advance
diff --git a/src/hci/mucurses/widgets/editbox.c b/src/hci/mucurses/widgets/editbox.c
index c024688ab..5dab3ac5c 100644
--- a/src/hci/mucurses/widgets/editbox.c
+++ b/src/hci/mucurses/widgets/editbox.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <assert.h>
diff --git a/src/hci/mucurses/winattrs.c b/src/hci/mucurses/winattrs.c
index 97a5a18b3..e78025543 100644
--- a/src/hci/mucurses/winattrs.c
+++ b/src/hci/mucurses/winattrs.c
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Get the background rendition attributes for a window
diff --git a/src/hci/mucurses/wininit.c b/src/hci/mucurses/wininit.c
index dd84d2f1d..1b651123e 100644
--- a/src/hci/mucurses/wininit.c
+++ b/src/hci/mucurses/wininit.c
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Initialise console environment
diff --git a/src/hci/readline.c b/src/hci/readline.c
index 5b46413e9..3d0330a62 100644
--- a/src/hci/readline.c
+++ b/src/hci/readline.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/hci/shell.c b/src/hci/shell.c
index 7e2ecaab6..cc7910eb8 100644
--- a/src/hci/shell.c
+++ b/src/hci/shell.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/hci/strerror.c b/src/hci/strerror.c
index 1bba8c620..48091b413 100644
--- a/src/hci/strerror.c
+++ b/src/hci/strerror.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Find error description
diff --git a/src/hci/tui/form_ui.c b/src/hci/tui/form_ui.c
index 6cc28c369..2bce952fa 100644
--- a/src/hci/tui/form_ui.c
+++ b/src/hci/tui/form_ui.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/tui/login_ui.c b/src/hci/tui/login_ui.c
index 02552f0d2..31069b154 100644
--- a/src/hci/tui/login_ui.c
+++ b/src/hci/tui/login_ui.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/tui/menu_ui.c b/src/hci/tui/menu_ui.c
index c7fad4a6b..f789a298f 100644
--- a/src/hci/tui/menu_ui.c
+++ b/src/hci/tui/menu_ui.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/tui/message.c b/src/hci/tui/message.c
index e3331d655..89c6f7703 100644
--- a/src/hci/tui/message.c
+++ b/src/hci/tui/message.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/tui/settings_ui.c b/src/hci/tui/settings_ui.c
index 57ff9e9a0..a069c527d 100644
--- a/src/hci/tui/settings_ui.c
+++ b/src/hci/tui/settings_ui.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <stdarg.h>
diff --git a/src/image/efi_image.c b/src/image/efi_image.c
index e7b19c4ce..2631530e7 100644
--- a/src/image/efi_image.c
+++ b/src/image/efi_image.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <stdlib.h>
diff --git a/src/image/embedded.c b/src/image/embedded.c
index 652cfc85f..22d3738cc 100644
--- a/src/image/embedded.c
+++ b/src/image/embedded.c
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/image.h>
diff --git a/src/image/script.c b/src/image/script.c
index 257e59a09..57662b788 100644
--- a/src/image/script.c
+++ b/src/image/script.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/include/assert.h b/src/include/assert.h
index 5affab2db..30277f9a9 100644
--- a/src/include/assert.h
+++ b/src/include/assert.h
@@ -11,6 +11,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifndef ASSERTING
 #ifdef NDEBUG
diff --git a/src/include/bits/dma.h b/src/include/bits/dma.h
index e9cb84942..c44b3e456 100644
--- a/src/include/bits/dma.h
+++ b/src/include/bits/dma.h
@@ -11,5 +11,6 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #endif /* _BITS_DMA_H */
diff --git a/src/include/bits/uaccess.h b/src/include/bits/uaccess.h
index 09f5f46c8..e3f8b1412 100644
--- a/src/include/bits/uaccess.h
+++ b/src/include/bits/uaccess.h
@@ -11,5 +11,6 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #endif /* _BITS_UACCESS_H */
diff --git a/src/include/bits/umalloc.h b/src/include/bits/umalloc.h
index 4927f0d00..689755b00 100644
--- a/src/include/bits/umalloc.h
+++ b/src/include/bits/umalloc.h
@@ -11,5 +11,6 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #endif /* _BITS_UMALLOC_H */
diff --git a/src/include/bits/virt_offset.h b/src/include/bits/virt_offset.h
index 5f026284c..a67b6941e 100644
--- a/src/include/bits/virt_offset.h
+++ b/src/include/bits/virt_offset.h
@@ -11,5 +11,6 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #endif /* _BITS_VIRT_OFFSET_H */
diff --git a/src/include/byteswap.h b/src/include/byteswap.h
index d1028c579..0910e4e2c 100644
--- a/src/include/byteswap.h
+++ b/src/include/byteswap.h
@@ -2,6 +2,7 @@
 #define BYTESWAP_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <endian.h>
diff --git a/src/include/ctype.h b/src/include/ctype.h
index 6fefd5d77..15109ff9d 100644
--- a/src/include/ctype.h
+++ b/src/include/ctype.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Check if character is ASCII
diff --git a/src/include/curses.h b/src/include/curses.h
index cf8cc53c9..bbc437a4e 100644
--- a/src/include/curses.h
+++ b/src/include/curses.h
@@ -13,6 +13,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #undef  ERR
 #define ERR	(-1)
diff --git a/src/include/endian.h b/src/include/endian.h
index bdae9de45..5565673ca 100644
--- a/src/include/endian.h
+++ b/src/include/endian.h
@@ -2,6 +2,7 @@
 #define _ENDIAN_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Constant representing little-endian byte order
  *
diff --git a/src/include/errno.h b/src/include/errno.h
index ac012a691..8900cdb34 100644
--- a/src/include/errno.h
+++ b/src/include/errno.h
@@ -25,6 +25,7 @@
 #define ERRNO_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/include/getopt.h b/src/include/getopt.h
index db3de1786..4087c332f 100644
--- a/src/include/getopt.h
+++ b/src/include/getopt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 
diff --git a/src/include/hci/ifmgmt_cmd.h b/src/include/hci/ifmgmt_cmd.h
index 5debf85c2..f1008e14f 100644
--- a/src/include/hci/ifmgmt_cmd.h
+++ b/src/include/hci/ifmgmt_cmd.h
@@ -25,6 +25,7 @@
 #define _IFMGMT_CMD_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/parseopt.h>
 
diff --git a/src/include/ipxe/acpi.h b/src/include/ipxe/acpi.h
index 5e9fb5eba..c423aa584 100644
--- a/src/include/ipxe/acpi.h
+++ b/src/include/ipxe/acpi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <byteswap.h>
diff --git a/src/include/ipxe/ansicol.h b/src/include/ipxe/ansicol.h
index 2b54ecaca..9c34d596b 100644
--- a/src/include/ipxe/ansicol.h
+++ b/src/include/ipxe/ansicol.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <curses.h> /* For COLOR_RED etc. */
diff --git a/src/include/ipxe/ansiesc.h b/src/include/ipxe/ansiesc.h
index 80bc83308..280f51066 100644
--- a/src/include/ipxe/ansiesc.h
+++ b/src/include/ipxe/ansiesc.h
@@ -27,6 +27,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct ansiesc_context;
 
diff --git a/src/include/ipxe/aoe.h b/src/include/ipxe/aoe.h
index 14d11c5cb..c548f42a2 100644
--- a/src/include/ipxe/aoe.h
+++ b/src/include/ipxe/aoe.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/api.h b/src/include/ipxe/api.h
index d05d3b07a..ab61f4f14 100644
--- a/src/include/ipxe/api.h
+++ b/src/include/ipxe/api.h
@@ -12,6 +12,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @defgroup Single-implementation APIs
  *
diff --git a/src/include/ipxe/arp.h b/src/include/ipxe/arp.h
index 674423c54..c70ea7eff 100644
--- a/src/include/ipxe/arp.h
+++ b/src/include/ipxe/arp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/asn1.h b/src/include/ipxe/asn1.h
index 86ebb890f..c5dcccb99 100644
--- a/src/include/ipxe/asn1.h
+++ b/src/include/ipxe/asn1.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/include/ipxe/ata.h b/src/include/ipxe/ata.h
index cd78cd795..eea086c13 100644
--- a/src/include/ipxe/ata.h
+++ b/src/include/ipxe/ata.h
@@ -11,6 +11,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * An ATA Logical Block Address
diff --git a/src/include/ipxe/base16.h b/src/include/ipxe/base16.h
index c9e430e7e..b2cf42eb4 100644
--- a/src/include/ipxe/base16.h
+++ b/src/include/ipxe/base16.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/include/ipxe/base64.h b/src/include/ipxe/base64.h
index 0c70d8382..f93039901 100644
--- a/src/include/ipxe/base64.h
+++ b/src/include/ipxe/base64.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/include/ipxe/bitmap.h b/src/include/ipxe/bitmap.h
index 38aca694b..7533d1bf9 100644
--- a/src/include/ipxe/bitmap.h
+++ b/src/include/ipxe/bitmap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/src/include/ipxe/blockdev.h b/src/include/ipxe/blockdev.h
index ef6fc8d5a..7e4d48ce4 100644
--- a/src/include/ipxe/blockdev.h
+++ b/src/include/ipxe/blockdev.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/interface.h>
diff --git a/src/include/ipxe/blocktrans.h b/src/include/ipxe/blocktrans.h
index 1eb388854..66a7e353c 100644
--- a/src/include/ipxe/blocktrans.h
+++ b/src/include/ipxe/blocktrans.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/cachedhcp.h b/src/include/ipxe/cachedhcp.h
index 5b19bc59e..100e5e098 100644
--- a/src/include/ipxe/cachedhcp.h
+++ b/src/include/ipxe/cachedhcp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 
diff --git a/src/include/ipxe/chap.h b/src/include/ipxe/chap.h
index 7c693e29d..965143095 100644
--- a/src/include/ipxe/chap.h
+++ b/src/include/ipxe/chap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/md5.h>
diff --git a/src/include/ipxe/command.h b/src/include/ipxe/command.h
index 331536313..cbd5fb665 100644
--- a/src/include/ipxe/command.h
+++ b/src/include/ipxe/command.h
@@ -2,6 +2,7 @@
 #define _IPXE_COMMAND_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/ipxe/console.h b/src/include/ipxe/console.h
index 1b764aaca..5e652a974 100644
--- a/src/include/ipxe/console.h
+++ b/src/include/ipxe/console.h
@@ -17,6 +17,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct pixel_buffer;
 
diff --git a/src/include/ipxe/cpio.h b/src/include/ipxe/cpio.h
index 744dbd269..f1752ab0a 100644
--- a/src/include/ipxe/cpio.h
+++ b/src/include/ipxe/cpio.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/image.h>
diff --git a/src/include/ipxe/crc32.h b/src/include/ipxe/crc32.h
index 30d2fe66c..7fe7ec88e 100644
--- a/src/include/ipxe/crc32.h
+++ b/src/include/ipxe/crc32.h
@@ -2,6 +2,7 @@
 #define _IPXE_CRC32_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/crypto.h b/src/include/ipxe/crypto.h
index dd567fb2c..f458d7f30 100644
--- a/src/include/ipxe/crypto.h
+++ b/src/include/ipxe/crypto.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/src/include/ipxe/device.h b/src/include/ipxe/device.h
index 89e6e4f31..ca12d2c07 100644
--- a/src/include/ipxe/device.h
+++ b/src/include/ipxe/device.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/dhcp.h b/src/include/ipxe/dhcp.h
index 43729d0c5..bdbe3b741 100644
--- a/src/include/ipxe/dhcp.h
+++ b/src/include/ipxe/dhcp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdarg.h>
diff --git a/src/include/ipxe/dhcparch.h b/src/include/ipxe/dhcparch.h
index 89ecfb31e..ff611331c 100644
--- a/src/include/ipxe/dhcparch.h
+++ b/src/include/ipxe/dhcparch.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /* Include platform-specific client architecture definitions */
 #define PLATFORM_DHCPARCH(_platform) <ipxe/_platform/dhcparch.h>
diff --git a/src/include/ipxe/dhcpopts.h b/src/include/ipxe/dhcpopts.h
index 707fda4a8..9fe7bb110 100644
--- a/src/include/ipxe/dhcpopts.h
+++ b/src/include/ipxe/dhcpopts.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/dhcppkt.h b/src/include/ipxe/dhcppkt.h
index 86075960a..7d0153107 100644
--- a/src/include/ipxe/dhcppkt.h
+++ b/src/include/ipxe/dhcppkt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/dhcp.h>
 #include <ipxe/dhcpopts.h>
diff --git a/src/include/ipxe/dhcpv6.h b/src/include/ipxe/dhcpv6.h
index 065e9c376..45b36724a 100644
--- a/src/include/ipxe/dhcpv6.h
+++ b/src/include/ipxe/dhcpv6.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/in.h>
diff --git a/src/include/ipxe/dma.h b/src/include/ipxe/dma.h
index a6e41c1ab..e6e7a4793 100644
--- a/src/include/ipxe/dma.h
+++ b/src/include/ipxe/dma.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/dns.h b/src/include/ipxe/dns.h
index 738dea6e4..e7fc32c25 100644
--- a/src/include/ipxe/dns.h
+++ b/src/include/ipxe/dns.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/in.h>
diff --git a/src/include/ipxe/downloader.h b/src/include/ipxe/downloader.h
index ccb1abfef..f87a8ea78 100644
--- a/src/include/ipxe/downloader.h
+++ b/src/include/ipxe/downloader.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct interface;
 struct image;
diff --git a/src/include/ipxe/dummy_sanboot.h b/src/include/ipxe/dummy_sanboot.h
index 9c9d942aa..991a2545a 100644
--- a/src/include/ipxe/dummy_sanboot.h
+++ b/src/include/ipxe/dummy_sanboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SANBOOT_DUMMY
 #define SANBOOT_PREFIX_dummy
diff --git a/src/include/ipxe/dynui.h b/src/include/ipxe/dynui.h
index f47f5cb36..e50c6ab49 100644
--- a/src/include/ipxe/dynui.h
+++ b/src/include/ipxe/dynui.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 
diff --git a/src/include/ipxe/eap.h b/src/include/ipxe/eap.h
index a44f01e0a..2b3770138 100644
--- a/src/include/ipxe/eap.h
+++ b/src/include/ipxe/eap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/eapol.h b/src/include/ipxe/eapol.h
index dcf392946..2d44750ec 100644
--- a/src/include/ipxe/eapol.h
+++ b/src/include/ipxe/eapol.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/ecam_io.h b/src/include/ipxe/ecam_io.h
index b2c232013..f31ccdc53 100644
--- a/src/include/ipxe/ecam_io.h
+++ b/src/include/ipxe/ecam_io.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/edd.h b/src/include/ipxe/edd.h
index 1914fd0b0..9529da475 100644
--- a/src/include/ipxe/edd.h
+++ b/src/include/ipxe/edd.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/interface.h>
diff --git a/src/include/ipxe/editbox.h b/src/include/ipxe/editbox.h
index 1f62485fe..85d5919c9 100644
--- a/src/include/ipxe/editbox.h
+++ b/src/include/ipxe/editbox.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <curses.h>
 #include <ipxe/editstring.h>
diff --git a/src/include/ipxe/editstring.h b/src/include/ipxe/editstring.h
index 7ad8fb304..48dc34f18 100644
--- a/src/include/ipxe/editstring.h
+++ b/src/include/ipxe/editstring.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** An editable string */
 struct edit_string {
diff --git a/src/include/ipxe/efi/ProcessorBind.h b/src/include/ipxe/efi/ProcessorBind.h
index 21b873163..9fb8012f7 100644
--- a/src/include/ipxe/efi/ProcessorBind.h
+++ b/src/include/ipxe/efi/ProcessorBind.h
@@ -2,6 +2,7 @@
 #define _IPXE_EFI_PROCESSOR_BIND_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * EFI header files rely on having the CPU architecture directory
diff --git a/src/include/ipxe/efi/Protocol/AppleNetBoot.h b/src/include/ipxe/efi/Protocol/AppleNetBoot.h
index 5946524fd..417730bc3 100644
--- a/src/include/ipxe/efi/Protocol/AppleNetBoot.h
+++ b/src/include/ipxe/efi/Protocol/AppleNetBoot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( BSD3 );
+FILE_SECBOOT ( PERMITTED );
 
 #define EFI_APPLE_NET_BOOT_PROTOCOL_GUID				\
 	{ 0x78ee99fb, 0x6a5e, 0x4186,					\
diff --git a/src/include/ipxe/efi/Protocol/ShimLock.h b/src/include/ipxe/efi/Protocol/ShimLock.h
index b31365173..8fd3c3bc8 100644
--- a/src/include/ipxe/efi/Protocol/ShimLock.h
+++ b/src/include/ipxe/efi/Protocol/ShimLock.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( BSD3 );
+FILE_SECBOOT ( PERMITTED );
 
 #define EFI_SHIM_LOCK_PROTOCOL_GUID					\
 	{ 0x605dab50, 0xe046, 0x4300,					\
diff --git a/src/include/ipxe/efi/efi.h b/src/include/ipxe/efi/efi.h
index 3085704b0..9554a6ad7 100644
--- a/src/include/ipxe/efi/efi.h
+++ b/src/include/ipxe/efi/efi.h
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 /* EFI headers rudely redefine NULL */
 #undef NULL
diff --git a/src/include/ipxe/efi/efi_acpi.h b/src/include/ipxe/efi/efi_acpi.h
index 68f9c5be7..d11ae95b1 100644
--- a/src/include/ipxe/efi/efi_acpi.h
+++ b/src/include/ipxe/efi/efi_acpi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef ACPI_EFI
 #define ACPI_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_autoboot.h b/src/include/ipxe/efi/efi_autoboot.h
index 94fd2d766..29b80fd86 100644
--- a/src/include/ipxe/efi/efi_autoboot.h
+++ b/src/include/ipxe/efi/efi_autoboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/efi_autoexec.h b/src/include/ipxe/efi/efi_autoexec.h
index 18bc4200c..1e68daeee 100644
--- a/src/include/ipxe/efi/efi_autoexec.h
+++ b/src/include/ipxe/efi/efi_autoexec.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int efi_autoexec_load ( void );
 
diff --git a/src/include/ipxe/efi/efi_block.h b/src/include/ipxe/efi/efi_block.h
index f8cf7fc13..b010d71a3 100644
--- a/src/include/ipxe/efi/efi_block.h
+++ b/src/include/ipxe/efi/efi_block.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SANBOOT_EFI
 #define SANBOOT_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_cachedhcp.h b/src/include/ipxe/efi/efi_cachedhcp.h
index 5968a1ea2..86164f463 100644
--- a/src/include/ipxe/efi/efi_cachedhcp.h
+++ b/src/include/ipxe/efi/efi_cachedhcp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/efi_cmdline.h b/src/include/ipxe/efi/efi_cmdline.h
index 45abd5493..ed43d71a7 100644
--- a/src/include/ipxe/efi/efi_cmdline.h
+++ b/src/include/ipxe/efi/efi_cmdline.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <wchar.h>
diff --git a/src/include/ipxe/efi/efi_download.h b/src/include/ipxe/efi/efi_download.h
index 740fcadf5..ca96efae2 100644
--- a/src/include/ipxe/efi/efi_download.h
+++ b/src/include/ipxe/efi/efi_download.h
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/include/ipxe/efi/efi_driver.h b/src/include/ipxe/efi/efi_driver.h
index 5ab2d011a..f373e47d3 100644
--- a/src/include/ipxe/efi/efi_driver.h
+++ b/src/include/ipxe/efi/efi_driver.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/device.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/efi/efi_fdt.h b/src/include/ipxe/efi/efi_fdt.h
index d18676d7e..644e6ddf9 100644
--- a/src/include/ipxe/efi/efi_fdt.h
+++ b/src/include/ipxe/efi/efi_fdt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/efi_file.h b/src/include/ipxe/efi/efi_file.h
index 79c073cf1..bf14297a1 100644
--- a/src/include/ipxe/efi/efi_file.h
+++ b/src/include/ipxe/efi/efi_file.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int efi_file_install ( EFI_HANDLE handle );
 extern void efi_file_uninstall ( EFI_HANDLE handle );
diff --git a/src/include/ipxe/efi/efi_hii.h b/src/include/ipxe/efi/efi_hii.h
index bbec31194..8a001723f 100644
--- a/src/include/ipxe/efi/efi_hii.h
+++ b/src/include/ipxe/efi/efi_hii.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/efi/Uefi/UefiInternalFormRepresentation.h>
diff --git a/src/include/ipxe/efi/efi_image.h b/src/include/ipxe/efi/efi_image.h
index 0fc0402b1..7fd2e2894 100644
--- a/src/include/ipxe/efi/efi_image.h
+++ b/src/include/ipxe/efi/efi_image.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/image.h>
 
diff --git a/src/include/ipxe/efi/efi_nap.h b/src/include/ipxe/efi/efi_nap.h
index 1ffb05569..6c01072c3 100644
--- a/src/include/ipxe/efi/efi_nap.h
+++ b/src/include/ipxe/efi/efi_nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef NAP_EFI
 #define NAP_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_null.h b/src/include/ipxe/efi/efi_null.h
index d23d36349..e81545485 100644
--- a/src/include/ipxe/efi/efi_null.h
+++ b/src/include/ipxe/efi/efi_null.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/Protocol/AppleNetBoot.h>
diff --git a/src/include/ipxe/efi/efi_path.h b/src/include/ipxe/efi/efi_path.h
index a37d7b9d7..f68d782fb 100644
--- a/src/include/ipxe/efi/efi_path.h
+++ b/src/include/ipxe/efi/efi_path.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/interface.h>
 #include <ipxe/efi/efi.h>
diff --git a/src/include/ipxe/efi/efi_pci.h b/src/include/ipxe/efi/efi_pci.h
index f8d1e3e40..670fb7d7a 100644
--- a/src/include/ipxe/efi/efi_pci.h
+++ b/src/include/ipxe/efi/efi_pci.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/pci.h>
 #include <ipxe/efi/efi.h>
diff --git a/src/include/ipxe/efi/efi_pci_api.h b/src/include/ipxe/efi/efi_pci_api.h
index 956795254..474555871 100644
--- a/src/include/ipxe/efi/efi_pci_api.h
+++ b/src/include/ipxe/efi/efi_pci_api.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef PCIAPI_EFI
 #define PCIAPI_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_pxe.h b/src/include/ipxe/efi/efi_pxe.h
index b356f3789..d9aac455c 100644
--- a/src/include/ipxe/efi/efi_pxe.h
+++ b/src/include/ipxe/efi/efi_pxe.h
@@ -10,6 +10,7 @@
 #include <ipxe/netdevice.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int efi_pxe_install ( EFI_HANDLE handle, struct net_device *netdev );
 extern void efi_pxe_uninstall ( EFI_HANDLE handle );
diff --git a/src/include/ipxe/efi/efi_reboot.h b/src/include/ipxe/efi/efi_reboot.h
index 249cae8c5..8eb38f271 100644
--- a/src/include/ipxe/efi/efi_reboot.h
+++ b/src/include/ipxe/efi/efi_reboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef REBOOT_EFI
 #define REBOOT_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_service.h b/src/include/ipxe/efi/efi_service.h
index ca4c7b2a4..2c5bc8fe9 100644
--- a/src/include/ipxe/efi/efi_service.h
+++ b/src/include/ipxe/efi/efi_service.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/efi_shim.h b/src/include/ipxe/efi/efi_shim.h
index 21f24315a..d205dec6d 100644
--- a/src/include/ipxe/efi/efi_shim.h
+++ b/src/include/ipxe/efi/efi_shim.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/image.h>
 #include <ipxe/efi/efi.h>
diff --git a/src/include/ipxe/efi/efi_smbios.h b/src/include/ipxe/efi/efi_smbios.h
index d890d5460..23af651a8 100644
--- a/src/include/ipxe/efi/efi_smbios.h
+++ b/src/include/ipxe/efi/efi_smbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SMBIOS_EFI
 #define SMBIOS_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_snp.h b/src/include/ipxe/efi/efi_snp.h
index 1095b19e3..0822466db 100644
--- a/src/include/ipxe/efi/efi_snp.h
+++ b/src/include/ipxe/efi/efi_snp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/efi/efi_strings.h b/src/include/ipxe/efi/efi_strings.h
index a7adff827..36f5a7eb0 100644
--- a/src/include/ipxe/efi/efi_strings.h
+++ b/src/include/ipxe/efi/efi_strings.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/include/ipxe/efi/efi_table.h b/src/include/ipxe/efi/efi_table.h
index 9a41d8723..714069e15 100644
--- a/src/include/ipxe/efi/efi_table.h
+++ b/src/include/ipxe/efi/efi_table.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/efi_time.h b/src/include/ipxe/efi/efi_time.h
index 099994b57..8b2addc0f 100644
--- a/src/include/ipxe/efi/efi_time.h
+++ b/src/include/ipxe/efi/efi_time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/efi/efi_umalloc.h b/src/include/ipxe/efi/efi_umalloc.h
index 4eb2a5f9b..4d5c706ca 100644
--- a/src/include/ipxe/efi/efi_umalloc.h
+++ b/src/include/ipxe/efi/efi_umalloc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef UMALLOC_EFI
 #define UMALLOC_PREFIX_efi
diff --git a/src/include/ipxe/efi/efi_utils.h b/src/include/ipxe/efi/efi_utils.h
index 98659b150..29dc171d2 100644
--- a/src/include/ipxe/efi/efi_utils.h
+++ b/src/include/ipxe/efi/efi_utils.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/efi_veto.h b/src/include/ipxe/efi/efi_veto.h
index c9ecbb05c..be48441ad 100644
--- a/src/include/ipxe/efi/efi_veto.h
+++ b/src/include/ipxe/efi/efi_veto.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern void efi_veto ( void );
 
diff --git a/src/include/ipxe/efi/efi_watchdog.h b/src/include/ipxe/efi/efi_watchdog.h
index 4a56b9a29..1801c6d6c 100644
--- a/src/include/ipxe/efi/efi_watchdog.h
+++ b/src/include/ipxe/efi/efi_watchdog.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern struct retry_timer efi_watchdog;
 
diff --git a/src/include/ipxe/efi/efi_wrap.h b/src/include/ipxe/efi/efi_wrap.h
index 1cae3d2db..7801c77d0 100644
--- a/src/include/ipxe/efi/efi_wrap.h
+++ b/src/include/ipxe/efi/efi_wrap.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 
diff --git a/src/include/ipxe/efi/mnpnet.h b/src/include/ipxe/efi/mnpnet.h
index 99d6cf083..1f2d0d1f6 100644
--- a/src/include/ipxe/efi/mnpnet.h
+++ b/src/include/ipxe/efi/mnpnet.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct efi_device;
 struct net_device;
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index d97c5eca6..8379adb13 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <bits/errfile.h>
 
diff --git a/src/include/ipxe/errno/efi.h b/src/include/ipxe/errno/efi.h
index 9f010f5fb..2db2d5cb6 100644
--- a/src/include/ipxe/errno/efi.h
+++ b/src/include/ipxe/errno/efi.h
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/Uefi/UefiBaseType.h>
diff --git a/src/include/ipxe/errortab.h b/src/include/ipxe/errortab.h
index 4fe81a6be..6c63bb6d1 100644
--- a/src/include/ipxe/errortab.h
+++ b/src/include/ipxe/errortab.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/ipxe/eth_slow.h b/src/include/ipxe/eth_slow.h
index 754ea6e1f..757bb83f0 100644
--- a/src/include/ipxe/eth_slow.h
+++ b/src/include/ipxe/eth_slow.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Slow protocols header */
 struct eth_slow_header {
diff --git a/src/include/ipxe/ethernet.h b/src/include/ipxe/ethernet.h
index dd04e00ce..f1eb21dd0 100644
--- a/src/include/ipxe/ethernet.h
+++ b/src/include/ipxe/ethernet.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/fakedhcp.h b/src/include/ipxe/fakedhcp.h
index d016b5237..f23a98f2d 100644
--- a/src/include/ipxe/fakedhcp.h
+++ b/src/include/ipxe/fakedhcp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/fault.h b/src/include/ipxe/fault.h
index 356296c35..251567226 100644
--- a/src/include/ipxe/fault.h
+++ b/src/include/ipxe/fault.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <config/fault.h>
diff --git a/src/include/ipxe/fc.h b/src/include/ipxe/fc.h
index 840d11f62..8c2bbe5e5 100644
--- a/src/include/ipxe/fc.h
+++ b/src/include/ipxe/fc.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/fcels.h b/src/include/ipxe/fcels.h
index 02f755115..8aa086106 100644
--- a/src/include/ipxe/fcels.h
+++ b/src/include/ipxe/fcels.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/fc.h>
diff --git a/src/include/ipxe/fcp.h b/src/include/ipxe/fcp.h
index d86afab42..96aae37db 100644
--- a/src/include/ipxe/fcp.h
+++ b/src/include/ipxe/fcp.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/fc.h>
diff --git a/src/include/ipxe/fdtmem.h b/src/include/ipxe/fdtmem.h
index 8d7ebfe7e..1bbc38ff9 100644
--- a/src/include/ipxe/fdtmem.h
+++ b/src/include/ipxe/fdtmem.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/features.h b/src/include/ipxe/features.h
index e86a2d226..2d1ef3b7b 100644
--- a/src/include/ipxe/features.h
+++ b/src/include/ipxe/features.h
@@ -12,6 +12,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @defgroup featurecat Feature categories
diff --git a/src/include/ipxe/fragment.h b/src/include/ipxe/fragment.h
index 0069e5e08..474ad5e1c 100644
--- a/src/include/ipxe/fragment.h
+++ b/src/include/ipxe/fragment.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/http.h b/src/include/ipxe/http.h
index fc3e7b7a1..e84a75237 100644
--- a/src/include/ipxe/http.h
+++ b/src/include/ipxe/http.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/ib_mad.h b/src/include/ipxe/ib_mad.h
index 134274026..dcc432558 100644
--- a/src/include/ipxe/ib_mad.h
+++ b/src/include/ipxe/ib_mad.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/ib_packet.h>
diff --git a/src/include/ipxe/ib_packet.h b/src/include/ipxe/ib_packet.h
index 747f96399..087e86d5a 100644
--- a/src/include/ipxe/ib_packet.h
+++ b/src/include/ipxe/ib_packet.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct ib_device;
 struct ib_queue_pair;
diff --git a/src/include/ipxe/ib_srp.h b/src/include/ipxe/ib_srp.h
index 4b6df8d3b..9bd272a3b 100644
--- a/src/include/ipxe/ib_srp.h
+++ b/src/include/ipxe/ib_srp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( BSD2 );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/acpi.h>
diff --git a/src/include/ipxe/ibft.h b/src/include/ipxe/ibft.h
index 51ce781a6..9534c1e8a 100644
--- a/src/include/ipxe/ibft.h
+++ b/src/include/ipxe/ibft.h
@@ -29,6 +29,7 @@
  */
 
 FILE_LICENCE ( BSD2 );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/include/ipxe/icmp.h b/src/include/ipxe/icmp.h
index 803f8e019..a62e63ee8 100644
--- a/src/include/ipxe/icmp.h
+++ b/src/include/ipxe/icmp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/iobuf.h>
diff --git a/src/include/ipxe/icmpv6.h b/src/include/ipxe/icmpv6.h
index 0474ddca8..7d0c5ba14 100644
--- a/src/include/ipxe/icmpv6.h
+++ b/src/include/ipxe/icmpv6.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/if_arp.h b/src/include/ipxe/if_arp.h
index 9d7b03fe8..31d7d8b73 100644
--- a/src/include/ipxe/if_arp.h
+++ b/src/include/ipxe/if_arp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/if_ether.h b/src/include/ipxe/if_ether.h
index c1168b10e..a7d0e55f9 100644
--- a/src/include/ipxe/if_ether.h
+++ b/src/include/ipxe/if_ether.h
@@ -2,6 +2,7 @@
 #define	_IPXE_IF_ETHER_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/image.h b/src/include/ipxe/image.h
index e0e70f360..d9abe11ec 100644
--- a/src/include/ipxe/image.h
+++ b/src/include/ipxe/image.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/in.h b/src/include/ipxe/in.h
index 05a8122ef..f91ab306a 100644
--- a/src/include/ipxe/in.h
+++ b/src/include/ipxe/in.h
@@ -2,6 +2,7 @@
 #define	_IPXE_IN_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <byteswap.h>
diff --git a/src/include/ipxe/infiniband.h b/src/include/ipxe/infiniband.h
index 379bc109e..8022ab606 100644
--- a/src/include/ipxe/infiniband.h
+++ b/src/include/ipxe/infiniband.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/init.h b/src/include/ipxe/init.h
index da01b2953..00946fe83 100644
--- a/src/include/ipxe/init.h
+++ b/src/include/ipxe/init.h
@@ -2,6 +2,7 @@
 #define _IPXE_INIT_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/ipxe/initrd.h b/src/include/ipxe/initrd.h
index 0b955a381..50788597b 100644
--- a/src/include/ipxe/initrd.h
+++ b/src/include/ipxe/initrd.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/memmap.h>
diff --git a/src/include/ipxe/interface.h b/src/include/ipxe/interface.h
index d2fa8190c..87fd3c62f 100644
--- a/src/include/ipxe/interface.h
+++ b/src/include/ipxe/interface.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdarg.h>
diff --git a/src/include/ipxe/io.h b/src/include/ipxe/io.h
index ee2b7e156..1bb49370c 100644
--- a/src/include/ipxe/io.h
+++ b/src/include/ipxe/io.h
@@ -17,6 +17,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/iobuf.h b/src/include/ipxe/iobuf.h
index 46b350458..2ff24e50f 100644
--- a/src/include/ipxe/iobuf.h
+++ b/src/include/ipxe/iobuf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <assert.h>
diff --git a/src/include/ipxe/iomap.h b/src/include/ipxe/iomap.h
index 7d1547d9c..23153641e 100644
--- a/src/include/ipxe/iomap.h
+++ b/src/include/ipxe/iomap.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/iomap_virt.h b/src/include/ipxe/iomap_virt.h
index 3dd66bd75..a2564ec76 100644
--- a/src/include/ipxe/iomap_virt.h
+++ b/src/include/ipxe/iomap_virt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/uaccess.h>
diff --git a/src/include/ipxe/ip.h b/src/include/ipxe/ip.h
index e2cd512ac..3a5c3e175 100644
--- a/src/include/ipxe/ip.h
+++ b/src/include/ipxe/ip.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/in.h>
diff --git a/src/include/ipxe/ipstat.h b/src/include/ipxe/ipstat.h
index b34ed5fcf..b02673dcd 100644
--- a/src/include/ipxe/ipstat.h
+++ b/src/include/ipxe/ipstat.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/ipxe/ipv6.h b/src/include/ipxe/ipv6.h
index 4dd43f16d..bd7181e69 100644
--- a/src/include/ipxe/ipv6.h
+++ b/src/include/ipxe/ipv6.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/include/ipxe/iscsi.h b/src/include/ipxe/iscsi.h
index a25eec257..e890e62ad 100644
--- a/src/include/ipxe/iscsi.h
+++ b/src/include/ipxe/iscsi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/socket.h>
diff --git a/src/include/ipxe/iso9660.h b/src/include/ipxe/iso9660.h
index 34cb8f0a1..6727c7721 100644
--- a/src/include/ipxe/iso9660.h
+++ b/src/include/ipxe/iso9660.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/job.h b/src/include/ipxe/job.h
index c01bd1740..088012ba7 100644
--- a/src/include/ipxe/job.h
+++ b/src/include/ipxe/job.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/interface.h>
 
diff --git a/src/include/ipxe/jumpscroll.h b/src/include/ipxe/jumpscroll.h
index 470f08e71..0eec1b47b 100644
--- a/src/include/ipxe/jumpscroll.h
+++ b/src/include/ipxe/jumpscroll.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/keymap.h b/src/include/ipxe/keymap.h
index 49a8915ef..cdb83e03b 100644
--- a/src/include/ipxe/keymap.h
+++ b/src/include/ipxe/keymap.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/keys.h b/src/include/ipxe/keys.h
index 38ebd7d1a..b2a62744e 100644
--- a/src/include/ipxe/keys.h
+++ b/src/include/ipxe/keys.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * Symbolic names for some standard ASCII characters
diff --git a/src/include/ipxe/linebuf.h b/src/include/ipxe/linebuf.h
index 630278a04..b46168415 100644
--- a/src/include/ipxe/linebuf.h
+++ b/src/include/ipxe/linebuf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/src/include/ipxe/linux/linux_acpi.h b/src/include/ipxe/linux/linux_acpi.h
index a2c33ce2c..f6dbc9252 100644
--- a/src/include/ipxe/linux/linux_acpi.h
+++ b/src/include/ipxe/linux/linux_acpi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef ACPI_LINUX
 #define ACPI_PREFIX_linux
diff --git a/src/include/ipxe/linux/linux_nap.h b/src/include/ipxe/linux/linux_nap.h
index d072886c7..329124e52 100644
--- a/src/include/ipxe/linux/linux_nap.h
+++ b/src/include/ipxe/linux/linux_nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef NAP_LINUX
 #define NAP_PREFIX_linux
diff --git a/src/include/ipxe/linux/linux_pci.h b/src/include/ipxe/linux/linux_pci.h
index f9cd98819..b0fddc41a 100644
--- a/src/include/ipxe/linux/linux_pci.h
+++ b/src/include/ipxe/linux/linux_pci.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef PCIAPI_LINUX
 #define PCIAPI_PREFIX_linux
diff --git a/src/include/ipxe/linux/linux_smbios.h b/src/include/ipxe/linux/linux_smbios.h
index 16c6d8acd..32f006b66 100644
--- a/src/include/ipxe/linux/linux_smbios.h
+++ b/src/include/ipxe/linux/linux_smbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SMBIOS_LINUX
 #define SMBIOS_PREFIX_linux
diff --git a/src/include/ipxe/linux/linux_time.h b/src/include/ipxe/linux/linux_time.h
index 872ef5ade..cf02452d7 100644
--- a/src/include/ipxe/linux/linux_time.h
+++ b/src/include/ipxe/linux/linux_time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef TIME_LINUX
 #define TIME_PREFIX_linux
diff --git a/src/include/ipxe/linux/linux_uaccess.h b/src/include/ipxe/linux/linux_uaccess.h
index 7770ea90e..c3119a60e 100644
--- a/src/include/ipxe/linux/linux_uaccess.h
+++ b/src/include/ipxe/linux/linux_uaccess.h
@@ -13,6 +13,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef UACCESS_LINUX
 #define UACCESS_PREFIX_linux
diff --git a/src/include/ipxe/linux/linux_umalloc.h b/src/include/ipxe/linux/linux_umalloc.h
index 1811d0bc6..c1669b42a 100644
--- a/src/include/ipxe/linux/linux_umalloc.h
+++ b/src/include/ipxe/linux/linux_umalloc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef UMALLOC_LINUX
 #define UMALLOC_PREFIX_linux
diff --git a/src/include/ipxe/list.h b/src/include/ipxe/list.h
index 2f02e71f0..4282d8455 100644
--- a/src/include/ipxe/list.h
+++ b/src/include/ipxe/list.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <assert.h>
diff --git a/src/include/ipxe/lldp.h b/src/include/ipxe/lldp.h
index 9951d3b8f..7d4e7f6cf 100644
--- a/src/include/ipxe/lldp.h
+++ b/src/include/ipxe/lldp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/login_ui.h b/src/include/ipxe/login_ui.h
index 313e07349..2924a2f63 100644
--- a/src/include/ipxe/login_ui.h
+++ b/src/include/ipxe/login_ui.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int login_ui ( void );
 
diff --git a/src/include/ipxe/malloc.h b/src/include/ipxe/malloc.h
index d3f056c15..fac46bd00 100644
--- a/src/include/ipxe/malloc.h
+++ b/src/include/ipxe/malloc.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * Prototypes for the standard functions (malloc() et al) are in
diff --git a/src/include/ipxe/md5.h b/src/include/ipxe/md5.h
index 527ad3658..275e63824 100644
--- a/src/include/ipxe/md5.h
+++ b/src/include/ipxe/md5.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/memmap.h b/src/include/ipxe/memmap.h
index c16e25daa..4a768f867 100644
--- a/src/include/ipxe/memmap.h
+++ b/src/include/ipxe/memmap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/include/ipxe/message.h b/src/include/ipxe/message.h
index e2e783740..997135d70 100644
--- a/src/include/ipxe/message.h
+++ b/src/include/ipxe/message.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern void msg ( unsigned int row, const char *fmt, ... );
 extern void clearmsg ( unsigned int row );
diff --git a/src/include/ipxe/monojob.h b/src/include/ipxe/monojob.h
index 1661d91c2..cda27616a 100644
--- a/src/include/ipxe/monojob.h
+++ b/src/include/ipxe/monojob.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct interface;
 
diff --git a/src/include/ipxe/nap.h b/src/include/ipxe/nap.h
index 8d5d8e3df..eff5ad5b9 100644
--- a/src/include/ipxe/nap.h
+++ b/src/include/ipxe/nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/api.h>
 #include <config/nap.h>
diff --git a/src/include/ipxe/ndp.h b/src/include/ipxe/ndp.h
index d06672ec1..0c8a9a27d 100644
--- a/src/include/ipxe/ndp.h
+++ b/src/include/ipxe/ndp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/in.h>
diff --git a/src/include/ipxe/neighbour.h b/src/include/ipxe/neighbour.h
index e0701f6e3..d400bb93a 100644
--- a/src/include/ipxe/neighbour.h
+++ b/src/include/ipxe/neighbour.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/netdevice.h b/src/include/ipxe/netdevice.h
index 17695d5b6..62f0dd1f7 100644
--- a/src/include/ipxe/netdevice.h
+++ b/src/include/ipxe/netdevice.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/ntlm.h b/src/include/ipxe/ntlm.h
index b0436c9ac..867f5ddc3 100644
--- a/src/include/ipxe/ntlm.h
+++ b/src/include/ipxe/ntlm.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/null_acpi.h b/src/include/ipxe/null_acpi.h
index 18f059964..dd3992630 100644
--- a/src/include/ipxe/null_acpi.h
+++ b/src/include/ipxe/null_acpi.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 
diff --git a/src/include/ipxe/null_memmap.h b/src/include/ipxe/null_memmap.h
index 0933d45be..122280d14 100644
--- a/src/include/ipxe/null_memmap.h
+++ b/src/include/ipxe/null_memmap.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef MEMMAP_NULL
 #define MEMMAP_PREFIX_null
diff --git a/src/include/ipxe/null_nap.h b/src/include/ipxe/null_nap.h
index 17145b48b..3f4fc13ae 100644
--- a/src/include/ipxe/null_nap.h
+++ b/src/include/ipxe/null_nap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef NAP_NULL
 #define NAP_PREFIX_null
diff --git a/src/include/ipxe/null_pci.h b/src/include/ipxe/null_pci.h
index 0cdcdc109..1e7b4da60 100644
--- a/src/include/ipxe/null_pci.h
+++ b/src/include/ipxe/null_pci.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef PCIAPI_NULL
 #define PCIAPI_PREFIX_null
diff --git a/src/include/ipxe/null_reboot.h b/src/include/ipxe/null_reboot.h
index 5de38afc0..47539300a 100644
--- a/src/include/ipxe/null_reboot.h
+++ b/src/include/ipxe/null_reboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef REBOOT_NULL
 #define REBOOT_PREFIX_null
diff --git a/src/include/ipxe/null_sanboot.h b/src/include/ipxe/null_sanboot.h
index b0e36b8b0..d455edbd6 100644
--- a/src/include/ipxe/null_sanboot.h
+++ b/src/include/ipxe/null_sanboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SANBOOT_NULL
 #define SANBOOT_PREFIX_null
diff --git a/src/include/ipxe/null_smbios.h b/src/include/ipxe/null_smbios.h
index c430dd089..474398b3c 100644
--- a/src/include/ipxe/null_smbios.h
+++ b/src/include/ipxe/null_smbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef SMBIOS_NULL
 #define SMBIOS_PREFIX_null
diff --git a/src/include/ipxe/null_time.h b/src/include/ipxe/null_time.h
index c670a5fce..db85769f7 100644
--- a/src/include/ipxe/null_time.h
+++ b/src/include/ipxe/null_time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef TIME_NULL
 #define TIME_PREFIX_null
diff --git a/src/include/ipxe/nvo.h b/src/include/ipxe/nvo.h
index 7a3c7a3db..39e3a707d 100644
--- a/src/include/ipxe/nvo.h
+++ b/src/include/ipxe/nvo.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/dhcpopts.h>
diff --git a/src/include/ipxe/nvs.h b/src/include/ipxe/nvs.h
index 5789f4c0d..1b02acea6 100644
--- a/src/include/ipxe/nvs.h
+++ b/src/include/ipxe/nvs.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/open.h b/src/include/ipxe/open.h
index 64e12d177..f429cadbe 100644
--- a/src/include/ipxe/open.h
+++ b/src/include/ipxe/open.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdarg.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/params.h b/src/include/ipxe/params.h
index 61e46e029..64008380e 100644
--- a/src/include/ipxe/params.h
+++ b/src/include/ipxe/params.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/parseopt.h b/src/include/ipxe/parseopt.h
index 5c449cd42..dec230b0f 100644
--- a/src/include/ipxe/parseopt.h
+++ b/src/include/ipxe/parseopt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/src/include/ipxe/pci.h b/src/include/ipxe/pci.h
index 2728cbd45..44095afe2 100644
--- a/src/include/ipxe/pci.h
+++ b/src/include/ipxe/pci.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/device.h>
diff --git a/src/include/ipxe/pci_io.h b/src/include/ipxe/pci_io.h
index 7ac09efb0..e67832fec 100644
--- a/src/include/ipxe/pci_io.h
+++ b/src/include/ipxe/pci_io.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/pcicloud.h b/src/include/ipxe/pcicloud.h
index 52268908c..19d5147be 100644
--- a/src/include/ipxe/pcicloud.h
+++ b/src/include/ipxe/pcicloud.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef PCIAPI_CLOUD
 #define PCIAPI_PREFIX_cloud
diff --git a/src/include/ipxe/pending.h b/src/include/ipxe/pending.h
index be6ed05a1..1ed10df18 100644
--- a/src/include/ipxe/pending.h
+++ b/src/include/ipxe/pending.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** A pending operation */
 struct pending_operation {
diff --git a/src/include/ipxe/ping.h b/src/include/ipxe/ping.h
index c55bd1ab2..7a45f1ab7 100644
--- a/src/include/ipxe/ping.h
+++ b/src/include/ipxe/ping.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/iobuf.h>
 #include <ipxe/tcpip.h>
diff --git a/src/include/ipxe/pool.h b/src/include/ipxe/pool.h
index 81ff57d75..fbd8567a9 100644
--- a/src/include/ipxe/pool.h
+++ b/src/include/ipxe/pool.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/interface.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/process.h b/src/include/ipxe/process.h
index d5e13aa04..0ec94f9bc 100644
--- a/src/include/ipxe/process.h
+++ b/src/include/ipxe/process.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/profile.h b/src/include/ipxe/profile.h
index fd45b3cdc..c7e6d54f2 100644
--- a/src/include/ipxe/profile.h
+++ b/src/include/ipxe/profile.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <bits/profile.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/quiesce.h b/src/include/ipxe/quiesce.h
index 00b530b83..a43628de0 100644
--- a/src/include/ipxe/quiesce.h
+++ b/src/include/ipxe/quiesce.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/ipxe/reboot.h b/src/include/ipxe/reboot.h
index cfd5b546d..361988ff1 100644
--- a/src/include/ipxe/reboot.h
+++ b/src/include/ipxe/reboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/api.h>
 #include <config/reboot.h>
diff --git a/src/include/ipxe/refcnt.h b/src/include/ipxe/refcnt.h
index 7f489abc9..dff67bf58 100644
--- a/src/include/ipxe/refcnt.h
+++ b/src/include/ipxe/refcnt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <assert.h>
diff --git a/src/include/ipxe/resolv.h b/src/include/ipxe/resolv.h
index ff48d35ca..3f26577c6 100644
--- a/src/include/ipxe/resolv.h
+++ b/src/include/ipxe/resolv.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/interface.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/retry.h b/src/include/ipxe/retry.h
index 76d45fbd0..6817bf4c9 100644
--- a/src/include/ipxe/retry.h
+++ b/src/include/ipxe/retry.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/list.h>
 
diff --git a/src/include/ipxe/rotate.h b/src/include/ipxe/rotate.h
index 4dea09aeb..77a87dffd 100644
--- a/src/include/ipxe/rotate.h
+++ b/src/include/ipxe/rotate.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/sanboot.h b/src/include/ipxe/sanboot.h
index 9d5fceee0..ea44191c2 100644
--- a/src/include/ipxe/sanboot.h
+++ b/src/include/ipxe/sanboot.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/api.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/sbat.h b/src/include/ipxe/sbat.h
index 4b74670ed..b708215c1 100644
--- a/src/include/ipxe/sbat.h
+++ b/src/include/ipxe/sbat.h
@@ -19,6 +19,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * A single line within an SBAT CSV file
diff --git a/src/include/ipxe/script.h b/src/include/ipxe/script.h
index 7e7a9a3a4..59a42c66f 100644
--- a/src/include/ipxe/script.h
+++ b/src/include/ipxe/script.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/image.h>
 
diff --git a/src/include/ipxe/scsi.h b/src/include/ipxe/scsi.h
index 9bb38a059..858f63547 100644
--- a/src/include/ipxe/scsi.h
+++ b/src/include/ipxe/scsi.h
@@ -11,6 +11,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Maximum block for READ/WRITE (10) commands */
 #define SCSI_MAX_BLOCK_10 0xffffffffULL
diff --git a/src/include/ipxe/settings.h b/src/include/ipxe/settings.h
index 689e011d3..1582aaa8f 100644
--- a/src/include/ipxe/settings.h
+++ b/src/include/ipxe/settings.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/settings_ui.h b/src/include/ipxe/settings_ui.h
index 0bf21935d..41e3351bc 100644
--- a/src/include/ipxe/settings_ui.h
+++ b/src/include/ipxe/settings_ui.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct settings;
 
diff --git a/src/include/ipxe/shell.h b/src/include/ipxe/shell.h
index 0d574e028..cbea7b319 100644
--- a/src/include/ipxe/shell.h
+++ b/src/include/ipxe/shell.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Shell stop states */
 enum shell_stop_state {
diff --git a/src/include/ipxe/smbios.h b/src/include/ipxe/smbios.h
index d9e2c38ed..5e431504a 100644
--- a/src/include/ipxe/smbios.h
+++ b/src/include/ipxe/smbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/socket.h b/src/include/ipxe/socket.h
index 8c70ea4c0..f0e80a712 100644
--- a/src/include/ipxe/socket.h
+++ b/src/include/ipxe/socket.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/srp.h b/src/include/ipxe/srp.h
index 1f66a22b2..c2450038f 100644
--- a/src/include/ipxe/srp.h
+++ b/src/include/ipxe/srp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( BSD2 );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <byteswap.h>
diff --git a/src/include/ipxe/stp.h b/src/include/ipxe/stp.h
index 3d85e5ba4..b30e09d20 100644
--- a/src/include/ipxe/stp.h
+++ b/src/include/ipxe/stp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/if_ether.h>
diff --git a/src/include/ipxe/string.h b/src/include/ipxe/string.h
index a8cbe8faa..593ced230 100644
--- a/src/include/ipxe/string.h
+++ b/src/include/ipxe/string.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern unsigned int digit_value ( unsigned int digit );
 
diff --git a/src/include/ipxe/tables.h b/src/include/ipxe/tables.h
index ac17f4b4b..d0f88cf56 100644
--- a/src/include/ipxe/tables.h
+++ b/src/include/ipxe/tables.h
@@ -2,6 +2,7 @@
 #define _IPXE_TABLES_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @page ifdef_harmful #ifdef considered harmful
  *
diff --git a/src/include/ipxe/tcp.h b/src/include/ipxe/tcp.h
index a1e89f718..14e8169e0 100644
--- a/src/include/ipxe/tcp.h
+++ b/src/include/ipxe/tcp.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tcpip.h>
 
diff --git a/src/include/ipxe/tcpip.h b/src/include/ipxe/tcpip.h
index 414daad53..cfee7aa1e 100644
--- a/src/include/ipxe/tcpip.h
+++ b/src/include/ipxe/tcpip.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/socket.h>
diff --git a/src/include/ipxe/tftp.h b/src/include/ipxe/tftp.h
index e3661e1ac..fa029e234 100644
--- a/src/include/ipxe/tftp.h
+++ b/src/include/ipxe/tftp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/time.h b/src/include/ipxe/time.h
index 89bf90e03..1b6f5daff 100644
--- a/src/include/ipxe/time.h
+++ b/src/include/ipxe/time.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <sys/time.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/timer.h b/src/include/ipxe/timer.h
index a6dffaf1c..72ddc9d28 100644
--- a/src/include/ipxe/timer.h
+++ b/src/include/ipxe/timer.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/ipxe/uaccess.h b/src/include/ipxe/uaccess.h
index d97db95be..1b0dc9de7 100644
--- a/src/include/ipxe/uaccess.h
+++ b/src/include/ipxe/uaccess.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/udp.h b/src/include/ipxe/udp.h
index 7b0de4dc0..693b2a422 100644
--- a/src/include/ipxe/udp.h
+++ b/src/include/ipxe/udp.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/iobuf.h>
diff --git a/src/include/ipxe/uheap.h b/src/include/ipxe/uheap.h
index d356786d3..0d37a649a 100644
--- a/src/include/ipxe/uheap.h
+++ b/src/include/ipxe/uheap.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef UMALLOC_UHEAP
 #define UMALLOC_PREFIX_uheap
diff --git a/src/include/ipxe/umalloc.h b/src/include/ipxe/umalloc.h
index da6c34143..c2a13dfdf 100644
--- a/src/include/ipxe/umalloc.h
+++ b/src/include/ipxe/umalloc.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/api.h>
diff --git a/src/include/ipxe/uri.h b/src/include/ipxe/uri.h
index a94b525e1..0de0135e4 100644
--- a/src/include/ipxe/uri.h
+++ b/src/include/ipxe/uri.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/include/ipxe/usb.h b/src/include/ipxe/usb.h
index d9891b757..9b8c7ae00 100644
--- a/src/include/ipxe/usb.h
+++ b/src/include/ipxe/usb.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/utf8.h b/src/include/ipxe/utf8.h
index 299c25511..10b2fcbd6 100644
--- a/src/include/ipxe/utf8.h
+++ b/src/include/ipxe/utf8.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/uuid.h b/src/include/ipxe/uuid.h
index 4874b7382..d0120741d 100644
--- a/src/include/ipxe/uuid.h
+++ b/src/include/ipxe/uuid.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <byteswap.h>
diff --git a/src/include/ipxe/version.h b/src/include/ipxe/version.h
index a43a33425..6be6096dc 100644
--- a/src/include/ipxe/version.h
+++ b/src/include/ipxe/version.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <wchar.h>
 
diff --git a/src/include/ipxe/virt_offset.h b/src/include/ipxe/virt_offset.h
index 2762acb40..31c434fc5 100644
--- a/src/include/ipxe/virt_offset.h
+++ b/src/include/ipxe/virt_offset.h
@@ -47,6 +47,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #ifdef UACCESS_OFFSET
 #define UACCESS_PREFIX_offset
diff --git a/src/include/ipxe/vlan.h b/src/include/ipxe/vlan.h
index 20bbc891d..a1cd76182 100644
--- a/src/include/ipxe/vlan.h
+++ b/src/include/ipxe/vlan.h
@@ -9,6 +9,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/netdevice.h>
 
diff --git a/src/include/ipxe/vsprintf.h b/src/include/ipxe/vsprintf.h
index 9e6297715..8b25422d8 100644
--- a/src/include/ipxe/vsprintf.h
+++ b/src/include/ipxe/vsprintf.h
@@ -32,6 +32,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdarg.h>
diff --git a/src/include/ipxe/widget.h b/src/include/ipxe/widget.h
index 945b4672a..6e61a8ca8 100644
--- a/src/include/ipxe/widget.h
+++ b/src/include/ipxe/widget.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <curses.h>
 
diff --git a/src/include/ipxe/xfer.h b/src/include/ipxe/xfer.h
index 3a35fa924..c35be31d9 100644
--- a/src/include/ipxe/xfer.h
+++ b/src/include/ipxe/xfer.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdarg.h>
diff --git a/src/include/ipxe/xferbuf.h b/src/include/ipxe/xferbuf.h
index 04fcf2286..aa0b2471f 100644
--- a/src/include/ipxe/xferbuf.h
+++ b/src/include/ipxe/xferbuf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/iobuf.h>
diff --git a/src/include/libgen.h b/src/include/libgen.h
index ae0861270..b686b15ac 100644
--- a/src/include/libgen.h
+++ b/src/include/libgen.h
@@ -2,6 +2,7 @@
 #define _LIBGEN_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern char * basename ( char *path );
 extern char * dirname ( char *path );
diff --git a/src/include/readline/readline.h b/src/include/readline/readline.h
index 3caf28b47..a2a1d950a 100644
--- a/src/include/readline/readline.h
+++ b/src/include/readline/readline.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** A readline history entry */
 struct readline_history_entry {
diff --git a/src/include/stdarg.h b/src/include/stdarg.h
index 89e94ce22..a981ea24a 100644
--- a/src/include/stdarg.h
+++ b/src/include/stdarg.h
@@ -2,6 +2,7 @@
 #define _STDARG_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 typedef __builtin_va_list va_list;
 #define va_start( ap, last ) __builtin_va_start ( ap, last )
diff --git a/src/include/stdbool.h b/src/include/stdbool.h
index c49a7f192..6afd038db 100644
--- a/src/include/stdbool.h
+++ b/src/include/stdbool.h
@@ -2,6 +2,7 @@
 #define _STDBOOL_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #define bool _Bool
 #define true 1
diff --git a/src/include/stddef.h b/src/include/stddef.h
index fb01c489d..7f46a7729 100644
--- a/src/include/stddef.h
+++ b/src/include/stddef.h
@@ -2,6 +2,7 @@
 #define STDDEF_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/stdint.h b/src/include/stdint.h
index 0a239a517..2fcd184fa 100644
--- a/src/include/stdint.h
+++ b/src/include/stdint.h
@@ -2,6 +2,7 @@
 #define _STDINT_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * This is a standard predefined macro on all gcc's I've seen. It's
diff --git a/src/include/stdio.h b/src/include/stdio.h
index ac17da83d..5dfa67865 100644
--- a/src/include/stdio.h
+++ b/src/include/stdio.h
@@ -2,6 +2,7 @@
 #define _STDIO_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdarg.h>
diff --git a/src/include/stdlib.h b/src/include/stdlib.h
index d7748a07e..8a531110e 100644
--- a/src/include/stdlib.h
+++ b/src/include/stdlib.h
@@ -2,6 +2,7 @@
 #define STDLIB_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <assert.h>
diff --git a/src/include/string.h b/src/include/string.h
index 4ee9c7344..3affe8e86 100644
--- a/src/include/string.h
+++ b/src/include/string.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 
diff --git a/src/include/strings.h b/src/include/strings.h
index d7e9d6971..8eac3e5e4 100644
--- a/src/include/strings.h
+++ b/src/include/strings.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <bits/strings.h>
diff --git a/src/include/sys/time.h b/src/include/sys/time.h
index 6e2a24447..e49df570f 100644
--- a/src/include/sys/time.h
+++ b/src/include/sys/time.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/syslog.h b/src/include/syslog.h
index 748a4faec..09c0112fd 100644
--- a/src/include/syslog.h
+++ b/src/include/syslog.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdarg.h>
 #include <ipxe/ansiesc.h>
diff --git a/src/include/time.h b/src/include/time.h
index ab93a3dbb..5ef67ece2 100644
--- a/src/include/time.h
+++ b/src/include/time.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <sys/time.h>
 #include <ipxe/time.h>
diff --git a/src/include/unistd.h b/src/include/unistd.h
index 6c31c0601..56431d15e 100644
--- a/src/include/unistd.h
+++ b/src/include/unistd.h
@@ -2,6 +2,7 @@
 #define _UNISTD_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdarg.h>
diff --git a/src/include/usr/autoboot.h b/src/include/usr/autoboot.h
index a081a70df..fbc8b10e9 100644
--- a/src/include/usr/autoboot.h
+++ b/src/include/usr/autoboot.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/device.h>
 
diff --git a/src/include/usr/dhcpmgmt.h b/src/include/usr/dhcpmgmt.h
index ed669eb9d..2440b1713 100644
--- a/src/include/usr/dhcpmgmt.h
+++ b/src/include/usr/dhcpmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct net_device;
 
diff --git a/src/include/usr/ifmgmt.h b/src/include/usr/ifmgmt.h
index 8d8a6bb56..3b489c02a 100644
--- a/src/include/usr/ifmgmt.h
+++ b/src/include/usr/ifmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 struct net_device;
 struct net_device_configurator;
diff --git a/src/include/usr/imgmgmt.h b/src/include/usr/imgmgmt.h
index 506c3eb14..f98af7984 100644
--- a/src/include/usr/imgmgmt.h
+++ b/src/include/usr/imgmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/image.h>
 
diff --git a/src/include/usr/prompt.h b/src/include/usr/prompt.h
index 8d3eeee3c..22c39105f 100644
--- a/src/include/usr/prompt.h
+++ b/src/include/usr/prompt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int prompt ( const char *text, unsigned long timeout, int key );
 
diff --git a/src/include/usr/route.h b/src/include/usr/route.h
index 7ec4a3509..7503c8c55 100644
--- a/src/include/usr/route.h
+++ b/src/include/usr/route.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/tables.h>
 
diff --git a/src/include/usr/shimmgmt.h b/src/include/usr/shimmgmt.h
index 0c59f54a8..0ed85c468 100644
--- a/src/include/usr/shimmgmt.h
+++ b/src/include/usr/shimmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/image.h>
 
diff --git a/src/include/usr/sync.h b/src/include/usr/sync.h
index b6f12ad6e..b24ab32fb 100644
--- a/src/include/usr/sync.h
+++ b/src/include/usr/sync.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int sync ( unsigned long timeout );
 
diff --git a/src/include/valgrind/memcheck.h b/src/include/valgrind/memcheck.h
index 7d4b56d31..e7fae01ed 100644
--- a/src/include/valgrind/memcheck.h
+++ b/src/include/valgrind/memcheck.h
@@ -61,6 +61,7 @@
 #define __MEMCHECK_H
 
 FILE_LICENCE ( BSD3 );
+FILE_SECBOOT ( PERMITTED );
 
 
 /* This file is for inclusion into client (your!) code.
diff --git a/src/include/valgrind/valgrind.h b/src/include/valgrind/valgrind.h
index d48bbccae..1a907cbbf 100644
--- a/src/include/valgrind/valgrind.h
+++ b/src/include/valgrind/valgrind.h
@@ -74,6 +74,7 @@
 #define __VALGRIND_H
 
 FILE_LICENCE ( BSD3 );
+FILE_SECBOOT ( PERMITTED );
 
 
 /* ------------------------------------------------------------------ */
diff --git a/src/include/wchar.h b/src/include/wchar.h
index a7e9de4f2..427bfff7a 100644
--- a/src/include/wchar.h
+++ b/src/include/wchar.h
@@ -2,6 +2,7 @@
 #define WCHAR_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 
diff --git a/src/interface/efi/efi_acpi.c b/src/interface/efi/efi_acpi.c
index a2021a4f6..cb8b4a5d0 100644
--- a/src/interface/efi/efi_acpi.c
+++ b/src/interface/efi/efi_acpi.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_autoboot.c b/src/interface/efi/efi_autoboot.c
index e52c857d8..9e0c3e42e 100644
--- a/src/interface/efi/efi_autoboot.c
+++ b/src/interface/efi/efi_autoboot.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_autoexec.c b/src/interface/efi/efi_autoexec.c
index 73ba5df33..b63ac1602 100644
--- a/src/interface/efi/efi_autoexec.c
+++ b/src/interface/efi/efi_autoexec.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_block.c b/src/interface/efi/efi_block.c
index 10952ef8a..0da92307b 100644
--- a/src/interface/efi/efi_block.c
+++ b/src/interface/efi/efi_block.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_cachedhcp.c b/src/interface/efi/efi_cachedhcp.c
index 6bba4173a..2f33fcefb 100644
--- a/src/interface/efi/efi_cachedhcp.c
+++ b/src/interface/efi/efi_cachedhcp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_cmdline.c b/src/interface/efi/efi_cmdline.c
index 8b9d8efde..f5844f2ad 100644
--- a/src/interface/efi/efi_cmdline.c
+++ b/src/interface/efi/efi_cmdline.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/interface/efi/efi_connect.c b/src/interface/efi/efi_connect.c
index 5aa8dc689..f4747cf6b 100644
--- a/src/interface/efi/efi_connect.c
+++ b/src/interface/efi/efi_connect.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/interface/efi/efi_console.c b/src/interface/efi/efi_console.c
index e896c5d88..afbd722ab 100644
--- a/src/interface/efi/efi_console.c
+++ b/src/interface/efi/efi_console.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <string.h>
diff --git a/src/interface/efi/efi_download.c b/src/interface/efi/efi_download.c
index 8d12bd57c..1c2f13573 100644
--- a/src/interface/efi/efi_download.c
+++ b/src/interface/efi/efi_download.c
@@ -17,6 +17,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/interface/efi/efi_driver.c b/src/interface/efi/efi_driver.c
index b1ff404be..cb07af401 100644
--- a/src/interface/efi/efi_driver.c
+++ b/src/interface/efi/efi_driver.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/interface/efi/efi_file.c b/src/interface/efi/efi_file.c
index 1909dea10..2f49b1a99 100644
--- a/src/interface/efi/efi_file.c
+++ b/src/interface/efi/efi_file.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_guid.c b/src/interface/efi/efi_guid.c
index 135eeb881..c989aebfe 100644
--- a/src/interface/efi/efi_guid.c
+++ b/src/interface/efi/efi_guid.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/uuid.h>
diff --git a/src/interface/efi/efi_hii.c b/src/interface/efi/efi_hii.c
index 66f58affe..fd65ae122 100644
--- a/src/interface/efi/efi_hii.c
+++ b/src/interface/efi/efi_hii.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stddef.h>
diff --git a/src/interface/efi/efi_init.c b/src/interface/efi/efi_init.c
index 69aea0d50..ac62ea747 100644
--- a/src/interface/efi/efi_init.c
+++ b/src/interface/efi/efi_init.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_local.c b/src/interface/efi/efi_local.c
index 4564470fc..58a5f689f 100644
--- a/src/interface/efi/efi_local.c
+++ b/src/interface/efi/efi_local.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <strings.h>
diff --git a/src/interface/efi/efi_nap.c b/src/interface/efi/efi_nap.c
index 2bb47627f..9d97dae6e 100644
--- a/src/interface/efi/efi_nap.c
+++ b/src/interface/efi/efi_nap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/nap.h>
 #include <ipxe/efi/efi.h>
diff --git a/src/interface/efi/efi_null.c b/src/interface/efi/efi_null.c
index d0f0428cc..fb9ee1780 100644
--- a/src/interface/efi/efi_null.c
+++ b/src/interface/efi/efi_null.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ipxe/efi/efi.h>
diff --git a/src/interface/efi/efi_open.c b/src/interface/efi/efi_open.c
index 8f8af4ea0..679d1946e 100644
--- a/src/interface/efi/efi_open.c
+++ b/src/interface/efi/efi_open.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/interface/efi/efi_path.c b/src/interface/efi/efi_path.c
index dd0df67e5..37558c36e 100644
--- a/src/interface/efi/efi_path.c
+++ b/src/interface/efi/efi_path.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdarg.h>
diff --git a/src/interface/efi/efi_pci.c b/src/interface/efi/efi_pci.c
index f4853c234..4bf3977c5 100644
--- a/src/interface/efi/efi_pci.c
+++ b/src/interface/efi/efi_pci.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/interface/efi/efi_pxe.c b/src/interface/efi/efi_pxe.c
index 4ba057019..2d1a6fd73 100644
--- a/src/interface/efi/efi_pxe.c
+++ b/src/interface/efi/efi_pxe.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_reboot.c b/src/interface/efi/efi_reboot.c
index 7ed9f5c84..cc35ef7ad 100644
--- a/src/interface/efi/efi_reboot.c
+++ b/src/interface/efi/efi_reboot.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_service.c b/src/interface/efi/efi_service.c
index f10733b24..4e2f2e951 100644
--- a/src/interface/efi/efi_service.c
+++ b/src/interface/efi/efi_service.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/interface/efi/efi_settings.c b/src/interface/efi/efi_settings.c
index 5ddbe12f1..95fe2c03c 100644
--- a/src/interface/efi/efi_settings.c
+++ b/src/interface/efi/efi_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_shim.c b/src/interface/efi/efi_shim.c
index 4bb6df79f..553cb2721 100644
--- a/src/interface/efi/efi_shim.c
+++ b/src/interface/efi/efi_shim.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdlib.h>
@@ -40,6 +41,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Require use of a third party loader binary
diff --git a/src/interface/efi/efi_smbios.c b/src/interface/efi/efi_smbios.c
index 5d0e69d6b..c10ba1440 100644
--- a/src/interface/efi/efi_smbios.c
+++ b/src/interface/efi/efi_smbios.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/uaccess.h>
diff --git a/src/interface/efi/efi_snp.c b/src/interface/efi/efi_snp.c
index 86ad87bde..dad8b33df 100644
--- a/src/interface/efi/efi_snp.c
+++ b/src/interface/efi/efi_snp.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/interface/efi/efi_snp_hii.c b/src/interface/efi/efi_snp_hii.c
index 8b65c8a78..25287673a 100644
--- a/src/interface/efi/efi_snp_hii.c
+++ b/src/interface/efi/efi_snp_hii.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_strings.c b/src/interface/efi/efi_strings.c
index 765b23ca6..3dae22e41 100644
--- a/src/interface/efi/efi_strings.c
+++ b/src/interface/efi/efi_strings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdarg.h>
diff --git a/src/interface/efi/efi_table.c b/src/interface/efi/efi_table.c
index 3c3f35a4b..da5966a13 100644
--- a/src/interface/efi/efi_table.c
+++ b/src/interface/efi/efi_table.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_time.c b/src/interface/efi/efi_time.c
index 983a0ef5c..a4c77da20 100644
--- a/src/interface/efi/efi_time.c
+++ b/src/interface/efi/efi_time.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_timer.c b/src/interface/efi/efi_timer.c
index 6427eb1d8..ffb899c86 100644
--- a/src/interface/efi/efi_timer.c
+++ b/src/interface/efi/efi_timer.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_umalloc.c b/src/interface/efi/efi_umalloc.c
index 419d9b294..257b27bec 100644
--- a/src/interface/efi/efi_umalloc.c
+++ b/src/interface/efi/efi_umalloc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/interface/efi/efi_utils.c b/src/interface/efi/efi_utils.c
index 51da06172..a7008afd4 100644
--- a/src/interface/efi/efi_utils.c
+++ b/src/interface/efi/efi_utils.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/interface/efi/efi_veto.c b/src/interface/efi/efi_veto.c
index da585db60..788515dd1 100644
--- a/src/interface/efi/efi_veto.c
+++ b/src/interface/efi/efi_veto.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/interface/efi/efi_watchdog.c b/src/interface/efi/efi_watchdog.c
index dcc9a5668..5e4eb626c 100644
--- a/src/interface/efi/efi_watchdog.c
+++ b/src/interface/efi/efi_watchdog.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_wrap.c b/src/interface/efi/efi_wrap.c
index 320a32f02..572d05aac 100644
--- a/src/interface/efi/efi_wrap.c
+++ b/src/interface/efi/efi_wrap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efiprefix.c b/src/interface/efi/efiprefix.c
index 64122185a..3c095afdc 100644
--- a/src/interface/efi/efiprefix.c
+++ b/src/interface/efi/efiprefix.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <errno.h>
diff --git a/src/interface/smbios/smbios.c b/src/interface/smbios/smbios.c
index 3a1a98b17..a23d9bfa2 100644
--- a/src/interface/smbios/smbios.c
+++ b/src/interface/smbios/smbios.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/interface/smbios/smbios_settings.c b/src/interface/smbios/smbios_settings.c
index 6358a4709..d0ef49d5f 100644
--- a/src/interface/smbios/smbios_settings.c
+++ b/src/interface/smbios/smbios_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/net/aoe.c b/src/net/aoe.c
index b484bdd33..edeb81867 100644
--- a/src/net/aoe.c
+++ b/src/net/aoe.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <string.h>
diff --git a/src/net/arp.c b/src/net/arp.c
index c9b4109a9..2bf3c12ec 100644
--- a/src/net/arp.c
+++ b/src/net/arp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/dhcpopts.c b/src/net/dhcpopts.c
index cdb632b46..844a94d62 100644
--- a/src/net/dhcpopts.c
+++ b/src/net/dhcpopts.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/dhcppkt.c b/src/net/dhcppkt.c
index 4e64f85e4..a9b454695 100644
--- a/src/net/dhcppkt.c
+++ b/src/net/dhcppkt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/eap.c b/src/net/eap.c
index 87327d723..040566b57 100644
--- a/src/net/eap.c
+++ b/src/net/eap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <errno.h>
diff --git a/src/net/eap_md5.c b/src/net/eap_md5.c
index 0664174f9..1e263c8ec 100644
--- a/src/net/eap_md5.c
+++ b/src/net/eap_md5.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/net/eapol.c b/src/net/eapol.c
index 0c573d198..d83d63386 100644
--- a/src/net/eapol.c
+++ b/src/net/eapol.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <assert.h>
diff --git a/src/net/eth_slow.c b/src/net/eth_slow.c
index 1103a49f3..fb4e0d972 100644
--- a/src/net/eth_slow.c
+++ b/src/net/eth_slow.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/net/ethernet.c b/src/net/ethernet.c
index 3fcdafe6d..60219b98f 100644
--- a/src/net/ethernet.c
+++ b/src/net/ethernet.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/fakedhcp.c b/src/net/fakedhcp.c
index 009b12c56..0020d8225 100644
--- a/src/net/fakedhcp.c
+++ b/src/net/fakedhcp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/fragment.c b/src/net/fragment.c
index 781b9bc60..4976167ed 100644
--- a/src/net/fragment.c
+++ b/src/net/fragment.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/icmp.c b/src/net/icmp.c
index 5371277e4..740b42440 100644
--- a/src/net/icmp.c
+++ b/src/net/icmp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <byteswap.h>
diff --git a/src/net/icmpv4.c b/src/net/icmpv4.c
index 0858ff37f..ffcc4b375 100644
--- a/src/net/icmpv4.c
+++ b/src/net/icmpv4.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/net/icmpv6.c b/src/net/icmpv6.c
index 8555aaf0b..5331b81e8 100644
--- a/src/net/icmpv6.c
+++ b/src/net/icmpv6.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/net/iobpad.c b/src/net/iobpad.c
index 936b4bde4..6366efb5e 100644
--- a/src/net/iobpad.c
+++ b/src/net/iobpad.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/ipv4.c b/src/net/ipv4.c
index 21abfccec..f3dd44384 100644
--- a/src/net/ipv4.c
+++ b/src/net/ipv4.c
@@ -49,6 +49,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /* Unique IP datagram identification number (high byte) */
 static uint8_t next_ident_high = 0;
diff --git a/src/net/ipv6.c b/src/net/ipv6.c
index b12d6577e..7e908dd2a 100644
--- a/src/net/ipv6.c
+++ b/src/net/ipv6.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/net/lldp.c b/src/net/lldp.c
index 2b707c874..d0e990f23 100644
--- a/src/net/lldp.c
+++ b/src/net/lldp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/net/ndp.c b/src/net/ndp.c
index 3c555f4a3..6d96270c1 100644
--- a/src/net/ndp.c
+++ b/src/net/ndp.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/net/neighbour.c b/src/net/neighbour.c
index ac79041e3..fa8fba5cd 100644
--- a/src/net/neighbour.c
+++ b/src/net/neighbour.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/netdev_settings.c b/src/net/netdev_settings.c
index 90b804c6c..8bc8ce57b 100644
--- a/src/net/netdev_settings.c
+++ b/src/net/netdev_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/net/netdevice.c b/src/net/netdevice.c
index c89585708..0af916ff5 100644
--- a/src/net/netdevice.c
+++ b/src/net/netdevice.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/nullnet.c b/src/net/nullnet.c
index 2948b38c0..c665b203a 100644
--- a/src/net/nullnet.c
+++ b/src/net/nullnet.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <errno.h>
diff --git a/src/net/retry.c b/src/net/retry.c
index 734567be5..c13ecb6b1 100644
--- a/src/net/retry.c
+++ b/src/net/retry.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/timer.h>
diff --git a/src/net/socket.c b/src/net/socket.c
index 2009ab237..6fed73128 100644
--- a/src/net/socket.c
+++ b/src/net/socket.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <errno.h>
diff --git a/src/net/stp.c b/src/net/stp.c
index 3d78400af..d1b0d4862 100644
--- a/src/net/stp.c
+++ b/src/net/stp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <byteswap.h>
diff --git a/src/net/tcp.c b/src/net/tcp.c
index 2e52cf480..f08db5250 100644
--- a/src/net/tcp.c
+++ b/src/net/tcp.c
@@ -28,6 +28,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** A TCP connection */
 struct tcp_connection {
diff --git a/src/net/tcp/http.c b/src/net/tcp/http.c
index b000ed80f..16cfd035e 100644
--- a/src/net/tcp/http.c
+++ b/src/net/tcp/http.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/httpauth.c b/src/net/tcp/httpauth.c
index 2c57e3d48..d682c5f8f 100644
--- a/src/net/tcp/httpauth.c
+++ b/src/net/tcp/httpauth.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/httpbasic.c b/src/net/tcp/httpbasic.c
index 52a67063d..4dffc7e0f 100644
--- a/src/net/tcp/httpbasic.c
+++ b/src/net/tcp/httpbasic.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/httpblock.c b/src/net/tcp/httpblock.c
index 8eff1942c..14398869e 100644
--- a/src/net/tcp/httpblock.c
+++ b/src/net/tcp/httpblock.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/httpconn.c b/src/net/tcp/httpconn.c
index 538c4dcf6..4b99209f0 100644
--- a/src/net/tcp/httpconn.c
+++ b/src/net/tcp/httpconn.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/httpcore.c b/src/net/tcp/httpcore.c
index 8fee0421c..912bea407 100644
--- a/src/net/tcp/httpcore.c
+++ b/src/net/tcp/httpcore.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/httpdigest.c b/src/net/tcp/httpdigest.c
index 4074078c7..8ff6dbfa5 100644
--- a/src/net/tcp/httpdigest.c
+++ b/src/net/tcp/httpdigest.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/iscsi.c b/src/net/tcp/iscsi.c
index b7b33a51a..0d1f0f645 100644
--- a/src/net/tcp/iscsi.c
+++ b/src/net/tcp/iscsi.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <string.h>
diff --git a/src/net/tcpip.c b/src/net/tcpip.c
index cc7d02005..5ed3d68a9 100644
--- a/src/net/tcpip.c
+++ b/src/net/tcpip.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * Process a received TCP/IP packet
diff --git a/src/net/udp.c b/src/net/udp.c
index 2c0b343dc..41aba2fca 100644
--- a/src/net/udp.c
+++ b/src/net/udp.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * A UDP connection
diff --git a/src/net/udp/dhcp.c b/src/net/udp/dhcp.c
index daa37b96b..59b7c663d 100644
--- a/src/net/udp/dhcp.c
+++ b/src/net/udp/dhcp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdlib.h>
diff --git a/src/net/udp/dhcpv6.c b/src/net/udp/dhcpv6.c
index a49109894..43a569d6e 100644
--- a/src/net/udp/dhcpv6.c
+++ b/src/net/udp/dhcpv6.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/net/udp/dns.c b/src/net/udp/dns.c
index f46eeb5c8..3f534b99f 100644
--- a/src/net/udp/dns.c
+++ b/src/net/udp/dns.c
@@ -25,6 +25,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/udp/tftp.c b/src/net/udp/tftp.c
index 2ee01862a..760af10e9 100644
--- a/src/net/udp/tftp.c
+++ b/src/net/udp/tftp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/net/vlan.c b/src/net/vlan.c
index c61bb850e..f7697a9be 100644
--- a/src/net/vlan.c
+++ b/src/net/vlan.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/usr/autoboot.c b/src/usr/autoboot.c
index 4b64ca82b..3d46e65e0 100644
--- a/src/usr/autoboot.c
+++ b/src/usr/autoboot.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdio.h>
diff --git a/src/usr/dhcpmgmt.c b/src/usr/dhcpmgmt.c
index dcb360b23..2a0a8c718 100644
--- a/src/usr/dhcpmgmt.c
+++ b/src/usr/dhcpmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdio.h>
diff --git a/src/usr/ifmgmt.c b/src/usr/ifmgmt.c
index d87ffff27..80f350ee4 100644
--- a/src/usr/ifmgmt.c
+++ b/src/usr/ifmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdio.h>
diff --git a/src/usr/imgmgmt.c b/src/usr/imgmgmt.c
index 65b52fd3a..bad056f0e 100644
--- a/src/usr/imgmgmt.c
+++ b/src/usr/imgmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/usr/prompt.c b/src/usr/prompt.c
index fca0a157c..ea233e2ed 100644
--- a/src/usr/prompt.c
+++ b/src/usr/prompt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/usr/route.c b/src/usr/route.c
index 690ba3b6b..77c68eeb3 100644
--- a/src/usr/route.c
+++ b/src/usr/route.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/netdevice.h>
 #include <usr/route.h>
diff --git a/src/usr/route_ipv4.c b/src/usr/route_ipv4.c
index f79c0ad8f..21b0820da 100644
--- a/src/usr/route_ipv4.c
+++ b/src/usr/route_ipv4.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <ipxe/netdevice.h>
diff --git a/src/usr/route_ipv6.c b/src/usr/route_ipv6.c
index 9e94b4a15..9d773ec60 100644
--- a/src/usr/route_ipv6.c
+++ b/src/usr/route_ipv6.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <ipxe/netdevice.h>
diff --git a/src/usr/shimmgmt.c b/src/usr/shimmgmt.c
index 6ac1ac35e..fb063ad51 100644
--- a/src/usr/shimmgmt.c
+++ b/src/usr/shimmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/efi_shim.h>
diff --git a/src/usr/sync.c b/src/usr/sync.c
index f599588ae..1e740bd4c 100644
--- a/src/usr/sync.c
+++ b/src/usr/sync.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/job.h>
-- 
cgit v1.2.3-55-g7522


From adcaaf9b93f9de14ba93bea54aecef103fe16b5f Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 14 Jan 2026 14:36:49 +0000
Subject: [build] Mark known reviewed files as permitted for UEFI Secure Boot

Some past security reviews carried out for UEFI Secure Boot signing
submissions have covered specific drivers or functional areas of iPXE.
Mark all of the files comprising these areas as permitted for UEFI
Secure Boot.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/arch/x86/core/cpuid_settings.c               | 1 +
 src/arch/x86/core/rdrand.c                       | 1 +
 src/arch/x86/include/bits/bigint.h               | 1 +
 src/arch/x86/include/bits/bitops.h               | 1 +
 src/arch/x86/include/bits/xen.h                  | 1 +
 src/config/config_archive.c                      | 1 +
 src/config/config_asn1.c                         | 1 +
 src/config/config_certs.c                        | 1 +
 src/config/config_crypto.c                       | 1 +
 src/config/config_digest_cmd.c                   | 1 +
 src/config/config_entropy.c                      | 1 +
 src/config/config_fc.c                           | 1 +
 src/config/config_fdt.c                          | 1 +
 src/config/config_infiniband.c                   | 1 +
 src/config/config_pixbuf.c                       | 1 +
 src/config/config_usb.c                          | 1 +
 src/config/crypto.h                              | 1 +
 src/config/entropy.h                             | 1 +
 src/config/fdt.h                                 | 1 +
 src/config/usb.h                                 | 1 +
 src/core/acpi_settings.c                         | 1 +
 src/core/acpimac.c                               | 1 +
 src/core/ansicoldef.c                            | 1 +
 src/core/fbcon.c                                 | 1 +
 src/core/fdt.c                                   | 1 +
 src/core/isqrt.c                                 | 1 +
 src/core/lineconsole.c                           | 1 +
 src/core/netbios.c                               | 1 +
 src/core/pinger.c                                | 1 +
 src/core/pixbuf.c                                | 1 +
 src/core/profile.c                               | 1 +
 src/crypto/aes.c                                 | 1 +
 src/crypto/asn1.c                                | 1 +
 src/crypto/bigint.c                              | 1 +
 src/crypto/cbc.c                                 | 1 +
 src/crypto/certstore.c                           | 1 +
 src/crypto/cms.c                                 | 1 +
 src/crypto/crypto_null.c                         | 1 +
 src/crypto/deflate.c                             | 1 +
 src/crypto/dhe.c                                 | 1 +
 src/crypto/drbg.c                                | 1 +
 src/crypto/ecb.c                                 | 1 +
 src/crypto/ecdhe.c                               | 1 +
 src/crypto/ecdsa.c                               | 1 +
 src/crypto/entropy.c                             | 1 +
 src/crypto/gcm.c                                 | 1 +
 src/crypto/hash_df.c                             | 1 +
 src/crypto/hmac.c                                | 1 +
 src/crypto/hmac_drbg.c                           | 1 +
 src/crypto/md4.c                                 | 1 +
 src/crypto/mishmash/cmd_sha224.c                 | 1 +
 src/crypto/mishmash/cmd_sha256.c                 | 1 +
 src/crypto/mishmash/cmd_sha384.c                 | 1 +
 src/crypto/mishmash/cmd_sha512.c                 | 1 +
 src/crypto/mishmash/dhe_rsa_aes_cbc_sha1.c       | 1 +
 src/crypto/mishmash/dhe_rsa_aes_cbc_sha256.c     | 1 +
 src/crypto/mishmash/dhe_rsa_aes_gcm_sha256.c     | 1 +
 src/crypto/mishmash/dhe_rsa_aes_gcm_sha384.c     | 1 +
 src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha1.c   | 1 +
 src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha256.c | 1 +
 src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha384.c | 1 +
 src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha256.c | 1 +
 src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha384.c | 1 +
 src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha1.c     | 1 +
 src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha256.c   | 1 +
 src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha384.c   | 1 +
 src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha256.c   | 1 +
 src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha384.c   | 1 +
 src/crypto/mishmash/ecdsa_sha224.c               | 1 +
 src/crypto/mishmash/ecdsa_sha256.c               | 1 +
 src/crypto/mishmash/ecdsa_sha384.c               | 1 +
 src/crypto/mishmash/ecdsa_sha512.c               | 1 +
 src/crypto/mishmash/oid_aes_cbc.c                | 1 +
 src/crypto/mishmash/oid_aes_gcm.c                | 1 +
 src/crypto/mishmash/oid_p256.c                   | 1 +
 src/crypto/mishmash/oid_p384.c                   | 1 +
 src/crypto/mishmash/oid_rsa.c                    | 1 +
 src/crypto/mishmash/oid_sha1.c                   | 1 +
 src/crypto/mishmash/oid_sha224.c                 | 1 +
 src/crypto/mishmash/oid_sha256.c                 | 1 +
 src/crypto/mishmash/oid_sha384.c                 | 1 +
 src/crypto/mishmash/oid_sha512.c                 | 1 +
 src/crypto/mishmash/oid_sha512_224.c             | 1 +
 src/crypto/mishmash/oid_sha512_256.c             | 1 +
 src/crypto/mishmash/oid_x25519.c                 | 1 +
 src/crypto/mishmash/rsa_aes_cbc_sha1.c           | 1 +
 src/crypto/mishmash/rsa_aes_cbc_sha256.c         | 1 +
 src/crypto/mishmash/rsa_aes_gcm_sha256.c         | 1 +
 src/crypto/mishmash/rsa_aes_gcm_sha384.c         | 1 +
 src/crypto/mishmash/rsa_sha1.c                   | 1 +
 src/crypto/mishmash/rsa_sha224.c                 | 1 +
 src/crypto/mishmash/rsa_sha256.c                 | 1 +
 src/crypto/mishmash/rsa_sha384.c                 | 1 +
 src/crypto/mishmash/rsa_sha512.c                 | 1 +
 src/crypto/ntlm.c                                | 1 +
 src/crypto/ocsp.c                                | 1 +
 src/crypto/p256.c                                | 1 +
 src/crypto/p384.c                                | 1 +
 src/crypto/privkey.c                             | 1 +
 src/crypto/random_nz.c                           | 1 +
 src/crypto/rbg.c                                 | 1 +
 src/crypto/rootcert.c                            | 1 +
 src/crypto/rsa.c                                 | 1 +
 src/crypto/sha1.c                                | 1 +
 src/crypto/sha224.c                              | 1 +
 src/crypto/sha256.c                              | 1 +
 src/crypto/sha384.c                              | 1 +
 src/crypto/sha512.c                              | 1 +
 src/crypto/sha512_224.c                          | 1 +
 src/crypto/sha512_256.c                          | 1 +
 src/crypto/weierstrass.c                         | 1 +
 src/crypto/x25519.c                              | 1 +
 src/crypto/x509.c                                | 1 +
 src/drivers/bus/cdc.c                            | 1 +
 src/drivers/bus/pcibackup.c                      | 1 +
 src/drivers/bus/pciextra.c                       | 1 +
 src/drivers/bus/pcimsix.c                        | 1 +
 src/drivers/bus/usb.c                            | 1 +
 src/drivers/bus/usb_settings.c                   | 1 +
 src/drivers/net/acm.c                            | 1 +
 src/drivers/net/acm.h                            | 1 +
 src/drivers/net/axge.c                           | 1 +
 src/drivers/net/axge.h                           | 1 +
 src/drivers/net/dm96xx.c                         | 1 +
 src/drivers/net/dm96xx.h                         | 1 +
 src/drivers/net/ecm.c                            | 1 +
 src/drivers/net/ecm.h                            | 1 +
 src/drivers/net/ice.c                            | 1 +
 src/drivers/net/ice.h                            | 1 +
 src/drivers/net/intel.c                          | 1 +
 src/drivers/net/intel.h                          | 1 +
 src/drivers/net/intelvf.c                        | 1 +
 src/drivers/net/intelvf.h                        | 1 +
 src/drivers/net/intelx.c                         | 1 +
 src/drivers/net/intelx.h                         | 1 +
 src/drivers/net/intelxl.c                        | 1 +
 src/drivers/net/intelxl.h                        | 1 +
 src/drivers/net/intelxlvf.c                      | 1 +
 src/drivers/net/intelxlvf.h                      | 1 +
 src/drivers/net/intelxvf.c                       | 1 +
 src/drivers/net/intelxvf.h                       | 1 +
 src/drivers/net/iphone.c                         | 1 +
 src/drivers/net/iphone.h                         | 1 +
 src/drivers/net/lan78xx.c                        | 1 +
 src/drivers/net/lan78xx.h                        | 1 +
 src/drivers/net/mii.c                            | 1 +
 src/drivers/net/ncm.c                            | 1 +
 src/drivers/net/ncm.h                            | 1 +
 src/drivers/net/netfront.c                       | 1 +
 src/drivers/net/netfront.h                       | 1 +
 src/drivers/net/smsc75xx.c                       | 1 +
 src/drivers/net/smsc75xx.h                       | 1 +
 src/drivers/net/smsc95xx.c                       | 1 +
 src/drivers/net/smsc95xx.h                       | 1 +
 src/drivers/net/smscusb.c                        | 1 +
 src/drivers/net/smscusb.h                        | 1 +
 src/drivers/net/vmxnet3.c                        | 1 +
 src/drivers/net/vmxnet3.h                        | 1 +
 src/drivers/usb/ehci.c                           | 1 +
 src/drivers/usb/ehci.h                           | 1 +
 src/drivers/usb/uhci.c                           | 1 +
 src/drivers/usb/uhci.h                           | 1 +
 src/drivers/usb/usbblk.c                         | 1 +
 src/drivers/usb/usbblk.h                         | 1 +
 src/drivers/usb/usbhub.c                         | 1 +
 src/drivers/usb/usbhub.h                         | 1 +
 src/drivers/usb/usbnet.c                         | 1 +
 src/drivers/usb/xhci.c                           | 1 +
 src/hci/commands/cert_cmd.c                      | 1 +
 src/hci/commands/console_cmd.c                   | 1 +
 src/hci/commands/digest_cmd.c                    | 1 +
 src/hci/commands/image_trust_cmd.c               | 1 +
 src/hci/commands/ipstat_cmd.c                    | 1 +
 src/hci/commands/neighbour_cmd.c                 | 1 +
 src/hci/commands/nslookup_cmd.c                  | 1 +
 src/hci/commands/ntp_cmd.c                       | 1 +
 src/hci/commands/param_cmd.c                     | 1 +
 src/hci/commands/ping_cmd.c                      | 1 +
 src/hci/commands/poweroff_cmd.c                  | 1 +
 src/hci/commands/profstat_cmd.c                  | 1 +
 src/hci/commands/vlan_cmd.c                      | 1 +
 src/image/der.c                                  | 1 +
 src/image/efi_siglist.c                          | 1 +
 src/image/pem.c                                  | 1 +
 src/image/png.c                                  | 1 +
 src/include/hci/digest_cmd.h                     | 1 +
 src/include/ipxe/acpimac.h                       | 1 +
 src/include/ipxe/aes.h                           | 1 +
 src/include/ipxe/bigint.h                        | 1 +
 src/include/ipxe/bitops.h                        | 1 +
 src/include/ipxe/cbc.h                           | 1 +
 src/include/ipxe/cdc.h                           | 1 +
 src/include/ipxe/certstore.h                     | 1 +
 src/include/ipxe/cms.h                           | 1 +
 src/include/ipxe/deflate.h                       | 1 +
 src/include/ipxe/der.h                           | 1 +
 src/include/ipxe/dhe.h                           | 1 +
 src/include/ipxe/drbg.h                          | 1 +
 src/include/ipxe/ecb.h                           | 1 +
 src/include/ipxe/ecdhe.h                         | 1 +
 src/include/ipxe/ecdsa.h                         | 1 +
 src/include/ipxe/efi/efi_siglist.h               | 1 +
 src/include/ipxe/efi/efi_usb.h                   | 3 +++
 src/include/ipxe/entropy.h                       | 1 +
 src/include/ipxe/fbcon.h                         | 1 +
 src/include/ipxe/fdt.h                           | 1 +
 src/include/ipxe/gcm.h                           | 1 +
 src/include/ipxe/hash_df.h                       | 1 +
 src/include/ipxe/hmac.h                          | 1 +
 src/include/ipxe/hmac_drbg.h                     | 1 +
 src/include/ipxe/isqrt.h                         | 1 +
 src/include/ipxe/lineconsole.h                   | 1 +
 src/include/ipxe/md4.h                           | 1 +
 src/include/ipxe/mii.h                           | 1 +
 src/include/ipxe/netbios.h                       | 1 +
 src/include/ipxe/ntp.h                           | 1 +
 src/include/ipxe/ocsp.h                          | 1 +
 src/include/ipxe/p256.h                          | 1 +
 src/include/ipxe/p384.h                          | 1 +
 src/include/ipxe/pccrc.h                         | 1 +
 src/include/ipxe/pccrd.h                         | 1 +
 src/include/ipxe/pccrr.h                         | 1 +
 src/include/ipxe/pcibackup.h                     | 1 +
 src/include/ipxe/pcimsix.h                       | 1 +
 src/include/ipxe/peerblk.h                       | 1 +
 src/include/ipxe/peerdisc.h                      | 1 +
 src/include/ipxe/peermux.h                       | 1 +
 src/include/ipxe/pem.h                           | 1 +
 src/include/ipxe/pinger.h                        | 1 +
 src/include/ipxe/pixbuf.h                        | 1 +
 src/include/ipxe/png.h                           | 1 +
 src/include/ipxe/privkey.h                       | 1 +
 src/include/ipxe/random_nz.h                     | 1 +
 src/include/ipxe/rbg.h                           | 1 +
 src/include/ipxe/rndis.h                         | 1 +
 src/include/ipxe/rootcert.h                      | 1 +
 src/include/ipxe/rsa.h                           | 1 +
 src/include/ipxe/sha1.h                          | 1 +
 src/include/ipxe/sha256.h                        | 1 +
 src/include/ipxe/sha512.h                        | 1 +
 src/include/ipxe/syslog.h                        | 1 +
 src/include/ipxe/tls.h                           | 1 +
 src/include/ipxe/usbnet.h                        | 1 +
 src/include/ipxe/validator.h                     | 1 +
 src/include/ipxe/weierstrass.h                   | 1 +
 src/include/ipxe/x25519.h                        | 1 +
 src/include/ipxe/x509.h                          | 1 +
 src/include/ipxe/xen.h                           | 1 +
 src/include/ipxe/xenbus.h                        | 1 +
 src/include/ipxe/xenevent.h                      | 1 +
 src/include/ipxe/xengrant.h                      | 1 +
 src/include/ipxe/xenstore.h                      | 1 +
 src/include/ipxe/xhci.h                          | 1 +
 src/include/mii.h                                | 1 +
 src/include/usr/certmgmt.h                       | 1 +
 src/include/usr/imgtrust.h                       | 1 +
 src/include/usr/ipstat.h                         | 1 +
 src/include/usr/neighmgmt.h                      | 1 +
 src/include/usr/nslookup.h                       | 1 +
 src/include/usr/ntpmgmt.h                        | 1 +
 src/include/usr/pingmgmt.h                       | 1 +
 src/include/usr/profstat.h                       | 1 +
 src/include/xen/arch-x86/xen-x86_64.h            | 1 +
 src/include/xen/arch-x86/xen.h                   | 1 +
 src/include/xen/event_channel.h                  | 1 +
 src/include/xen/grant_table.h                    | 1 +
 src/include/xen/io/netif.h                       | 1 +
 src/include/xen/io/ring.h                        | 1 +
 src/include/xen/io/xenbus.h                      | 1 +
 src/include/xen/io/xs_wire.h                     | 1 +
 src/include/xen/xen-compat.h                     | 1 +
 src/include/xen/xen.h                            | 1 +
 src/interface/efi/efi_cacert.c                   | 1 +
 src/interface/efi/efi_entropy.c                  | 1 +
 src/interface/efi/efi_fbcon.c                    | 1 +
 src/interface/efi/efi_fdt.c                      | 1 +
 src/interface/efi/efi_rng.c                      | 1 +
 src/interface/efi/efi_usb.c                      | 1 +
 src/interface/xen/xenbus.c                       | 1 +
 src/interface/xen/xengrant.c                     | 1 +
 src/interface/xen/xenstore.c                     | 1 +
 src/net/pccrc.c                                  | 1 +
 src/net/pccrd.c                                  | 1 +
 src/net/peerblk.c                                | 1 +
 src/net/peerdisc.c                               | 1 +
 src/net/peerdist.c                               | 1 +
 src/net/peermux.c                                | 1 +
 src/net/ping.c                                   | 1 +
 src/net/rndis.c                                  | 1 +
 src/net/tcp/httpntlm.c                           | 1 +
 src/net/tcp/https.c                              | 1 +
 src/net/tcp/syslogs.c                            | 1 +
 src/net/tls.c                                    | 1 +
 src/net/udp/ntp.c                                | 1 +
 src/net/udp/syslog.c                             | 1 +
 src/net/validator.c                              | 1 +
 src/usr/certmgmt.c                               | 1 +
 src/usr/imgtrust.c                               | 1 +
 src/usr/ipstat.c                                 | 1 +
 src/usr/neighmgmt.c                              | 1 +
 src/usr/nslookup.c                               | 1 +
 src/usr/ntpmgmt.c                                | 1 +
 src/usr/pingmgmt.c                               | 1 +
 src/usr/profstat.c                               | 1 +
 304 files changed, 306 insertions(+)

(limited to 'src/core')

diff --git a/src/arch/x86/core/cpuid_settings.c b/src/arch/x86/core/cpuid_settings.c
index 44d38debc..ef0164069 100644
--- a/src/arch/x86/core/cpuid_settings.c
+++ b/src/arch/x86/core/cpuid_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/arch/x86/core/rdrand.c b/src/arch/x86/core/rdrand.c
index 850ab1f11..05fc3cd23 100644
--- a/src/arch/x86/core/rdrand.c
+++ b/src/arch/x86/core/rdrand.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/arch/x86/include/bits/bigint.h b/src/arch/x86/include/bits/bigint.h
index c6f097a34..21cffa0cf 100644
--- a/src/arch/x86/include/bits/bigint.h
+++ b/src/arch/x86/include/bits/bigint.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/arch/x86/include/bits/bitops.h b/src/arch/x86/include/bits/bitops.h
index f697b8c8f..cdbc3b0a2 100644
--- a/src/arch/x86/include/bits/bitops.h
+++ b/src/arch/x86/include/bits/bitops.h
@@ -14,6 +14,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/arch/x86/include/bits/xen.h b/src/arch/x86/include/bits/xen.h
index 3433cea1f..313bec254 100644
--- a/src/arch/x86/include/bits/xen.h
+++ b/src/arch/x86/include/bits/xen.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /* Hypercall registers */
 #ifdef __x86_64__
diff --git a/src/config/config_archive.c b/src/config/config_archive.c
index 746fc7e44..71c883dcc 100644
--- a/src/config/config_archive.c
+++ b/src/config/config_archive.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_asn1.c b/src/config/config_asn1.c
index 107f99c1d..ad3e95b96 100644
--- a/src/config/config_asn1.c
+++ b/src/config/config_asn1.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_certs.c b/src/config/config_certs.c
index a325d132c..ad5a2f708 100644
--- a/src/config/config_certs.c
+++ b/src/config/config_certs.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_crypto.c b/src/config/config_crypto.c
index 4bba147e5..724b95d02 100644
--- a/src/config/config_crypto.c
+++ b/src/config/config_crypto.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/crypto.h>
 
diff --git a/src/config/config_digest_cmd.c b/src/config/config_digest_cmd.c
index 5a8752ae1..1c4d8dca1 100644
--- a/src/config/config_digest_cmd.c
+++ b/src/config/config_digest_cmd.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/crypto.h>
 
diff --git a/src/config/config_entropy.c b/src/config/config_entropy.c
index 92aa97884..494b19f20 100644
--- a/src/config/config_entropy.c
+++ b/src/config/config_entropy.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/entropy.h>
 
diff --git a/src/config/config_fc.c b/src/config/config_fc.c
index 33fc9462a..3aea9b080 100644
--- a/src/config/config_fc.c
+++ b/src/config/config_fc.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_fdt.c b/src/config/config_fdt.c
index e8d425933..a6fb6f332 100644
--- a/src/config/config_fdt.c
+++ b/src/config/config_fdt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/fdt.h>
 
diff --git a/src/config/config_infiniband.c b/src/config/config_infiniband.c
index 4da8fe219..9e0826169 100644
--- a/src/config/config_infiniband.c
+++ b/src/config/config_infiniband.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_pixbuf.c b/src/config/config_pixbuf.c
index f8ff59daf..b2dbd869a 100644
--- a/src/config/config_pixbuf.c
+++ b/src/config/config_pixbuf.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/general.h>
 
diff --git a/src/config/config_usb.c b/src/config/config_usb.c
index 10dec221a..b3fd412e9 100644
--- a/src/config/config_usb.c
+++ b/src/config/config_usb.c
@@ -20,6 +20,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/usb.h>
 #include <config/settings.h>
diff --git a/src/config/crypto.h b/src/config/crypto.h
index a0774390b..e28ba2777 100644
--- a/src/config/crypto.h
+++ b/src/config/crypto.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** Minimum TLS version */
 #define TLS_VERSION_MIN TLS_VERSION_TLS_1_1
diff --git a/src/config/entropy.h b/src/config/entropy.h
index c79060fd5..db180c61a 100644
--- a/src/config/entropy.h
+++ b/src/config/entropy.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/fdt.h b/src/config/fdt.h
index 4d13e0535..7f3d39768 100644
--- a/src/config/fdt.h
+++ b/src/config/fdt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/config/usb.h b/src/config/usb.h
index 4252ec229..09e0b82e6 100644
--- a/src/config/usb.h
+++ b/src/config/usb.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <config/defaults.h>
 
diff --git a/src/core/acpi_settings.c b/src/core/acpi_settings.c
index 63f271855..8dc2a7fd8 100644
--- a/src/core/acpi_settings.c
+++ b/src/core/acpi_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/core/acpimac.c b/src/core/acpimac.c
index 11ac3243e..04fd98836 100644
--- a/src/core/acpimac.c
+++ b/src/core/acpimac.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/core/ansicoldef.c b/src/core/ansicoldef.c
index 6d8598e11..4555c4e36 100644
--- a/src/core/ansicoldef.c
+++ b/src/core/ansicoldef.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <errno.h>
diff --git a/src/core/fbcon.c b/src/core/fbcon.c
index ef158aec7..e07605470 100644
--- a/src/core/fbcon.c
+++ b/src/core/fbcon.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/fdt.c b/src/core/fdt.c
index 08adb166e..8ac781b05 100644
--- a/src/core/fdt.c
+++ b/src/core/fdt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <ctype.h>
diff --git a/src/core/isqrt.c b/src/core/isqrt.c
index c4d0571e7..b553c0935 100644
--- a/src/core/isqrt.c
+++ b/src/core/isqrt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/lineconsole.c b/src/core/lineconsole.c
index 0a72d1434..25eae39dd 100644
--- a/src/core/lineconsole.c
+++ b/src/core/lineconsole.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/netbios.c b/src/core/netbios.c
index 0d4e2086f..299e0d599 100644
--- a/src/core/netbios.c
+++ b/src/core/netbios.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/pinger.c b/src/core/pinger.c
index 0ff7bb9f2..bbfa83f8d 100644
--- a/src/core/pinger.c
+++ b/src/core/pinger.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/core/pixbuf.c b/src/core/pixbuf.c
index 506a28c38..df187f93d 100644
--- a/src/core/pixbuf.c
+++ b/src/core/pixbuf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/core/profile.c b/src/core/profile.c
index 3655108ea..27d481d45 100644
--- a/src/core/profile.c
+++ b/src/core/profile.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/crypto/aes.c b/src/crypto/aes.c
index 5200e7760..fe6ccb222 100644
--- a/src/crypto/aes.c
+++ b/src/crypto/aes.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/asn1.c b/src/crypto/asn1.c
index dd0b954e1..98d5b638f 100644
--- a/src/crypto/asn1.c
+++ b/src/crypto/asn1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/src/crypto/bigint.c b/src/crypto/bigint.c
index 9ccd9ff88..5d2f7b560 100644
--- a/src/crypto/bigint.c
+++ b/src/crypto/bigint.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/crypto/cbc.c b/src/crypto/cbc.c
index 0ba17ee48..ddba7abd9 100644
--- a/src/crypto/cbc.c
+++ b/src/crypto/cbc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <assert.h>
diff --git a/src/crypto/certstore.c b/src/crypto/certstore.c
index aad874297..8472a2eed 100644
--- a/src/crypto/certstore.c
+++ b/src/crypto/certstore.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdlib.h>
diff --git a/src/crypto/cms.c b/src/crypto/cms.c
index 7775e581b..4c0f3f5a6 100644
--- a/src/crypto/cms.c
+++ b/src/crypto/cms.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/crypto_null.c b/src/crypto/crypto_null.c
index e80f2707f..8637987b1 100644
--- a/src/crypto/crypto_null.c
+++ b/src/crypto/crypto_null.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/crypto/deflate.c b/src/crypto/deflate.c
index 5d0101184..1d54749e0 100644
--- a/src/crypto/deflate.c
+++ b/src/crypto/deflate.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <strings.h>
diff --git a/src/crypto/dhe.c b/src/crypto/dhe.c
index a249f9b40..2785a500b 100644
--- a/src/crypto/dhe.c
+++ b/src/crypto/dhe.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/drbg.c b/src/crypto/drbg.c
index a3366e806..c4dc7646d 100644
--- a/src/crypto/drbg.c
+++ b/src/crypto/drbg.c
@@ -34,6 +34,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/ecb.c b/src/crypto/ecb.c
index 3c9cf340c..73eef09c2 100644
--- a/src/crypto/ecb.c
+++ b/src/crypto/ecb.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 #include <ipxe/crypto.h>
diff --git a/src/crypto/ecdhe.c b/src/crypto/ecdhe.c
index 6c86b1c90..016253457 100644
--- a/src/crypto/ecdhe.c
+++ b/src/crypto/ecdhe.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/ecdsa.c b/src/crypto/ecdsa.c
index cd06d5578..6f10a1a0f 100644
--- a/src/crypto/ecdsa.c
+++ b/src/crypto/ecdsa.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/entropy.c b/src/crypto/entropy.c
index 419007159..ac0e92c42 100644
--- a/src/crypto/entropy.c
+++ b/src/crypto/entropy.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/gcm.c b/src/crypto/gcm.c
index b93925d07..b9c9d3a39 100644
--- a/src/crypto/gcm.c
+++ b/src/crypto/gcm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/hash_df.c b/src/crypto/hash_df.c
index dc0dc0ce8..ec4bcaebc 100644
--- a/src/crypto/hash_df.c
+++ b/src/crypto/hash_df.c
@@ -34,6 +34,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/hmac.c b/src/crypto/hmac.c
index 7109bbf6a..ed4cefaad 100644
--- a/src/crypto/hmac.c
+++ b/src/crypto/hmac.c
@@ -34,6 +34,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/crypto/hmac_drbg.c b/src/crypto/hmac_drbg.c
index 57bde4d1d..bd831e239 100644
--- a/src/crypto/hmac_drbg.c
+++ b/src/crypto/hmac_drbg.c
@@ -34,6 +34,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/md4.c b/src/crypto/md4.c
index dcd86a428..a9184aa57 100644
--- a/src/crypto/md4.c
+++ b/src/crypto/md4.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/mishmash/cmd_sha224.c b/src/crypto/mishmash/cmd_sha224.c
index 3975a37c5..fd8095937 100644
--- a/src/crypto/mishmash/cmd_sha224.c
+++ b/src/crypto/mishmash/cmd_sha224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha256.h>
 #include <hci/digest_cmd.h>
diff --git a/src/crypto/mishmash/cmd_sha256.c b/src/crypto/mishmash/cmd_sha256.c
index 8076e8dbf..259ae3eac 100644
--- a/src/crypto/mishmash/cmd_sha256.c
+++ b/src/crypto/mishmash/cmd_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha256.h>
 #include <hci/digest_cmd.h>
diff --git a/src/crypto/mishmash/cmd_sha384.c b/src/crypto/mishmash/cmd_sha384.c
index ed7265ab9..c31154d24 100644
--- a/src/crypto/mishmash/cmd_sha384.c
+++ b/src/crypto/mishmash/cmd_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha512.h>
 #include <hci/digest_cmd.h>
diff --git a/src/crypto/mishmash/cmd_sha512.c b/src/crypto/mishmash/cmd_sha512.c
index 96b8ade88..b6207f86d 100644
--- a/src/crypto/mishmash/cmd_sha512.c
+++ b/src/crypto/mishmash/cmd_sha512.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha512.h>
 #include <hci/digest_cmd.h>
diff --git a/src/crypto/mishmash/dhe_rsa_aes_cbc_sha1.c b/src/crypto/mishmash/dhe_rsa_aes_cbc_sha1.c
index 05e409f7a..ec2155001 100644
--- a/src/crypto/mishmash/dhe_rsa_aes_cbc_sha1.c
+++ b/src/crypto/mishmash/dhe_rsa_aes_cbc_sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/dhe_rsa_aes_cbc_sha256.c b/src/crypto/mishmash/dhe_rsa_aes_cbc_sha256.c
index 6ce428642..4e6226e87 100644
--- a/src/crypto/mishmash/dhe_rsa_aes_cbc_sha256.c
+++ b/src/crypto/mishmash/dhe_rsa_aes_cbc_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/dhe_rsa_aes_gcm_sha256.c b/src/crypto/mishmash/dhe_rsa_aes_gcm_sha256.c
index dc5cad9f8..6bbe4d00d 100644
--- a/src/crypto/mishmash/dhe_rsa_aes_gcm_sha256.c
+++ b/src/crypto/mishmash/dhe_rsa_aes_gcm_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/dhe_rsa_aes_gcm_sha384.c b/src/crypto/mishmash/dhe_rsa_aes_gcm_sha384.c
index 0448255f3..336feb195 100644
--- a/src/crypto/mishmash/dhe_rsa_aes_gcm_sha384.c
+++ b/src/crypto/mishmash/dhe_rsa_aes_gcm_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha1.c b/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha1.c
index d6eaf8b0a..0d9fcd15d 100644
--- a/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha1.c
+++ b/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/ecdsa.h>
diff --git a/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha256.c b/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha256.c
index 0fc486fbd..4b7cf1620 100644
--- a/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha256.c
+++ b/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/ecdsa.h>
diff --git a/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha384.c b/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha384.c
index 5106c18ce..85373911a 100644
--- a/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha384.c
+++ b/src/crypto/mishmash/ecdhe_ecdsa_aes_cbc_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/ecdsa.h>
diff --git a/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha256.c b/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha256.c
index 2b118e7a5..5aeb2f3d9 100644
--- a/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha256.c
+++ b/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/ecdsa.h>
diff --git a/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha384.c b/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha384.c
index b4946df88..3dc6149d7 100644
--- a/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha384.c
+++ b/src/crypto/mishmash/ecdhe_ecdsa_aes_gcm_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/ecdsa.h>
diff --git a/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha1.c b/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha1.c
index c23f65cc0..46b42ac1e 100644
--- a/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha1.c
+++ b/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha256.c b/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha256.c
index 431e2e304..dd524ec78 100644
--- a/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha256.c
+++ b/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha384.c b/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha384.c
index c52976809..7524d1ccc 100644
--- a/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha384.c
+++ b/src/crypto/mishmash/ecdhe_rsa_aes_cbc_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha256.c b/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha256.c
index 4f4e38c69..978be2a4c 100644
--- a/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha256.c
+++ b/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha384.c b/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha384.c
index 0bc7c305f..5ca6f0457 100644
--- a/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha384.c
+++ b/src/crypto/mishmash/ecdhe_rsa_aes_gcm_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/ecdsa_sha224.c b/src/crypto/mishmash/ecdsa_sha224.c
index ab42658cb..92aa881cd 100644
--- a/src/crypto/mishmash/ecdsa_sha224.c
+++ b/src/crypto/mishmash/ecdsa_sha224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/ecdsa.h>
 #include <ipxe/sha256.h>
diff --git a/src/crypto/mishmash/ecdsa_sha256.c b/src/crypto/mishmash/ecdsa_sha256.c
index 12cbec80c..025d6ec73 100644
--- a/src/crypto/mishmash/ecdsa_sha256.c
+++ b/src/crypto/mishmash/ecdsa_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/ecdsa.h>
 #include <ipxe/sha256.h>
diff --git a/src/crypto/mishmash/ecdsa_sha384.c b/src/crypto/mishmash/ecdsa_sha384.c
index b52621311..d7a0ca5d6 100644
--- a/src/crypto/mishmash/ecdsa_sha384.c
+++ b/src/crypto/mishmash/ecdsa_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/ecdsa.h>
 #include <ipxe/sha512.h>
diff --git a/src/crypto/mishmash/ecdsa_sha512.c b/src/crypto/mishmash/ecdsa_sha512.c
index 420c685e7..15391abf2 100644
--- a/src/crypto/mishmash/ecdsa_sha512.c
+++ b/src/crypto/mishmash/ecdsa_sha512.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/ecdsa.h>
 #include <ipxe/sha512.h>
diff --git a/src/crypto/mishmash/oid_aes_cbc.c b/src/crypto/mishmash/oid_aes_cbc.c
index b5f716574..d5b81541a 100644
--- a/src/crypto/mishmash/oid_aes_cbc.c
+++ b/src/crypto/mishmash/oid_aes_cbc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/aes.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_aes_gcm.c b/src/crypto/mishmash/oid_aes_gcm.c
index af1432d8e..6be1a132d 100644
--- a/src/crypto/mishmash/oid_aes_gcm.c
+++ b/src/crypto/mishmash/oid_aes_gcm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/aes.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_p256.c b/src/crypto/mishmash/oid_p256.c
index d473df09f..81ae1d11e 100644
--- a/src/crypto/mishmash/oid_p256.c
+++ b/src/crypto/mishmash/oid_p256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/p256.h>
diff --git a/src/crypto/mishmash/oid_p384.c b/src/crypto/mishmash/oid_p384.c
index 968fb45c1..a7d36aee4 100644
--- a/src/crypto/mishmash/oid_p384.c
+++ b/src/crypto/mishmash/oid_p384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/p384.h>
diff --git a/src/crypto/mishmash/oid_rsa.c b/src/crypto/mishmash/oid_rsa.c
index 582022628..02bb59edb 100644
--- a/src/crypto/mishmash/oid_rsa.c
+++ b/src/crypto/mishmash/oid_rsa.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsa.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha1.c b/src/crypto/mishmash/oid_sha1.c
index 5dae6d27c..5ddd2aba8 100644
--- a/src/crypto/mishmash/oid_sha1.c
+++ b/src/crypto/mishmash/oid_sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha1.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha224.c b/src/crypto/mishmash/oid_sha224.c
index ee7ed22e4..6658bda56 100644
--- a/src/crypto/mishmash/oid_sha224.c
+++ b/src/crypto/mishmash/oid_sha224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha256.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha256.c b/src/crypto/mishmash/oid_sha256.c
index 963fddb63..8da40a70b 100644
--- a/src/crypto/mishmash/oid_sha256.c
+++ b/src/crypto/mishmash/oid_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha256.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha384.c b/src/crypto/mishmash/oid_sha384.c
index 81ff48bbf..57c1ab53b 100644
--- a/src/crypto/mishmash/oid_sha384.c
+++ b/src/crypto/mishmash/oid_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha512.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha512.c b/src/crypto/mishmash/oid_sha512.c
index 78bae48b4..73d7cb78f 100644
--- a/src/crypto/mishmash/oid_sha512.c
+++ b/src/crypto/mishmash/oid_sha512.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha512.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha512_224.c b/src/crypto/mishmash/oid_sha512_224.c
index 6f61f9cac..a6291097b 100644
--- a/src/crypto/mishmash/oid_sha512_224.c
+++ b/src/crypto/mishmash/oid_sha512_224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha512.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_sha512_256.c b/src/crypto/mishmash/oid_sha512_256.c
index bce4762e4..d36199372 100644
--- a/src/crypto/mishmash/oid_sha512_256.c
+++ b/src/crypto/mishmash/oid_sha512_256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/sha512.h>
 #include <ipxe/asn1.h>
diff --git a/src/crypto/mishmash/oid_x25519.c b/src/crypto/mishmash/oid_x25519.c
index 30b7905ea..2907eb461 100644
--- a/src/crypto/mishmash/oid_x25519.c
+++ b/src/crypto/mishmash/oid_x25519.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/x25519.h>
diff --git a/src/crypto/mishmash/rsa_aes_cbc_sha1.c b/src/crypto/mishmash/rsa_aes_cbc_sha1.c
index 0862fb5ac..35f5f6eb7 100644
--- a/src/crypto/mishmash/rsa_aes_cbc_sha1.c
+++ b/src/crypto/mishmash/rsa_aes_cbc_sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/rsa_aes_cbc_sha256.c b/src/crypto/mishmash/rsa_aes_cbc_sha256.c
index e5928db82..22705df7e 100644
--- a/src/crypto/mishmash/rsa_aes_cbc_sha256.c
+++ b/src/crypto/mishmash/rsa_aes_cbc_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/rsa_aes_gcm_sha256.c b/src/crypto/mishmash/rsa_aes_gcm_sha256.c
index b18bbd844..d3fd00f1e 100644
--- a/src/crypto/mishmash/rsa_aes_gcm_sha256.c
+++ b/src/crypto/mishmash/rsa_aes_gcm_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/rsa_aes_gcm_sha384.c b/src/crypto/mishmash/rsa_aes_gcm_sha384.c
index 06558aaed..908db086a 100644
--- a/src/crypto/mishmash/rsa_aes_gcm_sha384.c
+++ b/src/crypto/mishmash/rsa_aes_gcm_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <byteswap.h>
 #include <ipxe/rsa.h>
diff --git a/src/crypto/mishmash/rsa_sha1.c b/src/crypto/mishmash/rsa_sha1.c
index 264f871f1..8907ac08a 100644
--- a/src/crypto/mishmash/rsa_sha1.c
+++ b/src/crypto/mishmash/rsa_sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsa.h>
 #include <ipxe/sha1.h>
diff --git a/src/crypto/mishmash/rsa_sha224.c b/src/crypto/mishmash/rsa_sha224.c
index 1465a033d..b676d41f3 100644
--- a/src/crypto/mishmash/rsa_sha224.c
+++ b/src/crypto/mishmash/rsa_sha224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsa.h>
 #include <ipxe/sha256.h>
diff --git a/src/crypto/mishmash/rsa_sha256.c b/src/crypto/mishmash/rsa_sha256.c
index 7283c3e29..8a6a7a5cf 100644
--- a/src/crypto/mishmash/rsa_sha256.c
+++ b/src/crypto/mishmash/rsa_sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsa.h>
 #include <ipxe/sha256.h>
diff --git a/src/crypto/mishmash/rsa_sha384.c b/src/crypto/mishmash/rsa_sha384.c
index 6f8c29b29..cc1878bd4 100644
--- a/src/crypto/mishmash/rsa_sha384.c
+++ b/src/crypto/mishmash/rsa_sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsa.h>
 #include <ipxe/sha512.h>
diff --git a/src/crypto/mishmash/rsa_sha512.c b/src/crypto/mishmash/rsa_sha512.c
index bb4463a5a..9c995e1c8 100644
--- a/src/crypto/mishmash/rsa_sha512.c
+++ b/src/crypto/mishmash/rsa_sha512.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/rsa.h>
 #include <ipxe/sha512.h>
diff --git a/src/crypto/ntlm.c b/src/crypto/ntlm.c
index fb120f8db..f9ce51bde 100644
--- a/src/crypto/ntlm.c
+++ b/src/crypto/ntlm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/ocsp.c b/src/crypto/ocsp.c
index 1712d614e..5d6acb605 100644
--- a/src/crypto/ocsp.c
+++ b/src/crypto/ocsp.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/crypto/p256.c b/src/crypto/p256.c
index 2ba66e72c..a513555b3 100644
--- a/src/crypto/p256.c
+++ b/src/crypto/p256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/p384.c b/src/crypto/p384.c
index a53a9ce9d..bdd23d460 100644
--- a/src/crypto/p384.c
+++ b/src/crypto/p384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/privkey.c b/src/crypto/privkey.c
index cbe8deff3..c67a4400b 100644
--- a/src/crypto/privkey.c
+++ b/src/crypto/privkey.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/crypto/random_nz.c b/src/crypto/random_nz.c
index 5fe576e05..96b12359c 100644
--- a/src/crypto/random_nz.c
+++ b/src/crypto/random_nz.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/rbg.c b/src/crypto/rbg.c
index 5e1c25f53..17914542e 100644
--- a/src/crypto/rbg.c
+++ b/src/crypto/rbg.c
@@ -34,6 +34,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/rootcert.c b/src/crypto/rootcert.c
index b198c1d95..6eb08256a 100644
--- a/src/crypto/rootcert.c
+++ b/src/crypto/rootcert.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <ipxe/crypto.h>
diff --git a/src/crypto/rsa.c b/src/crypto/rsa.c
index 9c0982cf6..be055d881 100644
--- a/src/crypto/rsa.c
+++ b/src/crypto/rsa.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/crypto/sha1.c b/src/crypto/sha1.c
index 8eecc75b3..023becec6 100644
--- a/src/crypto/sha1.c
+++ b/src/crypto/sha1.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/sha224.c b/src/crypto/sha224.c
index e54a0abb0..7e0cfd34e 100644
--- a/src/crypto/sha224.c
+++ b/src/crypto/sha224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/sha256.c b/src/crypto/sha256.c
index c30300eb4..742393612 100644
--- a/src/crypto/sha256.c
+++ b/src/crypto/sha256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/sha384.c b/src/crypto/sha384.c
index f1af6fc6f..3e5e98a31 100644
--- a/src/crypto/sha384.c
+++ b/src/crypto/sha384.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/sha512.c b/src/crypto/sha512.c
index d7d44b284..724cb71a5 100644
--- a/src/crypto/sha512.c
+++ b/src/crypto/sha512.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/sha512_224.c b/src/crypto/sha512_224.c
index b6728726c..3b256a3b9 100644
--- a/src/crypto/sha512_224.c
+++ b/src/crypto/sha512_224.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/sha512_256.c b/src/crypto/sha512_256.c
index 8163631e0..04df3f5bc 100644
--- a/src/crypto/sha512_256.c
+++ b/src/crypto/sha512_256.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/weierstrass.c b/src/crypto/weierstrass.c
index bb9b50bf8..a64626c85 100644
--- a/src/crypto/weierstrass.c
+++ b/src/crypto/weierstrass.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/x25519.c b/src/crypto/x25519.c
index 4b4c489da..95c42ea13 100644
--- a/src/crypto/x25519.c
+++ b/src/crypto/x25519.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/crypto/x509.c b/src/crypto/x509.c
index 1206e4023..6a3fe423b 100644
--- a/src/crypto/x509.c
+++ b/src/crypto/x509.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/drivers/bus/cdc.c b/src/drivers/bus/cdc.c
index 373a03072..c3a2a450b 100644
--- a/src/drivers/bus/cdc.c
+++ b/src/drivers/bus/cdc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/usb.h>
diff --git a/src/drivers/bus/pcibackup.c b/src/drivers/bus/pcibackup.c
index 4cf126f83..81fcb7e05 100644
--- a/src/drivers/bus/pcibackup.c
+++ b/src/drivers/bus/pcibackup.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/pci.h>
diff --git a/src/drivers/bus/pciextra.c b/src/drivers/bus/pciextra.c
index 3654a2d1c..f769a3172 100644
--- a/src/drivers/bus/pciextra.c
+++ b/src/drivers/bus/pciextra.c
@@ -1,4 +1,5 @@
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/timer.h>
diff --git a/src/drivers/bus/pcimsix.c b/src/drivers/bus/pcimsix.c
index f55488ad7..008c1c22f 100644
--- a/src/drivers/bus/pcimsix.c
+++ b/src/drivers/bus/pcimsix.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <errno.h>
diff --git a/src/drivers/bus/usb.c b/src/drivers/bus/usb.c
index b3b361b0d..30c288df9 100644
--- a/src/drivers/bus/usb.c
+++ b/src/drivers/bus/usb.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/drivers/bus/usb_settings.c b/src/drivers/bus/usb_settings.c
index bb01f34d5..e34c79126 100644
--- a/src/drivers/bus/usb_settings.c
+++ b/src/drivers/bus/usb_settings.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/drivers/net/acm.c b/src/drivers/net/acm.c
index 16dab4be8..0cb2713b2 100644
--- a/src/drivers/net/acm.c
+++ b/src/drivers/net/acm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/acm.h b/src/drivers/net/acm.h
index d4944967b..3f10f0fa2 100644
--- a/src/drivers/net/acm.h
+++ b/src/drivers/net/acm.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 #include <ipxe/cdc.h>
diff --git a/src/drivers/net/axge.c b/src/drivers/net/axge.c
index fb274d24f..922c94d91 100644
--- a/src/drivers/net/axge.c
+++ b/src/drivers/net/axge.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/axge.h b/src/drivers/net/axge.h
index e22e0ec47..c30ca5950 100644
--- a/src/drivers/net/axge.h
+++ b/src/drivers/net/axge.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 #include <ipxe/usbnet.h>
diff --git a/src/drivers/net/dm96xx.c b/src/drivers/net/dm96xx.c
index 61b957be9..193980a40 100644
--- a/src/drivers/net/dm96xx.c
+++ b/src/drivers/net/dm96xx.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/dm96xx.h b/src/drivers/net/dm96xx.h
index 43a1a4e30..33e404e17 100644
--- a/src/drivers/net/dm96xx.h
+++ b/src/drivers/net/dm96xx.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 #include <ipxe/usbnet.h>
diff --git a/src/drivers/net/ecm.c b/src/drivers/net/ecm.c
index 7b3e92b9b..9a13b68a5 100644
--- a/src/drivers/net/ecm.c
+++ b/src/drivers/net/ecm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <errno.h>
diff --git a/src/drivers/net/ecm.h b/src/drivers/net/ecm.h
index a7d03cf94..d77b0c64f 100644
--- a/src/drivers/net/ecm.h
+++ b/src/drivers/net/ecm.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 #include <ipxe/usbnet.h>
diff --git a/src/drivers/net/ice.c b/src/drivers/net/ice.c
index b5d66f1bb..1abc8ecd0 100644
--- a/src/drivers/net/ice.c
+++ b/src/drivers/net/ice.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/ice.h b/src/drivers/net/ice.h
index 26291a7a1..c4b7b95be 100644
--- a/src/drivers/net/ice.h
+++ b/src/drivers/net/ice.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/if_ether.h>
 #include "intelxl.h"
diff --git a/src/drivers/net/intel.c b/src/drivers/net/intel.c
index 845ba3e7f..57c0151a4 100644
--- a/src/drivers/net/intel.c
+++ b/src/drivers/net/intel.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/intel.h b/src/drivers/net/intel.h
index 29cf3a7d8..bfd250f00 100644
--- a/src/drivers/net/intel.h
+++ b/src/drivers/net/intel.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/if_ether.h>
diff --git a/src/drivers/net/intelvf.c b/src/drivers/net/intelvf.c
index 0d48b4178..e99b67626 100644
--- a/src/drivers/net/intelvf.c
+++ b/src/drivers/net/intelvf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/intelvf.h b/src/drivers/net/intelvf.h
index ffb18e040..378f9b075 100644
--- a/src/drivers/net/intelvf.h
+++ b/src/drivers/net/intelvf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include "intel.h"
 
diff --git a/src/drivers/net/intelx.c b/src/drivers/net/intelx.c
index 343d01374..ceb687e4f 100644
--- a/src/drivers/net/intelx.c
+++ b/src/drivers/net/intelx.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/intelx.h b/src/drivers/net/intelx.h
index d7f3b78e8..d68f50082 100644
--- a/src/drivers/net/intelx.h
+++ b/src/drivers/net/intelx.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/if_ether.h>
diff --git a/src/drivers/net/intelxl.c b/src/drivers/net/intelxl.c
index 76b9ff48f..f8d325ead 100644
--- a/src/drivers/net/intelxl.c
+++ b/src/drivers/net/intelxl.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/intelxl.h b/src/drivers/net/intelxl.h
index d23acf96e..4481300d3 100644
--- a/src/drivers/net/intelxl.h
+++ b/src/drivers/net/intelxl.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/if_ether.h>
diff --git a/src/drivers/net/intelxlvf.c b/src/drivers/net/intelxlvf.c
index 083195513..ab4df4c47 100644
--- a/src/drivers/net/intelxlvf.c
+++ b/src/drivers/net/intelxlvf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/intelxlvf.h b/src/drivers/net/intelxlvf.h
index 95ddf9474..63ed0b202 100644
--- a/src/drivers/net/intelxlvf.h
+++ b/src/drivers/net/intelxlvf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include "intelxl.h"
 
diff --git a/src/drivers/net/intelxvf.c b/src/drivers/net/intelxvf.c
index d50bac698..70ed8efe3 100644
--- a/src/drivers/net/intelxvf.c
+++ b/src/drivers/net/intelxvf.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/intelxvf.h b/src/drivers/net/intelxvf.h
index 4663272aa..1dac98699 100644
--- a/src/drivers/net/intelxvf.h
+++ b/src/drivers/net/intelxvf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include "intelvf.h"
 
diff --git a/src/drivers/net/iphone.c b/src/drivers/net/iphone.c
index 11f763553..b58017560 100644
--- a/src/drivers/net/iphone.c
+++ b/src/drivers/net/iphone.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/iphone.h b/src/drivers/net/iphone.h
index 2db6da7bd..3448af37f 100644
--- a/src/drivers/net/iphone.h
+++ b/src/drivers/net/iphone.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/usb.h>
diff --git a/src/drivers/net/lan78xx.c b/src/drivers/net/lan78xx.c
index 3f4f21b60..32333e787 100644
--- a/src/drivers/net/lan78xx.c
+++ b/src/drivers/net/lan78xx.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/lan78xx.h b/src/drivers/net/lan78xx.h
index 39422aec0..ea6d7ce52 100644
--- a/src/drivers/net/lan78xx.h
+++ b/src/drivers/net/lan78xx.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include "smscusb.h"
 #include "smsc75xx.h"
diff --git a/src/drivers/net/mii.c b/src/drivers/net/mii.c
index 87605f0cb..85749b941 100644
--- a/src/drivers/net/mii.c
+++ b/src/drivers/net/mii.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/ncm.c b/src/drivers/net/ncm.c
index 2c0f91e21..48f9856b0 100644
--- a/src/drivers/net/ncm.c
+++ b/src/drivers/net/ncm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/drivers/net/ncm.h b/src/drivers/net/ncm.h
index 6b0d21cdb..53e96cf72 100644
--- a/src/drivers/net/ncm.h
+++ b/src/drivers/net/ncm.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/usb.h>
diff --git a/src/drivers/net/netfront.c b/src/drivers/net/netfront.c
index 12713c5b4..ba6a20002 100644
--- a/src/drivers/net/netfront.c
+++ b/src/drivers/net/netfront.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/drivers/net/netfront.h b/src/drivers/net/netfront.h
index de16d5291..0520a0b2a 100644
--- a/src/drivers/net/netfront.h
+++ b/src/drivers/net/netfront.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/xen.h>
 #include <xen/io/netif.h>
diff --git a/src/drivers/net/smsc75xx.c b/src/drivers/net/smsc75xx.c
index 861669edf..8ae65e42a 100644
--- a/src/drivers/net/smsc75xx.c
+++ b/src/drivers/net/smsc75xx.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/smsc75xx.h b/src/drivers/net/smsc75xx.h
index 72339df03..51330993d 100644
--- a/src/drivers/net/smsc75xx.h
+++ b/src/drivers/net/smsc75xx.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include "smscusb.h"
 
diff --git a/src/drivers/net/smsc95xx.c b/src/drivers/net/smsc95xx.c
index 0210e9240..16086b33e 100644
--- a/src/drivers/net/smsc95xx.c
+++ b/src/drivers/net/smsc95xx.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <unistd.h>
diff --git a/src/drivers/net/smsc95xx.h b/src/drivers/net/smsc95xx.h
index 0cdf38248..0cb6ab4c7 100644
--- a/src/drivers/net/smsc95xx.h
+++ b/src/drivers/net/smsc95xx.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include "smscusb.h"
 
diff --git a/src/drivers/net/smscusb.c b/src/drivers/net/smscusb.c
index 93007e386..486b5953b 100644
--- a/src/drivers/net/smscusb.c
+++ b/src/drivers/net/smscusb.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/drivers/net/smscusb.h b/src/drivers/net/smscusb.h
index e866bb747..e4ad61915 100644
--- a/src/drivers/net/smscusb.h
+++ b/src/drivers/net/smscusb.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/vmxnet3.c b/src/drivers/net/vmxnet3.c
index 2cc6738f2..95e4f79c2 100644
--- a/src/drivers/net/vmxnet3.c
+++ b/src/drivers/net/vmxnet3.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/drivers/net/vmxnet3.h b/src/drivers/net/vmxnet3.h
index 5e1e0cb6e..b6c3bc50d 100644
--- a/src/drivers/net/vmxnet3.h
+++ b/src/drivers/net/vmxnet3.h
@@ -25,6 +25,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/drivers/usb/ehci.c b/src/drivers/usb/ehci.c
index 77022a47d..9f9d94175 100644
--- a/src/drivers/usb/ehci.c
+++ b/src/drivers/usb/ehci.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <unistd.h>
diff --git a/src/drivers/usb/ehci.h b/src/drivers/usb/ehci.h
index 42e282e92..a0166bc63 100644
--- a/src/drivers/usb/ehci.h
+++ b/src/drivers/usb/ehci.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/pci.h>
 #include <ipxe/usb.h>
diff --git a/src/drivers/usb/uhci.c b/src/drivers/usb/uhci.c
index 47474bdc7..2c70a11bd 100644
--- a/src/drivers/usb/uhci.c
+++ b/src/drivers/usb/uhci.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <strings.h>
 #include <unistd.h>
diff --git a/src/drivers/usb/uhci.h b/src/drivers/usb/uhci.h
index ba4c28f7e..629f6ae3b 100644
--- a/src/drivers/usb/uhci.h
+++ b/src/drivers/usb/uhci.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 #include <ipxe/pci.h>
diff --git a/src/drivers/usb/usbblk.c b/src/drivers/usb/usbblk.c
index cb377efb0..b42c70645 100644
--- a/src/drivers/usb/usbblk.c
+++ b/src/drivers/usb/usbblk.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/drivers/usb/usbblk.h b/src/drivers/usb/usbblk.h
index 65d0705e3..1fa0ebad8 100644
--- a/src/drivers/usb/usbblk.h
+++ b/src/drivers/usb/usbblk.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/usb.h>
diff --git a/src/drivers/usb/usbhub.c b/src/drivers/usb/usbhub.c
index 28d6cb33d..1d7b03e77 100644
--- a/src/drivers/usb/usbhub.c
+++ b/src/drivers/usb/usbhub.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/drivers/usb/usbhub.h b/src/drivers/usb/usbhub.h
index a5f123acc..9768b81a9 100644
--- a/src/drivers/usb/usbhub.h
+++ b/src/drivers/usb/usbhub.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 #include <ipxe/list.h>
diff --git a/src/drivers/usb/usbnet.c b/src/drivers/usb/usbnet.c
index 0fac00b56..e773ab882 100644
--- a/src/drivers/usb/usbnet.c
+++ b/src/drivers/usb/usbnet.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <errno.h>
diff --git a/src/drivers/usb/xhci.c b/src/drivers/usb/xhci.c
index 440c347c8..f812ed338 100644
--- a/src/drivers/usb/xhci.c
+++ b/src/drivers/usb/xhci.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/hci/commands/cert_cmd.c b/src/hci/commands/cert_cmd.c
index efa4c3c12..ebd9a25cd 100644
--- a/src/hci/commands/cert_cmd.c
+++ b/src/hci/commands/cert_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/hci/commands/console_cmd.c b/src/hci/commands/console_cmd.c
index 19d19ef1b..29347bbba 100644
--- a/src/hci/commands/console_cmd.c
+++ b/src/hci/commands/console_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/digest_cmd.c b/src/hci/commands/digest_cmd.c
index a7f43f69e..4d7da0385 100644
--- a/src/hci/commands/digest_cmd.c
+++ b/src/hci/commands/digest_cmd.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/hci/commands/image_trust_cmd.c b/src/hci/commands/image_trust_cmd.c
index 314aa0998..a8ec5784e 100644
--- a/src/hci/commands/image_trust_cmd.c
+++ b/src/hci/commands/image_trust_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/hci/commands/ipstat_cmd.c b/src/hci/commands/ipstat_cmd.c
index 488016e3a..fc454c57d 100644
--- a/src/hci/commands/ipstat_cmd.c
+++ b/src/hci/commands/ipstat_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <getopt.h>
diff --git a/src/hci/commands/neighbour_cmd.c b/src/hci/commands/neighbour_cmd.c
index 520d5aa06..870024ee0 100644
--- a/src/hci/commands/neighbour_cmd.c
+++ b/src/hci/commands/neighbour_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/nslookup_cmd.c b/src/hci/commands/nslookup_cmd.c
index dc9d61704..b13127dd4 100644
--- a/src/hci/commands/nslookup_cmd.c
+++ b/src/hci/commands/nslookup_cmd.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <getopt.h>
diff --git a/src/hci/commands/ntp_cmd.c b/src/hci/commands/ntp_cmd.c
index fed126f4c..d7604227a 100644
--- a/src/hci/commands/ntp_cmd.c
+++ b/src/hci/commands/ntp_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/hci/commands/param_cmd.c b/src/hci/commands/param_cmd.c
index 0924df597..ed57c5eaa 100644
--- a/src/hci/commands/param_cmd.c
+++ b/src/hci/commands/param_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/ping_cmd.c b/src/hci/commands/ping_cmd.c
index 4e86ae1c0..e132fb457 100644
--- a/src/hci/commands/ping_cmd.c
+++ b/src/hci/commands/ping_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/hci/commands/poweroff_cmd.c b/src/hci/commands/poweroff_cmd.c
index 2c6f1369a..63aeb3d5b 100644
--- a/src/hci/commands/poweroff_cmd.c
+++ b/src/hci/commands/poweroff_cmd.c
@@ -29,6 +29,7 @@
 #include <ipxe/reboot.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/profstat_cmd.c b/src/hci/commands/profstat_cmd.c
index da01068b2..3303ebcf3 100644
--- a/src/hci/commands/profstat_cmd.c
+++ b/src/hci/commands/profstat_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <getopt.h>
diff --git a/src/hci/commands/vlan_cmd.c b/src/hci/commands/vlan_cmd.c
index 636e5927f..69aef9f3c 100644
--- a/src/hci/commands/vlan_cmd.c
+++ b/src/hci/commands/vlan_cmd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/src/image/der.c b/src/image/der.c
index 67117d43b..ace106b84 100644
--- a/src/image/der.c
+++ b/src/image/der.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/image/efi_siglist.c b/src/image/efi_siglist.c
index b264ac558..71d597006 100644
--- a/src/image/efi_siglist.c
+++ b/src/image/efi_siglist.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/image/pem.c b/src/image/pem.c
index caff822ad..0fea5fbea 100644
--- a/src/image/pem.c
+++ b/src/image/pem.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <errno.h>
diff --git a/src/image/png.c b/src/image/png.c
index b7864f770..ab279eae5 100644
--- a/src/image/png.c
+++ b/src/image/png.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/include/hci/digest_cmd.h b/src/include/hci/digest_cmd.h
index 0986f775e..9cb4fde1a 100644
--- a/src/include/hci/digest_cmd.h
+++ b/src/include/hci/digest_cmd.h
@@ -25,6 +25,7 @@
 #define _DIGEST_CMD_H
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 #include <ipxe/command.h>
diff --git a/src/include/ipxe/acpimac.h b/src/include/ipxe/acpimac.h
index de673eb28..074165a92 100644
--- a/src/include/ipxe/acpimac.h
+++ b/src/include/ipxe/acpimac.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int acpi_mac ( uint8_t *hw_addr );
 
diff --git a/src/include/ipxe/aes.h b/src/include/ipxe/aes.h
index 8731de6ba..1c0024ccb 100644
--- a/src/include/ipxe/aes.h
+++ b/src/include/ipxe/aes.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 
diff --git a/src/include/ipxe/bigint.h b/src/include/ipxe/bigint.h
index 9eab89d25..9c31f4540 100644
--- a/src/include/ipxe/bigint.h
+++ b/src/include/ipxe/bigint.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 
diff --git a/src/include/ipxe/bitops.h b/src/include/ipxe/bitops.h
index 7366cd9f1..59a4fb442 100644
--- a/src/include/ipxe/bitops.h
+++ b/src/include/ipxe/bitops.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <bits/bitops.h>
 
diff --git a/src/include/ipxe/cbc.h b/src/include/ipxe/cbc.h
index f02e51937..154fc5666 100644
--- a/src/include/ipxe/cbc.h
+++ b/src/include/ipxe/cbc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 
diff --git a/src/include/ipxe/cdc.h b/src/include/ipxe/cdc.h
index b8b4a59d9..a61fe61ea 100644
--- a/src/include/ipxe/cdc.h
+++ b/src/include/ipxe/cdc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 
diff --git a/src/include/ipxe/certstore.h b/src/include/ipxe/certstore.h
index e276d6792..293f6dec7 100644
--- a/src/include/ipxe/certstore.h
+++ b/src/include/ipxe/certstore.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/x509.h>
 
diff --git a/src/include/ipxe/cms.h b/src/include/ipxe/cms.h
index 084cd81f8..d2e426c5c 100644
--- a/src/include/ipxe/cms.h
+++ b/src/include/ipxe/cms.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <time.h>
 #include <ipxe/asn1.h>
diff --git a/src/include/ipxe/deflate.h b/src/include/ipxe/deflate.h
index 67292d77e..7e5ae01b9 100644
--- a/src/include/ipxe/deflate.h
+++ b/src/include/ipxe/deflate.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/include/ipxe/der.h b/src/include/ipxe/der.h
index 512bc0853..17e96405e 100644
--- a/src/include/ipxe/der.h
+++ b/src/include/ipxe/der.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/asn1.h>
diff --git a/src/include/ipxe/dhe.h b/src/include/ipxe/dhe.h
index 3cd24a880..f89e7bd02 100644
--- a/src/include/ipxe/dhe.h
+++ b/src/include/ipxe/dhe.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/drbg.h b/src/include/ipxe/drbg.h
index ed2b3757a..0512f0833 100644
--- a/src/include/ipxe/drbg.h
+++ b/src/include/ipxe/drbg.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/sha256.h>
diff --git a/src/include/ipxe/ecb.h b/src/include/ipxe/ecb.h
index db22d996d..c29602fca 100644
--- a/src/include/ipxe/ecb.h
+++ b/src/include/ipxe/ecb.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 
diff --git a/src/include/ipxe/ecdhe.h b/src/include/ipxe/ecdhe.h
index 36fc0a1ee..c6575678c 100644
--- a/src/include/ipxe/ecdhe.h
+++ b/src/include/ipxe/ecdhe.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 
diff --git a/src/include/ipxe/ecdsa.h b/src/include/ipxe/ecdsa.h
index f55af3973..fdf8c6159 100644
--- a/src/include/ipxe/ecdsa.h
+++ b/src/include/ipxe/ecdsa.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 
diff --git a/src/include/ipxe/efi/efi_siglist.h b/src/include/ipxe/efi/efi_siglist.h
index cbc835dc0..f2a2fcfd0 100644
--- a/src/include/ipxe/efi/efi_siglist.h
+++ b/src/include/ipxe/efi/efi_siglist.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/asn1.h>
diff --git a/src/include/ipxe/efi/efi_usb.h b/src/include/ipxe/efi/efi_usb.h
index 06baff529..cbcef0e52 100644
--- a/src/include/ipxe/efi/efi_usb.h
+++ b/src/include/ipxe/efi/efi_usb.h
@@ -7,6 +7,9 @@
  *
  */
 
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
+
 #include <ipxe/list.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/efi_driver.h>
diff --git a/src/include/ipxe/entropy.h b/src/include/ipxe/entropy.h
index 82bb11826..8ec8f1047 100644
--- a/src/include/ipxe/entropy.h
+++ b/src/include/ipxe/entropy.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/include/ipxe/fbcon.h b/src/include/ipxe/fbcon.h
index 5233b4d0e..75cda3390 100644
--- a/src/include/ipxe/fbcon.h
+++ b/src/include/ipxe/fbcon.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/ansiesc.h>
diff --git a/src/include/ipxe/fdt.h b/src/include/ipxe/fdt.h
index e951aea59..6aa078ff6 100644
--- a/src/include/ipxe/fdt.h
+++ b/src/include/ipxe/fdt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/image.h>
diff --git a/src/include/ipxe/gcm.h b/src/include/ipxe/gcm.h
index 2c785a977..5635a1031 100644
--- a/src/include/ipxe/gcm.h
+++ b/src/include/ipxe/gcm.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/hash_df.h b/src/include/ipxe/hash_df.h
index e57682446..61c3420ce 100644
--- a/src/include/ipxe/hash_df.h
+++ b/src/include/ipxe/hash_df.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/hmac.h b/src/include/ipxe/hmac.h
index cf9d08677..12312c540 100644
--- a/src/include/ipxe/hmac.h
+++ b/src/include/ipxe/hmac.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/crypto.h>
 
diff --git a/src/include/ipxe/hmac_drbg.h b/src/include/ipxe/hmac_drbg.h
index a0f22da75..e9113807c 100644
--- a/src/include/ipxe/hmac_drbg.h
+++ b/src/include/ipxe/hmac_drbg.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/isqrt.h b/src/include/ipxe/isqrt.h
index 68255d1bc..4308cebd2 100644
--- a/src/include/ipxe/isqrt.h
+++ b/src/include/ipxe/isqrt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern unsigned long isqrt ( unsigned long value );
 
diff --git a/src/include/ipxe/lineconsole.h b/src/include/ipxe/lineconsole.h
index 31117e73c..b02822dcf 100644
--- a/src/include/ipxe/lineconsole.h
+++ b/src/include/ipxe/lineconsole.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/ansiesc.h>
diff --git a/src/include/ipxe/md4.h b/src/include/ipxe/md4.h
index 9f6cb8a5f..60512993b 100644
--- a/src/include/ipxe/md4.h
+++ b/src/include/ipxe/md4.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/mii.h b/src/include/ipxe/mii.h
index 89fc92a4a..061aeb24e 100644
--- a/src/include/ipxe/mii.h
+++ b/src/include/ipxe/mii.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <mii.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/netbios.h b/src/include/ipxe/netbios.h
index c11552556..80f791738 100644
--- a/src/include/ipxe/netbios.h
+++ b/src/include/ipxe/netbios.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern const char * netbios_domain ( char **username );
 
diff --git a/src/include/ipxe/ntp.h b/src/include/ipxe/ntp.h
index f5b3d2326..7f83c6d4f 100644
--- a/src/include/ipxe/ntp.h
+++ b/src/include/ipxe/ntp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/in.h>
diff --git a/src/include/ipxe/ocsp.h b/src/include/ipxe/ocsp.h
index a973f6f5e..9302506f8 100644
--- a/src/include/ipxe/ocsp.h
+++ b/src/include/ipxe/ocsp.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdarg.h>
 #include <time.h>
diff --git a/src/include/ipxe/p256.h b/src/include/ipxe/p256.h
index 0c4e81665..14d429cd9 100644
--- a/src/include/ipxe/p256.h
+++ b/src/include/ipxe/p256.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/weierstrass.h>
 
diff --git a/src/include/ipxe/p384.h b/src/include/ipxe/p384.h
index f4631b5f2..2fdd8d13c 100644
--- a/src/include/ipxe/p384.h
+++ b/src/include/ipxe/p384.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/weierstrass.h>
 
diff --git a/src/include/ipxe/pccrc.h b/src/include/ipxe/pccrc.h
index bec2b271a..6d0e3f194 100644
--- a/src/include/ipxe/pccrc.h
+++ b/src/include/ipxe/pccrc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <byteswap.h>
diff --git a/src/include/ipxe/pccrd.h b/src/include/ipxe/pccrd.h
index 3daa92f29..453ef666d 100644
--- a/src/include/ipxe/pccrd.h
+++ b/src/include/ipxe/pccrd.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** PeerDist discovery port */
 #define PEERDIST_DISCOVERY_PORT 3702
diff --git a/src/include/ipxe/pccrr.h b/src/include/ipxe/pccrr.h
index 4de94fda3..92522d0b7 100644
--- a/src/include/ipxe/pccrr.h
+++ b/src/include/ipxe/pccrr.h
@@ -10,6 +10,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/pcibackup.h b/src/include/ipxe/pcibackup.h
index e5249df99..a25421d7d 100644
--- a/src/include/ipxe/pcibackup.h
+++ b/src/include/ipxe/pcibackup.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/pcimsix.h b/src/include/ipxe/pcimsix.h
index b40c6c357..a7a6899a9 100644
--- a/src/include/ipxe/pcimsix.h
+++ b/src/include/ipxe/pcimsix.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/pci.h>
 
diff --git a/src/include/ipxe/peerblk.h b/src/include/ipxe/peerblk.h
index f16f207b0..596c78b57 100644
--- a/src/include/ipxe/peerblk.h
+++ b/src/include/ipxe/peerblk.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/peerdisc.h b/src/include/ipxe/peerdisc.h
index 45d592e76..9a8f13ecf 100644
--- a/src/include/ipxe/peerdisc.h
+++ b/src/include/ipxe/peerdisc.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/peermux.h b/src/include/ipxe/peermux.h
index 54acbfec9..849488d0a 100644
--- a/src/include/ipxe/peermux.h
+++ b/src/include/ipxe/peermux.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/list.h>
diff --git a/src/include/ipxe/pem.h b/src/include/ipxe/pem.h
index d9ca017d5..95c55408b 100644
--- a/src/include/ipxe/pem.h
+++ b/src/include/ipxe/pem.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/asn1.h>
diff --git a/src/include/ipxe/pinger.h b/src/include/ipxe/pinger.h
index 227f002dc..ade12ec12 100644
--- a/src/include/ipxe/pinger.h
+++ b/src/include/ipxe/pinger.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/interface.h>
diff --git a/src/include/ipxe/pixbuf.h b/src/include/ipxe/pixbuf.h
index 47ea0065e..e2cbcdca7 100644
--- a/src/include/ipxe/pixbuf.h
+++ b/src/include/ipxe/pixbuf.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/png.h b/src/include/ipxe/png.h
index 3505eefc8..31cac0534 100644
--- a/src/include/ipxe/png.h
+++ b/src/include/ipxe/png.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <byteswap.h>
diff --git a/src/include/ipxe/privkey.h b/src/include/ipxe/privkey.h
index a65cf6106..56f23143e 100644
--- a/src/include/ipxe/privkey.h
+++ b/src/include/ipxe/privkey.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/asn1.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/random_nz.h b/src/include/ipxe/random_nz.h
index 4c433fa38..2de1a1a33 100644
--- a/src/include/ipxe/random_nz.h
+++ b/src/include/ipxe/random_nz.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/ipxe/rbg.h b/src/include/ipxe/rbg.h
index 4bf3055d1..0b65a408c 100644
--- a/src/include/ipxe/rbg.h
+++ b/src/include/ipxe/rbg.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/drbg.h>
diff --git a/src/include/ipxe/rndis.h b/src/include/ipxe/rndis.h
index e8ece1e85..bd64eddfe 100644
--- a/src/include/ipxe/rndis.h
+++ b/src/include/ipxe/rndis.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/netdevice.h>
diff --git a/src/include/ipxe/rootcert.h b/src/include/ipxe/rootcert.h
index d1a69723d..f07c612ff 100644
--- a/src/include/ipxe/rootcert.h
+++ b/src/include/ipxe/rootcert.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/x509.h>
 
diff --git a/src/include/ipxe/rsa.h b/src/include/ipxe/rsa.h
index e36a75edf..c5ae919ae 100644
--- a/src/include/ipxe/rsa.h
+++ b/src/include/ipxe/rsa.h
@@ -7,6 +7,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdarg.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/sha1.h b/src/include/ipxe/sha1.h
index 9cbbebdee..33b07ecc3 100644
--- a/src/include/ipxe/sha1.h
+++ b/src/include/ipxe/sha1.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/sha256.h b/src/include/ipxe/sha256.h
index f226ad07b..e8a81b889 100644
--- a/src/include/ipxe/sha256.h
+++ b/src/include/ipxe/sha256.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/sha512.h b/src/include/ipxe/sha512.h
index 82a9e4e69..74cdb413c 100644
--- a/src/include/ipxe/sha512.h
+++ b/src/include/ipxe/sha512.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/syslog.h b/src/include/ipxe/syslog.h
index 138440d66..67f45fdb4 100644
--- a/src/include/ipxe/syslog.h
+++ b/src/include/ipxe/syslog.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <syslog.h>
 
diff --git a/src/include/ipxe/tls.h b/src/include/ipxe/tls.h
index 1a1d9c982..b4a92a044 100644
--- a/src/include/ipxe/tls.h
+++ b/src/include/ipxe/tls.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/refcnt.h>
diff --git a/src/include/ipxe/usbnet.h b/src/include/ipxe/usbnet.h
index a7276eba5..937a26d9a 100644
--- a/src/include/ipxe/usbnet.h
+++ b/src/include/ipxe/usbnet.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/usb.h>
 
diff --git a/src/include/ipxe/validator.h b/src/include/ipxe/validator.h
index 367e4045d..4d95766fa 100644
--- a/src/include/ipxe/validator.h
+++ b/src/include/ipxe/validator.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/interface.h>
 #include <ipxe/x509.h>
diff --git a/src/include/ipxe/weierstrass.h b/src/include/ipxe/weierstrass.h
index 15dd9ce03..ced99b4fc 100644
--- a/src/include/ipxe/weierstrass.h
+++ b/src/include/ipxe/weierstrass.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/bigint.h>
 #include <ipxe/crypto.h>
diff --git a/src/include/ipxe/x25519.h b/src/include/ipxe/x25519.h
index d570282c5..ef294f7b2 100644
--- a/src/include/ipxe/x25519.h
+++ b/src/include/ipxe/x25519.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <ipxe/bigint.h>
diff --git a/src/include/ipxe/x509.h b/src/include/ipxe/x509.h
index 4903eb656..360e2b19a 100644
--- a/src/include/ipxe/x509.h
+++ b/src/include/ipxe/x509.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/src/include/ipxe/xen.h b/src/include/ipxe/xen.h
index 382901ff3..9ddfcdf81 100644
--- a/src/include/ipxe/xen.h
+++ b/src/include/ipxe/xen.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /* Define Xen interface version before including any Xen header files */
 #define __XEN_INTERFACE_VERSION__ 0x00040400
diff --git a/src/include/ipxe/xenbus.h b/src/include/ipxe/xenbus.h
index ec5782eed..d73f29781 100644
--- a/src/include/ipxe/xenbus.h
+++ b/src/include/ipxe/xenbus.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/device.h>
 #include <ipxe/tables.h>
diff --git a/src/include/ipxe/xenevent.h b/src/include/ipxe/xenevent.h
index f0bd3465e..8be9e2b2f 100644
--- a/src/include/ipxe/xenevent.h
+++ b/src/include/ipxe/xenevent.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/xen.h>
 #include <xen/event_channel.h>
diff --git a/src/include/ipxe/xengrant.h b/src/include/ipxe/xengrant.h
index fcb7a7157..8af27f3e3 100644
--- a/src/include/ipxe/xengrant.h
+++ b/src/include/ipxe/xengrant.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdlib.h>
diff --git a/src/include/ipxe/xenstore.h b/src/include/ipxe/xenstore.h
index 892640755..c2079cec5 100644
--- a/src/include/ipxe/xenstore.h
+++ b/src/include/ipxe/xenstore.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/xen.h>
 
diff --git a/src/include/ipxe/xhci.h b/src/include/ipxe/xhci.h
index 586d5d320..2f5c256a0 100644
--- a/src/include/ipxe/xhci.h
+++ b/src/include/ipxe/xhci.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <assert.h>
 #include <ipxe/pci.h>
diff --git a/src/include/mii.h b/src/include/mii.h
index 515ba224d..9d6b2b3b7 100644
--- a/src/include/mii.h
+++ b/src/include/mii.h
@@ -12,6 +12,7 @@
  */
 
 FILE_LICENCE ( GPL2_ONLY );
+FILE_SECBOOT ( PERMITTED );
 
 /* Generic MII registers. */
 #define MII_BMCR	    0x00	/* Basic mode control register */
diff --git a/src/include/usr/certmgmt.h b/src/include/usr/certmgmt.h
index 4363b03e1..ff646236b 100644
--- a/src/include/usr/certmgmt.h
+++ b/src/include/usr/certmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/x509.h>
 
diff --git a/src/include/usr/imgtrust.h b/src/include/usr/imgtrust.h
index 414e07a80..1e43f5d3d 100644
--- a/src/include/usr/imgtrust.h
+++ b/src/include/usr/imgtrust.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <ipxe/image.h>
 
diff --git a/src/include/usr/ipstat.h b/src/include/usr/ipstat.h
index 803254bcb..2399446eb 100644
--- a/src/include/usr/ipstat.h
+++ b/src/include/usr/ipstat.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern void ipstat ( void );
 
diff --git a/src/include/usr/neighmgmt.h b/src/include/usr/neighmgmt.h
index 06f03716e..5ed5829c4 100644
--- a/src/include/usr/neighmgmt.h
+++ b/src/include/usr/neighmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern void nstat ( void );
 
diff --git a/src/include/usr/nslookup.h b/src/include/usr/nslookup.h
index d34649e9f..3b2bb504d 100644
--- a/src/include/usr/nslookup.h
+++ b/src/include/usr/nslookup.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 extern int nslookup ( const char *name, const char *setting_name );
 
diff --git a/src/include/usr/ntpmgmt.h b/src/include/usr/ntpmgmt.h
index 284e668e6..6d90ec749 100644
--- a/src/include/usr/ntpmgmt.h
+++ b/src/include/usr/ntpmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern int ntp ( const char *hostname );
 
diff --git a/src/include/usr/pingmgmt.h b/src/include/usr/pingmgmt.h
index c7a8434be..d15a748d8 100644
--- a/src/include/usr/pingmgmt.h
+++ b/src/include/usr/pingmgmt.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 
diff --git a/src/include/usr/profstat.h b/src/include/usr/profstat.h
index b7812ca7f..c5d545a86 100644
--- a/src/include/usr/profstat.h
+++ b/src/include/usr/profstat.h
@@ -8,6 +8,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 extern void profstat ( void );
 
diff --git a/src/include/xen/arch-x86/xen-x86_64.h b/src/include/xen/arch-x86/xen-x86_64.h
index 8287fd20f..618bf07d7 100644
--- a/src/include/xen/arch-x86/xen-x86_64.h
+++ b/src/include/xen/arch-x86/xen-x86_64.h
@@ -11,6 +11,7 @@
 #define __XEN_PUBLIC_ARCH_X86_XEN_X86_64_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * Hypercall interface:
diff --git a/src/include/xen/arch-x86/xen.h b/src/include/xen/arch-x86/xen.h
index 2b7afb2f4..7df850650 100644
--- a/src/include/xen/arch-x86/xen.h
+++ b/src/include/xen/arch-x86/xen.h
@@ -13,6 +13,7 @@
 #define __XEN_PUBLIC_ARCH_X86_XEN_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 /* Structural guest handles introduced in 0x00030201. */
 #if __XEN_INTERFACE_VERSION__ >= 0x00030201
diff --git a/src/include/xen/event_channel.h b/src/include/xen/event_channel.h
index 0c3752723..a3145d76f 100644
--- a/src/include/xen/event_channel.h
+++ b/src/include/xen/event_channel.h
@@ -11,6 +11,7 @@
 #define __XEN_PUBLIC_EVENT_CHANNEL_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 #include "xen.h"
 
diff --git a/src/include/xen/grant_table.h b/src/include/xen/grant_table.h
index f0ae17c41..141a17f56 100644
--- a/src/include/xen/grant_table.h
+++ b/src/include/xen/grant_table.h
@@ -12,6 +12,7 @@
 #define __XEN_PUBLIC_GRANT_TABLE_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 #include "xen.h"
 
diff --git a/src/include/xen/io/netif.h b/src/include/xen/io/netif.h
index bec61ab3e..59887a80f 100644
--- a/src/include/xen/io/netif.h
+++ b/src/include/xen/io/netif.h
@@ -11,6 +11,7 @@
 #define __XEN_PUBLIC_IO_NETIF_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 #include "ring.h"
 #include "../grant_table.h"
diff --git a/src/include/xen/io/ring.h b/src/include/xen/io/ring.h
index 41b50e2cf..3451bbb52 100644
--- a/src/include/xen/io/ring.h
+++ b/src/include/xen/io/ring.h
@@ -11,6 +11,7 @@
 #define __XEN_PUBLIC_IO_RING_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * When #include'ing this header, you need to provide the following
diff --git a/src/include/xen/io/xenbus.h b/src/include/xen/io/xenbus.h
index 473f538b8..3bf417c3a 100644
--- a/src/include/xen/io/xenbus.h
+++ b/src/include/xen/io/xenbus.h
@@ -11,6 +11,7 @@
 #define _XEN_PUBLIC_IO_XENBUS_H
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 /*
  * The state of either end of the Xenbus, i.e. the current communication
diff --git a/src/include/xen/io/xs_wire.h b/src/include/xen/io/xs_wire.h
index cffd75cde..99dc91781 100644
--- a/src/include/xen/io/xs_wire.h
+++ b/src/include/xen/io/xs_wire.h
@@ -10,6 +10,7 @@
 #define _XS_WIRE_H
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 enum xsd_sockmsg_type
 {
diff --git a/src/include/xen/xen-compat.h b/src/include/xen/xen-compat.h
index 8b2361807..8e4ed2434 100644
--- a/src/include/xen/xen-compat.h
+++ b/src/include/xen/xen-compat.h
@@ -11,6 +11,7 @@
 #define __XEN_PUBLIC_XEN_COMPAT_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 #define __XEN_LATEST_INTERFACE_VERSION__ 0x00040e00
 
diff --git a/src/include/xen/xen.h b/src/include/xen/xen.h
index c35008aa0..6d8192f8d 100644
--- a/src/include/xen/xen.h
+++ b/src/include/xen/xen.h
@@ -11,6 +11,7 @@
 #define __XEN_PUBLIC_XEN_H__
 
 FILE_LICENCE ( MIT );
+FILE_SECBOOT ( PERMITTED );
 
 #include "xen-compat.h"
 
diff --git a/src/interface/efi/efi_cacert.c b/src/interface/efi/efi_cacert.c
index 64bb0bae2..3e941ddc5 100644
--- a/src/interface/efi/efi_cacert.c
+++ b/src/interface/efi/efi_cacert.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/interface/efi/efi_entropy.c b/src/interface/efi/efi_entropy.c
index cda1c3640..b6bd12ccc 100644
--- a/src/interface/efi/efi_entropy.c
+++ b/src/interface/efi/efi_entropy.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/entropy.h>
diff --git a/src/interface/efi/efi_fbcon.c b/src/interface/efi/efi_fbcon.c
index 9c5d7063d..3896fd4d1 100644
--- a/src/interface/efi/efi_fbcon.c
+++ b/src/interface/efi/efi_fbcon.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/interface/efi/efi_fdt.c b/src/interface/efi/efi_fdt.c
index 3c249693e..cd8580fcb 100644
--- a/src/interface/efi/efi_fdt.c
+++ b/src/interface/efi/efi_fdt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <byteswap.h>
diff --git a/src/interface/efi/efi_rng.c b/src/interface/efi/efi_rng.c
index 058f0ee7d..66b37fe89 100644
--- a/src/interface/efi/efi_rng.c
+++ b/src/interface/efi/efi_rng.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <ipxe/entropy.h>
diff --git a/src/interface/efi/efi_usb.c b/src/interface/efi/efi_usb.c
index b09272f58..a3b153c88 100644
--- a/src/interface/efi/efi_usb.c
+++ b/src/interface/efi/efi_usb.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/interface/xen/xenbus.c b/src/interface/xen/xenbus.c
index 8b5ee0a0d..95bfdf7da 100644
--- a/src/interface/xen/xenbus.c
+++ b/src/interface/xen/xenbus.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <string.h>
diff --git a/src/interface/xen/xengrant.c b/src/interface/xen/xengrant.c
index 269cd5836..b0a15010b 100644
--- a/src/interface/xen/xengrant.c
+++ b/src/interface/xen/xengrant.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <strings.h>
diff --git a/src/interface/xen/xenstore.c b/src/interface/xen/xenstore.c
index caeb4e934..a076cd046 100644
--- a/src/interface/xen/xenstore.c
+++ b/src/interface/xen/xenstore.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdarg.h>
diff --git a/src/net/pccrc.c b/src/net/pccrc.c
index 0db6e3cb5..4bf2f441e 100644
--- a/src/net/pccrc.c
+++ b/src/net/pccrc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <errno.h>
 #include <assert.h>
diff --git a/src/net/pccrd.c b/src/net/pccrd.c
index 04b5dd86c..a7182c8ee 100644
--- a/src/net/pccrd.c
+++ b/src/net/pccrd.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stddef.h>
 #include <stdlib.h>
diff --git a/src/net/peerblk.c b/src/net/peerblk.c
index 58b185102..6efd4ebf6 100644
--- a/src/net/peerblk.c
+++ b/src/net/peerblk.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/net/peerdisc.c b/src/net/peerdisc.c
index 86ff94a87..2ba733697 100644
--- a/src/net/peerdisc.c
+++ b/src/net/peerdisc.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/net/peerdist.c b/src/net/peerdist.c
index 3210ac0ec..8e0f5dc13 100644
--- a/src/net/peerdist.c
+++ b/src/net/peerdist.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <ipxe/http.h>
diff --git a/src/net/peermux.c b/src/net/peermux.c
index 5c814b03e..7160d1c43 100644
--- a/src/net/peermux.c
+++ b/src/net/peermux.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/net/ping.c b/src/net/ping.c
index f0729e159..5782813e1 100644
--- a/src/net/ping.c
+++ b/src/net/ping.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/net/rndis.c b/src/net/rndis.c
index a3b562bc2..f04bc775f 100644
--- a/src/net/rndis.c
+++ b/src/net/rndis.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/net/tcp/httpntlm.c b/src/net/tcp/httpntlm.c
index 25187bd19..a7e44d5f6 100644
--- a/src/net/tcp/httpntlm.c
+++ b/src/net/tcp/httpntlm.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/https.c b/src/net/tcp/https.c
index 85f1f124f..bccfafe15 100644
--- a/src/net/tcp/https.c
+++ b/src/net/tcp/https.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/tcp/syslogs.c b/src/net/tcp/syslogs.c
index 5676f3e3e..eff53ea94 100644
--- a/src/net/tcp/syslogs.c
+++ b/src/net/tcp/syslogs.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/net/tls.c b/src/net/tls.c
index 6140ca58a..4f8ea2692 100644
--- a/src/net/tls.c
+++ b/src/net/tls.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 /**
  * @file
diff --git a/src/net/udp/ntp.c b/src/net/udp/ntp.c
index 559233575..b3056184d 100644
--- a/src/net/udp/ntp.c
+++ b/src/net/udp/ntp.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <string.h>
diff --git a/src/net/udp/syslog.c b/src/net/udp/syslog.c
index 198c86ef7..07ab3ed0c 100644
--- a/src/net/udp/syslog.c
+++ b/src/net/udp/syslog.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/net/validator.c b/src/net/validator.c
index e1371d2e6..c1f353b2a 100644
--- a/src/net/validator.c
+++ b/src/net/validator.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <string.h>
 #include <stdio.h>
diff --git a/src/usr/certmgmt.c b/src/usr/certmgmt.c
index e6bf51fd8..9056a917c 100644
--- a/src/usr/certmgmt.c
+++ b/src/usr/certmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <errno.h>
diff --git a/src/usr/imgtrust.c b/src/usr/imgtrust.c
index e60854c9f..fa8282da0 100644
--- a/src/usr/imgtrust.c
+++ b/src/usr/imgtrust.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/usr/ipstat.c b/src/usr/ipstat.c
index b9c5e02a7..c0d9739fa 100644
--- a/src/usr/ipstat.c
+++ b/src/usr/ipstat.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <ipxe/tcp.h>
diff --git a/src/usr/neighmgmt.c b/src/usr/neighmgmt.c
index fcdcbbfbb..79f62e6d3 100644
--- a/src/usr/neighmgmt.c
+++ b/src/usr/neighmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <ipxe/neighbour.h>
diff --git a/src/usr/nslookup.c b/src/usr/nslookup.c
index eb2b08b42..e4386e2c0 100644
--- a/src/usr/nslookup.c
+++ b/src/usr/nslookup.c
@@ -18,6 +18,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/src/usr/ntpmgmt.c b/src/usr/ntpmgmt.c
index 765c6dc9e..8b61662a0 100644
--- a/src/usr/ntpmgmt.c
+++ b/src/usr/ntpmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/usr/pingmgmt.c b/src/usr/pingmgmt.c
index bb33c5d47..fee6b438b 100644
--- a/src/usr/pingmgmt.c
+++ b/src/usr/pingmgmt.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/src/usr/profstat.c b/src/usr/profstat.c
index d80fa26b2..7fafd7b5f 100644
--- a/src/usr/profstat.c
+++ b/src/usr/profstat.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <ipxe/profile.h>
-- 
cgit v1.2.3-55-g7522


From c7403e7e5dbf4978a35c28bb25296962bc0ebafb Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Wed, 14 Jan 2026 22:37:05 +0000
Subject: [build] Mark more reviewed files as permitted for UEFI Secure Boot

Mark dynamic keyboard map support and the "pciscan", "usbscan", and
"time" commands as permitted for UEFI Secure Boot, on the basis that
these features have previously been present in binaries signed by
Microsoft.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/dynkeymap.c        | 1 +
 src/hci/commands/pci_cmd.c  | 1 +
 src/hci/commands/time_cmd.c | 1 +
 src/hci/commands/usb_cmd.c  | 1 +
 4 files changed, 4 insertions(+)

(limited to 'src/core')

diff --git a/src/core/dynkeymap.c b/src/core/dynkeymap.c
index 2f7c49937..fa9d3cb0f 100644
--- a/src/core/dynkeymap.c
+++ b/src/core/dynkeymap.c
@@ -22,6 +22,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/pci_cmd.c b/src/hci/commands/pci_cmd.c
index 0b54902fb..2e9505752 100644
--- a/src/hci/commands/pci_cmd.c
+++ b/src/hci/commands/pci_cmd.c
@@ -30,6 +30,7 @@
 #include <ipxe/parseopt.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
diff --git a/src/hci/commands/time_cmd.c b/src/hci/commands/time_cmd.c
index aba080792..2199321c7 100644
--- a/src/hci/commands/time_cmd.c
+++ b/src/hci/commands/time_cmd.c
@@ -21,6 +21,7 @@
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
+FILE_SECBOOT ( PERMITTED );
 
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/src/hci/commands/usb_cmd.c b/src/hci/commands/usb_cmd.c
index 2e3a82371..17affc0d7 100644
--- a/src/hci/commands/usb_cmd.c
+++ b/src/hci/commands/usb_cmd.c
@@ -30,6 +30,7 @@
 #include <ipxe/parseopt.h>
 
 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+FILE_SECBOOT ( PERMITTED );
 
 /** @file
  *
-- 
cgit v1.2.3-55-g7522