Changeset 1fab972 in rtems


Ignore:
Timestamp:
Jul 21, 2020, 1:22:55 PM (3 weeks ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
33314eb
Parents:
3a95a07d
git-author:
Sebastian Huber <sebastian.huber@…> (07/21/20 13:22:55)
git-committer:
Sebastian Huber <sebastian.huber@…> (07/21/20 15:13:47)
Message:

score: Improve _Thread_Start() description

File:
1 edited

Legend:

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

    r3a95a07d r1fab972  
    212212
    213213/**
    214  * @brief Initializes thread and executes it.
    215  *
    216  * This routine initializes the executable information for a thread
    217  * and makes it ready to execute.  After this routine executes, the
    218  * thread competes with all other threads for CPU time.
    219  *
    220  * @param the_thread The thread to be started.
    221  * @param entry The thread entry information.
     214 * @brief Starts the specified thread.
     215 *
     216 * If the thread is not in the dormant state, the routine returns with a value
     217 * of false and performs no actions except enabling interrupts as indicated by
     218 * the ISR lock context.
     219 *
     220 * Otherwise, this routine initializes the executable information for the
     221 * thread and makes it ready to execute.  After the call of this routine, the
     222 * thread competes with all other ready threads for CPU time.
     223 *
     224 * Then the routine enables the local interrupts as indicated by the ISR lock
     225 * context.
     226 *
     227 * Then the thread start user extensions are called with thread dispatching
     228 * disabled and interrupts enabled after making the thread ready.  Please note
     229 * that in SMP configurations, the thread switch and begin user extensions may
     230 * be called in parallel on another processor.
     231 *
     232 * Then thread dispatching is enabled and other threads may execute before the
     233 * routine returns.
     234 *
     235 * @param[in, out] the_thread is the thread to start.
     236 *
     237 * @param entry is the thread entry information.
     238 *
     239 * @param[in, out] is the ISR lock context which shall be used to disable the
     240 *   local interrupts before the call of this routine.
     241 *
     242 * @retval true The thread was in the dormant state and was sucessefully
     243 *   started.
     244 *
     245 * @retval false Otherwise.
    222246 */
    223247bool _Thread_Start(
Note: See TracChangeset for help on using the changeset viewer.