include/rtems/rtems-rfs-shell.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup rtems_rfs
0007  * @brief RTEMS File Systems Shell Commands
0008  *
0009  * RTEMS File Systems Shell commands provide a CLI interface to support and
0010  * development of the RFS file system.
0011  */
0012
0013 /*
0014  *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #if !defined (_RTEMS_RFS_SHELL_H_)
0039 #define _RTEMS_RFS_SHELL_H_
0040
0041 #include <stddef.h>
0042 #include <stdbool.h>
0043 #include <stdint.h>
0044
0045 /**
0046  * The shell command for the RFS debugger.
0047  *
0048  * @param[in] argc is the argument count.
0049  * @param[in] argv is a pointer to the argument variables.
0050  *
0051  * @retval 0 Successful operation.
0052  * @retval error_code An error occurred.
0053  */
0054 int rtems_shell_debugrfs (int argc, char *argv[]);
0055
0056 /**
0057  * The shell command for formatting an RFS file system.
0058  *
0059  * @param[in] argc is the argument count.
0060  * @param[in] argv is a pointer to the argument variables.
0061  *
0062  * @retval 0 Successful operation.
0063  * @retval 1 An error occurred.
0064  */
0065 int rtems_shell_rfs_format (int argc, char* argv[]);
0066
0067 #endif