Mouse code for the MacroRat
mbed-dev/targets/TARGET_ONSEMI/TARGET_NCS36510/rtc.h@46:b156ef445742, 2017-06-03 (annotated)
- Committer:
- sahilmgandhi
- Date:
- Sat Jun 03 00:22:44 2017 +0000
- Revision:
- 46:b156ef445742
- Parent:
- 18:6a4db94011d3
Final code for internal battlebot competition.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
sahilmgandhi | 18:6a4db94011d3 | 1 | /** |
sahilmgandhi | 18:6a4db94011d3 | 2 | ****************************************************************************** |
sahilmgandhi | 18:6a4db94011d3 | 3 | * @file rtc.h |
sahilmgandhi | 18:6a4db94011d3 | 4 | * @brief (API) Public header of RTC driver |
sahilmgandhi | 18:6a4db94011d3 | 5 | * @internal |
sahilmgandhi | 18:6a4db94011d3 | 6 | * @author ON Semiconductor |
sahilmgandhi | 18:6a4db94011d3 | 7 | * $Rev: 3485 $ |
sahilmgandhi | 18:6a4db94011d3 | 8 | * $Date: 2015-07-14 15:20:11 +0530 (Tue, 14 Jul 2015) $ |
sahilmgandhi | 18:6a4db94011d3 | 9 | ****************************************************************************** |
sahilmgandhi | 18:6a4db94011d3 | 10 | * Copyright 2016 Semiconductor Components Industries LLC (d/b/a ON Semiconductor). |
sahilmgandhi | 18:6a4db94011d3 | 11 | * All rights reserved. This software and/or documentation is licensed by ON Semiconductor |
sahilmgandhi | 18:6a4db94011d3 | 12 | * under limited terms and conditions. The terms and conditions pertaining to the software |
sahilmgandhi | 18:6a4db94011d3 | 13 | * and/or documentation are available at http://www.onsemi.com/site/pdf/ONSEMI_T&C.pdf |
sahilmgandhi | 18:6a4db94011d3 | 14 | * (ON Semiconductor Standard Terms and Conditions of Sale, Section 8 Software) and |
sahilmgandhi | 18:6a4db94011d3 | 15 | * if applicable the software license agreement. Do not use this software and/or |
sahilmgandhi | 18:6a4db94011d3 | 16 | * documentation unless you have carefully read and you agree to the limited terms and |
sahilmgandhi | 18:6a4db94011d3 | 17 | * conditions. By using this software and/or documentation, you agree to the limited |
sahilmgandhi | 18:6a4db94011d3 | 18 | * terms and conditions. |
sahilmgandhi | 18:6a4db94011d3 | 19 | * |
sahilmgandhi | 18:6a4db94011d3 | 20 | * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED |
sahilmgandhi | 18:6a4db94011d3 | 21 | * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF |
sahilmgandhi | 18:6a4db94011d3 | 22 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. |
sahilmgandhi | 18:6a4db94011d3 | 23 | * ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, |
sahilmgandhi | 18:6a4db94011d3 | 24 | * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER. |
sahilmgandhi | 18:6a4db94011d3 | 25 | * @endinternal |
sahilmgandhi | 18:6a4db94011d3 | 26 | * |
sahilmgandhi | 18:6a4db94011d3 | 27 | * @ingroup rtc |
sahilmgandhi | 18:6a4db94011d3 | 28 | */ |
sahilmgandhi | 18:6a4db94011d3 | 29 | |
sahilmgandhi | 18:6a4db94011d3 | 30 | #ifndef RTC_H_ |
sahilmgandhi | 18:6a4db94011d3 | 31 | #define RTC_H_ |
sahilmgandhi | 18:6a4db94011d3 | 32 | |
sahilmgandhi | 18:6a4db94011d3 | 33 | #include "rtc_map.h" |
sahilmgandhi | 18:6a4db94011d3 | 34 | #include "clock.h" |
sahilmgandhi | 18:6a4db94011d3 | 35 | #include "memory_map.h" |
sahilmgandhi | 18:6a4db94011d3 | 36 | |
sahilmgandhi | 18:6a4db94011d3 | 37 | #define RTC_CLOCK_HZ 32768 |
sahilmgandhi | 18:6a4db94011d3 | 38 | #define RTC_SEC_TO_US 1000000 |
sahilmgandhi | 18:6a4db94011d3 | 39 | #define RTC_SUB_SEC_MASK 0x7FFF |
sahilmgandhi | 18:6a4db94011d3 | 40 | #define RTC_SEC_MASK 0xFFFFFFFF |
sahilmgandhi | 18:6a4db94011d3 | 41 | #define RTC_SEC_INT_STATUS_MASK 0x2 |
sahilmgandhi | 18:6a4db94011d3 | 42 | |
sahilmgandhi | 18:6a4db94011d3 | 43 | #define RTC_SUBSEC_INTERRUPT_BIT_VAL 0x1 |
sahilmgandhi | 18:6a4db94011d3 | 44 | #define RTC_SEC_INTERRUPT_BIT_VAL 0x2 |
sahilmgandhi | 18:6a4db94011d3 | 45 | #define RTC_ALL_INTERRUPT_BIT_VAL 0x3 |
sahilmgandhi | 18:6a4db94011d3 | 46 | |
sahilmgandhi | 18:6a4db94011d3 | 47 | #define RTC_INT_CLR_SUB_SEC_BIT_POS 0 |
sahilmgandhi | 18:6a4db94011d3 | 48 | #define RTC_INT_CLR_SEC_BIT_POS 1 |
sahilmgandhi | 18:6a4db94011d3 | 49 | |
sahilmgandhi | 18:6a4db94011d3 | 50 | #define RTC_CONTROL_SUBSEC_CNT_START_BIT_POS 0 |
sahilmgandhi | 18:6a4db94011d3 | 51 | #define RTC_CONTROL_SEC_CNT_START_BIT_POS 1 |
sahilmgandhi | 18:6a4db94011d3 | 52 | #define RTC_CONTROL_SUBSEC_CNT_INT_BIT_POS 2 |
sahilmgandhi | 18:6a4db94011d3 | 53 | #define RTC_CONTROL_SEC_CNT_INT_BIT_POS 3 |
sahilmgandhi | 18:6a4db94011d3 | 54 | |
sahilmgandhi | 18:6a4db94011d3 | 55 | #define RTC_STATUS_SUB_SEC_ALARM_WRT_BIT_POS 6 |
sahilmgandhi | 18:6a4db94011d3 | 56 | #define RTC_STATUS_SEC_ALARM_WRT_BIT_POS 7 |
sahilmgandhi | 18:6a4db94011d3 | 57 | #define RTC_STATUS_CONTROL_WRT_BIT_POS 8 |
sahilmgandhi | 18:6a4db94011d3 | 58 | #define RTC_STATUS_SUB_SEC_INT_CLR_WRT_BIT_POS 9 |
sahilmgandhi | 18:6a4db94011d3 | 59 | #define RTC_STATUS_SEC_INT_CLR_WRT_BIT_POS 10 |
sahilmgandhi | 18:6a4db94011d3 | 60 | |
sahilmgandhi | 18:6a4db94011d3 | 61 | #define SUB_SEC_MASK 0x7FFF |
sahilmgandhi | 18:6a4db94011d3 | 62 | |
sahilmgandhi | 18:6a4db94011d3 | 63 | |
sahilmgandhi | 18:6a4db94011d3 | 64 | /* FUnction pointer for call back */ |
sahilmgandhi | 18:6a4db94011d3 | 65 | typedef void (* fRtcCallBack)(void); |
sahilmgandhi | 18:6a4db94011d3 | 66 | |
sahilmgandhi | 18:6a4db94011d3 | 67 | /** |
sahilmgandhi | 18:6a4db94011d3 | 68 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 69 | * Initializes RTC, enable RTC & register call back function |
sahilmgandhi | 18:6a4db94011d3 | 70 | * |
sahilmgandhi | 18:6a4db94011d3 | 71 | * @param RtcCallBack Function pointer for RTC call back funtion |
sahilmgandhi | 18:6a4db94011d3 | 72 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 73 | */ |
sahilmgandhi | 18:6a4db94011d3 | 74 | void fRtcInit(void); |
sahilmgandhi | 18:6a4db94011d3 | 75 | |
sahilmgandhi | 18:6a4db94011d3 | 76 | /** |
sahilmgandhi | 18:6a4db94011d3 | 77 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 78 | * Disable RTC |
sahilmgandhi | 18:6a4db94011d3 | 79 | * |
sahilmgandhi | 18:6a4db94011d3 | 80 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 81 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 82 | */ |
sahilmgandhi | 18:6a4db94011d3 | 83 | void fRtcFree(void); |
sahilmgandhi | 18:6a4db94011d3 | 84 | |
sahilmgandhi | 18:6a4db94011d3 | 85 | /** |
sahilmgandhi | 18:6a4db94011d3 | 86 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 87 | * Set up alram for RTC interrupt in micro second |
sahilmgandhi | 18:6a4db94011d3 | 88 | * Pre-requisite: Both second & sub second interrupts should be cleared. |
sahilmgandhi | 18:6a4db94011d3 | 89 | * @param TimeStamp in micro seconds |
sahilmgandhi | 18:6a4db94011d3 | 90 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 91 | */ |
sahilmgandhi | 18:6a4db94011d3 | 92 | void fRtcSetInterrupt(uint32_t timestamp); |
sahilmgandhi | 18:6a4db94011d3 | 93 | |
sahilmgandhi | 18:6a4db94011d3 | 94 | /** |
sahilmgandhi | 18:6a4db94011d3 | 95 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 96 | * Disable interrupt |
sahilmgandhi | 18:6a4db94011d3 | 97 | * |
sahilmgandhi | 18:6a4db94011d3 | 98 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 99 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 100 | */ |
sahilmgandhi | 18:6a4db94011d3 | 101 | void fRtcDisableInterrupt(void); |
sahilmgandhi | 18:6a4db94011d3 | 102 | |
sahilmgandhi | 18:6a4db94011d3 | 103 | /** |
sahilmgandhi | 18:6a4db94011d3 | 104 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 105 | * Enable interrupt |
sahilmgandhi | 18:6a4db94011d3 | 106 | * |
sahilmgandhi | 18:6a4db94011d3 | 107 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 108 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 109 | */ |
sahilmgandhi | 18:6a4db94011d3 | 110 | void fRtcEnableInterrupt(void); |
sahilmgandhi | 18:6a4db94011d3 | 111 | |
sahilmgandhi | 18:6a4db94011d3 | 112 | /** |
sahilmgandhi | 18:6a4db94011d3 | 113 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 114 | * Clear interrupt |
sahilmgandhi | 18:6a4db94011d3 | 115 | * |
sahilmgandhi | 18:6a4db94011d3 | 116 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 117 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 118 | */ |
sahilmgandhi | 18:6a4db94011d3 | 119 | void fRtcClearInterrupt(void); |
sahilmgandhi | 18:6a4db94011d3 | 120 | |
sahilmgandhi | 18:6a4db94011d3 | 121 | /** |
sahilmgandhi | 18:6a4db94011d3 | 122 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 123 | * Returns RTC time in micro seconds |
sahilmgandhi | 18:6a4db94011d3 | 124 | * |
sahilmgandhi | 18:6a4db94011d3 | 125 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 126 | * @return RTC Time in micro second |
sahilmgandhi | 18:6a4db94011d3 | 127 | */ |
sahilmgandhi | 18:6a4db94011d3 | 128 | uint64_t fRtcRead(void); |
sahilmgandhi | 18:6a4db94011d3 | 129 | |
sahilmgandhi | 18:6a4db94011d3 | 130 | /** |
sahilmgandhi | 18:6a4db94011d3 | 131 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 132 | * Set RTC time in micro seconds |
sahilmgandhi | 18:6a4db94011d3 | 133 | * |
sahilmgandhi | 18:6a4db94011d3 | 134 | * @param RtcTime in micro Seconds |
sahilmgandhi | 18:6a4db94011d3 | 135 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 136 | */ |
sahilmgandhi | 18:6a4db94011d3 | 137 | void fRtcWrite(uint64_t RtcTimeus); |
sahilmgandhi | 18:6a4db94011d3 | 138 | |
sahilmgandhi | 18:6a4db94011d3 | 139 | /** |
sahilmgandhi | 18:6a4db94011d3 | 140 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 141 | * RTC interrupt handler |
sahilmgandhi | 18:6a4db94011d3 | 142 | * |
sahilmgandhi | 18:6a4db94011d3 | 143 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 144 | * @return None |
sahilmgandhi | 18:6a4db94011d3 | 145 | */ |
sahilmgandhi | 18:6a4db94011d3 | 146 | void fRtcHandler(void); |
sahilmgandhi | 18:6a4db94011d3 | 147 | |
sahilmgandhi | 18:6a4db94011d3 | 148 | /** |
sahilmgandhi | 18:6a4db94011d3 | 149 | * @details |
sahilmgandhi | 18:6a4db94011d3 | 150 | * Is RTC enabled? |
sahilmgandhi | 18:6a4db94011d3 | 151 | * |
sahilmgandhi | 18:6a4db94011d3 | 152 | * @param None |
sahilmgandhi | 18:6a4db94011d3 | 153 | * @return RTC status |
sahilmgandhi | 18:6a4db94011d3 | 154 | */ |
sahilmgandhi | 18:6a4db94011d3 | 155 | boolean fIsRtcEnabled(void); |
sahilmgandhi | 18:6a4db94011d3 | 156 | #endif /* RTC_H_ */ |