New GPS HAL Interface
This change converts the hardware_legacy API to a HAL API. More cleanup work will likely follow. Change-Id: I6bd23b94ae458b0de32827c704a481564772ee3b
This commit is contained in:
Mike Lockwood
The Android Open Source Project
parent
e879c389cf
commit
4ea2a7a23c
1 changed files with 508 additions and 0 deletions
508
include/hardware/gps.h
Normal file
508
include/hardware/gps.h
Normal file
|
|
@ -0,0 +1,508 @@
|
|||
/*
|
||||
* Copyright (C) 2010 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
#ifndef ANDROID_INCLUDE_HARDWARE_GPS_H
|
||||
#define ANDROID_INCLUDE_HARDWARE_GPS_H
|
||||
|
||||
#include <stdint.h>
|
||||
#include <sys/cdefs.h>
|
||||
#include <sys/types.h>
|
||||
|
||||
#include <hardware/hardware.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
|
||||
/**
|
||||
* The id of this module
|
||||
*/
|
||||
#define GPS_HARDWARE_MODULE_ID "gps"
|
||||
|
||||
|
||||
/** Milliseconds since January 1, 1970 */
|
||||
typedef int64_t GpsUtcTime;
|
||||
|
||||
/** Maximum number of SVs for gps_sv_status_callback(). */
|
||||
#define GPS_MAX_SVS 32
|
||||
|
||||
/** Requested mode for GPS operation. */
|
||||
typedef uint32_t GpsPositionMode;
|
||||
// IMPORTANT: Note that the following values must match
|
||||
// constants in GpsLocationProvider.java.
|
||||
/** Mode for running GPS standalone (no assistance). */
|
||||
#define GPS_POSITION_MODE_STANDALONE 0
|
||||
/** AGPS MS-Based mode. */
|
||||
#define GPS_POSITION_MODE_MS_BASED 1
|
||||
/** AGPS MS-Assisted mode. */
|
||||
#define GPS_POSITION_MODE_MS_ASSISTED 2
|
||||
|
||||
/** GPS status event values. */
|
||||
typedef uint16_t GpsStatusValue;
|
||||
// IMPORTANT: Note that the following values must match
|
||||
// constants in GpsLocationProvider.java.
|
||||
/** GPS status unknown. */
|
||||
#define GPS_STATUS_NONE 0
|
||||
/** GPS has begun navigating. */
|
||||
#define GPS_STATUS_SESSION_BEGIN 1
|
||||
/** GPS has stopped navigating. */
|
||||
#define GPS_STATUS_SESSION_END 2
|
||||
/** GPS has powered on but is not navigating. */
|
||||
#define GPS_STATUS_ENGINE_ON 3
|
||||
/** GPS is powered off. */
|
||||
#define GPS_STATUS_ENGINE_OFF 4
|
||||
|
||||
/** Flags to indicate which values are valid in a GpsLocation. */
|
||||
typedef uint16_t GpsLocationFlags;
|
||||
// IMPORTANT: Note that the following values must match
|
||||
// constants in GpsLocationProvider.java.
|
||||
/** GpsLocation has valid latitude and longitude. */
|
||||
#define GPS_LOCATION_HAS_LAT_LONG 0x0001
|
||||
/** GpsLocation has valid altitude. */
|
||||
#define GPS_LOCATION_HAS_ALTITUDE 0x0002
|
||||
/** GpsLocation has valid speed. */
|
||||
#define GPS_LOCATION_HAS_SPEED 0x0004
|
||||
/** GpsLocation has valid bearing. */
|
||||
#define GPS_LOCATION_HAS_BEARING 0x0008
|
||||
/** GpsLocation has valid accuracy. */
|
||||
#define GPS_LOCATION_HAS_ACCURACY 0x0010
|
||||
|
||||
/** Flags used to specify which aiding data to delete
|
||||
when calling delete_aiding_data(). */
|
||||
typedef uint16_t GpsAidingData;
|
||||
// IMPORTANT: Note that the following values must match
|
||||
// constants in GpsLocationProvider.java.
|
||||
#define GPS_DELETE_EPHEMERIS 0x0001
|
||||
#define GPS_DELETE_ALMANAC 0x0002
|
||||
#define GPS_DELETE_POSITION 0x0004
|
||||
#define GPS_DELETE_TIME 0x0008
|
||||
#define GPS_DELETE_IONO 0x0010
|
||||
#define GPS_DELETE_UTC 0x0020
|
||||
#define GPS_DELETE_HEALTH 0x0040
|
||||
#define GPS_DELETE_SVDIR 0x0080
|
||||
#define GPS_DELETE_SVSTEER 0x0100
|
||||
#define GPS_DELETE_SADATA 0x0200
|
||||
#define GPS_DELETE_RTI 0x0400
|
||||
#define GPS_DELETE_CELLDB_INFO 0x8000
|
||||
#define GPS_DELETE_ALL 0xFFFF
|
||||
|
||||
/** AGPS type */
|
||||
typedef uint16_t AGpsType;
|
||||
#define AGPS_TYPE_SUPL 1
|
||||
#define AGPS_TYPE_C2K 2
|
||||
|
||||
/**
|
||||
* String length constants
|
||||
*/
|
||||
#define GPS_NI_SHORT_STRING_MAXLEN 256
|
||||
#define GPS_NI_LONG_STRING_MAXLEN 2048
|
||||
|
||||
/**
|
||||
* GpsNiType constants
|
||||
*/
|
||||
typedef uint32_t GpsNiType;
|
||||
#define GPS_NI_TYPE_VOICE 1
|
||||
#define GPS_NI_TYPE_UMTS_SUPL 2
|
||||
#define GPS_NI_TYPE_UMTS_CTRL_PLANE 3
|
||||
|
||||
/**
|
||||
* GpsNiNotifyFlags constants
|
||||
*/
|
||||
typedef uint32_t GpsNiNotifyFlags;
|
||||
/** NI requires notification */
|
||||
#define GPS_NI_NEED_NOTIFY 0x0001
|
||||
/** NI requires verification */
|
||||
#define GPS_NI_NEED_VERIFY 0x0002
|
||||
/** NI requires privacy override, no notification/minimal trace */
|
||||
#define GPS_NI_PRIVACY_OVERRIDE 0x0004
|
||||
|
||||
/**
|
||||
* GPS NI responses, used to define the response in
|
||||
* NI structures
|
||||
*/
|
||||
typedef int GpsUserResponseType;
|
||||
#define GPS_NI_RESPONSE_ACCEPT 1
|
||||
#define GPS_NI_RESPONSE_DENY 2
|
||||
#define GPS_NI_RESPONSE_NORESP 3
|
||||
|
||||
/**
|
||||
* NI data encoding scheme
|
||||
*/
|
||||
typedef int GpsNiEncodingType;
|
||||
#define GPS_ENC_NONE 0
|
||||
#define GPS_ENC_SUPL_GSM_DEFAULT 1
|
||||
#define GPS_ENC_SUPL_UTF8 2
|
||||
#define GPS_ENC_SUPL_UCS2 3
|
||||
#define GPS_ENC_UNKNOWN -1
|
||||
|
||||
/** AGPS status event values. */
|
||||
typedef uint16_t AGpsStatusValue;
|
||||
/** GPS requests data connection for AGPS. */
|
||||
#define GPS_REQUEST_AGPS_DATA_CONN 1
|
||||
/** GPS releases the AGPS data connection. */
|
||||
#define GPS_RELEASE_AGPS_DATA_CONN 2
|
||||
/** AGPS data connection initiated */
|
||||
#define GPS_AGPS_DATA_CONNECTED 3
|
||||
/** AGPS data connection completed */
|
||||
#define GPS_AGPS_DATA_CONN_DONE 4
|
||||
/** AGPS data connection failed */
|
||||
#define GPS_AGPS_DATA_CONN_FAILED 5
|
||||
|
||||
/**
|
||||
* Name for the GPS XTRA interface.
|
||||
*/
|
||||
#define GPS_XTRA_INTERFACE "gps-xtra"
|
||||
|
||||
/**
|
||||
* Name for the GPS DEBUG interface.
|
||||
*/
|
||||
#define GPS_DEBUG_INTERFACE "gps-debug"
|
||||
|
||||
/**
|
||||
* Name for the AGPS interface.
|
||||
*/
|
||||
#define AGPS_INTERFACE "agps"
|
||||
|
||||
/**
|
||||
* Name for NI interface
|
||||
*/
|
||||
#define GPS_NI_INTERFACE "gps-ni"
|
||||
|
||||
/** Represents a location. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsLocation) */
|
||||
size_t size;
|
||||
/** Contains GpsLocationFlags bits. */
|
||||
uint16_t flags;
|
||||
/** Represents latitude in degrees. */
|
||||
double latitude;
|
||||
/** Represents longitude in degrees. */
|
||||
double longitude;
|
||||
/** Represents altitude in meters above the WGS 84 reference
|
||||
* ellipsoid. */
|
||||
double altitude;
|
||||
/** Represents speed in meters per second. */
|
||||
float speed;
|
||||
/** Represents heading in degrees. */
|
||||
float bearing;
|
||||
/** Represents expected accuracy in meters. */
|
||||
float accuracy;
|
||||
/** Timestamp for the location fix. */
|
||||
GpsUtcTime timestamp;
|
||||
} GpsLocation;
|
||||
|
||||
/** Represents the status. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsStatus) */
|
||||
size_t size;
|
||||
GpsStatusValue status;
|
||||
} GpsStatus;
|
||||
|
||||
/** Represents SV information. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsSvInfo) */
|
||||
size_t size;
|
||||
/** Pseudo-random number for the SV. */
|
||||
int prn;
|
||||
/** Signal to noise ratio. */
|
||||
float snr;
|
||||
/** Elevation of SV in degrees. */
|
||||
float elevation;
|
||||
/** Azimuth of SV in degrees. */
|
||||
float azimuth;
|
||||
} GpsSvInfo;
|
||||
|
||||
/** Represents SV status. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsSvStatus) */
|
||||
size_t size;
|
||||
|
||||
/** Number of SVs currently visible. */
|
||||
int num_svs;
|
||||
|
||||
/** Contains an array of SV information. */
|
||||
GpsSvInfo sv_list[GPS_MAX_SVS];
|
||||
|
||||
/** Represents a bit mask indicating which SVs
|
||||
* have ephemeris data.
|
||||
*/
|
||||
uint32_t ephemeris_mask;
|
||||
|
||||
/** Represents a bit mask indicating which SVs
|
||||
* have almanac data.
|
||||
*/
|
||||
uint32_t almanac_mask;
|
||||
|
||||
/**
|
||||
* Represents a bit mask indicating which SVs
|
||||
* were used for computing the most recent position fix.
|
||||
*/
|
||||
uint32_t used_in_fix_mask;
|
||||
} GpsSvStatus;
|
||||
|
||||
/** Callback with location information. */
|
||||
typedef void (* gps_location_callback)(GpsLocation* location);
|
||||
|
||||
/** Callback with status information. */
|
||||
typedef void (* gps_status_callback)(GpsStatus* status);
|
||||
|
||||
/** Callback with SV status information. */
|
||||
typedef void (* gps_sv_status_callback)(GpsSvStatus* sv_info);
|
||||
|
||||
/** Callback for reporting NMEA sentences. */
|
||||
typedef void (* gps_nmea_callback)(GpsUtcTime timestamp, const char* nmea, int length);
|
||||
|
||||
/** GPS callback structure. */
|
||||
typedef struct {
|
||||
gps_location_callback location_cb;
|
||||
gps_status_callback status_cb;
|
||||
gps_sv_status_callback sv_status_cb;
|
||||
gps_nmea_callback nmea_cb;
|
||||
} GpsCallbacks;
|
||||
|
||||
|
||||
/** Represents the standard GPS interface. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsInterface) */
|
||||
size_t size;
|
||||
/**
|
||||
* Opens the interface and provides the callback routines
|
||||
* to the implemenation of this interface.
|
||||
*/
|
||||
int (*init)( GpsCallbacks* callbacks );
|
||||
|
||||
/** Starts navigating. */
|
||||
int (*start)( void );
|
||||
|
||||
/** Stops navigating. */
|
||||
int (*stop)( void );
|
||||
|
||||
/** Closes the interface. */
|
||||
void (*cleanup)( void );
|
||||
|
||||
/** Injects the current time. */
|
||||
int (*inject_time)(GpsUtcTime time, int64_t timeReference,
|
||||
int uncertainty);
|
||||
|
||||
/** Injects current location from another location provider
|
||||
* (typically cell ID).
|
||||
* latitude and longitude are measured in degrees
|
||||
* expected accuracy is measured in meters
|
||||
*/
|
||||
int (*inject_location)(double latitude, double longitude, float accuracy);
|
||||
|
||||
/**
|
||||
* Specifies that the next call to start will not use the
|
||||
* information defined in the flags. GPS_DELETE_ALL is passed for
|
||||
* a cold start.
|
||||
*/
|
||||
void (*delete_aiding_data)(GpsAidingData flags);
|
||||
|
||||
/**
|
||||
* fix_frequency represents the time between fixes in seconds.
|
||||
* Set fix_frequency to zero for a single-shot fix.
|
||||
*/
|
||||
int (*set_position_mode)(GpsPositionMode mode, int fix_frequency);
|
||||
|
||||
/** Get a pointer to extension information. */
|
||||
const void* (*get_extension)(const char* name);
|
||||
} GpsInterface;
|
||||
|
||||
/** Callback to request the client to download XTRA data.
|
||||
The client should download XTRA data and inject it by calling
|
||||
inject_xtra_data(). */
|
||||
typedef void (* gps_xtra_download_request)();
|
||||
|
||||
/** Callback structure for the XTRA interface. */
|
||||
typedef struct {
|
||||
gps_xtra_download_request download_request_cb;
|
||||
} GpsXtraCallbacks;
|
||||
|
||||
/** Extended interface for XTRA support. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsXtraInterface) */
|
||||
size_t size;
|
||||
/**
|
||||
* Opens the XTRA interface and provides the callback routines
|
||||
* to the implemenation of this interface.
|
||||
*/
|
||||
int (*init)( GpsXtraCallbacks* callbacks );
|
||||
/** Injects XTRA data into the GPS. */
|
||||
int (*inject_xtra_data)( char* data, int length );
|
||||
} GpsXtraInterface;
|
||||
|
||||
/** Extended interface for DEBUG support. */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsDebugInterface) */
|
||||
size_t size;
|
||||
|
||||
/**
|
||||
* This function should return any information that the native
|
||||
* implementation wishes to include in a bugreport.
|
||||
*/
|
||||
size_t (*get_internal_state)(char* buffer, size_t bufferSize);
|
||||
} GpsDebugInterface;
|
||||
|
||||
/** Represents the status of AGPS. */
|
||||
typedef struct {
|
||||
/** set to sizeof(AGpsStatus) */
|
||||
size_t size;
|
||||
|
||||
AGpsType type;
|
||||
AGpsStatusValue status;
|
||||
} AGpsStatus;
|
||||
|
||||
/** Callback with AGPS status information. */
|
||||
typedef void (* agps_status_callback)(AGpsStatus* status);
|
||||
|
||||
/** Callback structure for the AGPS interface. */
|
||||
typedef struct {
|
||||
agps_status_callback status_cb;
|
||||
} AGpsCallbacks;
|
||||
|
||||
|
||||
/** Extended interface for AGPS support. */
|
||||
typedef struct {
|
||||
/** set to sizeof(AGpsInterface) */
|
||||
size_t size;
|
||||
|
||||
/**
|
||||
* Opens the AGPS interface and provides the callback routines
|
||||
* to the implemenation of this interface.
|
||||
*/
|
||||
void (*init)( AGpsCallbacks* callbacks );
|
||||
/**
|
||||
* Notifies that a data connection is available and sets
|
||||
* the name of the APN to be used for SUPL.
|
||||
*/
|
||||
int (*data_conn_open)( const char* apn );
|
||||
/**
|
||||
* Notifies that the AGPS data connection has been closed.
|
||||
*/
|
||||
int (*data_conn_closed)();
|
||||
/**
|
||||
* Notifies that a data connection is not available for AGPS.
|
||||
*/
|
||||
int (*data_conn_failed)();
|
||||
/**
|
||||
* Sets the hostname and port for the AGPS server.
|
||||
*/
|
||||
int (*set_server)( AGpsType type, const char* hostname, int port );
|
||||
} AGpsInterface;
|
||||
|
||||
|
||||
/** Represents an NI request */
|
||||
typedef struct {
|
||||
/** set to sizeof(GpsNiNotification) */
|
||||
size_t size;
|
||||
|
||||
/**
|
||||
* An ID generated by HAL to associate NI notifications and UI
|
||||
* responses
|
||||
*/
|
||||
int notification_id;
|
||||
|
||||
/**
|
||||
* An NI type used to distinguish different categories of NI
|
||||
* events, such as GPS_NI_TYPE_VOICE, GPS_NI_TYPE_UMTS_SUPL, ...
|
||||
*/
|
||||
GpsNiType ni_type;
|
||||
|
||||
/**
|
||||
* Notification/verification options, combinations of GpsNiNotifyFlags constants
|
||||
*/
|
||||
GpsNiNotifyFlags notify_flags;
|
||||
|
||||
/**
|
||||
* Timeout period to wait for user response.
|
||||
* Set to 0 for no time out limit.
|
||||
*/
|
||||
int timeout;
|
||||
|
||||
/**
|
||||
* Default response when time out.
|
||||
*/
|
||||
GpsUserResponseType default_response;
|
||||
|
||||
/**
|
||||
* Requestor ID
|
||||
*/
|
||||
char requestor_id[GPS_NI_SHORT_STRING_MAXLEN];
|
||||
|
||||
/**
|
||||
* Notification message. It can also be used to store client_id in some cases
|
||||
*/
|
||||
char text[GPS_NI_LONG_STRING_MAXLEN];
|
||||
|
||||
/**
|
||||
* Client name decoding scheme
|
||||
*/
|
||||
GpsNiEncodingType requestor_id_encoding;
|
||||
|
||||
/**
|
||||
* Client name decoding scheme
|
||||
*/
|
||||
GpsNiEncodingType text_encoding;
|
||||
|
||||
/**
|
||||
* A pointer to extra data. Format:
|
||||
* key_1 = value_1
|
||||
* key_2 = value_2
|
||||
*/
|
||||
char extras[GPS_NI_LONG_STRING_MAXLEN];
|
||||
|
||||
} GpsNiNotification;
|
||||
|
||||
/** Callback with NI notification. */
|
||||
typedef void (*gps_ni_notify_callback)(GpsNiNotification *notification);
|
||||
|
||||
/** GPS NI callback structure. */
|
||||
typedef struct
|
||||
{
|
||||
/**
|
||||
* Sends the notification request from HAL to GPSLocationProvider.
|
||||
*/
|
||||
gps_ni_notify_callback notify_cb;
|
||||
} GpsNiCallbacks;
|
||||
|
||||
/**
|
||||
* Extended interface for Network-initiated (NI) support.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
/** set to sizeof(GpsNiInterface) */
|
||||
size_t size;
|
||||
|
||||
/** Registers the callbacks for HAL to use. */
|
||||
void (*init) (GpsNiCallbacks *callbacks);
|
||||
|
||||
/** Sends a response to HAL. */
|
||||
void (*respond) (int notif_id, GpsUserResponseType user_response);
|
||||
} GpsNiInterface;
|
||||
|
||||
struct gps_device_t {
|
||||
struct hw_device_t common;
|
||||
|
||||
/**
|
||||
* Set the provided lights to the provided values.
|
||||
*
|
||||
* Returns: 0 on succes, error code on failure.
|
||||
*/
|
||||
const GpsInterface* (*get_gps_interface)(struct gps_device_t* dev);
|
||||
};
|
||||
|
||||
__END_DECLS
|
||||
|
||||
#endif /* ANDROID_INCLUDE_HARDWARE_GPS_H */
|
||||
|
||||
Loading…
Reference in a new issue