summaryrefslogtreecommitdiff
path: root/gpxe/src/include/gpxe/nap.h
blob: 6c2e40cfbf5a106a30892bb8e25d75c6ecf2db55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#ifndef _GPXE_NAP_H
#define _GPXE_NAP_H

/** @file
 *
 * CPU sleeping
 *
 */

FILE_LICENCE ( GPL2_OR_LATER );

#include <gpxe/api.h>
#include <config/nap.h>

/**
 * Calculate static inline CPU sleeping API function name
 *
 * @v _prefix		Subsystem prefix
 * @v _api_func		API function
 * @ret _subsys_func	Subsystem API function
 */
#define NAP_INLINE( _subsys, _api_func ) \
	SINGLE_API_INLINE ( NAP_PREFIX_ ## _subsys, _api_func )

/**
 * Provide an CPU sleeping API implementation
 *
 * @v _prefix		Subsystem prefix
 * @v _api_func		API function
 * @v _func		Implementing function
 */
#define PROVIDE_NAP( _subsys, _api_func, _func ) \
	PROVIDE_SINGLE_API ( NAP_PREFIX_ ## _subsys, _api_func, _func )

/**
 * Provide a static inline CPU sleeping API implementation
 *
 * @v _prefix		Subsystem prefix
 * @v _api_func		API function
 */
#define PROVIDE_NAP_INLINE( _subsys, _api_func ) \
	PROVIDE_SINGLE_API_INLINE ( NAP_PREFIX_ ## _subsys, _api_func )

/* Include all architecture-independent I/O API headers */
#include <gpxe/null_nap.h>

/* Include all architecture-dependent I/O API headers */
#include <bits/nap.h>

/**
 * Sleep until next CPU interrupt
 *
 */
void cpu_nap ( void );

#endif /* _GPXE_NAP_H */