diff options
| author | Jan Dolezal <dolezj21@fel.cvut.cz> | 2014-12-04 00:56:39 +0100 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2014-12-04 13:37:50 -0500 |
| commit | 038e1dba3106e70b650fb2d755eecf9cea04b9ab (patch) | |
| tree | 24b2b205c1a772b469026ba6c730b8357210152b /cpukit/score/cpu/i386/rtems/score/i386.h | |
| parent | i386/pc386: cammelCase (struct and function names) to underscores, typedefed ... (diff) | |
| download | rtems-038e1dba3106e70b650fb2d755eecf9cea04b9ab.tar.bz2 | |
i386: doxygen and comments related to VESA real mode framebuffer
Diffstat (limited to '')
| -rw-r--r-- | cpukit/score/cpu/i386/rtems/score/i386.h | 39 |
1 files changed, 24 insertions, 15 deletions
diff --git a/cpukit/score/cpu/i386/rtems/score/i386.h b/cpukit/score/cpu/i386/rtems/score/i386.h index 926627dccb..875526ad62 100644 --- a/cpukit/score/cpu/i386/rtems/score/i386.h +++ b/cpukit/score/cpu/i386/rtems/score/i386.h @@ -185,10 +185,14 @@ void *i386_Physical_to_logical( void *address ); -/* - * i386_Real_to_physical +/** + * @brief Converts real mode pointer {segment, offset} to physical address. + * + * i386_Real_to_physical * - * Converts real mode pointer {segment, offset} to physical address. + * @param[in] segment used with \p offset to compute physical address + * @param[in] offset used with \p segment to compute physical address + * @retval physical address */ RTEMS_INLINE_ROUTINE void *i386_Real_to_physical( uint16_t segment, @@ -197,19 +201,24 @@ RTEMS_INLINE_ROUTINE void *i386_Real_to_physical( return (void *)(((uint32_t)segment<<4)+offset); } -/* - * i386_Physical_to_real - * Retreives real mode pointer elements {segmnet, offset} from physical address - * Function returns the highest segment (base) address possible. - * Example: input address - 0x4B3A2 - * output segment - 0x4B3A - * offset - 0x2 - * input address - 0x10F12E - * output segment - 0xFFFF - * offset - 0xF13E +/** + * @brief Retreives real mode pointer elements {segmnet, offset} from + * physical address. + * + * i386_Physical_to_real + * Function returns the highest segment (base) address possible. + * Example: input address - 0x4B3A2 + * output segment - 0x4B3A + * offset - 0x2 + * input address - 0x10F12E + * output segment - 0xFFFF + * offset - 0xF13E * - * return 0 address not convertible, must be less than 0x10FFEF - * 1 segment and offset extracted + * @param[in] address address to be converted, must be less than 0x10FFEF + * @param[out] segment segment computed from \p address + * @param[out] offset offset computed from \p address + * @retval 0 address not convertible + * @retval 1 segment and offset extracted */ int i386_Physical_to_real( void *address, |