xref: /freebsd/sys/contrib/ncsw/Peripherals/QM/qm_ipc.h (revision 82aa34e6fa1cd5a4ad401383522daf51412ea4b2)
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          QM_ipc.h
38 
39  @Description   QM Inter-Partition prototypes, structures and definitions.
40 *//***************************************************************************/
41 #ifndef __QM_IPC_H
42 #define __QM_IPC_H
43 
44 #include "error_ext.h"
45 #include "std_ext.h"
46 
47 
48 /**************************************************************************//**
49  @Group         QM_grp Frame Manager API
50 
51  @Description   QM API functions, definitions and enums
52 
53  @{
54 *//***************************************************************************/
55 
56 /**************************************************************************//**
57  @Group         QM_IPC_grp Qm Inter-Partition messaging Unit
58 
59  @Description   QM Inter-Partition messaging unit API definitions and enums.
60 
61  @{
62 *//***************************************************************************/
63 
64 #define QM_FORCE_FQID               1
65 #define QM_PUT_FQID                 2
66 #define QM_GET_COUNTER              3
67 #define QM_GET_SET_PORTAL_PARAMS    4
68 #define QM_GET_REVISION             5
69 #define QM_MASTER_IS_ALIVE          6
70 
71 #define QM_IPC_MAX_REPLY_BODY_SIZE  16
72 #define QM_IPC_MAX_REPLY_SIZE       (QM_IPC_MAX_REPLY_BODY_SIZE + sizeof(uint32_t))
73 #define QM_IPC_MAX_MSG_SIZE         30
74 
75 #if defined(__MWERKS__) && !defined(__GNUC__)
76 #pragma pack(push,1)
77 #endif /* defined(__MWERKS__) && ... */
78 #define MEM_MAP_START
79 
80 typedef _Packed struct t_QmIpcMsg
81 {
82     uint32_t    msgId;
83     uint8_t     msgBody[QM_IPC_MAX_MSG_SIZE];
84 } _PackedType   t_QmIpcMsg;
85 
86 typedef _Packed struct t_QmIpcReply
87 {
88     uint32_t    error;
89     uint8_t     replyBody[QM_IPC_MAX_REPLY_BODY_SIZE];
90 } _PackedType t_QmIpcReply;
91 
92 typedef _Packed struct t_QmIpcGetCounter
93 {
94     uint32_t        enumId;     /**< IN */
95 } _PackedType t_QmIpcGetCounter;
96 
97 typedef _Packed struct t_QmIpcFqidParams
98 {
99     uint32_t         fqid;       /**< IN */
100     uint32_t         size;       /**< IN */
101 } _PackedType t_QmIpcFqidParams;
102 
103 typedef _Packed struct t_QmIpcPortalInitParams {
104     uint8_t             portalId;       /**< IN */
105     uint8_t             stashDestQueue; /**< IN */
106     uint16_t            liodn;          /**< IN */
107     uint16_t            dqrrLiodn;      /**< IN */
108     uint16_t            fdFqLiodn;      /**< IN */
109 } _PackedType t_QmIpcPortalInitParams;
110 
111 typedef _Packed struct t_QmIpcRevisionInfo {
112     uint8_t         majorRev;               /**< OUT: Major revision */
113     uint8_t         minorRev;               /**< OUT: Minor revision */
114 } _PackedType t_QmIpcRevisionInfo;
115 
116 #define MEM_MAP_END
117 #if defined(__MWERKS__) && !defined(__GNUC__)
118 #pragma pack(pop)
119 #endif /* defined(__MWERKS__) && ... */
120 
121 /** @} */ /* end of QM_IPC_grp group */
122 /** @} */ /* end of QM_grp group */
123 
124 
125 #endif /* __QM_IPC_H */
126