This changelog tracks the Rust svdtools project. See CHANGELOG-python.md for the Python svdtools project.

• Add bin feature (enabled by default), make some dependencies optional
• Skip adding enumeratedValues & writeConstraint to derived fields

• Fixed compilation with new rust

• Calculate _add position for peripherals and registers

• Add prefix and suffix as opposite to strip and strip_end

• Allow shorthand when _derive across clusters

• Fix optional fspec in set_field_modified_write_values

• html: field readAction and modifiedWriteValues in access
• patch: allow processing without path dependencies

• breaking Support "?~" in field _modify & _derive
• Keep position when merge fields

• _derive field

• Implement _expand_cluster
• Support derived registers/fields in svdtools html

• Fix deletion childrens on cluster modify
• Sugar for simple _split and _merge

• Replace yaml-rust with yaml-rust2. Check for duplicate keys and other YAML parse errors
• Prevent collapsing columns in HTML register-map-table with min-width
• Protect from using one enumeratedValues in fields with different width

• Support "isDefault" enum value in svdtools html

• Add possibility to add field arrays

• Add info tool, only with device-name for now
• Add expand-patch tool to show full patch rule with all includes

• If there is no path to interpolate, show unmodified description.
• Support write constraints when defining new register fields
• Allow absolute identifiers in _derive register

• Interpolate path and name in description and derivedFrom
• Allow specs started with _ (missing part)
• Allow 1 string _include

• dimArrayIndex support
• Allow to modify registers in _cluster:
• Add addressOffset check in collect_in_cluster
• Refactor RegisterBlockExt, use BlockPath for better errors
• Allow specs started with _
• Allow process, _delete and _modify cluster without _clusters specifier

• Add _expand_array
• Allow register arrays in collect_in_cluster
• Custom dimIncrement for 1-element cluster or array

• Allow to specify name for enumeratedValues
• Avoid unneded whitespaces in generated html

• Use <details> instead of JavaScript in html template
• Fix escape special characters on Windows

• Fix #176 in collect_in_cluster

• Support bitRange and msb+lsb in field _modify
• Support _include in peripherals in device.yaml
• Add --enum_derive flag
• Strip alternateRegister too
• Add modifiedWriteValues and readAction field patch (#156)
• Ignore rule if starts with "?~" and no matched instances
• Fix #144
• Flag to check for errors after patching

• Fix #182

• Move field with derived enums before other
• -1 for default enum value
• Update displayName during collect, improve searching common description
• mmaps: peripheral arrays, bump svd crates
• patch: --show-patch-on-error prints yaml patches on error

• Revert #145
• Improve "Could not find errors"
• use register size as dimIncrement for 1-element arrays
• Replace spec indices search with regex
• modify writeConstraint for register

• Fast fix for #161

• _modify derivedFrom for peripherals, clusters, registers and fields
• fix field bit range in svdtools html

• add svdtools html and svdtools htmlcompare tools from stm32-rs
• update svd-encoder, --format-config and optional out_path for patch
• add field name in enumeratedValues derive path

• cluster add/modify
• use normpath instead of std::fs::canonicalize

• patch: added possibility to modify dim elements (arrays)
• mmap: replace %s in field array

• Print svdtools version on error, update dependencies
• Check _delete, _strip, etc. on array of strings

Breaking changes:

• Move _strip, _strip_end before _modify (#89)
  • Existing patch files may need updating to refer to the stripped versions of names being modified
• Allow _derive to rename derived peripherals, optionally specify a new base address and description (#118)
  • If registers were being copied and modified, use _copy instead of _derive for those peripherals.

Other changes:

• Improve error messages on missing files (#117)
• Fix help documentation for svdtools patch command (#119)

• update svd-rs crates to 0.14
• convert: Add format_config option

• Added action to build binaries and release for every version tag and latest commit
• Use svd-parser 0.13.4, add expand_properties option in convert
• patch: check enum usage, don't add it if unneeded

• Add support for modifiedWriteValues & readAction for fields

• Use svd-encoder 0.13.2
• Support expand when processing SVD files (#104)
• Sanitize enumeratedValues (#103)

• Use svd-encoder 0.13.1
• Remove register access if empty

• Use svd-parser 0.13.1
• Add _clear_fields in Device and Peripheral (#90)
• Add new convert command to convert between SVD (XML), JSON, and YAML (#92)
• Provide option to opt out of regex replace of 0's in description when creating arrays by using a custom description attribute (#95)

• Initial release with feature-parity with the Python project.