mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-23 04:53:08 +00:00
ecab4d53d2
* Add doxygen and doxygen-awesome css, cleanup docs files * Ignore more libraries and remove leftover local variables * Create an actual intro page * .md files linting * Add doxygen action * Fix Doxygen path * Fix doxyfile path * Try to upload * Change docs branch * Add submudules checkout * Disable doxygen on PR * Mention the firmware docs in the readme * More dev docs mentions in the readme * Fix runner group, add tags * Test dev in PR * Disable running on PR * Fix a typo in the doxyfile * Try upload to S3 * Fix local path * Fix S3 ACL * Add delete flag, unifying dev and tags * Update ignored directories * More ignored directories * Even more ignored directories * Fix submodule * Change S3 uploader * Change S3 uploader version * Fix aws sync flags * Fix ACL * Disable ACL * Improve ignores, add WiFi devboard docs * TEMP: generate dev docs * TEMP: generate 0.89.0 docs * Disabling PR trigger * Enable submodules and test build * Enable test build * Disable test build * Change docs directory structure * Fix accidentally committed submodule * Fix submodules * Update links to the developer documentation * Markdown linting * Update workflow, enable test build * Fix doxygen dir path * Update Doxyfile-awesome.cfg * Change paths * Fix upload docs path * Disable pull_request debug trigger * Disable tags building * Remove autolinks and namespaces * Establish basic documentation structure * Add missing changes * Improve stylesheet, move some files * Improve examples * Improve the main page * Improve application dev docs * Improve system programming docs * Improve development tools docs * Improve other docs * Improve application examples * Fix formatting * Fix PVS-studio warnings * Improve visuals * Fix doxygen syntax warnings * Fix broken links * Update doxygen action Co-authored-by: DrunkBatya <drunkbatya.js@gmail.com> Co-authored-by: あく <alleteam@gmail.com> Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com> Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com>
93 lines
2.2 KiB
C
93 lines
2.2 KiB
C
/**
|
|
* @file message_queue.h
|
|
* FuriMessageQueue
|
|
*/
|
|
#pragma once
|
|
|
|
#include "core/base.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef void FuriMessageQueue;
|
|
|
|
/** Allocate furi message queue
|
|
*
|
|
* @param[in] msg_count The message count
|
|
* @param[in] msg_size The message size
|
|
*
|
|
* @return pointer to FuriMessageQueue instance
|
|
*/
|
|
FuriMessageQueue* furi_message_queue_alloc(uint32_t msg_count, uint32_t msg_size);
|
|
|
|
/** Free queue
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
*/
|
|
void furi_message_queue_free(FuriMessageQueue* instance);
|
|
|
|
/** Put message into queue
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
* @param[in] msg_ptr The message pointer
|
|
* @param[in] timeout The timeout
|
|
*
|
|
* @return The furi status.
|
|
*/
|
|
FuriStatus
|
|
furi_message_queue_put(FuriMessageQueue* instance, const void* msg_ptr, uint32_t timeout);
|
|
|
|
/** Get message from queue
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
* @param msg_ptr The message pointer
|
|
* @param[in] timeout The timeout
|
|
*
|
|
* @return The furi status.
|
|
*/
|
|
FuriStatus furi_message_queue_get(FuriMessageQueue* instance, void* msg_ptr, uint32_t timeout);
|
|
|
|
/** Get queue capacity
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
*
|
|
* @return capacity in object count
|
|
*/
|
|
uint32_t furi_message_queue_get_capacity(FuriMessageQueue* instance);
|
|
|
|
/** Get message size
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
*
|
|
* @return Message size in bytes
|
|
*/
|
|
uint32_t furi_message_queue_get_message_size(FuriMessageQueue* instance);
|
|
|
|
/** Get message count in queue
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
*
|
|
* @return Message count
|
|
*/
|
|
uint32_t furi_message_queue_get_count(FuriMessageQueue* instance);
|
|
|
|
/** Get queue available space
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
*
|
|
* @return Message count
|
|
*/
|
|
uint32_t furi_message_queue_get_space(FuriMessageQueue* instance);
|
|
|
|
/** Reset queue
|
|
*
|
|
* @param instance pointer to FuriMessageQueue instance
|
|
*
|
|
* @return The furi status.
|
|
*/
|
|
FuriStatus furi_message_queue_reset(FuriMessageQueue* instance);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|