| Message ID | 1417707535-7632-3-git-send-email-ola.liljedahl@linaro.org |
|---|---|
| State | Accepted |
| Commit | 25bdd8014cbf2b1561cfd102bccff002237a8a0a |
| Headers | show |
On Thu, Dec 4, 2014 at 9:38 AM, Ola Liljedahl <ola.liljedahl@linaro.org> wrote: > Signed-off-by: Ola Liljedahl <ola.liljedahl@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> --- > (This code contribution is provided under the terms of agreement > LES-LTM-21309) > Update and unify doxygen comments and function parameter names. > > platform/linux-generic/include/api/odp_barrier.h | 22 > +++++++++++++--------- > 1 file changed, 13 insertions(+), 9 deletions(-) > > diff --git a/platform/linux-generic/include/api/odp_barrier.h > b/platform/linux-generic/include/api/odp_barrier.h > index 1790ea3..423982f 100644 > --- a/platform/linux-generic/include/api/odp_barrier.h > +++ b/platform/linux-generic/include/api/odp_barrier.h > @@ -23,12 +23,12 @@ extern "C" { > #include <odp_atomic.h> > > /** @addtogroup odp_synchronizers > - * Barrier between threads. > + * Synchronize threads. > * @{ > */ > > /** > - * ODP execution barrier > + * ODP thread synchronization barrier > */ > typedef struct odp_barrier_t { > uint32_t count; /**< @private Thread count */ > @@ -37,20 +37,24 @@ typedef struct odp_barrier_t { > > > /** > - * Init barrier with thread count > + * Initialize barrier with thread count. > * > - * @param barrier Barrier > - * @param count Thread count > + * @param barr Pointer to a barrier variable > + * @param count Thread count > */ > -void odp_barrier_init(odp_barrier_t *barrier, int count); > +void odp_barrier_init(odp_barrier_t *barr, int count); > > > /** > - * Synchronise thread execution on barrier > + * Synchronize thread execution on barrier. > + * Wait for all threads to arrive at the barrier until they are let loose > again. > + * Threads will block (spin) until the last thread has arrived at the > barrier. > + * All memory operations before the odp_barrier_wait() call will be > visible > + * to all threads when they leave the barrier. > * > - * @param barrier Barrier > + * @param barr Pointer to a barrier variable > */ > -void odp_barrier_wait(odp_barrier_t *barrier); > +void odp_barrier_wait(odp_barrier_t *barr); > > /** > * @} > -- > 1.9.1 > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp >
diff --git a/platform/linux-generic/include/api/odp_barrier.h b/platform/linux-generic/include/api/odp_barrier.h index 1790ea3..423982f 100644 --- a/platform/linux-generic/include/api/odp_barrier.h +++ b/platform/linux-generic/include/api/odp_barrier.h @@ -23,12 +23,12 @@ extern "C" { #include <odp_atomic.h> /** @addtogroup odp_synchronizers - * Barrier between threads. + * Synchronize threads. * @{ */ /** - * ODP execution barrier + * ODP thread synchronization barrier */ typedef struct odp_barrier_t { uint32_t count; /**< @private Thread count */ @@ -37,20 +37,24 @@ typedef struct odp_barrier_t { /** - * Init barrier with thread count + * Initialize barrier with thread count. * - * @param barrier Barrier - * @param count Thread count + * @param barr Pointer to a barrier variable + * @param count Thread count */ -void odp_barrier_init(odp_barrier_t *barrier, int count); +void odp_barrier_init(odp_barrier_t *barr, int count); /** - * Synchronise thread execution on barrier + * Synchronize thread execution on barrier. + * Wait for all threads to arrive at the barrier until they are let loose again. + * Threads will block (spin) until the last thread has arrived at the barrier. + * All memory operations before the odp_barrier_wait() call will be visible + * to all threads when they leave the barrier. * - * @param barrier Barrier + * @param barr Pointer to a barrier variable */ -void odp_barrier_wait(odp_barrier_t *barrier); +void odp_barrier_wait(odp_barrier_t *barr); /** * @}
Signed-off-by: Ola Liljedahl <ola.liljedahl@linaro.org> --- (This code contribution is provided under the terms of agreement LES-LTM-21309) Update and unify doxygen comments and function parameter names. platform/linux-generic/include/api/odp_barrier.h | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-)