OSDN Git Service

Remove s-crtl-vms64.ads, no longer used.
[pf3gnuchains/gcc-fork.git] / gcc / ada / i-vxwork.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                  GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                --
4 --                                                                          --
5 --                      I N T E R F A C E S . V X W O R K S                 --
6 --                                                                          --
7 --                                   S p e c                                --
8 --                                                                          --
9 --                     Copyright (C) 1999-2005, AdaCore                     --
10 --                                                                          --
11 -- GNARL is free software; you can  redistribute it  and/or modify it under --
12 -- terms of the  GNU General Public License as published  by the Free Soft- --
13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
14 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17 -- for  more details.  You should have  received  a copy of the GNU General --
18 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
20 -- Boston, MA 02110-1301, USA.                                              --
21 --                                                                          --
22 -- As a special exception,  if other files  instantiate  generics from this --
23 -- unit, or you link  this unit with other files  to produce an executable, --
24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
25 -- covered  by the  GNU  General  Public  License.  This exception does not --
26 -- however invalidate  any other reasons why  the executable file  might be --
27 -- covered by the  GNU Public License.                                      --
28 --                                                                          --
29 -- GNARL was developed by the GNARL team at Florida State University.       --
30 -- Extensive contributions were provided by Ada Core Technologies, Inc.     --
31 --                                                                          --
32 ------------------------------------------------------------------------------
33
34 --  This package provides a limited binding to the VxWorks API
35 --  In particular, it interfaces with the VxWorks hardware interrupt
36 --  facilities, allowing the use of low-latency direct-vectored
37 --  interrupt handlers. Note that such handlers have a variety of
38 --  restrictions regarding system calls and language constructs. In particular,
39 --  the use of exception handlers and functions returning variable-length
40 --  objects cannot be used. Less restrictive, but higher-latency handlers can
41 --  be written using Ada protected procedures, Ada 83 style interrupt entries,
42 --  or by signalling an Ada task from within an interrupt handler using a
43 --  binary semaphore as described in the VxWorks Programmer's Manual.
44 --
45 --  For complete documentation of the operations in this package, please
46 --  consult the VxWorks Programmer's Manual and VxWorks Reference Manual.
47
48 with System.VxWorks;
49
50 package Interfaces.VxWorks is
51    pragma Preelaborate;
52
53    ------------------------------------------------------------------------
54    --  Here is a complete example that shows how to handle the Interrupt 0x14
55    --  with a direct-vectored interrupt handler in Ada using this package:
56
57    --  with Interfaces.VxWorks; use Interfaces.VxWorks;
58    --  with System;
59    --
60    --  package P is
61    --
62    --     Count : Integer;
63    --     pragma Atomic (Count);
64    --
65    --     Level : constant := 1;
66    --     --  Interrupt level used by this example
67    --
68    --     procedure Handler (parameter : System.Address);
69    --
70    --  end P;
71    --
72    --  package body P is
73    --
74    --     procedure Handler (parameter : System.Address) is
75    --        S : STATUS;
76    --     begin
77    --        Count := Count + 1;
78    --        logMsg ("received an interrupt" & ASCII.LF & ASCII.Nul);
79    --
80    --        --  Acknowledge VME interrupt
81    --        S := sysBusIntAck (intLevel => Level);
82    --     end Handler;
83    --  end P;
84    --
85    --  with Interfaces.VxWorks; use Interfaces.VxWorks;
86    --  with Ada.Text_IO; use Ada.Text_IO;
87    --
88    --  with P; use P;
89    --  procedure Useint is
90    --     --  Be sure to use a reasonable interrupt number for the target
91    --     --  board!
92    --     --  This one is the unused VME graphics interrupt on the PPC MV2604
93    --     Interrupt : constant := 16#14#;
94    --
95    --     task T;
96    --
97    --     S : STATUS;
98    --
99    --     task body T is
100    --     begin
101    --        loop
102    --           Put_Line ("Generating an interrupt...");
103    --           delay 1.0;
104    --
105    --           --  Generate VME interrupt, using interrupt number
106    --           S := sysBusIntGen (1, Interrupt);
107    --        end loop;
108    --     end T;
109    --
110    --  begin
111    --     S := sysIntEnable (intLevel => Level);
112    --     S := intConnect (INUM_TO_IVEC (Interrupt), handler'Access);
113    --
114    --     loop
115    --        delay 2.0;
116    --        Put_Line ("value of count:" & P.Count'Img);
117    --     end loop;
118    --  end Useint;
119    -------------------------------------
120
121    subtype int is Integer;
122
123    type STATUS is new int;
124    --  Equivalent of the C type STATUS
125
126    OK    : constant STATUS := 0;
127    ERROR : constant STATUS := -1;
128
129    type VOIDFUNCPTR is access procedure (parameter : System.Address);
130    type Interrupt_Vector is new System.Address;
131    type Exception_Vector is new System.Address;
132
133    function intConnect
134      (vector    : Interrupt_Vector;
135       handler   : VOIDFUNCPTR;
136       parameter : System.Address := System.Null_Address) return STATUS;
137    --  Binding to the C routine intConnect. Use this to set up an
138    --  user handler. The routine generates a wrapper around the user
139    --  handler to save and restore context
140
141    function intContext return int;
142    --  Binding to the C routine intContext. This function returns 1 only
143    --  if the current execution state is in interrupt context.
144
145    function intVecGet
146      (Vector : Interrupt_Vector) return VOIDFUNCPTR;
147    --  Binding to the C routine intVecGet. Use this to get the
148    --  existing handler for later restoral
149
150    procedure intVecSet
151      (Vector  : Interrupt_Vector;
152       Handler : VOIDFUNCPTR);
153    --  Binding to the C routine intVecSet. Use this to restore a
154    --  handler obtained using intVecGet
155
156    function INUM_TO_IVEC (intNum : int) return Interrupt_Vector;
157    --  Equivalent to the C macro INUM_TO_IVEC used to convert an interrupt
158    --  number to an interrupt vector
159
160    function sysIntEnable (intLevel : int) return STATUS;
161    --  Binding to the C routine sysIntEnable
162
163    function sysIntDisable (intLevel : int) return STATUS;
164    --  Binding to the C routine sysIntDisable
165
166    function sysBusIntAck (intLevel : int) return STATUS;
167    --  Binding to the C routine sysBusIntAck
168
169    function sysBusIntGen (intLevel : int; Intnum : int) return STATUS;
170    --  Binding to the C routine sysBusIntGen. Note that the T2
171    --  documentation implies that a vector address is the proper
172    --  argument - it's not. The interrupt number in the range
173    --  0 .. 255 (for 68K and PPC) is the correct agument.
174
175    procedure logMsg
176      (fmt : String; arg1, arg2, arg3, arg4, arg5, arg6 : int := 0);
177    --  Binding to the C routine logMsg. Note that it is the caller's
178    --  responsibility to ensure that fmt is a null-terminated string
179    --  (e.g logMsg ("Interrupt" & ASCII.NUL))
180
181    type FP_CONTEXT is private;
182    --  Floating point context save and restore. Handlers using floating
183    --  point must be bracketed with these calls. The pFpContext parameter
184    --  should be an object of type FP_CONTEXT that is
185    --  declared local to the handler.
186
187    procedure fppRestore (pFpContext : in out FP_CONTEXT);
188    --  Restore floating point context
189
190    procedure fppSave (pFpContext : in out FP_CONTEXT);
191    --  Save floating point context
192
193 private
194
195    type FP_CONTEXT is new System.VxWorks.FP_CONTEXT;
196    --  Target-dependent floating point context type
197
198    pragma Import (C, intConnect, "intConnect");
199    pragma Import (C, intContext, "intContext");
200    pragma Import (C, intVecGet, "intVecGet");
201    pragma Import (C, intVecSet, "intVecSet");
202    pragma Import (C, INUM_TO_IVEC, "__gnat_inum_to_ivec");
203    pragma Import (C, sysIntEnable, "sysIntEnable");
204    pragma Import (C, sysIntDisable, "sysIntDisable");
205    pragma Import (C, sysBusIntAck, "sysBusIntAck");
206    pragma Import (C, sysBusIntGen, "sysBusIntGen");
207    pragma Import (C, logMsg, "logMsg");
208    pragma Import (C, fppRestore, "fppRestore");
209    pragma Import (C, fppSave, "fppSave");
210 end Interfaces.VxWorks;