summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems-rfs-shell.h
blob: c2e1108a479bcd9ae7c0d6f063438d323b067124 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/**
 * @file
 * 
 * @ingroup rtems_rfs
 * @brief RTEMS File Systems Shell Commands
 *
 * RTEMS File Systems Shell commands provide a CLI interface to support and
 * development of the RFS file system.
 */

/*
 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#if !defined (_RTEMS_RFS_SHELL_H_)
#define _RTEMS_RFS_SHELL_H_

#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>

/**
 * The shell command for the RFS debugger.
 *
 * @param[in] argc is the argument count.
 * @param[in] argv is a pointer to the argument variables.
 *
 * @retval 0 Successful operation.
 * @retval error_code An error occurred.
 */
int rtems_shell_debugrfs (int argc, char *argv[]);

/**
 * The shell command for formatting an RFS file system.
 *
 * @param[in] argc is the argument count.
 * @param[in] argv is a pointer to the argument variables.
 *
 * @retval 0 Successful operation.
 * @retval 1 An error occurred.
 */
int rtems_shell_rfs_format (int argc, char* argv[]);

#endif