Documentation

This commit is contained in:
Thomas Doerfler
2009-05-05 12:56:30 +00:00
parent 846639da5f
commit d8602eb655
2 changed files with 10 additions and 8 deletions

View File

@@ -26,7 +26,8 @@ extern "C" {
* *
* @ingroup rtems_libblock * @ingroup rtems_libblock
* *
* Interface between device drivers and the block device library. * Interface between device drivers and the
* @ref rtems_bdbuf "block device buffer module".
* *
* The heart of the block device driver is the @ref RTEMS_BLKIO_REQUEST IO * The heart of the block device driver is the @ref RTEMS_BLKIO_REQUEST IO
* control. This call puts IO @ref rtems_blkdev_request "requests" to the block * control. This call puts IO @ref rtems_blkdev_request "requests" to the block
@@ -97,7 +98,7 @@ typedef struct rtems_blkdev_sg_buffer {
} rtems_blkdev_sg_buffer; } rtems_blkdev_sg_buffer;
/** /**
* The block device dequest structure is used to read or write a number of * The block device request structure is used to read or write a number of
* blocks from or to the device. * blocks from or to the device.
*/ */
typedef struct rtems_blkdev_request { typedef struct rtems_blkdev_request {

View File

@@ -36,12 +36,13 @@ extern "C" {
* *
* @ingroup rtems_libblock * @ingroup rtems_libblock
* *
* This module provides functions to manage disk devices. The disk devices are * This module provides functions to manage disk devices.
* accessed via the RTEMS block device library. A disk is a set of blocks *
* which are identified by a consecutive set of non-negative integers starting * A disk is a set of blocks which are identified by a consecutive set of
* at zero. There are also logical disks which contain a subset of consecutive * non-negative integers starting at zero. There are also logical disks which
* disk blocks. The logical disks are used to represent the partitions of a * contain a subset of consecutive disk blocks. The logical disks are used to
* disk. * represent the partitions of a disk. The disk devices are accessed via the
* @ref rtems_bdbuf "block device buffer module".
* *
* @{ * @{
*/ */