Minor rewording for clarity and to specify 0 as a don't care value for the align parameter and to define behavior on excessive alignment requests.
Signed-off-by: Bill Fischofer <[email protected]> --- include/odp/api/spec/packet.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/include/odp/api/spec/packet.h b/include/odp/api/spec/packet.h index de128df..5e84abb 100644 --- a/include/odp/api/spec/packet.h +++ b/include/odp/api/spec/packet.h @@ -646,11 +646,11 @@ int odp_packet_rem_data(odp_packet_t *pkt, uint32_t offset, uint32_t len); * Align packet data * * Modify packet data alignment so that 'len' bytes between 'offset' and - * 'offset' plus 'len' are contiguous in memory and start in minimum alignment + * 'offset' plus 'len' are contiguous in memory and have a minimum alignment * of 'align' bytes. * * A successful operation overwrites the packet handle with a new handle, which - * application must use as the reference to the packet instead of the old + * the application must use as the reference to the packet instead of the old * handle. Depending on the implementation, the old and new handles may be * equal. * @@ -667,7 +667,11 @@ int odp_packet_rem_data(odp_packet_t *pkt, uint32_t offset, uint32_t len); * @param offset Byte offset of the contiguous area * @param len Byte length of the contiguous area (0 ... packet_len) * @param align Minimum byte alignment of the contiguous area. - * Implementation rounds up to nearest power of two. + * Valid values are powers of 2. Use 0 to indicate no + * special alignment requirement. All implementations + * support alignments of up to at least 32 bytes. Request + * will fail if requested alignment exceeds implementation + * limits. * * @retval 0 Operation successful, old pointers remain valid * @retval >0 Operation successful, old pointers need to be updated -- 2.5.0 _______________________________________________ lng-odp mailing list [email protected] https://lists.linaro.org/mailman/listinfo/lng-odp
