CDX Model Memory Access

Foreground-only access to at most eight registered model regions.

Register only model-owned storage, not peripherals or IPC buffers. The caller is responsible for pointer validity and storage lifetime. Registration is reset when the runtime is bound, not by model stepping.

Contents

Functions

Function Description
CDX_memory_region_register Register a non-overlapping model memory region during initialization.
CDX_memory_read Copy bytes from one registered region to caller-owned storage.
CDX_memory_write Copy bytes into one registered, writable model region.
CDX_memory_read_u8 Read an 8-bit scalar through address extension zero.
CDX_memory_read_u16 Read a 16-bit scalar through address extension zero.
CDX_memory_read_u32 Read a 32-bit scalar through address extension zero.
CDX_memory_read_u64 Read a 64-bit scalar through address extension zero.
CDX_memory_write_u8 Write an 8-bit scalar through address extension zero.
CDX_memory_write_u16 Write a 16-bit scalar through address extension zero.
CDX_memory_write_u32 Write a 32-bit scalar through address extension zero.
CDX_memory_write_u64 Write a 64-bit scalar through address extension zero.

Functions

CDX_memory_region_register

Register a non-overlapping model memory region during initialization.

1CDX_STATUS CDX_memory_region_register(uint32_t address, void *data, uint32_t size, int writable)

retval

  • CDX_STATUS_OK: Region registered.
  • CDX_STATUS_BAD_PARAM: Null storage, zero size, overlap or address overflow.
  • CDX_STATUS_QUEUE_FULL: All eight registration slots are in use.

Parameters

  • uint32_t address: Logical 32-bit base address exposed through this API.
  • void * data: Backing storage; must remain valid until runtime rebinding.
  • uint32_t size: Region length in bytes; must be nonzero and not overflow address.
  • int writable: Nonzero permits writes; zero makes the region read-only.

Location: cdx_memory.h:47

CDX_memory_read

Copy bytes from one registered region to caller-owned storage.

1CDX_STATUS CDX_memory_read(uint32_t address, uint8_t extension, uint32_t size, void *data)

retval

  • CDX_STATUS_OK: Bytes copied.
  • CDX_STATUS_BAD_PARAM: Unsupported extension, null data or invalid range.

Parameters

  • uint32_t address: Logical starting address of the bytes to read.
  • uint8_t extension: Address extension; only zero is supported.
  • uint32_t size: Byte count; the entire range must fit in a single region.
  • void * data: Nonnull destination with room for size bytes; overlap is permitted.

Location: cdx_memory.h:57

CDX_memory_write

Copy bytes into one registered, writable model region.

1CDX_STATUS CDX_memory_write(uint32_t address, uint8_t extension, uint32_t size, void const *data)

retval

  • CDX_STATUS_OK: Bytes copied.
  • CDX_STATUS_BAD_PARAM: Invalid extension, source, range or write permission.

Parameters

  • uint32_t address: Logical starting address of the bytes to write.
  • uint8_t extension: Address extension; only zero is supported.
  • uint32_t size: Byte count; the entire range must fit in a single region.
  • void const * data: Nonnull source containing size bytes; overlap is permitted.

Location: cdx_memory.h:67

CDX_memory_read_u8

Read an 8-bit scalar through address extension zero.

1uint8_t CDX_memory_read_u8(uint32_t address)

Returns

Native-endian value, or zero on failure; use CDX_memory_read for status.

Parameters

  • uint32_t address: Logical address in a registered region; no alignment required.

Location: cdx_memory.h:73

CDX_memory_read_u16

Read a 16-bit scalar through address extension zero.

1uint16_t CDX_memory_read_u16(uint32_t address)

Returns

Native-endian value, or zero on failure; use CDX_memory_read for status.

Parameters

  • uint32_t address: Logical address in a registered region; no alignment required.

Location: cdx_memory.h:79

CDX_memory_read_u32

Read a 32-bit scalar through address extension zero.

1uint32_t CDX_memory_read_u32(uint32_t address)

Returns

Native-endian value, or zero on failure; use CDX_memory_read for status.

Parameters

  • uint32_t address: Logical address in a registered region; no alignment required.

Location: cdx_memory.h:85

CDX_memory_read_u64

Read a 64-bit scalar through address extension zero.

1uint64_t CDX_memory_read_u64(uint32_t address)

Returns

Native-endian value, or zero on failure; use CDX_memory_read for status.

Parameters

  • uint32_t address: Logical address in a registered region; no alignment required.

Location: cdx_memory.h:91

CDX_memory_write_u8

Write an 8-bit scalar through address extension zero.

1CDX_STATUS CDX_memory_write_u8(uint32_t address, uint8_t value)

Returns

CDX_STATUS_OK on success, CDX_STATUS_BAD_PARAM on invalid range/permission.

Parameters

  • uint32_t address: Logical address in a registered writable region.
  • uint8_t value: Native-endian value to store; no alignment is required.

Location: cdx_memory.h:98

CDX_memory_write_u16

Write a 16-bit scalar through address extension zero.

1CDX_STATUS CDX_memory_write_u16(uint32_t address, uint16_t value)

Returns

CDX_STATUS_OK on success, CDX_STATUS_BAD_PARAM on invalid range/permission.

Parameters

  • uint32_t address: Logical address in a registered writable region.
  • uint16_t value: Native-endian value to store; no alignment is required.

Location: cdx_memory.h:105

CDX_memory_write_u32

Write a 32-bit scalar through address extension zero.

1CDX_STATUS CDX_memory_write_u32(uint32_t address, uint32_t value)

Returns

CDX_STATUS_OK on success, CDX_STATUS_BAD_PARAM on invalid range/permission.

Parameters

  • uint32_t address: Logical address in a registered writable region.
  • uint32_t value: Native-endian value to store; no alignment is required.

Location: cdx_memory.h:112

CDX_memory_write_u64

Write a 64-bit scalar through address extension zero.

1CDX_STATUS CDX_memory_write_u64(uint32_t address, uint64_t value)

Returns

CDX_STATUS_OK on success, CDX_STATUS_BAD_PARAM on invalid range/permission.

Parameters

  • uint32_t address: Logical address in a registered writable region.
  • uint64_t value: Native-endian value to store; no alignment is required.

Location: cdx_memory.h:119