Document bank's set, get, unmapped_get -- SIMICS-23287
#404
Conversation
|
actually, im curious just how |
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for three bank methods (set, get, and unmapped_get) that were previously undocumented, and clarifies the return behavior of unmapped_read. These methods provide simpler variants for inquiry-type accesses to banks in the SIMICS device modeling language.
- Enhanced
unmapped_readdocumentation to specify its return type and behavior when overridden - Added documentation for
set()method used for inquiry write accesses - Added documentation for
get()andunmapped_get()methods used for inquiry read accesses
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lwaern-intel
force-pushed
the
lw/23287
branch
from
2ceffbc to
744030a
Compare
lwaern-intel
force-pushed
the
lw/23287
branch
from
744030a to
551e1fd
Compare
|
@mandolaerik ping |
| </dt><dd> | ||
| A simpler variant of `read()` used exclusively for inquiry read accesses to | ||
| the bank. Unlike `read`, `get()` unconditionally operates over an entire | ||
| range of bytes (hence `size` rather than `enabled_bytes`) and does not have an |
There was a problem hiding this comment.
consider something like , ..., or , ...; also, instead of (...) (and same thing in set). Parentheses are generally harmful for text flow, so it's good to avoid them if that's easy.
| `aux` parameter. Unlike `set()`, invocations to `get()` may throw, in | ||
| particular when some part of the access is not covered by mapped registers. |
There was a problem hiding this comment.
it could be worth mentioning something about the semantics of an exception, which for many years was not obvious to me. An exception indicates that some part of the accessed bytes is not mapped, and this is used by Simics in inspection commands such as x/examine-memory..
mandolaerik
left a comment
mandolaerik
left a comment
There was a problem hiding this comment.
Comments are optional.
2 participants
No description provided.