Re: [dpdk-dev] [PATCH v5 2/7] net: Add common PTP structures and functions

[Thomas Monjalon <thomas.monjalon@6wind.com>]

2015-11-11 10:45, Mcnamara, John:
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> > The library librte_net gather some structures and functions for network
> > headers/layers parsing.
> > These PTP functions looks really generic. Why not add them in EAL?
> > Maybe they could benefit from specific implementations in the arch/
> > directory.
> 
> Hi Thomas,
> 
> How about the following location and new header file?
> 
>     lib/librte_eal/common/include/rte_time.h

Yes

> > > +static inline uint64_t
> > > +timespec_to_ns(const struct timespec *ts)
> > [...]
> > > +static inline struct timespec
> > > +ns_to_timespec(uint64_t nsec)
> > [...]
> > > +static inline uint64_t
> > > +cyclecounter_cycles_to_ns(const struct cyclecounter *cc,
> > > +		      uint64_t cycles, uint64_t mask, uint64_t *frac)
> > [...]
> > > +static inline uint64_t
> > > +cyclecounter_cycles_to_ns_backwards(const struct cyclecounter *cc,
> > > +			       uint64_t cycles, uint64_t frac)
> > 
> > They must be prefixed with rte_ with full doxygen comments.
> 
> We can do that. But is the intention that these function are public? We really only need them internally. It is possible that they could be used somewhere else but probably not likely. How about if we document them but mark them as @internal in Doxygen. Then if they are require by some other libs they can be made external at a later stage.

Yes they can be marked @internal with rte_ prefix.