xref: /freebsd/sys/contrib/ncsw/inc/integrations/part_ext.h (revision 8ef24a0d4b28fe230e20637f56869cc4148cd2ca)
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          part_ext.h
36 
37  @Description   Definitions for the part (integration) module.
38 *//***************************************************************************/
39 
40 #ifndef __PART_EXT_H
41 #define __PART_EXT_H
42 
43 #include "std_ext.h"
44 #include "part_integration_ext.h"
45 
46 
47 #if !(defined(MPC8306) || \
48       defined(MPC8309) || \
49       defined(MPC834x) || \
50       defined(MPC836x) || \
51       defined(MPC832x) || \
52       defined(MPC837x) || \
53       defined(MPC8568) || \
54       defined(MPC8569) || \
55       defined(P1020)   || \
56       defined(P1021)   || \
57       defined(P1022)   || \
58       defined(P1023)   || \
59       defined(P2020)   || \
60       defined(P2040)   || \
61       defined(P2041)   || \
62       defined(P3041)   || \
63       defined(P4080)   || \
64       defined(SC4080)  || \
65       defined(P5020)   || \
66       defined(MSC814x))
67 #error "unable to proceed without chip-definition"
68 #endif /* !(defined(MPC834x) || ... */
69 
70 
71 /**************************************************************************//*
72  @Description   Part data structure - must be contained in any integration
73                 data structure.
74 *//***************************************************************************/
75 typedef struct t_Part
76 {
77     uintptr_t   (* f_GetModuleBase)(t_Handle h_Part, e_ModuleId moduleId);
78                 /**< Returns the address of the module's memory map base. */
79     e_ModuleId  (* f_GetModuleIdByBase)(t_Handle h_Part, uintptr_t baseAddress);
80                 /**< Returns the module's ID according to its memory map base. */
81 } t_Part;
82 
83 
84 #endif /* __PART_EXT_H */
85