Changeset af4ecb76 in mainline for uspace/lib/device/src/hr.c


Ignore:
Timestamp:
2025-05-07T11:01:14Z (6 weeks ago)
Author:
Miroslav Cimerman <mc@…>
Children:
155d34f
Parents:
fc265b4
Message:

hr: document lib/device/src/hr.c

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/device/src/hr.c

    rfc265b4 raf4ecb76  
    3131 */
    3232/**
    33  * @file
     33 * @file HelenRAID client API
    3434 */
    3535
    … …  
    4444#include <str.h>
    4545
     46/** Initialize server session.
     47 *
     48 * @param rhr   Place to store inited session
     49 *
     50 * @return EOK on success or an error code
     51 */
    4652errno_t hr_sess_init(hr_t **rhr)
    4753{
    … …  
    7985}
    8086
     87/** Destroy server session.
     88 *
     89 * @param hr    Session to destroy
     90 */
    8191void hr_sess_destroy(hr_t *hr)
    8292{
    … …  
    8898}
    8999
     100/** Create volume.
     101 *
     102 * @param hr            Server session
     103 * @param hr_config     Config to create from
     104 *
     105 * @return EOK on success or an error code
     106 */
    90107errno_t hr_create(hr_t *hr, hr_config_t *hr_config)
    91108{
    … …  
    112129}
    113130
     131/** Assemble volumes.
     132 *
     133 * @param hr             Server session
     134 * @param hr_config      Config to assemble from
     135 * @param rassembled_cnt Place to store assembled count
     136 *
     137 * @return EOK on success or an error code
     138 */
    114139errno_t hr_assemble(hr_t *hr, hr_config_t *hr_config, size_t *rassembled_cnt)
    115140{
    … …  
    148173}
    149174
     175/** Automatically assemble volumes.
     176 *
     177 * @param hr             Server session
     178 * @param rassembled_cnt Place to store assembled count
     179 *
     180 * @return EOK on success or an error code
     181 */
    150182errno_t hr_auto_assemble(hr_t *hr, size_t *rassembled_cnt)
    151183{
    … …  
    260292}
    261293
     294/** Stop/deactivate volume.
     295 *
     296 * @param hr            Server session
     297 * @param devname       Volume name
     298 *
     299 * @return EOK on success or an error code
     300 */
    262301errno_t hr_stop(hr_t *hr, const char *devname)
    263302{
    … …  
    282321}
    283322
     323/** Stop/deactivate all volumes.
     324 *
     325 * @param hr            Server session
     326 *
     327 * @return EOK on success or an error code
     328 */
    284329errno_t hr_stop_all(hr_t *hr)
    285330{
    … …  
    299344}
    300345
     346/** Fail an extent in volume.
     347 *
     348 * @param hr            Server session
     349 * @param volume_name   Volume name
     350 * @param extent        Extent index to fail
     351 *
     352 * @return EOK on success or an error code
     353 */
    301354errno_t hr_fail_extent(hr_t *hr, const char *volume_name, unsigned long extent)
    302355{
    … …  
    321374}
    322375
     376/** Add a hotspare to volume.
     377 *
     378 * @param hr            Server session
     379 * @param volume_name   Volume name
     380 * @param hotspare      Hotspare service name
     381 *
     382 * @return EOK on success or an error code
     383 */
    323384errno_t hr_add_hotspare(hr_t *hr, const char *volume_name, const char *hotspare)
    324385{
    … …  
    347408}
    348409
     410/** Print state of volumes.
     411 *
     412 * @param hr    Server session
     413 *
     414 * @return EOK on success or an error code
     415 */
    349416errno_t hr_print_status(hr_t *hr)
    350417{
Note: See TracChangeset for help on using the changeset viewer.