mirror of https://github.com/ARMmbed/mbed-os.git
117 lines
3.3 KiB
C
117 lines
3.3 KiB
C
/*
|
|
* Copyright (c) 2020-2021, Pelion and affiliates.
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* \file ns_time_api.h
|
|
* \brief Nanostack time API
|
|
*
|
|
* This is Nanostack time API.
|
|
*
|
|
*/
|
|
|
|
#ifndef NS_TIME_API_H_
|
|
#define NS_TIME_API_H_
|
|
|
|
#include "ns_types.h"
|
|
|
|
/**
|
|
* Time zone information structure.
|
|
*
|
|
* Daylight saving time and time zone information learned by network stack
|
|
*
|
|
*/
|
|
typedef struct timezone_info {
|
|
/** Timestamp of the Daylight saving time change*/
|
|
uint64_t timestamp;
|
|
/** Time zone information in minutes*/
|
|
int16_t timezone;
|
|
/** Change that is applied when timestamp is reached*/
|
|
int16_t deviation;
|
|
/** Time configuration status bit field
|
|
* "bit xxxxxxxxxxxxxxxS" 0 = false 1 = true Daylight saving time status*/
|
|
uint16_t status;
|
|
} timezone_info_t;
|
|
|
|
/**
|
|
* System time read callback.
|
|
*
|
|
* Callback shall return the system time in seconds after 1970.
|
|
*
|
|
* \param seconds system time in seconds
|
|
*
|
|
*/
|
|
typedef uint64_t ns_time_api_system_time_callback(void);
|
|
|
|
/**
|
|
* System time write callback.
|
|
*
|
|
* Callback will write the time in seconds after 1970.
|
|
*
|
|
* \param seconds system time in seconds
|
|
*
|
|
*/
|
|
typedef void ns_time_api_system_time_write_callback(uint64_t write_time);
|
|
|
|
/**
|
|
* New time zone and daylight saving time information learned from stack.
|
|
*
|
|
* Called when network stack learns the time zone and daylights saving time information.
|
|
*
|
|
* In Wi-SUN Border router can distribute this information to synchronize all nodes in network.
|
|
* This information is updated roughly once a day using DHCPv6 protocol
|
|
*
|
|
* If network stack does not have the information this is not called and can be called when information becomes available.
|
|
* This can be called multiple times with same information.
|
|
*
|
|
* \param info_ptr time zone and daylight saving time configuration.
|
|
*
|
|
*/
|
|
typedef void ns_time_api_time_configuration_notify_callback(timezone_info_t *info_ptr);
|
|
|
|
/**
|
|
* System time read callback set.
|
|
*
|
|
* Sets callback for the system time read.
|
|
*
|
|
* \param callback_rd system time read callback
|
|
*
|
|
*/
|
|
void ns_time_api_system_time_callback_set(ns_time_api_system_time_callback callback_rd);
|
|
|
|
/**
|
|
* Set system time write callback.
|
|
*
|
|
* Sets system time write callback.
|
|
*
|
|
* \param callback_wr system time write callback.
|
|
*
|
|
*/
|
|
void ns_time_api_system_time_write_callback_set(ns_time_api_system_time_write_callback callback_wr);
|
|
|
|
/**
|
|
* Set system time configuration notify callback.
|
|
*
|
|
* Sets system time configuration notify callback that is called if network stack
|
|
* learns time information from other devices in the network.
|
|
*
|
|
* \param callback_wr system time write callback.
|
|
*
|
|
*/
|
|
void ns_time_api_time_configuration_notify_callback_set(ns_time_api_time_configuration_notify_callback callback_wr);
|
|
|
|
#endif /* NS_TIME_API_H_ */
|