QNX: GateMP: Check Number of Resources for Gates Before Mapping
[ipc/ipcdev.git] / qnx / include / _GateMP.h
1 /*
2  * Copyright (c) 2013, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
33 /*
34  *  ======== _GateMP.h ========
35  *
36  *  Internal header
37  *
38  */
39 #ifndef _GATEMP_H
40 #define _GATEMP_H
42 #include <ti/ipc/GateMP.h>
44 #include <ti/syslink/inc/IObject.h>
45 #include <ti/syslink/utils/IGateProvider.h>
47 #if defined (__cplusplus)
48 extern "C" {
49 #endif
51 /* Helper macros */
52 #define GETREMOTE(mask) ((GateMP_RemoteProtect)(mask >> 8))
53 #define GETLOCAL(mask)  ((GateMP_LocalProtect)(mask & 0xFF))
54 #define SETMASK(remoteProtect, localProtect) \
55                         ((Bits32)(remoteProtect << 8 | localProtect))
57 /*!
58  *  @brief  Structure for the Handle for the GateMP.
59  */
60 typedef struct {
61     GateMP_Params           params;
62     /*!< Instance specific creation parameters */
63     GateMP_RemoteProtect    remoteProtect;
64     GateMP_LocalProtect     localProtect;
65     Ptr                     nsKey;
66     Int                     numOpens;
68     Bits16                  mask;
69     Bits16                  creatorProcId;
70     Bits32                  arg;
72     IGateProvider_Handle    gateHandle; /* remote gate handle */
73     Ipc_ObjType             objType;
74     IGateProvider_Handle    localGate;  /* local gate handle */
76     UInt                    resourceId;
77     /*!< Resource id of GateMP proxy */
78 } GateMP_Object;
80 /* Has GateMP been setup */
81 Bool GateMP_isSetup(Void);
83 #if defined (__cplusplus)
84 }
85 #endif /* defined (__cplusplus) */
87 #endif /* _GATEMP_H */