rtems/debugger/rtems-debugger-remote.h

0001 /*
0002  * Copyright (c) 2016 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 for RTEMS.
0029  */
0030
0031 #ifndef _RTEMS_DEBUGGER_REMOTE_h
0032 #define _RTEMS_DEBUGGER_REMOTE_h
0033
0034 #include <rtems/rtems-debugger.h>
0035 #include <rtems/debugger/rtems-debugger-server.h>
0036
0037 #ifdef __cplusplus
0038 extern "C" {
0039 #endif /* __cplusplus */
0040
0041 /**
0042  * Debugger remote.
0043  */
0044 struct rtems_debugger_remote
0045 {
0046   const char* name;
0047   int         (*begin)(rtems_debugger_remote* remote, const char* device);
0048   int         (*end)(rtems_debugger_remote* remote);
0049   int         (*connect)(rtems_debugger_remote* remote);
0050   int         (*disconnect)(rtems_debugger_remote* remote);
0051   bool        (*isconnected)(rtems_debugger_remote* remote);
0052   ssize_t     (*read)(rtems_debugger_remote* remote, void* buf, size_t nbytes);
0053   ssize_t     (*write)(rtems_debugger_remote* remote, const void* buf, size_t nbytes);
0054   void*       data;
0055 };
0056
0057 /**
0058  * Register a remote with the server.
0059  */
0060 int rtems_debugger_remote_register(rtems_debugger_remote* remote);
0061
0062 /**
0063  * Find a remote by name.
0064  */
0065 rtems_debugger_remote* rtems_debugger_remote_find(const char* name);
0066
0067 #ifdef __cplusplus
0068 }
0069 #endif /* __cplusplus */
0070
0071
0072 #endif