From: Hoa Nguyen Date: Thu, 20 Aug 2020 22:03:53 +0000 (-0700) Subject: base: Tag API methods in condcodes.hh X-Git-Tag: v20.1.0.0~84 X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=ebc738f7a9f695f0203f9e7a154e2f58278e9c03;p=gem5.git base: Tag API methods in condcodes.hh Change-Id: Ife6b5ed6ee684b65790c374ab6e709ce8eb708ad Signed-off-by: Hoa Nguyen Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33074 Reviewed-by: Bobby R. Bruce Reviewed-by: Jason Lowe-Power Maintainer: Bobby R. Bruce Tested-by: kokoro --- diff --git a/src/base/condcodes.hh b/src/base/condcodes.hh index 5de2daa77..b15fec0b0 100644 --- a/src/base/condcodes.hh +++ b/src/base/condcodes.hh @@ -74,6 +74,8 @@ * If we have a carry in, but no carry out: * src1 and src2 can neither be 1. So the overall result bit is 1. Hence: * ~1 + 0 + 0 => 0. We return false. + * + * @ingroup api_base_utils */ static inline bool findCarry(int width, uint64_t dest, uint64_t src1, uint64_t src2) @@ -86,6 +88,8 @@ findCarry(int width, uint64_t dest, uint64_t src1, uint64_t src2) /** * Calculate the overflow flag from an addition. + * + * @ingroup api_base_utils */ static inline bool findOverflow(int width, uint64_t dest, uint64_t src1, uint64_t src2) @@ -109,6 +113,8 @@ findOverflow(int width, uint64_t dest, uint64_t src1, uint64_t src2) * If the intermediate is still one, then there is exactly one high bit * which does not have a corresponding high bit. Therefore, the value must * have odd parity, and we return 1 accordingly. Otherwise we return 0. + * + * @ingroup api_base_utils */ static inline bool findParity(int width, uint64_t dest) @@ -125,6 +131,8 @@ findParity(int width, uint64_t dest) /** * Calculate the negative flag. + * + * @ingroup api_base_utils */ static inline bool findNegative(int width, uint64_t dest) @@ -134,6 +142,8 @@ findNegative(int width, uint64_t dest) /** * Calculate the zero flag. + * + * @ingroup api_base_utils */ static inline bool findZero(int width, uint64_t dest)