xref: /illumos-gate/usr/src/uts/common/sys/cyclic.h (revision 87a18d3f5ba5da1985af86439cf1c94a9118b665)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_CYCLIC_H
27 #define	_SYS_CYCLIC_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #ifndef _ASM
34 #include <sys/time.h>
35 #include <sys/cpuvar.h>
36 #include <sys/cpupart.h>
37 #endif /* !_ASM */
38 
39 #define	CY_LOW_LEVEL		0
40 #define	CY_LOCK_LEVEL		1
41 #define	CY_HIGH_LEVEL		2
42 #define	CY_SOFT_LEVELS		2
43 #define	CY_LEVELS		3
44 
45 #ifndef _ASM
46 
47 typedef uintptr_t cyclic_id_t;
48 typedef int cyc_index_t;
49 typedef int cyc_cookie_t;
50 typedef uint16_t cyc_level_t;
51 typedef void (*cyc_func_t)(void *);
52 typedef void *cyb_arg_t;
53 
54 #define	CYCLIC_NONE		((cyclic_id_t)0)
55 
56 typedef struct cyc_handler {
57 	cyc_func_t cyh_func;
58 	void *cyh_arg;
59 	cyc_level_t cyh_level;
60 } cyc_handler_t;
61 
62 typedef struct cyc_time {
63 	hrtime_t cyt_when;
64 	hrtime_t cyt_interval;
65 } cyc_time_t;
66 
67 typedef struct cyc_omni_handler {
68 	void (*cyo_online)(void *, cpu_t *, cyc_handler_t *, cyc_time_t *);
69 	void (*cyo_offline)(void *, cpu_t *, void *);
70 	void *cyo_arg;
71 } cyc_omni_handler_t;
72 
73 #define	CY_INFINITY	INT64_MAX
74 
75 #ifdef _KERNEL
76 
77 extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
78 extern cyclic_id_t cyclic_add_omni(cyc_omni_handler_t *);
79 extern void cyclic_remove(cyclic_id_t);
80 extern void cyclic_bind(cyclic_id_t, cpu_t *, cpupart_t *);
81 extern int cyclic_reprogram(cyclic_id_t, hrtime_t);
82 extern hrtime_t cyclic_getres();
83 
84 extern int cyclic_offline(cpu_t *cpu);
85 extern void cyclic_online(cpu_t *cpu);
86 extern int cyclic_juggle(cpu_t *cpu);
87 extern void cyclic_move_in(cpu_t *);
88 extern int cyclic_move_out(cpu_t *);
89 extern void cyclic_suspend();
90 extern void cyclic_resume();
91 
92 extern void cyclic_fire(cpu_t *cpu);
93 extern void cyclic_softint(cpu_t *cpu, cyc_level_t level);
94 
95 #endif /* _KERNEL */
96 
97 #endif /* !_ASM */
98 
99 #ifdef	__cplusplus
100 }
101 #endif
102 
103 #endif /* _SYS_CYCLIC_H */
104