diff options
Diffstat (limited to 'include/hardware/gps.h')
| -rw-r--r-- | include/hardware/gps.h | 1050 |
1 files changed, 1050 insertions, 0 deletions
diff --git a/include/hardware/gps.h b/include/hardware/gps.h new file mode 100644 index 0000000..9e70070 --- /dev/null +++ b/include/hardware/gps.h @@ -0,0 +1,1050 @@ +/* + * Copyright (C) 2010 The Android Open Source Project + * Copyright (c) 2011,2012 Code Aurora Forum. All rights reserved. + * + * 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 <stdbool.h> +#include <sys/cdefs.h> +#include <sys/types.h> +#include <pthread.h> + +#include <hardware/hardware.h> + +__BEGIN_DECLS + +/** + * The id of this module + */ +#define GPS_HARDWARE_MODULE_ID "gps" +#define ULP_NETWORK_INTERFACE "ulp-network-interface" + +/** Milliseconds since January 1, 1970 */ +typedef int64_t GpsUtcTime; + +/** Maximum number of SVs for gps_sv_status_callback(). */ +#define GPS_MAX_SVS 32 + +/** Requested operational 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 + +/** Requested recurrence mode for GPS operation. */ +typedef uint32_t GpsPositionRecurrence; +// IMPORTANT: Note that the following values must match +// constants in GpsLocationProvider.java. +/** Receive GPS fixes on a recurring basis at a specified period. */ +#define GPS_POSITION_RECURRENCE_PERIODIC 0 +/** Request a single shot GPS fix. */ +#define GPS_POSITION_RECURRENCE_SINGLE 1 + +/** 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 +/** Location has valid source information. */ +#define LOCATION_HAS_SOURCE_INFO 0x0020 +/** GpsLocation has valid "is indoor?" flag */ +#define GPS_LOCATION_HAS_IS_INDOOR 0x0040 +/** GpsLocation has valid floor number */ +#define GPS_LOCATION_HAS_FLOOR_NUMBER 0x0080 +/** GpsLocation has valid map URL*/ +#define GPS_LOCATION_HAS_MAP_URL 0x0100 +/** GpsLocation has valid map index */ +#define GPS_LOCATION_HAS_MAP_INDEX 0x0200 + +/** Sizes for indoor fields */ +#define GPS_LOCATION_MAP_URL_SIZE 400 +#define GPS_LOCATION_MAP_INDEX_SIZE 16 + +/** Location Information Source */ +/** Position source is ULP */ +#define ULP_LOCATION_IS_FROM_HYBRID 0x0001 +/** Position source is GNSS only */ +#define ULP_LOCATION_IS_FROM_GNSS 0x0002 + +/** Flags for the gps_set_capabilities callback. */ + +/** GPS HAL schedules fixes for GPS_POSITION_RECURRENCE_PERIODIC mode. + If this is not set, then the framework will use 1000ms for min_interval + and will start and call start() and stop() to schedule the GPS. + */ +#define GPS_CAPABILITY_SCHEDULING 0x0000001 +/** GPS supports MS-Based AGPS mode */ +#define GPS_CAPABILITY_MSB 0x0000002 +/** GPS supports MS-Assisted AGPS mode */ +#define GPS_CAPABILITY_MSA 0x0000004 +/** GPS supports single-shot fixes */ +#define GPS_CAPABILITY_SINGLE_SHOT 0x0000008 +/** GPS supports on demand time injection */ +#define GPS_CAPABILITY_ON_DEMAND_TIME 0x0000010 +/* Hybrid support, the Android Framework will query to see if this capability is set before using the ulp functionalities in HAL */ +#define ULP_CAPABILITY 0x0000020 +/** Flags used to specify which aiding data to delete + when calling delete_aiding_data(). */ +typedef uint32_t GpsAidingData; +// IMPORTANT: Note that the following values must match +// constants in GpsLocationProvider.java. +#define GPS_DELETE_EPHEMERIS 0x00000001 +#define GPS_DELETE_ALMANAC 0x00000002 +#define GPS_DELETE_POSITION 0x00000004 +#define GPS_DELETE_TIME 0x00000008 +#define GPS_DELETE_IONO 0x00000010 +#define GPS_DELETE_UTC 0x00000020 +#define GPS_DELETE_HEALTH 0x00000040 +#define GPS_DELETE_SVDIR 0x00000080 +#define GPS_DELETE_SVSTEER 0x00000100 +#define GPS_DELETE_SADATA 0x00000200 +#define GPS_DELETE_RTI 0x00000400 +#define GPS_DELETE_CELLDB_INFO 0x00000800 +#define GPS_DELETE_ALMANAC_CORR 0x00001000 +#define GPS_DELETE_FREQ_BIAS_EST 0x00002000 +#define GPS_DELETE_EPHEMERIS_GLO 0x00004000 +#define GPS_DELETE_ALMANAC_GLO 0x00008000 +#define GPS_DELETE_SVDIR_GLO 0x00010000 +#define GPS_DELETE_SVSTEER_GLO 0x00020000 +#define GPS_DELETE_ALMANAC_CORR_GLO 0x00040000 +#define GPS_DELETE_TIME_GPS 0x00080000 +#define GPS_DELETE_TIME_GLO 0x00100000 + +#define GPS_DELETE_ALL 0xFFFFFFFF + +/** AGPS type */ +typedef int16_t AGpsType; +#define AGPS_TYPE_INVALID -1 +#define AGPS_TYPE_ANY 0 +#define AGPS_TYPE_SUPL 1 +#define AGPS_TYPE_C2K 2 +#define AGPS_TYPE_WWAN_ANY 3 +#define AGPS_TYPE_WIFI 4 + +/** SSID length */ +#define SSID_BUF_SIZE (32+1) + +typedef uint16_t AGpsSetIDType; +#define AGPS_SETID_TYPE_NONE 0 +#define AGPS_SETID_TYPE_IMSI 1 +#define AGPS_SETID_TYPE_MSISDN 2 + +typedef int16_t AGpsBearerType; +#define AGPS_APN_BEARER_INVALID -1 +#define AGPS_APN_BEARER_IPV4 0 +#define AGPS_APN_BEARER_IPV6 1 +#define AGPS_APN_BEARER_IPV4V6 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 + +#define AGPS_REF_LOCATION_TYPE_GSM_CELLID 1 +#define AGPS_REF_LOCATION_TYPE_UMTS_CELLID 2 +#define AGPS_REG_LOCATION_TYPE_MAC 3 + +/** Network types for update_network_state "type" parameter */ +#define AGPS_RIL_NETWORK_TYPE_MOBILE 0 +#define AGPS_RIL_NETWORK_TYPE_WIFI 1 +#define AGPS_RIL_NETWORK_TYPE_MOBILE_MMS 2 +#define AGPS_RIL_NETWORK_TYPE_MOBILE_SUPL 3 +#define AGPS_RIL_NETWORK_TTYPE_MOBILE_DUN 4 +#define AGPS_RIL_NETWORK_TTYPE_MOBILE_HIPRI 5 +#define AGPS_RIL_NETWORK_TTYPE_WIMAX 6 + +/** + * Name for the EXTRA CMD interface. To pass from app to HAL + */ +#define ULP_RAW_CMD_INTERFACE "ulp-raw-cmd" + +/** + * 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" + +/** + * Name for the AGPS-RIL interface. + */ +#define AGPS_RIL_INTERFACE "agps_ril" +/** +* Name for ULP Phone Context Interface +*/ +#define ULP_PHONE_CONTEXT_INTERFACE "ulp-phone-context" + +/** Represents recurrence of location */ +typedef enum{ + ULP_LOC_RECURRENCE_PERIODIC = 0, + ULP_LOC_RECURRENCE_SINGLE, +}UlpRecurrenceCriteria; + +/** Represents horizontal accuracy options */ +typedef enum { + ULP_HORZ_ACCURACY_DONT_CARE = 0, + ULP_HORZ_ACCURACY_LOW, + ULP_HORZ_ACCURACY_MED, + ULP_HORZ_ACCURACY_HIGH, +}UlpHorzAccuracyCriteria; + +/** Represents accuracy options (for speed, altitude, and + * bearing) */ +typedef enum { + ULP_ACCURACY_DONT_CARE = 0, + ULP_ACCURACY_LOW, + ULP_ACCURACY_HIGH, +}UlpAccuracyCriteria; + +/** Represents power consumption options */ +typedef enum { + ULP_POWER_REQ_DONT_CARE = 0, + ULP_POWER_REQ_LOW, + ULP_POWER_REQ_HIGH, +}UlpPowerCriteria; + +/** Represents data usage options */ +typedef enum { + ULP_DATA_REQ_DONT_CARE = 0, + ULP_DATA_ALLOW, + ULP_DATA_DENY, +}UlpDataUsageCriteria; + +/** Enable the reporting of altitude in location reports */ +#define ULP_ENABLE_ALTITUDE_REPORT 0x01 +/** Enable the reporting of speed in location reports */ +#define ULP_ENABLE_SPEED_REPORT 0x02 +/** Enable the reporting of bearing in location reports */ +#define ULP_ENABLE_BEARING_REPORT 0x04 + +#define ULP_CRITERIA_HAS_ACTION 0x00000001 +#define ULP_CRITERIA_HAS_PROVIDER_SOURCE 0x00000002 +#define ULP_CRITERIA_HAS_RECURRENCE_TYPE 0x00000004 +#define ULP_CRITERIA_HAS_PREFERRED_RESPONSE_TIME 0x00000010 +#define ULP_CRITERIA_HAS_MIN_INTERVAL 0x00000020 +#define ULP_CRITERIA_HAS_MIN_DISTANCE 0x00000040 +#define ULP_CRITERIA_HAS_MIN_DIST_SAMPLE_INTERVAL 0x00000080 +#define ULP_CRITERIA_HAS_DESIRED_OUTPUT_PARAMETER 0x00000100 +#define ULP_CRITERIA_HAS_PREFERRED_HORIZONTAL_ACCURACY 0x00000200 +#define ULP_CRITERIA_HAS_PREFERRED_POWER_CONSUMPTION 0x00000400 +#define ULP_CRITERIA_HAS_PREFERRED_ALTITUDE_ACCURACY 0x00000800 +#define ULP_CRITERIA_HAS_PREFERRED_BEARING_ACCURACY 0x00001000 +#define ULP_CRITERIA_HAS_PREFERRED_DATA_USAGE 0x00002000 +#define ULP_CRITERIA_HAS_INTERMEDIATE_POS_REPORT_ENABLED 0x00004000 + +#define ULP_PROVIDER_SOURCE_GNSS 0x00000001 +#define ULP_PROVIDER_SOURCE_HYBRID 0x00000002 + + +#define ULP_ADD_CRITERIA 1 +#define ULP_REMOVE_CRITERIA 2 + +typedef struct { + + uint32_t valid_mask; + /* delete or add. This is a mandatory field */ + int action; + /*via gps or hybrid provider*/ + int provider_source; + /** PERIODIC or SINGLE */ + UlpRecurrenceCriteria recurrence_type; + /** obtain position within the specified response time */ + uint32_t preferred_response_time; + /** Send updates after the specified interval */ + uint32_t min_interval; + /** Send updates after device moved a specified distance */ + float min_distance; + uint32_t min_dist_sample_interval; + /** Fields specfied in the mask should be reported in the + * position report (altitude, bearing and speed) */ + uint32_t desired_output_parameter; + /** Desired accuracy for latitude, longitude */ + UlpHorzAccuracyCriteria preferred_horizontal_accuracy; + /** Desired power consumption level */ + UlpPowerCriteria preferred_power_consumption; + /** Desired accuracy for altitude */ + UlpAccuracyCriteria preferred_altitude_accuracy; + /** Desired accuracy for bearing */ + UlpAccuracyCriteria preferred_bearing_accuracy; + UlpDataUsageCriteria preferred_data_usage; + bool intermediate_pos_report_enabled; +} UlpLocationCriteria; + +/** Represents a location. */ +typedef struct { + /** set to sizeof(GpsLocation) */ + size_t size; + /** Contains GpsLocationFlags bits. */ + uint16_t flags; + /* Provider indicator for HYBRID or GPS */ + uint16_t position_source; + /** 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; + /*allows HAL to pass additional information related to the location */ + int rawDataSize; /* in # of bytes */ + void * rawData; + bool is_indoor; + float floor_number; + char map_url[GPS_LOCATION_MAP_URL_SIZE]; + unsigned char map_index[GPS_LOCATION_MAP_INDEX_SIZE]; +} 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; +#if 1 + /** Placeholder for Samsung ABI compat */ + int unknown; +#endif +} 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; + +/* 2G and 3G */ +/* In 3G lac is discarded */ +typedef struct { + uint16_t type; + uint16_t mcc; + uint16_t mnc; + uint16_t lac; +#if 1 + /** Placeholder for Samsung ABI compat */ + uint16_t unknown; +#endif + uint32_t cid; +} AGpsRefLocationCellID; + +typedef struct { + uint8_t mac[6]; +} AGpsRefLocationMac; + +/** Represents ref locations */ +typedef struct { + uint16_t type; + union { + AGpsRefLocationCellID cellID; + AGpsRefLocationMac mac; + } u; +} AGpsRefLocation; + +/** Callback with location information. + * Can only be called from a thread created by create_thread_cb. + */ +typedef void (* gps_location_callback)(GpsLocation* location); + +/** Callback with status information. + * Can only be called from a thread created by create_thread_cb. + */ +typedef void (* gps_status_callback)(GpsStatus* status); + +/** Callback with SV status information. + * Can only be called from a thread created by create_thread_cb. + */ +typedef void (* gps_sv_status_callback)(GpsSvStatus* sv_info); + +/** Callback for reporting NMEA sentences. + * Can only be called from a thread created by create_thread_cb. + */ +typedef void (* gps_nmea_callback)(GpsUtcTime timestamp, const char* nmea, int length); + +/** Callback to inform framework of the GPS engine's capabilities. + * Capability parameter is a bit field of GPS_CAPABILITY_* flags. + */ +typedef void (* gps_set_capabilities)(uint32_t capabilities); + +/** Callback utility for acquiring the GPS wakelock. + * This can be used to prevent the CPU from suspending while handling GPS events. + */ +typedef void (* gps_acquire_wakelock)(); + +/** Callback utility for releasing the GPS wakelock. */ +typedef void (* gps_release_wakelock)(); + +/** Callback for requesting NTP time */ +typedef void (* gps_request_utc_time)(); + +/** Callback for creating a thread that can call into the Java framework code. + * This must be used to create any threads that report events up to the framework. + */ +typedef pthread_t (* gps_create_thread)(const char* name, void (*start)(void *), void* arg); + +/** GPS callback structure. */ +typedef struct { + /** set to sizeof(GpsCallbacks) */ + size_t size; + gps_location_callback location_cb; + gps_status_callback status_cb; + gps_sv_status_callback sv_status_cb; + gps_nmea_callback nmea_cb; + gps_set_capabilities set_capabilities_cb; + gps_acquire_wakelock acquire_wakelock_cb; + gps_release_wakelock release_wakelock_cb; + gps_create_thread create_thread_cb; + gps_request_utc_time request_utc_time_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); + + /** + * min_interval represents the time between fixes in milliseconds. + * preferred_accuracy represents the requested fix accuracy in meters. + * preferred_time represents the requested time to first fix in milliseconds. + */ + int (*set_position_mode)(GpsPositionMode mode, GpsPositionRecurrence recurrence, + uint32_t min_interval, uint32_t preferred_accuracy, uint32_t preferred_time); + + /** Get a pointer to extension information. */ + const void* (*get_extension)(const char* name); + + /* set criterias of location requests */ + int (*update_criteria) (UlpLocationCriteria criteria ); +} GpsInterface; + +/** Extended interface for raw GPS command support. */ +typedef struct { + /** set to sizeof(ExtraCmdInterface) */ + size_t size; + /** Injects Android extra cmd into the ulp. Clarify if they are blocking calls */ + bool (*inject_raw_cmd)(char* bundle, int bundle_length ); + +} InjectRawCmdInterface; + +/** ULP Network Interface */ +/** Request for network position status */ +#define ULP_NETWORK_POS_STATUS_REQUEST (0x01) +/** Request for periodic network positions */ +#define ULP_NETWORK_POS_START_PERIODIC_REQUEST (0x02) +/** Request last known location */ +#define ULP_NETWORK_POS_GET_LAST_KNOWN_LOCATION_REQUEST (0x03) +/** Cancel request */ +#define ULP_NETWORK_POS_STOP_REQUEST (0x04) + +/** Position was obtained using Wifi Network */ +#define ULP_NETWORK_POSITION_SRC_WIFI (0x01) +/** Position was obtained using Cell Network */ +#define ULP_NETWORK_POSITION_SRC_CELL (0x02) +/** Position was obtained using an Unknown Network */ +#define ULP_NETWORK_POSITION_SRC_UNKNOWN (0x00) + +/** Represents the ULP network request */ +typedef struct { + /** type of request */ + uint16_t request_type; + /** Desired time between network positions/measurements in ms. + * Shall be set to 0 if only one position is requested */ + int interval_ms; + /** network position source to be used */ + uint16_t desired_position_source; +}UlpNetworkRequestPos; + +/** Callback with network position request. */ +typedef void (*ulp_network_location_request)(UlpNetworkRequestPos *req); + +/** ULP Network callback structure. */ +typedef struct { + ulp_network_location_request ulp_network_location_request_cb; +} UlpNetworkLocationCallbacks; + +/** represent a network position */ +typedef struct { + /** source of the position (Wifi, Cell) */ + uint16_t pos_source; + /** latitude in degrees */ + double latitude; + /** longitude in degrees */ + double longitude; + /** Horzizontal error estimate in meters */ + uint16_t HEPE; +} UlpNetworkPosition; + +/** Represents access point information */ +typedef struct { + /** Mac adderess */ + char mac_addr[6]; + /** signal strength in dbM */ + int32_t rssi; + /** Beacon channel for access point */ + uint16_t channel; + + /** Bit 0 = AP is used by WiFi positioning system + * Bit 1 = AP doesn't broadcast SSID Bit 2 = AP has encrption + * turned on Bit 3 = AP is in infrastructure mode and not in + * ad-hoc/unknown mode */ + uint8_t ap_qualifier; +} UlpNetworkAccessPointInfo; + +/** Represents Wifi information */ +typedef struct { + /** Number of APs in the calculated position (-1 means + * unknown) */ + uint8_t num_aps_in_pos; + /** Information of the scanned ap's used in the position estimation*/ + UlpNetworkAccessPointInfo *ap_info; +} UlpNetworkWifiInfo; + + +/** Represent network landscape information */ +typedef struct { + /** network type Cell/Wifi */ + uint8_t network_type; + /** network information */ + union { + UlpNetworkWifiInfo wifi_info; + uint32_t cell_info; + } u; +} UlpNetworkLandscape; + +/** network report valid flags */ +/** fix time is valid */ +#define ULP_NETWORK_POSITION_REPORT_HAS_FIX_TIME (0x01) +/** position is valid */ +#define ULP_NETWORK_POSITION_REPORT_HAS_POSITION (0x02) +/** landscape is valid */ +#define ULP_NETWORK_POSITION_REPORT_HAS_LANDSCAPE (0x04) + +/** Represents the network position report */ +typedef struct +{ + /** validity flags */ + uint16_t valid_flag; + /** time fo network fix */ + GpsUtcTime fix_time; + /** network position */ + UlpNetworkPosition position; + /** network landscape */ + UlpNetworkLandscape landscape_info; +}UlpNetworkPositionReport; + +/** represents ULP network interface extension */ +typedef struct +{ + /** set to sizeof(UlpNetworkInterface) */ + size_t size; + /** initialize network interface */ + int ( *init)(UlpNetworkLocationCallbacks *callback); + /** send network position */ + int ( *ulp_send_network_position)(UlpNetworkPositionReport *position_report); +}UlpNetworkInterface; + +/** Information for the ULP Phone context interface */ + +/** the Location settings context supports only ON_CHANGE + * request type */ +#define ULP_PHONE_CONTEXT_GPS_SETTING (0x01) +#define ULP_PHONE_CONTEXT_NETWORK_POSITION_SETTING (0x02) +#define ULP_PHONE_CONTEXT_WIFI_SETTING (0x04) +/** The battery charging state context supports only + * ON_CHANGE request type */ +#define ULP_PHONE_CONTEXT_BATTERY_CHARGING_STATE (0x08) +#define ULP_PHONE_CONTEXT_AGPS_SETTING (0x010) +#define ULP_PHONE_CONTEXT_ENH_LOCATION_SERVICES_SETTING (0x020) + +/** return phone context only once */ +#define ULP_PHONE_CONTEXT_REQUEST_TYPE_SINGLE (0x01) +/** return phone context periodcially */ +#define ULP_PHONE_CONTEXT_REQUEST_TYPE_PERIODIC (0x02) +/** return phone context when it changes */ +#define ULP_PHONE_CONTEXT_REQUEST_TYPE_ON_CHANGE (0x03) + + +/** Represents ULP phone context request */ +typedef struct { + /** context type requested */ + uint16_t context_type; + /** request type */ + uint16_t request_type; + /** interval in ms if request type is periodic */ + int interval_ms; +}UlpPhoneContextRequest; + +/** Callback for phone context request. */ +typedef void (*ulp_request_phone_context)(UlpPhoneContextRequest *req); + +/** ULP Phone Context callback structure. */ +typedef struct { + ulp_request_phone_context ulp_request_phone_context_cb; +}UlpPhoneContextCallbacks; + +/** Represents the phone context settings */ +typedef struct { + /** Phone context information type */ + uint16_t context_type; + + /** network information */ + /** gps setting */ + bool is_gps_enabled; + /** is network positioning enabled */ + bool is_network_position_available; + /** is wifi turned on */ + bool is_wifi_setting_enabled; + /** is battery being currently charged */ + bool is_battery_charging; + /* is agps enabled for single shot */ + bool is_agps_enabled; + /* is Enhanced Location Services enabled by user*/ + bool is_enh_location_services_enabled; +} UlpPhoneContextSettings; + +/** Represent the phone contxt interface */ +typedef struct +{ + /** set to sizeof(UlpPhoneContextInterface) */ + size_t size; + /** Initialize, register callback */ + int (*init)(UlpPhoneContextCallbacks *callback); + /** send the phone context settings */ + int (*ulp_phone_context_settings_update) (UlpPhoneContextSettings *settings ); +}UlpPhoneContextInterface; + +/** Callback to request the client to download XTRA data. + * The client should download XTRA data and inject it by calling inject_xtra_data(). + * Can only be called from a thread created by create_thread_cb. + */ +typedef void (* gps_xtra_download_request)(); + +/** Callback structure for the XTRA interface. */ +typedef struct { + gps_xtra_download_request download_request_cb; + gps_create_thread create_thread_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; + int ipv4_addr; + char ipv6_addr[16]; + char ssid[SSID_BUF_SIZE]; + char password[SSID_BUF_SIZE]; +} AGpsStatus; + +/** Callback with AGPS status information. + * Can only be called from a thread created by create_thread_cb. + */ +typedef void (* agps_status_callback)(AGpsStatus* status); + +/** Callback structure for the AGPS interface. */ +typedef struct { + agps_status_callback status_cb; + gps_create_thread create_thread_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)( AGpsType agpsType, + const char* apn, AGpsBearerType bearerType ); + /** + * Notifies that the AGPS data connection has been closed. + */ + int (*data_conn_closed)( AGpsType agpsType ); + /** + * Notifies that a data connection is not available for AGPS. + */ + int (*data_conn_failed)(AGpsType agpsType ); + /** + * 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. + * Can only be called from a thread created by create_thread_cb. + */ +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; + gps_create_thread create_thread_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); +}; + +#define AGPS_RIL_REQUEST_SETID_IMSI (1<<0L) +#define AGPS_RIL_REQUEST_SETID_MSISDN (1<<1L) + +#define AGPS_RIL_REQUEST_REFLOC_CELLID (1<<0L) +#define AGPS_RIL_REQUEST_REFLOC_MAC (1<<1L) + +typedef void (*agps_ril_request_set_id)(uint32_t flags); +typedef void (*agps_ril_request_ref_loc)(uint32_t flags); + +typedef struct { + agps_ril_request_set_id request_setid; + agps_ril_request_ref_loc request_refloc; + gps_create_thread create_thread_cb; +} AGpsRilCallbacks; + +/** Extended interface for AGPS_RIL support. */ +typedef struct { + /** set to sizeof(AGpsRilInterface) */ + size_t size; + /** + * Opens the AGPS interface and provides the callback routines + * to the implemenation of this interface. + */ + void (*init)( AGpsRilCallbacks* callbacks ); + + /** + * Sets the reference location. + */ + void (*set_ref_location) (const AGpsRefLocation *agps_reflocation, size_t sz_struct); + /** + * Sets the set ID. + */ + void (*set_set_id) (AGpsSetIDType type, const char* setid); + + /** + * Send network initiated message. + */ + void (*ni_message) (uint8_t *msg, size_t len); + + /** + * Notify GPS of network status changes. + * These parameters match values in the android.net.NetworkInfo class. + */ + void (*update_network_state) (int connected, int type, int roaming, const char* extra_info); + + /** + * Notify GPS of network status changes. + * These parameters match values in the android.net.NetworkInfo class. + */ + void (*update_network_availability) (int avaiable, const char* apn); +} AGpsRilInterface; + +__END_DECLS + +#endif /* ANDROID_INCLUDE_HARDWARE_GPS_H */ + |