rtems/debugger/rtems-debugger-bsp.h

0001 /*
0002  * Copyright (c) 2019 Chris Johns <chrisj@rtems.org>.
0003  * All rights reserved.
0004  *
0005  * Redistribution and use in source and binary forms, with or without
0006  * modification, are permitted provided that the following conditions
0007  * are met:
0008  * 1. Redistributions of source code must retain the above copyright
0009  *    notice, this list of conditions and the following disclaimer.
0010  * 2. Redistributions in binary form must reproduce the above copyright
0011  *    notice, this list of conditions and the following disclaimer in the
0012  *    documentation and/or other materials provided with the distribution.
0013  *
0014  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
0015  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0016  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0017  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
0018  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
0019  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
0020  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
0021  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
0022  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
0023  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
0024  * SUCH DAMAGE.
0025  */
0026
0027 /*
0028  * Debugger BSP support.
0029  */
0030
0031 #ifndef _RTEMS_DEBUGGER_BSP_h
0032 #define _RTEMS_DEBUGGER_BSP_h
0033
0034 #include <rtems/rtems-debugger.h>
0035
0036 #ifdef __cplusplus
0037 extern "C" {
0038 #endif /* __cplusplus */
0039
0040 /**
0041  * ARM
0042  */
0043
0044 /**
0045  * Debug registers
0046  *
0047  * Return the debugger registers for you BSP if the SoC requires memory mapped
0048  * registers and the DBGDRAR and DBGDSAR are not support or return 0. This
0049  * function is provided in the ARM backend and declared weak.
0050  */
0051 void* rtems_debugger_arm_debug_registers(void);
0052
0053 /**
0054  * Configure the debug interface.
0055  *
0056  * Some ARM devices need special configurations to enable the debugging
0057  * hardware. The device are often locked down for securty reasons and
0058  * the debug hardware in the ARM needs to be enabled (asserting DBGEN).
0059  */
0060 bool rtems_debugger_arm_debug_configure(void);
0061
0062 #ifdef __cplusplus
0063 }
0064 #endif /* __cplusplus */
0065
0066 #endif