sd: Add RPMB emulation to eMMC model
v4 cover sd: Add RPMB emulation to eMMC model
Changes in v4 [1]:
- add truncation warning to mkemmc.sh
- fix typos in doc and mkemmc.sh
Changes in v3:
- rebased, dropping merged patches
- rework image alignment rules to match hardware
- improve/fix mkemmc script
- add emmc documentation
Changes in v2:
- handle write counter expiry
- assert() availability of QCRYPTO_HASH_ALGO_SHA256
- add missing SPDX-License-Identifier
This closes an old gap in system integration testing for the very complex ARM firmware stacks by adding fairly advanced Replay Protected Memory Block (RPMB) emulation to the eMMC device model. Key programming and message authentication are working, so is the write counter. Known users are happy with the result. What is missing, but not only for RPMB- related registers, is state persistence across QEMU restarts. This is OK at this stage for most test scenarios, though, and could still be added later on.
What can already be done with it is demonstrated in the WIP branch of isar-cip-core at [2]: TF-A + OP-TEE + StandaloneMM TA + fTPM TA, used by U-Boot and Linux for UEFI variable storage and TPM scenarios. If you want to try: build qemu-arm64 target for trixie with 6.12-cip *head* kernel, enable secure boot and disk encryption, then run
$ QEMU_PATH=/path/to/qemu-build/ ./start-qemu.sh
Deploy snakeoil keys into PK, KEK and db after first boot to enable secure booting:
root@demo:~# cert-to-efi-sig-list PkKek-1-snakeoil.pem PK.esl root@demo:~# sign-efi-sig-list -k PkKek-1-snakeoil.key -c PkKek-1-snakeoil.pem PK PK.esl PK.auth root@demo:~# efi-updatevar -f PK.auth db root@demo:~# efi-updatevar -f PK.auth KEK root@demo:~# efi-updatevar -f PK.auth PK
Note that emulation is a bit slow in general, and specifically the partition encryption on first boot is taking 20 min. - we should probably reduce its size or understand if there is still something to optimize.
Jan
[1] https://github.com/siemens/qemu/commits/queues/emmc/
[2] https://gitlab.com/cip-project/cip-core/isar-cip-core/-/commits/wip/qemu-rpmb
Jan Kiszka (6):
hw/sd/sdcard: Fix size check for backing block image hw/sd/sdcard: Allow user-instantiated eMMC hw/sd/sdcard: Add basic support for RPMB partition hw/sd/sdcard: Handle RPMB MAC field
scripts: Add helper script to generate eMMC block device images
docs: Add eMMC device model description
docs/system/device-emulation.rst | 1 + docs/system/devices/emmc.rst | 52 +++++ hw/sd/sd.c | 349 ++++++++++++++++++++++++++++--- hw/sd/sdmmc-internal.h | 21 ++ hw/sd/trace-events | 2 + scripts/mkemmc.sh | 218 +++++++++++++++++++ 6 files changed, 615 insertions(+), 28 deletions(-) create mode 100644 docs/system/devices/emmc.rst create mode 100755 scripts/mkemmc.sh
Signature · 1 line
2.51.0
PATCH v4 1/6 hw/sd/sdcard: Fix size check for backing block image
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the user data area. For larger images, multiples of 512 sectors must be used for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.
---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>
--- hw/sd/sd.c | 61 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 19 deletions(-)
hw/sd/sd.c +42 -19
@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj)timer_free (sd->ocr_power_timer); } +static void sd_blk_size_error (SDState *sd,int64_t blk_size, +int64_t blk_size_aligned,const char *rule, +Error **errp) +{ +const char *dev_type =sd_is_emmc (sd) ?"eMMC" :"SD card" ; +char *blk_size_str; + + blk_size_str =size_to_str (blk_size); +error_setg (errp,"Invalid %s size: %s" , dev_type, blk_size_str); +g_free (blk_size_str); + + blk_size_str =size_to_str (blk_size_aligned); +error_append_hint (errp, +"%s size has to be %s, e.g. %s.\n" +"You can resize disk images with" +" 'qemu-img resize <imagefile> <new-size>'\n" +"(note that this will lose data if you make the" +" image smaller than it currently is).\n" , + dev_type, rule, blk_size_str); +g_free (blk_size_str); +} +static void sd_realize (DeviceState *dev,Error **errp) {SDState *sd =SDMMC_COMMON (dev);
@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp)return ; } - blk_size =blk_getlength (sd->blk); -if (blk_size >0 && !is_power_of_2 (blk_size)) { -int64_t blk_size_aligned =pow2ceil (blk_size); -char *blk_size_str; - - blk_size_str =size_to_str (blk_size); -error_setg (errp,"Invalid SD card size: %s" , blk_size_str); -g_free (blk_size_str); - - blk_size_str =size_to_str (blk_size_aligned); -error_append_hint (errp, -"SD card size has to be a power of 2, e.g. %s.\n" -"You can resize disk images with" -" 'qemu-img resize <imagefile> <new-size>'\n" -"(note that this will lose data if you make the" -" image smaller than it currently is).\n" , - blk_size_str); -g_free (blk_size_str); - + blk_size =blk_getlength (sd->blk) - sd->boot_part_size *2 ; +if (blk_size >SDSC_MAX_CAPACITY ) { +if (sd_is_emmc (sd) && blk_size % (1 <<HWBLOCK_SHIFT ) !=0 ) { +int64_t blk_size_aligned = + ((blk_size >>HWBLOCK_SHIFT ) +1 ) <<HWBLOCK_SHIFT ; +sd_blk_size_error (sd, blk_size, blk_size_aligned, +"multiples of 512" , errp); +return ; + }else if (!sd_is_emmc (sd) && blk_size % (512 * KiB)) { +int64_t blk_size_aligned = ((blk_size >>19 ) +1 ) <<19 ; +sd_blk_size_error (sd, blk_size, blk_size_aligned, +"multiples of 512K" , errp); +return ; + } + }else if (blk_size >0 && !is_power_of_2 (blk_size)) { +sd_blk_size_error (sd, blk_size,pow2ceil (blk_size),"a power of 2" , + errp); +return ; + }else if (blk_size <0 ) { +error_setg (errp,"eMMC image smaller than boot partitions" );return ; }
Signature · 1 line
2.51.0
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 88 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the user data area. For larger images, multiples of 512 sectors must be used for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>--- hw/sd/sd.c | 61 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +32
-19@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj)timer_free (sd->ocr_power_timer); } +static void sd_blk_size_error (SDState *sd,int64_t blk_size, +int64_t blk_size_aligned,const char *rule, +Error **errp) +{ +const char *dev_type =sd_is_emmc (sd) ?"eMMC" :"SD card" ; +char *blk_size_str; + + blk_size_str =size_to_str (blk_size); +error_setg (errp,"Invalid %s size: %s" , dev_type, blk_size_str); +g_free (blk_size_str); + + blk_size_str =size_to_str (blk_size_aligned); +error_append_hint (errp, +"%s size has to be %s, e.g. %s.\n" +"You can resize disk images with" +" 'qemu-img resize <imagefile> <new-size>'\n" +"(note that this will lose data if you make the" +" image smaller than it currently is).\n" , + dev_type, rule, blk_size_str); +g_free (blk_size_str); +} +static void sd_realize (DeviceState *dev,Error **errp) {SDState *sd =SDMMC_COMMON (dev);@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp)return ; } - blk_size =blk_getlength (sd->blk); -if (blk_size >0 && !is_power_of_2 (blk_size)) { -int64_t blk_size_aligned =pow2ceil (blk_size); -char *blk_size_str; - - blk_size_str =size_to_str (blk_size); -error_setg (errp,"Invalid SD card size: %s" , blk_size_str); -g_free (blk_size_str); - - blk_size_str =size_to_str (blk_size_aligned); -error_append_hint (errp, -"SD card size has to be a power of 2, e.g. %s.\n" -"You can resize disk images with" -" 'qemu-img resize <imagefile> <new-size>'\n" -"(note that this will lose data if you make the" -" image smaller than it currently is).\n" , - blk_size_str); -g_free (blk_size_str); - + blk_size =blk_getlength (sd->blk) - sd->boot_part_size *2 ; +if (blk_size >SDSC_MAX_CAPACITY ) { +if (sd_is_emmc (sd) && blk_size % (1 <<HWBLOCK_SHIFT ) !=0 ) { +int64_t blk_size_aligned = + ((blk_size >>HWBLOCK_SHIFT ) +1 ) <<HWBLOCK_SHIFT ; +sd_blk_size_error (sd, blk_size, blk_size_aligned, +"multiples of 512" , errp); +return ; + }else if (!sd_is_emmc (sd) && blk_size % (512 * KiB)) { +int64_t blk_size_aligned = ((blk_size >>19 ) +1 ) <<19 ;
hw/sd/sd.c static void sd_realize(DeviceState *dev, Error **errp) · line 2825
Quoted 10 lines
hw/sd/sd.c +10
-0+sd_blk_size_error (sd, blk_size, blk_size_aligned, +"multiples of 512K" , errp); +return ; + } + }else if (blk_size >0 && !is_power_of_2 (blk_size)) { +sd_blk_size_error (sd, blk_size,pow2ceil (blk_size),"a power of 2" , + errp); +return ; + }else if (blk_size <0 ) { +error_setg (errp,"eMMC image smaller than boot partitions" );
Cedric, I just played with some ast* machines and noticed that they now trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?
Jan
Quoted 3 lines
hw/sd/sd.c +0
-0return ; }
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
+ Jamin
Quoted 97 lines · Jan Kiszka
Quoted 96 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the user data area. For larger images, multiples of 512 sectors must be used for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>--- hw/sd/sd.c | 61 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +40
-19@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj)timer_free (sd->ocr_power_timer); } +static void sd_blk_size_error (SDState *sd,int64_t blk_size, +int64_t blk_size_aligned,const char *rule, +Error **errp) +{ +const char *dev_type =sd_is_emmc (sd) ?"eMMC" :"SD card" ; +char *blk_size_str; + + blk_size_str =size_to_str (blk_size); +error_setg (errp,"Invalid %s size: %s" , dev_type, blk_size_str); +g_free (blk_size_str); + + blk_size_str =size_to_str (blk_size_aligned); +error_append_hint (errp, +"%s size has to be %s, e.g. %s.\n" +"You can resize disk images with" +" 'qemu-img resize <imagefile> <new-size>'\n" +"(note that this will lose data if you make the" +" image smaller than it currently is).\n" , + dev_type, rule, blk_size_str); +g_free (blk_size_str); +} +static void sd_realize (DeviceState *dev,Error **errp) {SDState *sd =SDMMC_COMMON (dev);@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp)return ; } - blk_size =blk_getlength (sd->blk); -if (blk_size >0 && !is_power_of_2 (blk_size)) { -int64_t blk_size_aligned =pow2ceil (blk_size); -char *blk_size_str; - - blk_size_str =size_to_str (blk_size); -error_setg (errp,"Invalid SD card size: %s" , blk_size_str); -g_free (blk_size_str); - - blk_size_str =size_to_str (blk_size_aligned); -error_append_hint (errp, -"SD card size has to be a power of 2, e.g. %s.\n" -"You can resize disk images with" -" 'qemu-img resize <imagefile> <new-size>'\n" -"(note that this will lose data if you make the" -" image smaller than it currently is).\n" , - blk_size_str); -g_free (blk_size_str); - + blk_size =blk_getlength (sd->blk) - sd->boot_part_size *2 ; +if (blk_size >SDSC_MAX_CAPACITY ) { +if (sd_is_emmc (sd) && blk_size % (1 <<HWBLOCK_SHIFT ) !=0 ) { +int64_t blk_size_aligned = + ((blk_size >>HWBLOCK_SHIFT ) +1 ) <<HWBLOCK_SHIFT ; +sd_blk_size_error (sd, blk_size, blk_size_aligned, +"multiples of 512" , errp); +return ; + }else if (!sd_is_emmc (sd) && blk_size % (512 * KiB)) { +int64_t blk_size_aligned = ((blk_size >>19 ) +1 ) <<19 ; +sd_blk_size_error (sd, blk_size, blk_size_aligned, +"multiples of 512K" , errp); +return ; + } + }else if (blk_size >0 && !is_power_of_2 (blk_size)) { +sd_blk_size_error (sd, blk_size,pow2ceil (blk_size),"a power of 2" , + errp); +return ;
Quoted 8 lines
hw/sd/sd.c static void sd_realize(DeviceState *dev, Error **errp) · line 2825
Quoted 2 lines
hw/sd/sd.c +2
-0+ }else if (blk_size <0 ) { +error_setg (errp,"eMMC image smaller than boot partitions" );Cedric, I just played with some ast* machines and noticed that they now trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?
Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset. The machine model loads the u-boot-spl.bin contents as a ROM.
The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \
-drive file=./v09.07/ast2600-default/image-bmc,format=raw,if=mtd -serial mon:stdio \
-drive file=mmc-ast2600-evb-noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2 ....
U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000)
SOC: AST2600-A3
eSPI Mode: SIO:Enable : SuperIO-2e
Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII
Model: AST2600 EVB
DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off)
RC Bridge phy@1e6ed200 : Link up
MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0
....
[ 4.209117] mmc0: new high speed MMC card at address 0001
[ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiB
[ 4.233637] GPT:Primary header thinks Alt. header is not at the end of the disk.
[ 4.233995] GPT:29624393 != 33554431
[ 4.234161] GPT:Alternate GPT header not at the end of the disk.
[ 4.234399] GPT:29624393 != 33554431
[ 4.234549] GPT: Use GNU Parted to correct GPT errors.
[ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7Thanks,
C.
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 149 lines · Cédric Le Goater
+ Jamin
Quoted 105 lines · Jan Kiszka
Quoted 104 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the user data area. For larger images, multiples of 512 sectors must be used for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>
---
hw/sd/sd.c| 61 +++++++++++++++++++++++++++++++++++++-----------------1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +21
-0@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj) timer_free(sd->ocr_power_timer); } +static void sd_blk_size_error(SDState *sd, int64_t blk_size, + int64_t blk_size_aligned, const char *rule, + Error **errp) +{ + const char *dev_type = sd_is_emmc(sd) ? "eMMC" : "SD card"; + char *blk_size_str; + + blk_size_str = size_to_str(blk_size); + error_setg(errp, "Invalid %s size: %s", dev_type, blk_size_str); + g_free(blk_size_str); + + blk_size_str = size_to_str(blk_size_aligned); + error_append_hint(errp, + "%s size has to be %s, e.g. %s.\n" + "You can resize disk images with" + " 'qemu-img resize <imagefile> <new-size>'\n" + "(note that this will lose data if you make the" + " image smaller than it currently is).\n", + dev_type, rule, blk_size_str); + g_free(blk_size_str); +} + static void sd_realize(DeviceState *dev, Error **errp) {SDState *sd =
SDMMC_COMMON(dev);hw/sd/sd.c +0
-11@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp) return; } - blk_size = blk_getlength(sd->blk); - if (blk_size > 0 && !is_power_of_2(blk_size)) { - int64_t blk_size_aligned = pow2ceil(blk_size); - char *blk_size_str; - - blk_size_str = size_to_str(blk_size); - error_setg(errp, "Invalid SD card size: %s", blk_size_str); - g_free(blk_size_str); - - blk_size_str = size_to_str(blk_size_aligned); - error_append_hint(errp, - "SD card size has to be a power of 2,e.g. %s.\n"
- "You can resize disk images with" - " 'qemu-img resize <imagefile> <new- size>'\n"
- "(note that this will lose data if you make the"
- " image smaller than it currently is). \n",
-blk_size_str);
-g_free(blk_size_str);
-
+blk_size=blk_getlength(sd->blk)-sd->boot_part_size* 2; + if (blk_size>SDSC_MAX_CAPACITY) {
+ if (sd_is_emmc(sd)&&blk_size% (1 <<HWBLOCK_SHIFT) !=
0) {
+int64_tblk_size_aligned=
+ ((blk_size>>HWBLOCK_SHIFT) + 1) <<HWBLOCK_SHIFT; + sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512", errp); + return;
+ } else if (!sd_is_emmc(sd) &&blk_size% (512 * KiB)) { +int64_tblk_size_aligned= ((blk_size>> 19) + 1) << 19;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512K", errp); + return;
+ }
+ } else if (blk_size> 0 && !is_power_of_2(blk_size)) { + sd_blk_size_error(sd,blk_size,pow2ceil(blk_size), "a power of 2",
+ errp);
+ return;
+ } else if (blk_size< 0) {Quoted 8 lines
Quoted 2 lines
+
error_setg(errp, "eMMC image smaller than boot partitions");Cedric, I just played with some ast* machines and noticed that they now trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?
Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset. The machine model loads the u-boot-spl.bin contents as a ROM.
The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \ -drive file=./v09.07/ast2600-default/image-bmc,format=raw,if=mtd - serial mon:stdio \ -drive file=mmc-ast2600-evb- noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2 .... U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000) SOC: AST2600-A3 eSPI Mode: SIO:Enable : SuperIO-2e Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII Model: AST2600 EVB DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off) RC Bridge phy@1e6ed200 : Link up MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0 .... [ 4.209117] mmc0: new high speed MMC card at address 0001 [ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiB
Quoted 8 lines
[ 4.233637] GPT:Primary header thinks Alt. header is not at the end of the disk. [ 4.233995] GPT:29624393 != 33554431 [ 4.234161] GPT:Alternate GPT header not at the end of the disk. [ 4.234399] GPT:29624393 != 33554431 [ 4.234549] GPT: Use GNU Parted to correct GPT errors. [ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7
$ ./qemu-system-arm -M ast2600-evb qemu-system-arm: eMMC image smaller than boot partitions $ ./qemu-system-arm -M ast2600-evb -drive file=disk.image,if=sd <works if disk.image is large enough>
Is that ok?
Jan
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 159 lines · Jan Kiszka
Quoted 148 lines · Cédric Le Goater
+ Jamin
Quoted 105 lines · Jan Kiszka
Quoted 104 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the user data area. For larger images, multiples of 512 sectors must be used for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>--- hw/sd/sd.c | 61 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +21
-11@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj) timer_free(sd->ocr_power_timer); } +static void sd_blk_size_error(SDState *sd, int64_t blk_size, + int64_t blk_size_aligned, const char *rule, + Error **errp) +{ + const char *dev_type = sd_is_emmc(sd) ? "eMMC" : "SD card"; + char *blk_size_str; + + blk_size_str = size_to_str(blk_size); + error_setg(errp, "Invalid %s size: %s", dev_type, blk_size_str); + g_free(blk_size_str); + + blk_size_str = size_to_str(blk_size_aligned); + error_append_hint(errp, + "%s size has to be %s, e.g. %s.\n" + "You can resize disk images with" + " 'qemu-img resize <imagefile> <new-size>'\n" + "(note that this will lose data if you make the" + " image smaller than it currently is).\n", + dev_type, rule, blk_size_str); + g_free(blk_size_str); +} + static void sd_realize(DeviceState *dev, Error **errp) { SDState *sd = SDMMC_COMMON(dev);@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp) return; } - blk_size = blk_getlength(sd->blk); - if (blk_size > 0 && !is_power_of_2(blk_size)) { - int64_t blk_size_aligned = pow2ceil(blk_size); - char *blk_size_str; - - blk_size_str = size_to_str(blk_size); - error_setg(errp, "Invalid SD card size: %s", blk_size_str); - g_free(blk_size_str); - - blk_size_str = size_to_str(blk_size_aligned); - error_append_hint(errp, - "SD card size has to be a power of 2,e.g. %s.\n"
- "You can resize disk images with" - " 'qemu-img resize <imagefile> <new- size>'\n"
- "(note that this will lose data if you make the"
- " image smaller than it currently is). \n",
-blk_size_str);
-g_free(blk_size_str);
-
+blk_size=blk_getlength(sd->blk)-sd->boot_part_size* 2; + if (blk_size>SDSC_MAX_CAPACITY) {
+ if (sd_is_emmc(sd)&&blk_size% (1 <<HWBLOCK_SHIFT) !=
0) {
+int64_tblk_size_aligned=
+ ((blk_size>>HWBLOCK_SHIFT) + 1) <<HWBLOCK_SHIFT; + sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512", errp); + return;
+ } else if (!sd_is_emmc(sd) &&blk_size% (512 * KiB)) { +int64_tblk_size_aligned= ((blk_size>> 19) + 1) << 19;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512K", errp); + return;
+ }
+ } else if (blk_size> 0 && !is_power_of_2(blk_size)) { + sd_blk_size_error(sd,blk_size,pow2ceil(blk_size), "a power of 2",
+ errp);
+ return;
+ } else if (blk_size< 0) {Quoted 8 lines
Quoted 2 lines
+
error_setg(errp, "eMMC image smaller than boot partitions");Cedric, I just played with some ast* machines and noticed that they now trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?
Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset. The machine model loads the u-boot-spl.bin contents as a ROM.
The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \ -drive file=./v09.07/ast2600-default/image-bmc,format=raw,if=mtd - serial mon:stdio \ -drive file=mmc-ast2600-evb- noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2 .... U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000) SOC: AST2600-A3 eSPI Mode: SIO:Enable : SuperIO-2e Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII Model: AST2600 EVB DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off) RC Bridge phy@1e6ed200 : Link up MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0 .... [ 4.209117] mmc0: new high speed MMC card at address 0001Quoted 9 lines
[ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiB [ 4.233637] GPT:Primary header thinks Alt. header is not at the end of the disk. [ 4.233995] GPT:29624393 != 33554431 [ 4.234161] GPT:Alternate GPT header not at the end of the disk. [ 4.234399] GPT:29624393 != 33554431 [ 4.234549] GPT: Use GNU Parted to correct GPT errors. [ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7
Quoted 6 lines
$ ./qemu-system-arm -M ast2600-evb qemu-system-arm: eMMC image smaller than boot partitions $ ./qemu-system-arm -M ast2600-evb -drive file=disk.image,if=sd <works if disk.image is large enough>Is that ok?
No. This is wrong.
An sd card device is auto created at init time and a 'DriveInfo *' is always available for index 0. 'mc->auto_create_sdcard' should be set to false IMO.
commit cdc8d7cadaac ("hw/boards: Rename no_sdcard -> auto_create_sdcard") seems to have changed the behavior of several machines. See 'make check'.
C.
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 178 lines · Cédric Le Goater
Quoted 168 lines · Jan Kiszka
Quoted 158 lines · Cédric Le Goater
+ Jamin
Quoted 112 lines · Jan Kiszka
Quoted 111 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the
user data area. For larger images, multiples of 512 sectors must be used
for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>
---
hw/sd/sd.c| 61 ++++++++++++++++++++++++++++++++++++
+-----------------1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +16
-0@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj) timer_free(sd->ocr_power_timer); } +static void sd_blk_size_error(SDState *sd, int64_t blk_size, + int64_t blk_size_aligned, const char *rule, + Error **errp) +{ + const char *dev_type = sd_is_emmc(sd) ? "eMMC" : "SD card"; + char *blk_size_str; + + blk_size_str = size_to_str(blk_size); + error_setg(errp, "Invalid %s size: %s", dev_type, blk_size_str); + g_free(blk_size_str); + + blk_size_str = size_to_str(blk_size_aligned); + error_append_hint(errp, + "%s size has to be %s, e.g. %s.\n" + "You can resize disk images with" + " 'qemu-img resize <imagefile> <new-size>'\n" + "(note that this will lose data if you makethe"
+ " image smaller than it currently is).\n", +dev_type, rule,blk_size_str);
+g_free(blk_size_str);hw/sd/sd.c +2
-0+} +static void
sd_realize(DeviceState *dev, Error **errp){
SDState *sd =SDMMC_COMMON(dev);hw/sd/sd.c +0
-11@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp) return; } - blk_size = blk_getlength(sd->blk); - if (blk_size > 0 && !is_power_of_2(blk_size)) { - int64_t blk_size_aligned = pow2ceil(blk_size); - char *blk_size_str; - - blk_size_str = size_to_str(blk_size); - error_setg(errp, "Invalid SD card size: %s", blk_size_str); - g_free(blk_size_str); - - blk_size_str = size_to_str(blk_size_aligned); - error_append_hint(errp, - "SD card size has to be a power of 2,e.g. %s.\n"
- "You can resize disk images with" - " 'qemu-img resize <imagefile> <new- size>'\n"
- "(note that this will lose data if you make the"
- " image smaller than it currently is). \n",
-blk_size_str);
-g_free(blk_size_str);
-
+blk_size=blk_getlength(sd->blk)-sd->boot_part_size* 2; + if (blk_size>SDSC_MAX_CAPACITY) {
+ if (sd_is_emmc(sd)&&blk_size% (1 <<HWBLOCK_SHIFT) !=
0) {
+int64_tblk_size_aligned=
+ ((blk_size>>HWBLOCK_SHIFT) + 1) <<HWBLOCK_SHIFT;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512", errp); + return;
+ } else if (!sd_is_emmc(sd) &&blk_size% (512 * KiB)) { +int64_tblk_size_aligned= ((blk_size>> 19) + 1) << 19;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512K", errp); + return;
+ }
+ } else if (blk_size> 0 && !is_power_of_2(blk_size)) { + sd_blk_size_error(sd,blk_size,pow2ceil(blk_size), "a power of 2",
+ errp);
+ return;
+ } else if (blk_size< 0) {
+ error_setg(errp, "eMMC image smaller than bootQuoted 8 lines
Quoted 1 line
partitions");
Cedric, I just played with some ast* machines and noticed that they now trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we
shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset. The machine model loads the u-boot-spl.bin contents as a ROM.
The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \ -drive file=./v09.07/ast2600-default/image- bmc,format=raw,if=mtd - serial mon:stdio \ -drive file=mmc-ast2600-evb- noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2 .... U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000) SOC: AST2600-A3 eSPI Mode: SIO:Enable : SuperIO-2e Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII Model: AST2600 EVB DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off) RC Bridge phy@1e6ed200 : Link up MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0 .... [ 4.209117] mmc0: new high speed MMC card at address 0001 [ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiBQuoted 8 lines
[ 4.233637] GPT:Primary header thinks Alt. header is not at the end of the disk. [ 4.233995] GPT:29624393 != 33554431 [ 4.234161] GPT:Alternate GPT header not at the end of the disk. [ 4.234399] GPT:29624393 != 33554431 [ 4.234549] GPT: Use GNU Parted to correct GPT errors. [ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7Quoted 6 lines
$ ./qemu-system-arm -M ast2600-evb qemu-system-arm: eMMC image smaller than boot partitions $ ./qemu-system-arm -M ast2600-evb -drive file=disk.image,if=sd <works if disk.image is large enough>Is that ok?
No. This is wrong.
Quoted 8 lines
An sd card device is auto created at init time and a 'DriveInfo *' is always available for index 0. '
mc->auto_create_sdcard' should be set to false IMO.commit
cdc8d7cadaac("hw/boards: Renameno_sdcard->auto_create_sdcard") seems to have changed the behavior of several machines. See 'make check'.
Just to avoid we are in deadlock: My understanding of this issue is that it is not a fault of this series. Am I right? Or am I supposed to address that as well?
Regarding the rest of the series, there was another comment on potential improvements for the docs. I was waiting for further remarks before creating a potential v5.
So, what is needed now to move forward with my series?
Thanks,
Jan
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 183 lines · Jan Kiszka
Quoted 182 lines · Cédric Le Goater
Quoted 168 lines · Jan Kiszka
Quoted 157 lines · Cédric Le Goater
+ Jamin
Quoted 112 lines · Jan Kiszka
Quoted 111 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later on also RPMB) and depend both on the size of the image and the type of the device. Up to and including 2GB, the power-of-2 rule applies to the
user data area. For larger images, multiples of 512 sectors must be used
for eMMC and multiples of 512K for SD-cards. Fix the check accordingly and also detect if the image is too small to even hold the boot partitions.Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>--- hw/sd/sd.c | 61 ++++++++++++++++++++++++++++++++++++ +----------------- 1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +16
-0@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj) timer_free(sd->ocr_power_timer); } +static void sd_blk_size_error(SDState *sd, int64_t blk_size, + int64_t blk_size_aligned, const char *rule, + Error **errp) +{ + const char *dev_type = sd_is_emmc(sd) ? "eMMC" : "SD card"; + char *blk_size_str; + + blk_size_str = size_to_str(blk_size); + error_setg(errp, "Invalid %s size: %s", dev_type, blk_size_str); + g_free(blk_size_str); + + blk_size_str = size_to_str(blk_size_aligned); + error_append_hint(errp, + "%s size has to be %s, e.g. %s.\n" + "You can resize disk images with" + " 'qemu-img resize <imagefile> <new-size>'\n" + "(note that this will lose data if you makethe"
+ " image smaller than it currently is).\n", +dev_type, rule,blk_size_str);
+g_free(blk_size_str);hw/sd/sd.c +2
-11+} + static void sd_realize(DeviceState *dev, Error **errp) { SDState *sd = SDMMC_COMMON(dev);@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp) return; } - blk_size = blk_getlength(sd->blk); - if (blk_size > 0 && !is_power_of_2(blk_size)) { - int64_t blk_size_aligned = pow2ceil(blk_size); - char *blk_size_str; - - blk_size_str = size_to_str(blk_size); - error_setg(errp, "Invalid SD card size: %s", blk_size_str); - g_free(blk_size_str); - - blk_size_str = size_to_str(blk_size_aligned); - error_append_hint(errp, - "SD card size has to be a power of 2,e.g. %s.\n"
- "You can resize disk images with" - " 'qemu-img resize <imagefile> <new- size>'\n"
- "(note that this will lose data if you make the"
- " image smaller than it currently is). \n",
-blk_size_str);
-g_free(blk_size_str);
-
+blk_size=blk_getlength(sd->blk)-sd->boot_part_size* 2; + if (blk_size>SDSC_MAX_CAPACITY) {
+ if (sd_is_emmc(sd)&&blk_size% (1 <<HWBLOCK_SHIFT) !=
0) {
+int64_tblk_size_aligned=
+ ((blk_size>>HWBLOCK_SHIFT) + 1) <<HWBLOCK_SHIFT;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512", errp); + return;
+ } else if (!sd_is_emmc(sd) &&blk_size% (512 * KiB)) { +int64_tblk_size_aligned= ((blk_size>> 19) + 1) << 19;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512K", errp); + return;
+ }
+ } else if (blk_size> 0 && !is_power_of_2(blk_size)) { + sd_blk_size_error(sd,blk_size,pow2ceil(blk_size), "a power of 2",
+ errp);
+ return;
+ } else if (blk_size< 0) {
+ error_setg(errp, "eMMC image smaller than bootQuoted 8 lines
Quoted 1 line
partitions");
Cedric, I just played with some ast* machines and noticed that they now trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we
shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset. The machine model loads the u-boot-spl.bin contents as a ROM.
The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \ -drive file=./v09.07/ast2600-default/image- bmc,format=raw,if=mtd - serial mon:stdio \ -drive file=mmc-ast2600-evb- noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2 .... U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000) SOC: AST2600-A3 eSPI Mode: SIO:Enable : SuperIO-2e Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII Model: AST2600 EVB DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off) RC Bridge phy@1e6ed200 : Link up MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0 .... [ 4.209117] mmc0: new high speed MMC card at address 0001Quoted 9 lines
[ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiB [ 4.233637] GPT:Primary header thinks Alt. header is not at the end of the disk. [ 4.233995] GPT:29624393 != 33554431 [ 4.234161] GPT:Alternate GPT header not at the end of the disk. [ 4.234399] GPT:29624393 != 33554431 [ 4.234549] GPT: Use GNU Parted to correct GPT errors. [ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7Quoted 6 lines
$ ./qemu-system-arm -M ast2600-evb qemu-system-arm: eMMC image smaller than boot partitions $ ./qemu-system-arm -M ast2600-evb -drive file=disk.image,if=sd <works if disk.image is large enough>Is that ok?
No. This is wrong.
An sd card device is auto created at init time and a 'DriveInfo *' is always available for index 0. '
mc->auto_create_sdcard' should be set to false IMO.
Quoted 8 lines
Quoted 4 lines
commit
cdc8d7cadaac("hw/boards: Renameno_sdcard->auto_create_sdcard") seems to have changed the behavior of several machines. See 'make check'.Just to avoid we are in deadlock: My understanding of this issue is that it is not a fault of this series. Am I right? Or am I supposed to address that as well?
Could you add to your series :
https://lore.kernel.org/qemu-devel/[email protected]/
and retry the aspeed machines ?
I am afraid more should be done to run 'make check' with your series. Maybe set 'mc->auto_create_sdcard' to false for all machines ?
Thanks,
C.
Quoted 10 lines
Regarding the rest of the series, there was another comment on potential improvements for the docs. I was waiting for further remarks before creating a potential v5.
So, what is needed now to move forward with my series?
Thanks,
Jan
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 204 lines · Cédric Le Goater
Quoted 194 lines · Jan Kiszka
Quoted 193 lines · Cédric Le Goater
Quoted 179 lines · Jan Kiszka
Quoted 169 lines · Cédric Le Goater
+ Jamin
Quoted 122 lines · Jan Kiszka
Quoted 112 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Alignment rules apply the the individual partitions (user, boot, later
on also RPMB) and depend both on the size of the image and the type of
the device. Up to and including 2GB, the power-of-2 rule applies to the
user data area. For larger images, multiples of 512 sectors must be used
for eMMC and multiples of 512K for SD-cards. Fix the check accordingly
and also detect if the image is too small to even hold the boot partitions.Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Warner Losh <[email protected]>---
CC: Warner Losh <[email protected]>
CC: Cédric Le Goater <[email protected]>
CC: Joel Stanley <[email protected]>
CC: Alistair Francis <[email protected]>
CC: Alexander Bulekov <[email protected]>
---
hw/sd/sd.c| 61 ++++++++++++++++++++++++++++++++++++
+-----------------1 file changed, 42 insertions(+), 19 deletions(-)hw/sd/sd.c +16
-0@@ -2759,6 +2759,28 @@ static void sd_instance_finalize(Object *obj) timer_free(sd->ocr_power_timer); } +static void sd_blk_size_error(SDState *sd, int64_t blk_size, + int64_t blk_size_aligned, const char *rule, + Error **errp) +{ + const char *dev_type = sd_is_emmc(sd) ? "eMMC" : "SD card"; + char *blk_size_str; + + blk_size_str = size_to_str(blk_size); + error_setg(errp, "Invalid %s size: %s", dev_type, blk_size_str); + g_free(blk_size_str); + + blk_size_str = size_to_str(blk_size_aligned); + error_append_hint(errp, + "%s size has to be %s, e.g. %s.\n" + "You can resize disk images with" + " 'qemu-img resize <imagefile> <new-size>'\n" + "(note that this will lose data if you makethe"
+ " image smaller than it currently is).\n", +dev_type, rule,blk_size_str);
+g_free(blk_size_str);hw/sd/sd.c +2
-0+} +static void
sd_realize(DeviceState *dev, Error **errp){
SDState *sd =SDMMC_COMMON(dev);hw/sd/sd.c +0
-11@@ -2781,25 +2803,26 @@ static void sd_realize(DeviceState *dev, Error **errp) return; } - blk_size = blk_getlength(sd->blk); - if (blk_size > 0 && !is_power_of_2(blk_size)) { - int64_t blk_size_aligned = pow2ceil(blk_size); - char *blk_size_str; - - blk_size_str = size_to_str(blk_size); - error_setg(errp, "Invalid SD card size: %s", blk_size_str); - g_free(blk_size_str); - - blk_size_str = size_to_str(blk_size_aligned); - error_append_hint(errp, - "SD card size has to be a power of 2,e.g. %s.\n"
- "You can resize disk images with" - " 'qemu-img resize <imagefile> <new- size>'\n"
- "(note that this will lose data if you
make the"
- " image smaller than it currently is).
\n",
-blk_size_str);
-g_free(blk_size_str);
-
+blk_size=blk_getlength(sd->blk)-sd->boot_part_size* 2; + if (blk_size>SDSC_MAX_CAPACITY) {
+ if (sd_is_emmc(sd)&&blk_size% (1 <<HWBLOCK_SHIFT) !=
0) {
+int64_tblk_size_aligned=
+ ((blk_size>>HWBLOCK_SHIFT) + 1) <<HWBLOCK_SHIFT;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512", errp); + return;
+ } else if (!sd_is_emmc(sd) &&blk_size% (512 * KiB)) { +int64_tblk_size_aligned= ((blk_size>> 19) +
1) <<
19;
+ sd_blk_size_error(sd,blk_size,blk_size_aligned, + "multiples of 512K", errp); + return;
+ }Quoted 8 lines
+ } else if (
blk_size> 0 && !is_power_of_2(blk_size)) { + sd_blk_size_error(sd,blk_size,pow2ceil(blk_size), "a power of 2",
+ errp);
+ return;
+ } else if (blk_size< 0) {
+error_setg(errp, "eMMC image smaller than boot partitions");Quoted 7 lines
Cedric, I just played with some ast* machines and noticed that they now
trigger that error above when no eMMC disk image is specified ("qemu-system-aarch64 -M ast2700a1-evb"). Is that a valid error, i.e. we
shouldn't have tried to boot without an eMMC at all so far, or would this be a regression?Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset. The machine model loads the u-boot-spl.bin contents as a ROM.
The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \ -drive file=./v09.07/ast2600-default/image- bmc,format=raw,if=mtd - serial mon:stdio \ -drive file=mmc-ast2600-evb- noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2 .... U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000) SOC: AST2600-A3 eSPI Mode: SIO:Enable : SuperIO-2e Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII Model: AST2600 EVB DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off) RC Bridge phy@1e6ed200 : Link up MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0 .... [ 4.209117] mmc0: new high speed MMC card at address 0001 [ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiB [ 4.233637] GPT:Primary header thinks Alt. header is not at theQuoted 8 lines
end of the disk. [ 4.233995] GPT:29624393 != 33554431 [ 4.234161] GPT:Alternate GPT header not at the end of the disk. [ 4.234399] GPT:29624393 != 33554431 [ 4.234549] GPT: Use GNU Parted to correct GPT errors. [ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7Quoted 6 lines
$ ./qemu-system-arm -M ast2600-evb qemu-system-arm: eMMC image smaller than boot partitions $ ./qemu-system-arm -M ast2600-evb -drive file=disk.image,if=sd <works if disk.image is large enough>Is that ok?
No. This is wrong.
An sd card device is auto created at init time and a 'DriveInfo *' is always available for index 0. '
mc->auto_create_sdcard' should be set to false IMO.Quoted 8 lines
Quoted 4 lines
commit
cdc8d7cadaac("hw/boards: Renameno_sdcard->auto_create_sdcard") seems to have changed the behavior of several machines. See 'make check'.Just to avoid we are in deadlock: My understanding of this issue is that it is not a fault of this series. Am I right? Or am I supposed to address that as well?
Quoted 6 lines
Could you add to your series :
https://lore.kernel.org/qemu-devel/20250930142448.1030476-1-
[email protected]/and retry the aspeed machines ?
Yes, that patch resolves the issue above.
Quoted 3 lines
I am afraid more should be done to run 'make check' with your series. Maybe set '
mc->auto_create_sdcard' to false for all machines ?
Who should do that?
Quoted 14 lines
Thanks,
C.
Quoted 7 lines
Regarding the rest of the series, there was another comment on potential improvements for the docs. I was waiting for further remarks before creating a potential v5.
So, what is needed now to move forward with my series?
This question is still open for me.
Jan
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Hello Jan,
Quoted 4 lines
Quoted 4 lines
Quoted 3 lines
Just to avoid we are in deadlock: My understanding of this issue is that it is not a fault of this series. Am I right? Or am I supposed to address that as well?
Quoted 8 lines
Quoted 6 lines
Could you add to your series :
https://lore.kernel.org/qemu-devel/20250930142448.1030476-1-
[email protected]/and retry the aspeed machines ?
Yes, that patch resolves the issue above.
A similar version is now merged.
Quoted 4 lines
Quoted 2 lines
I am afraid more should be done to run 'make check' with your series. Maybe set '
mc->auto_create_sdcard' to false for all machines ?Who should do that?
/me looks at sd maintainers. Thanks,
C.
Re: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
Quoted 18 lines · Cédric Le Goater
Hello Jan,
Quoted 5 lines
Quoted 5 lines
Quoted 4 lines
Just to avoid we are in deadlock: My understanding of this issue is that
it is not a fault of this series. Am I right? Or am I supposed to address that as well?Quoted 8 lines
Quoted 6 lines
Could you add to your series :
https://lore.kernel.org/qemu-devel/20250930142448.1030476-1-
[email protected]/and retry the aspeed machines ?
Yes, that patch resolves the issue above.
A similar version is now merged.
Quoted 9 lines
Quoted 4 lines
Quoted 2 lines
I am afraid more should be done to run 'make check' with your series. Maybe set '
mc->auto_create_sdcard' to false for all machines ?Who should do that?
/me looks at sd maintainers. Thanks,
C.
FWIW, v5 of this series is coming: I found an issue of this patch /wrt unplugged SD cards. make check now passes.
Jan
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center
RE: [PATCH v4 1/6] hw/sd/sdcard: Fix size check for backing block image
In reply to Cédric Le GoaterQuoted 3 lines
Only the ast2600-evb and the rainier-bmc have eMMC support. I don't think the ast2700a1-evb has eMMC support. Jamin ?
Yes, the AST2700 does not support booting from eMMC yet. Jamin
Quoted 45 lines
The rainier-bmc boots by default from eMMC. Nothing really special about the image, the first boot partition includes the u-boot-spl.bin and u-boot.bin images at expected offset.
The machine model loads the u-boot-spl.bin contents as a ROM.The ast2600-evb machine boots from flash. To add an eMMC drive (needs to be the 3rd 'sd' drive), use this command line :
$ qemu-system-arm -M ast2600-evb -net nic,netdev=net0 -netdev user,id=net0 \ -drive file=./v09.07/ast2600-default/image-bmc,format=raw,if=mtd -serial mon:stdio \ -drive file=mmc-ast2600-evb-noboot.qcow2,format=qcow2,if=sd,id=sd2,index=2.... U-Boot 2019.04-v00.04.22 (Jun 17 2025 - 08:57:39 +0000) SOC: AST2600-A3 eSPI Mode: SIO:Enable : SuperIO-2e Eth: MAC0: RGMII, MAC1: RGMII, MAC2: RGMII, MAC3: RGMII Model: AST2600 EVB DRAM: already initialized, 1008 MiB (capacity:1024 MiB, VGA:64 MiB, ECC:off) RC Bridge phy@1e6ed200 : Link up MMC: sdhci_slot0@100: 1, sdhci_slot1@200: 2, emmc_slot0@100: 0 .... [ 4.209117] mmc0: new high speed MMC card at address 0001 [ 4.211765] mmcblk0: mmc0:0001 QEMU!! 16.0 GiB [ 4.233637] GPT:Primary header thinks Alt. header is not at the end of the disk. [ 4.233995] GPT:29624393 != 33554431 [ 4.234161] GPT:Alternate GPT header not at the end of the disk. [ 4.234399] GPT:29624393 != 33554431 [ 4.234549] GPT: Use GNU Parted to correct GPT errors. [ 4.235223] mmcblk0: p1 p2 p3 p4 p5 p6 p7Thanks,
C.
PATCH v4 2/6 hw/sd/sdcard: Allow user-instantiated eMMC
In reply to Jan KiszkaFrom: Jan Kiszka <[email protected]>
Enable user-instantiation so that PCI-attached eMMCs can be created for virt machines, for QA purposes for the eMMC model itself and for complex firmware/OS integrations using the upcoming RPMB partition support.
--- hw/sd/sd.c | 2 -- 1 file changed, 2 deletions(-)
hw/sd/sd.c +0 -2
@@ -2926,8 +2926,6 @@ static void emmc_class_init(ObjectClass *klass, const void *data) dc->desc ="eMMC" ; dc->realize = emmc_realize;device_class_set_props (dc, emmc_properties); -/* Reason: Soldered on board */ - dc->user_creatable = false; sc->proto = &sd_proto_emmc;
Signature · 1 line
2.51.0
PATCH v4 3/6 hw/sd/sdcard: Add basic support for RPMB partition
In reply to Jan KiszkaFrom: Jan Kiszka <[email protected]>
The Replay Protected Memory Block (RPMB) is available since eMMC 4.4 which has been obsoleted by 4.41. Therefore lift the provided EXT_CSD_REV to 5 (4.41) and provide the basic logic to implement basic support for it. This allows to set the authentication key, read the write counter and authenticated perform data read and write requests. Those aren't actually authenticated yet, support for that will be added later.
The RPMB image needs to be added to backing block images after potential boot partitions and before the user data. It's size is controlled by the rpmb-partition-size property.
Also missing in this version (and actually not only for RPMB bits) is persistence of registers that are supposed to survive power cycles. Most prominent are the write counters or the authentication key. This feature can be added later, e.g. by append a state structure to the backing block image.
--- hw/sd/sd.c | 207 +++++++++++++++++++++++++++++++++++++++-- hw/sd/sdmmc-internal.h | 21 +++++ hw/sd/trace-events | 2 + 3 files changed, 222 insertions(+), 8 deletions(-)
hw/sd/sd.c +199 -8
@@ -117,6 +117,20 @@ typedef struct SDProto { } cmd[SDMMC_CMD_MAX ], acmd[SDMMC_CMD_MAX ]; } SDProto; +#define RPMB_KEY_MAC_LEN 32 + +typedef struct { +uint8_t stuff_bytes[196 ]; +uint8_t key_mac[RPMB_KEY_MAC_LEN ]; +uint8_t data[256 ]; +uint8_t nonce[16 ]; +uint32_t write_counter; +uint16_t address; +uint16_t block_count; +uint16_t result; +uint16_t req_resp; +}RPMBDataFrame ; +struct SDState {DeviceState parent_obj;
@@ -140,6 +154,7 @@ struct SDState {uint8_t spec_version;uint64_t boot_part_size; +uint64_t rpmb_part_size;BlockBackend *blk;uint8_t boot_config;
@@ -172,6 +187,10 @@ struct SDState {uint32_t data_offset;size_t data_size;uint8_t data[512 ]; +RPMBDataFrame rpmb_result; +uint32_t rpmb_write_counter; +uint8_t rpmb_key[32 ]; +uint8_t rpmb_key_set;QEMUTimer *ocr_power_timer;uint8_t dat_lines;bool cmd_line;
@@ -506,7 +525,9 @@ static void emmc_set_ext_csd(SDState *sd, uint64_t size) sd->ext_csd[205 ] =0x46 ;/* Min read perf for 4bit@26Mhz */ sd->ext_csd[EXT_CSD_CARD_TYPE ] =0b11 ; sd->ext_csd[EXT_CSD_STRUCTURE ] =2 ; - sd->ext_csd[EXT_CSD_REV ] =3 ; + sd->ext_csd[EXT_CSD_REV ] =5 ; + sd->ext_csd[EXT_CSD_RPMB_MULT ] = sd->rpmb_part_size / (128 * KiB); + sd->ext_csd[EXT_CSD_PARTITION_SUPPORT ] =0b111 ;/* Mode segment (RW) */ sd->ext_csd[EXT_CSD_PART_CONFIG ] = sd->boot_config;
@@ -834,7 +855,8 @@ static uint32_t sd_blk_len(SDState *sd)/* * This requires a disk image that has two boot partitions inserted at the * beginning of it, followed by an RPMB partition. The size of the boot -* partitions is the "boot-partition-size" property. +* partitions is the "boot-partition-size" property, the one of the RPMB +* partition is 'rpmb-partition-size'. */ static uint32_t sd_part_offset (SDState *sd) {
@@ -848,11 +870,13 @@ static uint32_t sd_part_offset(SDState *sd) &EXT_CSD_PART_CONFIG_ACC_MASK ;switch (partition_access) {case EXT_CSD_PART_CONFIG_ACC_DEFAULT : -return sd->boot_part_size *2 ; +return sd->boot_part_size *2 + sd->rpmb_part_size;case EXT_CSD_PART_CONFIG_ACC_BOOT1 :return 0 ;case EXT_CSD_PART_CONFIG_ACC_BOOT2 :return sd->boot_part_size *1 ; +case EXT_CSD_PART_CONFIG_ACC_RPMB : +return sd->boot_part_size *2 ;default :g_assert_not_reached (); }
@@ -891,7 +915,7 @@ static void sd_reset(DeviceState *dev) } size = sect <<HWBLOCK_SHIFT ;if (sd_is_emmc (sd)) { - size -= sd->boot_part_size *2 ; + size -= sd->boot_part_size *2 + sd->rpmb_part_size; } sect =sd_addr_to_wpnum (size) +1 ;
@@ -979,6 +1003,34 @@ static const VMStateDescription sd_ocr_vmstate = { }, }; +static bool vmstate_needed_for_rpmb (void *opaque) +{ +SDState *sd = opaque; + +return sd->rpmb_part_size >0 ; +} + +static const VMStateDescription emmc_rpmb_vmstate = { + .name ="sd-card/ext_csd_modes-state" , + .version_id =1 , + .minimum_version_id =1 , + .needed = vmstate_needed_for_rpmb, + .fields = (const VMStateField []) { +VMSTATE_UINT8_ARRAY (rpmb_result.key_mac, SDState,RPMB_KEY_MAC_LEN ), +VMSTATE_UINT8_ARRAY (rpmb_result.data, SDState,256 ), +VMSTATE_UINT8_ARRAY (rpmb_result.nonce, SDState,16 ), +VMSTATE_UINT32 (rpmb_result.write_counter, SDState), +VMSTATE_UINT16 (rpmb_result.address, SDState), +VMSTATE_UINT16 (rpmb_result.block_count, SDState), +VMSTATE_UINT16 (rpmb_result.result, SDState), +VMSTATE_UINT16 (rpmb_result.req_resp, SDState), +VMSTATE_UINT32 (rpmb_write_counter, SDState), +VMSTATE_UINT8_ARRAY (rpmb_key, SDState,32 ), +VMSTATE_UINT8 (rpmb_key_set, SDState), +VMSTATE_END_OF_LIST () + }, +}; +static bool vmstate_needed_for_emmc (void *opaque) {SDState *sd = opaque;
@@ -1045,6 +1097,7 @@ static const VMStateDescription sd_vmstate = { .subsections = (const VMStateDescription * const []) { &sd_ocr_vmstate, &emmc_extcsd_vmstate, + &emmc_rpmb_vmstate,NULL }, };
@@ -1067,6 +1120,105 @@ static void sd_blk_write(SDState *sd, uint64_t addr, uint32_t len) } } +static void emmc_rpmb_blk_read (SDState *sd,uint64_t addr,uint32_t len) +{ +uint16_t resp =be16_to_cpu (sd->rpmb_result.req_resp); +uint16_t result =be16_to_cpu (sd->rpmb_result.result); +unsigned int curr_block =0 ; + +if ((result & ~RPMB_RESULT_COUTER_EXPIRED ) ==RPMB_RESULT_OK && + resp ==RPMB_RESP (RPMB_REQ_AUTH_DATA_READ )) { + curr_block =be16_to_cpu (sd->rpmb_result.address); +if (sd->rpmb_result.block_count ==0 ) { + sd->rpmb_result.block_count =cpu_to_be16 (sd->multi_blk_cnt); + }else { + curr_block +=be16_to_cpu (sd->rpmb_result.block_count) - + sd->multi_blk_cnt; + } + addr = curr_block *256 +sd_part_offset (sd); +if (blk_pread (sd->blk, addr,256 , sd->rpmb_result.data,0 ) <0 ) { +fprintf (stderr,"sd_blk_read: read error on host side\n" ); +memset (sd->rpmb_result.data,0 ,sizeof (sd->rpmb_result.data)); + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_READ_FAILURE | + (result &RPMB_RESULT_COUTER_EXPIRED )); + } + } +memcpy (sd->data, &sd->rpmb_result,sizeof (sd->rpmb_result)); + +trace_sdcard_rpmb_read_block (resp, curr_block, +be16_to_cpu (sd->rpmb_result.result)); +} + +static void emmc_rpmb_blk_write (SDState *sd,uint64_t addr,uint32_t len) +{ +RPMBDataFrame *frame = (RPMBDataFrame *)sd->data; +uint16_t req =be16_to_cpu (frame->req_resp); + +if (req ==RPMB_REQ_READ_RESULT ) { +/* just return the current result register */ + goto exit; + } +memset (&sd->rpmb_result,0 ,sizeof (sd->rpmb_result)); +memcpy (sd->rpmb_result.nonce, frame->nonce,sizeof (sd->rpmb_result.nonce)); + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_OK ); + sd->rpmb_result.req_resp =cpu_to_be16 (RPMB_RESP (req)); + +if (!sd->rpmb_key_set && req !=RPMB_REQ_PROGRAM_AUTH_KEY ) { + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_NO_AUTH_KEY ); + goto exit; + } + +switch (req) { +case RPMB_REQ_PROGRAM_AUTH_KEY : +if (sd->rpmb_key_set) { + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_WRITE_FAILURE ); +break ; + } +memcpy (sd->rpmb_key, frame->key_mac,sizeof (sd->rpmb_key)); + sd->rpmb_key_set =1 ; +break ; +case RPMB_REQ_READ_WRITE_COUNTER : + sd->rpmb_result.write_counter =cpu_to_be32 (sd->rpmb_write_counter); +break ; +case RPMB_REQ_AUTH_DATA_WRITE : +/* We only support single-block writes so far */ +if (sd->multi_blk_cnt !=1 ) { + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_GENERAL_FAILURE ); +break ; + } +if (sd->rpmb_write_counter ==0xffffffff ) { + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_WRITE_FAILURE ); +break ; + } +if (be32_to_cpu (frame->write_counter) != sd->rpmb_write_counter) { + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_COUNTER_FAILURE ); +break ; + } + sd->rpmb_result.address = frame->address; + addr =be16_to_cpu (frame->address) *256 +sd_part_offset (sd); +if (blk_pwrite (sd->blk, addr,256 , frame->data,0 ) <0 ) { +fprintf (stderr,"sd_blk_write: write error on host side\n" ); + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_WRITE_FAILURE ); + }else { + sd->rpmb_write_counter++; + } + sd->rpmb_result.write_counter =cpu_to_be32 (sd->rpmb_write_counter); +break ; +case RPMB_REQ_AUTH_DATA_READ : + sd->rpmb_result.address = frame->address; +break ; +default : +qemu_log_mask (LOG_UNIMP ,"RPMB request %d not implemented\n" , req); + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_GENERAL_FAILURE ); +break ; + } +exit: +if (sd->rpmb_write_counter ==0xffffffff ) { + sd->rpmb_result.result |=cpu_to_be16 (RPMB_RESULT_COUTER_EXPIRED ); + } +trace_sdcard_rpmb_write_block (req,be16_to_cpu (sd->rpmb_result.result)); +} +static void sd_erase (SDState *sd) {uint64_t erase_start = sd->erase_start;
@@ -1180,6 +1332,19 @@ static void emmc_function_switch(SDState *sd, uint32_t arg)break ; } +if (index ==EXT_CSD_PART_CONFIG ) { +uint8_t part = b &EXT_CSD_PART_CONFIG_ACC_MASK ; + +if (((part ==EXT_CSD_PART_CONFIG_ACC_BOOT1 || + part ==EXT_CSD_PART_CONFIG_ACC_BOOT2 ) && !sd->boot_part_size) || + (part ==EXT_CSD_PART_CONFIG_ACC_RPMB && !sd->rpmb_part_size)) { +qemu_log_mask (LOG_GUEST_ERROR , +"MMC switching to illegal partition\n" ); + sd->card_status |=R_CSR_SWITCH_ERROR_MASK ; +return ; + } + } +trace_sdcard_ext_csd_update (index, sd->ext_csd[index], b); sd->ext_csd[index] = b; }
@@ -2378,6 +2543,7 @@ static bool sd_generic_read_byte(SDState *sd, uint8_t *value)static void sd_write_byte (SDState *sd,uint8_t value) { +unsigned int partition_access;int i;if (!sd->blk || !blk_is_inserted (sd->blk)) {
@@ -2427,7 +2593,13 @@ static void sd_write_byte(SDState *sd, uint8_t value)if (sd->data_offset >= sd->blk_len) {/* TODO: Check CRC before committing */ sd->state = sd_programming_state; -sd_blk_write (sd, sd->data_start, sd->data_offset); + partition_access = sd->ext_csd[EXT_CSD_PART_CONFIG ] + &EXT_CSD_PART_CONFIG_ACC_MASK ; +if (partition_access ==EXT_CSD_PART_CONFIG_ACC_RPMB ) { +emmc_rpmb_blk_write (sd, sd->data_start, sd->data_offset); + }else { +sd_blk_write (sd, sd->data_start, sd->data_offset); + } sd->blk_written++; sd->data_start += sd->blk_len; sd->data_offset =0 ;
@@ -2510,6 +2682,7 @@ static uint8_t sd_read_byte(SDState *sd) {/* TODO: Append CRCs */ const uint8_t dummy_byte =0x00 ; +unsigned int partition_access;uint8_t ret;uint32_t io_len;
@@ -2553,7 +2726,13 @@ static uint8_t sd_read_byte(SDState *sd) sd->data_start, io_len)) {return dummy_byte; } -sd_blk_read (sd, sd->data_start, io_len); + partition_access = sd->ext_csd[EXT_CSD_PART_CONFIG ] + &EXT_CSD_PART_CONFIG_ACC_MASK ; +if (partition_access ==EXT_CSD_PART_CONFIG_ACC_RPMB ) { +emmc_rpmb_blk_read (sd, sd->data_start, io_len); + }else { +sd_blk_read (sd, sd->data_start, io_len); + } } ret = sd->data[sd->data_offset ++];
@@ -2803,7 +2982,8 @@ static void sd_realize(DeviceState *dev, Error **errp)return ; } - blk_size =blk_getlength (sd->blk) - sd->boot_part_size *2 ; + blk_size =blk_getlength (sd->blk) - sd->boot_part_size *2 - + sd->rpmb_part_size;if (blk_size >SDSC_MAX_CAPACITY ) {if (sd_is_emmc (sd) && blk_size % (1 <<HWBLOCK_SHIFT ) !=0 ) { int64_t blk_size_aligned =
@@ -2842,13 +3022,23 @@ static void sd_realize(DeviceState *dev, Error **errp)"The boot partition size must be multiples of 128K" "and not larger than 32640K.\n"); } +if (sd->rpmb_part_size % (128 * KiB) || + sd->rpmb_part_size >128 *128 * KiB) { +char *size_str =size_to_str (sd->boot_part_size); + +error_setg (errp,"Invalid RPMB partition size: %s" , size_str); +g_free (size_str); +error_append_hint (errp, +"The RPMB partition size must be multiples of 128K" +"and not larger than 16384K.\n" ); + } }static void emmc_realize (DeviceState *dev,Error **errp) {SDState *sd =SDMMC_COMMON (dev); - sd->spec_version = SD_PHY_SPECv3_01_VERS;/* Actually v4.3 */ + sd->spec_version = SD_PHY_SPECv3_01_VERS;/* Actually v4.5 */ sd_realize (dev, errp); }
@@ -2865,6 +3055,7 @@ static const Property sd_properties[] = {static const Property emmc_properties[] = {DEFINE_PROP_UINT64 ("boot-partition-size" , SDState, boot_part_size,0 ),DEFINE_PROP_UINT8 ("boot-config" , SDState, boot_config,0x0 ), +DEFINE_PROP_UINT64 ("rpmb-partition-size" , SDState, rpmb_part_size,0 ), };static void sdmmc_common_class_init (ObjectClass *klass,const void *data)
hw/sd/sdmmc-internal.h +21 -0
@@ -118,9 +118,30 @@ DECLARE_OBJ_CHECKERS(SDState, SDCardClass, SDMMC_COMMON, TYPE_SDMMC_COMMON)#define EXT_CSD_PART_CONFIG_ACC_DEFAULT (0x0)#define EXT_CSD_PART_CONFIG_ACC_BOOT1 (0x1)#define EXT_CSD_PART_CONFIG_ACC_BOOT2 (0x2) +#define EXT_CSD_PART_CONFIG_ACC_RPMB (0x3)#define EXT_CSD_PART_CONFIG_EN_MASK (0x7 << 3)#define EXT_CSD_PART_CONFIG_EN_BOOT0 (0x1 << 3)#define EXT_CSD_PART_CONFIG_EN_USER (0x7 << 3) +#define RPMB_REQ_PROGRAM_AUTH_KEY (1) +#define RPMB_REQ_READ_WRITE_COUNTER (2) +#define RPMB_REQ_AUTH_DATA_WRITE (3) +#define RPMB_REQ_AUTH_DATA_READ (4) +#define RPMB_REQ_READ_RESULT (5) +#define RPMB_REQ_AUTH_CONFIG_WRITE (6) +#define RPMB_REQ_AUTH_CONFIG_READ (7) + +#define RPMB_RESP (__req__) ((__req__) << 8) + +#define RPMB_RESULT_OK (0) +#define RPMB_RESULT_GENERAL_FAILURE (1) +#define RPMB_RESULT_AUTH_FAILURE (2) +#define RPMB_RESULT_COUNTER_FAILURE (3) +#define RPMB_RESULT_ADDRESS_FAILURE (4) +#define RPMB_RESULT_WRITE_FAILURE (5) +#define RPMB_RESULT_READ_FAILURE (6) +#define RPMB_RESULT_NO_AUTH_KEY (7) +#define RPMB_RESULT_COUTER_EXPIRED (0x80) +#endif
hw/sd/trace-events +2 -0
@@ -59,6 +59,8 @@ sdcard_read_data(const char *proto, const char *cmd_desc, uint8_t cmd, uint32_t sdcard_set_voltage(uint16_t millivolts) "%u mV" sdcard_ext_csd_update(unsigned index, uint8_t oval, uint8_t nval) "index %u: 0x%02x -> 0x%02x" sdcard_switch(unsigned access, unsigned index, unsigned value, unsigned set) "SWITCH acc:%u idx:%u val:%u set:%u" +sdcard_rpmb_read_block(uint16_t resp, uint16_t read_addr, uint16_t result) "resp 0x%x read_addr 0x%x result 0x%x" +sdcard_rpmb_write_block(uint16_t req, uint16_t result) "req 0x%x result 0x%x" # pl181.c pl181_command_send(uint8_t cmd, uint32_t arg) "sending CMD%02d arg 0x%08" PRIx32
Signature · 1 line
2.51.0
PATCH v4 4/6 hw/sd/sdcard: Handle RPMB MAC field
In reply to Jan KiszkaFrom: Jan Kiszka <[email protected]>
Implement correct setting of the MAC field when passing RPMB frames back to the guest. Also check the MAC on authenticated write requests.
This depends on HMAC support for QCRYPTO_HASH_ALGO_SHA256 which is always available via glib - assert this, just to be safe.
--- hw/sd/sd.c | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+)
hw/sd/sd.c +81 -0
@@ -51,6 +51,7 @@#include "qemu/module.h" #include "sdmmc-internal.h" #include "trace.h" +#include "crypto/hmac.h" //#define DEBUG_SD 1
@@ -118,6 +119,7 @@ typedef struct SDProto { } SDProto;#define RPMB_KEY_MAC_LEN 32 +#define RPMB_HASH_LEN 284 typedef struct { uint8_t stuff_bytes[196];
@@ -1120,6 +1122,66 @@ static void sd_blk_write(SDState *sd, uint64_t addr, uint32_t len) } } +static bool rpmb_calc_hmac (SDState *sd,RPMBDataFrame *frame, +unsigned int num_blocks,uint8_t *mac) +{ +size_t mac_len =RPMB_KEY_MAC_LEN ; +bool success = true; +Error *err =NULL ; +QCryptoHmac *hmac; +uint64_t addr; + + hmac =qcrypto_hmac_new (QCRYPTO_HASH_ALGO_SHA256 , sd->rpmb_key, +RPMB_KEY_MAC_LEN , &err); +if (!hmac) { +error_report_err (err); +return false; + } + +/* +* This implies a read request because we only support single-block write +* requests so far. +*/ +if (num_blocks >1 ) { +/* +* Unfortunately, the underlying crypto libraries do not allow us to +* migrate an active QCryptoHmac state. Therefore, we have to calculate +* the HMAC in one run. To avoid buffering a complete read sequence in +* SDState, reconstruct all frames except for the last one. +*/ +char *buf = (char *)sd->data; + +memcpy (buf, frame->data,RPMB_HASH_LEN ); + addr =be16_to_cpu (frame->address) *256 +sd_part_offset (sd); +do { +if (blk_pread (sd->blk, addr,256 , buf,0 ) <0 ) { +fprintf (stderr,"sd_blk_read: read error on host side\n" ); + success = false; +break ; + } +if (qcrypto_hmac_bytes (hmac, buf,RPMB_HASH_LEN ,NULL ,NULL , + &err) <0 ) { +error_report_err (err); + success = false; +break ; + } + addr +=256 ; + }while (--num_blocks >1 ); + } + +if (success && +qcrypto_hmac_bytes (hmac, (const char *)frame->data,RPMB_HASH_LEN , &mac, + &mac_len, &err) <0 ) { +error_report_err (err); + success = false; + } +assert (!success || mac_len ==RPMB_KEY_MAC_LEN ); + +qcrypto_hmac_free (hmac); + +return success; +} +static void emmc_rpmb_blk_read (SDState *sd,uint64_t addr,uint32_t len) {uint16_t resp =be16_to_cpu (sd->rpmb_result.req_resp);
@@ -1142,6 +1204,17 @@ static void emmc_rpmb_blk_read(SDState *sd, uint64_t addr, uint32_t len) sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_READ_FAILURE | (result &RPMB_RESULT_COUTER_EXPIRED )); } +if (sd->multi_blk_cnt ==1 && + !rpmb_calc_hmac (sd, &sd->rpmb_result, +be16_to_cpu (sd->rpmb_result.block_count), + sd->rpmb_result.key_mac)) { +memset (sd->rpmb_result.data,0 ,sizeof (sd->rpmb_result.data)); + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_AUTH_FAILURE ); + } + }else if (!rpmb_calc_hmac (sd, &sd->rpmb_result,1 , + sd->rpmb_result.key_mac)) { +memset (sd->rpmb_result.data,0 ,sizeof (sd->rpmb_result.data)); + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_AUTH_FAILURE ); }memcpy (sd->data, &sd->rpmb_result,sizeof (sd->rpmb_result));
@@ -1153,6 +1226,7 @@ static void emmc_rpmb_blk_write(SDState *sd, uint64_t addr, uint32_t len) {RPMBDataFrame *frame = (RPMBDataFrame *)sd->data;uint16_t req =be16_to_cpu (frame->req_resp); +uint8_t mac[RPMB_KEY_MAC_LEN ];if (req ==RPMB_REQ_READ_RESULT ) {/* just return the current result register */
@@ -1190,6 +1264,11 @@ static void emmc_rpmb_blk_write(SDState *sd, uint64_t addr, uint32_t len) sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_WRITE_FAILURE );break ; } +if (!rpmb_calc_hmac (sd, frame,1 , mac) || +memcmp (frame->key_mac, mac,RPMB_KEY_MAC_LEN ) !=0 ) { + sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_AUTH_FAILURE ); +break ; + }if (be32_to_cpu (frame->write_counter) != sd->rpmb_write_counter) { sd->rpmb_result.result =cpu_to_be16 (RPMB_RESULT_COUNTER_FAILURE );break ;
@@ -3114,6 +3193,8 @@ static void emmc_class_init(ObjectClass *klass, const void *data)DeviceClass *dc =DEVICE_CLASS (klass);SDCardClass *sc =SDMMC_COMMON_CLASS (klass); +assert (qcrypto_hmac_supports (QCRYPTO_HASH_ALGO_SHA256 )); + dc->desc ="eMMC" ; dc->realize = emmc_realize;device_class_set_props (dc, emmc_properties);
Signature · 1 line
2.51.0
PATCH v4 5/6 scripts: Add helper script to generate eMMC block device images
In reply to Jan KiszkaFrom: Jan Kiszka <[email protected]>
As an eMMC block device image may consist of more than just the user data partition, provide a helper script that can compose the image from boot partitions, an RPMB partition and the user data image. The script also does the required size validation and/or rounding.
--- scripts/mkemmc.sh | 218 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100755 scripts/mkemmc.sh
scripts/mkemmc.sh new file +218 -0
@@ -0,0 +1,218 @@ +#!/bin/sh -e +# SPDX-License-Identifier: GPL-2.0-only +# +# Create eMMC block device image from boot, RPMB and user data images +# +# Copyright (c) Siemens, 2025 +# +# Authors: +# Jan Kiszka <[email protected]> +# +# This work is licensed under the terms of the GNU GPL version 2. +# See the COPYING file in the top-level directory. +# + +usage() { + echo "$0 [OPTIONS] USER_IMG[:SIZE] OUTPUT_IMG" + echo "" + echo "SIZE must be a power of 2 up to 2G and multiples of 512 byte from there on." + echo "If no SIZE is specified, the size of USER_ING will be used (rounded up)." + echo "" + echo "Supported options:" + echo " -b BOOT1_IMG[:SIZE] Add boot partitions. SIZE must be multiples of 128K. If" + echo " no SIZE is specified, the size of BOOT1_IMG will be" + echo " used (rounded up). BOOT1_IMG will be stored in boot" + echo " partition 1, and a boot partition 2 of the same size" + echo " will be created as empty (all zeros) unless -B is" + echo " specified as well." + echo " -B BOOT2_IMG Fill boot partition 2 with BOOT2_IMG. Must be combined" + echo " with -b which is also defining the partition size." + echo " -r RPMB_IMG[:SIZE] Add RPMB partition. SIZE must be multiples of 128K. If" + echo " no SIZE is specified, the size of RPMB_IMG will be" + echo " used (rounded up)." + echo " -h, --help This help" + echo "" + echo "All SIZE parameters support the units K, M, G. If SIZE is smaller than the" + echo "associated image, it will be truncated in the output image." + exit "$1" +} + +process_size() { + name=$1 + image_file=$2 + alignment=$3 + image_arg=$4 + if [ "${image_arg#*:}" = "$image_arg" ]; then + if ! size=$(stat -L -c %s "$image_file" 2>/dev/null); then + echo "Missing $name image '$image_file'." >&2 + exit 1 + fi + if [ "$alignment" = 128 ]; then + size=$(( (size + 128 * 1024 - 1) & ~(128 * 1024 - 1) )) + elif [ $size -gt $((2 * 1024 * 1024 * 1024)) ]; then + size=$(( (size + 511) & ~511 )) + elif [ $(( size & (size - 1) )) -gt 0 ]; then + n=0 + while [ "$size" -gt 0 ]; do + size=$((size >> 1)) + n=$((n + 1)) + done + size=$((1 << n)) + fi + else + value="${image_arg#*:}" + if [ "${value%K}" != "$value" ]; then + size=${value%K} + multiplier=1024 + elif [ "${value%M}" != "$value" ]; then + size=${value%M} + multiplier=$((1024 * 1024)) + elif [ "${value%G}" != "$value" ]; then + size=${value%G} + multiplier=$((1024 * 1024 * 1024)) + else + size=$value + multiplier=1 + fi + if [ "$size" -eq "$size" ] 2>/dev/null; then + size=$((size * multiplier)) + else + echo "Invalid value '$value' specified for $image_file image size." >&2 + exit 1 + fi + if [ "$alignment" = 128 ]; then + if [ $(( size & (128 * 1024 - 1) )) -ne 0 ]; then + echo "The $name image size must be multiples of 128K." >&2 + exit 1 + fi + elif [ $size -gt $((2 * 1024 * 1024 * 1024)) ]; then + if [ $(( size & 511)) -ne 0 ]; then + echo "The $name image size must be multiples of 512 (if >2G)." >&2 + exit 1 + fi + elif [ $(( size & (size - 1) )) -gt 0 ]; then + echo "The $name image size must be power of 2 (up to 2G)." >&2 + exit 1 + fi + fi + echo $size +} + +check_truncation() { + image_file=$1 + output_size=$2 + if [ "$image_file" = "/dev/zero" ]; then + return + fi + if ! actual_size=$(stat -L -c %s "$image_file" 2>/dev/null); then + echo "Missing image '$image_file'." >&2 + exit 1 + fi + if [ "$actual_size" -gt "$output_size" ]; then + echo "Warning: image '$image_file' will be truncated on output." + fi +} + +userimg= +outimg= +bootimg1= +bootimg2=/dev/zero +bootsz=0 +rpmbimg= +rpmbsz=0 + +while [ $# -gt 0 ]; do + case "$1" in + -b) + shift + [ $# -ge 1 ] || usage 1 + bootimg1=${1%%:*} + bootsz=$(process_size boot "$bootimg1" 128 "$1") + shift + ;; + -B) + shift + [ $# -ge 1 ] || usage 1 + bootimg2=$1 + shift + ;; + -r) + shift + [ $# -ge 1 ] || usage 1 + rpmbimg=${1%%:*} + rpmbsz=$(process_size RPMB "$rpmbimg" 128 "$1") + shift + ;; + -h|--help) + usage 0 + ;; + *) + if [ -z "$userimg" ]; then + userimg=${1%%:*} + usersz=$(process_size user "$userimg" U "$1") + elif [ -z "$outimg" ]; then + outimg=$1 + else + usage 1 + fi + shift + ;; + esac +done + +[ -n "$outimg" ] || usage 1 + +if [ "$bootsz" -gt $((32640 * 1024)) ]; then + echo "Boot image size is larger than 32640K." >&2 + exit 1 +fi +if [ "$rpmbsz" -gt $((16384 * 1024)) ]; then + echo "RPMB image size is larger than 16384K." >&2 + exit 1 +fi + +echo "Creating eMMC image" + +truncate "$outimg" -s 0 +pos=0 + +if [ "$bootsz" -gt 0 ]; then + echo " Boot partition 1 and 2: $((bootsz / 1024))K each" + blocks=$(( bootsz / (128 * 1024) )) + check_truncation "$bootimg1" "$bootsz" + dd if="$bootimg1" of="$outimg" conv=sparse bs=128K count=$blocks \ + status=none + check_truncation "$bootimg2" "$bootsz" + dd if="$bootimg2" of="$outimg" conv=sparse bs=128K count=$blocks \ + seek=$blocks status=none + pos=$((2 * bootsz)) +fi + +if [ "$rpmbsz" -gt 0 ]; then + echo " RPMB partition: $((rpmbsz / 1024))K" + blocks=$(( rpmbsz / (128 * 1024) )) + check_truncation "$rpmbimg" "$rpmbsz" + dd if="$rpmbimg" of="$outimg" conv=sparse bs=128K count=$blocks \ + seek=$(( pos / (128 * 1024) )) status=none + pos=$((pos + rpmbsz)) +fi + +if [ "$usersz" -lt 1024 ]; then + echo " User data: $usersz bytes" +elif [ "$usersz" -lt $((1024 * 1024)) ]; then + echo " User data: $(( (usersz + 1023) / 1024 ))K ($usersz)" +elif [ "$usersz" -lt $((1024 * 1024 * 1024)) ]; then + echo " User data: $(( (usersz + 1048575) / 1048576))M ($usersz)" +else + echo " User data: $(( (usersz + 1073741823) / 1073741824))G ($usersz)" +fi +check_truncation "$userimg" "$usersz" +dd if="$userimg" of="$outimg" conv=sparse bs=128K seek=$(( pos / (128 * 1024) )) \ + count=$(( (usersz + 128 * 1024 - 1) / (128 * 1024) )) status=none +pos=$((pos + usersz)) +truncate "$outimg" -s $pos + +echo "" +echo "Instantiate by appending to the qemu command line:" +echo " -drive file=$outimg,if=none,format=raw,id=emmc-img" +echo " -device emmc,boot-partition-size=$bootsz,rpmb-partition-size=$rpmbsz,drive=emmc-img"
Signature · 1 line
2.51.0
PATCH v4 6/6 docs: Add eMMC device model description
In reply to Jan KiszkaFrom: Jan Kiszka <[email protected]>
--- docs/system/device-emulation.rst | 1 + docs/system/devices/emmc.rst | 52 ++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 docs/system/devices/emmc.rst
docs/system/device-emulation.rst +1 -0
@@ -101,3 +101,4 @@ Emulated Devices devices/canokey.rst devices/usb-u2f.rst devices/igb.rst + devices/emmc.rst
docs/system/devices/emmc.rst new file +52 -0
52 lines not on this page · raw message
Signature · 1 line
2.51.0
Re: [PATCH v4 6/6] docs: Add eMMC device model description
Quoted 44 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Alex Bennée <[email protected]>--- docs/system/device-emulation.rst | 1 + docs/system/devices/emmc.rst | 52 ++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+)create mode 100644
docs/system/devices/emmc.rstdocs/system/device-emulation.rst +1
-0@@ -101,3 +101,4 @@ Emulated Devices devices/canokey.rst devices/usb-u2f.rst devices/igb.rst + devices/emmc.rstdocs/system/devices/emmc.rst new file +19
-0@@ -0,0 +1,52 @@ +============== +eMMC Emulation +============== + +Besides SD card emulation, QEMU also offers an eMMC model as found on many +embedded boards. An eMMC, just like an SD card, is connected to the machine +via an SDHCI controller. + +Create eMMC Images +================== + +A recent eMMC consists of 4 partitions: 2 boot partitions, 1 Replay protected +Memory Block (RPMB), and the user data area. QEMU expects backing images for +the eMMC to contain those partitions concatenated in exactly that order. +However, the boot partitions as well as the RPMB might be absent if their sizes +are configured to zero. + +The eMMC specification defines alignment constraints for the partitions. The +two boot partitions must be of the same size. Furthermore, boot and RPMB
docs/system/devices/emmc.rst line 29
Quoted 10 lines
docs/system/devices/emmc.rst new file +10
-0+partitions must be multiples of 128 KB with a maximum of 32640 KB for each +boot partition and 16384K for the RPMB partition. + +The alignment constrain of the user data area depends on its size. Up to 2 +GByte, the size must be a power of 2. From 2 GByte onward, the size has to be +multiples of 512 byte. + +QEMU is enforcing those alignment rules before instantiating the device. +Therefore, the provided image has to strictly follow them as well. The helper +script `scripts/mkemmc.sh` can be used to create compliant images, with or
the single backquote would interpret scripts/mkemmc.sh as a ref. I think you want ``scripts/mkemmc.sh``
Quoted 13 lines
docs/system/devices/emmc.rst new file +13
-0+without pre-filled partitions. E.g., to create an eMMC image from a firmware +image and an OS image with an empty 2 MByte RPMB, use the following command: + +.. code-block:: console + + scripts/mkemmc.sh -b firmware.img -r /dev/zero:2MB os.img emmc.img + +This will take care of rounding up the partition sizes to the next valid value +and will leave the RPMB and the second boot partition empty (zeroed). + +Adding eMMC Devices +=================== +
docs/system/devices/emmc.rst line 52
Quoted 10 lines
docs/system/devices/emmc.rst new file +10
-0+An eMMC is either automatically created by a machine model (e.g. Aspeed boards) +or can be user-created when using a PCI-attached SDHCI controller. To +instantiate the eMMC image from the example above while assuming that the +firmware needs a boot partitions of 1 MB, use the following options: + +.. code-block:: console + + -drive file=emmc.img,if=none,format=raw,id=emmc-img + -device sdhci-pci + -device emmc,drive=emmc-img,boot-partition-size=1048576,rpmb-partition-size=2097152
I will see if I can adjust the existing aspeed test with your proposal.
Thanks,
C.
Re: [PATCH v4 6/6] docs: Add eMMC device model description
Quoted 94 lines · Cédric Le Goater
Quoted 63 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Alex Bennée <[email protected]>---
docs/system/device-emulation.rst| 1 + docs/system/devices/emmc.rst | 52 ++++++++++++++++++++++++++++++++2 files changed, 53 insertions(+)create mode 100644
docs/system/devices/emmc.rstdocs/system/device- renamed from docs/system/device-emulation.rst +0
-0
emulation.rst
index911381643f..36429b1d17100644docs/system/device-emulation.rst +0
-0@@ -101,3 +101,4 @@ Emulated Devices
devices/canokey.rst
devices/usb-u2f.rst
devices/igb.rst
+devices/emmc.rstdocs/system/devices/emmc.rst new file +5
-0@@ -0,0 +1,52 @@ +============== +eMMC Emulation +============== + +Besides SD card emulation, QEMU also offers an eMMC model as found onmany
+embedded boards. An eMMC, just like an SD card, is connected to the machinedocs/system/devices/emmc.rst new file +6
-0+via an SDHCI controller. + +Create eMMC Images +================== + +A recent eMMC consists of 4 partitions: 2 boot partitions, 1 Replayprotected
+Memory Block (RPMB), and the user data area. QEMU expects backing images fordocs/system/devices/emmc.rst new file +2
-0+the eMMC to contain those partitions concatenated in exactly that order. +However, the boot partitions as well as the RPMB might be absent iftheir sizes
docs/system/devices/emmc.rst new file +3
-0+are configured to zero. + +The eMMC specification defines alignment constraints for thepartitions. The
docs/system/devices/emmc.rst new file +2
-0+two boot partitions must be of the same size. Furthermore, boot and RPMB +partitions must be multiples of 128 KB with a maximum of 32640 KB foreach
docs/system/devices/emmc.rst new file +3
-0+boot partition and 16384K for the RPMB partition. + +The alignment constrain of the user data area depends on its size. Upto 2
+GByte, the size must be a power of 2. From 2 GByte onward, the size has to bedocs/system/devices/emmc.rst new file +4
-0+multiples of 512 byte. + +QEMU is enforcing those alignment rules before instantiating the device. +Therefore, the provided image has to strictly follow them as well.Quoted 3 lines
The helper
+scriptscripts/mkemmc.shcan be used to create compliant images, with orthe single backquote would interpret
scripts/mkemmc.shas a ref. I think you want ``scripts/mkemmc.sh``Quoted 23 lines
+without pre-filled partitions. E.g., to create an eMMC image from a firmware
+image and an OS image with an empty 2 MByte RPMB, use the following command:docs/system/devices/emmc.rst new file +6
-0+ +.. code-block:: console + + scripts/mkemmc.sh -b firmware.img -r /dev/zero:2MB os.img emmc.img + +This will take care of rounding up the partition sizes to the nextvalid value
docs/system/devices/emmc.rst new file +6
-0+and will leave the RPMB and the second boot partition empty (zeroed). + +Adding eMMC Devices +=================== + +An eMMC is either automatically created by a machine model (e.g.Aspeed boards)
docs/system/devices/emmc.rst new file +2
-0+or can be user-created when using a PCI-attached SDHCI controller. To +instantiate the eMMC image from the example above while assuming thatthe
docs/system/devices/emmc.rst new file +2
-0+firmware needs a boot partitions of 1 MB, use the following options: +
Quoted 9 lines
Quoted 6 lines
+.. code-block:: console
+
+ -drive file=emmc.img,if=none,format=raw,id=emmc-img + -device sdhci-pci
+ -device emmc,drive=emmc-img,boot-partition-size=1048576,rpmb- partition-size=2097152I will see if I can adjust the existing aspeed test with your proposal.
Thanks in advance! Yeah, the existing alignment rules were incorrect once you turned on boot partitions. So there is unfortunately no way around fixing images that followed them.
Jan
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center
Re: [PATCH v4 6/6] docs: Add eMMC device model description
Quoted 105 lines · Jan Kiszka
Quoted 94 lines · Cédric Le Goater
Quoted 63 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Alex Bennée <[email protected]>--- docs/system/device-emulation.rst | 1 + docs/system/devices/emmc.rst | 52 ++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+)create mode 100644
docs/system/devices/emmc.rstdocs/system/device- renamed from docs/system/device-emulation.rst +0
-0
emulation.rst
index911381643f..36429b1d17100644docs/system/device-emulation.rst +1
-0@@ -101,3 +101,4 @@ Emulated Devices devices/canokey.rst devices/usb-u2f.rst devices/igb.rst + devices/emmc.rstdocs/system/devices/emmc.rst new file +5
-0@@ -0,0 +1,52 @@ +============== +eMMC Emulation +============== + +Besides SD card emulation, QEMU also offers an eMMC model as found onmany
+embedded boards. An eMMC, just like an SD card, is connected to the machinedocs/system/devices/emmc.rst new file +6
-0+via an SDHCI controller. + +Create eMMC Images +================== + +A recent eMMC consists of 4 partitions: 2 boot partitions, 1 Replayprotected
+Memory Block (RPMB), and the user data area. QEMU expects backing images fordocs/system/devices/emmc.rst new file +2
-0+the eMMC to contain those partitions concatenated in exactly that order. +However, the boot partitions as well as the RPMB might be absent iftheir sizes
docs/system/devices/emmc.rst new file +3
-0+are configured to zero. + +The eMMC specification defines alignment constraints for thepartitions. The
docs/system/devices/emmc.rst new file +2
-0+two boot partitions must be of the same size. Furthermore, boot and RPMB +partitions must be multiples of 128 KB with a maximum of 32640 KB foreach
docs/system/devices/emmc.rst new file +3
-0+boot partition and 16384K for the RPMB partition. + +The alignment constrain of the user data area depends on its size. Upto 2
+GByte, the size must be a power of 2. From 2 GByte onward, the size has to bedocs/system/devices/emmc.rst new file +4
-0+multiples of 512 byte. + +QEMU is enforcing those alignment rules before instantiating the device. +Therefore, the provided image has to strictly follow them as well.Quoted 3 lines
The helper
+scriptscripts/mkemmc.shcan be used to create compliant images, with orthe single backquote would interpret
scripts/mkemmc.shas a ref. I think you want ``scripts/mkemmc.sh``Quoted 23 lines
+without pre-filled partitions. E.g., to create an eMMC image from a firmware
+image and an OS image with an empty 2 MByte RPMB, use the following command:docs/system/devices/emmc.rst new file +6
-0+ +.. code-block:: console + + scripts/mkemmc.sh -b firmware.img -r /dev/zero:2MB os.img emmc.img + +This will take care of rounding up the partition sizes to the nextvalid value
docs/system/devices/emmc.rst new file +6
-0+and will leave the RPMB and the second boot partition empty (zeroed). + +Adding eMMC Devices +=================== + +An eMMC is either automatically created by a machine model (e.g.Aspeed boards)
docs/system/devices/emmc.rst new file +2
-0+or can be user-created when using a PCI-attached SDHCI controller. To +instantiate the eMMC image from the example above while assuming thatthe
docs/system/devices/emmc.rst new file +2
-0+firmware needs a boot partitions of 1 MB, use the following options: +Quoted 9 lines
Quoted 6 lines
+.. code-block:: console
+
+ -drive file=emmc.img,if=none,format=raw,id=emmc-img + -device sdhci-pci
+ -device emmc,drive=emmc-img,boot-partition-size=1048576,rpmb- partition-size=2097152I will see if I can adjust the existing aspeed test with your proposal.
Quoted 3 lines
Thanks in advance! Yeah, the existing alignment rules were incorrect once you turned on boot partitions. So there is unfortunately no way around fixing images that followed them.
Ideally we should generate the rainier emmc image with your script from the OpenBMC artifacts [1]. The current image is not broken by this series, so, we have time.
However, regarding this command line :
-drive file=emmc.img,if=none,format=raw,id=emmc-img
-device sdhci-pci
-device emmc,drive=emmc-img,boot-partition-size=1048576,rpmb-size=2097152a few assumptions are made.
Machines can have multiple sdhci controllers with several slots. In the, case above, the emmc device is "blindly" attached to slot 0 on a bus named "sd-bus".
Removing all QEMU internal references to "sd-bus" will require some work.
Philippe,
Should we allow automatic bus numbering :
- qbus_init(&s->sdbus, sizeof(s->sdbus), TYPE_SDHCI_BUS, DEVICE(s), "sd-bus");
+ qbus_init(&s->sdbus, sizeof(s->sdbus), TYPE_SDHCI_BUS, DEVICE(s), NULL);
and replace all :
- BusState *bus = qdev_get_child_bus(DEVICE(sdhci), "sd-bus");
+ BusState *bus = BUS(&sdhci->sdbus);
Thanks,
C.
Re: [PATCH v4 6/6] docs: Add eMMC device model description
Quoted 127 lines · Cédric Le Goater
Quoted 110 lines · Jan Kiszka
Quoted 99 lines · Cédric Le Goater
Quoted 66 lines · Jan Kiszka
From: Jan Kiszka <[email protected]>
Signed-off-by Jan Kiszka <[email protected]>Reviewed-by Alex Bennée <[email protected]>---
docs/system/device-emulation.rst| 1 + docs/system/devices/emmc.rst | 52 +++++++++++++++++++++++++++
+++++2 files changed, 53 insertions(+)create mode 100644
docs/system/devices/emmc.rstdocs/system/device- renamed from docs/system/device-emulation.rst +0
-0
emulation.rst
index911381643f..36429b1d17100644docs/system/device-emulation.rst +0
-0@@ -101,3 +101,4 @@ Emulated Devices
devices/canokey.rst
devices/usb-u2f.rst
devices/igb.rst
+devices/emmc.rstdocs/system/devices/ renamed from docs/system/devices/emmc.rst +0
-0
emmc.rst
new file mode 100644
index 0000000000..dbea6d6c7edocs/system/devices/emmc.rst new file +5
-0@@ -0,0 +1,52 @@ +============== +eMMC Emulation +============== + +Besides SD card emulation, QEMU also offers an eMMC model as found onmany
+embedded boards. An eMMC, just like an SD card, is connected to the machinedocs/system/devices/emmc.rst new file +6
-0+via an SDHCI controller. + +Create eMMC Images +================== + +A recent eMMC consists of 4 partitions: 2 boot partitions, 1 Replayprotected
+Memory Block (RPMB), and the user data area. QEMU expects backing images for
+the eMMC to contain those partitions concatenated in exactly that order.
+However, the boot partitions as well as the RPMB might be absent if their sizesdocs/system/devices/emmc.rst new file +3
-0+are configured to zero. + +The eMMC specification defines alignment constraints for thepartitions. The
+two boot partitions must be of the same size. Furthermore, boot and RPMB
+partitions must be multiples of 128 KB with a maximum of 32640 KB for eachdocs/system/devices/emmc.rst new file +3
-0+boot partition and 16384K for the RPMB partition. + +The alignment constrain of the user data area depends on its size. Upto 2
+GByte, the size must be a power of 2. From 2 GByte onward, the size has to bedocs/system/devices/emmc.rst new file +3
-0+multiples of 512 byte. + +QEMU is enforcing those alignment rules before instantiating theQuoted 5 lines
device.
+Therefore, the provided image has to strictly follow them as well. The helper
+scriptscripts/mkemmc.shcan be used to create compliant images, with orthe single backquote would interpret
scripts/mkemmc.shas a ref. I think you want ``scripts/mkemmc.sh``Quoted 23 lines
+without pre-filled partitions. E.g., to create an eMMC image from a firmware
+image and an OS image with an empty 2 MByte RPMB, use the following command:docs/system/devices/emmc.rst new file +6
-0+ +.. code-block:: console + + scripts/mkemmc.sh -b firmware.img -r /dev/zero:2MB os.img emmc.img + +This will take care of rounding up the partition sizes to the nextvalid value
docs/system/devices/emmc.rst new file +6
-0+and will leave the RPMB and the second boot partition empty (zeroed). + +Adding eMMC Devices +=================== + +An eMMC is either automatically created by a machine model (e.g.Aspeed boards)
docs/system/devices/emmc.rst new file +2
-0+or can be user-created when using a PCI-attached SDHCI controller. To +instantiate the eMMC image from the example above while assuming thatthe
docs/system/devices/emmc.rst new file +2
-0+firmware needs a boot partitions of 1 MB, use the following options: +Quoted 9 lines
Quoted 6 lines
+.. code-block:: console
+
+ -drive file=emmc.img,if=none,format=raw,id=emmc-img + -device sdhci-pci
+ -device emmc,drive=emmc-img,boot-partition-size=1048576,rpmb- partition-size=2097152I will see if I can adjust the existing aspeed test with your proposal.
Quoted 3 lines
Thanks in advance! Yeah, the existing alignment rules were incorrect once you turned on boot partitions. So there is unfortunately no way around fixing images that followed them.
Ideally we should generate the rainier emmc image with your script from the OpenBMC artifacts [1]. The current image is not broken by this series, so, we have time.
However, regarding this command line :
-drive file=emmc.img,if=none,format=raw,id=emmc-img -device sdhci-pci
-device emmc,drive=emmc-img,boot-partition-size=1048576,rpmb- size=2097152
Quoted 5 lines
a few assumptions are made.
Machines can have multiple sdhci controllers with several slots. In the, case above, the emmc device is "blindly" attached to slot 0 on a bus named "sd-bus".
If the machine has an sdhci controller already, the sdhci-pci device is not needed. I can try to make the description clearer, and maybe you can tell me what would be needed for the rainier boards, then we can have both examples there.
Quoted 3 lines
Removing all QEMU internal references to "sd-bus" will require some work.
Sure, this should rather document the current situation.
Jan
Quoted 25 lines
Philippe,
Should we allow automatic bus numbering :
-
qbus_init(&s->sdbus, sizeof(s->sdbus), TYPE_SDHCI_BUS, DEVICE(s), "sd-bus");
+qbus_init(&s->sdbus, sizeof(s->sdbus), TYPE_SDHCI_BUS, DEVICE(s), NULL);and replace all :
- BusState *bus =
qdev_get_child_bus(DEVICE(sdhci), "sd-bus"); + BusState *bus =BUS(&sdhci->sdbus);Thanks,
C.
[1] https://jenkins.openbmc.org/job/ci-openbmc/
distro=ubuntu,label=docker-builder,target=p10bmc/32112/artifact/openbmc/ build/tmp/deploy/images/p10bmc/
Signature · 2 lines
Siemens AG, Foundational Technologies Linux Expert Center