/*****************************************************************************
 *
 * \file
 *
 * \brief Macros and functions dedicated to debug purposes.
 *
 * Copyright (c) 2009-2012 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 _DEBUG_H_
#define _DEBUG_H_

/**
 * \defgroup group_avr32_utils_debug Debug macros and functions
 *
 * Debug macros and functions for tracing memory usage for the malloc() and free() functions. Can also be used to get
 * information about both size and placement of the heap memory.
 *
 * \{
 */

#include "stringz.h"

/*! \brief These macros are used to add traces memory.
 *
 * First, initialize the trace with Uc3_trace_init(pointer), giving the start address
 * of the memory location where will be stored the trace.
 * Use Uc3_trace(something) to store "something" into the memory. The end of the trace
 * is signalled by the "0xdeadbeef" pattern.
 */
#define Uc3_trace_init(debug_addr)   \
      *(U32*)(debug_addr)=debug_addr+4

#define Uc3_trace(debug_addr, x)   \
      *(U32*)(*(U32*)(debug_addr)  ) = (U32)(x)   ;\
      *(U32*)(*(U32*)(debug_addr)+4) = 0xdeadbeef ;\
      *(U32*)(debug_addr  ) = *(U32*)(debug_addr)+4

/*! \brief This macro is used to insert labels into assembly output.
 *
 */
#define Insert_label(name)         \
    __asm__ __volatile__ (STRINGZ(name)":");

#if (defined __GNUC__)
/*! \brief Returns the number of total of used bytes allocated from the HEAP.
 *
 * \retval total number of used bytes.
 */
U32 get_heap_total_used_size( void );

/*! \brief Returns the number of bytes currently used from the HEAP.
 *
 * \retval total number of used bytes.
 */
U32 get_heap_curr_used_size( void );
#endif

/*! \brief Returns the number of free bytes in the HEAP.
 *
 * This function tries to allocate the maximum number of bytes by dichotomical method.
 *
 * \retval number of free bytes.
 */
extern U32 get_heap_free_size( void );

/*! \name Traces function using a round buffer
 */
//! @{

/*! \brief Initialize the trace using a round buffer.
 *
 * \param buf   Base address of the buffer used for the trace.
 * \param size  Size of the round buffer. Must be a power of 2.
 */
void uc3_round_trace_init(void* buf, U32 size);

/*! \brief Trace a data in the round buffer.
 *
 * The end of the trace is signalled by the "0xdeadbeef" pattern.
 * \param val   Data to trace;
 */
void uc3_round_trace(U32 val);

//! @}

/**
 * \}
 */

#endif  // _DEBUG_H_
