Contiki-NG
clock-arch.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, Texas Instruments Incorporated - http://www.ti.com/
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 /**
31  * \addtogroup cc13xx-cc26xx-cpu
32  * @{
33  *
34  * \defgroup cc13xx-cc26xx-clock CC13xx/CC26xx clock implementation
35  *
36  * @{
37  *
38  * \file
39  * Header file for the CC13xx/CC26xx clock implementation.
40  */
41 /*---------------------------------------------------------------------------*/
42 #ifndef CLOCK_ARCH_H_
43 #define CLOCK_ARCH_H_
44 /*---------------------------------------------------------------------------*/
45 #include <stdbool.h>
46 /*---------------------------------------------------------------------------*/
47 /**
48  * \brief Prepare to enter some low-power mode. Return value indicates if we
49  * are ready or not to enter some low-power mode.
50  * \return true if ready; else false.
51  */
52 bool clock_arch_enter_idle(void);
53 /*---------------------------------------------------------------------------*/
54 /**
55  * \brief Cleanup after returning from low-power mode.
56  */
57 void clock_arch_exit_idle(void);
58 /*---------------------------------------------------------------------------*/
59 /**
60  * \brief Called by the Power driver when dropping to some low-power state.
61  */
62 void clock_arch_standby_policy(void);
63 /*---------------------------------------------------------------------------*/
64 #endif /* CLOCK_ARCH_H_ */
65 /*---------------------------------------------------------------------------*/
66 /**
67  * @}
68  * @}
69  */
bool clock_arch_enter_idle(void)
Prepare to enter some low-power mode.
Definition: clock-arch.c:142
void clock_arch_exit_idle(void)
Cleanup after returning from low-power mode.
Definition: clock-arch.c:178
void clock_arch_standby_policy(void)
Called by the Power driver when dropping to some low-power state.
Definition: clock-arch.c:184