Changeset f6c7bcfe in rtems for cpukit/libblock


Ignore:
Timestamp:
Dec 21, 2012, 5:42:39 PM (7 years ago)
Author:
Mathew Kallada <matkallada@…>
Branches:
4.11, master
Children:
e5e1d8f
Parents:
f5f2676
git-author:
Mathew Kallada <matkallada@…> (12/21/12 17:42:39)
git-committer:
Jennifer Averett <jennifer.averett@…> (12/21/12 17:42:39)
Message:

libblock: Doxygen Enhancement Task #1

Location:
cpukit/libblock
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libblock/include/rtems/bdpart.h

    rf5f2676 rf6c7bcfe  
    3434
    3535/**
     36 * @brief Manage Partitions of a Disk Device
    3637 * @defgroup rtems_bdpart Block Device Partition Management
    3738 *
     
    335336
    336337/**
     338 * @brief Prints the Partition Table @a Partitions with @a Count Partitions
     339 *
    337340 * Prints the partition table @a partitions with @a count partitions to
    338341 * standard output.
  • cpukit/libblock/include/rtems/blkdev.h

    rf5f2676 rf6c7bcfe  
    277277
    278278/**
    279  * @brief Common IO control primitive.
     279 * @brief Common IO Control Primitive
    280280 *
    281281 * Use this in all block devices to handle the common set of IO control
     
    345345
    346346/**
    347  * @brief Prints the block device statistics.
     347 * @brief Prints the Block Device Statistics
    348348 */
    349349void rtems_blkdev_print_stats(
     
    354354
    355355/**
    356  * @brief Block device statistics command.
     356 * @brief Block Device Statistics Command
    357357 */
    358358void rtems_blkstats(
  • cpukit/libblock/src/bdpart-create.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Manage Partitions of a Disk Device
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/bdpart-dump.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Prints the Partition Table @a Partitions with @a Count Partitions
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/bdpart-mount.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Block Device Partition Management
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/bdpart-read.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Block Device Partition Management
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/bdpart-register.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Block Device Partition Management
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/bdpart-sort.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Block Device Partition Management
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/bdpart-write.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Block Device Partition Management
    45 * @ingroup rtems_bdpart
    5  *
    6  * Block device partition management.
    76 */
    87
  • cpukit/libblock/src/blkdev-blkstats.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Block Device Statistics Command
     5 * @ingroup rtems_blkdev Block Device Management
     6 */
     7
    18/*
    29 * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  • cpukit/libblock/src/blkdev-imfs.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Block Device IMFS
     5 * @ingroup libblock
     6 */
     7
    18/*
    29 * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  • cpukit/libblock/src/blkdev-ioctl.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Common IO Control Primitive
    45 * @ingroup rtems_blkdev
    5  *
    6  * Block device management.
    76 */
    87
  • cpukit/libblock/src/blkdev-print-stats.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Prints the Block Device Statistics
     5 * @ingroup rtems_blkdev Block Device Management
     6 */
     7
    18/*
    29 * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  • cpukit/libblock/src/blkdev.c

    rf5f2676 rf6c7bcfe  
    22 * @file
    33 *
     4 * @brief Block Device Management
    45 * @ingroup rtems_blkdev
    5  *
    6  * Block device management.
    76 */
    87
  • cpukit/libblock/src/diskdevs-init.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Block Device Disk Management Initialize
     5 * @ingroup rtems_disk Block Device Disk Management
     6 */
     7
    18/*
    29 * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  • cpukit/libblock/src/flashdisk.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Flash Disk Block Device Implementation
     5 * @ingroup libblock
     6 */
     7
    18/*
    2  * flashdisk.c -- Flash disk block device implementation
    3  *
    49 * Copyright (C) 2007 Chris Johns
    510 *
  • cpukit/libblock/src/ide_part_table.c

    rf5f2676 rf6c7bcfe  
    1 /*****************************************************************************
    2  *
    3  * ide_part_table.c
    4  *
    5  * The implementation of library supporting "MS-DOS-style" partition table
    6  *
    7  *
     1/**
     2 * @file
     3 *
     4 * @brief Library supporting "MS-DOS-style" Partition Table
     5 * @ingroup libblock
     6 */
     7
     8/*
    89 * Copyright (C) 2002 OKTET Ltd., St.-Petersburg, Russia
    910 *
     
    1516 *  http://www.rtems.com/license/LICENSE.
    1617 *
    17  *****************************************************************************/
     18 */
    1819
    1920#if HAVE_CONFIG_H
  • cpukit/libblock/src/nvdisk-sram.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Provide SRAM support for the NV Disk
     5 * @ingroup libblock
     6 */
     7
    18/*
    29 * RTEMS Project (http://www.rtems.org/)
    310 *
    411 * Copyright 2007 Chris Johns (chrisj@rtems.org)
    5  */
    6 /**
    7  * Provide SRAM support for the NV Disk.
    812 */
    913
  • cpukit/libblock/src/nvdisk.c

    rf5f2676 rf6c7bcfe  
     1/**
     2 * @file
     3 *
     4 * @brief Non-Volatile Disk Block Device Implementation
     5 * @ingroup libblock
     6 */
     7
    18/*
    2  * nvdisk.c -- Non-volatile disk block device implementation
    3  *
    49 * Copyright (C) 2007 Chris Johns
    510 *
  • cpukit/libblock/src/show_bdbuf.c

    rf5f2676 rf6c7bcfe  
    1 /*===============================================================*\
    2 | Project: RTEMS bdbuf inspector                                  |
    3 +-----------------------------------------------------------------+
    4 | File: show_bdbuf.c
    5 +-----------------------------------------------------------------+
    6 |                    Copyright (c) 2005                           |
    7 |                    Embedded Brains GmbH                         |
    8 |                    Obere Lagerstr. 30                           |
    9 |                    D-82178 Puchheim                             |
    10 |                    Germany                                      |
    11 |                    rtems@embedded-brains.de                     |
    12 +-----------------------------------------------------------------+
    13 | The license and distribution terms for this file may be         |
    14 | found in the file LICENSE in this distribution or at            |
    15 |                                                                 |
    16 | http://www.rtems.com/license/LICENSE.                           |
    17 |                                                                 |
    18 +-----------------------------------------------------------------+
    19 | this file contains functions to enable the monitor              |
    20 | to show bdbuf information                                       |
    21 |                                                                 |
    22 |                    XXX!!! ATTETION!!! XXX!!!                    |
    23 |                                                                 |
    24 | This module inspects the bdbuf data structures,                 |
    25 | assuming they are static, but in fact they are used very        |
    26 | dynamically. Therefore the results show MAY BE INCORRECT in     |
    27 | some cases. And, to cure this a bit, this module may block      |
    28 | preemption for a rather long time and therefore it may          |
    29 | BREAK THE REALTIME BEHAVIOUR OF YOUR SYSTEM (when in use)       |
    30 +-----------------------------------------------------------------+
    31 |   date                      history                        ID   |
    32 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
    33 | 26.09.06  creation                                         doe  |
    34 |*****************************************************************|
    35 \*===============================================================*/
     1/**
     2 * @file
     3 *
     4 * @brief Enable the Monitor to Show bdbuf Information
     5 * @ingroup rtems_bdpart
     6 *
     7 * This module inspects the bdbuf data structures,
     8 * assuming they are static, but in fact they are used very
     9 * dynamically. Therefore the results show MAY BE INCORRECT in
     10 * some cases. And, to cure this a bit, this module may block
     11 * preemption for a rather long time and therefore it may
     12 * BREAK THE REALTIME BEHAVIOUR OF YOUR SYSTEM (when in use)
     13 */
     14
     15/*
     16 * Copyright (c) 2005
     17 * Embedded Brains GmbH
     18 * Obere Lagerstr. 30
     19 * D-82178 Puchheim
     20 * Germany
     21 * rtems@embedded-brains.de
     22 * The license and distribution terms for this file may be
     23 * found in the file LICENSE in this distribution or at
     24 * http://www.rtems.com/license/LICENSE.
     25 */
    3626
    3727#if HAVE_CONFIG_H
Note: See TracChangeset for help on using the changeset viewer.