path: root/c/src/ada/rtems-tasks.ads

--
--  RTEMS / Specification
--
--  DESCRIPTION:
--
--  This package provides the interface to the RTEMS API.
--
--  DEPENDENCIES:
--
--  NOTES:
--    RTEMS initialization and configuration are called from
--    the BSP side, therefore should never be called from ADA.
--
--  COPYRIGHT (c) 1997-2008.
--  On-Line Applications Research Corporation (OAR).
--
--  The license and distribution terms for this file may in
--  the file LICENSE in this distribution or at
--  http://www.rtems.com/license/LICENSE.
--

package RTEMS.Tasks is

   subtype Priority       is RTEMS.Unsigned32;

   Current_Priority : constant Priority := 0;
   No_Priority      : constant Priority := 0;

   subtype Argument       is RTEMS.Unsigned32;
   type Argument_PTR      is access all Argument;

   type Entry_Point is access procedure (
      Argument : RTEMS.Unsigned32
   );
   pragma Convention (C, Entry_Point);


   --
   --  Task Manager
   --

   procedure Create (
      Name             : in     RTEMS.Name;
      Initial_Priority : in     Priority;
      Stack_Size       : in     Unsigned32;
      Initial_Modes    : in     RTEMS.Mode;
      Attribute_Set    : in     RTEMS.Attribute;
      ID               :    out RTEMS.ID;
      Result           :    out RTEMS.Status_Codes
   );

   procedure Ident (
      Name   : in     RTEMS.Name;
      Node   : in     RTEMS.Node;
      ID     :    out RTEMS.ID;
      Result :    out RTEMS.Status_Codes
   );

   procedure Start (
      ID          : in     RTEMS.ID;
      Entry_Point : in     RTEMS.Tasks.Entry_Point;
      Argument    : in     RTEMS.Tasks.Argument;
      Result      :    out RTEMS.Status_Codes
   );

   procedure Restart (
      ID       : in     RTEMS.ID;
      Argument : in     RTEMS.Tasks.Argument;
      Result   :    out RTEMS.Status_Codes
   );

   procedure Delete (
      ID     : in     RTEMS.ID;
      Result :    out RTEMS.Status_Codes
   );

   procedure Suspend (
      ID     : in     RTEMS.ID;
      Result :    out RTEMS.Status_Codes
   );

   procedure Resume (
      ID     : in     RTEMS.ID;
      Result :    out RTEMS.Status_Codes
   );

   procedure Is_Suspended (
      ID     : in     RTEMS.ID;
      Result :    out RTEMS.Status_Codes
   );

   procedure Set_Priority (
      ID           : in     RTEMS.ID;
      New_Priority : in     Priority;
      Old_Priority :    out Priority;
      Result       :    out RTEMS.Status_Codes
   );

   procedure Mode (
      Mode_Set          : in     RTEMS.Mode;
      Mask              : in     RTEMS.Mode;
      Previous_Mode_Set :    out RTEMS.Mode;
      Result            :    out RTEMS.Status_Codes
   );

   procedure Get_Note (
      ID      : in     RTEMS.ID;
      Notepad : in     RTEMS.Notepad_Index;
      Note    :    out RTEMS.Unsigned32;
      Result  :    out RTEMS.Status_Codes
   );

   procedure Set_Note (
      ID      : in     RTEMS.ID;
      Notepad : in     RTEMS.Notepad_Index;
      Note    : in     RTEMS.Unsigned32;
      Result  :    out RTEMS.Status_Codes
   );

   type Variable_Dtor is access procedure (
      Argument : in     RTEMS.Address
   );
   pragma Convention (C, Variable_Dtor);

   procedure Variable_Add (
      ID            : in     RTEMS.ID;
      Task_Variable : in     RTEMS.Address;
      Dtor          : in     Variable_Dtor;
      Result        :    out RTEMS.Status_Codes
   );

   procedure Variable_Get (
      ID                  : in     RTEMS.ID;
      Task_Variable       :    out RTEMS.Address;
      Task_Variable_Value :    out RTEMS.Address;
      Result              :    out RTEMS.Status_Codes
   );

   procedure Variable_Delete (
      ID                  : in     RTEMS.ID;
      Task_Variable       :    out RTEMS.Address;
      Result              :    out RTEMS.Status_Codes
   );

   procedure Wake_When (
      Time_Buffer : in     RTEMS.Time_Of_Day;
      Result      :    out RTEMS.Status_Codes
   );

   procedure Wake_After (
      Ticks  : in     RTEMS.Interval;
      Result :    out RTEMS.Status_Codes
   );

end RTEMS.Tasks;