xref: /xnu-10002.1.13/osfmk/man/clock_map_time.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>clock_map_time</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Return a memory object that maps a clock.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>kern_return_t   clock_map_time</strong>
8*1031c584SApple OSS Distributions                <strong>(clock_t</strong>                             <var>clock_name</var>,
9*1031c584SApple OSS Distributions                 <strong>memory_object_t</strong>                   <var>clock_memory</var><strong>);</strong>
10*1031c584SApple OSS Distributions</pre>
11*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
12*1031c584SApple OSS Distributions<dl>
13*1031c584SApple OSS Distributions<p>
14*1031c584SApple OSS Distributions<dt> <var>clock_name</var>
15*1031c584SApple OSS Distributions<dd>
16*1031c584SApple OSS Distributions[in clock-name send right]
17*1031c584SApple OSS DistributionsThe name (or control) port for the clock.
18*1031c584SApple OSS Distributions<p>
19*1031c584SApple OSS Distributions<dt> <var>clock_memory</var>
20*1031c584SApple OSS Distributions<dd>
21*1031c584SApple OSS Distributions[out memory-object-representative send right]
22*1031c584SApple OSS DistributionsMapped clock time
23*1031c584SApple OSS Distributionsmemory object representative.
24*1031c584SApple OSS Distributions</dl>
25*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
26*1031c584SApple OSS Distributions<p>
27*1031c584SApple OSS DistributionsThe <strong>clock_map_time</strong> function returns a memory object representative port
28*1031c584SApple OSS Distributionsrepresenting read access to a memory object that contains (at offset zero) a
29*1031c584SApple OSS Distributionsmapped version of the clock time (structure <strong>mapped_tvalspec</strong>).
30*1031c584SApple OSS DistributionsThe returned right is suitable as an argument for <strong>vm_map</strong>.
31*1031c584SApple OSS Distributions<h3>NOTES</h3>
32*1031c584SApple OSS Distributions<p>
33*1031c584SApple OSS DistributionsNot all clocks provide this service, but the REALTIME clock must.
34*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
35*1031c584SApple OSS Distributions<dl>
36*1031c584SApple OSS Distributions<p>
37*1031c584SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
38*1031c584SApple OSS Distributions<dd>
39*1031c584SApple OSS DistributionsThe specified clock does not provide this service.
40*1031c584SApple OSS Distributions</dl>
41*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
42*1031c584SApple OSS Distributions<p>
43*1031c584SApple OSS DistributionsFunctions:
44*1031c584SApple OSS Distributions<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
45*1031c584SApple OSS Distributions<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
46*1031c584SApple OSS Distributions<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
47*1031c584SApple OSS Distributions<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
48*1031c584SApple OSS Distributions<a href="clock_alarm.html"><strong>clock_alarm</strong></a>.
49*1031c584SApple OSS Distributions<p>
50*1031c584SApple OSS DistributionsData Structures:
51*1031c584SApple OSS Distributions<a href="mapped_tvalspec.html"><strong>mapped_tvalspec</strong></a>.
52