rust-osdev / rust-osdev/acpi

Specify required memory type / caching behavior for `map_physical_region`

Open
#258 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
245
Forks
93
Avg merge
2d 8h
Merged PRs (30d)
15

Description

I'm guessing Write-Back should be okay (and preferred, because it is the most performant), but I'm not 100% sure. Am I right? Either way, can the requirements for this be mentioned in the docs for map_physical_region?

Also I am assuming the memory protection needs to be readable, and should be not writable and not executable. Can this also be added to the docs?

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.

Research direction

Start with the Handler::map_physical_region documentation linked in the issue and inspect the surrounding Handler API and implementation references. Confirm the required memory type, caching behavior, and protection flags before documenting them. Done means the API docs clearly state these requirements and the documentation builds successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.