xref: /xnu-12377.81.4/tests/arm_matrix.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
1*043036a2SApple OSS Distributions /*
2*043036a2SApple OSS Distributions  * Copyright (c) 2022 Apple Computer, Inc. All rights reserved.
3*043036a2SApple OSS Distributions  *
4*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*043036a2SApple OSS Distributions  *
6*043036a2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*043036a2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*043036a2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*043036a2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*043036a2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*043036a2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*043036a2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*043036a2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*043036a2SApple OSS Distributions  *
15*043036a2SApple OSS Distributions  * Please obtain a copy of the License at
16*043036a2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*043036a2SApple OSS Distributions  *
18*043036a2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*043036a2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*043036a2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*043036a2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*043036a2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*043036a2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*043036a2SApple OSS Distributions  * limitations under the License.
25*043036a2SApple OSS Distributions  *
26*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*043036a2SApple OSS Distributions  */
28*043036a2SApple OSS Distributions 
29*043036a2SApple OSS Distributions #ifndef __ARM_MATRIX_H
30*043036a2SApple OSS Distributions #define __ARM_MATRIX_H
31*043036a2SApple OSS Distributions 
32*043036a2SApple OSS Distributions #include <mach/mach_types.h>
33*043036a2SApple OSS Distributions #include <mach/thread_status.h>
34*043036a2SApple OSS Distributions #include <stdbool.h>
35*043036a2SApple OSS Distributions #include <stddef.h>
36*043036a2SApple OSS Distributions #include <stdlib.h>
37*043036a2SApple OSS Distributions 
38*043036a2SApple OSS Distributions struct arm_matrix_operations {
39*043036a2SApple OSS Distributions 	const char *name;
40*043036a2SApple OSS Distributions 
41*043036a2SApple OSS Distributions 	size_t (*data_size)(void);
42*043036a2SApple OSS Distributions 	void *(*alloc_data)(void);
43*043036a2SApple OSS Distributions 
44*043036a2SApple OSS Distributions 	bool (*is_available)(void);
45*043036a2SApple OSS Distributions 	void (*start)(void);
46*043036a2SApple OSS Distributions 	void (*stop)(void);
47*043036a2SApple OSS Distributions 
48*043036a2SApple OSS Distributions 	void (*load_one_vector)(const void *);
49*043036a2SApple OSS Distributions 	void (*load_data)(const void *);
50*043036a2SApple OSS Distributions 	void (*store_data)(void *);
51*043036a2SApple OSS Distributions 
52*043036a2SApple OSS Distributions 	kern_return_t (*thread_get_state)(thread_act_t, void *);
53*043036a2SApple OSS Distributions 	kern_return_t (*thread_set_state)(thread_act_t, const void *);
54*043036a2SApple OSS Distributions };
55*043036a2SApple OSS Distributions 
56*043036a2SApple OSS Distributions /** Operates on all SME context data.  Legacy SIMD instructions between start() and stop() will trap. */
57*043036a2SApple OSS Distributions extern const struct arm_matrix_operations sme_operations;
58*043036a2SApple OSS Distributions /** Operates only on SME context data controlled by `SVCR.ZA`.  No effect on legacy SIMD instructions. */
59*043036a2SApple OSS Distributions extern const struct arm_matrix_operations sme_za_operations;
60*043036a2SApple OSS Distributions 
61*043036a2SApple OSS Distributions #endif /* __ARM_MATRIX_H */
62