include/libkern/OSThermalNotification.h

   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
  40 typedef enum {
  41         OSThermalNotificationLevelAny      = -1,
  42         OSThermalNotificationLevelNormal   =  0,
  43         OSThermalNotificationLevel70PercentTorch  =  1,
  44         OSThermalNotificationLevel70PercentBacklight  =  3,
  45         OSThermalNotificationLevel50PercentTorch  =  3,
  46         OSThermalNotificationLevel50PercentBacklight  =  5,
  47         OSThermalNotificationLevelDisableTorch  =  5,
  48         OSThermalNotificationLevel25PercentBacklight = 7,
  49         OSThermalNotificationLevelAppTerminate  =  12,
  50         OSThermalNotificationLevelDeviceRestart = 16
  51 } OSThermalNotificationLevel;
  52
  53 /* Backwards compatibility */
  54 #define OSThermalNotificationLevelWarning OSThermalNotificationLevel70PercentBacklight
  55 #define OSThermalNotificationLevelUrgent OSThermalNotificationLevelAppTerminate
  56 #define OSThermalNotificationLevelCritical OSThermalNotificationLevelDeviceRestart
  57
  58 /*
  59 ** Simple polling interface to detect current thermal level
  60 */
  61
  62 OSThermalNotificationLevel OSThermalNotificationCurrentLevel(void);
  63
  64 /*
  65 ** External notify(3) string for manual notification setup
  66 */
  67
  68 extern const char *kOSThermalNotificationName;
  69
  70 __END_DECLS
  71
  72 #endif /* _OSTHERMALNOTIFICATION_H_ */