Furi: core refactoring and CMSIS removal part 2 (#1410)
* Furi: rename and move core * Furi: drop CMSIS_OS header and unused api, partially refactor and cleanup the rest * Furi: CMSIS_OS drop and refactoring. * Furi: refactoring, remove cmsis legacy * Furi: fix incorrect assert on queue deallocation, cleanup timer * Furi: improve delay api, get rid of floats * hal: dropped furi_hal_crc * Furi: move DWT based delay to cortex HAL * Furi: update core documentation Co-authored-by: hedger <hedger@nanode.su>
This commit is contained in:
		
							
								
								
									
										199
									
								
								furi/core/thread.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										199
									
								
								furi/core/thread.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,199 @@
 | 
			
		||||
/**
 | 
			
		||||
 * @file thread.h
 | 
			
		||||
 * Furi: Furi Thread API
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "base.h"
 | 
			
		||||
#include "common_defines.h"
 | 
			
		||||
 | 
			
		||||
#ifdef __cplusplus
 | 
			
		||||
extern "C" {
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
/** FuriThreadState */
 | 
			
		||||
typedef enum {
 | 
			
		||||
    FuriThreadStateStopped,
 | 
			
		||||
    FuriThreadStateStarting,
 | 
			
		||||
    FuriThreadStateRunning,
 | 
			
		||||
} FuriThreadState;
 | 
			
		||||
 | 
			
		||||
/** FuriThreadPriority */
 | 
			
		||||
typedef enum {
 | 
			
		||||
    FuriThreadPriorityNone = 0, /**< Uninitialized, choose system default */
 | 
			
		||||
    FuriThreadPriorityIdle = 1, /**< Idle priority */
 | 
			
		||||
    FuriThreadPriorityLowest = 14, /**< Lowest */
 | 
			
		||||
    FuriThreadPriorityLow = 15, /**< Low */
 | 
			
		||||
    FuriThreadPriorityNormal = 16, /**< Normal */
 | 
			
		||||
    FuriThreadPriorityHigh = 17, /**< High */
 | 
			
		||||
    FuriThreadPriorityHighest = 18, /**< Highest */
 | 
			
		||||
    FuriThreadPriorityIsr = 32, /**< Deffered Isr (highest possible) */
 | 
			
		||||
} FuriThreadPriority;
 | 
			
		||||
 | 
			
		||||
/** FuriThread anonymous structure */
 | 
			
		||||
typedef struct FuriThread FuriThread;
 | 
			
		||||
 | 
			
		||||
/** FuriThreadId proxy type to OS low level functions */
 | 
			
		||||
typedef void* FuriThreadId;
 | 
			
		||||
 | 
			
		||||
/** FuriThreadCallback Your callback to run in new thread
 | 
			
		||||
 * @warning    never use osThreadExit in FuriThread
 | 
			
		||||
 */
 | 
			
		||||
typedef int32_t (*FuriThreadCallback)(void* context);
 | 
			
		||||
 | 
			
		||||
/** FuriThread state change calback called upon thread state change
 | 
			
		||||
 * @param      state    new thread state
 | 
			
		||||
 * @param      context  callback context
 | 
			
		||||
 */
 | 
			
		||||
typedef void (*FuriThreadStateCallback)(FuriThreadState state, void* context);
 | 
			
		||||
 | 
			
		||||
/** Allocate FuriThread
 | 
			
		||||
 *
 | 
			
		||||
 * @return     FuriThread instance
 | 
			
		||||
 */
 | 
			
		||||
FuriThread* furi_thread_alloc();
 | 
			
		||||
 | 
			
		||||
/** Release FuriThread
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_free(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread name
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 * @param      name    string
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_name(FuriThread* thread, const char* name);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread stack size
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread      FuriThread instance
 | 
			
		||||
 * @param      stack_size  stack size in bytes
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_stack_size(FuriThread* thread, size_t stack_size);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread callback
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread    FuriThread instance
 | 
			
		||||
 * @param      callback  FuriThreadCallback, called upon thread run
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_callback(FuriThread* thread, FuriThreadCallback callback);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread context
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread   FuriThread instance
 | 
			
		||||
 * @param      context  pointer to context for thread callback
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_context(FuriThread* thread, void* context);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread priority
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread   FuriThread instance
 | 
			
		||||
 * @param      priority FuriThreadPriority value
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_priority(FuriThread* thread, FuriThreadPriority priority);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread state change callback
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread    FuriThread instance
 | 
			
		||||
 * @param      callback  state change callback
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_state_callback(FuriThread* thread, FuriThreadStateCallback callback);
 | 
			
		||||
 | 
			
		||||
/** Set FuriThread state change context
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread   FuriThread instance
 | 
			
		||||
 * @param      context  pointer to context
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_set_state_context(FuriThread* thread, void* context);
 | 
			
		||||
 | 
			
		||||
/** Get FuriThread state
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @return     thread state from FuriThreadState
 | 
			
		||||
 */
 | 
			
		||||
FuriThreadState furi_thread_get_state(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Start FuriThread
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_start(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Join FuriThread
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @return     bool
 | 
			
		||||
 */
 | 
			
		||||
bool furi_thread_join(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Get FreeRTOS FuriThreadId for FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @return     FuriThreadId or NULL
 | 
			
		||||
 */
 | 
			
		||||
FuriThreadId furi_thread_get_id(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Enable heap tracing
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_enable_heap_trace(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Disable heap tracing
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 */
 | 
			
		||||
void furi_thread_disable_heap_trace(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Get thread heap size
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @return     size in bytes
 | 
			
		||||
 */
 | 
			
		||||
size_t furi_thread_get_heap_size(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Get thread return code
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @return     return code
 | 
			
		||||
 */
 | 
			
		||||
int32_t furi_thread_get_return_code(FuriThread* thread);
 | 
			
		||||
 | 
			
		||||
/** Thread releated methods that doesn't involve FuriThread directly */
 | 
			
		||||
 | 
			
		||||
/** Get FreeRTOS FuriThreadId for current thread
 | 
			
		||||
 *
 | 
			
		||||
 * @param      thread  FuriThread instance
 | 
			
		||||
 *
 | 
			
		||||
 * @return     FuriThreadId or NULL
 | 
			
		||||
 */
 | 
			
		||||
FuriThreadId furi_thread_get_current_id();
 | 
			
		||||
 | 
			
		||||
/** Return control to scheduler */
 | 
			
		||||
void furi_thread_yield();
 | 
			
		||||
 | 
			
		||||
uint32_t furi_thread_flags_set(FuriThreadId thread_id, uint32_t flags);
 | 
			
		||||
 | 
			
		||||
uint32_t furi_thread_flags_clear(uint32_t flags);
 | 
			
		||||
 | 
			
		||||
uint32_t furi_thread_flags_get(void);
 | 
			
		||||
 | 
			
		||||
uint32_t furi_thread_flags_wait(uint32_t flags, uint32_t options, uint32_t timeout);
 | 
			
		||||
 | 
			
		||||
uint32_t furi_thread_enumerate(FuriThreadId* thread_array, uint32_t array_items);
 | 
			
		||||
 | 
			
		||||
const char* furi_thread_get_name(FuriThreadId thread_id);
 | 
			
		||||
 | 
			
		||||
uint32_t furi_thread_get_stack_space(FuriThreadId thread_id);
 | 
			
		||||
 | 
			
		||||
#ifdef __cplusplus
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
		Reference in New Issue
	
	Block a user