From: Hyotaek Shim Date: Wed, 29 Jun 2022 02:40:05 +0000 (+0900) Subject: Add API privilege declaration and fix typo in API spec X-Git-Tag: submit/tizen_6.5/20220630.054955~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=23eb26b275a172a7586b4828b02be7944775964f;p=platform%2Fcore%2Fapi%2Fresource.git Add API privilege declaration and fix typo in API spec Change-Id: Id5c6330ec069dfcc55407c44a5d5a122d1dfc818 Signed-off-by: Hyotaek Shim (cherry picked from commit 2e4d9374164a7eff0a5f345906d1f41ea4041288) --- diff --git a/include/cpu-boosting.h b/include/cpu-boosting.h index 39f1e8a..e48a5e8 100644 --- a/include/cpu-boosting.h +++ b/include/cpu-boosting.h @@ -32,11 +32,15 @@ extern "C" { /** * @brief Set cpu boosting for the target process (pid/tids). * - * @remarks The original cpu schedule configuration of the target process is backed up if it is currently not boosted. \n + * @details The original cpu schedule configuration of the target process is backed up if it is currently not boosted. + * + * @privlevel partner + * @privilege http://tizen.org/privilege/internal/default/partner + * * @param[in] pid The target process pid/tids \n * If pid.pid is nonzero, pid.tid and pid.tid_count are ignored, \n * and cpu boosting is applied for all the threads of pid.pid. \n - * If pid.pid is zero and pid.tid is not NULL, all tids in the list are used \n + * If pid.pid is zero and pid.tid is not NULL, all tids in pid.tid are used. \n * If pid.pid is zero and pid.tid is NULL, tid of the calling thread is used. \n * The caller must (de)allocate the buffer in the pid.tid pointer. * @param[in] level The cpu boosting level @@ -49,12 +53,16 @@ int resource_set_cpu_boosting (resource_pid_t pid, cpu_boosting_level_e level, i /** * @brief Clear cpu boosting for the target process (pid/tids). * - * @remarks The backed-up cpu schedule configuration of the target process is restored. \n + * @details The backed-up cpu schedule configuration of the target process is restored. \n * Without the backed-up configuration, the default non-boosting configuration (SCHED_OTHER and nice=0) is applied. \n + * + * @privlevel partner + * @privilege http://tizen.org/privilege/internal/default/partner + * * @param[in] pid The target process pid/tids \n * If pid.pid is nonzero, pid.tid and pid.tid_count are ignored, \n * and cpu boosting is cleared for all the threads of pid.pid. \n - * If pid.pid is zero and pid.tid is not NULL, all tids in the list are used \n + * If pid.pid is zero and pid.tid is not NULL, all tids in pid.tid are used. \n * If pid.pid is zero and pid.tid is NULL, tid of the calling thread is used. \n * The caller must (de)allocate the buffer in the pid.tid pointer. * @@ -68,12 +76,12 @@ int resource_clear_cpu_boosting (resource_pid_t pid); * @param[in] pid The target process pid/tids \n * If pid.pid is nonzero, pid.tid and pid.tid_count are ignored, \n * and all the threads of pid.pid are checked. \n - * If pid.pid is zero and pid.tid is not NULL, all tids in the list are checked. \n + * If pid.pid is zero and pid.tid is not NULL, all tids in pid.tid are checked. \n * If pid.pid is zero and pid.tid is NULL, the calling thread is checked. \n * The caller must (de)allocate the buffer in the pid.tid pointer. * @param[out] level The boosting level for the target process (pid/tids) \n * The level->tid_level array will be filled with cpu_boosting_level_e for tids requested by the pid argument. \n - * The caller must (de)allocate the buffer in the level.tid_level pointer. + * The caller must (de)allocate the buffer in the level->tid_level pointer. * * @return 0 on success, otherwise a negative error value. */ @@ -82,6 +90,9 @@ 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). * + * @privlevel partner + * @privilege http://tizen.org/privilege/internal/default/partner + * * @param[in] source_tid The caller thread tid * @param[in] dest_process The name of destination process * @param[in] timeout_msec The timeout in milliseconds, -1 to apply inheritance permanently @@ -93,6 +104,9 @@ int resource_set_cpu_inheritance (int source_tid, const char *dest_process, int /** * @brief Clear cpu resource inheritance from the source tid to the destination process (pid/tids). * + * @privlevel partner + * @privilege http://tizen.org/privilege/internal/default/partner + * * @param[in] source_tid The caller thread's tid * @param[in] dest_process The name of destination process * @@ -103,12 +117,15 @@ int resource_clear_cpu_inheritance (int source_tid, const char *dest_process); /** * @brief Register a destination process (pid/tids) for cpu resource inheritance. * + * @privlevel partner + * @privilege http://tizen.org/privilege/internal/default/partner + * * @param[in] dest_process The name of destination process * @param[in] pid The destination process pid/tids \n - * If pid.pid is nonzero, pid.tid and pid.tid_count are ignored. \n + * If pid.pid is nonzero, pid.tid and pid.tid_count are ignored, \n * and all the threads of pid.pid are registered. \n - * If pid.pid is zero and pid.tid is not NULL, all tids in the list are used \n - * If pid.pid is zero and pid.tid is NULL, pid of the calling thread is used. \n + * If pid.pid is zero and pid.tid is not NULL, all tids in pid.tid are registered. \n + * If pid.pid is zero and pid.tid is NULL, tid of the calling thread is registered. \n * The caller must (de)allocate the buffer in the pid.tid pointer. * * @return 0 on success, otherwise a negative error value. @@ -118,6 +135,9 @@ int resource_register_cpu_inheritance_destination (const char *dest_process, res /** * @brief Unregister a destination process for cpu resource inheritance. * + * @privlevel partner + * @privilege http://tizen.org/privilege/internal/default/partner + * * @param[in] dest_process The name of destination process * * @return 0 on success, otherwise a negative error value.