thread.h

Go to the documentation of this file.

/****************************************************************************/
 
#ifndef THREAD_H
#define THREAD_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <stddef.h>
#include "config.h"
 
#include "message.h"
 
#if (OS_CFG_USE_SHELL != 0u)
#define AKOS_THREAD_NAME_INIT(_name) .name = #_name,
#else
#define AKOS_THREAD_NAME_INIT(_name)
#endif
 
#define AKOS_THREAD_DEFINE(_name, _id, _entry, _arg, _prio, _queue_size, _stack_size) \
  const thread_t _name __attribute__((used, section("task_desc"))) = {                 \
      AKOS_THREAD_NAME_INIT(_name)                                                     \
      .id = (thread_id_t)(_id),                                                        \
      .pf_thread = (thread_func_t)(_entry),                                            \
      .p_arg = (void *)(_arg),                                                         \
      .prio = (uint8_t)(_prio),                                                        \
      .queue_size = (size_t)(_queue_size),                                             \
      .stack_size = (size_t)(_stack_size),                                             \
  }

  typedef enum
  {
    THREAD_STATE_RUNNING = 0,     
    THREAD_STATE_READY,           
    THREAD_STATE_DELAYED,          
    THREAD_STATE_SUSPENDED,        
    THREAD_STATE_SUSPENDED_ON_MSG, 
    THREAD_STATE_DELAYED_ON_MSG    
  } thread_state_t;
 
  typedef struct thread_tcb *thread_handle_t; 
  typedef struct thread thread_t;           

  typedef void (*thread_func_t)(void *p_arg);

  typedef uint8_t thread_id_t;
 
  typedef struct
  {
#if (OS_CFG_USE_SHELL != 0u)
    const char *name;
#endif
    thread_id_t id;
    uint8_t prio;
    uint32_t run_ticks;
  } thread_runtime_snapshot_t;

  struct thread
  {
#if (OS_CFG_USE_SHELL != 0u)
    const char *name;      
#endif
    thread_id_t id;         
    thread_func_t pf_thread; 
    void *p_arg;            
    uint8_t prio;           
    size_t queue_size;       
    size_t stack_size;       
  };

  uint32_t akos_thread_get_tick(void);

  void akos_thread_register_static_threads(void);

  uint8_t akos_thread_get_app_thread_count(void);

  uint8_t akos_thread_get_idle_thread_id(void);

  uint8_t akos_thread_get_timer_thread_id(void);

  uint8_t akos_thread_get_shell_thread_id(void);

  uint8_t akos_thread_increment_tick(void);

  void akos_thread_delay(const uint32_t tick_to_delay);

  void akos_thread_start(void);

  void akos_thread_post_msg_dynamic(uint8_t des_thread_id, int32_t sig, void *p_content, uint8_t msg_size);

  void akos_thread_post_msg_pure(uint8_t des_thread_id, int32_t sig);

  msg_t *akos_thread_wait_for_msg(uint32_t time_out);

  void akos_thread_get_runtime_totals(uint32_t *p_idle_ticks, uint32_t *p_total_ticks);

  uint8_t akos_thread_get_runtime_count(void);

  void akos_thread_get_runtime_snapshot(uint8_t index, thread_runtime_snapshot_t *p_snapshot);
 
#ifdef __cplusplus
}
#endif
#endif /* THREAD_H */