Register Map

Register Map

Hardware register and OTP fuse map table for SDK and BSP documentation

Installation

npx @ravikumarsurya/mdx-ui add register-map

Usage

import { RegisterMap } from "@/components/mdx/register-map";
 
<RegisterMap
  rows={[
    {
      address: "0x00780000",
      name: "QFPROM_CORR_RD_WR_PERM_LSB",
      bits: "31:0",
      access: "OTP",
      reset: "0x00000000",
      description: "Read/write permissions for fuse rows.",
    },
    {
      address: "0x00780008",
      name: "QFPROM_CORR_JTAG_ID",
      bits: "31:0",
      access: "RO",
      reset: "0x009600E1",
      description: "JTAG identification register.",
    },
  ]}
/>;

Examples

Security Control Registers
AddressRegisterBitsAccessResetDescription
0x00780000QFPROM_CORR_RD_WR_PERM_LSB31:0OTP0x00000000Read/write permissions for fuse rows.
0x00780008QFPROM_CORR_JTAG_ID31:0RO0x009600E1JTAG identification register.
0x00780018USB_PHY_CFG07:0RW0x80PHY configuration register 0.

QFPROM fuse map with title

<RegisterMap
  title="QFPROM Fuse Map — Security Control"
  rows={[
    {
      address: "0x00780000",
      name: "QFPROM_CORR_RD_WR_PERM_LSB",
      bits: "31:0",
      access: "OTP",
      reset: "0x00000000",
      description: "Read/write permissions for fuse rows.",
    },
    {
      address: "0x00780008",
      name: "QFPROM_CORR_JTAG_ID",
      bits: "31:0",
      access: "RO",
      reset: "0x009600E1",
      description: "JTAG identification register.",
    },
    {
      address: "0x00780018",
      name: "QFPROM_CORR_FEAT_CONFIG_ROW0_LSB",
      bits: "31:0",
      access: "OTP",
      reset: "0x00000000",
      description: "Feature configuration fuse row 0.",
    },
  ]}
  caption="Source: Qualcomm QFPROM Interface Control Document"
/>

CSR table without addresses

<RegisterMap
  title="USB PHY Control Registers"
  rows={[
    {
      name: "USB_PHY_CFG0",
      bits: "31:0",
      access: "RW",
      reset: "0x80000000",
      description: "PHY configuration register 0.",
    },
    {
      name: "USB_PHY_STATUS",
      bits: "31:0",
      access: "RO",
      description: "PHY status flags — read-only.",
    },
    {
      name: "USB_PHY_CTRL",
      bits: "7:0",
      access: "RW",
      reset: "0x00",
      description: "Enable and reset control bits.",
    },
  ]}
/>

Access type reference

AccessColourMeaning
ROSkyRead-only
WOVioletWrite-only
RWGreenRead/write
OTPAmberOne-time programmable (irreversible)
RCRoseRead and clear

Props

RegisterMap

PropTypeDefaultDescription
titlestringOptional section title shown in the card header
rowsRegisterRow[]Array of register rows (required)
captionstringOptional caption below the table
classNamestringAdditional CSS classes

RegisterRow

FieldTypeDescription
namestringRegister or fuse name (required)
addressstringMemory-mapped address in hex, e.g. "0x00780000"
bitsstringBit field range, e.g. "31:0" or "7:0"
access"RO" | "WO" | "RW" | "OTP" | "RC"Access type
resetstringReset or default value in hex
descriptionstringHuman-readable description