Location

---

The Location provides functions for location service.

Required Header

#include <hal-location.h>

Overview

The location HAL provides common abstraction interfaces to control location services and get information about location.

State Transitions

FUNCTION	PRE-STATE	POST-STATE	SYNC TYPE
hal_location_get_backend()	N/A	N/A	SYNC
hal_location_put_backend()	N/A	N/A	SYNC
hal_location_init()	N/A	INITIALIZED	SYNC
hal_location_deinit()	INITIALIZED	N/A	SYNC
hal_location_request()	INITIALIZED	INITIALIZED	SYNC

Typedefs
typedef int(*	gps_event_cb )(gps_event_info_s *gps_event_info, void *user_data)
	Callback function.
typedef struct _hal_backend_location_funcs	hal_backend_location_funcs
	HAL Backend Location Functions.
Defines
#define	HAL_LOCATION_MAX_REQUESTER_ID_LEN   (128)
	Max length of requester ID.
#define	HAL_LOCATION_MAX_CLIENT_NAME_LEN   (128)
	Max length of client name.
#define	HAL_LOCATION_MAX_SUPL_URL_LEN   (128)
	Max length of SUPL URL.
#define	HAL_LOCATION_MAX_GPS_NUM_SAT_USED   (12)
	Maximum number of satellite which is in used.
#define	HAL_LOCATION_MAX_GPS_NUM_SAT_IN_VIEW   (32)
	Maximum number of satellite which is in view.

---

Data Structure Documentation

struct hal_location_pos_data_s

This structure defines the GPS position data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
time_t	timestamp
double	latitude
double	longitude
double	altitude
double	speed
double	bearing
double	hor_accuracy
double	ver_accuracy

---

Field Documentation

double hal_location_pos_data_s::altitude

Altitude data (in meter)

double hal_location_pos_data_s::bearing

Direction from true north(in degree)

double hal_location_pos_data_s::hor_accuracy

Horizontal position error(in meter)

double hal_location_pos_data_s::latitude

Latitude data (in degree)

double hal_location_pos_data_s::longitude

Longitude data (in degree)

double hal_location_pos_data_s::speed

Speed (in m/s)

time_t hal_location_pos_data_s::timestamp

Timestamp

double hal_location_pos_data_s::ver_accuracy

Vertical position error(in meter)

struct hal_location_batch_data_s

This structure defines the GPS batch data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	num_of_location
hal_location_pos_data_s *	data

---

Field Documentation

hal_location_pos_data_s* hal_location_batch_data_s::data

Batch data

int hal_location_batch_data_s::num_of_location

Number of batch data

struct hal_location_sv_info_s

This structure defines the satellite data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	prn
int	snr
int	elevation
int	azimuth
int	used

---

Field Documentation

int hal_location_sv_info_s::azimuth

Degrees from true north

int hal_location_sv_info_s::elevation

Elevation

int hal_location_sv_info_s::prn

Pseudo Random Noise code of satellite

int hal_location_sv_info_s::snr

Signal to Noise Ratio

int hal_location_sv_info_s::used

Satellite was used for position fix

struct hal_location_sv_data_s

This structure defines the GPS satellite in view data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
time_t	timestamp
unsigned char	pos_valid
int	num_of_sat
hal_location_sv_info_s	sat [(32)]

---

Field Documentation

int hal_location_sv_data_s::num_of_sat

Number of satellites in view

unsigned char hal_location_sv_data_s::pos_valid

TRUE, if position is valid

hal_location_sv_info_s hal_location_sv_data_s::sat[(32)]

Satellite information

time_t hal_location_sv_data_s::timestamp

Timestamp

struct hal_location_nmea_data_s

This structure defines the NMEA data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
time_t	timestamp
int	len
char *	data

---

Field Documentation

char* hal_location_nmea_data_s::data

Raw NMEA data

int hal_location_nmea_data_s::len

NMEA data length

time_t hal_location_nmea_data_s::timestamp

Timestamp

struct hal_location_geofence_data_s

This structure defines the geofence data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	geofence_id
double	latitude
double	longitude
int	radius

---

Field Documentation

int hal_location_geofence_data_s::geofence_id

Geofence ID

double hal_location_geofence_data_s::latitude

Latitude data (in degree)

double hal_location_geofence_data_s::longitude

Longitude data (in degree)

int hal_location_geofence_data_s::radius

Radius data (in meters)

struct hal_location_mobile_info_s

This structure defines the mobile information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
char	imsi [16]
int	mcc
int	mnc
int	lac
int	psc
int	cid

---

Field Documentation

int hal_location_mobile_info_s::cid

Cell id

char hal_location_mobile_info_s::imsi[16]

IMSI

int hal_location_mobile_info_s::lac

Location area code

int hal_location_mobile_info_s::mcc

MCC

int hal_location_mobile_info_s::mnc

MNC

int hal_location_mobile_info_s::psc

Primary Srambling code

struct hal_location_gps_qos_param_s

This structure is used to get the Extra Fix request parameters.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	accuracy
int	tbf
int	num_fixes
unsigned char	timeout

---

Field Documentation

int hal_location_gps_qos_param_s::accuracy

accuracy

int hal_location_gps_qos_param_s::num_fixes

num fixes

int hal_location_gps_qos_param_s::tbf

time between fixes

unsigned char hal_location_gps_qos_param_s::timeout

session timeout

struct hal_location_gps_start_session_ev_info_s

Start session response event data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error

---

Field Documentation

hal_location_gps_error_e hal_location_gps_start_session_ev_info_s::error

Error code

struct hal_location_gps_stop_session_ev_info_s

Response of stop session.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error

---

Field Documentation

hal_location_gps_error_e hal_location_gps_stop_session_ev_info_s::error

Error code

struct hal_location_gps_set_option_ev_info_s

Set option response event data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error

---

Field Documentation

hal_location_gps_error_e hal_location_gps_set_option_ev_info_s::error

Error code

struct hal_location_gps_change_interval_ev_info_s

Change interval response event data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error

---

Field Documentation

hal_location_gps_error_e hal_location_gps_change_interval_ev_info_s::error

Error code

struct hal_location_gps_pos_ev_info_s

Position data from GPS.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error
hal_location_pos_data_s	pos

---

Field Documentation

hal_location_gps_error_e hal_location_gps_pos_ev_info_s::error

Error code

hal_location_pos_data_s hal_location_gps_pos_ev_info_s::pos

Position data

struct hal_location_gps_batch_ev_info_s

Batch data from GPS.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error
hal_location_batch_data_s	batch

---

Field Documentation

hal_location_batch_data_s hal_location_gps_batch_ev_info_s::batch

Batch data

hal_location_gps_error_e hal_location_gps_batch_ev_info_s::error

Error code

struct hal_location_gps_sv_ev_info_s

Satellite data from GPS.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error
hal_location_sv_data_s	sv

---

Field Documentation

hal_location_gps_error_e hal_location_gps_sv_ev_info_s::error

Error code

hal_location_sv_data_s hal_location_gps_sv_ev_info_s::sv

Satellite data

struct hal_location_gps_nmea_ev_info_s

NMEA data from GPS.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error
hal_location_nmea_data_s	nmea

---

Field Documentation

hal_location_gps_error_e hal_location_gps_nmea_ev_info_s::error

Error code

hal_location_nmea_data_s hal_location_gps_nmea_ev_info_s::nmea

NMEA data

struct hal_location_agps_verification_ev_info_s

This structure defines the values for GPS Verification message indication.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_agps_notify_e	notify_type
hal_location_agps_supl_format_e	supl_format
hal_location_agps_encoding_scheme_e	datacoding_scheme
char	requester_id [(128)]
char	client_name [(128)]
int	resp_timer

---

Field Documentation

char hal_location_agps_verification_ev_info_s::client_name[(128)]

Specifies client name

hal_location_agps_encoding_scheme_e hal_location_agps_verification_ev_info_s::datacoding_scheme

Specifies requester type

hal_location_agps_notify_e hal_location_agps_verification_ev_info_s::notify_type

Specifies notification type refer enum tapi_gps_notify_type_t

char hal_location_agps_verification_ev_info_s::requester_id[(128)]

Specifies requester ID

int hal_location_agps_verification_ev_info_s::resp_timer

Response timer

hal_location_agps_supl_format_e hal_location_agps_verification_ev_info_s::supl_format

Specifies encoding type refer enum tapi_gps_encoding_type_t

struct hal_location_gps_factory_test_ev_info_s

Factory test result information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error
int	prn
double	snr

---

Field Documentation

hal_location_gps_error_e hal_location_gps_factory_test_ev_info_s::error

Error code

int hal_location_gps_factory_test_ev_info_s::prn

Specifies Pseudo Random Noise value

double hal_location_gps_factory_test_ev_info_s::snr

Specifies Signal to Noise Ratio value

struct hal_location_gps_dns_query_ev_info_s

DNS query request information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_error_e	error
char	domain_name [(128)]

---

Field Documentation

char hal_location_gps_dns_query_ev_info_s::domain_name[(128)]

Domain name

hal_location_gps_error_e hal_location_gps_dns_query_ev_info_s::error

Error code

struct hal_location_geofence_transition_ev_info_s

Geofence transition information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
time_t	geofence_timestamp
int	geofence_id
hal_location_pos_data_s	pos
hal_location_geofence_zone_state_e	state

---

Field Documentation

int hal_location_geofence_transition_ev_info_s::geofence_id

Geofence ID

time_t hal_location_geofence_transition_ev_info_s::geofence_timestamp

Timestamp

hal_location_pos_data_s hal_location_geofence_transition_ev_info_s::pos

Position data

hal_location_geofence_zone_state_e hal_location_geofence_transition_ev_info_s::state

Geofence zone state

struct hal_location_geofence_status_ev_info_s

Geofecne status information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_geofence_status_e	status
hal_location_pos_data_s	last_pos

---

Field Documentation

hal_location_pos_data_s hal_location_geofence_status_ev_info_s::last_pos

Last position

hal_location_geofence_status_e hal_location_geofence_status_ev_info_s::status

Geofence status

struct hal_location_geofence_event_s

Geofence event information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	geofence_id
hal_location_geofence_error_e	error

---

Field Documentation

hal_location_geofence_error_e hal_location_geofence_event_s::error

Geofence error

int hal_location_geofence_event_s::geofence_id

Geofence ID

struct xtra_request_info_s

XTRA request information. Used by Wearable profile only.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
xtra_request_type_e	xtra_id
hal_location_xtra_request_error_e	error

---

Field Documentation

hal_location_xtra_request_error_e xtra_request_info_s::error

Error code

xtra_request_type_e xtra_request_info_s::xtra_id

XTRA request type

struct ref_data_request_info_s

Reference data request information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
time_t	timeout

---

Field Documentation

time_t ref_data_request_info_s::timeout

Timeout

union gps_event_data_u

GPS event info.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_start_session_ev_info_s	start_session_rsp
hal_location_gps_stop_session_ev_info_s	stop_session_rsp
hal_location_gps_set_option_ev_info_s	set_option_rsp
hal_location_gps_change_interval_ev_info_s	change_interval_rsp
hal_location_gps_pos_ev_info_s	pos_ind
hal_location_gps_sv_ev_info_s	sv_ind
hal_location_gps_nmea_ev_info_s	nmea_ind
hal_location_gps_batch_ev_info_s	batch_ind
hal_location_agps_verification_ev_info_s	agps_verification_ind
hal_location_gps_factory_test_ev_info_s	factory_test_rsp
hal_location_gps_dns_query_ev_info_s	dns_query_ind
hal_location_geofence_transition_ev_info_s	geofence_transition_ind
hal_location_geofence_status_ev_info_s	geofence_status_ind
hal_location_geofence_event_s	geofence_event_rsp
xtra_request_info_s	xtra_request_ind
ref_data_request_info_s	ref_data_req_ind

---

Field Documentation

hal_location_agps_verification_ev_info_s gps_event_data_u::agps_verification_ind

Verification indication

hal_location_gps_batch_ev_info_s gps_event_data_u::batch_ind

Batch indication

hal_location_gps_change_interval_ev_info_s gps_event_data_u::change_interval_rsp

Change interval response

hal_location_gps_dns_query_ev_info_s gps_event_data_u::dns_query_ind

DNS query indication

hal_location_gps_factory_test_ev_info_s gps_event_data_u::factory_test_rsp

Factory test response

hal_location_geofence_event_s gps_event_data_u::geofence_event_rsp

Geofence event response

hal_location_geofence_status_ev_info_s gps_event_data_u::geofence_status_ind

Geofence status indication

hal_location_geofence_transition_ev_info_s gps_event_data_u::geofence_transition_ind

Callback related with Geofence. Geofence transition indication

hal_location_gps_nmea_ev_info_s gps_event_data_u::nmea_ind

NMEA indication

hal_location_gps_pos_ev_info_s gps_event_data_u::pos_ind

Callback related with Indication Position indication

ref_data_request_info_s gps_event_data_u::ref_data_req_ind

Reference data request indication

hal_location_gps_set_option_ev_info_s gps_event_data_u::set_option_rsp

Set option response

hal_location_gps_start_session_ev_info_s gps_event_data_u::start_session_rsp

Callback related with Response Start session response

hal_location_gps_stop_session_ev_info_s gps_event_data_u::stop_session_rsp

Stop session response

hal_location_gps_sv_ev_info_s gps_event_data_u::sv_ind

Satellite indication

xtra_request_info_s gps_event_data_u::xtra_request_ind

Callback related with XTRA. Used by Wearable profile only. XTRA request indication

struct gps_event_info_s

GPS Event Info.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_gps_event_id_e	event_id
gps_event_data_u	event_data

---

Field Documentation

gps_event_data_u gps_event_info_s::event_data

GPS event information data

hal_location_gps_event_id_e gps_event_info_s::event_id

GPS asynchronous event id

struct hal_location_agps_supl_ni_info_s

SUPL network-initiated information.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
char *	msg_body
int	msg_size
int	status

---

Field Documentation

char* hal_location_agps_supl_ni_info_s::msg_body

SUPL NI message body

int hal_location_agps_supl_ni_info_s::msg_size

SUPL NI message size

int hal_location_agps_supl_ni_info_s::status

Return code of Status

struct hal_location_agps_supl_ni_nomodem_info_s

SUPL network-initiated information in case of no-modem.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
char *	msg_body
int	msg_size
char	imsi [16]
int	mcc
int	mnc
int	lac
int	psc
int	cid
int	status

---

Field Documentation

int hal_location_agps_supl_ni_nomodem_info_s::cid

Cell id

char hal_location_agps_supl_ni_nomodem_info_s::imsi[16]

IMSI

int hal_location_agps_supl_ni_nomodem_info_s::lac

Location area code

int hal_location_agps_supl_ni_nomodem_info_s::mcc

MCC

int hal_location_agps_supl_ni_nomodem_info_s::mnc

MNC

char* hal_location_agps_supl_ni_nomodem_info_s::msg_body

SUPL NI message body

int hal_location_agps_supl_ni_nomodem_info_s::msg_size

SUPL NI message size

int hal_location_agps_supl_ni_nomodem_info_s::psc

Primary Srambling code

int hal_location_agps_supl_ni_nomodem_info_s::status

Return code of Status

struct hal_location_geofence_action_data_s

Geofence action data type.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
hal_location_geofence_data_s	geofence
hal_location_geofence_zone_state_e	last_state
int	monitor_states
int	notification_responsiveness_ms
int	unknown_timer_ms

---

Field Documentation

hal_location_geofence_data_s hal_location_geofence_action_data_s::geofence

Geofence data

hal_location_geofence_zone_state_e hal_location_geofence_action_data_s::last_state

Last state

int hal_location_geofence_action_data_s::monitor_states

Monitor states

int hal_location_geofence_action_data_s::notification_responsiveness_ms

Notification responsiveness in milliseconds

int hal_location_geofence_action_data_s::unknown_timer_ms

Unknown timer in milliseconds

struct hal_location_gps_action_start_data_s

GPS action start data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	interval
int	period
int	session_status

---

Field Documentation

int hal_location_gps_action_start_data_s::interval

Interval

int hal_location_gps_action_start_data_s::period

Emulator

int hal_location_gps_action_start_data_s::session_status

Emulator

struct hal_location_gps_action_change_interval_data_s

GPS action change interval data.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	interval

---

Field Documentation

int hal_location_gps_action_change_interval_data_s::interval

Interval

struct hal_location_gps_action_set_ref_location_s

GPS action to set ref location.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	result
int	reason
time_t	timestamp
double	latitude
double	longitude
double	accuracy

---

Field Documentation

double hal_location_gps_action_set_ref_location_s::accuracy

Horizontal position error(in meter)

double hal_location_gps_action_set_ref_location_s::latitude

Latitude data (in degree)

double hal_location_gps_action_set_ref_location_s::longitude

Longitude data (in degree)

int hal_location_gps_action_set_ref_location_s::reason

Reason

int hal_location_gps_action_set_ref_location_s::result

Result

time_t hal_location_gps_action_set_ref_location_s::timestamp

Timestamp

struct hal_location_gps_action_set_ref_time_s

GPS action to set ref time.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int	result
int	reason
int	method
int64_t	ntp_timestamp
int64_t	elapsed_systime
int	uncertainty

---

Field Documentation

int64_t hal_location_gps_action_set_ref_time_s::elapsed_systime

Milliseconds since boot, including time spent in sleep

int hal_location_gps_action_set_ref_time_s::method

Method

int64_t hal_location_gps_action_set_ref_time_s::ntp_timestamp

Timestamp from NTP

int hal_location_gps_action_set_ref_time_s::reason

Reason

int hal_location_gps_action_set_ref_time_s::result

Result

int hal_location_gps_action_set_ref_time_s::uncertainty

Half of round trip time in milliseconds

struct _hal_backend_location_funcs

HAL Backend Location Functions.

Since:

HAL_MODULE_LOCATION 1.0

Data Fields
int(*	init )(gps_event_cb gps_event_cb, void *user_data)
int(*	deinit )(gps_failure_reason_e *reason_code)
int(*	request )(hal_location_gps_action_e gps_action, void *gps_action_data, gps_failure_reason_e *reason_code)

---

Field Documentation

int(* _hal_backend_location_funcs::deinit)(gps_failure_reason_e *reason_code)

Deinitialize GPS

int(* _hal_backend_location_funcs::init)(gps_event_cb gps_event_cb, void *user_data)

Initialize GPS

int(* _hal_backend_location_funcs::request)(hal_location_gps_action_e gps_action, void *gps_action_data, gps_failure_reason_e *reason_code)

Request GPS action

---

Define Documentation

#define HAL_LOCATION_MAX_CLIENT_NAME_LEN   (128)

Max length of client name.

Since:

HAL_MODULE_LOCATION 1.0

#define HAL_LOCATION_MAX_GPS_NUM_SAT_IN_VIEW   (32)

Maximum number of satellite which is in view.

Since:

HAL_MODULE_LOCATION 1.0

#define HAL_LOCATION_MAX_GPS_NUM_SAT_USED   (12)

Maximum number of satellite which is in used.

Since:

HAL_MODULE_LOCATION 1.0

#define HAL_LOCATION_MAX_REQUESTER_ID_LEN   (128)

Max length of requester ID.

Since:

HAL_MODULE_LOCATION 1.0

#define HAL_LOCATION_MAX_SUPL_URL_LEN   (128)

Max length of SUPL URL.

Since:

HAL_MODULE_LOCATION 1.0

---

Typedef Documentation

typedef int(* gps_event_cb)(gps_event_info_s *gps_event_info, void *user_data)

Callback function.

Remarks:

LBS server needs to register a callback function with GPS OEM to receive asynchronous events.

Since:

HAL_MODULE_LOCATION 1.0

typedef struct _hal_backend_location_funcs hal_backend_location_funcs

HAL Backend Location Functions.

Since:

HAL_MODULE_LOCATION 1.0

---

Enumeration Type Documentation

enum gps_failure_reason_e

Transport Error Cause.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_FAILURE_CAUSE_NORMAL	Normal cause
HAL_LOCATION_GPS_FAILURE_CAUSE_FACTORY_TEST	Factory test cause
HAL_LOCATION_GPS_FAILURE_CAUSE_DNS_QUERY	DNS query cause
HAL_LOCATION_GPS_FAILURE_CAUSE_LBS_SERVER_FINISH	LBS server finish cause

enum hal_location_agps_cell_info_e

Cell information type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_CELL_INFO_TYPE_aRFCNPresent	aRFCN present
HAL_LOCATION_GPS_CELL_INFO_TYPE_bSICPresent	bSIC present
HAL_LOCATION_GPS_CELL_INFO_TYPE_rxLevPresent	rxLev present
HAL_LOCATION_GPS_CELL_INFO_TYPE_frequencyInfoPresent	frequencyInfo present
HAL_LOCATION_GPS_CELL_INFO_TYPE_cellMeasuredResultPresent	cellMeasuredResult present
HAL_LOCATION_GPS_CELL_INFO_TYPE_refMCC	refMCC
HAL_LOCATION_GPS_CELL_INFO_TYPE_refMNC	refMNC
HAL_LOCATION_GPS_CELL_INFO_TYPE_refLAC	refLAC
HAL_LOCATION_GPS_CELL_INFO_TYPE_refCI	refCI
HAL_LOCATION_GPS_CELL_INFO_TYPE_refUC	refUC
HAL_LOCATION_GPS_CELL_INFO_TYPE_aRFCN	aRFCN
HAL_LOCATION_GPS_CELL_INFO_TYPE_bSIC	bSIC
HAL_LOCATION_GPS_CELL_INFO_TYPE_rxLev	rxLev

enum hal_location_agps_encoding_scheme_e

This enumeration defines values for GPS encoding type for GPS verification message.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_ENCODE_ISO646IRV	Specifies ISO646IRV encoding
HAL_LOCATION_AGPS_ENCODE_ISO8859	Specifies ISO8859 encoding
HAL_LOCATION_AGPS_ENCODE_UTF8	Specifies UTF8 encoding
HAL_LOCATION_AGPS_ENCODE_UTF16	Specifies UTF16 encoding
HAL_LOCATION_AGPS_ENCODE_UCS2	Specifies UCS2 encoding
HAL_LOCATION_AGPS_ENCODE_GSMDEFAULT	Specifies GSM default encoding
HAL_LOCATION_AGPS_ENCODE_SHIFT_JIS	Specifies Shift JIS encoding
HAL_LOCATION_AGPS_ENCODE_JIS	Specifies JIS encoding
HAL_LOCATION_AGPS_ENCODE_EUC	Specifies EUC encoding
HAL_LOCATION_AGPS_ENCODE_GB2312	Specifies GB2312 encoding
HAL_LOCATION_AGPS_ENCODE_CNS11643	Specifies CNS11643 encoding
HAL_LOCATION_AGPS_ENCODE_KSC1001	Specifies KSC1001 encoding
HAL_LOCATION_AGPS_ENCODE_GERMAN	Specifies German encoding
HAL_LOCATION_AGPS_ENCODE_ENGLISH	Specifies English encoding
HAL_LOCATION_AGPS_ENCODE_ITALIAN	Specifies Italian encoding
HAL_LOCATION_AGPS_ENCODE_FRENCH	Specifies French encoding
HAL_LOCATION_AGPS_ENCODE_SPANISH	Specifies Spanish encoding
HAL_LOCATION_AGPS_ENCODE_DUTCH	Specifies Dutch encoding
HAL_LOCATION_AGPS_ENCODE_SWEDISH	Specifies Swedish encoding
HAL_LOCATION_AGPS_ENCODE_DANISH	Specifies Danish encoding
HAL_LOCATION_AGPS_ENCODE_PORTUGUESE	Specifies Portuguese encoding
HAL_LOCATION_AGPS_ENCODE_FINNISH	Specifies Finish encoding
HAL_LOCATION_AGPS_ENCODE_NORWEGIAN	Specifies Norwegian encoding
HAL_LOCATION_AGPS_ENCODE_GREEK	Specifies Greek encoding
HAL_LOCATION_AGPS_ENCODE_TURKISH	Specifies Turkish encoding
HAL_LOCATION_AGPS_ENCODE_HUNGARIAN	Specifies Hungarian encoding
HAL_LOCATION_AGPS_ENCODE_POLISH	Specifies Polish encoding
HAL_LOCATION_AGPS_ENCODE_LANGUAGE_UNSPEC	Unspecified language

enum hal_location_agps_notify_e

This enumeration defines values for notify type for GPS verification message.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_NOTIFY_NO_VERIFY	No verification needed
HAL_LOCATION_AGPS_NOTIFY_ONLY	Notification only
HAL_LOCATION_AGPS_NOTIFY_ALLOW_NORESPONSE	Allow without response
HAL_LOCATION_AGPS_NOTIFY_NOTALLOW_NORESPONSE	Not allow without response
HAL_LOCATION_AGPS_NOTIFY_PRIVACY_NEEDED	Privacy needed
HAL_LOCATION_AGPS_NOTIFY_PRIVACY_OVERRIDE	Privacy override

enum hal_location_agps_requester_id_encoding_e

This enumeration defines values for GPS encoding type for GPS verification message.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_ID_ENCODE_ISO646IRV	Specifies ISO646IRV encoding
HAL_LOCATION_AGPS_ID_ENCODE_EXN_PROTOCOL_MSG	Specifies EXN protocol message encoding
HAL_LOCATION_AGPS_ID_ENCODE_ASCII	Specifies ASCII encoding
HAL_LOCATION_AGPS_ID_ENCODE_IA5	Specifies IA5 encoding
HAL_LOCATION_AGPS_ID_ENCODE_UNICODE	Specifies Unicode encoding
HAL_LOCATION_AGPS_ID_ENCODE_SHIFT_JIS	Specifies Shift JIS encoding
HAL_LOCATION_AGPS_ID_ENCODE_KOREAN	Specifies Korean encoding
HAL_LOCATION_AGPS_ID_ENCODE_LATIN_HEBREW	Specifies Latin Hebrew encoding
HAL_LOCATION_AGPS_ID_ENCODE_LATIN	Specifies Latin encoding
HAL_LOCATION_AGPS_ID_ENCODE_GSM	Specifies GSM encoding

enum hal_location_agps_ssl_cert_type_e

This enumeration has the SSL certification type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_CERT_VERISIGN	Specifies Verisign certificate.
HAL_LOCATION_AGPS_CERT_THAWTE	Specifies Thawte certificate.
HAL_LOCATION_AGPS_CERT_CMCC	Specifies CMCC certificate.
HAL_LOCATION_AGPS_CERT_SPIRENT_TEST	Specifies Spirent Test certificate.
HAL_LOCATION_AGPS_CERT_THALES_TEST	Specifies Thales Test certificate.
HAL_LOCATION_AGPS_CERT_CMCC_TEST	Specifies CMCC Test certificate.
HAL_LOCATION_AGPS_CERT_BMC_TEST	Specifies BMC Test certificate.
HAL_LOCATION_AGPS_CERT_GOOGLE	Specifies Google certificate.

enum hal_location_agps_ssl_mode_e

This enumeration has the SSL mode.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_SSL_DISABLE	SSL disable
HAL_LOCATION_AGPS_SSL_ENABLE	SSL enable

enum hal_location_agps_supl_format_e

This enumeration defines values for requester type for GPS verification message.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_REQ_LOGICAL_NAME	Specifies logical name.
HAL_LOCATION_AGPS_REQ_EMAIL_ADDR	Specifies e-mail address
HAL_LOCATION_AGPS_REQ_MSISDN	Specifies MSISDN number
HAL_LOCATION_AGPS_REQ_URL	Specifies URL
HAL_LOCATION_AGPS_REQ_SIPURL	Specifies SIPURL
HAL_LOCATION_AGPS_REQ_MIN	Specifies MIN
HAL_LOCATION_AGPS_REQ_MDN	Specifies MDN
HAL_LOCATION_AGPS_REQ_UNKNOWN	Unknown request

enum hal_location_agps_svc_type_e

Mobile service type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_SVCTYPE_NONE	Unknown network
HAL_LOCATION_SVCTYPE_NOSVC	Network in no service
HAL_LOCATION_SVCTYPE_EMERGENCY	Network emergency
HAL_LOCATION_SVCTYPE_SEARCH	Network search 1900
HAL_LOCATION_SVCTYPE_2G	Network 2G
HAL_LOCATION_SVCTYPE_2_5G	Network 2.5G
HAL_LOCATION_SVCTYPE_2_5G_EDGE	Network EDGE
HAL_LOCATION_SVCTYPE_3G	Network UMTS
HAL_LOCATION_SVCTYPE_HSDPA	Network HSDPA

enum hal_location_agps_verification_cnf_type_e

This enumeration has the verification confirm type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_AGPS_VER_CNF_YES	Specifies Confirmation yes.
HAL_LOCATION_AGPS_VER_CNF_NO	Specifies Confirmation no.
HAL_LOCATION_AGPS_VER_CNF_NORESPONSE	Specifies Confirmation no response.

enum hal_location_geofence_error_e

This enumeration has geofence service error type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GEOFENCE_ERR_NONE	No error
HAL_LOCATION_GEOFENCE_ERR_TOO_MANY_GEOFENCE	Too many geofences
HAL_LOCATION_GEOFENCE_ERR_ID_EXISTS	Geofence ID already exists
HAL_LOCATION_GEOFENCE_ERR_ID_UNKNOWN	Geofence ID does not exist
HAL_LOCATION_GEOFENCE_ERR_INVALID_TRANSITION	Invalid transition
HAL_LOCATION_GEOFENCE_ERR_UNKNOWN	Unknown error

enum hal_location_geofence_status_e

This enumeration has geofence service status.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GEOFENCE_STATUS_UNAVAILABLE	Geofence status is unavailable
HAL_LOCATION_GEOFENCE_STATUS_AVAILABLE	Geofence status is available

enum hal_location_geofence_zone_state_e

This enumeration has the zone in/out type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GEOFENCE_ZONE_OUT	Geofence zone out
HAL_LOCATION_GEOFENCE_ZONE_IN	Geofence zone in
HAL_LOCATION_GEOFENCE_ZONE_UNCERTAIN	Geofence zone uncertain

enum hal_location_gps_action_e

GPS action type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_ACTION_SEND_PARAMS	Send parameter
HAL_LOCATION_GPS_ACTION_START_SESSION	Start session
HAL_LOCATION_GPS_ACTION_STOP_SESSION	Stop session
HAL_LOCATION_GPS_ACTION_CHANGE_INTERVAL	Change interval
HAL_LOCATION_GPS_INDI_SUPL_VERIFICATION	SUPL verification
HAL_LOCATION_GPS_INDI_SUPL_DNSQUERY	DNS query
HAL_LOCATION_GPS_ACTION_START_FACTTEST	Start Factory test
HAL_LOCATION_GPS_ACTION_STOP_FACTTEST	Stop Factory test
HAL_LOCATION_GPS_ACTION_REQUEST_SUPL_NI	Request SUPL NI
HAL_LOCATION_GPS_ACTION_REQUEST_SUPL_NI_NOMODEM	Request SUPL NI in case of no modem
HAL_LOCATION_GPS_ACTION_DELETE_GPS_DATA	Delete GPS data
HAL_LOCATION_GPS_ACTION_ADD_GEOFENCE	Add geofence
HAL_LOCATION_GPS_ACTION_DELETE_GEOFENCE	Delete geofence
HAL_LOCATION_GPS_ACTION_PAUSE_GEOFENCE	Pause geofence
HAL_LOCATION_GPS_ACTION_RESUME_GEOFENCE	Resume geofence
HAL_LOCATION_GPS_ACTION_CONSUMER_CONNECTED	Download XTRA
HAL_LOCATION_GPS_ACTION_CONSUMER_DISCONNECTED	Consumer connected
HAL_LOCATION_GPS_ACTION_CHANGE_INTERVAL_SPORTMODE	Consumer disconnected Change interval for sport mode
HAL_LOCATION_GPS_ACTION_SET_REF_TIME	Set reference location
HAL_LOCATION_GPS_ACTION_START_BATCH	Set reference time Start batch
HAL_LOCATION_GPS_ACTION_STOP_BATCH	Stop batch
HAL_LOCATION_GPS_ACTION_ADD_REDUCE_SET	Add reduce set
HAL_LOCATION_GPS_ACTION_REMOVE_REDUCE_SET	Remove reduce set

enum hal_location_gps_error_e

This enumeration has error type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_ERR_NONE	Error None
HAL_LOCATION_GPS_ERR_TIMEOUT	pos_cb error GPS Timeout
HAL_LOCATION_GPS_ERR_OUT_OF_SERVICE	pos_cb error GPS out of service
HAL_LOCATION_GPS_ERR_COMMUNICATION	Plugin event callback error

enum hal_location_gps_event_id_e

GPS asynchronous event type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_EVENT_START_SESSION	The session is started
HAL_LOCATION_GPS_EVENT_STOP_SESSION	The session is stopped
HAL_LOCATION_GPS_EVENT_CHANGE_INTERVAL	Change updating interval
HAL_LOCATION_GPS_EVENT_REPORT_POSITION	Bring up GPS position data
HAL_LOCATION_GPS_EVENT_REPORT_SATELLITE	Bring up GPS SV data
HAL_LOCATION_GPS_EVENT_REPORT_NMEA	Bring up GPS NMEA data
HAL_LOCATION_GPS_EVENT_REPORT_BATCH	Bring up GPS batch data
HAL_LOCATION_GPS_EVENT_SET_OPTION	The option is set
HAL_LOCATION_GPS_EVENT_GET_REF_LOCATION	Get the reference location for AGPS
HAL_LOCATION_GPS_EVENT_GET_IMSI	Get IMSI for identification
HAL_LOCATION_GPS_EVENT_GET_REF_TIME	Get the reference time for AGPS
HAL_LOCATION_GPS_EVENT_OPEN_DATA_CONNECTION	Request opening data network connection
HAL_LOCATION_GPS_EVENT_CLOSE_DATA_CONNECTION	Request closing data network connection
HAL_LOCATION_GPS_EVENT_DNS_LOOKUP_IND	Request resolving host name
HAL_LOCATION_GPS_EVENT_AGPS_VERIFICATION_INDI	Verification indicator for AGPS is required
HAL_LOCATION_GPS_EVENT_FACTORY_TEST	Factory test is done
HAL_LOCATION_GPS_EVENT_GEOFENCE_TRANSITION	Geofence transition is occurred
HAL_LOCATION_GPS_EVENT_GEOFENCE_STATUS	Report geofence service status
HAL_LOCATION_GPS_EVENT_ADD_GEOFENCE	Geofence is added(Start geofence)
HAL_LOCATION_GPS_EVENT_DELETE_GEOFENCE	Geofence is deleted(Stop geofence)
HAL_LOCATION_GPS_EVENT_PAUSE_GEOFENCE	Geofence is paused
HAL_LOCATION_GPS_EVENT_RESUME_GEOFENCE	Geofence is resumed
HAL_LOCATION_GPS_EVENT_REQUEST_XTRA	XTRA is requested. Used by Wearable profile only.
HAL_LOCATION_GPS_EVENT_ERR_CAUSE	Some error is occurred

enum hal_location_gps_operation_e

This enumeration has GPS operation mode.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_OPERATION_STANDALONE	GPS standalone (no assistance)
HAL_LOCATION_GPS_OPERATION_MS_BASED	MS-Based AGPS
HAL_LOCATION_GPS_OPERATION_MS_ASSISTED	MS-Assisted AGPS

enum hal_location_gps_session_e

This enumeration has GPS session type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_SESSION_SINGLE_FIX	Single fix starting
HAL_LOCATION_GPS_SESSION_TRACKING_MODE	Tracking mode starting

enum hal_location_gps_starting_e

This enumeration has GPS starting type.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_GPS_STARTING_HOT_	Hot start
HAL_LOCATION_GPS_STARTING_COLD	Cold start
HAL_LOCATION_GPS_STARTING_NONE	None

enum hal_location_xtra_request_error_e

This enumeration has XTRA request error type (wearable profile use only).

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_XTRA_REQUEST_ERR_NONE	No error
HAL_LOCATION_XTRA_REQUEST_ERR_UNKNOWN	Unknown error

enum xtra_request_type_e

Type of XTRA request. Used by Wearable profile only.

Since:

HAL_MODULE_LOCATION 1.0

Enumerator:

HAL_LOCATION_XTRA_REQUEST_TYPE_NONE	Default value
HAL_LOCATION_XTRA_REQUEST_TYPE_QCOM	Request type QCOM
HAL_LOCATION_XTRA_REQUEST_TYPE_BRCM	Request type BRCM