xref: /freebsd/sys/contrib/ncsw/Peripherals/BM/bm_ipc.h (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1 /******************************************************************************
2 
3  � 1995-2003, 2004, 2005-2011 Freescale Semiconductor, Inc.
4  All rights reserved.
5 
6  This is proprietary source code of Freescale Semiconductor Inc.,
7  and its use is subject to the NetComm Device Drivers EULA.
8  The copyright notice above does not evidence any actual or intended
9  publication of such source code.
10 
11  ALTERNATIVELY, redistribution and use in source and binary forms, with
12  or without modification, are permitted provided that the following
13  conditions are met:
14      * Redistributions of source code must retain the above copyright
15        notice, this list of conditions and the following disclaimer.
16      * Redistributions in binary form must reproduce the above copyright
17        notice, this list of conditions and the following disclaimer in the
18        documentation and/or other materials provided with the distribution.
19      * Neither the name of Freescale Semiconductor nor the
20        names of its contributors may be used to endorse or promote products
21        derived from this software without specific prior written permission.
22 
23  THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
24  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
27  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34 
35  **************************************************************************/
36 /**************************************************************************//**
37  @File          bm_ipc.h
38 
39  @Description   BM Inter-Partition prototypes, structures and definitions.
40 *//***************************************************************************/
41 #ifndef __BM_IPC_H
42 #define __BM_IPC_H
43 
44 #include "error_ext.h"
45 #include "std_ext.h"
46 
47 
48 /**************************************************************************//**
49  @Group         BM_grp Frame Manager API
50 
51  @Description   BM API functions, definitions and enums
52 
53  @{
54 *//***************************************************************************/
55 
56 /**************************************************************************//**
57  @Group         BM_IPC_grp BM Inter-Partition messaging Unit
58 
59  @Description   BM Inter-Partition messaging unit API definitions and enums.
60 
61  @{
62 *//***************************************************************************/
63 
64 #define BM_SET_POOL_THRESH          1
65 #define BM_UNSET_POOL_THRESH        2
66 #define BM_GET_COUNTER              3
67 #define BM_GET_REVISION             4
68 #define BM_FORCE_BPID               5
69 #define BM_PUT_BPID                 6
70 #define BM_MASTER_IS_ALIVE          7
71 
72 #define BM_IPC_MAX_REPLY_BODY_SIZE  16
73 #define BM_IPC_MAX_REPLY_SIZE       (BM_IPC_MAX_REPLY_BODY_SIZE + sizeof(uint32_t))
74 #define BM_IPC_MAX_MSG_SIZE         30
75 
76 
77 #if defined(__MWERKS__) && !defined(__GNUC__)
78 #pragma pack(push,1)
79 #endif /* defined(__MWERKS__) && ... */
80 #define MEM_MAP_START
81 
82 typedef _Packed struct t_BmIpcMsg
83 {
84     uint32_t    msgId;
85     uint8_t     msgBody[BM_IPC_MAX_MSG_SIZE];
86 } _PackedType t_BmIpcMsg;
87 
88 typedef _Packed struct t_BmIpcReply
89 {
90     uint32_t    error;
91     uint8_t     replyBody[BM_IPC_MAX_REPLY_BODY_SIZE];
92 } _PackedType t_BmIpcReply;
93 
94 typedef _Packed struct t_BmIpcPoolThreshParams
95 {
96     uint8_t     bpid;                                   /**< IN */
97     uint32_t    thresholds[MAX_DEPLETION_THRESHOLDS];   /**< IN */
98 } _PackedType t_BmIpcPoolThreshParams;
99 
100 typedef _Packed struct t_BmIpcGetCounter
101 {
102     uint8_t         bpid;       /**< IN */
103     uint32_t        enumId;     /**< IN */
104 } _PackedType t_BmIpcGetCounter;
105 
106 typedef _Packed struct t_BmIpcBpidParams
107 {
108     uint8_t         bpid;       /**< IN */
109 } _PackedType t_BmIpcBpidParams;
110 
111 typedef _Packed struct t_BmIpcRevisionInfo {
112     uint8_t         majorRev;               /**< Major revision */
113     uint8_t         minorRev;               /**< Minor revision */
114 } _PackedType t_BmIpcRevisionInfo;
115 
116 #define MEM_MAP_END
117 #if defined(__MWERKS__) && !defined(__GNUC__)
118 #pragma pack(pop)
119 #endif /* defined(__MWERKS__) && ... */
120 
121 /** @} */ /* end of BM_IPC_grp group */
122 /** @} */ /* end of BM_grp group */
123 
124 
125 #endif /* __BM_IPC_H */
126