From: Harry van Haaren Date: Mon, 21 Aug 2017 12:58:16 +0000 (+0100) Subject: doc: add notes on service cores API updates X-Git-Tag: spdx-start~2155 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=c4c6f682292b8c8987cd0f9d247794d50f875dee;p=dpdk.git doc: add notes on service cores API updates Add a section on the service cores API changes to 17.11 release notes. Suggested-by: Neil Horman Signed-off-by: Harry van Haaren Acked-by: Pavan Nikhilesh --- diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst index 6e6ba1c862..8bf91bd40e 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -117,6 +117,19 @@ API Changes Also, make sure to start the actual text at the margin. ========================================================= +* **Service cores API updated for usability** + + The service cores API has been changed, removing pointers from the API + where possible, instead using integer IDs to identify each service. This + simplifed application code, aids debugging, and provides better + encapsulation. A summary of the main changes made is as follows: + + * Services identified by ID not by ``rte_service_spec`` pointer + * Reduced API surface by using ``set`` functions instead of enable/disable + * Reworked ``rte_service_register`` to provide the service ID to registrar + * Rework start and stop APIs into ``rte_service_runstate_set`` + * Added API to set runstate of service implementation to indicate readyness + ABI Changes -----------