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