no_os_gnss.h File Reference

Header file of GNSS Interface. More...

#include <stdint.h>
#include <stdbool.h>

Include dependency graph for no_os_gnss.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	no_os_gnss_pps_config
	GNSS PPS configuration structure for timing synchronization. More...
struct	no_os_gnss_precise_time
	API-level precise time information structure. More...
struct	no_os_gnss_position_data
	API-level position and fix quality data structure. More...
struct	no_os_gnss_init_param
	Structure holding the parameters for GNSS initialization. More...
struct	no_os_gnss_desc
	Structure holding the GNSS descriptor. More...
struct	no_os_gnss_platform_ops
	Structure holding GNSS function pointers that point to the platform specific function. More...

Functions
int32_t	no_os_gnss_init (struct no_os_gnss_desc **desc, const struct no_os_gnss_init_param *param)
	Initialize the GNSS communication peripheral.
int32_t	no_os_gnss_remove (struct no_os_gnss_desc *desc)
	Free the resources allocated by no_os_gnss_init().
int32_t	no_os_gnss_refresh_timing_data (struct no_os_gnss_desc *desc)
	Refresh timing data from GNSS device.
int32_t	no_os_gnss_is_timing_valid (struct no_os_gnss_desc *desc, bool *valid)
	Check if timing data is valid.
int32_t	no_os_gnss_get_unified_timing (struct no_os_gnss_desc *desc, struct no_os_gnss_precise_time *timing)
	Get unified timing information with best available precision.
int32_t	no_os_gnss_get_unix_epoch_unified (struct no_os_gnss_desc *desc, uint32_t *epoch, uint32_t *fractional_seconds)
	Get Unix epoch timestamp with unified precision.
int32_t	no_os_gnss_get_position_data (struct no_os_gnss_desc *desc, struct no_os_gnss_position_data *position_data)
	Get GPS position and fix quality data.

Variables
const struct no_os_gnss_platform_ops	nmea_ubx_gnss_ops
	Platform operations structure for NMEA/UBX GNSS devices.

Detailed Description

Header file of GNSS Interface.

Author

Radu Etz (radu..nosp@m.etz@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Copyright 2025(c) Analog Devices, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. 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.
3. Neither the name of Analog Devices, Inc. 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 BY ANALOG DEVICES, INC. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. 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.

Function Documentation

no_os_gnss_get_position_data()

int32_t no_os_gnss_get_position_data	(	struct no_os_gnss_desc *	desc,
		struct no_os_gnss_position_data *	position_data )

Get GPS position and fix quality data.

Parameters

desc	- The GNSS descriptor.
position_data	- Pointer to store position data.

Returns

0 on success, negative error code otherwise.

Here is the caller graph for this function:

no_os_gnss_get_unified_timing()

int32_t no_os_gnss_get_unified_timing	(	struct no_os_gnss_desc *	desc,
		struct no_os_gnss_precise_time *	timing )

Get unified timing information with best available precision.

Parameters

desc	- The GNSS descriptor.
timing	- Pointer to structure to store timing information.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

no_os_gnss_get_unix_epoch_unified()

int32_t no_os_gnss_get_unix_epoch_unified	(	struct no_os_gnss_desc *	desc,
		uint32_t *	epoch,
		uint32_t *	fractional_seconds )

Get Unix epoch timestamp with unified precision.

Parameters

desc	- The GNSS descriptor.
epoch	- Pointer to store Unix epoch timestamp in seconds.
fractional_seconds	- Pointer to store fractional seconds (microseconds).

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

no_os_gnss_init()

int32_t no_os_gnss_init	(	struct no_os_gnss_desc **	desc,
		const struct no_os_gnss_init_param *	param )

Initialize the GNSS communication peripheral.

Parameters

desc	- The GNSS descriptor.
param	- The structure that contains the GNSS parameters.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

no_os_gnss_is_timing_valid()

int32_t no_os_gnss_is_timing_valid	(	struct no_os_gnss_desc *	desc,
		bool *	valid )

Check if timing data is valid.

Parameters

desc	- The GNSS descriptor.
valid	- Pointer to store timing validity status.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

no_os_gnss_refresh_timing_data()

int32_t no_os_gnss_refresh_timing_data

(

struct no_os_gnss_desc *

desc

)

Refresh timing data from GNSS device.

Parameters

desc	- The GNSS descriptor.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

no_os_gnss_remove()

int32_t no_os_gnss_remove

(

struct no_os_gnss_desc *

desc

)

Free the resources allocated by no_os_gnss_init().

Parameters

desc	- The GNSS descriptor.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

Variable Documentation

nmea_ubx_gnss_ops

const struct no_os_gnss_platform_ops nmea_ubx_gnss_ops

extern

Platform operations structure for NMEA/UBX GNSS devices.