1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 #if __riscv
32 
33 /**
34  * @file sys/hwprobe.h
35  * @brief RISC-V hardware probing.
36  */
37 
38 #include <sys/cdefs.h>
39 #include <sys/types.h>
40 
41 /* Pull in struct riscv_hwprobe and corresponding constants. */
42 #include <asm/hwprobe.h>
43 
44 __BEGIN_DECLS
45 
46 /**
47  * [__riscv_hwprobe(2)](https://docs.kernel.org/riscv/hwprobe.html)
48  * queries hardware characteristics.
49  *
50  * A `__cpu_count` of 0 and null `__cpus` means "all online cpus".
51  *
52  * Returns 0 on success and returns an error number on failure.
53  */
54 int __riscv_hwprobe(struct riscv_hwprobe* _Nonnull __pairs, size_t __pair_count, size_t __cpu_count, unsigned long* _Nullable __cpus, unsigned __flags);
55 
56 /**
57  * The type of the second argument passed to riscv64 ifunc resolvers.
58  * This argument allows riscv64 ifunc resolvers to call __riscv_hwprobe()
59  * without worrying about whether that relocation is resolved before
60  * the ifunc resolver is called.
61  */
62 typedef int (*__riscv_hwprobe_t)(struct riscv_hwprobe* _Nonnull __pairs, size_t __pair_count, size_t __cpu_count, unsigned long* _Nullable __cpus, unsigned __flags);
63 
64 __END_DECLS
65 
66 #endif
67