Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / development / e943f2fd8e7623ba3ea12bb65294d30446db4174 / . / pdk / docs / gps_8h.html
blob: 726d25e7cd29c130d3996c9c877267b969926dfc [file] [log] [blame]
The Android Open Source Projecte943f2f2008-12-17 18:04:04 -0800[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
5<title>Doxygen-Generated Content</title>
6<link href="doxygen.css" rel="stylesheet" type="text/css" />
7<style type="text/css">
8<!--
9.navigation {
10 display: none;
11}
12-->
13</style>
14</head>
15<body>
16<!-- Generated by Doxygen 1.5.6 -->
17<div class="navigation" id="top">
18 <div class="tabs">
19 <ul>
20 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
21 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
22 <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
23 <li class="current"><a href="files.html"><span>Files</span></a></li>
24 </ul>
25 </div>
26</div>
27<div class="contents">
28<h1>gps.h File Reference</h1>
29<p>
30<a href="gps_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
31<tr><td></td></tr>
32<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_location.html">GpsLocation</a></td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents a location. <a href="struct_gps_location.html#_details">More...</a><br></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_status.html">GpsStatus</a></td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents the status. <a href="struct_gps_status.html#_details">More...</a><br></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_sv_info.html">GpsSvInfo</a></td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents SV information. <a href="struct_gps_sv_info.html#_details">More...</a><br></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_sv_status.html">GpsSvStatus</a></td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents SV status. <a href="struct_gps_sv_status.html#_details">More...</a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_callbacks.html">GpsCallbacks</a></td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">GPS callback structure. <a href="struct_gps_callbacks.html#_details">More...</a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_interface.html">GpsInterface</a></td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents the standard GPS interface. <a href="struct_gps_interface.html#_details">More...</a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_xtra_callbacks.html">GpsXtraCallbacks</a></td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback structure for the XTRA interface. <a href="struct_gps_xtra_callbacks.html#_details">More...</a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_xtra_interface.html">GpsXtraInterface</a></td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extended interface for XTRA support. <a href="struct_gps_xtra_interface.html#_details">More...</a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gps_supl_interface.html">GpsSuplInterface</a></td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extended interface for SUPL support. <a href="struct_gps_supl_interface.html#_details">More...</a><br></td></tr>
60<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int64_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#f2b0ea531a44c010f81a4abd27504c15">GpsUtcTime</a></td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Milliseconds since January 1, 1970. <a href="#f2b0ea531a44c010f81a4abd27504c15"></a><br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#2461a6f0dd56a1f7dc94e93207a1f740">GpsPositionMode</a></td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Requested mode for GPS operation. <a href="#2461a6f0dd56a1f7dc94e93207a1f740"></a><br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#de8fa0020d3aa1748a8e26759b768ec5">GpsStatusValue</a></td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">GPS status event values. <a href="#de8fa0020d3aa1748a8e26759b768ec5"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#4ae31616d5e232ad7a346a2d4e723e31">GpsLocationFlags</a></td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flags to indicate which values are valid in a <a class="el" href="struct_gps_location.html" title="Represents a location.">GpsLocation</a>. <a href="#4ae31616d5e232ad7a346a2d4e723e31"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#93f0283aeabd20211499991a29db7377">GpsAidingData</a></td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flags used to specify which aiding data to delete when calling delete_aiding_data(). <a href="#93f0283aeabd20211499991a29db7377"></a><br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#88f19d3da70dc0e951b51091ce0631ae">gps_location_callback</a> )(<a class="el" href="struct_gps_location.html">GpsLocation</a> *location)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback with location information. <a href="#88f19d3da70dc0e951b51091ce0631ae"></a><br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#1d9ef60ab0b91f7c106867a6aa1e4412">gps_status_callback</a> )(<a class="el" href="struct_gps_status.html">GpsStatus</a> *status)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback with status information. <a href="#1d9ef60ab0b91f7c106867a6aa1e4412"></a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#67274e784834c6c2547f4b5344fc4ea9">gps_sv_status_callback</a> )(<a class="el" href="struct_gps_sv_status.html">GpsSvStatus</a> *sv_info)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback with SV status information. <a href="#67274e784834c6c2547f4b5344fc4ea9"></a><br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#08fcfb3f85c2ac3008c9c73cf9136515">gps_xtra_download_request</a> )()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback to request the client to download XTRA data. <a href="#08fcfb3f85c2ac3008c9c73cf9136515"></a><br></td></tr>
88<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct_gps_interface.html">GpsInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#6d15bb02f1f91dd760e3e172bd7711a1">gps_get_hardware_interface</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the hardware GPS interface. <a href="#6d15bb02f1f91dd760e3e172bd7711a1"></a><br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct_gps_interface.html">GpsInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#f73f4a220fb97545e81d82fbff54b47e">gps_get_qemu_interface</a> ()</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the qemu emulated GPS interface. <a href="#f73f4a220fb97545e81d82fbff54b47e"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct_gps_interface.html">GpsInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#b582931ddf4bafa2cc5044963be66987">gps_get_interface</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the default GPS interface. <a href="#b582931ddf4bafa2cc5044963be66987"></a><br></td></tr>
98</table>
99<hr><h2>Typedef Documentation</h2>
100<a class="anchor" name="88f19d3da70dc0e951b51091ce0631ae"></a><!-- doxytag: member="gps.h::gps_location_callback" ref="88f19d3da70dc0e951b51091ce0631ae" args=")(GpsLocation *location)" -->
101<div class="memitem">
102<div class="memproto">
103 <table class="memname">
104 <tr>
105 <td class="memname">typedef void(* <a class="el" href="gps_8h.html#88f19d3da70dc0e951b51091ce0631ae">gps_location_callback</a>)(<a class="el" href="struct_gps_location.html">GpsLocation</a> *location) </td>
106 </tr>
107 </table>
108</div>
109<div class="memdoc">
110
111<p>
112Callback with location information.
113<p>
114
115<p>Definition at line <a class="el" href="gps_8h-source.html#l00166">166</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
116
117</div>
118</div><p>
119<a class="anchor" name="1d9ef60ab0b91f7c106867a6aa1e4412"></a><!-- doxytag: member="gps.h::gps_status_callback" ref="1d9ef60ab0b91f7c106867a6aa1e4412" args=")(GpsStatus *status)" -->
120<div class="memitem">
121<div class="memproto">
122 <table class="memname">
123 <tr>
124 <td class="memname">typedef void(* <a class="el" href="gps_8h.html#1d9ef60ab0b91f7c106867a6aa1e4412">gps_status_callback</a>)(<a class="el" href="struct_gps_status.html">GpsStatus</a> *status) </td>
125 </tr>
126 </table>
127</div>
128<div class="memdoc">
129
130<p>
131Callback with status information.
132<p>
133
134<p>Definition at line <a class="el" href="gps_8h-source.html#l00169">169</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
135
136</div>
137</div><p>
138<a class="anchor" name="67274e784834c6c2547f4b5344fc4ea9"></a><!-- doxytag: member="gps.h::gps_sv_status_callback" ref="67274e784834c6c2547f4b5344fc4ea9" args=")(GpsSvStatus *sv_info)" -->
139<div class="memitem">
140<div class="memproto">
141 <table class="memname">
142 <tr>
143 <td class="memname">typedef void(* <a class="el" href="gps_8h.html#67274e784834c6c2547f4b5344fc4ea9">gps_sv_status_callback</a>)(<a class="el" href="struct_gps_sv_status.html">GpsSvStatus</a> *sv_info) </td>
144 </tr>
145 </table>
146</div>
147<div class="memdoc">
148
149<p>
150Callback with SV status information.
151<p>
152
153<p>Definition at line <a class="el" href="gps_8h-source.html#l00172">172</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
154
155</div>
156</div><p>
157<a class="anchor" name="08fcfb3f85c2ac3008c9c73cf9136515"></a><!-- doxytag: member="gps.h::gps_xtra_download_request" ref="08fcfb3f85c2ac3008c9c73cf9136515" args=")()" -->
158<div class="memitem">
159<div class="memproto">
160 <table class="memname">
161 <tr>
162 <td class="memname">typedef void(* <a class="el" href="gps_8h.html#08fcfb3f85c2ac3008c9c73cf9136515">gps_xtra_download_request</a>)() </td>
163 </tr>
164 </table>
165</div>
166<div class="memdoc">
167
168<p>
169Callback to request the client to download XTRA data.
170<p>
171The client should download XTRA data and inject it by calling inject_xtra_data().
172<p>Definition at line <a class="el" href="gps_8h-source.html#l00226">226</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
173
174</div>
175</div><p>
176<a class="anchor" name="93f0283aeabd20211499991a29db7377"></a><!-- doxytag: member="gps.h::GpsAidingData" ref="93f0283aeabd20211499991a29db7377" args="" -->
177<div class="memitem">
178<div class="memproto">
179 <table class="memname">
180 <tr>
181 <td class="memname">typedef uint16_t <a class="el" href="gps_8h.html#93f0283aeabd20211499991a29db7377">GpsAidingData</a> </td>
182 </tr>
183 </table>
184</div>
185<div class="memdoc">
186
187<p>
188Flags used to specify which aiding data to delete when calling delete_aiding_data().
189<p>
190
191<p>Definition at line <a class="el" href="gps_8h-source.html#l00075">75</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
192
193</div>
194</div><p>
195<a class="anchor" name="4ae31616d5e232ad7a346a2d4e723e31"></a><!-- doxytag: member="gps.h::GpsLocationFlags" ref="4ae31616d5e232ad7a346a2d4e723e31" args="" -->
196<div class="memitem">
197<div class="memproto">
198 <table class="memname">
199 <tr>
200 <td class="memname">typedef uint16_t <a class="el" href="gps_8h.html#4ae31616d5e232ad7a346a2d4e723e31">GpsLocationFlags</a> </td>
201 </tr>
202 </table>
203</div>
204<div class="memdoc">
205
206<p>
207Flags to indicate which values are valid in a <a class="el" href="struct_gps_location.html" title="Represents a location.">GpsLocation</a>.
208<p>
209
210<p>Definition at line <a class="el" href="gps_8h-source.html#l00059">59</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
211
212</div>
213</div><p>
214<a class="anchor" name="2461a6f0dd56a1f7dc94e93207a1f740"></a><!-- doxytag: member="gps.h::GpsPositionMode" ref="2461a6f0dd56a1f7dc94e93207a1f740" args="" -->
215<div class="memitem">
216<div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">typedef uint16_t <a class="el" href="gps_8h.html#2461a6f0dd56a1f7dc94e93207a1f740">GpsPositionMode</a> </td>
220 </tr>
221 </table>
222</div>
223<div class="memdoc">
224
225<p>
226Requested mode for GPS operation.
227<p>
228
229<p>Definition at line <a class="el" href="gps_8h-source.html#l00033">33</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
230
231</div>
232</div><p>
233<a class="anchor" name="de8fa0020d3aa1748a8e26759b768ec5"></a><!-- doxytag: member="gps.h::GpsStatusValue" ref="de8fa0020d3aa1748a8e26759b768ec5" args="" -->
234<div class="memitem">
235<div class="memproto">
236 <table class="memname">
237 <tr>
238 <td class="memname">typedef uint16_t <a class="el" href="gps_8h.html#de8fa0020d3aa1748a8e26759b768ec5">GpsStatusValue</a> </td>
239 </tr>
240 </table>
241</div>
242<div class="memdoc">
243
244<p>
245GPS status event values.
246<p>
247
248<p>Definition at line <a class="el" href="gps_8h-source.html#l00044">44</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
249
250</div>
251</div><p>
252<a class="anchor" name="f2b0ea531a44c010f81a4abd27504c15"></a><!-- doxytag: member="gps.h::GpsUtcTime" ref="f2b0ea531a44c010f81a4abd27504c15" args="" -->
253<div class="memitem">
254<div class="memproto">
255 <table class="memname">
256 <tr>
257 <td class="memname">typedef int64_t <a class="el" href="gps_8h.html#f2b0ea531a44c010f81a4abd27504c15">GpsUtcTime</a> </td>
258 </tr>
259 </table>
260</div>
261<div class="memdoc">
262
263<p>
264Milliseconds since January 1, 1970.
265<p>
266
267<p>Definition at line <a class="el" href="gps_8h-source.html#l00027">27</a> of file <a class="el" href="gps_8h-source.html">gps.h</a>.</p>
268
269</div>
270</div><p>
271<hr><h2>Function Documentation</h2>
272<a class="anchor" name="6d15bb02f1f91dd760e3e172bd7711a1"></a><!-- doxytag: member="gps.h::gps_get_hardware_interface" ref="6d15bb02f1f91dd760e3e172bd7711a1" args="()" -->
273<div class="memitem">
274<div class="memproto">
275 <table class="memname">
276 <tr>
277 <td class="memname">const <a class="el" href="struct_gps_interface.html">GpsInterface</a>* gps_get_hardware_interface </td>
278 <td>(</td>
279 <td class="paramname"> </td>
280 <td>&nbsp;)&nbsp;</td>
281 <td></td>
282 </tr>
283 </table>
284</div>
285<div class="memdoc">
286
287<p>
288Returns the hardware GPS interface.
289<p>
290
291</div>
292</div><p>
293<a class="anchor" name="b582931ddf4bafa2cc5044963be66987"></a><!-- doxytag: member="gps.h::gps_get_interface" ref="b582931ddf4bafa2cc5044963be66987" args="()" -->
294<div class="memitem">
295<div class="memproto">
296 <table class="memname">
297 <tr>
298 <td class="memname">const <a class="el" href="struct_gps_interface.html">GpsInterface</a>* gps_get_interface </td>
299 <td>(</td>
300 <td class="paramname"> </td>
301 <td>&nbsp;)&nbsp;</td>
302 <td></td>
303 </tr>
304 </table>
305</div>
306<div class="memdoc">
307
308<p>
309Returns the default GPS interface.
310<p>
311
312</div>
313</div><p>
314<a class="anchor" name="f73f4a220fb97545e81d82fbff54b47e"></a><!-- doxytag: member="gps.h::gps_get_qemu_interface" ref="f73f4a220fb97545e81d82fbff54b47e" args="()" -->
315<div class="memitem">
316<div class="memproto">
317 <table class="memname">
318 <tr>
319 <td class="memname">const <a class="el" href="struct_gps_interface.html">GpsInterface</a>* gps_get_qemu_interface </td>
320 <td>(</td>
321 <td class="paramname"> </td>
322 <td>&nbsp;)&nbsp;</td>
323 <td></td>
324 </tr>
325 </table>
326</div>
327<div class="memdoc">
328
329<p>
330Returns the qemu emulated GPS interface.
331<p>
332
333</div>
334</div><p>
335</div>
336</body>
337</html>