Changes since version 5:
Per feedback from Petri S.
Renamed ODP_CPUMASK_BUFSIZE to ODP_CPUMASK_STR_SIZE.
Renamed ODP_PKTIO_MACADDRSIZE to ODP_PKTIO_MACADDR_MAXSIZE.
Reverted parameter name change from "id" to "hdl" in patch #2.
Reverted description of odp_pktio_mac_addr() in patch #2.
Split out patches #8-#9.
A number of patches that passed review already merged.

Changes since version 4:
Restored parameter names of odp_cpumask_to_str(), odp_pktio_mac_addr()
and odp_hw_random_get().

Changes since version 3:
Removed unnecessary braces from odp_cpumask.c in patch #1.

Changes since version 2:
Rebased, e.g. due to API restructuring.
Split two patches, separating documentation updates from API changes.
Reordered patches, all serious API changes are now contained in patches 1-4.

Patches #1-#2:
odp_cpumask_to_str() and odp_pktio_mac_addr() takes output buffer
size as input and returns number of chars/bytes written (on success),
a negative value on failure.
Added defines (ODP_CPUMASK_STR_SIZE, ODP_PKTIO_MACADDR_MAXSIZE) for
recommended output buffer sizes.
Updated the implementations of these calls.
Updated all usages of these calls in example and test programs.

Patches #3-#7:
Updated doxygen descriptions, particularly the @return/@retval descriptions.
Specifically documented those API calls which are guaranteed to handle
invalid/stale handles.
No change of implementation necessary.

Patch #8:
odp_pktio_recv() and odp_pktio_send() use int for 'len' parameter to
match return type.

Patch #9:
Use 'pktio' as the parameter name for all packet IO handles.
Unify the descriptions to say "packet IO handle".

(This document/code contribution attached is provided under the terms of
agreement LES-LTM-21309)

Ola Liljedahl (9):
  api: odp_cpumask.h: odp_cpumask_to_str() return chars written or error
  api: odp_pktio.h: odp_pktio_mac_addr() return chars written or error
  api: odp_buffer.h: undefined behavior description
  api: odp_init.h: updated return descriptions
  api: odp_packet_io.h: updated return descriptions
  api: odp_shared_memory.h: updated return descriptions
  api: odp_timer.h: updated return descriptions
  api: odp_packet_io.h: use int for size of pkt_tables
  api: odp_packet_io.h: clean up pktio parameter names and descriptions

 example/generator/odp_generator.c                  |   4 +-
 example/ipsec/odp_ipsec.c                          |   4 +-
 example/l2fwd/odp_l2fwd.c                          |   4 +-
 example/packet/odp_pktio.c                         |   4 +-
 example/timer/odp_timer_test.c                     |   4 +-
 include/odp/api/buffer.h                           |   4 +-
 include/odp/api/cpumask.h                          |  23 +++-
 include/odp/api/init.h                             |  22 ++--
 include/odp/api/packet_io.h                        | 135 ++++++++++++---------
 include/odp/api/shared_memory.h                    |  18 +--
 include/odp/api/timer.h                            |  38 ++----
 .../linux-generic/include/odp/plat/cpumask_types.h |   5 +
 .../include/odp/plat/packet_io_types.h             |   2 +
 platform/linux-generic/odp_cpumask.c               |  26 ++--
 platform/linux-generic/odp_packet_io.c             |  15 +--
 test/api_test/odp_common.c                         |   4 +-
 test/performance/odp_scheduling.c                  |   4 +-
 test/validation/odp_pktio.c                        |   8 +-
 18 files changed, 176 insertions(+), 148 deletions(-)

-- 
1.9.1


_______________________________________________
lng-odp mailing list
[email protected]
http://lists.linaro.org/mailman/listinfo/lng-odp

Reply via email to