xref: /xnu-8020.140.41/iokit/IOKit/rtc/IORTCController.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1*27b03b36SApple OSS Distributions /*
2*27b03b36SApple OSS Distributions  * Copyright (c) 1998-2019 Apple Inc. All rights reserved.
3*27b03b36SApple OSS Distributions  *
4*27b03b36SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*27b03b36SApple OSS Distributions  *
6*27b03b36SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*27b03b36SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*27b03b36SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*27b03b36SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*27b03b36SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*27b03b36SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*27b03b36SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*27b03b36SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*27b03b36SApple OSS Distributions  *
15*27b03b36SApple OSS Distributions  * Please obtain a copy of the License at
16*27b03b36SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*27b03b36SApple OSS Distributions  *
18*27b03b36SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*27b03b36SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*27b03b36SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*27b03b36SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*27b03b36SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*27b03b36SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*27b03b36SApple OSS Distributions  * limitations under the License.
25*27b03b36SApple OSS Distributions  *
26*27b03b36SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*27b03b36SApple OSS Distributions  */
28*27b03b36SApple OSS Distributions /*
29*27b03b36SApple OSS Distributions  * 24 Nov  1998 suurballe  Created.
30*27b03b36SApple OSS Distributions  */
31*27b03b36SApple OSS Distributions #ifndef _IORTCCONTROLLER_H
32*27b03b36SApple OSS Distributions #define _IORTCCONTROLLER_H
33*27b03b36SApple OSS Distributions 
34*27b03b36SApple OSS Distributions #include <IOKit/IOService.h>
35*27b03b36SApple OSS Distributions 
36*27b03b36SApple OSS Distributions typedef void (*RTC_tick_handler)( IOService * );
37*27b03b36SApple OSS Distributions 
38*27b03b36SApple OSS Distributions 
39*27b03b36SApple OSS Distributions class IORTCController : public IOService
40*27b03b36SApple OSS Distributions {
41*27b03b36SApple OSS Distributions 	OSDeclareAbstractStructors(IORTCController);
42*27b03b36SApple OSS Distributions 
43*27b03b36SApple OSS Distributions public:
44*27b03b36SApple OSS Distributions 
45*27b03b36SApple OSS Distributions 	virtual IOReturn getRealTimeClock( UInt8 * currentTime, IOByteCount * length ) = 0;
46*27b03b36SApple OSS Distributions 	virtual IOReturn setRealTimeClock( UInt8 * newTime ) = 0;
47*27b03b36SApple OSS Distributions };
48*27b03b36SApple OSS Distributions 
49*27b03b36SApple OSS Distributions class IORTC : public IOService
50*27b03b36SApple OSS Distributions {
51*27b03b36SApple OSS Distributions 	OSDeclareAbstractStructors(IORTC);
52*27b03b36SApple OSS Distributions 
53*27b03b36SApple OSS Distributions protected:
54*27b03b36SApple OSS Distributions 
55*27b03b36SApple OSS Distributions /*! @var reserved
56*27b03b36SApple OSS Distributions  *   Reserved for future use.  (Internal use only)  */
57*27b03b36SApple OSS Distributions 	struct ExpansionData { };
58*27b03b36SApple OSS Distributions 	ExpansionData *iortc_reserved __unused;
59*27b03b36SApple OSS Distributions 
60*27b03b36SApple OSS Distributions public:
61*27b03b36SApple OSS Distributions 
62*27b03b36SApple OSS Distributions 	virtual long            getGMTTimeOfDay( void ) = 0;
63*27b03b36SApple OSS Distributions 	virtual void            setGMTTimeOfDay( long secs ) = 0;
64*27b03b36SApple OSS Distributions 
65*27b03b36SApple OSS Distributions 	virtual void                    getUTCTimeOfDay( clock_sec_t * secs, clock_nsec_t * nsecs );
66*27b03b36SApple OSS Distributions 	virtual void                    setUTCTimeOfDay( clock_sec_t secs, clock_nsec_t nsecs );
67*27b03b36SApple OSS Distributions 
68*27b03b36SApple OSS Distributions 	virtual void            setAlarmEnable( IOOptionBits message ) = 0;
69*27b03b36SApple OSS Distributions 
70*27b03b36SApple OSS Distributions 	virtual IOReturn        getMonotonicClockOffset( int64_t * usecs );
71*27b03b36SApple OSS Distributions 	virtual IOReturn        setMonotonicClockOffset( int64_t usecs );
72*27b03b36SApple OSS Distributions 	virtual IOReturn        getMonotonicClockAndTimestamp( uint64_t * usecs, uint64_t *mach_absolute_time );
73*27b03b36SApple OSS Distributions 
74*27b03b36SApple OSS Distributions 
75*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 0);
76*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 1);
77*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 2);
78*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 3);
79*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 4);
80*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 5);
81*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 6);
82*27b03b36SApple OSS Distributions 	OSMetaClassDeclareReservedUnused(IORTC, 7);
83*27b03b36SApple OSS Distributions };
84*27b03b36SApple OSS Distributions 
85*27b03b36SApple OSS Distributions #endif /* !_IORTCCONTROLLER_H */
86