[dpdk-dev] [PATCH v10 1/2] librte_net: add crc compute APIs

[Thomas Monjalon]

2017-04-05 15:58, Jasvinder Singh:
> APIs for selecting the architecure specific implementation and computing
> the crc (16-bit and 32-bit CRCs) are added. For CRCs calculation, scalar
> as well as x86 intrinsic(sse4.2) versions are implemented.
> 
> The scalar version is based on generic Look-Up Table(LUT) algorithm,
> while x86 intrinsic version uses carry-less multiplication for
> fast CRC computation.
> 
> Signed-off-by: Jasvinder Singh <jasvinder.singh at intel.com>
> Acked-by: Pablo de Lara <pablo.de.lara.guarch at intel.com>

There is a remaining error with doxygen:
	lib/librte_net/rte_net_crc_sse.h:153:
	warning: documented symbol `static const uint8_t crc_xmm_shift_tab'
	was not declared or defined.

> --- a/lib/librte_net/Makefile
> +++ b/lib/librte_net/Makefile
> @@ -39,10 +39,12 @@ EXPORT_MAP := rte_net_version.map
>  LIBABIVER := 1
>  
>  SRCS-$(CONFIG_RTE_LIBRTE_NET) := rte_net.c
> +SRCS-$(CONFIG_RTE_LIBRTE_NET) += rte_net_crc.c
>  
>  # install includes
>  SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include := rte_ip.h rte_tcp.h rte_udp.h
>  SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_sctp.h rte_icmp.h rte_arp.h
>  SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_ether.h rte_gre.h rte_net.h
> +SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_net_crc.h

As rte_net_crc_sse.h is not exported, you should avoid doxygen generation.
I suggest removing the rte_ prefix of the filename, so it will make
clear that it is a private header and doxygen should ignore it
(because of FILE_PATTERNS = rte_*.h).