Files
Sebastian Huber 3b061c5c44 cpukit/libmisc: Write the Doxygen briefs
The briefs of the libmisc files named a topic, not the content of the
file.  Four shell briefs named the wrong command.  The file
main_blksync.c said "RM Shell Command Implementation".  The files
main_id.c, main_time.c and shellconfig.c named ls and debugrfs.  Four
string conversion sources named the conversion, for example "Convert
String to Unsigned Long".

Write every brief in the style of the tree.  A source brief starts with
"This source file contains".  A command brief names the command the file
provides.  A header brief starts with "This header file provides".  Put
@file, @ingroup and @brief in this order in every block.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
2026-09-01 20:17:20 +00:00

191 lines
5.3 KiB
C

/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplShellCommands
*
* @brief This source file contains the msdosfmt shell command.
*/
/*
* COPYRIGHT (c) 2007.
* Chris Johns (chrisj@rtems.org)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <inttypes.h>
#include <rtems.h>
#include <rtems/shell.h>
#include <rtems/stringto.h>
#include <rtems/shellconfig.h>
#include <rtems/dosfs.h>
#include <rtems/fsmount.h>
#include "internal.h"
static int rtems_shell_main_msdos_format(
int argc,
char *argv[]
)
{
msdos_format_request_param_t rqdata = {
.OEMName = "RTEMS",
.VolLabel = "RTEMSDisk",
.sectors_per_cluster = 0,
.fat_num = 0,
.files_per_root_dir = 0,
.media = 0,
.quick_format = TRUE,
.skip_alignment = 0,
.info_level = 0
};
unsigned long tmp;
const char* driver = NULL;
int arg;
for (arg = 1; arg < argc; arg++) {
if (argv[arg][0] == '-') {
switch (argv[arg][1]) {
case 'V':
arg++;
if (arg == argc) {
fprintf (stderr, "error: no volume label.\n");
return 1;
}
rqdata.VolLabel = argv[arg];
break;
case 's':
arg++;
if (arg == argc) {
fprintf (stderr, "error: sectors per cluster count.\n");
return 1;
}
if ( rtems_string_to_unsigned_long(argv[arg], &tmp, NULL, 0) ) {
printf(
"sector per cluster argument (%s) is not a number\n",
argv[arg]
);
return -1;
}
rqdata.sectors_per_cluster = (uint32_t) tmp;
break;
case 'r':
arg++;
if (arg == argc) {
fprintf (stderr, "error: no root directory size.\n");
return 1;
}
if ( rtems_string_to_unsigned_long(argv[arg], &tmp, NULL, 0) ) {
printf(
"root directory size argument (%s) is not a number\n",
argv[arg]
);
return -1;
}
rqdata.files_per_root_dir = (uint32_t) tmp;
break;
case 'v':
rqdata.info_level++;
break;
default:
fprintf (stderr, "error: invalid option: %s\n", argv[arg]);
return 1;
}
} else {
if (!driver)
driver = argv[arg];
else {
fprintf (stderr, "error: only one driver allowed: %s\n", argv[arg]);
return 1;
}
}
}
if (!driver) {
fprintf (stderr, "error: no driver\n");
return 1;
}
printf ("msdos format: %s\n", driver);
if (rqdata.info_level)
{
printf (" %-20s: %s\n", "OEMName", "RTEMS");
printf (" %-20s: %s\n", "VolLabel", "RTEMSDisk");
printf (" %-20s: %" PRIu32 "\n", "sectors per cluster", rqdata.sectors_per_cluster);
printf (" %-20s: %" PRIu32 "\n", "fats", rqdata.fat_num);
printf (" %-20s: %" PRIu32 "\n", "files per root dir", rqdata.files_per_root_dir);
printf (" %-20s: %d\n", "media", rqdata.media);
printf (" %-20s: %d\n", "quick_format", rqdata.quick_format);
printf (" %-20s: %s\n", "skip_alignment", (0 == rqdata.skip_alignment) ? "false" : "true");
}
if (msdos_format (driver, &rqdata) < 0) {
fprintf (stderr, "error: format failed: %s\n", strerror (errno));
return 1;
}
printf ("msdos format successful\n");
return 0;
}
#define OPTIONS "[-V label] [-s sectors/cluster] [-r size] [-v]"
rtems_shell_cmd_t rtems_shell_MSDOSFMT_Command = {
.name = "mkdos",
.usage = "mkdos " OPTIONS " path # format disk",
.topic = "files",
.command = rtems_shell_main_msdos_format,
.alias = NULL,
.next = NULL
};
rtems_shell_cmd_t rtems_shell_MSDOSFMT_Alias = {
.name = "msdosfmt",
.usage = NULL,
.topic = "files",
.command = rtems_shell_main_msdos_format,
.alias = &rtems_shell_MSDOSFMT_Command,
.next = NULL
};