mirror of https://github.com/ARMmbed/mbed-os.git
65 lines
1.9 KiB
C
65 lines
1.9 KiB
C
/*
|
|
* Copyright (c) 2014-2017, 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.
|
|
*/
|
|
|
|
#ifndef NET_SLEEP_H_
|
|
#define NET_SLEEP_H_
|
|
|
|
#include "ns_types.h"
|
|
|
|
/**
|
|
* \file net_sleep.h
|
|
* \brief Checks if there is a sleep possibility for the stack and the max sleep time.
|
|
*
|
|
* \section check-slp-poss Checking sleep possibility.
|
|
* - arm_net_check_enter_deep_sleep_possibility(), Checks whether the stack can enter a sleep cycle.
|
|
* - arm_net_enter_sleep(), A function to enter sleep cycle.
|
|
* - arm_net_wakeup_and_timer_synch(), Restarts the stack and synchronizes the timer.
|
|
*/
|
|
|
|
/**
|
|
*\brief Check sleep possibility.
|
|
* \return Time in milliseconds for sleep.
|
|
* \return 0, No possibility to enter deep sleep.
|
|
*/
|
|
uint32_t arm_net_check_enter_deep_sleep_possibility(void);
|
|
|
|
/**
|
|
* \brief Set stack to sleep.
|
|
*
|
|
* \return 0 Stack stopped.
|
|
* \return -1 Not supported action at the moment.
|
|
*
|
|
*/
|
|
|
|
int arm_net_enter_sleep(void);
|
|
/**
|
|
* \brief Restart stack after sleep.
|
|
*
|
|
* Stack enable and synch timers after sleep.
|
|
*
|
|
* \param sleeped_time_in_ms The total sleep time in milliseconds. The stack needs to synch with this.
|
|
*
|
|
* \return 0 Stack restarted.
|
|
* \return 1 Stack can continue sleep for the time defined in sleeped_time_in_ms.
|
|
* \return -1 Stack already active.
|
|
*
|
|
*/
|
|
int arm_net_wakeup_and_timer_synch(uint32_t sleeped_time_in_ms);
|
|
|
|
|
|
#endif /* NET_SLEEP_H_ */
|