• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * Copyright (c) 2019, The Linux Foundation. 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 are
6  * met:
7  *    * Redistributions of source code must retain the above copyright
8  *      notice, this list of conditions and the following disclaimer.
9  *    * Redistributions in binary form must reproduce the above
10  *      copyright notice, this list of conditions and the following
11  *      disclaimer in the documentation and/or other materials provided
12  *      with the distribution.
13  *    * Neither the name of The Linux Foundation nor the names of its
14  *      contributors may be used to endorse or promote products derived
15  *      from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef _ADSPMSGD_ADSP1_H
31 #define _ADSPMSGD_ADSP1_H
32 #include "AEEStdDef.h"
33 #include "remote.h"
34 #ifndef __QAIC_HEADER
35 #define __QAIC_HEADER(ff) ff
36 #endif //__QAIC_HEADER
37 
38 #ifndef __QAIC_HEADER_EXPORT
39 #define __QAIC_HEADER_EXPORT
40 #endif // __QAIC_HEADER_EXPORT
41 
42 #ifndef __QAIC_HEADER_ATTRIBUTE
43 #define __QAIC_HEADER_ATTRIBUTE
44 #endif // __QAIC_HEADER_ATTRIBUTE
45 
46 #ifndef __QAIC_IMPL
47 #define __QAIC_IMPL(ff) ff
48 #endif //__QAIC_IMPL
49 
50 #ifndef __QAIC_IMPL_EXPORT
51 #define __QAIC_IMPL_EXPORT
52 #endif // __QAIC_IMPL_EXPORT
53 
54 #ifndef __QAIC_IMPL_ATTRIBUTE
55 #define __QAIC_IMPL_ATTRIBUTE
56 #endif // __QAIC_IMPL_ATTRIBUTE
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 #define _const_adspmsgd_adsp1_handle 5
61 /**
62     * Opens the handle in the specified domain.  If this is the first
63     * handle, this creates the session.  Typically this means opening
64     * the device, aka open("/dev/adsprpc-smd"), then calling ioctl
65     * device APIs to create a PD on the DSP to execute our code in,
66     * then asking that PD to dlopen the .so and dlsym the skel function.
67     *
68     * @param uri, <interface>_URI"&_dom=aDSP"
69     *    <interface>_URI is a QAIC generated uri, or
70     *    "file:///<sofilename>?<interface>_skel_handle_invoke&_modver=1.0"
71     *    If the _dom parameter is not present, _dom=DEFAULT is assumed
72     *    but not forwarded.
73     *    Reserved uri keys:
74     *      [0]: first unamed argument is the skel invoke function
75     *      _dom: execution domain name, _dom=mDSP/aDSP/DEFAULT
76     *      _modver: module version, _modver=1.0
77     *      _*: any other key name starting with an _ is reserved
78     *    Unknown uri keys/values are forwarded as is.
79     * @param h, resulting handle
80     * @retval, 0 on success
81     */
82 __QAIC_HEADER_EXPORT int __QAIC_HEADER(adspmsgd_adsp1_open)(const char* uri, remote_handle64* h) __QAIC_HEADER_ATTRIBUTE;
83 /**
84     * Closes a handle.  If this is the last handle to close, the session
85     * is closed as well, releasing all the allocated resources.
86 
87     * @param h, the handle to close
88     * @retval, 0 on success, should always succeed
89     */
90 __QAIC_HEADER_EXPORT int __QAIC_HEADER(adspmsgd_adsp1_close)(remote_handle64 h) __QAIC_HEADER_ATTRIBUTE;
91 __QAIC_HEADER_EXPORT int __QAIC_HEADER(adspmsgd_adsp1_init2)(remote_handle64 _h) __QAIC_HEADER_ATTRIBUTE;
92 __QAIC_HEADER_EXPORT int __QAIC_HEADER(adspmsgd_adsp1_deinit)(remote_handle64 _h) __QAIC_HEADER_ATTRIBUTE;
93 #ifndef adspmsgd_adsp1_URI
94 #define adspmsgd_adsp1_URI "file:///libadspmsgd_adsp1_skel.so?adspmsgd_adsp1_skel_handle_invoke&_modver=1.0"
95 #endif /*adspmsgd_adsp1_URI*/
96 #ifdef __cplusplus
97 }
98 #endif
99 #endif //_ADSPMSGD_ADSP1_H
100