RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

libfs: Doxygen Enhancement Task #5

Browse Source
This commit is contained in:
Mathew Kallada
2012-12-28 08:05:20 -06:00
committed by Jennifer Averett
parent 36f3207b27
commit 4e592763cb
23 changed files with 240 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
cpukit/libfs/src/defaults/default_fcntl.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default FCNTL
* @ingroup libfs
*/
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).

7
cpukit/libfs/src/defaults/default_freenode.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Freenode
* @ingroup libfs
*/
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).

7
cpukit/libfs/src/defaults/default_ftruncate_directory.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Ftruncate Directory
* @ingroup libfs
*/
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*

7
cpukit/libfs/src/defaults/default_open.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Open
* @ingroup libfs
*/
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).

7
cpukit/libfs/src/defaults/default_readlink.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Readlink
* @ingroup libfs
*/
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).

7
cpukit/libfs/src/defaults/default_rmnod.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Remove Node
* @ingroup libfs
*/
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).

11
cpukit/libfs/src/dosfs/fat.c
View File

@@ -1,8 +1,11 @@
/**
* @file
*
* @brief Low-level Operations on a Volume with a DOSFS FAT filesystem
* @ingroup libfs
*/
/*
* fat.c
*
* Low-level operations on a volume with FAT filesystem
*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*/

19
cpukit/libfs/src/dosfs/msdos.h
View File

@@ -80,7 +80,7 @@ extern const rtems_filesystem_file_handlers_r msdos_file_handlers;
#define MSDOS_HARD_LINK RTEMS_FILESYSTEM_HARD_LINK /* pseudo type */
/**
* @brief Type of Node that Loc Refers To
* @brief Type of node that loc refers to.
*
* The following returns the type of node that the loc refers to.
*
@@ -233,7 +233,7 @@ typedef enum msdos_token_types_e
#define MSDOS_DPS512_NUM 16
/**
* @brief Shut Down MSDOS FileSystem
* @brief Shut down the MSDOS filesystem.
*
* MSDOS shut down handler implementation
*/
@@ -242,7 +242,7 @@ void msdos_shut_down(rtems_filesystem_mount_table_entry_t *temp_mt_entry);
void msdos_eval_path(rtems_filesystem_eval_path_context_t *ctx);
/**
* @brief Call Fat-File Close Routine
* @brief Call the Fat-File close routine.
*
* Free node handler implementation for the filesystem operations table.
*/
@@ -252,6 +252,11 @@ rtems_filesystem_node_types_t msdos_node_type(
const rtems_filesystem_location_info_t *loc
);
/**
* @brief Routine for node creation in a MSDOS filesystem.
*
* MSDOS Directory Handlers Implementation
*/
int msdos_mknod(
const rtems_filesystem_location_info_t *loc,
const char *name,
@@ -261,7 +266,7 @@ int msdos_mknod(
);
/**
* @brief Remove Node from MSDOS Directory
* @brief Remove node from MSDOS directory.
*
* MSDOS Directory Handlers Implementation
*/
@@ -271,7 +276,7 @@ int msdos_rmnod(
);
/**
* @brief Rename a MSDOS FileSystem Node
* @brief rename a MSDOS filesystem node
*
* Routine to rename a MSDOS filesystem node
*/
@@ -288,7 +293,7 @@ void msdos_lock(const rtems_filesystem_mount_table_entry_t *mt_entry);
void msdos_unlock(const rtems_filesystem_mount_table_entry_t *mt_entry);
/**
* @brief MSDOS Filesystem Initialization
* @brief The MSDOS filesystem initialization.
*
* MSDOS Initialization support routine implementation
*/
@@ -342,7 +347,7 @@ int msdos_dir_stat(
);
/**
* @brief Implements wake up version of the "signal" operation
* @brief Implements wake up version of the "signal" operation.
*
* Routine to create a new MSDOS filesystem node
*

9
cpukit/libfs/src/dosfs/msdos_eval.c
View File

@@ -1,6 +1,11 @@
/*
* MSDOS evaluation routines
/**
* @file
*
* @brief MSDOS Evaluation Routines
* @ingroup libfs
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_mknod.c
View File

@@ -1,6 +1,11 @@
/*
* Routine for node creation in MSDOS filesystem.
/**
* @file
*
* @brief Routine for Node Creation in MSDOS Filesystem
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/nfsclient/proto/mount_prot.h
View File

@@ -8,7 +8,12 @@
#include <rpc/rpc.h>
/**
* @defgroup libfs_nfsclient_mount_prot Mount Prot
*
* @ingroup libfs
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -140,5 +145,5 @@ extern bool_t xdr_exportnode ();
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* !_MOUNT_PROT_H_RPCGEN */

7
cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Mount Prot XDR
* @ingroup libfs_nfsclient_mount_prot Mount Prot
*/
/*
* Please do not edit this file.
* It was generated using rpcgen.

9
cpukit/libfs/src/nfsclient/proto/nfs_prot.h
View File

@@ -8,7 +8,12 @@
#include <rpc/rpc.h>
/**
* @defgroup libfs_nfsclient_nfs_prot NFS Prot
*
* @ingroup libfs
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -451,5 +456,5 @@ extern bool_t xdr_statfsres ();
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* !_NFS_PROT_H_RPCGEN */

7
cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief NFS Prot XDR
* @ingroup libfs_nfsclient_nfs_prot NFS Prot
*/
/*
* Please do not edit this file.
* It was generated using rpcgen.

7
cpukit/libfs/src/nfsclient/src/cexphelp.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief CEXP Help Information
* @ingroup libfs
*/
#if HAVE_CONFIG_H
#include "config.h"
#endif

11
cpukit/libfs/src/nfsclient/src/dirutils.c
View File

@@ -1,8 +1,13 @@
/* very crude and basic fs utilities for testing the NFS */
/* Till Straumann, <strauman@slac.stanford.edu>, 10/2002 */
/**
* @file
*
* @brief Basic NFS Filesystem Utilities for Testing the NFS
* @ingroup libfs
*/
/*
* Author: Till Straumann, <strauman@slac.stanford.edu>, 10/2002
*
* Authorship
* ----------
* This software (NFS-2 client implementation for RTEMS) was created by

23
cpukit/libfs/src/nfsclient/src/nfs.c
View File

@@ -1,15 +1,20 @@
/* NFS client implementation for RTEMS; hooks into the RTEMS filesystem */
/* Author: Till Straumann <strauman@slac.stanford.edu> 2002 */
/**
* @file
*
* @brief NFS Client Implementation for RTEMS
* @ingroup libfs
*
* Hooks Into the RTEMS NFS Filesystem
*/
/*
* Author: Till Straumann <strauman@slac.stanford.edu>, 2002
*
* Hacked on by others.
*
* Modifications to support reference counting in the file system are
* Copyright (c) 2012 embedded brains GmbH.
*/
/*
*
* Authorship
* ----------
* This software (NFS-2 client implementation for RTEMS) was created by
@@ -1313,7 +1318,7 @@ int len;
}
memcpy(&psa->sin_addr, h->h_addr, sizeof (struct in_addr));
/* END OF NON-THREAD SAFE REGION */
psa->sin_family = AF_INET;
@@ -1770,13 +1775,13 @@ char *path = mt_entry->dev;
fprintf (stderr, "error: initialising RPC\n");
return -1;
}
nfsInit(0, 0);
#if 0
printf("Trying to mount %s on %s\n",path,mntpoint);
#endif
if ( buildIpAddr(&uid, &gid, &host, &saddr, &path) )
return -1;

7
cpukit/libfs/src/nfsclient/src/nfs.modini.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief NFS Module Initialize
* @ingroup libfs
*/
#if HAVE_CONFIG_H
#include "config.h"
#endif

17
cpukit/libfs/src/nfsclient/src/nfsTest.c
View File

@@ -1,8 +1,10 @@
/* Test program for evaluating NFS read throughput */
/* Author: Till Straumann <strauman@slac.stanford.edu>, 2006 */
/* This test code allows for evaluating NFS read performance
/**
* @file
*
* @brief Test Program for Evaluating NFS Read Throughput
* @ingroup libfs
*
* This test code allows for evaluating NFS read performance
* under various scenarios:
* - synchronous reads with various buffer sizes (select
* 'num_readers' == 0, see below).
@@ -48,7 +50,12 @@
* performed at 'big block' boundaries (num_readers * chunk_size).
*/
/*
* Author: Till Straumann <strauman@slac.stanford.edu>, 2006
*
* Authorship
* ----------
* This software (NFS-2 client implementation for RTEMS) was created by

14
cpukit/libfs/src/nfsclient/src/rpcio.c
View File

@@ -1,8 +1,10 @@
/* RPC multiplexor for a multitasking environment */
/* Author: Till Straumann <strauman@slac.stanford.edu>, 2002 */
/* This code funnels arbitrary task's UDP/RPC requests
/**
* @file
*
* @brief RPC Multiplexor for a Multitasking Environment
* @ingroup libfs
*
* This code funnels arbitrary task's UDP/RPC requests
* through one socket to arbitrary servers.
* The replies are gathered and dispatched to the
* requestors.
@@ -15,6 +17,8 @@
*/
/*
* Author: Till Straumann <strauman@slac.stanford.edu>, 2002
*
* Authorship
* ----------
* This software (NFS-2 client implementation for RTEMS) was created by

7
cpukit/libfs/src/nfsclient/src/rpcio.modini.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief RPCIO Module Initialize
* @ingroup libfs
*/
#if HAVE_CONFIG_H
#include "config.h"
#endif

125
cpukit/libfs/src/nfsclient/src/sock_mbuf.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Sock Mbuf
* @ingroup libfs
*/
/*
* NOTE:
* This is derived from libnetworking/rtems/rtems_syscall.c
@@ -9,70 +16,64 @@
* Till Straumann, <strauman@slac.stanford.edu>
* Licensing: 'LICENSE.NET' file in the RTEMS top source directory
* for more information.
*
* The RTEMS TCP/IP stack is a port of the FreeBSD TCP/IP stack. The following
* copyright and licensing information applies to this code.
*
* This code is found under the c/src/libnetworking directory but does not
* constitute the entire contents of that subdirectory.
*
*
* Copyright (c) 1980, 1983, 1988, 1993
* The Regents of the University of California. All rights reserved.
*
* 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgment:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
* Portions Copyright (c) 1993 by Digital Equipment Corporation.
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies, and that
* the name of Digital Equipment Corporation not be used in advertising or
* publicity pertaining to distribution of the document or software without
* specific, written prior permission.
* THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
* WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT
* CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
* SOFTWARE.
*/
/*
The RTEMS TCP/IP stack is a port of the FreeBSD TCP/IP stack. The following
copyright and licensing information applies to this code.
This code is found under the c/src/libnetworking directory but does not
constitute the entire contents of that subdirectory.
=============================================================================
Copyright (c) 1980, 1983, 1988, 1993
The Regents of the University of California. All rights reserved.
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.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgment:
This product includes software developed by the University of
California, Berkeley and its contributors.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
-
Portions Copyright (c) 1993 by Digital Equipment Corporation.
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies, and that
the name of Digital Equipment Corporation not be used in advertising or
publicity pertaining to distribution of the document or software without
specific, written prior permission.
THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT
CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.
=============================================================================
*/
#if HAVE_CONFIG_H
#include "config.h"
#endif

13
cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
View File

@@ -1,8 +1,15 @@
/* xdr_mbuf is derived from xdr_mem */
/* Author (mbuf specifica): Till Straumann <strauman@slac.stanford.edu>, 10/2002 */
/**
* @file
*
* @brief XDR Implementation Using mbuf Buffers
* @ingroup libfs
*
* xdr_mbuf is derived from xdr_mem
*/
/*
* Author (mbuf specifica): Till Straumann <strauman@slac.stanford.edu>, 10/2002
*
* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
* unrestricted use provided that this legend is included on all tape
* media and as a part of the software program in whole or part. Users