Memory-mapped Registers: does `W` give read access to the register?

Open
#346 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Review the writing section of the Rust Embedded Book and compare its description of the PAC write() closure with the linked tm4c123x pwm0/ctl::W documentation. Clarify the access semantics so the text matches the provided API documentation. Done when the section accurately explains what W permits and no longer contradicts the link.

Written by the indexing model from the issue text.

Description

The section on writing to memory-mapped registers using a PAC says that the argument of the closure passed to the write() function gives read-write access to the various sub-fields within the register. However, the provided documentation link in the same section indicates that W gives write-only access to the register and cannot be used for reading.

Dominant language
No language data
Stars
1.3k
Forks
223
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.