/**
 * \file
 *
 * \brief Oscillator Frequency detection
 *
 * Copyright (c) 2011 Atmel Corporation. All rights reserved.
 *
 * \asf_license_start
 *
 * \page License
 *
 * 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 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. The name of Atmel may not be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an
 *    Atmel microcontroller product.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
 *
 * \asf_license_stop
 *
 */

#ifndef _FREQ_DETECT_H_
#define _FREQ_DETECT_H_

/**
 * \defgroup group_avr32_services_freq_detect External oscillator frequency detection
 *
 * A software service to estimate an oscillator frequency using a known oscillator (external or internal) as a reference.
 *
 * \{
 */

/*! \name External routine used to detect frequency
 */
//! \{
  //! Callback used to reset the counter of the reference's oscillator.
extern void freq_detect_iface_ref_cnt_reset(void);
  //! Callback used to read the counter value of the reference's oscillator.
extern int freq_detect_iface_ref_cnt_value(void);
  //! Callback used to reset the counter of the target oscillator.
extern void freq_detect_iface_target_cnt_reset(void);
  //! Callback used to read the counter value of the target oscillator.
extern int freq_detetc_iface_target_cnt_value(void);
//! \}

/*! \brief Detects the frequency
 *
 * \return The frequency in Hz or 0 if no detection.
 *
 */
uint32_t freq_detect_start(void);

/**
 * \}
 */

#endif //_FREQ_DETECT_H_
