Changeset 65f19f0 in rtems


Ignore:
Timestamp:
Apr 12, 2019, 6:14:23 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
06821fa5
Parents:
334de12
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/12/19 06:14:23)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:04)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    r334de12 r65f19f0  
    11/**
    2  *  @file
    3  *
    4  *  @brief Thread manipulation for the CBS scheduler
    5  *
    6  *  This include file contains all the constants and structures associated
    7  *  with the manipulation of threads for the CBS scheduler.
     2 * @file
     3 *
     4 * @ingroup RTEMSScoreSchedulerCBS
     5 *
     6 * @brief Thread manipulation for the CBS scheduler
     7 *
     8 * This include file contains all the constants and structures associated
     9 * with the manipulation of threads for the CBS scheduler.
    810 */
    911
     
    3436
    3537/**
    36  *  @defgroup RTEMSScoreSchedulerCBS CBS Scheduler
    37  *
    38  *  @ingroup RTEMSScoreScheduler
    39  */
    40 /**@{*/
     38 * @defgroup RTEMSScoreSchedulerCBS CBS Scheduler
     39 *
     40 * @ingroup RTEMSScoreScheduler
     41 *
     42 * @brief CBS Scheduler.
     43 *
     44 * @{
     45 */
    4146
    4247#define SCHEDULER_CBS_MAXIMUM_PRIORITY SCHEDULER_EDF_MAXIMUM_PRIORITY
     
    147152extern Scheduler_CBS_Server _Scheduler_CBS_Server_list[];
    148153
     154/**
     155 * @brief Unblocks a thread.
     156 *
     157 * @param scheduler The scheduler control.
     158 * @param the_thread The thread to unblock.
     159 * @param node The scheduler node.
     160 */
    149161void _Scheduler_CBS_Unblock(
    150162  const Scheduler_Control *scheduler,
     
    153165);
    154166
     167/**
     168 * @brief Releases a job.
     169 *
     170 * @param scheduler The scheduler for the operation.
     171 * @param the_thread The corresponding thread.
     172 * @param priority_node The priority node for the operation.
     173 * @param deadline The deadline for the job.
     174 * @param queue_context The thread queue context.
     175 */
    155176void _Scheduler_CBS_Release_job(
    156177  const Scheduler_Control *scheduler,
     
    161182);
    162183
     184/**
     185 * @brief Cancels a job.
     186 *
     187 * @param scheduler The scheduler for the operation.
     188 * @param the_thread The corresponding thread.
     189 * @param priority_node The priority node for the operation.
     190 * @param queue_context The thread queue context.
     191 */
    163192void _Scheduler_CBS_Cancel_job(
    164193  const Scheduler_Control *scheduler,
     
    169198
    170199/**
    171  *  @brief _Scheduler_CBS_Initialize
    172  *
    173  *  Initializes the CBS library.
    174  *
    175  *  @retval status code.
     200 * @brief _Scheduler_CBS_Initialize
     201 *
     202 * Initializes the CBS library.
     203 *
     204 * @return SCHEDULER_CBS_OK This method always returns this status.
    176205 */
    177206int _Scheduler_CBS_Initialize(void);
    178207
    179208/**
    180  *  @brief Attach a task to an already existing server.
    181  *
    182  *  Attach a task to an already existing server.
    183  *
    184  *  @retval status code.
     209 * @brief Attaches a task to an already existing server.
     210 *
     211 * Attach a task to an already existing server.
     212 *
     213 * @param server_id The id of the existing server.
     214 * @param task_id The id of the task to attach.
     215 *
     216 * @retval SCHEDULER_CBS_OK The operation was successful.
     217 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is so big
     218 *      or there is no thread for this task id.
     219 * @retval SCHEDULER_CBS_ERROR_NOSERVER The server is not yet initialized.
     220 * @retval SCHEDULER_CBS_ERROR_FULL The server already has a task.
    185221 */
    186222int _Scheduler_CBS_Attach_thread (
     
    190226
    191227/**
    192  *  @brief Detach from the CBS Server.
    193  *
    194  *  Detach from the CBS Server.
    195  *
    196  *  @retval status code.
     228 * @brief Detaches from the CBS Server.
     229 *
     230 * Detach from the CBS Server.
     231 *
     232 * @param server_id The id of the existing server.
     233 * @param task_id The id of the task to attach.
     234 *
     235 * @retval SCHEDULER_CBS_OK The operation was successful.
     236 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is to big,
     237 *      or the task with this id is not attached to this server or there is
     238 *      no thread with this task.
     239 * @retval SCHEDULER_CBS_ERROR_NOSERVER The server is not yet initialized.
    197240 */
    198241int _Scheduler_CBS_Detach_thread (
     
    202245
    203246/**
    204  *  @brief Cleanup resources associated to the CBS Library.
    205  *
    206  *  Cleanup resources associated to the CBS Library.
    207  *
    208  *  @retval status code.
     247 * @brief Cleans up resources associated to the CBS Library.
     248 *
     249 * Cleanup resources associated to the CBS Library.
     250 *
     251 * @return This method always returns SCHEDULER_CBS_OK.
    209252 */
    210253int _Scheduler_CBS_Cleanup (void);
    211254
    212255/**
    213  *  @brief Create a new server with specified parameters.
    214  *
    215  *  Create a new server with specified parameters.
    216  *
    217  *  @retval status code.
     256 * @brief Creates a new server with specified parameters.
     257 *
     258 * Create a new server with specified parameters.
     259 *
     260 * @param params The parameters for the server.
     261 * @param budget_overrun_callback The budget overrun for the new server.
     262 * @param[out] server_id In the case of success, this parameter contains the
     263 *      id of the newly created server.
     264 *
     265 * @retval SCHEDULER_CBS_OK The operation succeeded.
     266 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The given parameters are invalid.
     267 * @retval SCHEDULER_CBS_ERROR_FULL The maximum number of servers was already
     268 *      created, a new server cannot be created.
    218269 */
    219270int _Scheduler_CBS_Create_server (
     
    224275
    225276/**
    226  *  @brief Detach all tasks from a server and destroy it.
    227  *
    228  *  Detach all tasks from a server and destroy it.
    229  *
    230  *  @param[in] server_id is the ID of the server
    231  *
    232  *  @retval status code.
     277 * @brief Detaches all tasks from a server and destroys it.
     278 *
     279 * Detach all tasks from a server and destroy it.
     280 *
     281 * @param server_id The id of the server to destroy.
     282 *
     283 * @retval SCHEDULER_CBS_OK The operation was successful.
     284 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is too big.
     285 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no initialized server with this id.
    233286 */
    234287int _Scheduler_CBS_Destroy_server (
     
    237290
    238291/**
    239  *  @brief Retrieve the approved budget.
    240  *
    241  *  Retrieve the budget that has been approved for the subsequent
    242  *  server instances.
    243  *
    244  *  @retval status code.
     292 * @brief Retrieves the approved budget.
     293 *
     294 * Retrieve the budget that has been approved for the subsequent
     295 * server instances.
     296 *
     297 * @param server_id The id of the server instance of which the budget is wanted.
     298 * @param[out] approved_budget Contains the approved budget after a successful method call.
     299 *
     300 * @retval SCHEDULER_CBS_OK The operation was successful.
     301 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is too big.
     302 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no initialized server with this id.
    245303 */
    246304int _Scheduler_CBS_Get_approved_budget (
     
    250308
    251309/**
    252  *  @brief Retrieve remaining budget for the current server instance.
    253  *
    254  *  Retrieve remaining budget for the current server instance.
    255  *
    256  *  @retval status code.
     310 * @brief Retrieves remaining budget for the current server instance.
     311 *
     312 * Retrieve remaining budget for the current server instance.
     313 *
     314 * @param server_id The id of the server instance of which the remaining budget is wanted.
     315 * @param[out] remaining_budget Contains the remaining budget after a successful method call.
     316 *
     317 * @retval SCHEDULER_CBS_OK The operation was successful.
     318 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is too big.
     319 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no initialized server with this id.
    257320 */
    258321int _Scheduler_CBS_Get_remaining_budget (
     
    262325
    263326/**
    264  *  @brief Get relative time info.
    265  *
    266  *  Retrieve time info relative to @a server_id. The server status code is returned.
    267  *
    268  *  @param[in] server_id is the server to get the status code from.
    269  *  @param[in] exec_time is the execution time.
    270  *  @param[in] abs_time is not apparently used.
    271  *
    272  *  @retval status code.
     327 * @brief Gets relative time info.
     328 *
     329 * Retrieve time info relative to @a server_id. The server status code is returned.
     330 *
     331 * @param server_id is the server to get the status code from.
     332 * @param[out] exec_time Contains the execution time after a successful method call.
     333 * @param abs_time Not apparently used.
     334 *
     335 * @retval SCHEDULER_CBS_OK The operation was successful.
     336 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is too big.
     337 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no initialized server with this id.
    273338 */
    274339int _Scheduler_CBS_Get_execution_time (
     
    279344
    280345/**
    281  *  @brief Retrieve CBS scheduling parameters.
    282  *
    283  *  Retrieve CBS scheduling parameters.
    284  *
    285  *  @retval status code.
     346 * @brief Retrieves CBS scheduling parameters.
     347 *
     348 * Retrieve CBS scheduling parameters.
     349 *
     350 * @param server_id The id of the server to get the scheduling parameters from.
     351 * @param[out] params Will contain the scheduling parameters after successful method call.
     352 *
     353 * @retval SCHEDULER_CBS_OK The operation was successful.
     354 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is too big.
     355 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no initialized server with this id.
    286356 */
    287357int _Scheduler_CBS_Get_parameters (
     
    291361
    292362/**
    293  *  @brief Get a thread server id.
    294  *
    295  *  Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not
    296  *  attached to any server.
    297  *
    298  *  @retval status code.
     363 * @brief Gets a thread server id.
     364 *
     365 * Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not
     366 * attached to any server.
     367 *
     368 * @param task_id The id of the task to get the corresponding server.
     369 * @param[out] server_id Will contain the server id after successful method call.
     370 * @retval SCHEDULER_CBS_OK The operation was successful
     371 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no server with this task attached.
    299372 */
    300373int _Scheduler_CBS_Get_server_id (
     
    304377
    305378/**
    306  *  @brief Set parameters for CBS scheduling.
    307  *
    308  *  Change CBS scheduling parameters.
    309  *
    310  *  @param[in] server_id is the ID of the server.
    311  *  @param[in] parameters are the parameters to set.
    312  *
    313  *  @retval status code.
     379 * @brief Sets parameters for CBS scheduling.
     380 *
     381 * Change CBS scheduling parameters.
     382 *
     383 * @param server_id The id of the server.
     384 * @param parameters The parameters to set.
     385 *
     386 * @retval SCHEDULER_CBS_OK The operation was successful.
     387 * @retval SCHEDULER_CBS_ERROR_INVALID_PARAMETER The server id is too big or the
     388 *      given parameters are invalid.
     389 * @retval SCHEDULER_CBS_ERROR_NOSERVER There is no server with this id.
    314390 */
    315391int _Scheduler_CBS_Set_parameters (
     
    319395
    320396/**
    321  *  @brief Invoked when a limited time quantum is exceeded.
    322  *
    323  *  This routine is invoked when a limited time quantum is exceeded.
     397 * @brief Invoked when a limited time quantum is exceeded.
     398 *
     399 * This routine is invoked when a limited time quantum is exceeded.
     400 *
     401 * @param the_thread The thread that exceeded a limited time quantum.
    324402 */
    325403void _Scheduler_CBS_Budget_callout(
     
    328406
    329407/**
    330  *  @brief Initializes a CBS specific scheduler node of @a the_thread.
     408 * @brief Initializes a CBS specific scheduler node of @a the_thread.
     409 *
     410 * @param scheduler The scheduler control for the operation.
     411 * @param[out] node The scheduler node to initalize.
     412 * @param the_thread The thread to initialize a scheduler node for.
     413 * @param priority The priority for the node.
    331414 */
    332415void _Scheduler_CBS_Node_initialize(
     
    341424#endif
    342425
    343 /**@}*/
     426/** @} */
    344427
    345428#endif
Note: See TracChangeset for help on using the changeset viewer.