1 /* 2 * Copyright (c) 2012-2014 Apple Computer, Inc. All Rights Reserved. 3 * 4 * @APPLE_OSREFERENCE_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. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 29 // Internal data structures to be used by IOReporters and User Space Observers 30 31 32 #ifndef _IOKERNELREPORTSTRUCTS_H_ 33 #define _IOKERNELREPORTSTRUCTS_H_ 34 35 #include <stdint.h> 36 37 #include <IOKit/IOReportTypes.h> 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 // Drivers participating in IOReporting can advertise channels by 44 // publishing properties in the I/O Kit registry. Various helper 45 // mechanisms exist to produce correctly-formatted legends. 46 // 12836893 tracks advertising channels in user space. 47 #define kIOReportLegendPublicKey "IOReportLegendPublic" // bool 48 #define kIOReportLegendKey "IOReportLegend" // arr 49 #define kIOReportLegendChannelsKey "IOReportChannels" // arr 50 #define kIOReportLegendGroupNameKey "IOReportGroupName" // str 51 #define kIOReportLegendSubGroupNameKey "IOReportSubGroupName" // str 52 #define kIOReportLegendInfoKey "IOReportChannelInfo" // dict 53 #define kIOReportLegendUnitKey "IOReportChannelUnit" // num 54 #define kIOReportLegendConfigKey "IOReportChannelConfig" // data 55 #define kIOReportLegendStateNamesKey "IOReportChannelStateNames" // str[] 56 57 // in an I/O Kit registry legend, a small "array struct" represents a channel 58 #define kIOReportChannelIDIdx 0 // required 59 #define kIOReportChannelTypeIdx 1 // required 60 #define kIOReportChannelNameIdx 2 // optional 61 62 /* Histogram Segment Configuration 63 * Currently supports 2 types of scaling to compute bucket upper bounds, 64 * linear or exponential. 65 * scale_flag = 0 -> linear scale 66 * 1 -> exponential scale 67 * upper_bound[n] = (scale_flag) ? pow(base,(n+1)) : base * (n+1); 68 */ 69 #define kIOHistogramScaleLinear 0 70 #define kIOHistogramScaleExponential 1 71 typedef struct { 72 uint32_t base_bucket_width;// segment[0].bucket[0] = [0, base_width] 73 uint32_t scale_flag; // bit 0 only in current use (see #defs) 74 uint32_t segment_idx; // for multiple segments histograms 75 uint32_t segment_bucket_count;// number of buckets in this segment 76 } __attribute((packed)) IOHistogramSegmentConfig; 77 78 // "normalized distribution"(FIXME?) internal format (unused?) 79 typedef struct { 80 uint64_t samples; 81 uint64_t mean; 82 uint64_t variance; 83 uint64_t reserved; 84 } __attribute((packed)) IONormDistReportValues; 85 86 #ifdef __cplusplus 87 } 88 #endif 89 90 #endif // _IOKERNELREPORTSTRUCTS_H_ 91