hw/nvram: Add BCM2835 OTP device

The OTP device registers are currently stubbed. For now, the device
houses the OTP rows which will be accessed directly by other peripherals.

Signed-off-by: Rayhan Faizel <rayhan.faizel@gmail.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This commit is contained in:
Rayhan Faizel 2024-05-19 15:11:04 +05:30 committed by Peter Maydell
parent b6d32a06fc
commit c1bf754041
3 changed files with 256 additions and 0 deletions

187
hw/nvram/bcm2835_otp.c Normal file
View File

@ -0,0 +1,187 @@
/*
* BCM2835 One-Time Programmable (OTP) Memory
*
* The OTP implementation is mostly a stub except for the OTP rows
* which are accessed directly by other peripherals such as the mailbox.
*
* The OTP registers are unimplemented due to lack of documentation.
*
* Copyright (c) 2024 Rayhan Faizel <rayhan.faizel@gmail.com>
*
* SPDX-License-Identifier: MIT
*/
#include "qemu/osdep.h"
#include "qemu/log.h"
#include "hw/nvram/bcm2835_otp.h"
#include "migration/vmstate.h"
/* OTP rows are 1-indexed */
uint32_t bcm2835_otp_get_row(BCM2835OTPState *s, unsigned int row)
{
assert(row <= BCM2835_OTP_ROW_COUNT && row >= 1);
return s->otp_rows[row - 1];
}
void bcm2835_otp_set_row(BCM2835OTPState *s, unsigned int row,
uint32_t value)
{
assert(row <= BCM2835_OTP_ROW_COUNT && row >= 1);
/* Real OTP rows work as e-fuses */
s->otp_rows[row - 1] |= value;
}
static uint64_t bcm2835_otp_read(void *opaque, hwaddr addr, unsigned size)
{
switch (addr) {
case BCM2835_OTP_BOOTMODE_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_BOOTMODE_REG\n");
break;
case BCM2835_OTP_CONFIG_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_CONFIG_REG\n");
break;
case BCM2835_OTP_CTRL_LO_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_CTRL_LO_REG\n");
break;
case BCM2835_OTP_CTRL_HI_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_CTRL_HI_REG\n");
break;
case BCM2835_OTP_STATUS_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_STATUS_REG\n");
break;
case BCM2835_OTP_BITSEL_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_BITSEL_REG\n");
break;
case BCM2835_OTP_DATA_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_DATA_REG\n");
break;
case BCM2835_OTP_ADDR_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_ADDR_REG\n");
break;
case BCM2835_OTP_WRITE_DATA_READ_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_WRITE_DATA_READ_REG\n");
break;
case BCM2835_OTP_INIT_STATUS_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_INIT_STATUS_REG\n");
break;
default:
qemu_log_mask(LOG_GUEST_ERROR,
"%s: Bad offset 0x%" HWADDR_PRIx "\n", __func__, addr);
}
return 0;
}
static void bcm2835_otp_write(void *opaque, hwaddr addr,
uint64_t value, unsigned int size)
{
switch (addr) {
case BCM2835_OTP_BOOTMODE_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_BOOTMODE_REG\n");
break;
case BCM2835_OTP_CONFIG_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_CONFIG_REG\n");
break;
case BCM2835_OTP_CTRL_LO_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_CTRL_LO_REG\n");
break;
case BCM2835_OTP_CTRL_HI_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_CTRL_HI_REG\n");
break;
case BCM2835_OTP_STATUS_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_STATUS_REG\n");
break;
case BCM2835_OTP_BITSEL_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_BITSEL_REG\n");
break;
case BCM2835_OTP_DATA_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_DATA_REG\n");
break;
case BCM2835_OTP_ADDR_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_ADDR_REG\n");
break;
case BCM2835_OTP_WRITE_DATA_READ_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_WRITE_DATA_READ_REG\n");
break;
case BCM2835_OTP_INIT_STATUS_REG:
qemu_log_mask(LOG_UNIMP,
"bcm2835_otp: BCM2835_OTP_INIT_STATUS_REG\n");
break;
default:
qemu_log_mask(LOG_GUEST_ERROR,
"%s: Bad offset 0x%" HWADDR_PRIx "\n", __func__, addr);
}
}
static const MemoryRegionOps bcm2835_otp_ops = {
.read = bcm2835_otp_read,
.write = bcm2835_otp_write,
.endianness = DEVICE_NATIVE_ENDIAN,
.impl = {
.min_access_size = 4,
.max_access_size = 4,
},
};
static void bcm2835_otp_realize(DeviceState *dev, Error **errp)
{
BCM2835OTPState *s = BCM2835_OTP(dev);
memory_region_init_io(&s->iomem, OBJECT(dev), &bcm2835_otp_ops, s,
TYPE_BCM2835_OTP, 0x80);
sysbus_init_mmio(SYS_BUS_DEVICE(dev), &s->iomem);
memset(s->otp_rows, 0x00, sizeof(s->otp_rows));
}
static const VMStateDescription vmstate_bcm2835_otp = {
.name = TYPE_BCM2835_OTP,
.version_id = 1,
.minimum_version_id = 1,
.fields = (const VMStateField[]) {
VMSTATE_UINT32_ARRAY(otp_rows, BCM2835OTPState, BCM2835_OTP_ROW_COUNT),
VMSTATE_END_OF_LIST()
}
};
static void bcm2835_otp_class_init(ObjectClass *klass, void *data)
{
DeviceClass *dc = DEVICE_CLASS(klass);
dc->realize = bcm2835_otp_realize;
dc->vmsd = &vmstate_bcm2835_otp;
}
static const TypeInfo bcm2835_otp_info = {
.name = TYPE_BCM2835_OTP,
.parent = TYPE_SYS_BUS_DEVICE,
.instance_size = sizeof(BCM2835OTPState),
.class_init = bcm2835_otp_class_init,
};
static void bcm2835_otp_register_types(void)
{
type_register_static(&bcm2835_otp_info);
}
type_init(bcm2835_otp_register_types)

View File

@ -1,5 +1,6 @@
system_ss.add(files('fw_cfg-interface.c'))
system_ss.add(files('fw_cfg.c'))
system_ss.add(when: 'CONFIG_RASPI', if_true: files('bcm2835_otp.c'))
system_ss.add(when: 'CONFIG_CHRP_NVRAM', if_true: files('chrp_nvram.c'))
system_ss.add(when: 'CONFIG_DS1225Y', if_true: files('ds1225y.c'))
system_ss.add(when: 'CONFIG_NMC93XX_EEPROM', if_true: files('eeprom93xx.c'))

View File

@ -0,0 +1,68 @@
/*
* BCM2835 One-Time Programmable (OTP) Memory
*
* Copyright (c) 2024 Rayhan Faizel <rayhan.faizel@gmail.com>
*
* SPDX-License-Identifier: MIT
*/
#ifndef BCM2835_OTP_H
#define BCM2835_OTP_H
#include "hw/sysbus.h"
#include "qom/object.h"
#define TYPE_BCM2835_OTP "bcm2835-otp"
OBJECT_DECLARE_SIMPLE_TYPE(BCM2835OTPState, BCM2835_OTP)
#define BCM2835_OTP_ROW_COUNT 66
/* https://elinux.org/BCM2835_registers#OTP */
#define BCM2835_OTP_BOOTMODE_REG 0x00
#define BCM2835_OTP_CONFIG_REG 0x04
#define BCM2835_OTP_CTRL_LO_REG 0x08
#define BCM2835_OTP_CTRL_HI_REG 0x0c
#define BCM2835_OTP_STATUS_REG 0x10
#define BCM2835_OTP_BITSEL_REG 0x14
#define BCM2835_OTP_DATA_REG 0x18
#define BCM2835_OTP_ADDR_REG 0x1c
#define BCM2835_OTP_WRITE_DATA_READ_REG 0x20
#define BCM2835_OTP_INIT_STATUS_REG 0x24
/* -- Row 32: Undocumented -- */
#define BCM2835_OTP_ROW_32 32
/* Lock OTP Programming (Customer OTP and private key) */
#define BCM2835_OTP_ROW_32_LOCK BIT(6)
/* -- Row 36-43: Customer OTP -- */
#define BCM2835_OTP_CUSTOMER_OTP 36
#define BCM2835_OTP_CUSTOMER_OTP_LEN 8
/* Magic numbers to lock programming of customer OTP and private key */
#define BCM2835_OTP_LOCK_NUM1 0xffffffff
#define BCM2835_OTP_LOCK_NUM2 0xaffe0000
/* -- Row 56-63: Device-specific private key -- */
#define BCM2835_OTP_PRIVATE_KEY 56
#define BCM2835_OTP_PRIVATE_KEY_LEN 8
struct BCM2835OTPState {
/* <private> */
SysBusDevice parent_obj;
/* <public> */
MemoryRegion iomem;
uint32_t otp_rows[BCM2835_OTP_ROW_COUNT];
};
uint32_t bcm2835_otp_get_row(BCM2835OTPState *s, unsigned int row);
void bcm2835_otp_set_row(BCM2835OTPState *s, unsigned int row, uint32_t value);
#endif