rtems/rtl/rtl-shell.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  *  COPYRIGHT (c) 2012 Chris Johns <chrisj@rtems.org>
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027 /**
0028  * @file
0029  *
0030  * @ingroup rtems_rtl
0031  *
0032  * @brief RTEMS Run-Time Linker ELF Shell Support.
0033  */
0034
0035 #if !defined (_RTEMS_RTL_SHELL_H_)
0036 #define _RTEMS_RTL_SHELL_H_
0037
0038 #include <rtems/print.h>
0039
0040 #ifdef __cplusplus
0041 extern "C" {
0042 #endif /* __cplusplus */
0043
0044 /**
0045  * The RTL single shell command contains sub-commands.
0046  *
0047  * @param argc The argument count.
0048  * @param argv Array of argument strings.
0049  * @retval 0 No error.
0050  * @return int The exit code.
0051  */
0052 int rtems_rtl_shell_command (int argc, char* argv[]);
0053
0054 /**
0055  * List object files.
0056  */
0057 int rtems_rtl_shell_list (const rtems_printer* printer, int argc, char* argv[]);
0058
0059 /**
0060  * Symbols.
0061  */
0062 int rtems_rtl_shell_sym (const rtems_printer* printer, int argc, char* argv[]);
0063
0064 /**
0065  * Object files.
0066  */
0067 int rtems_rtl_shell_object (const rtems_printer* printer, int argc, char* argv[]);
0068
0069
0070 /**
0071  * Archive files.
0072  */
0073 int rtems_rtl_shell_archive (const rtems_printer* printer, int argc, char* argv[]);
0074
0075 /**
0076  * Call text symbol.
0077  */
0078 int rtems_rtl_shell_call (const rtems_printer* printer, int argc, char* argv[]);
0079
0080 #ifdef __cplusplus
0081 }
0082 #endif /* __cplusplus */
0083
0084 #endif