/*
 * Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
 * its subsidiaries and affiliates (collectly called MKSEMI).
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into an MKSEMI
 *    integrated circuit in a product or a software update for such product,
 *    must reproduce the above copyright notice, this list of conditions and
 *    the following disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. Neither the name of MKSEMI nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    MKSEMI integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be
 *    reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL MKSEMI OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef MK_CALIB_H_
#define MK_CALIB_H_
#include "mk_common.h"

/**
 * @addtogroup MK8000_Calibration
 * @{
 */

/** Start calibration */
#define CALIB_START (1U << 31)
/** Power on calibrate REFPLL */
#define CALIB_PO_REFPLL_EN (1U << 0)

/** Calibration done */
#define CALIB_CAL_DONE (1U << 31)
/** REFPLL Calibration done */
#define CALIB_REFPLL_DONE (1U << 0)

/** Calibration base address */
#define CALIB_BASE (APB_BASE + 0x6000)

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Function for initializing the calibration.
 *
 * @return
 *         @arg DEV_OK      succeed
 */
int calib_open(void);

/**
 * @brief Function for uninitializing the calibration.
 *
 * @return
 *         @arg DEV_OK       succeed
 */
int calib_close(void);

/**
 * @brief Start calibration.
 *
 * @param[in] items         Specified items to do calibration
 */
void calib_start(uint32_t items);

/**
 * @brief Check calibration done.
 *
 * @param[in] done          Calibration done flag to be checked
 */
void calib_check(uint32_t done);

/**
 * @brief Chip Calibration.
 */
void calib_chip(void);

/**
 * @brief Tuning load cap automatically based on frequency offset, this function should be called repeatedly.
 *
 * @param[in] ppm           Frequency offset
 */
void calib_xtal38m4_load_cap_auto_tune(int32_t ppm);

/**
 * @brief Set XTAL 38.4MHz load cap.
 *
 * @param[in] val           Load cap value to be set
 */
void calib_xtal38m4_load_cap_set(uint8_t val);

/**
 * @brief Set XTAL 32KHz load cap.
 *
 * @param[in] val           Load cap value (0x0 ~ 0x7F) to be set
 */
void calib_xtal32k_load_cap_set(uint8_t val);

/**
 * @brief Set XTAL 38.4MHz load cap and output clock at GPIO17.
 *
 * @param[in] val           Load cap value (0x0 ~ 0x7F) to be set
 */
void calib_xtal38m4_with_clock_out(uint8_t val);

/**
 * @brief Set XTAL 32KHz load cap and output clock at GPIO02.
 *
 * @param[in] val           Load cap value (0x0 ~ 0x7F) to be set
 */
void calib_xtal32k_with_clock_out(uint8_t val);

/**
 * @brief Function for Interrupt handler for Calibration.
 */
void CALIB_IRQHandler(void);

#ifdef __cplusplus
}
#endif

/**
 * @}
 */

#endif /* MK_CALIB_H_ */