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