1/* Copyright (c) 2011, Code Aurora Forum. All rights reserved.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions are
5 * met:
6 *     * Redistributions of source code must retain the above copyright
7 *       notice, this list of conditions and the following disclaimer.
8 *     * Redistributions in binary form must reproduce the above
9 *       copyright notice, this list of conditions and the following
10 *       disclaimer in the documentation and/or other materials provided
11 *       with the distribution.
12 *     * Neither the name of Code Aurora Forum, Inc. nor the names of its
13 *       contributors may be used to endorse or promote products derived
14 *       from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 */
29
30#ifndef ULP_H
31#define ULP_H
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#include <hardware/gps.h>
39
40typedef int (ulp_report_position_cb)
41(
42      void* owner,
43      const GpsLocation* location_report_ptr,
44      unsigned int ext_data_length,
45      unsigned char* ext_data
46);
47
48/** Represents the standard ulp module interface. */
49typedef struct {
50    /** set to sizeof(ulpInterface) */
51    size_t   size;
52
53    /**
54     * Starts the ulp module. 0: success
55     */
56    int   (*init)( void* owner, ulp_report_position_cb* cb);
57
58    /** Starts the ulp engine. 0: success      */
59    int   (*start_fix)( void );
60
61    /** Stops the ulp engine. 0: success */
62    int   (*stop_fix)( void );
63
64    /** Closes the interface */
65    int   (*destroy)( void );
66
67} ulpInterface;
68
69typedef const ulpInterface* (get_ulp_interface) (void);
70
71
72#ifdef __cplusplus
73}
74#endif
75#endif /* ULP_H */
76
77