interface/include/os_wrapper/thread.h

/*
 * Copyright (c) 2017-2019, Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

#ifndef __OS_WRAPPER_THREAD_H__
#define __OS_WRAPPER_THREAD_H__

#ifdef __cplusplus
extern "C" {
#endif

#include "common.h"

/* prototype for the thread entry function */
typedef void (*os_wrapper_thread_func) (void *argument);

/**
 * \brief Creates a new thread
 *
 * \param[in] name        Name of the thread
 * \param[in] stack_size  Size of stack to be allocated for this thread. It can
 *                        be \ref OS_WRAPPER_DEFAULT_STACK_SIZE to use the
 *                        default value provided by the underlying RTOS
 * \param[in] func        Pointer to the function invoked by thread
 * \param[in] arg         Argument to pass to the function invoked by thread
 * \param[in] priority    Initial thread priority
 *
 * \return Returns thread ID, or \ref OS_WRAPPER_ERROR in case of error
 */
uint32_t os_wrapper_thread_new(const char *name, int32_t stack_size,
                               os_wrapper_thread_func func, void *arg,
                               uint32_t priority);
/**
 * \brief Gets current thread ID
 *
 * \return Returns thread ID, or \ref OS_WRAPPER_ERROR in case of error
 */
uint32_t os_wrapper_thread_get_id(void);

/**
 * \brief Gets thread priority
 *
 * \param[in] id Thread ID
 *
 * \return Returns thread priority value, or \ref OS_WRAPPER_ERROR in case of
 *         error
 */
uint32_t os_wrapper_thread_get_priority(uint32_t id);

/**
 * \brief Exits the calling thread
 */
void os_wrapper_thread_exit(void);

#ifdef __cplusplus
}
#endif

#endif /* __OS_WRAPPER_THREAD_H__ */