1 /*
2 * Copyright (c) 2013, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 /*
33 * ======== GateHwi.xdc ========
34 *
35 */
36 package ti.sysbios.gates
37
38 import xdc.rov.ViewInfo;
39
40 /*!
41 * ======== GateHwi ========
42 * Hardware Interrupt Gate.
43 *
44 * GateHwi uses disabling and enabling of interrupts as the resource locking
45 * mechanism. Such a gate guarantees exclusive access to the CPU. This gate
46 * can be used whenever the resource is being shared by Tasks, Swis, and/or
47 * Hwis.
48 *
49 * The duration between the enter and leave should be as short as possible
50 * to minimize Hwi latency.
51 *
52 * GateHwi inherits from xdc.runtime.IGateProvider, therefore supports nesting.
53 *
54 * @p(html) 55 * <h3> Calling Context </h3>
56 * <table border="1" cellpadding="3">
57 * <colgroup span="1"></colgroup> <colgroup span="5" align="center">
58 * </colgroup>
59 *
60 * <tr><th> Function </th><th> Hwi </th><th> Swi </th><th> Task </th>
61 * <th> Main </th><th> Startup </th></tr>
62 * <!-- -->
63 * <tr><td> {@link #Params_init} </td><td> Y </td><td> Y </td>
64 * <td> Y </td><td> Y </td><td> Y </td></tr>
65 * <tr><td> {@link #query} </td><td> Y </td><td> Y </td>
66 * <td> Y </td><td> Y </td><td> Y </td></tr>
67 * <tr><td> {@link #construct} </td><td> Y </td><td> Y </td>
68 * <td> Y </td><td> Y </td><td> N </td></tr>
69 * <tr><td> {@link #create} </td><td> N* </td><td> N* </td>
70 * <td> Y </td><td> Y </td><td> N </td></tr>
71 * <tr><td> {@link #delete} </td><td> N* </td><td> N* </td>
72 * <td> Y </td><td> Y </td><td> N </td></tr>
73 * <tr><td> {@link #destruct} </td><td> Y </td><td> Y </td>
74 * <td> Y </td><td> Y </td><td> N </td></tr>
75 * <tr><td> {@link #enter} </td><td> Y </td><td> Y </td>
76 * <td> Y </td><td> Y** </td><td> Y** </td></tr>
77 * <tr><td> {@link #leave} </td><td> Y </td><td> Y </td>
78 * <td> Y </td><td> Y** </td><td> Y** </td></tr>
79 * <tr><td colspan="6"> Definitions: <br />
80 * <ul>
81 * <li> <b>Hwi</b>: API is callable from a Hwi thread. </li>
82 * <li> <b>Swi</b>: API is callable from a Swi thread. </li>
83 * <li> <b>Task</b>: API is callable from a Task thread. </li>
84 * <li> <b>Main</b>: API is callable during any of these phases: </li>
85 * <ul>
86 * <li> In your module startup after this module is started
87 * (e.g. GateHwi_Module_startupDone() returns TRUE). </li>
88 * <li> During xdc.runtime.Startup.lastFxns. </li>
89 * <li> During main().</li>
90 * <li> During BIOS.startupFxns.</li>
91 * </ul>
92 * <li> <b>Startup</b>: API is callable during any of these phases:</li>
93 * <ul>
94 * <li> During xdc.runtime.Startup.firstFxns.</li>
95 * <li> In your module startup before this module is started
96 * (e.g. GateHwi_Module_startupDone() returns FALSE).</li>
97 * </ul>
98 * <li> <b>*</b>: Assuming blocking Heap is used for creation. </li>
99 * <li> <b>**</b>: Must be used in enter/leave pairs. </li>
100 * </ul>
101 * </td></tr>
102 *
103 * </table>
104 * @p 105 */
106
107 module GateHwi inherits xdc.runtime.IGateProvider
108 {
109 /*!
110 * ======== BasicView ========
111 * @_nodoc 112 */
113 metaonlystruct BasicView {
114 String label;
115 }
116
117 /*!
118 * ======== rovViewInfo ========
119 * @_nodoc 120 */
121 @Facet
122 metaonlyconfig ViewInfo.Instance rovViewInfo =
123 ViewInfo.create({
124 viewMap: [
125 ['Basic', {type: ViewInfo.INSTANCE, viewInitFxn: 'viewInitBasic', structName: 'BasicView'}],
126 ]
127 });
128
129 instance:
130
131 override IArg enter();
132
133 override Void leave(IArg key);
134
135 internal:
136
137 /*!
138 * @_nodoc 139 * ======== Instance_State ========
140 * XDC requires this be defined, even though it's empty.
141 */
142 struct Instance_State {
143 };
144 }