[PATCH 18/45] score: Add Thread_queue_Control::Lock

[Gedare Bloom]

On Sun, May 17, 2015 at 7:04 AM, Gedare Bloom <gedare at rtems.org> wrote:
> On Fri, May 15, 2015 at 7:41 AM, Sebastian Huber
> <sebastian.huber at embedded-brains.de> wrote:
>>  /**
>> - *  @brief Gets a pointer to the "first" thread on the_thread_queue.
>> + * @brief Returns the first thread on the thread queue if it exists, otherwise
>> + * @c NULL (locked).
>> + *
>> + * The caller must be the owner of the thread queue lock.
>> + *
>> + * @param[in] the_thread_queue The thread queue.
>>   *
>> - *  This function returns a pointer to the "first" thread
>> - *  on the_thread_queue.  The "first" thread is selected
>> - *  based on the discipline of the_thread_queue.
>> + * @retval NULL No thread is present on the thread queue.
>> + * @retval first The first thread on the thread queue according to the enqueue
>> + * order.
>> + */
>> +Thread_Control *_Thread_queue_First_locked(
>> +  Thread_queue_Control *the_thread_queue
>> +);
>> +
> In other places we call such a function variant _unprotected. In the
> doxygen, I don't know what you mean by @c NULL (locked) in the @brief,
> or why there are two @brief.

Please clarify the distinctions between _locked(), _critical(), and
_unprotected().