xref: /xnu-11215.41.3/osfmk/kern/exclaves_sensor.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2023 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #if CONFIG_EXCLAVES
30 
31 #pragma once
32 
33 #include <mach/exclaves.h>
34 #include <mach/kern_return.h>
35 
36 #include <stdint.h>
37 
38 __BEGIN_DECLS
39 
40 /*!
41  * @function exclaves_sensor_copy
42  *
43  * @abstract
44  * Allow a copy from an aribtrated audio memory segment
45  *
46  * @param buffer
47  * Identifies which arbitrated memory buffer to operate on
48  *
49  * @param size1
50  * The length in bytes of the data to be copied
51  *
52  * @param offset1
53  * Offset in bytes of the data to be copied
54  *
55  * @param size2
56  * The length in bytes of the data to be copied
57  *
58  * @param offset2
59  * Offset in bytes of the data to be copied
60  *
61  * @param sensor_status
62  * Out parameter filled with the sensor status.
63  *
64  * @result
65  * KERN_SUCCESS or mach system call error code.
66  */
67 kern_return_t
68 exclaves_sensor_copy(uint32_t buffer, uint64_t size1,
69     uint64_t offset1, uint64_t size2, uint64_t offset2,
70     exclaves_sensor_status_t *sensor_status);
71 
72 __END_DECLS
73 
74 #endif /* CONFIG_EXCLAVES */
75