source: rtems/cpukit/libdebugger/rtems-debugger.h @ b53ad46

Last change on this file since b53ad46 was a0d4e99, checked in by Chris Johns <chrisj@…>, on Nov 25, 2016 at 4:13:36 AM

cpukit: Add libdebugger, a remote debugger agent for GDB.

  • Property mode set to 100644
File size: 2.3 KB
Line 
1/*
2 * Copyright (c) 2016 Chris Johns <chrisj@rtems.org>.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 */
25
26/*
27 * Debugger for RTEMS.
28 */
29
30#ifndef _RTEMS_DEBUGGER_h
31#define _RTEMS_DEBUGGER_h
32
33#include <stdbool.h>
34
35#include <rtems.h>
36#include <rtems/printer.h>
37
38#ifdef __cplusplus
39extern "C" {
40#endif /* __cplusplus */
41
42/**
43 * Timeout period for an ack
44 */
45#define RTEMS_DEBUGGER_TIMEOUT (3)
46
47/**
48 * Start the Debugger.
49 */
50extern int rtems_debugger_start(const char*          remote,
51                                const char*          device,
52                                int                  timeout,
53                                rtems_task_priority  priority,
54                                const rtems_printer* printer);
55
56/**
57 * Stop the Debugger.
58 */
59extern int rtems_debugger_stop(void);
60
61/**
62 * Is the Debugger running?.
63 */
64extern bool rtems_debugger_running(void);
65
66/**
67 * Verbose control.
68 */
69extern void rtems_debugger_set_verbose(bool on);
70
71/**
72 * Control remote debug printing.
73 */
74extern int rtems_debugger_remote_debug(bool state);
75
76#ifdef __cplusplus
77}
78#endif /* __cplusplus */
79
80
81#endif
Note: See TracBrowser for help on using the repository browser.