1 /*
2 * Copyright (c) 2012, 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 * ======== Cache.xdc ========
34 *
35 */
36 package ti.sysbios.hal;
37
38 import xdc.rov.ViewInfo;
39
40 /*!
41 * ======== Cache ========
42 * Cache Manager Proxy.
43 *
44 * This module is a proxy to the generic Cache module functions
45 * as defined in ICache.xdc.
46 *
47 * The actual implementations of the Cache module functions are
48 * provided by the Cache module delegates.
49 *
50 * Additional, family-specific Cache module APIs may also be provided
51 * by the Cache module delegates.
52 *
53 * Follow the link below to determine which Cache delegate is used
54 * for your Target/Device:
55 *
56 * {@link ./../family/doc-files/delegates.html Delegate Mappings}
57 *
58 * @p(html)
59 * <h3> Calling Context </h3>
60 * <table border="1" cellpadding="3">
61 * <colgroup span="1"></colgroup> <colgroup span="5" align="center">
62 * </colgroup>
63 *
64 * <tr><th> Function </th><th> Hwi </th><th> Swi </th>
65 * <th> Task </th><th> Main </th><th> Startup </th></tr>
66 * <!-- -->
67 * <tr><td> {@link #disable} </td><td> Y </td><td> Y </td>
68 * <td> Y </td><td> Y </td><td> Y </td></tr>
69 * <tr><td> {@link #enable} </td><td> Y </td><td> Y </td>
70 * <td> Y </td><td> Y </td><td> Y </td></tr>
71 * <tr><td> {@link #inv} </td><td> Y </td><td> Y </td>
72 * <td> Y </td><td> Y </td><td> Y </td></tr>
73 * <tr><td> {@link #wait} </td><td> Y </td><td> Y </td>
74 * <td> Y </td><td> Y </td><td> Y </td></tr>
75 * <tr><td> {@link #wb} </td><td> Y </td><td> Y </td>
76 * <td> Y </td><td> Y </td><td> Y </td></tr>
77 * <tr><td> {@link #wbInv} </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. Cache_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. Cache_Module_startupDone() returns FALSE).</li>
97 * </ul>
98 * </ul>
99 * </td></tr>
100 *
101 * </table>
102 * @p
103 */
104
105 module Cache inherits ti.sysbios.interfaces.ICache
106 {
107
108 internal: /* not for client use */
109
110 /*!
111 * ======== CacheProxy ========
112 * Target/device-specific Cache implementation
113 */
114 proxy CacheProxy inherits ti.sysbios.interfaces.ICache;
115 }