xref: /kernel/liteos_m/arch/include/los_timer.h (revision 3d8536b4)
1/*
2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 *    conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 *    of conditions and the following disclaimer in the documentation and/or other materials
13 *    provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16 *    to endorse or promote products derived from this software without specific prior written
17 *    permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _LOS_TIMER_H
33#define _LOS_TIMER_H
34
35#include "los_compiler.h"
36#include "los_interrupt.h"
37
38#ifdef __cplusplus
39#if __cplusplus
40extern "C" {
41#endif /* __cplusplus */
42#endif /* __cplusplus */
43
44#define TICK_CHECK                           0x4000000
45#define CYCLE_CHECK                          0xFFFFFFFFU
46#define SHIFT_32_BIT                          32
47#define MAX_HOUR 24
48#define MAX_MINUTES 60
49#define MAX_SECONDS 60
50#define MILSEC 1000
51#define RTC_WAKEUPCLOCK_RTCCLK 32768
52#define RTC_WAKEUPCLOCK_RTCCLK_DIV 16
53#define RTC_CALIBRATE_SLEEP_TIME 8
54#define MACHINE_CYCLE_DEALAY_TIMES (LOSCFG_BASE_CORE_TICK_PER_SECOND << 2)
55
56typedef struct {
57    UINT32        freq;
58    INT32         irqNum;
59    UINT64        periodMax;
60    UINT32        (*init)(HWI_PROC_FUNC tickHandler);
61    UINT64        (*getCycle)(UINT32 *period);
62    UINT64        (*reload)(UINT64 time);
63    VOID          (*lock)(VOID);
64    VOID          (*unlock)(VOID);
65    HWI_PROC_FUNC tickHandler;
66} ArchTickTimer;
67
68UINT32 ArchEnterSleep(VOID);
69
70/**
71 * @ingroup los_timer
72 * @brief Get tick timer control block.
73 *
74 * @par Description:
75 * This API is used to get tick timer control block.
76 *
77 * @param  None
78 *
79 * @retval #tick timer control block
80 * @par Dependency:
81 * <ul><li>los_timer.h: the header file that contains the API declaration.</li></ul>
82 * @see None.
83 */
84ArchTickTimer *ArchSysTickTimerGet(VOID);
85
86#define LOS_SysTickTimerGet ArchSysTickTimerGet
87
88#ifdef __cplusplus
89#if __cplusplus
90}
91#endif /* __cplusplus */
92#endif /* __cplusplus */
93
94#endif /* _LOS_TIMER_H */
95