]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/IOKit/IOTimeStamp.h
xnu-7195.101.1.tar.gz
[apple/xnu.git] / iokit / IOKit / IOTimeStamp.h
index cf07474f8b58c1767d7c5912e1fefa3e3af3c03f..2040caaf66de6526287c48d9dc118c4dc01b284e 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2010 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 #ifndef IOKIT_IOTIMESTAMP_H
 #define IOKIT_IOTIMESTAMP_H
 
 static inline void
 IOTimeStampStartConstant(unsigned int csc,
-                        unsigned int a = 0, unsigned int b = 0,
-                        unsigned int c = 0, unsigned int d = 0)
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
+{
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG_CONSTANT(((uint32_t)csc) | DBG_FUNC_START, a, b, c, d, 0);
+}
+
+static inline void
+IOTimeStampEndConstant(uintptr_t csc,
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
 {
-    KERNEL_DEBUG_CONSTANT(csc | DBG_FUNC_START, a, b, c, d, 0);
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG_CONSTANT(((uint32_t)csc) | DBG_FUNC_END, a, b, c, d, 0);
 }
 
 static inline void
-IOTimeStampEndConstant(unsigned int csc,
-                      unsigned int a = 0, unsigned int b = 0,
-                      unsigned int c = 0, unsigned int d = 0)
+IOTimeStampConstant(uintptr_t csc,
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
 {
-    KERNEL_DEBUG_CONSTANT(csc | DBG_FUNC_END, a, b, c, d, 0);
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG_CONSTANT(((uint32_t)csc) | DBG_FUNC_NONE, a, b, c, d, 0);
 }
 
 static inline void
-IOTimeStampConstant(unsigned int csc,
-                   unsigned int a = 0, unsigned int b = 0,
-                   unsigned int c = 0, unsigned int d = 0)
+IOTimeStampConstantFiltered(uintptr_t csc,
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
 {
-    KERNEL_DEBUG_CONSTANT(csc | DBG_FUNC_NONE, a, b, c, d, 0);
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG_CONSTANT_FILTERED(((uint32_t)csc) | DBG_FUNC_NONE, a, b, c, d, 0);
 }
 
+/*
+ * Objects of this class will trace a filtered interval for their lifetime.
+ * The constructor takes in the start tracepoint's arguments.
+ * By default, the end tracepoint emits no additional arguments,
+ * but you can set them with setEndCodes.
+ * Alternatively, you can set them individually with setA...setD
+ */
+class IOTimeStampIntervalConstantFiltered
+{
+public:
+       IOTimeStampIntervalConstantFiltered(unsigned int csc,
+           uintptr_t arg1 = 0, uintptr_t arg2 = 0,
+           uintptr_t arg3 = 0, uintptr_t arg4 = 0)
+               : _csc(csc), _endArg1(0), _endArg2(0), _endArg3(0), _endArg4(0)
+       {
+               (void)csc;
+               (void)arg1;
+               (void)arg2;
+               (void)arg3;
+               (void)arg4;
+               KDBG_FILTERED(((uint32_t)csc) | DBG_FUNC_START, arg1, arg2, arg3, arg4);
+       }
+       // Setters for the end debug codes
+       void
+       setEndCodes(uintptr_t arg1 = 0, uintptr_t arg2 = 0,
+           uintptr_t arg3 = 0, uintptr_t arg4 = 0)
+       {
+               _endArg1 = arg1;
+               _endArg2 = arg2;
+               _endArg3 = arg3;
+               _endArg4 = arg4;
+       }
+       void
+       setEndArg1(uintptr_t arg)
+       {
+               _endArg1  = arg;
+       }
+       void
+       setEndArg2(uintptr_t arg)
+       {
+               _endArg2  = arg;
+       }
+       void
+       setEndArg3(uintptr_t arg)
+       {
+               _endArg3  = arg;
+       }
+       void
+       setEndArg4(uintptr_t arg)
+       {
+               _endArg4  = arg;
+       }
+       ~IOTimeStampIntervalConstantFiltered()
+       {
+               KDBG_FILTERED(((uint32_t)_csc) | DBG_FUNC_END, _endArg1, _endArg2, _endArg3, _endArg4);
+       }
+private:
+#if (KDEBUG_LEVEL < KDEBUG_LEVEL_STANDARD)
+       __unused
+#endif /* KDEBUG_LEVEL < KDEBUG_LEVEL_STANDARD */
+       unsigned int _csc;
+       // End debug codes
+#if (KDEBUG_LEVEL < KDEBUG_LEVEL_STANDARD)
+       __unused
+#endif /* KDEBUG_LEVEL < KDEBUG_LEVEL_STANDARD */
+       uintptr_t _endArg1, _endArg2, _endArg3, _endArg4;
+};
+
 #if KDEBUG
 
 static inline void
-IOTimeStampStart(unsigned int csc,
-                 unsigned int a = 0, unsigned int b = 0,
-                 unsigned int c = 0, unsigned int d = 0)
+IOTimeStampStart(uintptr_t csc,
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
 {
-    KERNEL_DEBUG(csc | DBG_FUNC_START, a, b, c, d, 0);
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG(((uint32_t)csc) | DBG_FUNC_START, a, b, c, d, 0);
 }
 
 static inline void
-IOTimeStampEnd(unsigned int csc,
-               unsigned int a = 0, unsigned int b = 0,
-               unsigned int c = 0, unsigned int d = 0)
+IOTimeStampEnd(uintptr_t csc,
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
 {
-    KERNEL_DEBUG(csc | DBG_FUNC_END, a, b, c, d, 0);
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG(((uint32_t)csc) | DBG_FUNC_END, a, b, c, d, 0);
 }
 
 static inline void
-IOTimeStamp(unsigned int csc,
-            unsigned int a = 0, unsigned int b = 0,
-            unsigned int c = 0, unsigned int d = 0)
+IOTimeStamp(uintptr_t csc,
+    uintptr_t a = 0, uintptr_t b = 0,
+    uintptr_t c = 0, uintptr_t d = 0)
 {
-    KERNEL_DEBUG(csc | DBG_FUNC_NONE, a, b, c, d, 0);
+       (void)csc;
+       (void)a;
+       (void)b;
+       (void)c;
+       (void)d;
+       KERNEL_DEBUG(((uint32_t)csc) | DBG_FUNC_NONE, a, b, c, d, 0);
 }
 
 #endif /* KDEBUG */
 
-#define IODBG_SCSI(code)       (KDBG_CODE(DBG_IOKIT, DBG_IOSCSI, code))
-#define IODBG_DISK(code)       (KDBG_CODE(DBG_IOKIT, DBG_IODISK, code))
-#define IODBG_NETWORK(code)    (KDBG_CODE(DBG_IOKIT, DBG_IONETWORK, code))
-#define IODBG_KEYBOARD(code)   (KDBG_CODE(DBG_IOKIT, DBG_IOKEYBOARD, code))
-#define IODBG_POINTING(code)   (KDBG_CODE(DBG_IOKIT, DBG_IOPOINTING, code))
-#define IODBG_AUDIO(code)      (KDBG_CODE(DBG_IOKIT, DBG_IOAUDIO, code))
-#define IODBG_FLOPPY(code)     (KDBG_CODE(DBG_IOKIT, DBG_IOFLOPPY, code))
-#define IODBG_SERIAL(code)     (KDBG_CODE(DBG_IOKIT, DBG_IOSERIAL, code))
-#define IODBG_TTY(code)                (KDBG_CODE(DBG_IOKIT, DBG_IOTTY, code))
+#define IODBG_STORAGE(code)                     (KDBG_CODE(DBG_IOKIT, DBG_IOSTORAGE, code))
+#define IODBG_NETWORK(code)                     (KDBG_CODE(DBG_IOKIT, DBG_IONETWORK, code))
+#define IODBG_KEYBOARD(code)            (KDBG_CODE(DBG_IOKIT, DBG_IOKEYBOARD, code))
+#define IODBG_HID(code)                         (KDBG_CODE(DBG_IOKIT, DBG_IOHID, code))
+#define IODBG_AUDIO(code)                       (KDBG_CODE(DBG_IOKIT, DBG_IOAUDIO, code))
+#define IODBG_SERIAL(code)                      (KDBG_CODE(DBG_IOKIT, DBG_IOSERIAL, code))
+#define IODBG_TTY(code)                         (KDBG_CODE(DBG_IOKIT, DBG_IOTTY, code))
+#define IODBG_SAM(code)                         (KDBG_CODE(DBG_IOKIT, DBG_IOSAM, code))
+#define IODBG_PARALLELATA(code)         (KDBG_CODE(DBG_IOKIT, DBG_IOPARALLELATA, code))
+#define IODBG_PARALLELSCSI(code)        (KDBG_CODE(DBG_IOKIT, DBG_IOPARALLELSCSI, code))
+#define IODBG_SATA(code)                        (KDBG_CODE(DBG_IOKIT, DBG_IOSATA, code))
+#define IODBG_SAS(code)                         (KDBG_CODE(DBG_IOKIT, DBG_IOSAS, code))
+#define IODBG_FIBRECHANNEL(code)        (KDBG_CODE(DBG_IOKIT, DBG_IOFIBRECHANNEL, code))
+#define IODBG_USB(code)                         (KDBG_CODE(DBG_IOKIT, DBG_IOUSB, code))
+#define IODBG_BLUETOOTH(code)           (KDBG_CODE(DBG_IOKIT, DBG_IOBLUETOOTH, code))
+#define IODBG_FIREWIRE(code)            (KDBG_CODE(DBG_IOKIT, DBG_IOFIREWIRE, code))
+#define IODBG_INFINIBAND(code)          (KDBG_CODE(DBG_IOKIT, DBG_IOINFINIBAND, code))
+
+
+/* Backwards compatibility */
+#define IODBG_DISK(code)                        IODBG_STORAGE(code)
+#define IODBG_POINTING(code)            IODBG_HID(code)
+
 
 /* IOKit infrastructure subclasses */
-#define IODBG_WORKLOOP(code)   (KDBG_CODE(DBG_IOKIT, DBG_IOWORKLOOP, code))
-#define IODBG_INTES(code)      (KDBG_CODE(DBG_IOKIT, DBG_IOINTES, code))
-#define IODBG_TIMES(code)      (KDBG_CODE(DBG_IOKIT, DBG_IOCLKES, code))
-#define IODBG_CMDQ(code)       (KDBG_CODE(DBG_IOKIT, DBG_IOCMDQ, code))
-#define IODBG_MCURS(code)      (KDBG_CODE(DBG_IOKIT, DBG_IOMCURS, code))
-#define IODBG_MDESC(code)      (KDBG_CODE(DBG_IOKIT, DBG_IOMDESC, code))
-#define IODBG_POWER(code)      (KDBG_CODE(DBG_IOKIT, DBG_IOPOWER, code))
+#define IODBG_INTC(code)                        (KDBG_CODE(DBG_IOKIT, DBG_IOINTC, code))
+#define IODBG_WORKLOOP(code)            (KDBG_CODE(DBG_IOKIT, DBG_IOWORKLOOP, code))
+#define IODBG_INTES(code)                       (KDBG_CODE(DBG_IOKIT, DBG_IOINTES, code))
+#define IODBG_TIMES(code)                       (KDBG_CODE(DBG_IOKIT, DBG_IOCLKES, code))
+#define IODBG_CMDQ(code)                        (KDBG_CODE(DBG_IOKIT, DBG_IOCMDQ, code))
+#define IODBG_MCURS(code)                       (KDBG_CODE(DBG_IOKIT, DBG_IOMCURS, code))
+#define IODBG_MDESC(code)                       (KDBG_CODE(DBG_IOKIT, DBG_IOMDESC, code))
+#define IODBG_POWER(code)                       (KDBG_CODE(DBG_IOKIT, DBG_IOPOWER, code))
+#define IODBG_IOSERVICE(code)           (KDBG_CODE(DBG_IOKIT, DBG_IOSERVICE, code))
+#define IODBG_IOREGISTRY(code)          (KDBG_CODE(DBG_IOKIT, DBG_IOREGISTRY, code))
+#define IODBG_IOMDPA(code)                      (KDBG_CODE(DBG_IOKIT, DBG_IOMDPA, code))
 
 /* IOKit specific codes - within each subclass */
 
-/* DBG_IOKIT/DBG_IOSCSI codes */
-
 /* DBG_IOKIT/DBG_IODISK codes */
 
 /* DBG_IOKIT/DBG_IONETWORK codes */
 
 /* DBG_IOKIT/DBG_IOKEYBOARD codes */
 
-/* DBG_IOKIT/DBG_IOPOINTING codes */
+/* DBG_IOKIT/DBG_IOHID codes */
 
 /* DBG_IOKIT/DBG_IOAUDIO codes */
 
-/* DBG_IOKIT/DBG_IOFLOPPY codes */
-
 /* DBG_IOKIT/DBG_IOSERIAL codes */
 
 /* DBG_IOKIT/DBG_IOTTY codes */
 
+/* DBG_IOKIT/DBG_IOINTC codes */
+#define IOINTC_HANDLER  1       /* 0x05000004 */
+#define IOINTC_SPURIOUS 2       /* 0x05000008 */
+
 /* DBG_IOKIT/DBG_IOWORKLOOP codes */
-#define IOWL_CLIENT    1       /* 0x050a0004 */
-#define IOWL_WORK      2       /* 0x050a0008 */
+#define IOWL_CLIENT             1       /* 0x05010004 */
+#define IOWL_WORK               2       /* 0x05010008 */
 
 /* DBG_IOKIT/DBG_IOINTES codes */
-#define IOINTES_CLIENT 1       /* 0x050b0004 */
-#define IOINTES_LAT    2       /* 0x050b0008 */
-#define IOINTES_SEMA   3       /* 0x050b000c */
-#define IOINTES_INTCTXT 4      /* 0x050b0010 */
-#define IOINTES_INTFLTR 5      /* 0x050b0014 */
-#define IOINTES_ACTION 6       /* 0x050b0018 */
-#define IOINTES_FILTER 7       /* 0x050b001c */
+#define IOINTES_CLIENT  1       /* 0x05020004 */
+#define IOINTES_LAT             2       /* 0x05020008 */
+#define IOINTES_SEMA    3       /* 0x0502000c */
+#define IOINTES_INTCTXT 4       /* 0x05020010 */
+#define IOINTES_INTFLTR 5       /* 0x05020014 */
+#define IOINTES_ACTION  6       /* 0x05020018 */
+#define IOINTES_FILTER  7       /* 0x0502001c */
 
 /* DBG_IOKIT/DBG_IOTIMES codes */
-#define IOTIMES_CLIENT 1       /* 0x050c0004 */
-#define IOTIMES_LAT    2       /* 0x050c0008 */
-#define IOTIMES_SEMA   3       /* 0x050c000c */
-#define IOTIMES_ACTION 4       /* 0x050c0010 */
+#define IOTIMES_CLIENT  1       /* 0x05030004 */
+#define IOTIMES_LAT             2       /* 0x05030008 */
+#define IOTIMES_SEMA    3       /* 0x0503000c */
+#define IOTIMES_ACTION  4       /* 0x05030010 */
 
 /* DBG_IOKIT/DBG_IOCMDQ codes */
-#define IOCMDQ_CLIENT  1       /* 0x050d0004 */
-#define IOCMDQ_LAT     2       /* 0x050d0008 */
-#define IOCMDQ_SEMA    3       /* 0x050d000c */
-#define IOCMDQ_PSEMA   4       /* 0x050d0010 */
-#define IOCMDQ_PLOCK   5       /* 0x050d0014 */
-#define IOCMDQ_ACTION  6       /* 0x050d0018 */
+#define IOCMDQ_CLIENT   1       /* 0x05040004 */
+#define IOCMDQ_LAT              2       /* 0x05040008 */
+#define IOCMDQ_SEMA             3       /* 0x0504000c */
+#define IOCMDQ_PSEMA    4       /* 0x05040010 */
+#define IOCMDQ_PLOCK    5       /* 0x05040014 */
+#define IOCMDQ_ACTION   6       /* 0x05040018 */
 
 /* DBG_IOKIT/DBG_IOMCURS codes */
 
 /* DBG_IOKIT/DBG_IOMDESC codes */
+#define IOMDESC_WIRE 1       /* 0x05060004 */
+#define IOMDESC_PREPARE 2    /* 0x05060008 */
+#define IOMDESC_MAP 3        /* 0x0506000C */
+#define IOMDESC_UNMAP 4      /* 0x05060010 */
+#define IOMDESC_DMA_MAP 5    /* 0x05060014 */
+#define IOMDESC_DMA_UNMAP 6  /* 0x05060018 */
+#define IOMDESC_COMPLETE 7   /* 0x0506001C */
+
+/* DBG_IOKIT/DBG_IOMDPA */
+#define IOMDPA_MAPPED           1       /* 0x05410004 */
+#define IOMDPA_UNMAPPED         2       /* 0x05410008 */
+#define IOMDPA_SEGMENTS_PAGE    3       /* 0x0541000C */
+#define IOMDPA_SEGMENTS_LONG    4       /* 0x05410010 */
 
 /* DBG_IOKIT/DBG_IOPOWER codes */
-#define IOPOWER_ROOT   1       /* 0x05100004 */
-#define IOPOWER_WAKE   2       /* 0x05100008 */
-#define IOPOWER_STATE  3       /* 0x0510000c */
-#define IOPOWER_ACK    4       /* 0x05100010 */
-#define IOPOWER_CLIENT  5      /* 0x05100014 */
+// See IOKit/pwr_mgt/IOPMlog.h for the power management codes
+
+/* DBG_IOKIT/DBG_IOSERVICE codes */
+#define IOSERVICE_BUSY          1       /* 0x05080004 */
+#define IOSERVICE_NONBUSY       2       /* 0x05080008 */
+#define IOSERVICE_MODULESTALL   3       /* 0x0508000C */
+#define IOSERVICE_MODULEUNSTALL 4       /* 0x05080010 */
+
+#define IOSERVICE_TERMINATE_PHASE1              5       /* 0x05080014 */
+#define IOSERVICE_TERMINATE_REQUEST_OK          6       /* 0x05080018 */
+#define IOSERVICE_TERMINATE_REQUEST_FAIL        7       /* 0x0508001C */
+#define IOSERVICE_TERMINATE_SCHEDULE_STOP       8       /* 0x05080020 */
+#define IOSERVICE_TERMINATE_SCHEDULE_FINALIZE   9       /* 0x05080024 */
+#define IOSERVICE_TERMINATE_WILL                10      /* 0x05080028 */
+#define IOSERVICE_TERMINATE_DID                 11      /* 0x0508002C */
+#define IOSERVICE_TERMINATE_DID_DEFER           12      /* 0x05080030 */
+#define IOSERVICE_TERMINATE_FINALIZE            13      /* 0x05080034 */
+#define IOSERVICE_TERMINATE_STOP                14      /* 0x05080038 */
+#define IOSERVICE_TERMINATE_STOP_NOP            15      /* 0x0508003C */
+#define IOSERVICE_TERMINATE_STOP_DEFER          16      /* 0x05080040 */
+#define IOSERVICE_TERMINATE_DONE                17      /* 0x05080044 */
+
+#define IOSERVICE_KEXTD_ALIVE                   18      /* 0x05080048 */
+#define IOSERVICE_KEXTD_READY                   19      /* 0x0508004C */
+#define IOSERVICE_REGISTRY_QUIET                20      /* 0x05080050 */
+
+#define IOSERVICE_TERM_SET_INACTIVE             21      /* 0x05080054 */
+#define IOSERVICE_TERM_SCHED_PHASE2             22      /* 0x05080058 */
+#define IOSERVICE_TERM_START_PHASE2             23      /* 0x0508005C */
+#define IOSERVICE_TERM_TRY_PHASE2               24      /* 0x05080060 */
+#define IOSERVICE_TERM_UC_DEFER                 25      /* 0x05080064 */
+#define IOSERVICE_DETACH                        26      /* 0x05080068 */
+
+/* DBG_IOKIT/DBG_IOREGISTRY codes */
+#define IOREGISTRYENTRY_NAME_STRING              1      /* 0x05090004 */
+#define IOREGISTRYENTRY_NAME                     2      /* 0x05090008 */
 
 #endif /* ! IOKIT_IOTIMESTAMP_H */