xref: /freebsd/sys/contrib/ncsw/etc/mm.h (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1 /* Copyright (c) 2008-2011 Freescale Semiconductor, Inc.
2  * All rights reserved.
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  * File:  mm.h
36  *
37  *
38  * Description:
39  *  MM (Memory Management) object definitions.
40  *  It also includes definitions of the Free Block, Busy Block
41  *  and Memory Block structures used by the MM object.
42  *
43  ****************************************************************/
44 
45 #ifndef __MM_H
46 #define __MM_H
47 
48 
49 #include "mm_ext.h"
50 
51 #define __ERR_MODULE__  MODULE_MM
52 
53 
54 #define MAKE_ALIGNED(addr, align)    \
55     (((uint64_t)(addr) + ((align) - 1)) & (~(((uint64_t)align) - 1)))
56 
57 
58 /* t_MemBlock data stucutre defines parameters of the Memory Block */
59 typedef struct t_MemBlock
60 {
61     struct t_MemBlock *p_Next;      /* Pointer to the next memory block */
62 
63     uint64_t  base;                 /* Base address of the memory block */
64     uint64_t  end;                  /* End address of the memory block */
65 } t_MemBlock;
66 
67 
68 /* t_FreeBlock data stucutre defines parameters of the Free Block */
69 typedef struct t_FreeBlock
70 {
71     struct t_FreeBlock *p_Next;     /* Pointer to the next free block */
72 
73     uint64_t  base;                 /* Base address of the block */
74     uint64_t  end;                  /* End address of the block */
75 } t_FreeBlock;
76 
77 
78 /* t_BusyBlock data stucutre defines parameters of the Busy Block  */
79 typedef struct t_BusyBlock
80 {
81     struct t_BusyBlock *p_Next;         /* Pointer to the next free block */
82 
83     uint64_t    base;                   /* Base address of the block */
84     uint64_t    end;                    /* End address of the block */
85     char        name[MM_MAX_NAME_LEN];  /* That block of memory was allocated for
86                                            something specified by the Name */
87 } t_BusyBlock;
88 
89 
90 /* t_MM data structure defines parameters of the MM object */
91 typedef struct t_MM
92 {
93     t_MemBlock      *memBlocks;     /* List of memory blocks (Memory list) */
94     t_BusyBlock     *busyBlocks;    /* List of busy blocks (Busy list) */
95     t_FreeBlock     *freeBlocks[MM_MAX_ALIGNMENT + 1];
96                                     /* Alignment lists of free blocks (Free lists) */
97     t_Handle        h_Spinlock;
98 } t_MM;
99 
100 
101 #endif /* __MM_H */
102