glct/glct_api.h File Reference

Basic set of API control GLCT. More...

#include "glgps_hal.h"
Include dependency graph for glct_api.h:
This graph shows which files directly or indirectly include this file:

Defines

#define GpsRun   GL_FUNC_NAME(GpsRun, GLCT_P4_CHANGE_LIST)
 This header file contains PAL (Platform Abstraction Library) functions to be implemented to have the GLCT be able to communicate with your platform.

Functions

GL_STOP_CODE GpsRun (const plain_char *pcConfigString, const plain_char *pcJobToRun, short sExtraParmNum, const plain_char *apcExtraParms[])
 This function starts the GPS control software (GPSCT).
void * GlctOnLoad (const plain_char *pcConfigString, const plain_char *pcQAjobToExecute, short sExtraParmNum, const plain_char *apcExtraParms[])
 This function used internally in GpsRun to create a GpsEngine instance.
signed long GlctGetSleepTimeout (void *pGpsCtrl)
 Returns time in ms GLCT can be idle.
int GlctProcessEvent (void *pGpsCtrl, GPSCTRL_EVENT *potEvent)
 Function used internally in GpsRun to process events.
GL_STOP_CODE GlctOnExit (void *pGpsCtrl)
 Function used internally in GpsRun to clean up and exit.
GpsHalGetHalFromCtrlr (void *pGpsCtrl)
 Function used internally in GpsRun to get pointer to HAL.
void GlctOnAssert ()
 Function used to cleanup GLCT on assert.

Detailed Description

Basic set of API control GLCT.

For more information see GPS Library Control Task (GLCT) Interface

Copyright 2001-2010 Broadcom Corporation -- http://www.broadcom.com This program is the proprietary software of Broadcom Corporation and/or its licensors, and may only be used, duplicated, modified or distributed pursuant to the terms and conditions of a separate, written license agreement executed between you and Broadcom (an "Authorized License"). Except as set forth in an Authorized License, Broadcom grants no license (express or implied), right to use, or waiver of any kind with respect to the Software, and Broadcom expressly reserves all rights in and to the Software and all intellectual property rights therein. IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.


Function Documentation

GpsHal* GetHalFromCtrlr ( void *  pGpsCtrl)

Function used internally in GpsRun to get pointer to HAL.

Parameters:
pGpsCtrl- pointer to the GPS engine
signed long GlctGetSleepTimeout ( void *  pGpsCtrl)

Returns time in ms GLCT can be idle.

When this timeout expires the application must invoke GLCT GlctProcessEvent API to wake it up.

Parameters:
pGpsCtrl- pointer to the GPS engine
GL_STOP_CODE GlctOnExit ( void *  pGpsCtrl)

Function used internally in GpsRun to clean up and exit.

Parameters:
pGpsCtrl- pointer to the GPS engine
void* GlctOnLoad ( const plain_char *  pcConfigString,
const plain_char *  pcQAjobToExecute,
short  sExtraParmNum,
const plain_char *  apcExtraParms[] 
)

This function used internally in GpsRun to create a GpsEngine instance.

Parameters:
pcConfigString- XML configuration string either read from file or hard-coded. See the GL XML configuration file GL XML Config file description for description of XML file format.
pcConfigString- Name of the XML file.
pcQAjobToExecute- "normal", "cold" or some other job name defined in the XML config string.
sExtraParmNum- number of extra parameters in apcExtraParms
apcExtraParms- parm=value strings to be passed directly to GpsHalSetCfgValue().
Note:
Call this function to create GpsEngine, most likely in OnLoad event

Sets callback called on time available

Sets callback called on time available

int GlctProcessEvent ( void *  pGpsCtrl,
GPSCTRL_EVENT potEvent 
)

Function used internally in GpsRun to process events.

Parameters:
pGpsCtrl- pointer to the value returned from GlctOnLoad. (It is the GPS engine).
potEvent- pointer to an incoming event.
Return values:
1- Processing done, shutdown application
0- Wait for another event

At this point we got some events from HAL This event either goes directly to the GlEngine or it's teh input data for some request manager

The events for GlEngine consumption

GL_STOP_CODE GpsRun ( const plain_char *  pcConfigString,
const plain_char *  pcJobToRun,
short  sExtraParmNum,
const plain_char *  apcExtraParms[] 
)

This function starts the GPS control software (GPSCT).

The function does not return until the command "q" is received from the command stream. If a non blocking implementation is preferred see the source code for GpsRun for details on how to use the CreateGpsEngine, GlctProcessEvent, and DisposeEngine.

Parameters:
pcConfigString- XML configuration string either read from file or hard-coded. See the GL XML configuration file GL XML Config file description for description of XML file format.
pcJobToRun- "normal", "cold" or some other job name defined in the XML config string.
sExtraParmNum- number of extra parameters in apcExtraParms
apcExtraParms- parm=value strings to be passed directly to GpsHalSetCfgValue().
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines