Re: [PATCH 1/1] lmb: description lmb_is_reserved, lmb_is_reserved_flags

2023-08-12 Thread Massimo Pegorer
Hi,

Il giorno sab 12 ago 2023 alle ore 19:49 Heinrich Schuchardt <
heinrich.schucha...@canonical.com> ha scritto:

> * provide a description for function lmb_is_reserved()
> * improve the description of funciton lmb_is_reserved_flags()
>
> Signed-off-by: Heinrich Schuchardt 
> ---
>  include/lmb.h | 22 +++---
>  1 file changed, 19 insertions(+), 3 deletions(-)
>
> diff --git a/include/lmb.h b/include/lmb.h
> index 07bf22144e..0365c9ef1f 100644
> --- a/include/lmb.h
> +++ b/include/lmb.h
> @@ -116,16 +116,32 @@ phys_addr_t __lmb_alloc_base(struct lmb *lmb,
> phys_size_t size, ulong align,
>  phys_addr_t max_addr);
>  phys_addr_t lmb_alloc_addr(struct lmb *lmb, phys_addr_t base, phys_size_t
> size);
>  phys_size_t lmb_get_free_size(struct lmb *lmb, phys_addr_t addr);
> +
> +/**
> + * lmb_is_reserved_flags() - test if address is in reserved region
>

lmb_is_reserved()


> + *
> + * The function checks if a reserved region comprising @addr exists.
> + * flag bits set that are set in @flags.
>

line to be removed (cut and paste from lmb_is_reserved_flags() description)


> + *
> + * @lmb:   the logical memory block struct
> + * @addr:  address to be tested
> + * Return: 1 if reservation exists, 0 otherwise
> + */
>  int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr);
> +
>  /**
> - * lmb_is_reserved_flags - test if tha address is in reserved region with
> a bitfield flag
> + * lmb_is_reserved_flags() - test if address is in reserved region with
> flag bits set
> + *
> + * The function checks if a reserved region comprising @addr exists which
> has
> + * all flag bits set which are set in @flags.
>   *
>   * @lmb:   the logical memory block struct
>   * @addr:  address to be tested
> - * @flags: flags bitfied to be tested
> - * Return: if not reserved or reserved without the requested flag
> else 1
> + * @flags: bitmap with bits to be tested
> + * Return: 1 if matching reservation exists, 0 otherwise
>   */
>  int lmb_is_reserved_flags(struct lmb *lmb, phys_addr_t addr, int flags);
> +
>  long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size);
>
>  void lmb_dump_all(struct lmb *lmb);
> --
> 2.40.1
>
>


[PATCH 1/1] lmb: description lmb_is_reserved, lmb_is_reserved_flags

2023-08-12 Thread Heinrich Schuchardt
* provide a description for function lmb_is_reserved()
* improve the description of funciton lmb_is_reserved_flags()

Signed-off-by: Heinrich Schuchardt 
---
 include/lmb.h | 22 +++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/include/lmb.h b/include/lmb.h
index 07bf22144e..0365c9ef1f 100644
--- a/include/lmb.h
+++ b/include/lmb.h
@@ -116,16 +116,32 @@ phys_addr_t __lmb_alloc_base(struct lmb *lmb, phys_size_t 
size, ulong align,
 phys_addr_t max_addr);
 phys_addr_t lmb_alloc_addr(struct lmb *lmb, phys_addr_t base, phys_size_t 
size);
 phys_size_t lmb_get_free_size(struct lmb *lmb, phys_addr_t addr);
+
+/**
+ * lmb_is_reserved_flags() - test if address is in reserved region
+ *
+ * The function checks if a reserved region comprising @addr exists.
+ * flag bits set that are set in @flags.
+ *
+ * @lmb:   the logical memory block struct
+ * @addr:  address to be tested
+ * Return: 1 if reservation exists, 0 otherwise
+ */
 int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr);
+
 /**
- * lmb_is_reserved_flags - test if tha address is in reserved region with a 
bitfield flag
+ * lmb_is_reserved_flags() - test if address is in reserved region with flag 
bits set
+ *
+ * The function checks if a reserved region comprising @addr exists which has
+ * all flag bits set which are set in @flags.
  *
  * @lmb:   the logical memory block struct
  * @addr:  address to be tested
- * @flags: flags bitfied to be tested
- * Return: if not reserved or reserved without the requested flag else 1
+ * @flags: bitmap with bits to be tested
+ * Return: 1 if matching reservation exists, 0 otherwise
  */
 int lmb_is_reserved_flags(struct lmb *lmb, phys_addr_t addr, int flags);
+
 long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size);
 
 void lmb_dump_all(struct lmb *lmb);
-- 
2.40.1