From 72d22c45e958a3e3ac8b5f332ea43579eafbccd0 Mon Sep 17 00:00:00 2001 From: Hyotaek Shim Date: Mon, 11 Jul 2022 12:53:25 +0900 Subject: [PATCH] Refine the explanation of cpu-boosting set/clear APIs Change-Id: I1132400b79b7ff008d0cf3ebaa54ae518417df11 Signed-off-by: Hyotaek Shim --- include/cpu-boosting.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/include/cpu-boosting.h b/include/cpu-boosting.h index c62a20c..9ec06a1 100644 --- a/include/cpu-boosting.h +++ b/include/cpu-boosting.h @@ -31,8 +31,10 @@ extern "C" { /** * @brief Set cpu boosting for the target process (pid/tids). + * @since_tizen 6.5 * * @details The original cpu schedule configuration of the target process is backed up if it is currently not boosted. + * Another set request on the boosted target overrides the previous one. * * @privlevel partner * @privilege http://tizen.org/privilege/internal/default/partner @@ -51,9 +53,10 @@ extern "C" { int resource_set_cpu_boosting (resource_pid_t pid, cpu_boosting_level_e level, int timeout_msec); /** - * @brief Clear cpu boosting for the target process (pid/tids). + * @brief Clear cpu boosting for the boosted process (pid/tids). + * @since_tizen 6.5 * - * @details The backed-up cpu schedule configuration of the target process is restored. \n + * @details The backed-up cpu schedule configuration of the boosted process is restored. \n * Without the backed-up configuration, the default non-boosting configuration (SCHED_OTHER and nice=0) is applied. \n * * @privlevel partner @@ -72,6 +75,7 @@ int resource_clear_cpu_boosting (resource_pid_t pid); /** * @brief Get the cpu boosting level for the target process (pid/tids). + * @since_tizen 6.5 * * @param[in] pid The target process pid/tids \n * If pid.pid is nonzero, pid.tid and pid.tid_count are ignored, \n @@ -89,6 +93,7 @@ int resource_get_cpu_boosting_level (resource_pid_t pid, cpu_boosting_level_info /** * @brief Set cpu resource inheritance from the source tid to the destination process (pid/tids). + * @since_tizen 6.5 * * @privlevel partner * @privilege http://tizen.org/privilege/internal/default/partner @@ -103,6 +108,7 @@ int resource_set_cpu_inheritance (pid_t source_tid, const char *dest_process, in /** * @brief Clear cpu resource inheritance from the source tid to the destination process (pid/tids). + * @since_tizen 6.5 * * @privlevel partner * @privilege http://tizen.org/privilege/internal/default/partner @@ -116,6 +122,7 @@ int resource_clear_cpu_inheritance (pid_t source_tid, const char *dest_process); /** * @brief Register a destination process (pid/tids) for cpu resource inheritance. + * @since_tizen 6.5 * * @privlevel partner * @privilege http://tizen.org/privilege/internal/default/partner @@ -134,6 +141,7 @@ int resource_register_cpu_inheritance_destination (const char *dest_process, res /** * @brief Unregister a destination process for cpu resource inheritance. + * @since_tizen 6.5 * * @privlevel partner * @privilege http://tizen.org/privilege/internal/default/partner -- 2.34.1