f6b613a827
1. LocApiBase to create its own MsgTask thread to allow QMI calls to be made asynchronously. It shall no longer share the adapter's thread. 2. Implementation of new LocApiResponse classes for generic response type from LocApi layer to Adapter layers 3. GnssAdapter modified to handle the asynchronous nature of LocApi calls. CRs-Fixed: 2218658 Change-Id: I6e401a89f16791ec144763ac5f070b7ee1dad931
270 lines
10 KiB
C++
270 lines
10 KiB
C++
/* Copyright (c) 2011-2014, 2016-2017 The Linux Foundation. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are
|
|
* met:
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above
|
|
* copyright notice, this list of conditions and the following
|
|
* disclaimer in the documentation and/or other materials provided
|
|
* with the distribution.
|
|
* * Neither the name of The Linux Foundation, nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
|
|
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
|
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
|
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
|
* IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
#ifndef LOC_API_BASE_H
|
|
#define LOC_API_BASE_H
|
|
|
|
#include <stddef.h>
|
|
#include <ctype.h>
|
|
#include <gps_extended.h>
|
|
#include <LocationAPI.h>
|
|
#include <MsgTask.h>
|
|
#include <log_util.h>
|
|
|
|
namespace loc_core {
|
|
|
|
class ContextBase;
|
|
struct LocApiResponse;
|
|
|
|
int hexcode(char *hexstring, int string_size,
|
|
const char *data, int data_size);
|
|
int decodeAddress(char *addr_string, int string_size,
|
|
const char *data, int data_size);
|
|
|
|
#define MAX_ADAPTERS 10
|
|
#define MAX_FEATURE_LENGTH 100
|
|
|
|
#define TO_ALL_ADAPTERS(adapters, call) \
|
|
for (int i = 0; i < MAX_ADAPTERS && NULL != (adapters)[i]; i++) { \
|
|
call; \
|
|
}
|
|
|
|
#define TO_1ST_HANDLING_ADAPTER(adapters, call) \
|
|
for (int i = 0; i <MAX_ADAPTERS && NULL != (adapters)[i] && !(call); i++);
|
|
|
|
enum xtra_version_check {
|
|
DISABLED,
|
|
AUTO,
|
|
XTRA2,
|
|
XTRA3
|
|
};
|
|
|
|
class LocAdapterBase;
|
|
struct LocSsrMsg;
|
|
struct LocOpenMsg;
|
|
|
|
typedef struct
|
|
{
|
|
uint32_t accumulatedDistance;
|
|
uint32_t numOfBatchedPositions;
|
|
} LocApiBatchData;
|
|
|
|
typedef struct
|
|
{
|
|
uint32_t hwId;
|
|
} LocApiGeofenceData;
|
|
|
|
struct LocApiMsg: LocMsg {
|
|
private:
|
|
std::function<void ()> mProcImpl;
|
|
inline virtual void proc() const {
|
|
mProcImpl();
|
|
}
|
|
public:
|
|
inline LocApiMsg(std::function<void ()> procImpl ) :
|
|
mProcImpl(procImpl) {}
|
|
};
|
|
|
|
class LocApiProxyBase {
|
|
public:
|
|
inline LocApiProxyBase() {}
|
|
inline virtual ~LocApiProxyBase() {}
|
|
inline virtual void* getSibling2() { return NULL; }
|
|
};
|
|
|
|
class LocApiBase {
|
|
friend struct LocSsrMsg;
|
|
//LocOpenMsg calls open() which makes it necessary to declare
|
|
//it as a friend
|
|
friend struct LocOpenMsg;
|
|
friend struct LocCloseMsg;
|
|
friend class ContextBase;
|
|
static MsgTask* mMsgTask;
|
|
LocAdapterBase* mLocAdapters[MAX_ADAPTERS];
|
|
|
|
|
|
protected:
|
|
ContextBase *mContext;
|
|
virtual enum loc_api_adapter_err
|
|
open(LOC_API_ADAPTER_EVENT_MASK_T mask);
|
|
virtual enum loc_api_adapter_err
|
|
close();
|
|
LOC_API_ADAPTER_EVENT_MASK_T getEvtMask();
|
|
LOC_API_ADAPTER_EVENT_MASK_T mMask;
|
|
LocApiBase(LOC_API_ADAPTER_EVENT_MASK_T excludedMask,
|
|
ContextBase* context = NULL);
|
|
inline virtual ~LocApiBase() { close(); }
|
|
bool isInSession();
|
|
const LOC_API_ADAPTER_EVENT_MASK_T mExcludedMask;
|
|
|
|
public:
|
|
inline void sendMsg(const LocMsg* msg) const {
|
|
mMsgTask->sendMsg(msg);
|
|
}
|
|
void addAdapter(LocAdapterBase* adapter);
|
|
void removeAdapter(LocAdapterBase* adapter);
|
|
|
|
// upward calls
|
|
void handleEngineUpEvent();
|
|
void handleEngineDownEvent();
|
|
void reportPosition(UlpLocation& location,
|
|
GpsLocationExtended& locationExtended,
|
|
enum loc_sess_status status,
|
|
LocPosTechMask loc_technology_mask =
|
|
LOC_POS_TECH_MASK_DEFAULT);
|
|
void reportSv(GnssSvNotification& svNotify);
|
|
void reportSvMeasurement(GnssSvMeasurementSet &svMeasurementSet);
|
|
void reportSvPolynomial(GnssSvPolynomial &svPolynomial);
|
|
void reportStatus(LocGpsStatusValue status);
|
|
void reportNmea(const char* nmea, int length);
|
|
void reportXtraServer(const char* url1, const char* url2,
|
|
const char* url3, const int maxlength);
|
|
void requestXtraData();
|
|
void requestTime();
|
|
void requestLocation();
|
|
void requestATL(int connHandle, LocAGpsType agps_type);
|
|
void releaseATL(int connHandle);
|
|
void requestSuplES(int connHandle);
|
|
void reportDataCallOpened();
|
|
void reportDataCallClosed();
|
|
void requestNiNotify(GnssNiNotification ¬ify, const void* data);
|
|
void reportGnssMeasurementData(GnssMeasurementsNotification& measurements, int msInWeek);
|
|
void reportWwanZppFix(LocGpsLocation &zppLoc);
|
|
void reportZppBestAvailableFix(LocGpsLocation &zppLoc, GpsLocationExtended &location_extended,
|
|
LocPosTechMask tech_mask);
|
|
|
|
// downward calls
|
|
// All below functions are to be defined by adapter specific modules:
|
|
// RPC, QMI, etc. The default implementation is empty.
|
|
|
|
virtual void* getSibling();
|
|
virtual LocApiProxyBase* getLocApiProxy();
|
|
virtual void startFix(const LocPosMode& fixCriteria, LocApiResponse* adapterResponse);
|
|
virtual void
|
|
stopFix(LocApiResponse* adapterResponse);
|
|
virtual void
|
|
deleteAidingData(const GnssAidingData& data, LocApiResponse* adapterResponse);
|
|
|
|
virtual void
|
|
injectPosition(double latitude, double longitude, float accuracy);
|
|
virtual void
|
|
setTime(LocGpsUtcTime time, int64_t timeReference, int uncertainty);
|
|
|
|
// // TODO:: called from izatapipds
|
|
virtual enum loc_api_adapter_err
|
|
setXtraData(char* data, int length);
|
|
|
|
virtual void
|
|
atlOpenStatus(int handle, int is_succ, char* apn, uint32_t apnLen,
|
|
AGpsBearerType bear, LocAGpsType agpsType);
|
|
virtual void
|
|
atlCloseStatus(int handle, int is_succ);
|
|
virtual void
|
|
setPositionMode(const LocPosMode& posMode);
|
|
virtual LocationError
|
|
setServerSync(const char* url, int len);
|
|
virtual LocationError
|
|
setServerSync(unsigned int ip, int port,
|
|
LocServerType type);
|
|
virtual void
|
|
informNiResponse(GnssNiResponse userResponse, const void* passThroughData);
|
|
virtual LocationError setSUPLVersionSync(GnssConfigSuplVersion version);
|
|
virtual enum loc_api_adapter_err
|
|
setNMEATypesSync(uint32_t typesMask);
|
|
virtual LocationError setLPPConfigSync(GnssConfigLppProfile profile);
|
|
virtual enum loc_api_adapter_err
|
|
setSensorControlConfigSync(int sensorUsage, int sensorProvider);
|
|
virtual enum loc_api_adapter_err
|
|
setSensorPropertiesSync(bool gyroBiasVarianceRandomWalk_valid,
|
|
float gyroBiasVarianceRandomWalk,
|
|
bool accelBiasVarianceRandomWalk_valid,
|
|
float accelBiasVarianceRandomWalk,
|
|
bool angleBiasVarianceRandomWalk_valid,
|
|
float angleBiasVarianceRandomWalk,
|
|
bool rateBiasVarianceRandomWalk_valid,
|
|
float rateBiasVarianceRandomWalk,
|
|
bool velocityBiasVarianceRandomWalk_valid,
|
|
float velocityBiasVarianceRandomWalk);
|
|
virtual enum loc_api_adapter_err
|
|
setSensorPerfControlConfigSync(int controlMode,
|
|
int accelSamplesPerBatch,
|
|
int accelBatchesPerSec,
|
|
int gyroSamplesPerBatch,
|
|
int gyroBatchesPerSec,
|
|
int accelSamplesPerBatchHigh,
|
|
int accelBatchesPerSecHigh,
|
|
int gyroSamplesPerBatchHigh,
|
|
int gyroBatchesPerSecHigh,
|
|
int algorithmConfig);
|
|
virtual LocationError
|
|
setAGLONASSProtocolSync(GnssConfigAGlonassPositionProtocolMask aGlonassProtocol);
|
|
virtual LocationError setLPPeProtocolCpSync(GnssConfigLppeControlPlaneMask lppeCP);
|
|
virtual LocationError setLPPeProtocolUpSync(GnssConfigLppeUserPlaneMask lppeUP);
|
|
virtual GnssConfigSuplVersion convertSuplVersion(const uint32_t suplVersion);
|
|
virtual GnssConfigLppProfile convertLppProfile(const uint32_t lppProfile);
|
|
virtual GnssConfigLppeControlPlaneMask convertLppeCp(const uint32_t lppeControlPlaneMask);
|
|
virtual GnssConfigLppeUserPlaneMask convertLppeUp(const uint32_t lppeUserPlaneMask);
|
|
|
|
virtual enum loc_api_adapter_err
|
|
getWwanZppFix();
|
|
virtual void
|
|
getBestAvailableZppFix();
|
|
virtual int initDataServiceClient(bool isDueToSsr);
|
|
virtual int openAndStartDataCall();
|
|
virtual void stopDataCall();
|
|
virtual void closeDataCall();
|
|
virtual void releaseDataServiceClient();
|
|
virtual void installAGpsCert(const LocDerEncodedCertificate* pData,
|
|
size_t length,
|
|
uint32_t slotBitMask);
|
|
inline virtual void setInSession(bool inSession) {
|
|
|
|
(void)inSession;
|
|
}
|
|
|
|
|
|
void updateEvtMask();
|
|
|
|
virtual LocationError setGpsLockSync(GnssConfigGpsLock lock);
|
|
/*
|
|
Returns
|
|
Current value of GPS Lock on success
|
|
-1 on failure
|
|
*/
|
|
virtual int getGpsLock(void);
|
|
|
|
virtual LocationError setXtraVersionCheckSync(uint32_t check);
|
|
|
|
};
|
|
|
|
typedef LocApiBase* (getLocApi_t)(LOC_API_ADAPTER_EVENT_MASK_T exMask,
|
|
ContextBase *context);
|
|
|
|
} // namespace loc_core
|
|
|
|
#endif //LOC_API_BASE_H
|