On Fri, Jun 16, 2017 at 8:04 AM, Savolainen, Petri (Nokia - FI/Espoo)
<petri.savolai...@nokia.com> wrote:
>> > diff --git a/include/odp/api/spec/event.h b/include/odp/api/spec/event.h
>> > index f22efce5..2ad3ce84 100644
>> > --- a/include/odp/api/spec/event.h
>> > +++ b/include/odp/api/spec/event.h
>> > @@ -37,21 +37,91 @@ extern "C" {
>> >
>> > /**
>> > * @typedef odp_event_type_t
>> > - * ODP event types:
>> > - * ODP_EVENT_BUFFER, ODP_EVENT_PACKET, ODP_EVENT_TIMEOUT,
>> > - * ODP_EVENT_CRYPTO_COMPL, ODP_EVENT_IPSEC_RESULT,
>> ODP_EVENT_IPSEC_STATUS
>> > + * Event type
>> > + *
>> > + * Event type specifies purpose and general format of an event. It can
>> be
>> > + * checked with odp_event_type() or odp_event_types(). Each event type
>> has
>> > + * functions (e.g. odp_buffer_from_event()) to convert between the
>> generic event
>> > + * handle (odp_event_t) and the type specific handle (e.g.
>> odp_buffer_t).
>> > + * Results are undefined, if conversion function of a wrong event type
>> is used.
>> > + * Application cannot change event type by chaining conversion
>> functions.
>> > + *
>> > + * List of event types:
>> > + * - ODP_EVENT_BUFFER
>> > + * - Buffer event (odp_buffer_t) for simple data storage and
>> message passing
>> > + * - ODP_EVENT_PACKET
>> > + * - Packet event (odp_packet_t) containing packet data and plenty
>> of
>>
>> Why "plenty of"? "containing packet data and associated metadata"
>> seems sufficient.
>
> It highlights that packets should be used only for packets, not as random
> buffer space (buffers are simple vs. packets are complex).
Ok, it just looked a bit odd. Not a biggie.
>
> BTW. It would have been nice to get all review comments in one go. I did sent
> v3 as there were no more comments. I cannot do v4 before our lab is back
> online from a maintenance break... Hopefully v4 is not necessary.
Still working on it. This series needs Bala and Nikhil's reviews as a
check against their HW. But so far this looks very reasonable.
>
> -Petri
