/*********************************************************************
 *                
 * Copyright (C) 2002-2004, 2007-2008,  Karlsruhe University
 *                
 * File path:     glue/v4-x86/debug.h
 * Description:   x86 debugging support
 *                
 * 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.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR 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.
 *                
 * $Id: debug.h,v 1.8.4.3 2006/12/05 15:53:45 skoglund Exp $
 *                
 ********************************************************************/
#ifndef __GLUE__X86__DEBUG_H__
#define __GLUE__X86__DEBUG_H__

#include INC_ARCH(trapgate.h)
#include INC_ARCH(atomic.h)
#include INC_GLUE(config.h)

#if defined(CONFIG_DEBUG)

#include <kdb/tracepoints.h>

#define DEBUG_SCREEN (KERNEL_OFFSET + 0xb8000)
#define KDB_STACK_SIZE	KTCB_SIZE

INLINE void spin_forever(int pos = 0)
{
#if defined(CONFIG_SPIN_WHEELS)
    while(1)
	    ((u16_t*)(DEBUG_SCREEN))[pos] += 1;
#else /* defined(CONFIG_SPIN_WHEELS) */
    int dummy = 0;
    while(1)
	    dummy = (dummy + 1) % 32;
#endif /* defined(CONFIG_SPIN_WHEELS) */
}

class space_t;
class tcb_t;

class debug_param_t 
{
   
public:
    word_t exception;
    space_t * space;
    tcb_t * tcb;
    x86_exceptionframe_t * frame;
};

INLINE void spin(int pos, int cpu = 0)
{
#if defined(CONFIG_SPIN_WHEELS)
    ((u8_t*)(DEBUG_SCREEN))[(cpu * 160) + pos * 2] += 1;
    ((u8_t*)(DEBUG_SCREEN))[(cpu * 160) + pos * 2 + 1] = 7;
#endif /* defined(CONFIG_SPIN_WHEELS) */
}

#define enter_kdebug(arg...)                    \
    __asm__ __volatile__ (                      \
            "   int $3                  \n"     \
            "   jmp 1f                  \n"     \
            "   mov $2f, %0             \n"     \
            ".section .rodata           \n"     \
            "2:.ascii \"KD# " arg "\"   \n"     \
            ".byte 0                    \n"     \
            ".previous                  \n"     \
            "1:                         \n"     \
            :                                   \
            : "a" (0UL))

extern void do_enter_kdebug(x86_exceptionframe_t *frame, const word_t exception);

enum x86_breakpoint_type_e {
    x86_bp_instr =  0x00000000,
    x86_bp_write =  0x00010000,
    x86_bp_port  =  0x00020000,
    x86_bp_access = 0x00030000
};

extern void x86_set_kdb_dr(word_t num, x86_breakpoint_type_e type, word_t addr, bool enable, bool kdb);

extern "C" void x86_reset(void);
extern bool x86_reboot_scheduled;



#else
#define x86_dump_frame(x...)	do { } while (true)
#define x86_dump_flags(x...)	do { } while (true)

#endif /* defined(CONFIG_DEBUG) */

#endif /* !__GLUE__X86__DEBUG_H__ */