diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/sem.h')
-rw-r--r-- | cpukit/include/rtems/rtems/sem.h | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/cpukit/include/rtems/rtems/sem.h b/cpukit/include/rtems/rtems/sem.h index d079926720..73e725f82d 100644 --- a/cpukit/include/rtems/rtems/sem.h +++ b/cpukit/include/rtems/rtems/sem.h @@ -3,11 +3,13 @@ /** * @file * + * @ingroup RTEMSImplClassicSemaphore + * * @brief This header file defines the Semaphore Manager API. */ /* - * Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) + * Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) * * Redistribution and use in source and binary forms, with or without @@ -95,9 +97,9 @@ extern "C" { * semaphore with the priority ceiling or MrsP locking protocol as defined by * the attribute set. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the identifier of the created semaphore will - * be stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the identifier of the created semaphore will be stored + * in this object. * * This directive creates a semaphore which resides on the local node. The * semaphore has the user-defined object name specified in ``name`` and the @@ -201,13 +203,13 @@ extern "C" { * * @retval ::RTEMS_TOO_MANY There was no inactive object available to create a * semaphore. The number of semaphores available to the application is - * configured through the #CONFIGURE_MAXIMUM_SEMAPHORES application + * configured through the @ref CONFIGURE_MAXIMUM_SEMAPHORES application * configuration option. * * @retval ::RTEMS_TOO_MANY In multiprocessing configurations, there was no * inactive global object available to create a global semaphore. The number * of global objects available to the application is configured through the - * #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option. + * @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option. * * @retval ::RTEMS_INVALID_PRIORITY The ``priority_ceiling`` parameter was * invalid. @@ -241,7 +243,7 @@ extern "C" { * message to remote nodes. This may preempt the calling task. * * * The number of semaphores available to the application is configured - * through the #CONFIGURE_MAXIMUM_SEMAPHORES application configuration + * through the @ref CONFIGURE_MAXIMUM_SEMAPHORES application configuration * option. * * * Where the object class corresponding to the directive is configured to use @@ -249,8 +251,8 @@ extern "C" { * Workspace. * * * The number of global objects available to the application is configured - * through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration - * option. + * through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application + * configuration option. * @endparblock */ rtems_status_code rtems_semaphore_create( @@ -272,9 +274,9 @@ rtems_status_code rtems_semaphore_create( * * @param node is the node or node set to search for a matching object. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the object identifier of an object with the - * specified name will be stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the object identifier of an object with the specified + * name will be stored in this object. * * This directive obtains a semaphore identifier associated with the semaphore * name specified in ``name``. @@ -737,9 +739,9 @@ rtems_status_code rtems_semaphore_flush( rtems_id id ); * @param new_priority is the new priority corresponding to the specified * scheduler. * - * @param[out] old_priority is the pointer to a task priority variable. When - * the directive call is successful, the old priority of the semaphore - * corresponding to the specified scheduler will be stored in this variable. + * @param[out] old_priority is the pointer to an ::rtems_task_priority object. + * When the directive call is successful, the old priority of the semaphore + * corresponding to the specified scheduler will be stored in this object. * * This directive sets the priority of the semaphore specified by * ``semaphore_id``. The priority corresponds to the scheduler specified by |