1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/core/include/kernel_internal.h
Christian Mehlis 67428b5814 core: kernel: improved doxygen documentation
also added param[in] to irq.h and fix order of doxygen endguards
2014-05-20 14:47:41 +02:00

58 lines
1.3 KiB
C

/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @addtogroup core_internal
* @{
*
* @file kernel_internal.h
* @brief prototypes for kernel internal functions
*
* @author INRIA
* @author Oliver Hahm <oliver.hahm@inria.fr>
*/
#ifndef KERNEL_INTERNAL_H_
#define KERNEL_INTERNAL_H_
#include "attributes.h"
/**
* @brief Initializes scheduler and creates main and idle task
*/
void kernel_init(void);
/**
* @brief Optionally: initializes platform specifics (devices, pin configuration etc.)
*/
void board_init(void);
/**
* @brief Gets called upon thread creation to set CPU registers
*
* @param[in] task_func First function to call within the thread
* @param[in] stack_start Start address of the stack
* @param[in] stack_size Stack size
*
* @return stack pointer
*/
char *thread_stack_init(void (*task_func)(void), void *stack_start, int stack_size);
/**
* @brief Removes thread from scheduler and set status to #STATUS_STOPPED
*/
NORETURN void sched_task_exit(void);
/**
* @brief Prints human readable, ps-like thread information for debugging purposes
*/
void thread_print_stack(void);
#endif /* KERNEL_INTERNAL_H_ */
/** @} */