gllbs_distr/gllbs_types.h File Reference

Broadcom LBS Client Data Types. More...

#include "gllbs_os_types.h"
#include "glgpsapi.h"
Include dependency graph for gllbs_types.h:
This graph shows which files directly or indirectly include this file:

Classes

struct  GlLbsDeviceId
 Device identification structure. More...
struct  GlLbsUtcTime
 Structure to keep the UTC time. More...
struct  GlLbsNmrElement
 GSM Cell. More...
struct  GlLbsNmr
 Network Measurement Reports (NMR). More...
struct  GlLbsGsmCellInformation
 GSM Cell Info. More...
struct  GlLbsFrequencyInfoFDD
 Frequency info FDD. More...
struct  GlLbsFrequencyInfoTDD
 Frequency info TDD. More...
struct  GlLbsFrequencyInfoModeSpecificInfo
 Frequency Info Mode. More...
struct  GlLbsFrequencyInfo
 Frequency info. More...
struct  GlLbsTimeslotIscpList
 Time slot. More...
struct  GlLbsCellMeasuredResultsModeSpecificInfoTdd
 TDD Specific Info. More...
struct  GlLbsPrimaryCpichInfo
 TDD Specific Info. More...
struct  GlLbsCellMeasuredResultsModeSpecificInfoFdd
 FDD Specific Info. More...
struct  GlLbsCellMeasuredResultsModeSpecificInfo
 Cell Measured Results. More...
struct  GlLbsCellMeasuredResults
 Cell Measured Results. More...
struct  GlLbsCellMeasuredResultsList
 Cell Measured Results List. More...
struct  GlLbsMeasuredResults
 Cell Measured Results. More...
struct  GlLbsMeasuredResultsList
 Measured Results List. More...
struct  GlLbsWcdmaCellInformation
 WCDMA Cell Information. More...
struct  GlLbsLteCellInformation
 LTE Cell Information. More...
struct  GlLbsCellInfo
 Cell Info. More...
struct  GlLbsGpsTime
 GPS Time. More...
struct  GlLbsPosition
 Location information. More...
struct  GlLbsEphemerisSubframe1Reserved
 Navigation Model (Ephemeris) More...
struct  GlLbsUncompressedEphemeris
 GPS Uncompressed Ephemeris. More...
struct  GlLbsSatStatus
 GPS Satellite Status. More...
struct  GlLbsNavModelElement
 Navigation Model Element. More...
struct  GlLbsGpsSatPrMeas
 Satellite Pseudo-Range Measurements. More...
struct  GlLbsGpsResMeas
 Satellite Measurements. More...
struct  GlLbsSvInfo
 Per SV information. More...
struct  GlLbsPosLocation
 Location information. More...
struct  GlLbsPosInfo
 Structure used for position Info notification. More...
struct  GlLbsExtSensLocationData
 Structure used for GLLBS_GPS_AD_EXT_SENS_LOCATION notification. More...
struct  GlLbsGpsAssistanceData
 GPS Assistance Data Respond. More...

Defines

#define GLLBS_MAX_MSMT_SIZE   12
 GPS Measurement Information Element.

Typedefs

typedef enum GLLBS_ERRORS GLLBS_ERRORS
 Error codes.
typedef struct GlLbsDeviceId GlLbsDeviceId
 Device identification structure.
typedef struct GlLbsUtcTime GlLbsUtcTime
 Structure to keep the UTC time.
typedef struct GlLbsNmrElement GlLbsNmrElement
 GSM Cell.
typedef struct GlLbsNmr GlLbsNmr
 Network Measurement Reports (NMR).
typedef struct
GlLbsGsmCellInformation 
GlLbsGsmCellInformation
 GSM Cell Info.
typedef struct
GlLbsFrequencyInfoFDD 
GlLbsFrequencyInfoFDD
 Frequency info FDD.
typedef struct
GlLbsFrequencyInfoTDD 
GlLbsFrequencyInfoTDD
 Frequency info TDD.
typedef enum GlLbsFrequencyInfoType GlLbsFrequencyInfoType
 Frequency info Type.
typedef struct
GlLbsFrequencyInfoModeSpecificInfo 
GlLbsFrequencyInfoModeSpecificInfo
 Frequency Info Mode.
typedef struct GlLbsFrequencyInfo GlLbsFrequencyInfo
 Frequency info.
typedef struct
GlLbsTimeslotIscpList 
GlLbsTimeslotIscpList
 Time slot.
typedef struct
GlLbsCellMeasuredResultsModeSpecificInfoTdd 
GlLbsCellMeasuredResultsModeSpecificInfoTdd
 TDD Specific Info.
typedef struct
GlLbsPrimaryCpichInfo 
GlLbsPrimaryCpichInfo
 TDD Specific Info.
typedef struct
GlLbsCellMeasuredResultsModeSpecificInfoFdd 
GlLbsCellMeasuredResultsModeSpecificInfoFdd
 FDD Specific Info.
typedef struct
GlLbsCellMeasuredResultsModeSpecificInfo 
GlLbsCellMeasuredResultsModeSpecificInfo
 Cell Measured Results.
typedef struct
GlLbsCellMeasuredResults 
GlLbsCellMeasuredResults
 Cell Measured Results.
typedef struct
GlLbsCellMeasuredResultsList 
GlLbsCellMeasuredResultsList
 Cell Measured Results List.
typedef struct GlLbsMeasuredResults GlLbsMeasuredResults
 Cell Measured Results.
typedef struct
GlLbsMeasuredResultsList 
GlLbsMeasuredResultsList
 Measured Results List.
typedef struct
GlLbsWcdmaCellInformation 
GlLbsWcdmaCellInformation
 WCDMA Cell Information.
typedef struct
GlLbsLteCellInformation 
GlLbsLteCellInformation
 LTE Cell Information.
typedef enum GlLbsCellInfoType GlLbsCellInfoType
 Cell Info Type.
typedef struct GlLbsCellInfo GlLbsCellInfo
 Cell Info.
typedef struct GlLbsGpsTime GlLbsGpsTime
 GPS Time.
typedef struct GlLbsPosition GlLbsPosition
 Location information.
typedef struct
GlLbsEphemerisSubframe1Reserved 
GlLbsEphemerisSubframe1Reserved
 Navigation Model (Ephemeris)
typedef struct
GlLbsUncompressedEphemeris 
GlLbsUncompressedEphemeris
 GPS Uncompressed Ephemeris.
typedef struct GlLbsSatStatus GlLbsSatStatus
 GPS Satellite Status.
typedef struct GlLbsNavModelElement GlLbsNavModelElement
 Navigation Model Element.
typedef struct GlLbsGpsSatPrMeas GlLbsGpsSatPrMeas
 Satellite Pseudo-Range Measurements.
typedef struct GlLbsGpsResMeas GlLbsGpsResMeas
 Satellite Measurements.
typedef struct GlLbsSvInfo GlLbsSvInfo
 Per SV information.
typedef struct GlLbsPosLocation GlLbsPosLocation
 Location information.
typedef struct GlLbsPosInfo GlLbsPosInfo
 Structure used for position Info notification.
typedef struct
GlLbsExtSensLocationData 
GlLbsExtSensLocationData
 Structure used for GLLBS_GPS_AD_EXT_SENS_LOCATION notification.
typedef enum
GLLBS_REQUEST_LOCATION_CODE 
GLLBS_REQUEST_LOCATION_CODE
 Location Request Type.
typedef enum GLLBS_GPS_AD_CODE GLLBS_GPS_AD_CODE
 GPS Assistance Data Request Type.
typedef struct
GlLbsGpsAssistanceData 
GlLbsGpsAssistanceData
 GPS Assistance Data Respond.

Enumerations

enum  GLLBS_ERRORS { ,
  LBS_OK = 0, LBS_ERROR_LBS_INVALID = -1, LBS_ERROR_PARAMETER_INVALID = -2, LBS_ERROR_OUT_OF_MEMORY = -3,
  LBS_ERROR_ENCODE = -4, LBS_ERROR_DECODE = -5, LBS_ERROR_FAILED = -6, LBS_ERROR_UNEXPECTED = -7,
  LBS_ERROR_COUNT = -8
}
 Error codes. More...
enum  GlLbsFrequencyInfoType { GLLBS_FRQ_FDD = 1, GLLBS_FRQ_TDD = 2 }
 Frequency info Type. More...
enum  GlLbsCellInfoType { GLLBS_CELL_INFO_GSM = 1, GLLBS_CELL_INFO_WCDMA = 2, GLLBS_CELL_INFO_LTE = 3 }
 Cell Info Type. More...
enum  GLLBS_REQUEST_LOCATION_CODE { GLLBS_REQ_NONE, GLLBS_REQ_PERIODIC, GLLBS_REQ_SINGLE_SHOT }
 Location Request Type. More...
enum  GLLBS_GPS_AD_CODE {
  GLLBS_GPS_AD_REFTIME = 1 << 0, GLLBS_GPS_AD_REFLOCATION = 1 << 1, GLLBS_GPS_AD_NAVMODEL = 1 << 2, GLLBS_GPS_AD_EXT_SENS_LOCATION = 1 << 3,
  GLLBS_GPS_AD_REFTIME_UTC = 1 << 10, GLLBS_GPS_AD_GLN_NAVMODEL = 1 << 11
}
 GPS Assistance Data Request Type. More...

Detailed Description

Broadcom LBS Client Data Types.

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.


Define Documentation

#define GLLBS_MAX_MSMT_SIZE   12

GPS Measurement Information Element.

  • see GSM 04.31 version 7.2.0 Release 1998, Table A.5
  • see GSM 04.31 version 7.2.0 Release 1998, Table A.8

Typedef Documentation

typedef enum GLLBS_ERRORS GLLBS_ERRORS

Error codes.

Negative value indicate error. 0 and positive indicate success.

typedef struct GlLbsCellInfo GlLbsCellInfo

Cell Info.

The following cell IDs are supported:

  • GSM Cell Info
  • WCDMA Cell Info

Cell Info Type.

The following cell IDs are supported:

  • GSM Cell Info
  • WCDMA Cell Info
  • CDMA Cell Info

Reference: OMA SUPL TS (Section 7.11 Location ID)

Cell Measured Results.

The Cell Measured Results of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info)

ASN.1 specification:

CellMeasuredResults ::= SEQUENCE {
    cellIdentity INTEGER(0..268435455) OPTIONAL,
    modeSpecificInfo
}

Cell Measured Results List.

The FDD Frequency Specific Info of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info)

ASN.1 specification:

    maxCellMeas INTEGER ::= 32
    CellMeasuredResultsList ::= SEQUENCE (SIZE (1..maxCellMeas)) OF CellMeasuredResults

Cell Measured Results.

The Cell Measured Results of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info)

ASN.1 specification:

modeSpecificInfo :=
    CHOICE {
        fdd SEQUENCE {
            primaryCPICH-Info   PrimaryCPICH-Info,
            cpich-Ec-N0         CPICH-Ec-N0         OPTIONAL,
            cpich-RSCP          CPICH-RSCP          OPTIONAL,
            pathloss            Pathloss            OPTIONAL
        },
        tdd SEQUENCE {
            cellParametersID    CellParametersID,
            proposedTGSN        TGSN OPTIONAL,
            primaryCCPCH-RSCP   PrimaryCCPCH-RSCP   OPTIONAL,
            pathloss            Pathloss            OPTIONAL,
            timeslotISCP-List   TimeslotISCP-List   OPTIONAL
        }
    }

FDD Specific Info.

The FDD Frequency Specific Info of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info)

ASN.1 specification:

        fdd SEQUENCE {
            primaryCPICH-Info   PrimaryCPICH-Info,
            cpich-Ec-N0         CPICH-Ec-N0         OPTIONAL,
            cpich-RSCP          CPICH-RSCP          OPTIONAL,
            pathloss            Pathloss            OPTIONAL
        },

TDD Specific Info.

The TDD Frequency Specific Info of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

ASN.1 specification:

        tdd SEQUENCE {
            cellParametersID    CellParametersID,
            proposedTGSN        TGSN OPTIONAL,
            primaryCCPCH-RSCP   PrimaryCCPCH-RSCP   OPTIONAL,
            pathloss            Pathloss            OPTIONAL,
            timeslotISCP-List   TimeslotISCP-List   OPTIONAL
        }

Frequency info.

The Frequency info of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

Frequency info FDD.

The FDD Frequency parameter of a WCDMA radio cell. FDD Frequency info can be: uarfcn-UL, range: (0..16383) uarfcn-DL, range: (0..16383) In case of fdd, uarfcn-UL is optional while uarfcn-DL is mandatory. If uarfcn-UL is not present, the default duplex distance defined for the operating frequency band shall be used [3GPP RRC].

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

ASN.1 specification:

FrequencyInfoFDD ::= SEQUENCE {
    uarfcn-UL UARFCN    OPTIONAL,
    uarfcn-DL UARFCN,
    ...
}

Frequency Info Mode.

Mode Specific Info of Frequency Info.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

ASN.1 specification:

FrequencyInfo ::= SEQUENCE {
    modeSpecificInfo CHOICE {
        fdd FrequencyInfoFDD,
        tdd FrequencyInfoTDD,
        ...
    },
    ...
}

Frequency info TDD.

The TDD Frequency parameter of a WCDMA radio cell. TDD Frequency info can be: uarfcn-Nt, range: (0..16383)

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

ASN.1 specification:

FrequencyInfoTDD ::= SEQUENCE {
    uarfcn-Nt UARFCN,
    ...
}

Frequency info Type.

The Frequency info Type can be FDD or TDD.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

GSM Cell Info.

This parameter defines the parameter of a GSM radio cell.

Reference: OMA SUPL TS (Section 7.11.1 GSM Cell Info).

ASN.1 specification:

GsmCellInformation ::= SEQUENCE {
    refMCC  INTEGER(0..999),                -- Mobile Country Code
    refMNC  INTEGER(0..999),                -- Mobile Network Code
    refLAC  INTEGER(0..65535),              -- Location area code
    refCI   INTEGER(0..65535),              -- Cell identity
    nMR     NMR                 OPTIONAL,
    tA      INTEGER(0..255)     OPTIONAL,   -- Timing Advance
    ...
}

LTE Cell Information.

This parameter defines the parameter of a LTE radio cell.

Cell Measured Results.

The FDD Measured Results of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info)

ASN.1 specification:

MeasuredResults ::= SEQUENCE {
    frequencyInfo           FrequencyInfo           OPTIONAL,
    utra-CarrierRSSI        UTRA-CarrierRSSI        OPTIONAL,
    cellMeasuredResultsList CellMeasuredResultsList OPTIONAL
}

Measured Results List.

Network Measurement Report for WCDMA comprising both intra- and/or inter-frequency cell measurements (as per 3GPP TS 25.331).

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info)

ASN.1 specification:

    maxFreq INTEGER ::= 8
    MeasuredResultsList ::= SEQUENCE (SIZE (1..maxFreq)) OF MeasuredResults
typedef struct GlLbsNmr GlLbsNmr

Network Measurement Reports (NMR).

This parameter describes Contents of the Current Network Measurement Reports. Contains 1 to 15 NMR elements

Reference: OMA SUPL TS (Section 7.1 NMR).

ASN.1 specification:

NMR ::= SEQUENCE (SIZE (1..15)) OF NMRelement

GSM Cell.

Network Measurement Reports (NMR). Describes Contents of the Current Network Measurement Reports. Contains 1 to 15 NMR elements

Reference: OMA SUPL TS (Section 7.1 NMR).

ASN.1 specification:

NMRelement ::= SEQUENCE {
    aRFCN   INTEGER(0..1023),
    bSIC    INTEGER(0..63),
    rxLev   INTEGER(0..63),
    ...
}

TDD Specific Info.

The Primary CCPCH.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

ASN.1 specification:

    PrimaryCCPCH-RSCP ::= INTEGER(0..127)

Time slot.

The Time slot list for TDD Frequency of a WCDMA radio cell.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

ASN.1 specification:

maxTS INTEGER ::= 14
TimeslotISCP-List ::= SEQUENCE (SIZE (1..maxTS)) OF TimeslotISCP

WCDMA Cell Information.

This parameter defines the parameter of a WCDMA radio cell.


Enumeration Type Documentation

Error codes.

Negative value indicate error. 0 and positive indicate success.

Enumerator:
LBS_OK 

Success.

LBS_ERROR_LBS_INVALID 

Success.

LBS_ERROR_PARAMETER_INVALID 

Generic failure.

LBS_ERROR_OUT_OF_MEMORY 

Input parameter in API function is invalid.

LBS_ERROR_ENCODE 

Memory can not be allocated or was not allocated before.

LBS_ERROR_DECODE 

Encoding error.

LBS_ERROR_FAILED 

Decoding error.

LBS_ERROR_UNEXPECTED 

General error.

LBS_ERROR_COUNT 

Unexpected API function called.

GPS Assistance Data Request Type.

Enumerator:
GLLBS_GPS_AD_REFTIME 

Reference Time.

GLLBS_GPS_AD_REFLOCATION 

Reference Location.

GLLBS_GPS_AD_NAVMODEL 

Navigation Model.

GLLBS_GPS_AD_EXT_SENS_LOCATION 

Location for external sensor filter.

GLLBS_GPS_AD_REFTIME_UTC 

Reference Time in UTC.

GLLBS_GPS_AD_GLN_NAVMODEL 

GLONASS Navigation Model.

Location Request Type.

Enumerator:
GLLBS_REQ_NONE 

No request.

GLLBS_REQ_PERIODIC 

Request for periodic location.

GLLBS_REQ_SINGLE_SHOT 

Request for a single location.

Cell Info Type.

The following cell IDs are supported:

  • GSM Cell Info
  • WCDMA Cell Info
  • CDMA Cell Info

Reference: OMA SUPL TS (Section 7.11 Location ID)

Enumerator:
GLLBS_CELL_INFO_GSM 

GSM Cell information.

GLLBS_CELL_INFO_WCDMA 

WCDMA Cell information.

GLLBS_CELL_INFO_LTE 

LTE Cell information.

Frequency info Type.

The Frequency info Type can be FDD or TDD.

Reference: OMA SUPL TS (Section 7.11.2 WCDMA Cell Info).

Enumerator:
GLLBS_FRQ_FDD 

FDD Frequency information.

GLLBS_FRQ_TDD 

TDD Frequency information.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines