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 * ======== package.xdc ========
34 *
35 */
36
37 requires ti.sysbios.interfaces;
38
39 /*!
40 * ======== ti.sysbios.heaps ========
41 * Contains modules that inherit from IHeap.
42 *
43 * A "Heap" is a module that implements the IHeap interface. Heaps are
44 * dynamic memory managers: they manage a specific piece of memory and
45 * support allocating and freeing pieces ("blocks") of that memory.
46 *
47 * The {@link xdc.runtime.Memory} module is the common interface for all
48 * memory operations. Actual memory management is performed by a Heap
49 * instance, such as an instance of HeapMem or HeapBuf. For example,
50 * Memory_alloc() is used at runtime to dynamically allocate memory.
51 * All of the Memory APIs take a Heap instance as one of their parameters.
52 * Internally, the Memory module calls into the heap�s interface functions.
53 *
54 * The xdc.runtime.Memory module is documented in the XDCtools online help.
55 * Implementations of Heaps provided by SYS/BIOS are discussed here.
56 *
57 * Memory allocation sizes are measured in "Minimum Addressable Units"
58 * (MAUs) of memory. An MAU is the smallest unit of data storage that can
59 * be read or written by the CPU. For the C5000, this is a 16-bit word.
60 * For the C28x, this is an 16-bit word. For the all other currently
61 * supported target families�including C6000, ARM, and MSP430�this is an
62 * 8-bit byte.
63 *
64 */
65 package ti.sysbios.heaps [2,0,0,0] {
66 module HeapBuf;
67 module HeapMem;
68 module HeapMultiBuf;
69 module HeapNull;
70 module HeapTrack;
71 module HeapCallback;
72 }