1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS --
5 -- I N T E R F A C E S . V X W O R K S --
9 -- Copyright (C) 1999-2008, AdaCore --
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. --
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. --
29 -- GNARL was developed by the GNARL team at Florida State University. --
30 -- Extensive contributions were provided by Ada Core Technologies, Inc. --
32 ------------------------------------------------------------------------------
34 -- This is the x86 VxWorks version of this package
36 -- This package provides a limited binding to the VxWorks API
37 -- In particular, it interfaces with the VxWorks hardware interrupt
38 -- facilities, allowing the use of low-latency direct-vectored
39 -- interrupt handlers. Note that such handlers have a variety of
40 -- restrictions regarding system calls and language constructs. In particular,
41 -- the use of exception handlers and functions returning variable-length
42 -- objects cannot be used. Less restrictive, but higher-latency handlers can
43 -- be written using Ada protected procedures, Ada 83 style interrupt entries,
44 -- or by signalling an Ada task from within an interrupt handler using a
45 -- binary semaphore as described in the VxWorks Programmer's Manual.
47 -- For complete documentation of the operations in this package, please
48 -- consult the VxWorks Programmer's Manual and VxWorks Reference Manual.
50 pragma Warnings (Off, "*foreign convention*");
51 pragma Warnings (Off, "*add Convention pragma*");
55 package Interfaces.VxWorks is
58 ------------------------------------------------------------------------
59 -- Here is a complete example that shows how to handle the Interrupt 0x33
60 -- with a direct-vectored interrupt handler in Ada using this package:
62 -- with Interfaces.VxWorks; use Interfaces.VxWorks;
68 -- pragma Atomic (Count);
70 -- procedure Handler (Parameter : System.Address);
76 -- procedure Handler (Parameter : System.Address) is
78 -- Count := Count + 1;
79 -- logMsg ("received an interrupt" & ASCII.LF & ASCII.NUL);
83 -- with Interfaces.VxWorks; use Interfaces.VxWorks;
84 -- with Ada.Text_IO; use Ada.Text_IO;
85 -- with Ada.Interrupts;
86 -- with Machine_Code; use Machine_Code;
89 -- procedure Useint is
90 -- -- Be sure to use a reasonable interrupt number for the target
92 -- -- This one is an unreserved interrupt for the Pentium 3 BSP
93 -- Interrupt : constant := 16#33#;
102 -- Put_Line ("Generating an interrupt...");
105 -- -- Generate interrupt, using interrupt number
108 -- Ada.Interrupts.Interrupt_ID'Asm_Input
109 -- ("i", Interrupt));
114 -- S := intConnect (INUM_TO_IVEC (Interrupt), Handler'Access);
118 -- Put_Line ("value of count:" & P.Count'Img);
121 -------------------------------------
123 subtype int is Integer;
125 type STATUS is new int;
126 -- Equivalent of the C type STATUS
128 OK : constant STATUS := 0;
129 ERROR : constant STATUS := -1;
131 type VOIDFUNCPTR is access procedure (parameter : System.Address);
132 type Interrupt_Vector is new System.Address;
133 type Exception_Vector is new System.Address;
136 (vector : Interrupt_Vector;
137 handler : VOIDFUNCPTR;
138 parameter : System.Address := System.Null_Address) return STATUS;
139 -- Binding to the C routine intConnect. Use this to set up an
140 -- user handler. The routine generates a wrapper around the user
141 -- handler to save and restore context
143 function intContext return int;
144 -- Binding to the C routine intContext. This function returns 1 only
145 -- if the current execution state is in interrupt context.
148 (Vector : Interrupt_Vector) return VOIDFUNCPTR;
149 -- Binding to the C routine intVecGet. Use this to get the
150 -- existing handler for later restoral
153 (Vector : Interrupt_Vector;
154 Handler : VOIDFUNCPTR);
155 -- Binding to the C routine intVecSet. Use this to restore a
156 -- handler obtained using intVecGet
159 (vector : Interrupt_Vector;
160 pFunction : out VOIDFUNCPTR;
161 pIdtGate : not null access int;
162 pIdtSelector : not null access int);
163 -- Binding to the C routine intVecGet2. Use this to get the
164 -- existing handler for later restoral
167 (vector : Interrupt_Vector;
168 pFunction : VOIDFUNCPTR;
169 pIdtGate : not null access int;
170 pIdtSelector : not null access int);
171 -- Binding to the C routine intVecSet2. Use this to restore a
172 -- handler obtained using intVecGet2
174 function INUM_TO_IVEC (intNum : int) return Interrupt_Vector;
175 -- Equivalent to the C macro INUM_TO_IVEC used to convert an interrupt
176 -- number to an interrupt vector
179 (fmt : String; arg1, arg2, arg3, arg4, arg5, arg6 : int := 0);
180 -- Binding to the C routine logMsg. Note that it is the caller's
181 -- responsibility to ensure that fmt is a null-terminated string
182 -- (e.g logMsg ("Interrupt" & ASCII.NUL))
184 type FP_CONTEXT is private;
185 -- Floating point context save and restore. Handlers using floating
186 -- point must be bracketed with these calls. The pFpContext parameter
187 -- should be an object of type FP_CONTEXT that is
188 -- declared local to the handler.
189 -- See the VxWorks Intel Architecture Supplement regarding
192 procedure fppRestore (pFpContext : in out FP_CONTEXT);
193 -- Restore floating point context - old style
195 procedure fppSave (pFpContext : in out FP_CONTEXT);
196 -- Save floating point context - old style
198 procedure fppXrestore (pFpContext : in out FP_CONTEXT);
199 -- Restore floating point context - new style
201 procedure fppXsave (pFpContext : in out FP_CONTEXT);
202 -- Save floating point context - new style
206 type FP_CONTEXT is new System.VxWorks.FP_CONTEXT;
207 -- Target-dependent floating point context type
209 pragma Import (C, intConnect, "intConnect");
210 pragma Import (C, intContext, "intContext");
211 pragma Import (C, intVecGet, "intVecGet");
212 pragma Import (C, intVecSet, "intVecSet");
213 pragma Import (C, intVecGet2, "intVecGet2");
214 pragma Import (C, intVecSet2, "intVecSet2");
215 pragma Import (C, INUM_TO_IVEC, "__gnat_inum_to_ivec");
216 pragma Import (C, logMsg, "logMsg");
217 pragma Import (C, fppRestore, "fppRestore");
218 pragma Import (C, fppSave, "fppSave");
219 pragma Import (C, fppXrestore, "fppXrestore");
220 pragma Import (C, fppXsave, "fppXsave");
221 end Interfaces.VxWorks;