diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/dpmem.h')
| -rw-r--r-- | cpukit/include/rtems/rtems/dpmem.h | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h index 0dfa70a82e..62e34053ea 100644 --- a/cpukit/include/rtems/rtems/dpmem.h +++ b/cpukit/include/rtems/rtems/dpmem.h @@ -3,11 +3,13 @@ /** * @file * + * @ingroup RTEMSImplClassicDPMem + * * @brief This header file defines the Dual-Ported Memory 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 @@ -89,9 +91,9 @@ extern "C" { * * @param length is the length in bytes of the memory area. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the identifier of the created port 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 port will be stored in + * this object. * * This directive creates a port which resides on the local node. The port has * the user-defined object name specified in ``name``. The assigned object @@ -112,7 +114,7 @@ extern "C" { * * @retval ::RTEMS_TOO_MANY There was no inactive object available to create a * port. The number of port available to the application is configured - * through the #CONFIGURE_MAXIMUM_PORTS application configuration option. + * through the @ref CONFIGURE_MAXIMUM_PORTS application configuration option. * * @par Notes * @parblock @@ -136,7 +138,7 @@ extern "C" { * cause the calling task to be preempted. * * * The number of ports available to the application is configured through the - * #CONFIGURE_MAXIMUM_PORTS application configuration option. + * @ref CONFIGURE_MAXIMUM_PORTS application configuration option. * * * Where the object class corresponding to the directive is configured to use * unlimited objects, the directive may allocate memory from the RTEMS @@ -160,9 +162,9 @@ rtems_status_code rtems_port_create( * * @param name is the object name to look up. * - * @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 port identifier associated with the port name * specified in ``name``. @@ -251,9 +253,9 @@ rtems_status_code rtems_port_delete( rtems_id id ); * * @param external is the external address to convert. * - * @param[out] internal is the pointer to a pointer variable. When the + * @param[out] internal is the pointer to a ``void`` pointer object. When the * directive call is successful, the external address associated with the - * internal address will be stored in this variable. + * internal address will be stored in this object. * * This directive converts a dual-ported memory address from external to * internal representation for the specified port. If the given external @@ -297,9 +299,9 @@ rtems_status_code rtems_port_external_to_internal( * * @param internal is the internal address to convert. * - * @param[out] external is the pointer to a pointer variable. When the + * @param[out] external is the pointer to a ``void`` pointer object. When the * directive call is successful, the external address associated with the - * internal address will be stored in this variable. + * internal address will be stored in this object. * * This directive converts a dual-ported memory address from internal to * external representation so that it can be passed to owner of the DPMA |