Good grief. Detailed function descriptions should accompany their definition.

This commit is contained in:
Doug Evans
1998-03-03 00:45:10 +00:00
parent 3a0d0c15e7
commit 2307e0ee98
2 changed files with 4 additions and 12 deletions

View File

@ -255,17 +255,7 @@ sim_core_map_attach (SIM_DESC sd,
} }
/* Attach memory or a memory mapped device to the simulator. /* Attach memory or a memory mapped device to the simulator.
LEVEL is ... ? See sim-core.h for a full description. */
ACCESS is the kind of access to grant (some collection of r/w/x).
SPACE is ... ?
ADDR is the starting address of the section.
NR_BYTES is the size of the section.
MODULO is non-zero if this the section is to be split into several MODULO
sized identical chunks.
CLIENT is non-zero for devices, otherwise NULL.
OPTIONAL_BUFFER is the address of a pre-allocated buffer to use.
OPTIONAL_BUFFER is a sub-optimal hook that allows clients to do nasty
things that the interface doesn't accomodate. */
EXTERN_SIM_CORE\ EXTERN_SIM_CORE\
(void) (void)

View File

@ -122,7 +122,9 @@ EXTERN_SIM_CORE\
data read & written to the region. Normally a more efficient data read & written to the region. Normally a more efficient
internal structure is used. It is assumed that buffer is allocated internal structure is used. It is assumed that buffer is allocated
such that the byte alignmed of OPTIONAL_BUFFER matches ADDR vis such that the byte alignmed of OPTIONAL_BUFFER matches ADDR vis
(OPTIONAL_BUFFER % 8) == (ADDR % 8)) */ (OPTIONAL_BUFFER % 8) == (ADDR % 8)). It is defined to be a sub-optimal
hook that allows clients to do nasty things that the interface doesn't
accomodate. ??? That seems unnecessarily restrictive. */
EXTERN_SIM_CORE\ EXTERN_SIM_CORE\
(void) sim_core_attach (void) sim_core_attach