Changeset 5c91b54b in rtems


Ignore:
Timestamp:
Apr 18, 2019, 6:28:21 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
5791a3c
Parents:
4a693e7
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/18/19 06:28:21)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

doxygen: score: adjust doc in tls.h to doxygen guidelines

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/tls.h

    r4a693e7 r5c91b54b  
    8585} TLS_Index;
    8686
     87/**
     88 * @brief Gets the TLS size.
     89 *
     90 * @return the TLS size.
     91 */
    8792static inline uintptr_t _TLS_Get_size( void )
    8893{
     
    9499}
    95100
     101/**
     102 * @brief Returns the value aligned up to the heap alignment.
     103 *
     104 * @param val The value to align.
     105 *
     106 * @return The value aligned to the heap alignment.
     107 */
    96108static inline uintptr_t _TLS_Heap_align_up( uintptr_t val )
    97109{
     
    101113}
    102114
     115/**
     116 * @brief Returns the size of the thread control block area size for this
     117 *      alignment, or the minimum size if alignment is too small.
     118 *
     119 * @param alignment The alignment for the operation.
     120 *
     121 * @return The size of the thread control block area.
     122 */
    103123static inline uintptr_t _TLS_Get_thread_control_block_area_size(
    104124  uintptr_t alignment
     
    109129}
    110130
     131/**
     132 * @brief Returns the actual size that has to be allocated for this size and
     133 *      alignment.
     134 *
     135 * @param size The size for the operation.
     136 * @param alignment The alignment for the operation.
     137 *
     138 * @return The actual allocation size.
     139 */
    111140static inline uintptr_t _TLS_Get_allocation_size(
    112141  uintptr_t size,
     
    126155}
    127156
     157/**
     158 * @brief Copies TLS size bytes from the address tls_area and returns a pointer
     159 *      to the start of the area after clearing it.
     160 *
     161 * @param tls_area The starting address of the area to clear.
     162 *
     163 * @return The pointer to the beginning of the cleared section.
     164 */
    128165static inline void *_TLS_Copy_and_clear( void *tls_area )
    129166{
     
    145182}
    146183
     184/**
     185 * @brief Initializes the dynamic thread vector.
     186 *
     187 * @param tls_block The tls block for @a dtv.
     188 * @param tcb The thread control block for @a dtv.
     189 * @param[out] dtv The dynamic thread vector to initialize.
     190 *
     191 * @return Pointer to an area that was copied and cleared from tls_block
     192 *       onwards (@see _TLS_Copy_and_clear).
     193 */
    147194static inline void *_TLS_Initialize(
    148195  void *tls_block,
     
    163210}
    164211
    165 /* Use Variant I, TLS offsets emitted by linker takes the TCB into account */
     212/**
     213 * @brief Initializes a dynamic thread vector beginning at the given starting
     214 *      address.
     215 *
     216 * Use Variant I, TLS offsets emitted by linker takes the TCB into account.
     217 *
     218 * @param tls_area The tls area for the initialization.
     219 *
     220 * @return Pointer to an area that was copied and cleared from tls_block
     221 *       onwards (@see _TLS_Copy_and_clear).
     222 */
    166223static inline void *_TLS_TCB_at_area_begin_initialize( void *tls_area )
    167224{
     
    176233}
    177234
    178 /* Use Variant I, TLS offsets emitted by linker neglects the TCB */
     235/**
     236 * @brief Initializes a dynamic thread vector with the area before a given
     237 * starting address as thread control block.
     238 *
     239 * Use Variant I, TLS offsets emitted by linker neglects the TCB.
     240 *
     241 * @param tls_area The tls area for the initialization.
     242 *
     243 * @return Pointer to an area that was copied and cleared from tls_block
     244 *       onwards (@see _TLS_Copy_and_clear).
     245 */
    179246static inline void *_TLS_TCB_before_TLS_block_initialize( void *tls_area )
    180247{
     
    190257}
    191258
    192 /* Use Variant II */
     259/**
     260 * @brief Initializes a dynamic thread vector with the area after a given
     261 * starting address as thread control block.
     262 *
     263 * Use Variant II
     264 *
     265 * @param tls_area The tls area for the initialization.
     266 *
     267 * @return Pointer to an area that was copied and cleared from tls_block
     268 *       onwards (@see _TLS_Copy_and_clear).
     269 */
    193270static inline void *_TLS_TCB_after_TLS_block_initialize( void *tls_area )
    194271{
Note: See TracChangeset for help on using the changeset viewer.