renaming and cleanup

Author: clemdiep

so3/arch/arm64/domain.c

@@ -136,8 +136,9 @@ void __setup_dom_pgtable(struct domain *d, addr_t paddr_start, unsigned long map
 		d->grant_pfn[i].free = true;
 	}
 
+	/* Set IPA framebuffer starting address after the grant pfn area */
 	d->fbdev_start_pfn = phys_to_pfn(memslot[slotID].ipa_addr + map_size + 2 * PAGE_SIZE) + NR_GRANT_PFN;
-	fbdev_set_pgtable(d, slotID);
+	fbdev_ipamap_domain(d, slotID);
 #endif /* CONFIG_SOO */
 }
 

so3/arch/arm64/include/asm/processor.h

@@ -1129,6 +1129,7 @@ typedef struct __attribute__((packed, aligned(8))) cpu_regs {
 	u64 tls_usr;
 
 #ifdef CONFIG_AVZ
+	/* Used to keep track of EL1 exception registers in case they haven't been saved by the domain yet */
 	u64 elr_el1;
 	u64 spsr_el1;
 #endif

so3/avz/include/avz/domain.h

@@ -19,8 +19,6 @@
 #ifndef DOMAIN_H
 #define DOMAIN_H
 
-#include <generated/autoconf.h>
-
 #ifndef __ASSEMBLY__
 #ifdef CONFIG_SOO
 #include <soo/uapi/soo.h>
@@ -120,7 +118,7 @@ struct domain {
 	/* IPA reserved page frame numbers for mapping granted pages belonging to other domains */
 	grant_pfn_t grant_pfn[NR_GRANT_PFN];
 
-	/* IPA reserved information for long mapping granted pages belonging to other domains */
+	/* IPA reserved starting address for framebuffer mapping */
 	addr_t fbdev_start_pfn;
 #endif /* CONFIG_SOO */
 

so3/avz/include/avz/fbdev_gnt.h

@@ -1,11 +1,53 @@
+/*
+ * Copyright (C) 2026 Clément Dieperink <clement.dieperink@heig-vd.ch>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ */
+
 #ifndef FBDEV_GNT_H
 #define FBDEV_GNT_H
 
 #include <soo/uapi/soo.h>
 
-void fbdev_set_pgtable(struct domain *d, int slotID);
-void fbdev_set_info(fbdev_info_t *fbdev);
+/**
+ * IPA map for the framebuffer for the given domain, either on actual buffer
+ * or the fake one depending on currently shown slot.
+ *
+ * @param d pointer to the domain to map
+ * @param slotID Slot ID of the domain
+ */
+void fbdev_ipamap_domain(struct domain *d, int slotID);
+
+/**
+ * Set the actual framebuffer physical pages ranges for
+ * futur mapping.
+ *
+ * @param fbdev Framebuffer pfns informations.
+ */
+void fbdev_set_pfns(fbdev_pfns_t *fbdev);
+
+/**
+ * Change the currently shown slot ID by remapping corresponding ipa.
+ *
+ * @param new_slotID to be shown.
+ */
 void fbdev_change_focus(int new_slotID);
-addr_t fbdev_get_addr(void);
+
+/**
+ * Get the frambuffer starting ipa for the current domain.
+ */
+addr_t fbdev_get_domain_ipa(void);
 
 #endif /* FBDEV_GNT_H */

so3/avz/kernel/fbdev_gnt.c

@@ -5,14 +5,14 @@
 #include <avz/sched.h>
 
 typedef struct {
-	fbdev_info_t fbdev;
+	fbdev_pfns_t fbdev;
 	void *fake_fbdev;
 	int current_slotID;
 } fbdev_priv_t;
 
 static fbdev_priv_t priv = {};
 
-static void __map_fbdev(struct domain *d, const fbdev_info_t *pfn_info)
+static void __map_fbdev(struct domain *d, const fbdev_pfns_t *pfn_info)
 {
 	size_t i;
 	addr_t phys_addr;
@@ -21,7 +21,7 @@ static void __map_fbdev(struct domain *d, const fbdev_info_t *pfn_info)
 	void *pgtable;
 
 	pgtable = (void *)d->pagetable_vaddr;
-	ipa_addr = d->fbdev_start_pfn << PAGE_SHIFT;
+	ipa_addr = pfn_to_phys(d->fbdev_start_pfn);
 
 	/* Map all distincts ranges of the framebuffer to the capsule */
 	for (i = 0; i < pfn_info->pfn_count; i++) {
@@ -34,7 +34,7 @@ static void __map_fbdev(struct domain *d, const fbdev_info_t *pfn_info)
 	}
 }
 
-static void __map_fake_fbdev(struct domain *d, const fbdev_info_t *real_fb)
+static void __map_fake_fbdev(struct domain *d, const fbdev_pfns_t *real_fb)
 {
 	size_t i, j;
 	addr_t phys_addr;
@@ -62,7 +62,7 @@ static void __map_fake_fbdev(struct domain *d, const fbdev_info_t *real_fb)
 	}
 }
 
-void fbdev_set_pgtable(struct domain *d, int slotID)
+void fbdev_ipamap_domain(struct domain *d, int slotID)
 {
 	/* Only capsules have virtual framebuffer */
 	if ((slotID < MEMSLOT_BASE) && !memslot[slotID].busy)
@@ -74,7 +74,7 @@ void fbdev_set_pgtable(struct domain *d, int slotID)
 		__map_fake_fbdev(d, &priv.fbdev);
 }
 
-void fbdev_set_info(fbdev_info_t *fbdev)
+void fbdev_set_pfns(fbdev_pfns_t *fbdev)
 {
 	int slotID;
 
@@ -83,7 +83,7 @@ void fbdev_set_info(fbdev_info_t *fbdev)
 	/* Map framebuffer to all capsules. */
 	for (slotID = MEMSLOT_BASE; slotID < MEMSLOT_NR; slotID++)
 		if (memslot[slotID].busy)
-			fbdev_set_pgtable(domains[slotID], slotID);
+			fbdev_ipamap_domain(domains[slotID], slotID);
 }
 
 void fbdev_change_focus(int new_slotID)
@@ -99,7 +99,7 @@ void fbdev_change_focus(int new_slotID)
 	priv.current_slotID = new_slotID;
 }
 
-addr_t fbdev_get_addr(void)
+addr_t fbdev_get_domain_ipa(void)
 {
 	return pfn_to_phys(current_domain->fbdev_start_pfn);
 }

so3/avz/kernel/gnttab.c

@@ -81,7 +81,7 @@ gnttab_t *pick_granted_entry(grant_ref_t ref, domid_t origin_domid)
 
 /**
  * @brief Create a new grant table entry in the gnttab of a domain
- *
+ * 
  * @param d The domain containing the grant table
  * @param target_domid The domain concerned by this grant
  * @param pfn The real frame number of the page to be granted
@@ -186,7 +186,7 @@ addr_t map_vbstore_pfn(int target_domid, int pfn)
 
 /**
  * @brief Hypercall entry for grant table related operations.
- *
+ * 
  * @param args gnttab detail structure
  */
 void do_gnttab(gnttab_op_t *args)

so3/avz/kernel/hypercalls.c

@@ -202,16 +202,16 @@ void do_avz_hypercall(void *__args)
 		break;
 	}
 
-	case AVZ_FBDEV_SET_INFO:
-		fbdev_set_info(&args->u.avz_fbdev_info_args.fbdev);
+	case AVZ_FBDEV_SET_PFNS:
+		fbdev_set_pfns(&args->u.avz_fbdev_pfns_args.fbdev);
 		break;
 
 	case AVZ_FBDEV_CHANGE_FOCUS:
 		fbdev_change_focus(args->u.avz_fbdev_focus_args.new_slotID);
 		break;
 
-	case AVZ_FBDEV_GET_ADDR:
-		args->u.avz_fbdev_addr_args.paddr = fbdev_get_addr();
+	case AVZ_FBDEV_GET_ME_ADDR:
+		args->u.avz_fbdev_addr_args.paddr = fbdev_get_domain_ipa();
 		break;
 
 #endif /* CONFIG_SOO */

so3/soo/drivers/vfbdevfront/vfbdev.c

@@ -243,7 +243,7 @@ static void retrieve_data(vfbdev_priv_t *priv)
 
 	vdevfront_processing_end(vfbdev_dev);
 
-	hyp_args.cmd = AVZ_FBDEV_GET_ADDR;
+	hyp_args.cmd = AVZ_FBDEV_GET_ME_ADDR;
 	avz_hypercall(&hyp_args);
 	priv->fb_paddr = hyp_args.u.avz_fbdev_addr_args.paddr;
 }

so3/soo/include/soo/uapi/soo.h

@@ -79,11 +79,11 @@ void do_gnttab(gnttab_op_t *args);
  */
 
 #define MAX_FBDEV_PFN 8
-typedef struct fbdev_info {
+typedef struct fbdev_pfns {
 	size_t pfn_count;
 	addr_t pfn[MAX_FBDEV_PFN];
 	size_t page_count[MAX_FBDEV_PFN];
-} fbdev_info_t;
+} fbdev_pfns_t;
 
 #define AVZ_SCHEDULER_FLIP 0
 
@@ -314,9 +314,9 @@ typedef struct agency_ioctl_args {
 #define AVZ_SET_ME_STATE 11
 #define AVZ_GET_DOM_DESC 12
 #define AVZ_GRANT_TABLE_OP 13
-#define AVZ_FBDEV_SET_INFO 14
+#define AVZ_FBDEV_SET_PFNS 14
 #define AVZ_FBDEV_CHANGE_FOCUS 15
-#define AVZ_FBDEV_GET_ADDR 16
+#define AVZ_FBDEV_GET_ME_ADDR 16
 
 /* AVZ_INJECT_CAPSULE */
 typedef struct {
@@ -379,17 +379,17 @@ typedef struct {
 	gnttab_op_t gnttab_op;
 } avz_gnttab_t;
 
-/* AVZ_FBDEV_SET_INFO */
+/* AVZ_FBDEV_SET_PFNS */
 typedef struct {
-	fbdev_info_t fbdev;
-} avz_fbdev_info_t;
+	fbdev_pfns_t fbdev;
+} avz_fbdev_pfns_t;
 
 /* AVZ_FBDEV_CHANGE_FOCUS */
 typedef struct {
 	int new_slotID;
 } avz_fbdev_focus_t;
 
-/* AVZ_FBDEV_GET_ADDR */
+/* AVZ_FBDEV_GET_ME_ADDR */
 typedef struct {
 	addr_t paddr;
 } avz_fbdev_addr_t;
@@ -413,7 +413,7 @@ typedef struct {
 		avz_console_io_t avz_console_io_args;
 		avz_domctl_t avz_domctl_args;
 		avz_gnttab_t avz_gnttab_args;
-		avz_fbdev_info_t avz_fbdev_info_args;
+		avz_fbdev_pfns_t avz_fbdev_pfns_args;
 		avz_fbdev_focus_t avz_fbdev_focus_args;
 		avz_fbdev_addr_t avz_fbdev_addr_args;
 	} u;