Move example code from README.md to lib.rs

crates.io cannot hide portions of the example when marking the line
using hashtag in README.md. Moving the example into the doc comment of
lib.rs where it is formatted correctly on docs.rs.

Change-Id: I7bd4fec944813b7f0270e7deccbb05377b60cf89
Signed-off-by: Imre Kis <imre.kis@arm.com>
4 files changed
tree: 5792c04caf99a39a40257bb2d09e18179ee26741
  1. src/
  2. .gitignore
  3. Cargo.lock
  4. Cargo.toml
  5. dco.txt
  6. LICENSE-Apache-2.0
  7. LICENSE-MIT
  8. README.md
README.md

Arm Watchdog Module (SP805) driver

Driver implementation for the SP805 watchdog module.

Implemented features

  • Enable/disable watchdog timer
  • Update timer value

License

The project is MIT and Apache-2.0 dual licensed, see LICENSE-APACHE and LICENSE-MIT.

Maintainers

arm-sp805 is a trustedfirmware.org maintained project. All contributions are ultimately merged by the maintainers listed below.

Contributing

Please follow the directions of the Trusted Firmware Processes

Contributions are handled through review.trustedfirmware.org.

Reporting Security Issues

Please follow the directions of the Trusted Firmware Security Center


Copyright 2025 Arm Limited and/or its affiliates open-source-office@arm.com

Arm is a registered trademark of Arm Limited (or its subsidiaries or affiliates).