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/rtems/attr.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/smp.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTEMS_SELF                OBJECTS_ID_OF_SELF

#define RTEMS_YIELD_PROCESSOR WATCHDOG_NO_TIMEOUT

typedef uint32_t rtems_task_priority;

#define RTEMS_NO_PRIORITY           RTEMS_CURRENT_PRIORITY

#define RTEMS_MINIMUM_PRIORITY      1

rtems_task_priority _RTEMS_Maximum_priority( void );

#define RTEMS_MAXIMUM_PRIORITY      _RTEMS_Maximum_priority()

#define RTEMS_CURRENT_PRIORITY      0

struct _Thread_Control;

typedef struct _Thread_Control rtems_tcb;

typedef void rtems_task;

typedef CPU_Uint32ptr 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
);

void rtems_task_exit( void ) RTEMS_NO_RETURN;

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,
  rtems_task_argument argument
);

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_get_priority(
  rtems_id             task_id,
  rtems_id             scheduler_id,
  rtems_task_priority *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
);

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
);

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_task_priority priority
);

rtems_id rtems_task_self(void);

typedef bool ( *rtems_task_visitor )( rtems_tcb *tcb, void *arg );

void rtems_task_iterate(
  rtems_task_visitor  visitor,
  void               *arg
);

rtems_status_code rtems_scheduler_ident(
  rtems_name  name,
  rtems_id   *id
);

rtems_status_code rtems_scheduler_ident_by_processor(
  uint32_t  cpu_index,
  rtems_id *id
);

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

#define rtems_scheduler_get_processor() _SMP_Get_current_processor()

RTEMS_DEPRECATED RTEMS_INLINE_ROUTINE uint32_t
rtems_get_current_processor( void )
{
  return rtems_scheduler_get_processor();
}

#define rtems_scheduler_get_processor_maximum() _SMP_Get_processor_maximum()

RTEMS_DEPRECATED RTEMS_INLINE_ROUTINE uint32_t
rtems_get_processor_count( void )
{
  return rtems_scheduler_get_processor_maximum();
}

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

rtems_status_code rtems_scheduler_add_processor(
  rtems_id scheduler_id,
  uint32_t cpu_index
);

rtems_status_code rtems_scheduler_remove_processor(
  rtems_id scheduler_id,
  uint32_t cpu_index
);

rtems_status_code rtems_scheduler_get_maximum_priority(
  rtems_id             scheduler_id,
  rtems_task_priority *priority
);

rtems_status_code rtems_scheduler_map_priority_to_posix(
  rtems_id             scheduler_id,
  rtems_task_priority  priority,
  int                 *posix_priority
);

rtems_status_code rtems_scheduler_map_priority_from_posix(
  rtems_id             scheduler_id,
  int                  posix_priority,
  rtems_task_priority *priority
);

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */