tasks.h

Go to the documentation of this file.

/*
 * COPYRIGHT (c) 1989-2014.
 * On-Line Applications Research Corporation (OAR).
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_TASKS_H
#define _RTEMS_RTEMS_TASKS_H

#include <rtems/score/object.h>
#include <rtems/score/thread.h>
#include <rtems/rtems/types.h>
#include <rtems/rtems/event.h>
#include <rtems/rtems/asr.h>
#include <rtems/rtems/attr.h>
#include <rtems/rtems/status.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTEMS_SELF                OBJECTS_ID_OF_SELF

#define RTEMS_YIELD_PROCESSOR WATCHDOG_NO_TIMEOUT

typedef Priority_Control rtems_task_priority;

#define RTEMS_NO_PRIORITY           RTEMS_CURRENT_PRIORITY

#define RTEMS_MINIMUM_PRIORITY      (PRIORITY_MINIMUM + 1)

#define RTEMS_MAXIMUM_PRIORITY      PRIORITY_MAXIMUM

#define RTEMS_CURRENT_PRIORITY      PRIORITY_MINIMUM

#define RTEMS_NOTEPAD_FIRST 0

#define RTEMS_NOTEPAD_0    0

#define RTEMS_NOTEPAD_1    1

#define RTEMS_NOTEPAD_2    2

#define RTEMS_NOTEPAD_3    3

#define RTEMS_NOTEPAD_4    4

#define RTEMS_NOTEPAD_5    5

#define RTEMS_NOTEPAD_6    6

#define RTEMS_NOTEPAD_7    7

#define RTEMS_NOTEPAD_8    8

#define RTEMS_NOTEPAD_9    9

#define RTEMS_NOTEPAD_10   10

#define RTEMS_NOTEPAD_11   11

#define RTEMS_NOTEPAD_12   12

#define RTEMS_NOTEPAD_13   13

#define RTEMS_NOTEPAD_14   14

#define RTEMS_NOTEPAD_15   15

#define RTEMS_NOTEPAD_LAST RTEMS_NOTEPAD_15

#define RTEMS_NUMBER_NOTEPADS  (RTEMS_NOTEPAD_LAST+1)

typedef Thread_Control rtems_tcb;

typedef void rtems_task;

typedef Thread_Entry_numeric_type rtems_task_argument;

typedef rtems_task ( *rtems_task_entry )(
                      rtems_task_argument
                   );

typedef struct {
  rtems_name            name;
  size_t                stack_size;
  rtems_task_priority   initial_priority;
  rtems_attribute       attribute_set;
  rtems_task_entry      entry_point;
  rtems_mode            mode_set;
  rtems_task_argument   argument;
} rtems_initialization_tasks_table;

rtems_status_code rtems_task_create(
  rtems_name           name,
  rtems_task_priority  initial_priority,
  size_t               stack_size,
  rtems_mode           initial_modes,
  rtems_attribute      attribute_set,
  rtems_id            *id
);

rtems_status_code rtems_task_ident(
  rtems_name    name,
  uint32_t      node,
  rtems_id     *id
);

rtems_status_code rtems_task_delete(
  rtems_id   id
);

rtems_status_code rtems_task_get_note(
  rtems_id    id,
  uint32_t    notepad,
  uint32_t   *note
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;

rtems_status_code rtems_task_set_note(
  rtems_id   id,
  uint32_t   notepad,
  uint32_t   note
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;

rtems_status_code rtems_task_mode(
  rtems_mode  mode_set,
  rtems_mode  mask,
  rtems_mode *previous_mode_set
);

rtems_status_code rtems_task_restart(
  rtems_id   id,
  uint32_t   arg
);

rtems_status_code rtems_task_suspend(
  rtems_id   id
);

rtems_status_code rtems_task_resume(
  rtems_id   id
);

rtems_status_code rtems_task_set_priority(
  rtems_id             id,
  rtems_task_priority  new_priority,
  rtems_task_priority *old_priority
);

rtems_status_code rtems_task_start(
  rtems_id             id,
  rtems_task_entry     entry_point,
  rtems_task_argument  argument
);

rtems_status_code rtems_task_wake_when(
  rtems_time_of_day *time_buffer
);

rtems_status_code rtems_task_wake_after(
  rtems_interval  ticks
);

rtems_status_code rtems_task_is_suspended(
  rtems_id   id
);

#if !defined(RTEMS_SMP)

rtems_status_code rtems_task_variable_add(
  rtems_id  tid,
  void    **ptr,
  void    (*dtor)(void *)
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;

rtems_status_code rtems_task_variable_get(
  rtems_id tid,
  void **ptr,
  void **result
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;

rtems_status_code rtems_task_variable_delete(
  rtems_id  tid,
  void    **ptr
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
#endif

#if defined(__RTEMS_HAVE_SYS_CPUSET_H__)

rtems_status_code rtems_task_get_affinity(
  rtems_id             id,
  size_t               cpusetsize,
  cpu_set_t           *cpuset
);

rtems_status_code rtems_task_set_affinity(
  rtems_id         id,
  size_t           cpusetsize,
  const cpu_set_t *cpuset
);
#endif

rtems_status_code rtems_task_get_scheduler(
  rtems_id  task_id,
  rtems_id *scheduler_id
);

rtems_status_code rtems_task_set_scheduler(
  rtems_id task_id,
  rtems_id scheduler_id
);

rtems_id rtems_task_self(void);

rtems_status_code rtems_scheduler_ident(
  rtems_name  name,
  rtems_id   *id
);

#if defined(__RTEMS_HAVE_SYS_CPUSET_H__)

rtems_status_code rtems_scheduler_get_processor_set(
  rtems_id   scheduler_id,
  size_t     cpusetsize,
  cpu_set_t *cpuset
);
#endif

typedef struct {
  Event_Control            Event;
  Event_Control            System_event;
  ASR_Information          Signal;

  Thread_Action            Signal_action;

  uint32_t Notepads[ RTEMS_ZERO_LENGTH_ARRAY ] RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
}  RTEMS_API_Control;

extern void (*_RTEMS_tasks_Initialize_user_tasks_p)(void);

extern void _RTEMS_tasks_Initialize_user_tasks_body( void );

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */