hwfunc.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2003-2004 Juli Mallett.  All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 * $FreeBSD: stable/11/sys/mips/include/hwfunc.h 330897 2018-03-14 03:19:51Z eadler $
28 */
29
30#ifndef _MACHINE_HWFUNC_H_
31#define	_MACHINE_HWFUNC_H_
32
33#include <sys/_cpuset.h>
34
35struct timecounter;
36
37/*
38 * Hooks downward into platform functionality.
39 */
40void platform_reset(void);
41void platform_start(__register_t, __register_t,  __register_t, __register_t);
42
43/* For clocks and ticks and such */
44void platform_initclocks(void);
45uint64_t platform_get_frequency(void);
46unsigned platform_get_timecount(struct timecounter *);
47
48/* For hardware specific CPU initialization */
49void platform_cpu_init(void);
50
51#ifdef SMP
52
53/*
54 * Spin up the AP so that it starts executing MP bootstrap entry point: mpentry
55 *
56 * Returns 0 on sucess and non-zero on failure.
57 */
58int platform_start_ap(int processor_id);
59
60/*
61 * Platform-specific initialization that needs to be done when an AP starts
62 * running. This function is called from the MP bootstrap code in mpboot.S
63 */
64void platform_init_ap(int processor_id);
65
66/*
67 * Return a plaform-specific interrrupt number that is used to deliver IPIs.
68 *
69 * This hardware interrupt is used to deliver IPIs exclusively and must
70 * not be used for any other interrupt source.
71 */
72int platform_ipi_intrnum(void);
73
74/*
75 * Trigger a IPI interrupt on 'cpuid'.
76 */
77void platform_ipi_send(int cpuid);
78
79/*
80 * Quiesce the IPI interrupt source on the current cpu.
81 */
82void platform_ipi_clear(void);
83
84/*
85 * Return the processor id.
86 *
87 * Note that this function is called in early boot when stack is not available.
88 */
89extern int platform_processor_id(void);
90
91/*
92 * Return the cpumask of available processors.
93 */
94extern void platform_cpu_mask(cpuset_t *mask);
95
96/*
97 * Return the topology of processors on this platform
98 */
99struct cpu_group *platform_smp_topo(void);
100
101#endif	/* SMP */
102
103#endif /* !_MACHINE_HWFUNC_H_ */
104