135 lines
4.6 KiB
C
135 lines
4.6 KiB
C
|
/*
|
||
|
|
* Copyright (c) 2013 - 2015, Freescale Semiconductor, Inc.
|
||
|
|
* Copyright 2016-2020 NXP
|
||
|
|
* All rights reserved.
|
||
|
|
*
|
||
|
|
* NXP Confidential. This software is owned or controlled by NXP and may only be
|
||
|
|
* used strictly in accordance with the applicable license terms. By expressly
|
||
|
|
* accepting such terms or by downloading, installing, activating and/or otherwise
|
||
|
|
* using the software, you are agreeing that you have read, and that you agree to
|
||
|
|
* comply with and are bound by, such license terms. If you do not agree to be
|
||
|
|
* bound by the applicable license terms, then you may not retain, install,
|
||
|
|
* activate or otherwise use the software. The production use license in
|
||
|
|
* Section 2.3 is expressly granted for this software.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#if !defined(CLOCK_H)
|
||
|
|
#define CLOCK_H
|
||
|
|
|
||
|
|
#include "device_registers.h"
|
||
|
|
#include "status.h"
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Include the cpu specific clock API header files.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#if (defined(S32K14x_SERIES) || defined(S32K11x_SERIES))
|
||
|
|
/* S32K144 Clock System Level API header file */
|
||
|
|
#include "../src/clock/S32K1xx/clock_S32K1xx.h"
|
||
|
|
#elif (defined(S32MTV_SERIES))
|
||
|
|
/* S32MTV Clock System Level API header file */
|
||
|
|
#include "../src/clock/S32Mxx/clock_S32Mxx.h"
|
||
|
|
#elif (defined(MPC5777C_SERIES))
|
||
|
|
/* MPC5777C Clock System Level API header file */
|
||
|
|
#include "../src/clock/MPC5777C/clock_MPC5777C.c"
|
||
|
|
#elif (defined(MPC574x_SERIES) || defined(S32R_SERIES))
|
||
|
|
/* MPC574x Clock System Level API header file */
|
||
|
|
#include "../src/clock/MPC57xx/clock_MPC57xx.h"
|
||
|
|
#elif (defined(S32S247_SERIES))
|
||
|
|
/* S32S247 Clock System Level API header file */
|
||
|
|
#include "../src/clock/S32Sxx/clock_S32Sxx.h"
|
||
|
|
#elif (defined(SJA1110_SERIES))
|
||
|
|
/* SJA1110 Clock System Level API header file */
|
||
|
|
#include "../src/clock/SJA1110x/clock_SJA1110x.h"
|
||
|
|
#elif (defined(S32V234_SERIES))
|
||
|
|
/* S32Vxx Clock System Level API header file */
|
||
|
|
#include "../src/clock/S32Vxx/clock_S32Vxx.h"
|
||
|
|
#else
|
||
|
|
#error "No valid CPU defined!"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @file clock.h
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*! @addtogroup clock*/
|
||
|
|
/*! @{*/
|
||
|
|
|
||
|
|
/*******************************************************************************
|
||
|
|
* Definitions
|
||
|
|
******************************************************************************/
|
||
|
|
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
extern "C" {
|
||
|
|
#endif /* __cplusplus*/
|
||
|
|
|
||
|
|
/*******************************************************************************
|
||
|
|
* API
|
||
|
|
******************************************************************************/
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @name Dynamic clock setting
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*******************************************************************************
|
||
|
|
* API
|
||
|
|
******************************************************************************/
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief Gets the clock frequency for a specific clock name.
|
||
|
|
*
|
||
|
|
* This function checks the current clock configurations and then calculates
|
||
|
|
* the clock frequency for a specific clock name defined in clock_names_t.
|
||
|
|
* Clock modules must be properly configured before using this function.
|
||
|
|
* See features.h for supported clock names for different chip families.
|
||
|
|
* The returned value is in Hertz. If it cannot find the clock name
|
||
|
|
* or the name is not supported for a specific chip family, it returns an
|
||
|
|
* STATUS_UNSUPPORTED. If frequency is required for a peripheral and the
|
||
|
|
* module is not clocked, then STATUS_MCU_GATED_OFF status is returned.
|
||
|
|
* Frequency is returned if a valid address is provided. If frequency is
|
||
|
|
* required for a peripheral that doesn't support protocol clock, the zero
|
||
|
|
* value is provided.
|
||
|
|
*
|
||
|
|
* @param[in] clockName Clock names defined in clock_names_t
|
||
|
|
* @param[out] frequency Returned clock frequency value in Hertz
|
||
|
|
* @return status Error code defined in status_t
|
||
|
|
*/
|
||
|
|
status_t CLOCK_DRV_GetFreq(clock_names_t clockName,
|
||
|
|
uint32_t *frequency);
|
||
|
|
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief Set clock configuration according to pre-defined structure.
|
||
|
|
*
|
||
|
|
* This function sets system to target clock configuration; It sets the
|
||
|
|
* clock modules registers for clock mode change.
|
||
|
|
*
|
||
|
|
* @param[in] config Pointer to configuration structure.
|
||
|
|
*
|
||
|
|
* @return Error code.
|
||
|
|
*
|
||
|
|
* @note If external clock is used in the target mode, please make sure it is
|
||
|
|
* enabled, for example, if the external oscillator is used, please setup correctly.
|
||
|
|
*
|
||
|
|
* @note If the configuration structure is NULL, the function will set a default
|
||
|
|
* configuration for clock.
|
||
|
|
*/
|
||
|
|
status_t CLOCK_DRV_Init(clock_user_config_t const * config);
|
||
|
|
|
||
|
|
/*! @} */
|
||
|
|
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
}
|
||
|
|
#endif /* __cplusplus*/
|
||
|
|
|
||
|
|
/*! @}*/
|
||
|
|
|
||
|
|
#endif /* CLOCK_H */
|
||
|
|
/*******************************************************************************
|
||
|
|
* EOF
|
||
|
|
******************************************************************************/
|
||
|
|
|