Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

targets/TARGET_ONSEMI/TARGET_NCS36510/clock.h@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /**
elessair 0:f269e3021894 2 ******************************************************************************
elessair 0:f269e3021894 3 * @file clock.h
elessair 0:f269e3021894 4 * @brief Header of clock hw module functions
elessair 0:f269e3021894 5 * @internal
elessair 0:f269e3021894 6 * @author ON Semiconductor
elessair 0:f269e3021894 7 * $Rev: 3414 $
elessair 0:f269e3021894 8 * $Date: 2015-06-05 13:27:04 +0530 (Fri, 05 Jun 2015) $
elessair 0:f269e3021894 9 ******************************************************************************
elessair 0:f269e3021894 10 * Copyright 2016 Semiconductor Components Industries LLC (d/b/a “ON Semiconductor”).
elessair 0:f269e3021894 11 * All rights reserved. This software and/or documentation is licensed by ON Semiconductor
elessair 0:f269e3021894 12 * under limited terms and conditions. The terms and conditions pertaining to the software
elessair 0:f269e3021894 13 * and/or documentation are available at http://www.onsemi.com/site/pdf/ONSEMI_T&C.pdf
elessair 0:f269e3021894 14 * (“ON Semiconductor Standard Terms and Conditions of Sale, Section 8 Software”) and
elessair 0:f269e3021894 15 * if applicable the software license agreement. Do not use this software and/or
elessair 0:f269e3021894 16 * documentation unless you have carefully read and you agree to the limited terms and
elessair 0:f269e3021894 17 * conditions. By using this software and/or documentation, you agree to the limited
elessair 0:f269e3021894 18 * terms and conditions.
elessair 0:f269e3021894 19 *
elessair 0:f269e3021894 20 * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
elessair 0:f269e3021894 21 * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
elessair 0:f269e3021894 22 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
elessair 0:f269e3021894 23 * ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL,
elessair 0:f269e3021894 24 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
elessair 0:f269e3021894 25 * @endinternal
elessair 0:f269e3021894 26 *
elessair 0:f269e3021894 27 * @ingroup clock
elessair 0:f269e3021894 28 */
elessair 0:f269e3021894 29
elessair 0:f269e3021894 30 #ifndef CLOCK_H_
elessair 0:f269e3021894 31 #define CLOCK_H_
elessair 0:f269e3021894 32
elessair 0:f269e3021894 33 /*************************************************************************************************
elessair 0:f269e3021894 34 * *
elessair 0:f269e3021894 35 * Header files *
elessair 0:f269e3021894 36 * *
elessair 0:f269e3021894 37 *************************************************************************************************/
elessair 0:f269e3021894 38
elessair 0:f269e3021894 39 #include "types.h"
elessair 0:f269e3021894 40
elessair 0:f269e3021894 41 /*************************************************************************************************
elessair 0:f269e3021894 42 * *
elessair 0:f269e3021894 43 * Symbolic Constants *
elessair 0:f269e3021894 44 * *
elessair 0:f269e3021894 45 *************************************************************************************************/
elessair 0:f269e3021894 46
elessair 0:f269e3021894 47 /** Peripherals clock disable defines /
elessair 0:f269e3021894 48 * @details
elessair 0:f269e3021894 49 */
elessair 0:f269e3021894 50 #define CLOCK_TIMER0 (0x0) /**< <b> Timer 0 clock enable offset </b>*/
elessair 0:f269e3021894 51 #define CLOCK_TIMER1 (0x1) /**< <b> Timer 1 clock enable offset </b>: */
elessair 0:f269e3021894 52 #define CLOCK_TIMER2 (0x2) /**< <b> Timer 2 clock enable offset </b>: */
elessair 0:f269e3021894 53 #define CLOCK_PAD0_0 (0x3) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 54 #define CLOCK_PAD0_1 (0x4) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 55 #define CLOCK_UART1 (0x5) /**< <b> UART 1 clock enable offset </b> */
elessair 0:f269e3021894 56 #define CLOCK_SPI (0x6) /**< <b> SPI clock enable offset </b> */
elessair 0:f269e3021894 57 #define CLOCK_I2C (0x7) /**< <b> I2C clock enable offset </b> */
elessair 0:f269e3021894 58 #define CLOCK_UART2 (0x8) /**< <b> UART 2 clock enable offset </b> */
elessair 0:f269e3021894 59 #define CLOCK_SPI2 (0x9) /**< <b> Unused offset </b>: */
elessair 0:f269e3021894 60 #define CLOCK_WDOG (0xA) /**< <b> Watchdog clock enable offset </b> */
elessair 0:f269e3021894 61 #define CLOCK_PWM (0xB) /**< <b> PWM clock enable offset </b> */
elessair 0:f269e3021894 62 #define CLOCK_GPIO (0xC) /**< <b> GPIO clock enable offset </b> */
elessair 0:f269e3021894 63 #define CLOCK_I2C2 (0xD) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 64 #define CLOCK_PAD2_1 (0xE) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 65 #define CLOCK_RTC (0xF) /**< <b> RTC clock enable offset </b> */
elessair 0:f269e3021894 66 #define CLOCK_CROSSB (0x10) /**< <b> Crossbar clock enable offset </b> */
elessair 0:f269e3021894 67 #define CLOCK_RAND (0x11) /**< <b> Randomizer clock enable offset </b> */
elessair 0:f269e3021894 68 #define CLOCK_PAD3_0 (0x12) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 69 #define CLOCK_PAD3_1 (0x13) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 70 #define CLOCK_MACHW (0x14) /**< <b> macHw clock enable offset </b> */
elessair 0:f269e3021894 71 #define CLOCK_ADC (0x15) /**< <b> ADC clock enable offset </b> */
elessair 0:f269e3021894 72 #define CLOCK_AES (0x16) /**< <b> AES clock enable offset </b> */
elessair 0:f269e3021894 73 #define CLOCK_FLASH (0x17) /**< <b> Flash controller clock enable offset</b> */
elessair 0:f269e3021894 74 #define CLOCK_PAD4_0 (0x18) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 75 #define CLOCK_RFANA (0x19) /**< <b> rfAna clock enable offset </b> */
elessair 0:f269e3021894 76 #define CLOCK_IO (0x1A) /**< <b> IO clock enable offset </b> */
elessair 0:f269e3021894 77 #define CLOCK_PAD5_0 (0x1B) /**< <b> Unused offset </b> */
elessair 0:f269e3021894 78 #define CLOCK_PAD (0x1C) /**< <b> Pad clock enable offset </b> */
elessair 0:f269e3021894 79 #define CLOCK_PMU (0x1D) /**< <b> Pmu clock enable offset </b> */
elessair 0:f269e3021894 80 #define CLOCK_DMA (0x1E) /**< <b> DMA clock enable offset </b> */
elessair 0:f269e3021894 81 #define CLOCK_TEST (0x1F) /**< <b> Test controller clock enable offset </b> */
elessair 0:f269e3021894 82
elessair 0:f269e3021894 83 #define CLOCK_ENABLE(a) CLOCKREG->PDIS.WORD &= ~(1 << a)
elessair 0:f269e3021894 84 #define CLOCK_DISABLE(a) CLOCKREG->PDIS.WORD |= (uint32_t)(1 << a)
elessair 0:f269e3021894 85
elessair 0:f269e3021894 86 /*************************************************************************************************
elessair 0:f269e3021894 87 * *
elessair 0:f269e3021894 88 * Functions *
elessair 0:f269e3021894 89 * *
elessair 0:f269e3021894 90 *************************************************************************************************/
elessair 0:f269e3021894 91
elessair 0:f269e3021894 92 /** Function to initialize clocks
elessair 0:f269e3021894 93 * @details
elessair 0:f269e3021894 94 * The function initializes clocks.
elessair 0:f269e3021894 95 * This initialization includes:
elessair 0:f269e3021894 96 * - Enable of external 32mHz oscillator
elessair 0:f269e3021894 97 * - Disable of all peripheral clocks (to be turned on selectively when used later in the application)
elessair 0:f269e3021894 98 * - Setting core frequency
elessair 0:f269e3021894 99 */
elessair 0:f269e3021894 100 void fClockInit(void);
elessair 0:f269e3021894 101
elessair 0:f269e3021894 102 /** Function to get peripheral clock frequency
elessair 0:f269e3021894 103 * @details
elessair 0:f269e3021894 104 * The function checks and returns peripheral clock frequency
elessair 0:f269e3021894 105 * @return Peripheral clock frequency
elessair 0:f269e3021894 106 */
elessair 0:f269e3021894 107 uint32_t fClockGetPeriphClockfrequency();
elessair 0:f269e3021894 108
elessair 0:f269e3021894 109 /** Function to get peripheral clock frequency
elessair 0:f269e3021894 110 * @details
elessair 0:f269e3021894 111 * The function checks which input clock is sourcing 32kHz clock domain.
elessair 0:f269e3021894 112 * This domain can be either sourced by:
elessair 0:f269e3021894 113 * - Internal 32kHz oscillator
elessair 0:f269e3021894 114 * - External 32.768kHz oscillator
elessair 0:f269e3021894 115 * @return 32kHz clock domain frequency
elessair 0:f269e3021894 116 */
elessair 0:f269e3021894 117 uint16_t fClockGet32kClockfrequency();
elessair 0:f269e3021894 118
elessair 0:f269e3021894 119 /** Function to enable peripheral clock
elessair 0:f269e3021894 120 * @details
elessair 0:f269e3021894 121 * The function enables clock of peripheral indicated by parameter
elessair 0:f269e3021894 122 * @param deviceId Peripheral ID whose clock must be enabled.
elessair 0:f269e3021894 123 */
elessair 0:f269e3021894 124 void fClockEnablePeriph(uint8_t deviceId);
elessair 0:f269e3021894 125
elessair 0:f269e3021894 126 /** Function to disable peripheral clock
elessair 0:f269e3021894 127 * @details
elessair 0:f269e3021894 128 * The function disables clock of peripheral indicated by parameter
elessair 0:f269e3021894 129 * @param deviceId ID Peripheral whose clock must be disabled.
elessair 0:f269e3021894 130 */
elessair 0:f269e3021894 131 void fClockDisablePeriph(uint8_t deviceId);
elessair 0:f269e3021894 132
elessair 0:f269e3021894 133 #endif /* CLOCK_H_ */