xref: /utopia/UTPA2-700.0.x/modules/mbx/drv/mbx/linux/mdrv_mbx_io.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ///////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ///////////////////////////////////////////////////////////////////////////////
94 //////////////////////////////////////////////////////////////////////////////////////////////////
95 //
96 // @file   mdrv_mbx_io.h
97 // @brief  Mialbox KMD Driver Interface
98 // @author MStar Semiconductor Inc.
99 //
100 // Driver to initialize and access mailbox.
101 //     - Provide functions to initialize/de-initialize mailbox
102 //     - Provide mailbox functional access.
103 //////////////////////////////////////////////////////////////////////////////////////////////////
104 
105 #ifndef _MDRV_MBX_IO_H
106 #define _MDRV_MBX_IO_H
107 
108 //=============================================================================
109 // Includs
110 //=============================================================================
111 #include "mdrv_mbx_st.h"
112 
113 //=============================================================================
114 // Defines
115 //=============================================================================
116 //IO Ctrl defines:
117 #define MDRV_MBX_IOC_INIT_NR				0
118 #define MDRV_MBX_IOC_DEINIT_NR			MDRV_MBX_IOC_INIT_NR+1
119 #define MDRV_MBX_IOC_REGISTERMSG_NR		MDRV_MBX_IOC_DEINIT_NR+1
120 #define MDRV_MBX_IOC_UNREGISTERMSG_NR	MDRV_MBX_IOC_REGISTERMSG_NR+1
121 #define MDRV_MBX_IOC_CLEARMSG_NR         MDRV_MBX_IOC_UNREGISTERMSG_NR+1
122 #define MDRV_MBX_IOC_SENDMSG_NR			MDRV_MBX_IOC_CLEARMSG_NR+1
123 #define MDRV_MBX_IOC_SENDMSGLOOPBACK_NR MDRV_MBX_IOC_SENDMSG_NR+1
124 #define MDRV_MBX_IOC_RECVMSG_NR			MDRV_MBX_IOC_SENDMSGLOOPBACK_NR+1
125 #define MDRV_MBX_IOC_GETMSGQSTATUS_NR	MDRV_MBX_IOC_RECVMSG_NR+1
126 #define MDRV_MBX_IOC_MBXENABLE_NR		MDRV_MBX_IOC_GETMSGQSTATUS_NR+1
127 #define MDRV_MBX_IOC_SETINFORMATION_NR   MDRV_MBX_IOC_MBXENABLE_NR+1
128 #define MDRV_MBX_IOC_GETINFORMATION_NR   MDRV_MBX_IOC_SETINFORMATION_NR+1
129 #define MDRV_MBX_IOC_GETDRVSTATUS_NR     MDRV_MBX_IOC_GETINFORMATION_NR+1
130 #define MDRV_MBX_IOC_CHECKMSG_NR		MDRV_MBX_IOC_GETDRVSTATUS_NR+1
131 #define MDRV_MBX_IOC_REMOVEMSG_NR		MDRV_MBX_IOC_CHECKMSG_NR+1
132 
133 #define MDRV_MBX_IOC_MAX_NR				MDRV_MBX_IOC_REMOVEMSG_NR+1
134 
135 // use 'm' as magic number
136 #define MDRV_MBX_IOC_MAGIC			  'm'
137 #define MDRV_MBX_IOC_INIT         	  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_INIT_NR, MS_MBX_INIT_INFO)
138 #define MDRV_MBX_IOC_DEINIT			  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_DEINIT_NR, MS_MBX_SET_BINFO)
139 #define MDRV_MBX_IOC_REGISTERMSG		  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_REGISTERMSG_NR, MS_MBX_REGISTER_MSG)
140 #define MDRV_MBX_IOC_UNREGISTERMSG	  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_UNREGISTERMSG_NR, MS_MBX_UNREGISTER_MSG)
141 #define MDRV_mBX_IOC_CLEARMSG          _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_CLEARMSG_NR, MS_MBX_CLEAR_MSG)
142 #define MDRV_MBX_IOC_SENDMSG			  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_SENDMSG_NR, MS_MBX_SEND_MSG)
143 #define MDRV_MBX_IOC_RECVMSG			  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_RECVMSG_NR, MS_MBX_RECV_MSG)
144 #define MDRV_MBX_IOC_CHECKMSG           _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_CHECKMSG_NR, MS_MBX_RECV_MSG)
145 #define MDRV_MBX_IOC_REMOVEMSG           _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_REMOVEMSG_NR, MS_MBX_SET_BINFO)
146 #define MDRV_MBX_IOC_GETMSGQSTATUS	  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_GETMSGQSTATUS_NR, MS_MBX_GET_MSGQSTATUS)
147 #define MDRV_MBX_IOC_SENDMSGLOOPBACK   _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_SENDMSGLOOPBACK_NR, MS_MBX_SEND_MSG)
148 #define MDRV_MBX_IOC_MBXENABLE		  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_MBXENABLE_NR, MS_MBX_SET_BINFO)
149 #define MDRV_MBX_IOC_SETINFORMATION	  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_SETINFORMATION_NR, MS_MBX_CPROSYNC_INFORMATION)
150 #define MDRV_MBX_IOC_GETINFORMATION	  _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_GETINFORMATION_NR, MS_MBX_CPROSYNC_INFORMATION)
151 #define MDRV_MBX_IOC_GETDRVSTATUS      _IOWR(MDRV_MBX_IOC_MAGIC, MDRV_MBX_IOC_GETDRVSTATUS_NR, MS_MBX_GET_DRVSTATUS)
152 
153 #endif //_MDRV_MBX_IO_H
154