Add file-backed and write-once features to OTP
Subsystems (2)
v3 cover Add file-backed and write-once features to OTP
First patch is to add file-backed implementation to allow users to use '-drive' to assign an OTP raw image file. OTP image file must be bigger than 16K.
For example, '-drive if=none,format=raw,file=otp.img'
Second patch is to add 'write-once' feature to block second write to the OTP memory. Only keep the 'written' state for non-control register range from 0x38 to 16KB.
Tested on sifive_u for both qemu and u-boot.
Green Wan (2):
hw/riscv: sifive_u: Add backend drive support
hw/riscv: sifive_u: Add write-once protection.
hw/riscv/sifive_u_otp.c | 71 +++++++++++++++++++++++++++++++++ include/hw/riscv/sifive_u_otp.h | 3 ++ 2 files changed, 74 insertions(+)
Signature · 1 line
2.17.1
RFC PATCH v3 1/2 hw/riscv: sifive_u: Add backend drive support
Add '-drive' support to OTP device. Allow users to assign a raw file as OTP image.
--- hw/riscv/sifive_u_otp.c | 50 +++++++++++++++++++++++++++++++++ include/hw/riscv/sifive_u_otp.h | 2 ++ 2 files changed, 52 insertions(+)
hw/riscv/sifive_u_otp.c +50 -0
@@ -24,6 +24,8 @@#include "qemu/log.h" #include "qemu/module.h" #include "hw/riscv/sifive_u_otp.h" +#include "sysemu/blockdev.h" +#include "sysemu/block-backend.h" static uint64_t sifive_u_otp_read (void *opaque,hwaddr addr,unsigned int size) {
@@ -46,6 +48,16 @@ static uint64_t sifive_u_otp_read(void *opaque, hwaddr addr, unsigned int size)if ((s->pce &SIFIVE_U_OTP_PCE_EN ) && (s->pdstb &SIFIVE_U_OTP_PDSTB_EN ) && (s->ptrim &SIFIVE_U_OTP_PTRIM_EN )) { + +/* read from backend*/ +if (s->blk) { +int32_t buf; + +blk_pread (s->blk, s->pa *SIFIVE_U_OTP_FUSE_WORD , &buf, +SIFIVE_U_OTP_FUSE_WORD ); +return buf; + } +return s->fuse[s->pa &SIFIVE_U_OTP_PA_MASK ]; }else {return 0xff ;
@@ -123,6 +135,12 @@ static void sifive_u_otp_write(void *opaque, hwaddr addr, s->ptrim = val32;break ;case SIFIVE_U_OTP_PWE : +/* write to backend */ +if (s->blk) { +blk_pwrite (s->blk, s->pa *SIFIVE_U_OTP_FUSE_WORD , &val32, +SIFIVE_U_OTP_FUSE_WORD ,0 ); + } + s->pwe = val32;break ;default :
@@ -143,16 +161,48 @@ static const MemoryRegionOps sifive_u_otp_ops = {static Property sifive_u_otp_properties[] = {DEFINE_PROP_UINT32 ("serial" , SiFiveUOTPState, serial,0 ), +DEFINE_PROP_DRIVE ("drive" , SiFiveUOTPState, blk),DEFINE_PROP_END_OF_LIST (), };static void sifive_u_otp_realize (DeviceState *dev,Error **errp) {SiFiveUOTPState *s =SIFIVE_U_OTP (dev); +DriveInfo *dinfo;memory_region_init_io (&s->mmio,OBJECT (dev), &sifive_u_otp_ops, s,TYPE_SIFIVE_U_OTP ,SIFIVE_U_OTP_REG_SIZE );sysbus_init_mmio (SYS_BUS_DEVICE (dev), &s->mmio); + + dinfo =drive_get_next (IF_NONE ); +if (dinfo) { +int ret; +uint64_t perm; +int filesize; +BlockBackend *blk; + + blk =blk_by_legacy_dinfo (dinfo); + filesize =SIFIVE_U_OTP_NUM_FUSES *SIFIVE_U_OTP_FUSE_WORD ; +if (blk_getlength (blk) < filesize) { +qemu_log_mask (LOG_GUEST_ERROR ,"OTP drive size < 16K\n" ); +return ; + } + +qdev_prop_set_drive (dev,"drive" ,blk_by_legacy_dinfo (dinfo)); + + perm =BLK_PERM_CONSISTENT_READ | + (blk_is_read_only (s->blk) ?0 :BLK_PERM_WRITE ); + ret =blk_set_perm (s->blk, perm,BLK_PERM_ALL , errp); +if (ret <0 ) { +qemu_log_mask (LOG_GUEST_ERROR ,"set perm error." ); + } + +if (blk_pread (s->blk,0 , s->fuse, filesize) != filesize) { +qemu_log_mask (LOG_GUEST_ERROR , +"failed to read the initial flash content" ); +return ; + } + } }static void sifive_u_otp_reset (DeviceState *dev)
include/hw/riscv/sifive_u_otp.h +2 -0
@@ -43,6 +43,7 @@#define SIFIVE_U_OTP_PA_MASK 0xfff#define SIFIVE_U_OTP_NUM_FUSES 0x1000 +#define SIFIVE_U_OTP_FUSE_WORD 4#define SIFIVE_U_OTP_SERIAL_ADDR 0xfc#define SIFIVE_U_OTP_REG_SIZE 0x1000
@@ -75,6 +76,7 @@ typedef struct SiFiveUOTPState {uint32_t fuse[SIFIVE_U_OTP_NUM_FUSES ];/* config */ uint32_t serial; + BlockBackend *blk; } SiFiveUOTPState;#endif /* HW_SIFIVE_U_OTP_H */
Signature · 1 line
2.17.1
Re: [RFC PATCH v3 1/2] hw/riscv: sifive_u: Add backend drive support
Quoted 24 lines · Green Wan
Add '-drive' support to OTP device. Allow users to assign a raw file as OTP image.
Signed-off-by Green Wan <[email protected]>--- hw/riscv/sifive_u_otp.c | 50 +++++++++++++++++++++++++++++++++ include/hw/riscv/sifive_u_otp.h | 2 ++ 2 files changed, 52 insertions(+)hw/riscv/sifive_u_otp.c +2
-0@@ -24,6 +24,8 @@#include "qemu/log.h" #include "qemu/module.h" #include "hw/riscv/sifive_u_otp.h" +#include "sysemu/blockdev.h" +#include "sysemu/block-backend.h" static uint64_t sifive_u_otp_read (void *opaque,hwaddr addr,unsigned int size) {
hw/riscv/sifive_u_otp.c static uint64_t sifive_u_otp_read(void *opaque, hwaddr addr, unsigned int size) · line 52
Quoted 5 lines
hw/riscv/sifive_u_otp.c +2
-0@@ -46,6 +48,16 @@ static uint64_t sifive_u_otp_read(void *opaque, hwaddr addr, unsigned int size)if ((s->pce &SIFIVE_U_OTP_PCE_EN ) && (s->pdstb &SIFIVE_U_OTP_PDSTB_EN ) && (s->ptrim &SIFIVE_U_OTP_PTRIM_EN )) { + +/* read from backend*/
nits: need a space before */
Quoted 37 lines
hw/riscv/sifive_u_otp.c +16
-0+if (s->blk) { +int32_t buf; + +blk_pread (s->blk, s->pa *SIFIVE_U_OTP_FUSE_WORD , &buf, +SIFIVE_U_OTP_FUSE_WORD ); +return buf; + } +return s->fuse[s->pa &SIFIVE_U_OTP_PA_MASK ]; }else {return 0xff ;@@ -123,6 +135,12 @@ static void sifive_u_otp_write(void *opaque, hwaddr addr, s->ptrim = val32;break ;case SIFIVE_U_OTP_PWE : +/* write to backend */ +if (s->blk) { +blk_pwrite (s->blk, s->pa *SIFIVE_U_OTP_FUSE_WORD , &val32, +SIFIVE_U_OTP_FUSE_WORD ,0 ); + } + s->pwe = val32;break ;default :@@ -143,16 +161,48 @@ static const MemoryRegionOps sifive_u_otp_ops = {static Property sifive_u_otp_properties[] = {DEFINE_PROP_UINT32 ("serial" , SiFiveUOTPState, serial,0 ), +DEFINE_PROP_DRIVE ("drive" , SiFiveUOTPState, blk),DEFINE_PROP_END_OF_LIST (), };static void sifive_u_otp_realize (DeviceState *dev,Error **errp) {SiFiveUOTPState *s =SIFIVE_U_OTP (dev); +DriveInfo *dinfo;
hw/riscv/sifive_u_otp.c static const MemoryRegionOps sifive_u_otp_ops = { · line 182
Quoted 10 lines
hw/riscv/sifive_u_otp.c +7
-0memory_region_init_io (&s->mmio,OBJECT (dev), &sifive_u_otp_ops, s,TYPE_SIFIVE_U_OTP ,SIFIVE_U_OTP_REG_SIZE );sysbus_init_mmio (SYS_BUS_DEVICE (dev), &s->mmio); + + dinfo =drive_get_next (IF_NONE ); +if (dinfo) { +int ret; +uint64_t perm; +int filesize; +BlockBackend *blk;
nits: keep one space in between
hw/riscv/sifive_u_otp.c static const MemoryRegionOps sifive_u_otp_ops = { · line 191
Quoted 9 lines
hw/riscv/sifive_u_otp.c +9
-0+ + blk =blk_by_legacy_dinfo (dinfo); + filesize =SIFIVE_U_OTP_NUM_FUSES *SIFIVE_U_OTP_FUSE_WORD ; +if (blk_getlength (blk) < filesize) { +qemu_log_mask (LOG_GUEST_ERROR ,"OTP drive size < 16K\n" ); +return ; + } + +qdev_prop_set_drive (dev,"drive" ,blk_by_legacy_dinfo (dinfo));
Use blk for blk_by_legacy_dinfo(dinfo)
Quoted 30 lines
hw/riscv/sifive_u_otp.c +14
-0+ + perm =BLK_PERM_CONSISTENT_READ | + (blk_is_read_only (s->blk) ?0 :BLK_PERM_WRITE ); + ret =blk_set_perm (s->blk, perm,BLK_PERM_ALL , errp); +if (ret <0 ) { +qemu_log_mask (LOG_GUEST_ERROR ,"set perm error." ); + } + +if (blk_pread (s->blk,0 , s->fuse, filesize) != filesize) { +qemu_log_mask (LOG_GUEST_ERROR , +"failed to read the initial flash content" ); +return ; + } + } }static void sifive_u_otp_reset (DeviceState *dev)include/hw/riscv/sifive_u_otp.h +1
-0@@ -43,6 +43,7 @@#define SIFIVE_U_OTP_PA_MASK 0xfff#define SIFIVE_U_OTP_NUM_FUSES 0x1000 +#define SIFIVE_U_OTP_FUSE_WORD 4#define SIFIVE_U_OTP_SERIAL_ADDR 0xfc#define SIFIVE_U_OTP_REG_SIZE 0x1000
include/hw/riscv/sifive_u_otp.h typedef struct SiFiveUOTPState { · line 79
Quoted 4 lines
include/hw/riscv/sifive_u_otp.h +1
-0@@ -75,6 +76,7 @@ typedef struct SiFiveUOTPState {uint32_t fuse[SIFIVE_U_OTP_NUM_FUSES ];/* config */ uint32_t serial; +BlockBackend *blk;
nits: keep one space in between
include/hw/riscv/sifive_u_otp.h typedef struct SiFiveUOTPState {
Quoted 4 lines
include/hw/riscv/sifive_u_otp.h +0
-1} SiFiveUOTPState;#endif /* HW_SIFIVE_U_OTP_H */ --
Regards,
Bin
RFC PATCH v3 2/2 hw/riscv: sifive_u: Add write-once protection.
In reply to Green WanAdd array to store the 'written' status for all bit of OTP to block the write operation to the same bit. Ignore the control register offset from 0x0 to 0x38 of OTP memory mapping.
--- hw/riscv/sifive_u_otp.c | 21 +++++++++++++++++++++ include/hw/riscv/sifive_u_otp.h | 1 + 2 files changed, 22 insertions(+)
hw/riscv/sifive_u_otp.c +21 -0
@@ -27,6 +27,12 @@#include "sysemu/blockdev.h" #include "sysemu/block-backend.h" +#define SET_WRITTEN_BIT (map, idx, bit) \ + (map[idx] |= (0x1 << bit)) + +#define GET_WRITTEN_BIT (map, idx, bit) \ + ((map[idx] >> bit) & 0x1) +static uint64_t sifive_u_otp_read (void *opaque,hwaddr addr,unsigned int size) {SiFiveUOTPState *s = opaque;
@@ -135,6 +141,18 @@ static void sifive_u_otp_write(void *opaque, hwaddr addr, s->ptrim = val32;break ;case SIFIVE_U_OTP_PWE : +/* Keep written state for data only and PWE is enabled. Ignore PAS=1 */ +if ((s->pa >SIFIVE_U_OTP_PWE ) && (val32 &0x1 ) && !s->pas) { +if (GET_WRITTEN_BIT (s->fuse_wo, s->pa, s->paio)) { +qemu_log_mask (LOG_GUEST_ERROR , +"Error: write idx<%u>, bit<%u>\n" , + s->pa, s->paio); +break ; + }else { +SET_WRITTEN_BIT (s->fuse_wo, s->pa, s->paio); + } + } +/* write to backend */ if (s->blk) { blk_pwrite(s->blk, s->pa * SIFIVE_U_OTP_FUSE_WORD, &val32,
@@ -215,6 +233,9 @@ static void sifive_u_otp_reset(DeviceState *dev)/* Make a valid content of serial number */ s->fuse[SIFIVE_U_OTP_SERIAL_ADDR ] = s->serial; s->fuse[SIFIVE_U_OTP_SERIAL_ADDR +1 ] = ~(s->serial); + +/* Initialize write-once map */ +memset (s->fuse_wo,0x00 ,sizeof (s->fuse_wo)); }static void sifive_u_otp_class_init (ObjectClass *klass,void *data)
include/hw/riscv/sifive_u_otp.h +1 -0
@@ -74,6 +74,7 @@ typedef struct SiFiveUOTPState {uint32_t ptrim;uint32_t pwe;uint32_t fuse[SIFIVE_U_OTP_NUM_FUSES ]; +uint32_t fuse_wo[SIFIVE_U_OTP_NUM_FUSES ];/* config */ uint32_t serial;BlockBackend *blk;
Signature · 1 line
2.17.1
Re: [RFC PATCH v3 2/2] hw/riscv: sifive_u: Add write-once protection.
Quoted 4 lines · Green Wan
Add array to store the 'written' status for all bit of OTP to block the write operation to the same bit. Ignore the control register offset from
0x0to0x38of OTP memory mapping.
nits: please remove the ending period in the commit title
Quoted 27 lines
Signed-off-by Green Wan <[email protected]>--- hw/riscv/sifive_u_otp.c | 21 +++++++++++++++++++++ include/hw/riscv/sifive_u_otp.h | 1 + 2 files changed, 22 insertions(+)hw/riscv/sifive_u_otp.c +6
-0@@ -27,6 +27,12 @@#include "sysemu/blockdev.h" #include "sysemu/block-backend.h" +#define SET_WRITTEN_BIT (map, idx, bit) \ + (map[idx] |= (0x1 << bit)) + +#define GET_WRITTEN_BIT (map, idx, bit) \ + ((map[idx] >> bit) & 0x1) +static uint64_t sifive_u_otp_read (void *opaque,hwaddr addr,unsigned int size) {SiFiveUOTPState *s = opaque;@@ -135,6 +141,18 @@ static void sifive_u_otp_write(void *opaque, hwaddr addr, s->ptrim = val32;break ;
hw/riscv/sifive_u_otp.c static void sifive_u_otp_write(void *opaque, hwaddr addr, · line 152
Quoted 10 lines
hw/riscv/sifive_u_otp.c +9
-0case SIFIVE_U_OTP_PWE : +/* Keep written state for data only and PWE is enabled. Ignore PAS=1 */ +if ((s->pa >SIFIVE_U_OTP_PWE ) && (val32 &0x1 ) && !s->pas) { +if (GET_WRITTEN_BIT (s->fuse_wo, s->pa, s->paio)) { +qemu_log_mask (LOG_GUEST_ERROR , +"Error: write idx<%u>, bit<%u>\n" , + s->pa, s->paio); +break ; + }else { +SET_WRITTEN_BIT (s->fuse_wo, s->pa, s->paio);
Shouldn't the write operation below be moved to this else branch?
Quoted 21 lines
hw/riscv/sifive_u_otp.c +6
-0+ } + } +/* write to backend */ if (s->blk) { blk_pwrite(s->blk, s->pa * SIFIVE_U_OTP_FUSE_WORD, &val32,@@ -215,6 +233,9 @@ static void sifive_u_otp_reset(DeviceState *dev)/* Make a valid content of serial number */ s->fuse[SIFIVE_U_OTP_SERIAL_ADDR ] = s->serial; s->fuse[SIFIVE_U_OTP_SERIAL_ADDR +1 ] = ~(s->serial); + +/* Initialize write-once map */ +memset (s->fuse_wo,0x00 ,sizeof (s->fuse_wo)); }static void sifive_u_otp_class_init (ObjectClass *klass,void *data)include/hw/riscv/sifive_u_otp.h +0
-0
include/hw/riscv/sifive_u_otp.h typedef struct SiFiveUOTPState {
Quoted 8 lines
include/hw/riscv/sifive_u_otp.h +1
-1@@ -74,6 +74,7 @@ typedef struct SiFiveUOTPState {uint32_t ptrim;uint32_t pwe;uint32_t fuse[SIFIVE_U_OTP_NUM_FUSES ]; +uint32_t fuse_wo[SIFIVE_U_OTP_NUM_FUSES ];/* config */ uint32_t serial;BlockBackend *blk; --
Regards,
Bin