Changeset 1024561 in rtems


Ignore:
Timestamp:
Feb 28, 2012, 3:29:27 PM (8 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
796967c
Parents:
c42b03f4
git-author:
Sebastian Huber <sebastian.huber@…> (02/28/12 15:29:27)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/13/12 11:24:18)
Message:

libblock: Documentation

File:
1 edited

Legend:

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

    rc42b03f4 r1024561  
    1616 *    Change to support demand driven variable buffer sizes.
    1717 *
    18  * Copyright (c) 2009 embedded brains GmbH.
     18 * Copyright (c) 2009-2012 embedded brains GmbH.
    1919 *
    2020 * @(#) bdbuf.h,v 1.9 2005/02/02 00:06:18 joel Exp
     
    444444 * ready state.
    445445 *
    446  * @return RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    447  *         successfully or error code if error is occured)
     446 * @retval RTEMS_SUCCESSFUL Successful operation.
     447 * @retval RTEMS_CALLED_FROM_ISR Called from an interrupt context.
     448 * @retval RTEMS_INVALID_NUMBER The buffer maximum is not an integral multiple
     449 * of the buffer minimum.
     450 * @retval RTEMS_RESOURCE_IN_USE Already initialized.
     451 * @retval RTEMS_UNSATISFIED Not enough resources.
    448452 */
    449453rtems_status_code
     
    467471 * of the partition on the media.
    468472 *
    469  * @param device Device number (constructed of major and minor device number)
    470  * @param block  Linear media block number
    471  * @param bd     Reference to the buffer descriptor pointer.
    472  *
    473  * @return       RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    474  *               successfully or error code if error is occured)
     473 * @param device [in] Device number (constructed of major and minor device
     474 * number).
     475 * @param block [in] Linear media block number.
     476 * @param bd [out] Reference to the buffer descriptor pointer.
     477 *
     478 * @retval RTEMS_SUCCESSFUL Successful operation.
     479 * @retval RTEMS_NOT_CONFIGURED Not initialized.
     480 * @retval RTEMS_INVALID_ID No such device.
     481 * @retval RTEMS_INVALID_NUMBER Invalid block size.
    475482 */
    476483rtems_status_code
     
    492499 * first.
    493500 *
    494  * @param device Device number (constructed of major and minor device number)
    495  * @param block  Linear media block number
    496  * @param bd     Reference to the buffer descriptor pointer.
    497  *
    498  * @return       RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    499  *               successfully or error code if error is occured)
     501 * @param device [in] Device number (constructed of major and minor device
     502 * number).
     503 * @param block [in] Linear media block number.
     504 * @param bd [out] Reference to the buffer descriptor pointer.
     505 *
     506 * @retval RTEMS_SUCCESSFUL Successful operation.
     507 * @retval RTEMS_NOT_CONFIGURED Not initialized.
     508 * @retval RTEMS_INVALID_ID No such device.
     509 * @retval RTEMS_INVALID_NUMBER Invalid block size.
     510 * @retval RTEMS_IO_ERROR IO error.
    500511 */
    501512rtems_status_code
     
    510521 * queue. The buffers is returned to the end of the LRU list.
    511522 *
    512  * @param bd Reference to the buffer descriptor.
    513  *
    514  * @return RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    515  *         successfully or error code if error is occured)
     523 * @param bd [in] Reference to the buffer descriptor.
     524 *
     525 * @retval RTEMS_SUCCESSFUL Successful operation.
     526 * @retval RTEMS_NOT_CONFIGURED Not initialized.
     527 * @retval RTEMS_INVALID_ADDRESS The reference is NULL.
    516528 */
    517529rtems_status_code
     
    528540 * before the hold timer has expired the buffer will be returned to the user.
    529541 *
    530  * @param bd Reference to the buffer descriptor.
    531  *
    532  * @return RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    533  *         successfully or error code if error is occured)
     542 * @param bd [in] Reference to the buffer descriptor.
     543 *
     544 * @retval RTEMS_SUCCESSFUL Successful operation.
     545 * @retval RTEMS_NOT_CONFIGURED Not initialized.
     546 * @retval RTEMS_INVALID_ADDRESS The reference is NULL.
    534547 */
    535548rtems_status_code
     
    545558 *       modified queue.
    546559
    547  * @param bd Reference to the buffer descriptor.
    548  *
    549  * @return RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    550  *         successfully or error code if error is occured)
     560 * @param bd [in] Reference to the buffer descriptor.
     561 *
     562 * @retval RTEMS_SUCCESSFUL Successful operation.
     563 * @retval RTEMS_NOT_CONFIGURED Not initialized.
     564 * @retval RTEMS_INVALID_ADDRESS The reference is NULL.
    551565 */
    552566rtems_status_code
     
    562576 * nested call will be blocked until the first sync request has complete.
    563577 *
    564  * @param dev Block device number
    565  *
    566  * @return RTEMS status code (RTEMS_SUCCESSFUL if operation completed
    567  *         successfully or error code if error is occured)
     578 * @param dev [in] Device number (constructed of major and minor device
     579 * number).
     580 *
     581 * @retval RTEMS_SUCCESSFUL Successful operation.
     582 * @retval RTEMS_NOT_CONFIGURED Not initialized.
     583 * @retval RTEMS_INVALID_ID No such device.
    568584 */
    569585rtems_status_code
Note: See TracChangeset for help on using the changeset viewer.