# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### Added

- ci: add `check-changlog` and `check-commit-signatures` in `workflows`.
- pmu: add missing `snapshot_set_shmem` function and testcases in `Pmu` trait.
- pmu: add missing `snapshot_set_shmem` function in `Pmu` trait, impl for `&T` and `Option<T>` and `Forward` structure
- forward: derive `Copy`, `Default`, `PartialEq`, `Eq` and `Hash` for struct Forward
- pmu: mark that signatures of `pmu_counter_{config_matching, start, stop}` would be changed in RustSBI 0.5.0, as they are breaking changes.
- lib: re-export `CounterMask` structure from `sbi-spec` crate.

### Modified

- susp: amend documentation on `system_suspend` function.

### Removed

## [0.4.0]

### Added

- macro based `#[derive(RustSBI)]` interface
- support System Suspend extension
- support CPPC extension
- support for NACL and STA extensions
- `handle_ecall` now only requires `&self` since RustSBI trait implementations are internally mutable
- `into_inner` function for `HartMask`
- forward extensions to current environment by `Forward` struct

### Modified

- run on provided `EnvInfo` by default; bare metal M-mode environment should gate `machine`
- doc: grammar tweaks in hsm module
- update dependency `sbi-spec` to v0.0.6, use `Physical` struct from `sbi-spec` crate.
- merge rustsbi/sbi-{rt, spec, testing} repositories into rustsbi/rustsbi repository.

### Removed

- `sbi_2_0` feature; RustSBI now supports SBI 2.0-rc1 by default
- support for legacy SBI extensions
- singleton-based RustSBI interface; use derive macro `#[derive(RustSBI)]` instead

## [0.3.2] - 2023-02-26

Bump RISC-V SBI specification version to 2.0-rc1.

### Added

- pmu: counter_fw_read_hi function in SBI 2.0-rc1
- lib: memory address parameters and DBCN extension
- lib: adds feature `sbi_2_0` and gate pmu read_hi

### Modified

- doc: amend using SBI 2.0-rc1 specification

### Fixed

- `impl<T: Console> Console for &T`

## [0.3.1] - 2023-01-20

### Modified

- Update dependency crate `riscv` to version 0.10.1
- Use let-else to simplify code, bump MSRV to 1.65.0

## [0.3.0] - 2022-11-03

### Added

- Instance based and/or machine independent RustSBI to support hypervisor development
- Structure `MachineInfo` for non-machine environment, e.g. cross-architecture emulator
- Builder structure for instance based RustSBI framework
- Implement RustSBI traits for their references
- Extensive documents for hypervisors, emulators, and machine environments using RustSBI
- Feature `legacy` to gate the SBI legacy extension
- Expose `init_*` functions on instance-based RustSBI implementation
- LEGACY_CLEAR_IPI implemented

### Modified

- Probe function now returns if legacy extensions are available
- Update to `riscv` crate 0.9.0, sbi-spec crate version 0.0.4
- Rename `send_ipi_many` to `send_ipi`

### Removed

- Remove dependency on crate alloc; RustSBI now works without a heap
- Remove embedded-hal serial adapter to legacy console

### Fixed

## [0.2.2] - 2022-03-23

This update adapts to ratified RISC-V SBI v1.0.0 specification, it's recommended for users to update to
the latest RustSBI version.

### Added

- Support for RISC-V SBI v1.0.0 Ratified Specification
- Internal guest and instance module

### Modified

- Use the Rust 2021 edition
- Update dependency `embedded-hal` to v0.2.7

## [0.2.1] - 2022-02-14

This update fixes a severe bug on IPI module. The previous version of RustSBI did not follow the SBI definition of IPI
module on SBI v0.3 format. Users are encouraged to use 0.2.1 and newer version instead of yanked 0.2.0 version.

### Modified

- Internal speed up to new SBI v0.3+ IPI procedure
- Reduce code size by inlining internal functions

### Fixed

- Severe bug on IPI does not follow the new SBI version convention rule
- Pass cargo test on docs, add test cases on hart mask

## [0.2.0] - 2022-02-13

### Added

- Support for RISC-V SBI v1.0 and v0.3 Specification
- S-level Illegal instruction exception is now delegated into S-level software handler
- Support RFENCE extension in RustSBI framework
- Added a test kernel to test SBI function on RustSBI implementations
- Support device tree binary in the K210 platform
- Support SBI v0.3 hart suspend function
- Support PMU extension trait and init function
- Use fat pointer cell to support asynchronous hart state monitor module
- Build under new asm! macro

### Modified

- Reform RustSBI project into a library
- Use `u32` function and module id width for SBI 1.0
- Function `rustsbi::ecall` now require `a0`-`a5` input parameters
- Enhanced in-line code documents from the SBI standard
- Now IPI module requires to return an `SbiRet` value
- Remove use of `global_asm` and `llvm_asm` in test kernel
- Align to 4 bytes for interrupt handler on QEMU and test kernel
- Update `riscv` crate dependency for QEMU platform
- Use `mtval` to read instruction on QEMU; still need to be kept on K210 as 1.9.1 does not define this register behavior
- Modify second parameter of `enter_privileged` to `opaque` other than `dtb_pa`
- Dump all trap frame registers when exception happened in reference implementations
- Use `embedded-hal` dependency version `0.2.6`
- Change to asynchronous lock structure trait style
- Function `num_counters` returns `usize` and its SBI call must return ``SbiRet::success()``
- Use amo mutex for legacy stdio handler; remove dependency on `lazy_static` and `spin`
- Improve documents to adapt to v1.0-rc2 specification

### Fixed

- Test kernel console now will lock before `println` line is finished
- Non-legacy supervisor IPI extension is fixed
- Returns -1 other than 0 when legacy console getchar function fails; thanks to @duskmoon314

## [0.1.1] - 2021-02-01

### Added

- Abstract support for HSM and SRST extensions
- Support SRST extension using the test device on QEMU
- Count harts from device tree binary on QEMU platform
- Show hart id on panic for QEMU platform

### Modified

- Use '#[naked]' instead of global assembly in newer Rust versions for RustSBI platforms

### Fixed

- Fix `init_hsm` function which is not exported before
- Small fixes on library documents

## [0.1.0] - 2020-12-26

RustSBI is adapted to the SBI standard with implementation number 4.

### Added

- Implementation specific SBI module `0x0A000004` defined
- K210 specific sbi_rustsbi_k210_sext SBI call

### Modified

- Update private SBI function to K210 implementation

### Fixed

- Delegate instruction load/store faults to S mode, allowing legacy console getchar to work on K210 (#7).
- Fixed 64-bit and 32-bit instruction value for target pointer widths
- Fixed readme document path for crates.io

## [0.0.2] - 2020-10-20

### Added

- Support for Kendryte K210 with MMU and S-Mode
- Support for QEMU
- SBI v0.2 TIME extension and IPI extension
- RISC-V ISA both RV32 and RV64
- RISC-V Privileged Specification v1.11
- Backward compatible to privileged spec v1.9.1

[Unreleased]: https://github.com/rustsbi/rustsbi/compare/v0.4.0...HEAD
[0.4.0]: https://github.com/rustsbi/rustsbi/compare/v0.3.2...v0.4.0
[0.3.2]: https://github.com/rustsbi/rustsbi/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/rustsbi/rustsbi/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/rustsbi/rustsbi/compare/v0.2.2...v0.3.0
[0.2.2]: https://github.com/rustsbi/rustsbi/compare/v0.2.1...v0.2.2
[0.2.1]: https://github.com/rustsbi/rustsbi/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/rustsbi/rustsbi/compare/v0.1.1...v0.2.0
[0.1.1]: https://github.com/rustsbi/rustsbi/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/rustsbi/rustsbi/compare/v0.0.2...v0.1.0
[0.0.2]: https://github.com/rustsbi/rustsbi/releases/tag/v0.0.2