From dd0c2a3169a7207b7053e5fc19bdc625562d491f Mon Sep 17 00:00:00 2001 From: antifallobst Date: Fri, 3 Mar 2023 17:28:55 +0100 Subject: [PATCH] docs: documented updated 'bitmap_T' documentation --- .wiki/Kernel-documentation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.wiki/Kernel-documentation.md b/.wiki/Kernel-documentation.md index cdc061d..75d6d9e 100644 --- a/.wiki/Kernel-documentation.md +++ b/.wiki/Kernel-documentation.md @@ -1174,8 +1174,12 @@ This needs to be called from an interrupt handler, for the returned state to be Provides functionalities to create, destruct and work with bitmaps. #### `bitmap_T` - struct -This struct holds a buffer for a bitmap and its size. -The size is the size of the buffer in bytes, to get the amount of storable bits multiply size with 8. + +| Name | Type | Description | +|-----------|----------|---------------------------------------| +| size | uint32_t | The size of _buffer_ (in bytes) | +| size_bits | uint32_t | The amount of storable bits | +| buffer | uint8_t* | The buffer, where the bits are stored | #### `bitmap_init_from_buffer(buffer, size)` - function (bitmap_T) Creates a bitmap object from a given buffer and size