1/*
2 * Copyright 2008-2012 Freescale Semiconductor Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *     * Redistributions of source code must retain the above copyright
7 *       notice, this list of conditions and the following disclaimer.
8 *     * Redistributions in binary form must reproduce the above copyright
9 *       notice, this list of conditions and the following disclaimer in the
10 *       documentation and/or other materials provided with the distribution.
11 *     * Neither the name of Freescale Semiconductor nor the
12 *       names of its contributors may be used to endorse or promote products
13 *       derived from this software without specific prior written permission.
14 *
15 *
16 * ALTERNATIVELY, this software may be distributed under the terms of the
17 * GNU General Public License ("GPL") as published by the Free Software
18 * Foundation, either version 2 of that License or (at your option) any
19 * later version.
20 *
21 * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
22 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
25 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33
34/****************************************************************
35 *
36 * File:  mm.h
37 *
38 *
39 * Description:
40 *  MM (Memory Management) object definitions.
41 *  It also includes definitions of the Free Block, Busy Block
42 *  and Memory Block structures used by the MM object.
43 *
44 ****************************************************************/
45
46#ifndef __MM_H
47#define __MM_H
48
49
50#include "mm_ext.h"
51
52#define __ERR_MODULE__  MODULE_MM
53
54
55#define MAKE_ALIGNED(addr, align)    \
56    (((uint64_t)(addr) + ((align) - 1)) & (~(((uint64_t)align) - 1)))
57
58
59/* t_MemBlock data structure defines parameters of the Memory Block */
60typedef struct t_MemBlock
61{
62    struct t_MemBlock *p_Next;      /* Pointer to the next memory block */
63
64    uint64_t  base;                 /* Base address of the memory block */
65    uint64_t  end;                  /* End address of the memory block */
66} t_MemBlock;
67
68
69/* t_FreeBlock data structure defines parameters of the Free Block */
70typedef struct t_FreeBlock
71{
72    struct t_FreeBlock *p_Next;     /* Pointer to the next free block */
73
74    uint64_t  base;                 /* Base address of the block */
75    uint64_t  end;                  /* End address of the block */
76} t_FreeBlock;
77
78
79/* t_BusyBlock data structure defines parameters of the Busy Block  */
80typedef struct t_BusyBlock
81{
82    struct t_BusyBlock *p_Next;         /* Pointer to the next free block */
83
84    uint64_t    base;                   /* Base address of the block */
85    uint64_t    end;                    /* End address of the block */
86    char        name[MM_MAX_NAME_LEN];  /* That block of memory was allocated for
87                                           something specified by the Name */
88} t_BusyBlock;
89
90
91/* t_MM data structure defines parameters of the MM object */
92typedef struct t_MM
93{
94    t_Handle        h_Spinlock;
95
96    t_MemBlock      *memBlocks;     /* List of memory blocks (Memory list) */
97    t_BusyBlock     *busyBlocks;    /* List of busy blocks (Busy list) */
98    t_FreeBlock     *freeBlocks[MM_MAX_ALIGNMENT + 1];
99                                    /* Alignment lists of free blocks (Free lists) */
100
101    uint64_t        freeMemSize;    /* Total size of free memory (in bytes) */
102} t_MM;
103
104
105#endif /* __MM_H */
106