iokit/IOKit/rtc/IORTCController.h

   1 /*
   2  * Copyright (c) 1998-2017 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  * 24 Nov  1998 suurballe  Created.
  30  */
  31 #ifndef _IORTCCONTROLLER_H
  32 #define _IORTCCONTROLLER_H
  33
  34 #include <IOKit/IOService.h>
  35
  36 typedef void (*RTC_tick_handler)( IOService * );
  37
  38
  39 class IORTCController : public IOService
  40 {
  41         OSDeclareAbstractStructors(IORTCController)
  42
  43 public:
  44
  45         virtual IOReturn getRealTimeClock( UInt8 * currentTime, IOByteCount * length ) = 0;
  46         virtual IOReturn setRealTimeClock( UInt8 * newTime ) = 0;
  47 };
  48
  49 class IORTC : public IOService
  50 {
  51         OSDeclareAbstractStructors(IORTC);
  52
  53 protected:
  54
  55 /*! @var reserved
  56  *   Reserved for future use.  (Internal use only)  */
  57         struct ExpansionData { };
  58         ExpansionData *iortc_reserved __unused;
  59
  60 public:
  61
  62         virtual long            getGMTTimeOfDay( void ) = 0;
  63         virtual void            setGMTTimeOfDay( long secs ) = 0;
  64
  65         virtual void                    getUTCTimeOfDay( clock_sec_t * secs, clock_nsec_t * nsecs );
  66         virtual void                    setUTCTimeOfDay( clock_sec_t secs, clock_nsec_t nsecs );
  67
  68         virtual void            setAlarmEnable( IOOptionBits message ) = 0;
  69
  70         virtual IOReturn        getMonotonicClockOffset( int64_t * usecs );
  71         virtual IOReturn        setMonotonicClockOffset( int64_t usecs );
  72         virtual IOReturn        getMonotonicClockAndTimestamp( uint64_t * usecs, uint64_t *mach_absolute_time );
  73
  74
  75         OSMetaClassDeclareReservedUnused(IORTC, 0);
  76         OSMetaClassDeclareReservedUnused(IORTC, 1);
  77         OSMetaClassDeclareReservedUnused(IORTC, 2);
  78         OSMetaClassDeclareReservedUnused(IORTC, 3);
  79         OSMetaClassDeclareReservedUnused(IORTC, 4);
  80         OSMetaClassDeclareReservedUnused(IORTC, 5);
  81         OSMetaClassDeclareReservedUnused(IORTC, 6);
  82         OSMetaClassDeclareReservedUnused(IORTC, 7);
  83 };
  84
  85 #endif /* !_IORTCCONTROLLER_H */