mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

targets/hal/TARGET_Freescale/TARGET_KPSDK_MCUS/TARGET_KPSDK_CODE/hal/osc/fsl_osc_hal.h@149:1fb5f62b92bd, 2014-04-03 (annotated)

Committer:
mbed_official
Date:
Thu Apr 03 11:45:06 2014 +0100
Revision:
149:1fb5f62b92bd
Parent:
targets/hal/TARGET_Freescale/TARGET_KSDK_MCUS/TARGET_KSDK_CODE/hal/osc/fsl_osc_hal.h@146:f64d43ff0c18
Child:
324:406fd2029f23
Synchronized with git revision 220c0bb39ceee40016e1e86350c058963d01ed42



Full URL: https://github.com/mbedmicro/mbed/commit/220c0bb39ceee40016e1e86350c058963d01ed42/

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 146:f64d43ff0c18 1 /*
mbed_official 146:f64d43ff0c18 2 * Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
mbed_official 146:f64d43ff0c18 3 * All rights reserved.
mbed_official 146:f64d43ff0c18 4 *
mbed_official 146:f64d43ff0c18 5 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 146:f64d43ff0c18 6 * are permitted provided that the following conditions are met:
mbed_official 146:f64d43ff0c18 7 *
mbed_official 146:f64d43ff0c18 8 * o Redistributions of source code must retain the above copyright notice, this list
mbed_official 146:f64d43ff0c18 9 * of conditions and the following disclaimer.
mbed_official 146:f64d43ff0c18 10 *
mbed_official 146:f64d43ff0c18 11 * o Redistributions in binary form must reproduce the above copyright notice, this
mbed_official 146:f64d43ff0c18 12 * list of conditions and the following disclaimer in the documentation and/or
mbed_official 146:f64d43ff0c18 13 * other materials provided with the distribution.
mbed_official 146:f64d43ff0c18 14 *
mbed_official 146:f64d43ff0c18 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
mbed_official 146:f64d43ff0c18 16 * contributors may be used to endorse or promote products derived from this
mbed_official 146:f64d43ff0c18 17 * software without specific prior written permission.
mbed_official 146:f64d43ff0c18 18 *
mbed_official 146:f64d43ff0c18 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
mbed_official 146:f64d43ff0c18 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
mbed_official 146:f64d43ff0c18 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 146:f64d43ff0c18 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
mbed_official 146:f64d43ff0c18 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
mbed_official 146:f64d43ff0c18 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
mbed_official 146:f64d43ff0c18 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
mbed_official 146:f64d43ff0c18 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
mbed_official 146:f64d43ff0c18 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
mbed_official 146:f64d43ff0c18 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 146:f64d43ff0c18 29 */
mbed_official 146:f64d43ff0c18 30 #if !defined(__FSL_OSC_HAL_H__)
mbed_official 146:f64d43ff0c18 31 #define __FSL_OSC_HAL_H__
mbed_official 146:f64d43ff0c18 32
mbed_official 146:f64d43ff0c18 33 #include <stdint.h>
mbed_official 146:f64d43ff0c18 34 #include <stdbool.h>
mbed_official 146:f64d43ff0c18 35 #include <assert.h>
mbed_official 146:f64d43ff0c18 36 #include "fsl_device_registers.h"
mbed_official 146:f64d43ff0c18 37 #include "fsl_osc_features.h"
mbed_official 146:f64d43ff0c18 38
mbed_official 146:f64d43ff0c18 39 /*! @addtogroup osc_hal*/
mbed_official 146:f64d43ff0c18 40 /*! @{*/
mbed_official 146:f64d43ff0c18 41
mbed_official 146:f64d43ff0c18 42 /*! @file fsl_osc_hal.h */
mbed_official 146:f64d43ff0c18 43
mbed_official 146:f64d43ff0c18 44 /*******************************************************************************
mbed_official 146:f64d43ff0c18 45 * Definitions
mbed_official 146:f64d43ff0c18 46 ******************************************************************************/
mbed_official 146:f64d43ff0c18 47
mbed_official 146:f64d43ff0c18 48 /*! @brief Oscillator instance.*/
mbed_official 146:f64d43ff0c18 49 typedef enum _osc_instance {
mbed_official 146:f64d43ff0c18 50 kOsc0 = 0, /*!< Oscillator 0*/
mbed_official 146:f64d43ff0c18 51 #if FSL_FEATURE_OSC_HAS_OSC1
mbed_official 146:f64d43ff0c18 52 kOsc1 = 1 /*!< Oscillator 1*/
mbed_official 146:f64d43ff0c18 53 #endif
mbed_official 146:f64d43ff0c18 54 } osc_instance_t;
mbed_official 146:f64d43ff0c18 55
mbed_official 146:f64d43ff0c18 56 /*! @brief Oscillator capacitor load configurations.*/
mbed_official 146:f64d43ff0c18 57 typedef enum _osc_capacitor_config {
mbed_official 146:f64d43ff0c18 58 kOscCapacitor2p = OSC_CR_SC2P_MASK, /*!< 2 pF capacitor load */
mbed_official 146:f64d43ff0c18 59 kOscCapacitor4p = OSC_CR_SC4P_MASK, /*!< 4 pF capacitor load */
mbed_official 146:f64d43ff0c18 60 kOscCapacitor8p = OSC_CR_SC8P_MASK, /*!< 8 pF capacitor load */
mbed_official 146:f64d43ff0c18 61 kOscCapacitor16p = OSC_CR_SC16P_MASK /*!< 16 pF capacitor load */
mbed_official 146:f64d43ff0c18 62 } osc_capacitor_config_t;
mbed_official 146:f64d43ff0c18 63
mbed_official 146:f64d43ff0c18 64 /*! @brief Oscillator capacitor load configurations mask*/
mbed_official 146:f64d43ff0c18 65 #define kOscCapacitorMask (OSC_CR_SC2P_MASK | OSC_CR_SC4P_MASK | OSC_CR_SC8P_MASK | OSC_CR_SC16P_MASK)
mbed_official 146:f64d43ff0c18 66
mbed_official 146:f64d43ff0c18 67
mbed_official 146:f64d43ff0c18 68 /*******************************************************************************
mbed_official 146:f64d43ff0c18 69 * API
mbed_official 146:f64d43ff0c18 70 ******************************************************************************/
mbed_official 146:f64d43ff0c18 71
mbed_official 146:f64d43ff0c18 72 #if defined(__cplusplus)
mbed_official 146:f64d43ff0c18 73 extern "C" {
mbed_official 146:f64d43ff0c18 74 #endif /* __cplusplus*/
mbed_official 146:f64d43ff0c18 75
mbed_official 146:f64d43ff0c18 76 /*! @name oscillator control APIs*/
mbed_official 146:f64d43ff0c18 77 /*@{*/
mbed_official 146:f64d43ff0c18 78
mbed_official 146:f64d43ff0c18 79
mbed_official 146:f64d43ff0c18 80 /*!
mbed_official 146:f64d43ff0c18 81 * @brief Enables the external reference clock for oscillator
mbed_official 146:f64d43ff0c18 82 *
mbed_official 146:f64d43ff0c18 83 * This function enables the external reference clock output
mbed_official 146:f64d43ff0c18 84 * for the oscillator - that is the OSCERCLK. This clock is used
mbed_official 146:f64d43ff0c18 85 * by many peripherals. It should be enabled at an early system initialization
mbed_official 146:f64d43ff0c18 86 * stage to ensure the peripherals could select it and use it.
mbed_official 146:f64d43ff0c18 87 *
mbed_official 146:f64d43ff0c18 88 * @param instance Oscillator instance
mbed_official 146:f64d43ff0c18 89 */
mbed_official 146:f64d43ff0c18 90 void osc_hal_enable_external_reference_clock(osc_instance_t instance);
mbed_official 146:f64d43ff0c18 91
mbed_official 146:f64d43ff0c18 92 /*!
mbed_official 146:f64d43ff0c18 93 * @brief Disables the external reference clock for oscillator.
mbed_official 146:f64d43ff0c18 94 *
mbed_official 146:f64d43ff0c18 95 * This function disables the external reference clock output
mbed_official 146:f64d43ff0c18 96 * for oscillator - that is the OSCERCLK. This clock is used
mbed_official 146:f64d43ff0c18 97 * by many peripherals. It should be enabled at an early system initialization
mbed_official 146:f64d43ff0c18 98 * stage to ensure the peripherals could select and use it.
mbed_official 146:f64d43ff0c18 99 *
mbed_official 146:f64d43ff0c18 100 * @param instance Oscillator instance
mbed_official 146:f64d43ff0c18 101 */
mbed_official 146:f64d43ff0c18 102 void osc_hal_disable_external_reference_clock(osc_instance_t instance);
mbed_official 146:f64d43ff0c18 103
mbed_official 146:f64d43ff0c18 104 /*!
mbed_official 146:f64d43ff0c18 105 * @brief Enables the external reference clock in stop mode.
mbed_official 146:f64d43ff0c18 106 *
mbed_official 146:f64d43ff0c18 107 * This function enables the external reference clock (OSCERCLK) when
mbed_official 146:f64d43ff0c18 108 * MCU enters Stop mode.
mbed_official 146:f64d43ff0c18 109 *
mbed_official 146:f64d43ff0c18 110 * @param instance Oscillator instance
mbed_official 146:f64d43ff0c18 111 */
mbed_official 146:f64d43ff0c18 112 void osc_hal_enable_external_reference_clock_in_stop_mode(osc_instance_t instance);
mbed_official 146:f64d43ff0c18 113
mbed_official 146:f64d43ff0c18 114 /*!
mbed_official 146:f64d43ff0c18 115 * @brief Disables the external reference clock in stop mode.
mbed_official 146:f64d43ff0c18 116 *
mbed_official 146:f64d43ff0c18 117 * This function disables the external reference clock (OSCERCLK) when
mbed_official 146:f64d43ff0c18 118 * MCU enters Stop mode.
mbed_official 146:f64d43ff0c18 119 *
mbed_official 146:f64d43ff0c18 120 * @param instance Oscillator instance
mbed_official 146:f64d43ff0c18 121 */
mbed_official 146:f64d43ff0c18 122 void osc_hal_disable_external_reference_clock_in_stop_mode(osc_instance_t instance);
mbed_official 146:f64d43ff0c18 123
mbed_official 146:f64d43ff0c18 124 /*!
mbed_official 146:f64d43ff0c18 125 * @brief Enables the capacitor configuration for oscillator.
mbed_official 146:f64d43ff0c18 126 *
mbed_official 146:f64d43ff0c18 127 * This function enables the specified capacitors configuration for the
mbed_official 146:f64d43ff0c18 128 * oscillator. This should be done in the early system level initialization function call
mbed_official 146:f64d43ff0c18 129 * based on system configuration.
mbed_official 146:f64d43ff0c18 130 *
mbed_official 146:f64d43ff0c18 131 * @param instance Oscillator instance
mbed_official 146:f64d43ff0c18 132 * @param capacitorConfig Capacitor configurations. Combination of OSC_CR_SCxP_MASK
mbed_official 146:f64d43ff0c18 133 */
mbed_official 146:f64d43ff0c18 134 void osc_hal_enable_capacitor_config(osc_instance_t instance, uint32_t capacitorConfigs);
mbed_official 146:f64d43ff0c18 135
mbed_official 146:f64d43ff0c18 136 /*!
mbed_official 146:f64d43ff0c18 137 * @brief Disables the capacitor configuration for specific oscillator.
mbed_official 146:f64d43ff0c18 138 *
mbed_official 146:f64d43ff0c18 139 * This function enables the specified capacitors configuration for the
mbed_official 146:f64d43ff0c18 140 * oscillator.
mbed_official 146:f64d43ff0c18 141 *
mbed_official 146:f64d43ff0c18 142 * @param instance Oscillator instance
mbed_official 146:f64d43ff0c18 143 * @param capacitorConfig Capacitor configurations. Combination of OSC_CR_SCxP_MASK
mbed_official 146:f64d43ff0c18 144 */
mbed_official 146:f64d43ff0c18 145 void osc_hal_disable_capacitor_config(osc_instance_t instance, uint32_t capacitorConfigs);
mbed_official 146:f64d43ff0c18 146
mbed_official 146:f64d43ff0c18 147 /*@}*/
mbed_official 146:f64d43ff0c18 148
mbed_official 146:f64d43ff0c18 149 #if defined(__cplusplus)
mbed_official 146:f64d43ff0c18 150 }
mbed_official 146:f64d43ff0c18 151 #endif /* __cplusplus*/
mbed_official 146:f64d43ff0c18 152
mbed_official 146:f64d43ff0c18 153 /*! @}*/
mbed_official 146:f64d43ff0c18 154
mbed_official 146:f64d43ff0c18 155 #endif /* __FSL_OSC_HAL_H__*/
mbed_official 146:f64d43ff0c18 156 /*******************************************************************************
mbed_official 146:f64d43ff0c18 157 * EOF
mbed_official 146:f64d43ff0c18 158 ******************************************************************************/
mbed_official 146:f64d43ff0c18 159