From patchwork Tue Jan 30 16:00:00 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Github ODP bot X-Patchwork-Id: 126268 Delivered-To: patch@linaro.org Received: by 10.46.84.92 with SMTP id y28csp3487864ljd; Tue, 30 Jan 2018 08:03:36 -0800 (PST) X-Google-Smtp-Source: AH8x227T6XTRDUVBhwgK1+wG0tD5TFcS7GzfjSnQubYDSAgArULD7oMoB5/olyLbJli2OyFHnlEw X-Received: by 10.37.139.16 with SMTP id i16mr3999296ybl.77.1517328216328; Tue, 30 Jan 2018 08:03:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1517328216; cv=none; d=google.com; s=arc-20160816; b=cmaBUUP2E4btCo1VbdB1vJbqaxKne98hIcgtmpbDahB5J0OmyO7NKn+iic/ZIBSedm DjXZgk67DSsTx3jCGQRtAne+yMU1pqWmyTpiXrHOBRuwg36aQswC1P2u91Gj0za0478s PTSubmYpBl3fd01FU8cjVCBz9xzN+0OmCtO7mDnGDK/x7QUCX/LA1G0JOwHpiuE1PYDv iQoQWokpW+vI7E+NKztfIFn3Lcoo9tRhZKRYjhSehiXP117/0sOonBWvEKb/1PUPd1/K ZFJNCodTpBLohAaH35e4WHYYuEK882kiiQ8bbitcwnhpazB5o/wgC9DPrmvDV0Q88HXl 5s0Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:github-pr-num :references:in-reply-to:message-id:date:to:from:delivered-to :arc-authentication-results; bh=pNwxe09/3dUEsXpT5V2HhchpP0ltH1nhBZzXrOF3a7U=; b=l4JlnyFqxEgaoo69XzsqKR+J9uVgBhhAocEfsom4LQTJKLeheotrxw2ED5Y5x0mOd4 cUySVwyDiw5Crb0J9FRSNY/Yicd81hW9pPz6ojEKklFM60wEqeJPyYzMirP42l7rU9yj gW87mn9aLwHlBW+LYtwlP3e4W2cQga3o8tqzdvr6HME59LvWuyLGdKMUQAhBc/Q4VXU+ GP7NTd8teMgpPfOsNhQnf0Ar3HBJ2XxheWRsWq48Typn3C0wmmI+29VDjJmgqsfWsoH3 sIOjtieKonZ6h+dSknqRnudCNIc97mSMPI0qsVhBTQXmsEBUZLD3a6rvQvFGfYU4BURU ywDA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.197.127.237 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Return-Path: Received: from lists.linaro.org (ec2-54-197-127-237.compute-1.amazonaws.com. [54.197.127.237]) by mx.google.com with ESMTP id f70si2671232ywh.747.2018.01.30.08.03.36; Tue, 30 Jan 2018 08:03:36 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.197.127.237 as permitted sender) client-ip=54.197.127.237; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.197.127.237 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Received: by lists.linaro.org (Postfix, from userid 109) id EBC72616E1; Tue, 30 Jan 2018 16:03:35 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 4F9B660B0E; Tue, 30 Jan 2018 16:00:44 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 7F076616E1; Tue, 30 Jan 2018 16:00:24 +0000 (UTC) Received: from forward106o.mail.yandex.net (forward106o.mail.yandex.net [37.140.190.187]) by lists.linaro.org (Postfix) with ESMTPS id 62BCA60B0E for ; Tue, 30 Jan 2018 16:00:14 +0000 (UTC) Received: from mxback17j.mail.yandex.net (mxback17j.mail.yandex.net [IPv6:2a02:6b8:0:1619::93]) by forward106o.mail.yandex.net (Yandex) with ESMTP id CABBA783183 for ; Tue, 30 Jan 2018 19:00:12 +0300 (MSK) Received: from smtp4o.mail.yandex.net (smtp4o.mail.yandex.net [2a02:6b8:0:1a2d::28]) by mxback17j.mail.yandex.net (nwsmtp/Yandex) with ESMTP id MhvGfC6qvU-0CnC6UFj; Tue, 30 Jan 2018 19:00:12 +0300 Received: by smtp4o.mail.yandex.net (nwsmtp/Yandex) with ESMTPSA id Nz8CQ597Mi-0CRubENo; Tue, 30 Jan 2018 19:00:12 +0300 (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (Client certificate not present) From: Github ODP bot To: lng-odp@lists.linaro.org Date: Tue, 30 Jan 2018 19:00:00 +0300 Message-Id: <1517328009-16379-3-git-send-email-odpbot@yandex.ru> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1517328009-16379-1-git-send-email-odpbot@yandex.ru> References: <1517328009-16379-1-git-send-email-odpbot@yandex.ru> Github-pr-num: 437 Subject: [lng-odp] [PATCH v1 2/11] linux-gen: packet: remove dummy doxygen documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" From: Petri Savolainen Use @cond tag to hide internal functions from Doxygen. Signed-off-by: Petri Savolainen --- /** Email created from pull request 437 (psavol:master-packet-optim) ** https://github.com/Linaro/odp/pull/437 ** Patch: https://github.com/Linaro/odp/pull/437.patch ** Base sha: b95ccd3db6eeb7358a877541747e06354429acdd ** Merge commit sha: ab7875c186fe80cfe103c5be5634b0eda312aed4 **/ .../include/odp/api/plat/packet_inlines.h | 39 +++------------------- 1 file changed, 5 insertions(+), 34 deletions(-) diff --git a/platform/linux-generic/include/odp/api/plat/packet_inlines.h b/platform/linux-generic/include/odp/api/plat/packet_inlines.h index fb9c524fb..765bafb4f 100644 --- a/platform/linux-generic/include/odp/api/plat/packet_inlines.h +++ b/platform/linux-generic/include/odp/api/plat/packet_inlines.h @@ -23,63 +23,52 @@ #include #include -/** @internal Inline function @param pkt_ptr @param offset @param seg_len - * @param seg_idx @return */ +/** @cond _ODP_HIDE_FROM_DOXYGEN_ */ + void *_odp_packet_map(void *pkt_ptr, uint32_t offset, uint32_t *seg_len, int *seg_idx); -/** @internal Inline function offsets */ extern const _odp_packet_inline_offset_t _odp_packet_inline; - -/** @internal Pool inline function offsets */ -extern const _odp_pool_inline_offset_t _odp_pool_inline; +extern const _odp_pool_inline_offset_t _odp_pool_inline; #ifndef _ODP_HAVE_PACKET_SEG_NDX #include -/** @internal Inline function @param seg @return */ static inline uint32_t _odp_packet_seg_to_ndx(odp_packet_seg_t seg) { return _odp_typeval(seg); } -/** @internal Inline function @param ndx @return */ static inline odp_packet_seg_t _odp_packet_seg_from_ndx(uint32_t ndx) { return _odp_cast_scalar(odp_packet_seg_t, ndx); } #endif -/** @internal Inline function @param pkt @return */ static inline void *_odp_packet_data(odp_packet_t pkt) { return _odp_pkt_get(pkt, void *, data); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_seg_len(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint32_t, seg_len); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_len(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint32_t, frame_len); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_headroom(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint16_t, headroom); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_tailroom(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint16_t, tailroom); } -/** @internal Inline function @param pkt @return */ static inline odp_pool_t _odp_packet_pool(odp_packet_t pkt) { void *pool = _odp_pkt_get(pkt, void *, pool); @@ -87,31 +76,26 @@ static inline odp_pool_t _odp_packet_pool(odp_packet_t pkt) return _odp_pool_get(pool, odp_pool_t, pool_hdl); } -/** @internal Inline function @param pkt @return */ static inline odp_pktio_t _odp_packet_input(odp_packet_t pkt) { return _odp_pkt_get(pkt, odp_pktio_t, input); } -/** @internal Inline function @param pkt @return */ static inline int _odp_packet_num_segs(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint8_t, segcount); } -/** @internal Inline function @param pkt @return */ static inline void *_odp_packet_user_ptr(odp_packet_t pkt) { return _odp_pkt_get(pkt, void *, user_ptr); } -/** @internal Inline function @param pkt @return */ static inline void *_odp_packet_user_area(odp_packet_t pkt) { return _odp_pkt_get(pkt, void *, user_area); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_user_area_size(odp_packet_t pkt) { void *pool = _odp_pkt_get(pkt, void *, pool); @@ -119,25 +103,21 @@ static inline uint32_t _odp_packet_user_area_size(odp_packet_t pkt) return _odp_pool_get(pool, uint32_t, uarea_size); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_l2_offset(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint16_t, l2_offset); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_l3_offset(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint16_t, l3_offset); } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_l4_offset(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint16_t, l4_offset); } -/** @internal Inline function @param pkt @param len @return */ static inline void *_odp_packet_l2_ptr(odp_packet_t pkt, uint32_t *len) { uint32_t offset = _odp_packet_l2_offset(pkt); @@ -156,7 +136,6 @@ static inline void *_odp_packet_l2_ptr(odp_packet_t pkt, uint32_t *len) return data + offset; } -/** @internal Inline function @param pkt @param len @return */ static inline void *_odp_packet_l3_ptr(odp_packet_t pkt, uint32_t *len) { uint32_t offset = _odp_packet_l3_offset(pkt); @@ -175,7 +154,6 @@ static inline void *_odp_packet_l3_ptr(odp_packet_t pkt, uint32_t *len) return data + offset; } -/** @internal Inline function @param pkt @param len @return */ static inline void *_odp_packet_l4_ptr(odp_packet_t pkt, uint32_t *len) { uint32_t offset = _odp_packet_l4_offset(pkt); @@ -194,31 +172,26 @@ static inline void *_odp_packet_l4_ptr(odp_packet_t pkt, uint32_t *len) return data + offset; } -/** @internal Inline function @param pkt @return */ static inline uint32_t _odp_packet_flow_hash(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint32_t, flow_hash); } -/** @internal Inline function @param pkt @return */ static inline odp_time_t _odp_packet_ts(odp_packet_t pkt) { return _odp_pkt_get(pkt, odp_time_t, timestamp); } -/** @internal Inline function @param pkt @return */ static inline void *_odp_packet_head(odp_packet_t pkt) { return (uint8_t *)_odp_packet_data(pkt) - _odp_packet_headroom(pkt); } -/** @internal Inline function @param pkt @return */ static inline int _odp_packet_is_segmented(odp_packet_t pkt) { return _odp_pkt_get(pkt, uint8_t, segcount) > 1; } -/** @internal Inline function @param pkt @return */ static inline odp_packet_seg_t _odp_packet_first_seg(odp_packet_t pkt) { (void)pkt; @@ -226,13 +199,11 @@ static inline odp_packet_seg_t _odp_packet_first_seg(odp_packet_t pkt) return _odp_packet_seg_from_ndx(0); } -/** @internal Inline function @param pkt @return */ static inline odp_packet_seg_t _odp_packet_last_seg(odp_packet_t pkt) { return _odp_packet_seg_from_ndx(_odp_packet_num_segs(pkt) - 1); } -/** @internal Inline function @param pkt @param seg @return */ static inline odp_packet_seg_t _odp_packet_next_seg(odp_packet_t pkt, odp_packet_seg_t seg) { @@ -243,17 +214,17 @@ static inline odp_packet_seg_t _odp_packet_next_seg(odp_packet_t pkt, return seg + 1; } -/** @internal Inline function @param pkt @param offset @param len */ static inline void _odp_packet_prefetch(odp_packet_t pkt, uint32_t offset, uint32_t len) { (void)pkt; (void)offset; (void)len; } -/** @internal Inline function @param pkt @return */ static inline odp_buffer_t packet_to_buffer(odp_packet_t pkt) { return (odp_buffer_t)pkt; } +/** @endcond */ + #endif