[API-NEXT,v1,1/3] api: packet_io: refine packet format on output

Message ID 1504702806-13800-2-git-send-email-odpbot@yandex.ru
State New
Headers show
Series
  • [API-NEXT,v1,1/3] api: packet_io: refine packet format on output
Related show

Commit Message

Github ODP bot Sept. 6, 2017, 1 p.m.
From: Petri Savolainen <petri.savolainen@linaro.org>


Define explicitly that (by default) packet output does not
need any extra metadata to be set. Also (Ethernet) padding
and CRC are added by default.

Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>

---
/** Email created from pull request 167 (psavol:next-pkt-checksum)
 ** https://github.com/Linaro/odp/pull/167
 ** Patch: https://github.com/Linaro/odp/pull/167.patch
 ** Base sha: 4eae04e80a634c17ac276bb06bce468cbe28cde0
 ** Merge commit sha: fb1526ce83d639bbbd28205b31145e0e15153508
 **/
 include/odp/api/spec/packet_io.h | 5 +++++
 1 file changed, 5 insertions(+)

Patch

diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h
index d42cebf0..6040a831 100644
--- a/include/odp/api/spec/packet_io.h
+++ b/include/odp/api/spec/packet_io.h
@@ -889,6 +889,11 @@  uint64_t odp_pktin_wait_time(uint64_t nsec);
  * is less than 'num', the remaining packets at the end of packets[] array
  * are not consumed, and the caller has to take care of them.
  *
+ * Entire packet data is sent out (odp_packet_len() bytes of data, starting from
+ * odp_packet_data()). All other packet metadata is ignored unless otherwise
+ * specified e.g. for protocol offload purposes. Link protocol specific frame
+ * checksum and padding are added to frames before transmission.
+ *
  * @param queue        Packet output queue handle for sending packets
  * @param packets[]    Array of packets to send
  * @param num          Number of packets to send