/**
 * \file
 *
 * \brief 32-bit NLMS filtering
 *
 * Copyright (c) 2011 Atmel Corporation. All rights reserved.
 *
 * \asf_license_start
 *
 * 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
 *
 */

/**
 * \defgroup group_avr32_services_dsplib_simulator_example_dsp32_nlms DSPLIB - 32-bit fixed-point NLMS filter example
 * \section intro Introduction
 * This example demonstrates a way to use the 32-bit NLMS Filter function.\n
 * To visualize the result, you may set a breakpoint after the sprintf and
 * check the string variable output through Watch Window in AVR Studio 5.
 * Through this page, you can access the \ref group_dsplib documentation.
 *
 * \section files Main Files
 * - nlms_example.c : DSPLIB NLMS Filter example
 * - conf_board.h: Simulator configuration for example
 * - conf_clock.h: Clock configuration for example
 *
 * \section compinfo Compilation Info
 * This software was written for the GNU GCC for AVR32.
 *
 * \section configinfo Configuration Information
 * This example has been tested with the following configuration:
 * - AVR Simulator
 * - CPU clock: <i> Internal RC oscillator (about 115200 Hz) </i>.
 *
 * \section contactinfo Contact Information
 * For further information, visit
 * <A href="http://www.atmel.com/products/AVR32/">Atmel AVR32</A>.\n
 */

#include <avr32/io.h>

#include "compiler.h"
#include "board.h"

#include "dsp.h"
#include "dsp_debug.h"

#include "sysclk.h"
#include "cycle_counter.h"

//! The size of the input signal
#define SIZE  64

//! Buffer containing input data
A_ALIGNED dsp32_t input_x[SIZE] = {
	DSP32_Q(0.00000000000),
	DSP32_Q(0.03718075139),
	DSP32_Q(0.07131184859),
	DSP32_Q(0.09963983090),
	DSP32_Q(0.11997464035),
	DSP32_Q(0.13090169944),
	DSP32_Q(0.13191810690),
	DSP32_Q(0.12347962859),
	DSP32_Q(0.10695389264),
	DSP32_Q(0.08448437894),
	DSP32_Q(0.05877852523),
	DSP32_Q(0.03284069954),
	DSP32_Q(0.00967618536),
	DSP32_Q(-0.00800483670),
	DSP32_Q(-0.01805432735),
	DSP32_Q(-0.01909830056),
	DSP32_Q(-0.01067285908),
	DSP32_Q(0.00672896857),
	DSP32_Q(0.03170418002),
	DSP32_Q(0.06207594915),
	DSP32_Q(0.09510565163),
	DSP32_Q(0.12776001555),
	DSP32_Q(0.15700725030),
	DSP32_Q(0.18011316957),
	DSP32_Q(0.19490832447),
	DSP32_Q(0.20000000000),
	DSP32_Q(0.19490832447),
	DSP32_Q(0.18011316957),
	DSP32_Q(0.15700725030),
	DSP32_Q(0.12776001555),
	DSP32_Q(0.09510565163),
	DSP32_Q(0.06207594915),
	DSP32_Q(0.03170418002),
	DSP32_Q(0.00672896857),
	DSP32_Q(-0.01067285908),
	DSP32_Q(-0.01909830056),
	DSP32_Q(-0.01805432735),
	DSP32_Q(-0.00800483670),
	DSP32_Q(0.00967618536),
	DSP32_Q(0.03284069954),
	DSP32_Q(0.05877852523),
	DSP32_Q(0.08448437894),
	DSP32_Q(0.10695389264),
	DSP32_Q(0.12347962859),
	DSP32_Q(0.13191810690),
	DSP32_Q(0.13090169944),
	DSP32_Q(0.11997464035),
	DSP32_Q(0.09963983090),
	DSP32_Q(0.07131184859),
	DSP32_Q(0.03718075139),
	DSP32_Q(0.00000000000),
	DSP32_Q(-0.03718075139),
	DSP32_Q(-0.07131184859),
	DSP32_Q(-0.09963983090),
	DSP32_Q(-0.11997464035),
	DSP32_Q(-0.13090169944),
	DSP32_Q(-0.13191810690),
	DSP32_Q(-0.12347962859),
	DSP32_Q(-0.10695389264),
	DSP32_Q(-0.08448437894),
	DSP32_Q(-0.05877852523),
	DSP32_Q(-0.03284069954),
	DSP32_Q(-0.00967618536),
	DSP32_Q(0.00800483670)
};

//! Buffer containing filtered input data
A_ALIGNED dsp32_t input_d[SIZE] = {
	DSP32_Q(0.0000),
	DSP32_Q(0.0005),
	DSP32_Q(0.0017),
	DSP32_Q(0.0045),
	DSP32_Q(0.0100),
	DSP32_Q(0.0191),
	DSP32_Q(0.0320),
	DSP32_Q(0.0480),
	DSP32_Q(0.0655),
	DSP32_Q(0.0823),
	DSP32_Q(0.0960),
	DSP32_Q(0.1043),
	DSP32_Q(0.1061),
	DSP32_Q(0.1014),
	DSP32_Q(0.0907),
	DSP32_Q(0.0756),
	DSP32_Q(0.0581),
	DSP32_Q(0.0403),
	DSP32_Q(0.0245),
	DSP32_Q(0.0127),
	DSP32_Q(0.0064),
	DSP32_Q(0.0066),
	DSP32_Q(0.0137),
	DSP32_Q(0.0272),
	DSP32_Q(0.0463),
	DSP32_Q(0.0692),
	DSP32_Q(0.0940),
	DSP32_Q(0.1183),
	DSP32_Q(0.1401),
	DSP32_Q(0.1573),
	DSP32_Q(0.1683),
	DSP32_Q(0.1721),
	DSP32_Q(0.1683),
	DSP32_Q(0.1573),
	DSP32_Q(0.1401),
	DSP32_Q(0.1183),
	DSP32_Q(0.0940),
	DSP32_Q(0.0692),
	DSP32_Q(0.0463),
	DSP32_Q(0.0272),
	DSP32_Q(0.0137),
	DSP32_Q(0.0066),
	DSP32_Q(0.0064),
	DSP32_Q(0.0127),
	DSP32_Q(0.0245),
	DSP32_Q(0.0403),
	DSP32_Q(0.0581),
	DSP32_Q(0.0756),
	DSP32_Q(0.0907),
	DSP32_Q(0.1014),
	DSP32_Q(0.1061),
	DSP32_Q(0.1039),
	DSP32_Q(0.0943),
	DSP32_Q(0.0778),
	DSP32_Q(0.0555),
	DSP32_Q(0.0289),
	DSP32_Q(0.0000),
	DSP32_Q(-0.0289),
	DSP32_Q(-0.0555),
	DSP32_Q(-0.0778),
	DSP32_Q(-0.0943),
	DSP32_Q(-0.1039),
	DSP32_Q(-0.1061),
	DSP32_Q(-0.1014)
};

#define FIR_COEF_SIZE   12
A_ALIGNED dsp32_t unknown_coef_filter[FIR_COEF_SIZE] = {
	DSP32_Q(0.0132),
	DSP32_Q(0.0254),
	DSP32_Q(0.0579),
	DSP32_Q(0.1006),
	DSP32_Q(0.1398),
	DSP32_Q(0.1632),
	DSP32_Q(0.1632),
	DSP32_Q(0.1398),
	DSP32_Q(0.1006),
	DSP32_Q(0.0579),
	DSP32_Q(0.0254),
	DSP32_Q(0.0132)
};

A_ALIGNED dsp32_t x[FIR_COEF_SIZE];

//! Coefficients of the filter
A_ALIGNED dsp32_t w[FIR_COEF_SIZE];

//! The main function
int main(int argc, char *argv[])
{
	dsp32_t sample_x,sample_d;
	dsp32_t y, e;
	int i;
	char nlms_vect_result[FIR_COEF_SIZE][15];

	/**
	 * \note the call to sysclk_init() will disable all non-vital
	 * peripheral clocks, except for the peripheral clocks explicitly
	 * enabled in conf_clock.h.
	 */
	sysclk_init();

		// Initialize the DSP debug USART module when running in external board
#if BOARD != AVR_SIMULATOR_UC3
	dsp_debug_initialization(FOSC0);
#endif

	// Initialisation of the buffers
	for (i = 0; i < FIR_COEF_SIZE; i++) {
		w[i] = 0;
		x[i] = 0;
	}

	for (i = 0; i < SIZE; i++) {
		// Compute a new sample
		sample_x = input_x[i];
		sample_d = input_d[i];
		// Compute the NLMS filter
		dsp32_filt_nlms(x, w, FIR_COEF_SIZE, sample_x, sample_d, &y, &e);
	}

	// Print the  output signal
	for (i = 0; i < FIR_COEF_SIZE; i++) {
		dsp32_debug_sprintf(nlms_vect_result[i],"%f", w[i]);
	}
	/*
	 * Place a breakpoint here and check the ASCII output in nlms_vect_result
	 * in Memory Window.
	 * Note: Find the variable address in Watch Window and enter it in
	 * Memory Window
	 */
	while (1) {
		// Intentionally left blank.
	}
}
