xref: /xnu-11215.1.10/osfmk/kern/exclaves_driverkit.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
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 #pragma once
30 
31 #if CONFIG_EXCLAVES
32 
33 #if __has_include(<Tightbeam/tightbeam.h>)
34 
35 #include <stdint.h>
36 
37 #include <Tightbeam/tightbeam.h>
38 #include <Tightbeam/tightbeam_private.h>
39 
40 #include "kern/exclaves.tightbeam.h"
41 
42 __BEGIN_DECLS
43 
44 extern tb_error_t
45     exclaves_driverkit_upcall_irq_register(const uint64_t id, const int32_t index,
46     tb_error_t (^completion)(xnuupcalls_xnuupcalls_irq_register__result_s));
47 
48 extern tb_error_t
49     exclaves_driverkit_upcall_irq_remove(const uint64_t id, const int32_t index,
50     tb_error_t (^completion)(xnuupcalls_xnuupcalls_irq_remove__result_s));
51 
52 extern tb_error_t
53     exclaves_driverkit_upcall_irq_enable(const uint64_t id, const int32_t index,
54     tb_error_t (^completion)(xnuupcalls_xnuupcalls_irq_enable__result_s));
55 
56 extern tb_error_t
57     exclaves_driverkit_upcall_irq_disable(const uint64_t id, const int32_t index,
58     tb_error_t (^completion)(xnuupcalls_xnuupcalls_irq_disable__result_s));
59 
60 extern tb_error_t
61     exclaves_driverkit_upcall_timer_register(const uint64_t id,
62     tb_error_t (^completion)(xnuupcalls_xnuupcalls_timer_register__result_s));
63 
64 extern tb_error_t
65     exclaves_driverkit_upcall_timer_remove(const uint64_t id, const uint32_t timer_id,
66     tb_error_t (^completion)(xnuupcalls_xnuupcalls_timer_remove__result_s));
67 
68 extern tb_error_t
69     exclaves_driverkit_upcall_timer_enable(const uint64_t id, const uint32_t timer_id,
70     tb_error_t (^completion)(xnuupcalls_xnuupcalls_timer_enable__result_s));
71 
72 extern tb_error_t
73     exclaves_driverkit_upcall_timer_disable(const uint64_t id, const uint32_t timer_id,
74     tb_error_t (^completion)(xnuupcalls_xnuupcalls_timer_disable__result_s));
75 
76 extern tb_error_t
77     exclaves_driverkit_upcall_timer_set_timeout(const uint64_t id,
78     const uint32_t timer_id,
79     const struct xnuupcalls_drivertimerspecification_s *duration,
80     tb_error_t (^completion)(xnuupcalls_xnuupcalls_timer_set_timeout__result_s));
81 
82 extern tb_error_t
83     exclaves_driverkit_upcall_timer_cancel_timeout(const uint64_t id,
84     const uint32_t timer_id,
85     tb_error_t (^completion)(xnuupcalls_xnuupcalls_timer_cancel_timeout__result_s));
86 
87 extern tb_error_t
88     exclaves_driverkit_upcall_lock_wl(const uint64_t id,
89     tb_error_t (^completion)(xnuupcalls_xnuupcalls_lock_wl__result_s));
90 
91 extern tb_error_t
92     exclaves_driverkit_upcall_unlock_wl(const uint64_t id,
93     tb_error_t (^completion)(xnuupcalls_xnuupcalls_unlock_wl__result_s));
94 
95 extern tb_error_t
96     exclaves_driverkit_upcall_async_notification_signal(const uint64_t id,
97     const uint32_t notificationID,
98     tb_error_t (^completion)(xnuupcalls_xnuupcalls_async_notification_signal__result_s));
99 
100 extern tb_error_t
101     exclaves_driverkit_upcall_mapper_activate(const uint64_t id,
102     const uint32_t mapperIndex,
103     tb_error_t (^completion)(xnuupcalls_xnuupcalls_mapper_activate__result_s));
104 
105 extern tb_error_t
106     exclaves_driverkit_upcall_mapper_deactivate(const uint64_t id,
107     const uint32_t mapperIndex,
108     tb_error_t (^completion)(xnuupcalls_xnuupcalls_mapper_deactivate__result_s));
109 
110 extern tb_error_t
111     exclaves_driverkit_upcall_notification_signal(const uint64_t id,
112     const uint32_t mask,
113     tb_error_t (^completion)(xnuupcalls_xnuupcalls_notification_signal__result_s));
114 
115 extern tb_error_t
116     exclaves_driverkit_upcall_ane_setpowerstate(const uint64_t id,
117     const uint32_t desiredState,
118     tb_error_t (^completion)(xnuupcalls_xnuupcalls_ane_setpowerstate__result_s));
119 
120 extern tb_error_t
121     exclaves_driverkit_upcall_ane_worksubmit(const uint64_t id, const uint64_t requestID,
122     const uint32_t taskDescriptorCount, const uint64_t submitTimestamp,
123     tb_error_t (^completion)(xnuupcalls_xnuupcalls_ane_worksubmit__result_s));
124 
125 extern tb_error_t
126     exclaves_driverkit_upcall_ane_workbegin(const uint64_t id, const uint64_t requestID,
127     const uint64_t beginTimestamp,
128     tb_error_t (^completion)(xnuupcalls_xnuupcalls_ane_workbegin__result_s));
129 
130 extern tb_error_t
131     exclaves_driverkit_upcall_ane_workend(const uint64_t id, const uint64_t requestID,
132     tb_error_t (^completion)(xnuupcalls_xnuupcalls_ane_workend__result_s));
133 
134 __END_DECLS
135 
136 #endif /* __has_include(<Tightbeam/tightbeam.h>) */
137 
138 #endif /* CONFIG_EXCLAVES */
139