noxos
/
kernel
4
1
Fork 0
Code Issues 5 Pull Requests Packages Projects Releases Wiki Activity

docs: documented updated 'bitmap_T' documentation

This commit is contained in:
antifallobst 2023-03-03 17:28:55 +01:00
parent 91cd670c50
commit dd0c2a3169
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.wiki/Kernel-documentation.md
View File

@ -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. Provides functionalities to create, destruct and work with bitmaps.
#### `bitmap_T` - struct #### `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) #### `bitmap_init_from_buffer(buffer, size)` - function (bitmap_T)
Creates a bitmap object from a given buffer and size Creates a bitmap object from a given buffer and size