]> git.saurik.com Git - apple/libc.git/blame_incremental - include/libkern/OSThermalNotification.h
Libc-583.tar.gz
[apple/libc.git] / include / libkern / OSThermalNotification.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2007 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24#ifndef _OSTHERMALNOTIFICATION_H_
25#define _OSTHERMALNOTIFICATION_H_
26
27#include <sys/cdefs.h>
28
29/*
30** OSThermalNotification.h
31**
32** Notification mechanism to alert registered tasks when device thermal conditions
33** reach certain thresholds. Notifications are triggered in both directions
34** so clients can manage their memory usage more and less aggressively.
35**
36*/
37
38__BEGIN_DECLS
39
40typedef enum {
41 OSThermalNotificationLevelAny = -1,
42 OSThermalNotificationLevelNormal = 0,
43 OSThermalNotificationLevel70PercentBacklight = 3,
44 OSThermalNotificationLevel50PercentBacklight = 5,
45 OSThermalNotificationLevelAppTerminate = 12,
46 OSThermalNotificationLevelDeviceRestart = 16
47} OSThermalNotificationLevel;
48
49/* Backwards compatibility */
50#define OSThermalNotificationLevelWarning OSThermalNotificationLevel70PercentBacklight
51#define OSThermalNotificationLevelUrgent OSThermalNotificationLevelAppTerminate
52#define OSThermalNotificationLevelCritical OSThermalNotificationLevelDeviceRestart
53
54/*
55** Simple polling interface to detect current thermal level
56*/
57
58OSThermalNotificationLevel OSThermalNotificationCurrentLevel(void);
59
60/*
61** External notify(3) string for manual notification setup
62*/
63
64extern const char *kOSThermalNotificationName;
65
66__END_DECLS
67
68#endif /* _OSTHERMALNOTIFICATION_H_ */