SongYZZZ/moon-firmware/model

README
U
AddressRange
U
AsciiSpan
U
ByteOrder
U
CheckLevel
U
ChecksumStatus
U
ConversionResult
U
ConvertOptions
U
CortexMReleaseOptions
U
CortexMReleaseReport
U
CortexMVectorTable
U
Diagnostic
U
EntryPoint
U
EntryPolicy
U
ErrorCode
U
FirmwareDiff
U
FirmwareError
U
FirmwareImage
U
FlashOptions
U
FlashPage
U
FlashPlan
U
Format
U
ImageChecksum
U
ImageChecksumAlgorithm
U
ImageStatistics
U
LayoutIssue
U
LayoutOptions
U
LayoutReport
U
LayoutRule
U
MaskedPattern
U
MemoryMap
U
MemoryRegion
U
MemorySegment
U
Metadata
U
OverlapPolicy
U
ParseMode
U
ParseOptions
U
ReleaseIssue
U
ReleaseRule
V
checksum_image
V
convert
V
detect_format
V
diff_images
V
encode_uint
V
extract_range
V
fill_range
V
find_ascii_strings
V
find_pattern
V
find_uint
V
inspect_cortex_m_vectors
V
inspect_image
V
load_firmware
V
merge_images
V
parse_intel_hex
V
parse_srecord
V
plan_flash_pages
V
read_uint
V
relocate
V
remove_range
V
validate_cortex_m_release
V
validate_layout
V
write_intel_hex
V
write_srecord
V
write_uint

SongYZZZ/moon-firmware/model does not have a README file

FirmwareError

pub(all) suberror FirmwareError {
  FirmwareError(Diagnostic)
} derive(@moonbitlang/core/debug.Debug
Debug)

Library failures always carry a structured diagnostic.

AddressRange

source

pub struct AddressRange {
  start : Int64
  end : Int64
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Half-open [start, end) interval. End may equal 2^32; start must be smaller.

AddressRange::contains

source

fn AddressRange::contains(self : AddressRange, address : Int64) -> Bool

Test membership using an exclusive upper bound.

AddressRange::inclusive

source

fn AddressRange::inclusive(start : Int64, last : Int64) -> AddressRange raise FirmwareError

Convert an inclusive user-facing range to the library's half-open model.

AddressRange::intersection

source

fn AddressRange::intersection(self : AddressRange, other : AddressRange) -> AddressRange?

A nonempty intersection, or None for disjoint/touching intervals.

AddressRange::is_empty

source

fn AddressRange::is_empty(self : AddressRange) -> Bool

Empty intervals contain no addresses.

AddressRange::length

source

fn AddressRange::length(self : AddressRange) -> Int64

Number of addresses in the interval, without narrowing to machine Int.

AddressRange::new

source

fn AddressRange::new(start : Int64, end : Int64) -> AddressRange raise FirmwareError

Construct a checked interval. Empty intervals are legal.

AddressRange::render

source

fn AddressRange::render(self : AddressRange) -> String

Display a nonempty interval with inclusive endpoints for firmware tools.

AddressRange::shift

source

fn AddressRange::shift(self : AddressRange, delta : Int64) -> AddressRange raise FirmwareError

Checked relocation of a range, useful for bootloader image rebasing.

AddressRange::subtract

source

fn AddressRange::subtract(self : AddressRange, other : AddressRange) -> Array[AddressRange]

Split around an intersection, retaining the two possible outer intervals.

ChecksumStatus

source

pub(all) enum ChecksumStatus {
  Verified
  NotApplicable
  Derived
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Provenance survives decoding. Checksums describe source records, not hashes.

Diagnostic

source

pub(all) struct Diagnostic {
  code : ErrorCode
  format : Format
  line : Int
  column : Int
  record_type : Int?
  address : Int64?
  end_address : Int64?
  message : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Diagnostic locations are one-based; zero means not tied to a text line.

Diagnostic::render

source

fn Diagnostic::render(self : Diagnostic) -> String

Render diagnostic text without losing structured address information.

EntryPoint

source

pub(all) enum EntryPoint {
  Linear(Int64)
  Segment(Int, Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Preserve segmented execution state instead of silently flattening CS:IP.

EntryPoint::address

source

fn EntryPoint::address(self : EntryPoint) -> Int64 raise FirmwareError

Validated execution address in the same address space as payload.

ErrorCode

source

pub(all) enum ErrorCode {
  InvalidDigit
  InvalidLength
  InvalidRecord
  UnsupportedRecord
  ChecksumMismatch
  MissingTerminator
  AfterTerminator
  DuplicateRecord
  CountMismatch
  AddressOverflow
  InvalidRange
  AddressConflict
  GapRequiresFill
  ResourceLimit
  InvalidOption
  UnknownFormat
  EntryConflict
  Io
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Machine-readable failure categories; messages add context, not identity.

FirmwareImage

source

pub(all) struct FirmwareImage {
  memory : MemoryMap
  entry : EntryPoint?
  metadata : Metadata
  warnings : Array[Diagnostic]
}

An owned sparse map, optional entry point, source metadata and warnings.

FirmwareImage::copy

source

fn FirmwareImage::copy(self : FirmwareImage) -> FirmwareImage

Deep-copy mutable state, including metadata counters and diagnostics array.

FirmwareImage::from_binary

source

fn FirmwareImage::from_binary(bytes : Bytes, base_address : Int64) -> FirmwareImage raise FirmwareError

Construct a raw binary image with explicit placement.

FirmwareImage::new

source

fn FirmwareImage::new() -> FirmwareImage

Empty image with unknown origin.

FirmwareImage::semantic_equal

source

fn FirmwareImage::semantic_equal(self : FirmwareImage, other : FirmwareImage) -> Bool

Compare memory and exact execution state, ignoring serialization metadata.

Format

source

pub(all) enum Format {
  IntelHex
  SRecord
  RawBinary
  Unknown
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The wire format or origin of an image.

Format::label

source

fn Format::label(self : Format) -> String

Human-readable name independent of enum debugging syntax.

MemoryMap

source

pub struct MemoryMap {
  // private fields
}

Sorted, nonempty, disjoint and nonadjacent segments. No allocation for gaps.

MemoryMap::bounds

source

fn MemoryMap::bounds(self : MemoryMap) -> AddressRange?

Span including internal gaps; empty maps have no bounds.

MemoryMap::contains

source

fn MemoryMap::contains(self : MemoryMap, address : Int64) -> Bool

True only for occupied addresses; does not treat gaps as zero bytes.

MemoryMap::copy

source

fn MemoryMap::copy(self : MemoryMap) -> MemoryMap

Independent mutable copy for transactional multi-image operations.

MemoryMap::gaps

source

fn MemoryMap::gaps(self : MemoryMap) -> Array[AddressRange]

Internal holes only. No leading zero-to-first-address gap is invented.

MemoryMap::highest_address

source

fn MemoryMap::highest_address(self : MemoryMap) -> Int64?

Highest occupied address (inclusive), or None.

MemoryMap::holes_in

source

fn MemoryMap::holes_in(self : MemoryMap, range : AddressRange) -> Array[AddressRange]

Holes in an explicit window, including leading and trailing holes.

MemoryMap::insert

source

fn MemoryMap::insert(self : MemoryMap, address : Int64, bytes : Bytes, policy? : OverlapPolicy) -> Unit raise FirmwareError

Insert data using a checked overlap policy. Limits cap payload at 64 MiB.

MemoryMap::lowest_address

source

fn MemoryMap::lowest_address(self : MemoryMap) -> Int64?

Lowest occupied address, or None for an empty map.

MemoryMap::new

source

fn MemoryMap::new() -> MemoryMap

An empty sparse map. Insertions are transactional on validation failure.

MemoryMap::payload_size

source

fn MemoryMap::payload_size(self : MemoryMap) -> Int

Payload size rather than the address span.

MemoryMap::read

source

fn MemoryMap::read(self : MemoryMap, address : Int64) -> Byte?

Read an occupied byte; holes and out-of-range addresses return None.

MemoryMap::same_memory

source

fn MemoryMap::same_memory(self : MemoryMap, other : MemoryMap) -> Bool

Semantic memory equality, independent of source record boundaries.

MemoryMap::segment_count

source

fn MemoryMap::segment_count(self : MemoryMap) -> Int

Count normalized occupied regions.

MemoryMap::segments

source

fn MemoryMap::segments(self : MemoryMap) -> Array[MemorySegment]

Return immutable snapshots, never the map's mutable internal buffers.

MemoryMap::slice

source

fn MemoryMap::slice(self : MemoryMap, range : AddressRange) -> MemoryMap raise FirmwareError

Copy just the occupied intersections with a checked interval.

MemoryMap::to_binary

source

fn MemoryMap::to_binary(self : MemoryMap, range : AddressRange, fill? : Byte, max_size? : Int) -> Bytes raise FirmwareError

Dense bytes from an explicit interval. Refuse holes unless fill is supplied.

MemorySegment

source

pub struct MemorySegment {
  start : Int64
  data : Bytes
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Immutable snapshot of one contiguous occupied region.

MemorySegment::new

source

fn MemorySegment::new(start : Int64, data : Bytes) -> MemorySegment raise FirmwareError

Checked segment constructor; bytes are immutable in the public API.

MemorySegment::range

source

fn MemorySegment::range(self : MemorySegment) -> AddressRange

Interval occupied by this segment.

Metadata

source

pub(all) struct Metadata {
  source_format : Format
  record_counts : Array[Int]
  header : Bytes?
  checksum_status : ChecksumStatus
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Original record statistics and S0 header bytes, with no lossy text decoding.

Metadata::new

source

fn Metadata::new(format : Format) -> Metadata

Metadata for an image assembled in memory or transformed after parsing.

OverlapPolicy

source

pub(all) enum OverlapPolicy {
  Reject
  AllowIdentical
  Overwrite
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Reject any overlap, accept byte-identical overlap, or replace existing data.

ParseMode

source

pub(all) enum ParseMode {
  Strict
  Permissive
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Strict structural validation or a small documented set of tolerances.

ParseOptions

source

pub(all) struct ParseOptions {
  mode : ParseMode
  overlap : OverlapPolicy
  max_line_length : Int
  max_records : Int
  max_payload : Int
  max_text_length : Int
  max_warnings : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Resource limits apply before parsing or allocating output buffers.

ParseOptions::default

source

fn ParseOptions::default() -> ParseOptions

Conservative defaults, independent of the largest address in the input.

ParseOptions::validate

source

fn ParseOptions::validate(self : ParseOptions) -> Unit raise FirmwareError

Check options once before processing untrusted records.

data_range

source

fn data_range(address : Int64, length : Int) -> AddressRange raise FirmwareError

Check a start plus byte length without overflow in either integer width.

diagnostic

source

fn diagnostic(code : ErrorCode, message : String, address? : Int64, end_address? : Int64) -> Diagnostic

Create a diagnostic outside a parser; parser code supplies source fields.

hex_address

source

fn hex_address(address : Int64) -> String

Stable fixed-width display for firmware addresses and range endpoints.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#FirmwareError

#AddressRange

#AddressRange::contains

#AddressRange::inclusive

#AddressRange::intersection

#AddressRange::is_empty

#AddressRange::length

#AddressRange::new

#AddressRange::render

#AddressRange::shift

#AddressRange::subtract

#ChecksumStatus

#Diagnostic

#Diagnostic::render

#EntryPoint

#EntryPoint::address

#ErrorCode

#FirmwareImage

#FirmwareImage::copy

#FirmwareImage::from_binary

#FirmwareImage::new

#FirmwareImage::semantic_equal

#Format

#Format::label

#MemoryMap

#MemoryMap::bounds

#MemoryMap::contains

#MemoryMap::copy

#MemoryMap::gaps

#MemoryMap::highest_address

#MemoryMap::holes_in

#MemoryMap::insert

#MemoryMap::lowest_address

#MemoryMap::new

#MemoryMap::payload_size

#MemoryMap::read

#MemoryMap::same_memory

#MemoryMap::segment_count

#MemoryMap::segments

#MemoryMap::slice

#MemoryMap::to_binary

#MemorySegment

#MemorySegment::new

#MemorySegment::range

#Metadata

#Metadata::new

#OverlapPolicy

#ParseMode

#ParseOptions

#ParseOptions::default

#ParseOptions::validate

#data_range

#diagnostic

#hex_address

Source Files

FirmwareError

AddressRange

AddressRange::contains

AddressRange::inclusive

AddressRange::intersection

AddressRange::is_empty

AddressRange::length

AddressRange::new

AddressRange::render

AddressRange::shift

AddressRange::subtract

ChecksumStatus

Diagnostic

Diagnostic::render

EntryPoint

EntryPoint::address

ErrorCode

FirmwareImage

FirmwareImage::copy

FirmwareImage::from_binary

FirmwareImage::new

FirmwareImage::semantic_equal

Format

Format::label

MemoryMap

MemoryMap::bounds

MemoryMap::contains

MemoryMap::copy

MemoryMap::gaps

MemoryMap::highest_address

MemoryMap::holes_in

MemoryMap::insert

MemoryMap::lowest_address

MemoryMap::new

MemoryMap::payload_size

MemoryMap::read

MemoryMap::same_memory

MemoryMap::segment_count

MemoryMap::segments

MemoryMap::slice

MemoryMap::to_binary

MemorySegment

MemorySegment::new

MemorySegment::range

Metadata

Metadata::new

OverlapPolicy

ParseMode

ParseOptions

ParseOptions::default

ParseOptions::validate

data_range

diagnostic

hex_address