xref: /freebsd/sys/contrib/vchiq/interface/vchiq_arm/vchiq_memdrv.h (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1 /**
2  * Copyright (c) 2010-2012 Broadcom. 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions, and the following disclaimer,
9  *    without modification.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The names of the above-listed copyright holders may not be used
14  *    to endorse or promote products derived from this software without
15  *    specific prior written permission.
16  *
17  * ALTERNATIVELY, this software may be distributed under the terms of the
18  * GNU General Public License ("GPL") version 2, as published by the Free
19  * Software Foundation.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef VCHIQ_MEMDRV_H
35 #define VCHIQ_MEMDRV_H
36 
37 /* ---- Include Files ----------------------------------------------------- */
38 
39 #include <linux/kernel.h>
40 #include "vchiq_if.h"
41 
42 /* ---- Constants and Types ---------------------------------------------- */
43 
44 typedef struct {
45 	 void                   *armSharedMemVirt;
46 	 dma_addr_t              armSharedMemPhys;
47 	 size_t                  armSharedMemSize;
48 
49 	 void                   *vcSharedMemVirt;
50 	 dma_addr_t              vcSharedMemPhys;
51 	 size_t                  vcSharedMemSize;
52 } VCHIQ_SHARED_MEM_INFO_T;
53 
54 /* ---- Variable Externs ------------------------------------------------- */
55 
56 /* ---- Function Prototypes ---------------------------------------------- */
57 
58 void vchiq_get_shared_mem_info(VCHIQ_SHARED_MEM_INFO_T *info);
59 
60 VCHIQ_STATUS_T vchiq_memdrv_initialise(void);
61 
62 VCHIQ_STATUS_T vchiq_userdrv_create_instance(
63 	const VCHIQ_PLATFORM_DATA_T * platform_data);
64 
65 VCHIQ_STATUS_T vchiq_userdrv_suspend(
66 	const VCHIQ_PLATFORM_DATA_T * platform_data);
67 
68 VCHIQ_STATUS_T vchiq_userdrv_resume(
69 	const VCHIQ_PLATFORM_DATA_T * platform_data);
70 
71 #endif
72