osfmk/mach/clock.defs

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  *      File:           mach/clock.defs
  30  *      Purpose:        Kernel clock subsystem definitions. This
  31  *                      file defines the clock request interface.
  32  */
  33
  34 subsystem
  35 #if     KERNEL_SERVER
  36           KernelServer
  37 #endif  /* KERNEL_SERVER */
  38                        clock 1000;
  39
  40 #include <mach/std_types.defs>
  41 #include <mach/mach_types.defs>
  42 #include <mach/clock_types.defs>
  43
  44 /*
  45  * References to clock objects are returned by:
  46  *      host_get_clock_service(host_t,...)
  47  *      host_get_clock_control(host_priv_t,...) - Priviledged subclass
  48  */
  49
  50 /*
  51  *      Get the clock time.
  52  *      Available to all.
  53  */
  54 routine clock_get_time(
  55                 clock_serv      : clock_serv_t;
  56         out     cur_time        : mach_timespec_t);
  57
  58 /*
  59  *      Get clock attributes.
  60  *      Available to all.
  61  */
  62 routine clock_get_attributes(
  63                 clock_serv      : clock_serv_t;
  64         in      flavor          : clock_flavor_t;
  65         out     clock_attr      : clock_attr_t, CountInOut);
  66
  67 /*
  68  *      Setup a clock alarm.
  69  *      Available to all.
  70  */
  71 routine clock_alarm(
  72                 clock_serv      : clock_serv_t;
  73                 alarm_type      : alarm_type_t;
  74                 alarm_time      : mach_timespec_t;
  75                 alarm_port      : clock_reply_t =
  76                         MACH_MSG_TYPE_MAKE_SEND_ONCE|polymorphic);