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