From: Harry van Haaren Date: Mon, 21 Aug 2017 12:58:15 +0000 (+0100) Subject: service: clarify documentation for register X-Git-Tag: spdx-start~2156 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=c2150ad4c46427e72fe1b21fc35a77cf1bab193d;p=dpdk.git service: clarify documentation for register This commit adds a section to the service register function to make it clear that registering a service, must not configure service-cores (eg: adding lcores or changing mappings). Signed-off-by: Harry van Haaren Acked-by: Pavan Nikhilesh --- diff --git a/lib/librte_eal/common/include/rte_service_component.h b/lib/librte_eal/common/include/rte_service_component.h index 5e4573b5ad..ac965cb485 100644 --- a/lib/librte_eal/common/include/rte_service_component.h +++ b/lib/librte_eal/common/include/rte_service_component.h @@ -85,8 +85,13 @@ struct rte_service_spec { * * For example the eventdev SW PMD requires CPU cycles to perform its * scheduling. This can be achieved by registering it as a service, and the - * application can then assign CPU resources to it using - * *rte_service_set_coremask*. + * application can then assign CPU resources to that service. + * + * Note that when a service component registers itself, it is not permitted to + * add or remove service-core threads, or modify lcore-to-service mappings. The + * only API that may be called by the service-component is + * *rte_service_component_runstate_set*, which indicates that the service + * component is ready to be executed. * * @param spec The specification of the service to register * @param[out] service_id A pointer to a uint32_t, which will be filled in