sys: util: s/ceiling_fraction/DIV_ROUND_UP

- Align naming with Linux equivalent macro
- New name uses UPPERCASE, as we do for all macro based functions.
- ceiling_fraction is kept, but flagged as deprecated.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2022-11-23 09:53:28 +01:00 committed by Carles Cufí
parent 1f14506c37
commit 53da110dbf

View file

@ -245,10 +245,27 @@ extern "C" {
#define WB_DN(x) ROUND_DOWN(x, sizeof(void *))
/**
* @brief Ceiling function applied to @p numerator / @p divider as a fraction.
* @brief Divide and round up.
*
* Example:
* @code{.c}
* DIV_ROUND_UP(1, 2); // 1
* DIV_ROUND_UP(3, 2); // 2
* @endcode
*
* @param n Numerator.
* @param d Denominator.
*
* @return The result of @p n / @p d, rounded up.
*/
#define ceiling_fraction(numerator, divider) \
(((numerator) + ((divider) - 1)) / (divider))
#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
/**
* @brief Ceiling function applied to @p numerator / @p divider as a fraction.
* @deprecated Use DIV_ROUND_UP() instead.
*/
#define ceiling_fraction(numerator, divider) __DEPRECATED_MACRO \
DIV_ROUND_UP(numerator, divider)
#ifndef MAX
/**