Device Model
IRI: https://w3id.org/altium/cdm/deviceModel
Models an embedded device (e.g. an MCU), which the CDM calls a digital twin: its processors; its address map with memories, registers, bit fields and their enumerated values; its peripherals with their instances, modes and configurations; and its pins and ports with the alternative functions of each port. A configured device model filters the full model to one device configuration, which in the product is edited on a hardware component in an ESD document.
In the product
- Electronic System Design (primary)
In the API
Renesas (preview) in the Altium 365 API reference: the queries, mutations and types of this bounded context.
Entities
| Name | Description |
|---|---|
| FullStackDeviceModel | A digital twin of an embedded hardware device. It exposes the full device model, including interfaces, peripherals, and ports. |
Resources
| Name | Description |
|---|---|
| AddressBlock | Address block with start, size, and optional registers and peripherals. |
| AddressMap | Address map for the device including memory and peripheral regions. |
| AddressSegment | A contiguous region of the device's memory map. Each segment can represent either a memory or a peripheral region. |
| ConfiguredDeviceModel | A digital twin of an embedded hardware device as configured for a specific use-case. It exposes the device model filtered to specific device configuration. |
| FieldEnum | An enumerated value for a register field. |
| Memory | A memory entry within an address block. |
| Peripheral | A single peripheral definition, including its instances and properties. |
| PeripheralConfiguration | A concrete configuration for a peripheral role, containing pin multiplexing details. |
| PeripheralInstance | A concrete instance of a peripheral (e.g., SCI0), including available modes. |
| PeripheralMode | A specific mode that a peripheral instance can fulfill, |
| PeripheralParameter | A parameter associated with peripheral instance configuration. |
| PeripheralPinConfig | A specific pin multiplexing configuration within peripheral configuration. |
| PeripheralPinDependencyConfig | A pin dependency to port mapping entry within peripheral configuration. |
| Pin | A physical pin on the device. |
| Port | A physical port on the device, with its functions, configurations, and connections. |
| PortConfiguration | A specific configuration for a port. |
| PortConfigurationDependency | A dependency describing how a configuration value maps to GPIO or alternate function usage. |
| PortConfigurationEnumValue | An enumerated value for a port configuration. |
| PortConnection | A connection from this port to another component or signal. |
| PortFunction | A specific function that a port can perform. |
| Processor | Represents a physical processing core. Defining endianness and clock frequency allows the system to determine if the hardware can meet the computational and data-ordering requirements of a use-case. |
| Register | A hardware register within an address block. |
| RegisterField | A bit field within a register. |
Enumerations in Bounded Context
| Enumeration | Description |
|---|---|
| Access Type | Specifies the access permissions for a register or memory region |
| Address Block Type | Specifies the type of address block within the device's memory map |
| Endianness | Specifies the byte-ordering convention of the processor |
| GPIO Mode | Defines the specific electrical and logical configuration of a pin when Port... |
| Peripheral Virtualization | Defines the virtualization model used by a peripheral interface, describing w... |
| Port Mode | Defines the primary operational mode of a physical port pin |