From patchwork Thu Aug 21 00:03:03 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anders Roxell X-Patchwork-Id: 35718 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-oa0-f69.google.com (mail-oa0-f69.google.com [209.85.219.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 7218920351 for ; Thu, 21 Aug 2014 00:03:34 +0000 (UTC) Received: by mail-oa0-f69.google.com with SMTP id i7sf53769718oag.0 for ; Wed, 20 Aug 2014 17:03:34 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=8SZyvTttaxub72Lo3l+UlUwD2EIniVBDyaHcC4GXhiY=; b=Hevx0oIv0ch9oYA8wi/44GHhJK9+U6FD6GERwtVkWyHsfhX927+9SFXQxj0+wNn58K UO+YZH/Y4ag0ucOYqanAj90uDNJ4epdzgOJwYQUK6+IdrtX7tgD8onfIm/FqdEvf58lk Hqf0GPdG1/7iovUol0BIt5KK8AeZ0bmh/aBDv37dcfYXyO1DRjW60Anq08ZJc0r7gexR RmfiK/5CdpOh/JsgD7VcyCjrQi4CyzOzOMzaiw6Na11VoeB7XCrwpfkKBrI8la4YxQhD dsy0tHpeF4xQ7SkPjLfzCxWnoqHF+n249xquy5sDz8qYgDGzrHTwGrFrSg7TKzVPBLdd tdoA== X-Gm-Message-State: ALoCoQm91vdMAhmVKqwkPCwagaavFzAMzbbxhj497tK/3cF7YvXMACv4JkbNOazjwdz9qyBRCRjF X-Received: by 10.43.28.197 with SMTP id rv5mr447711icb.23.1408579414007; Wed, 20 Aug 2014 17:03:34 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.46.100 with SMTP id j91ls540120qga.44.gmail; Wed, 20 Aug 2014 17:03:33 -0700 (PDT) X-Received: by 10.52.168.134 with SMTP id zw6mr1040064vdb.37.1408579413921; Wed, 20 Aug 2014 17:03:33 -0700 (PDT) Received: from mail-vc0-f170.google.com (mail-vc0-f170.google.com [209.85.220.170]) by mx.google.com with ESMTPS id qp20si11716036vdb.6.2014.08.20.17.03.33 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 20 Aug 2014 17:03:33 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.170 as permitted sender) client-ip=209.85.220.170; Received: by mail-vc0-f170.google.com with SMTP id lf12so10051878vcb.29 for ; Wed, 20 Aug 2014 17:03:33 -0700 (PDT) X-Received: by 10.220.168.210 with SMTP id v18mr39053367vcy.3.1408579413833; Wed, 20 Aug 2014 17:03:33 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.221.45.67 with SMTP id uj3csp91750vcb; Wed, 20 Aug 2014 17:03:33 -0700 (PDT) X-Received: by 10.140.41.133 with SMTP id z5mr77762005qgz.99.1408579413337; Wed, 20 Aug 2014 17:03:33 -0700 (PDT) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id a4si36481568qae.107.2014.08.20.17.03.32 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 20 Aug 2014 17:03:33 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XKFqm-00071I-Mp; Thu, 21 Aug 2014 00:03:32 +0000 Received: from mail-la0-f51.google.com ([209.85.215.51]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XKFqZ-00070G-Cw for lng-odp@lists.linaro.org; Thu, 21 Aug 2014 00:03:19 +0000 Received: by mail-la0-f51.google.com with SMTP id pn19so7957292lab.10 for ; Wed, 20 Aug 2014 17:03:13 -0700 (PDT) X-Received: by 10.152.30.10 with SMTP id o10mr45811975lah.41.1408579393464; Wed, 20 Aug 2014 17:03:13 -0700 (PDT) Received: from localhost (c-853670d5.07-21-73746f28.cust.bredbandsbolaget.se. [213.112.54.133]) by mx.google.com with ESMTPSA id e4sm39267482lbc.29.2014.08.20.17.03.12 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Wed, 20 Aug 2014 17:03:12 -0700 (PDT) From: Anders Roxell To: lng-odp@lists.linaro.org Date: Thu, 21 Aug 2014 02:03:03 +0200 Message-Id: <1408579384-21392-3-git-send-email-anders.roxell@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1408579384-21392-1-git-send-email-anders.roxell@linaro.org> References: <1408579384-21392-1-git-send-email-anders.roxell@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 2/3] doxygen: fix doxygen-run generated warnings X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: anders.roxell@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.170 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Anders Roxell --- platform/linux-generic/include/api/odp_pktio_netmap.h | 19 ++++++++++++++----- platform/linux-generic/include/api/odp_pktio_socket.h | 13 +++++++++++-- platform/linux-generic/include/api/odp_pktio_types.h | 16 ++++++++++++++-- 3 files changed, 39 insertions(+), 9 deletions(-) diff --git a/platform/linux-generic/include/api/odp_pktio_netmap.h b/platform/linux-generic/include/api/odp_pktio_netmap.h index d57e212..85272d5 100644 --- a/platform/linux-generic/include/api/odp_pktio_netmap.h +++ b/platform/linux-generic/include/api/odp_pktio_netmap.h @@ -5,18 +5,27 @@ * SPDX-License-Identifier: BSD-3-Clause */ +/** + * @file + * + * ODP packet input/output netmap + */ + #ifndef ODP_PKTIO_NETMAP_H #define ODP_PKTIO_NETMAP_H #include -#define ODP_NETMAP_MODE_HW 0 -#define ODP_NETMAP_MODE_SW 1 +#define ODP_NETMAP_MODE_HW 0 /**< Netmap mode in hardware */ +#define ODP_NETMAP_MODE_SW 1 /**< Netmap mode in software */ +/** + * Netmap parameters + */ typedef struct { - odp_pktio_type_t type; - int netmap_mode; - uint16_t ringid; + odp_pktio_type_t type; /**< Packet IO type */ + int netmap_mode; /**< Netmap Mode */ + uint16_t ringid; /**< Ring identifiers */ } netmap_params_t; #endif diff --git a/platform/linux-generic/include/api/odp_pktio_socket.h b/platform/linux-generic/include/api/odp_pktio_socket.h index deeeeed..6444cba 100644 --- a/platform/linux-generic/include/api/odp_pktio_socket.h +++ b/platform/linux-generic/include/api/odp_pktio_socket.h @@ -4,6 +4,12 @@ * SPDX-License-Identifier: BSD-3-Clause */ +/** + * @file + * + * ODP packet input/output socket + */ + #ifndef ODP_PKTIO_SOCKET_H #define ODP_PKTIO_SOCKET_H @@ -13,9 +19,12 @@ extern "C" { #include +/** + * Socket Parameters + */ typedef struct { - odp_pktio_type_t type; - int fanout; + odp_pktio_type_t type; /**< Packet IO type */ + int fanout; /**< Fantout */ } socket_params_t; #ifdef __cplusplus diff --git a/platform/linux-generic/include/api/odp_pktio_types.h b/platform/linux-generic/include/api/odp_pktio_types.h index 8d195a5..54ce459 100644 --- a/platform/linux-generic/include/api/odp_pktio_types.h +++ b/platform/linux-generic/include/api/odp_pktio_types.h @@ -4,6 +4,12 @@ * SPDX-License-Identifier: BSD-3-Clause */ +/** + * @file + * + * ODP packet input/output types + */ + #ifndef ODP_PKTIO_TYPES_H #define ODP_PKTIO_TYPES_H @@ -16,6 +22,9 @@ extern "C" { * was not built with netmap support and there are more types define below */ +/** + * Packet IO types + */ typedef enum { ODP_PKTIO_TYPE_SOCKET_BASIC = 0x1, ODP_PKTIO_TYPE_SOCKET_MMSG, @@ -28,9 +37,12 @@ typedef enum { #include #endif +/** + * Packet IO parameters + */ typedef union odp_pktio_params_t { - odp_pktio_type_t type; - socket_params_t sock_params; + odp_pktio_type_t type; /**< Packet IO type */ + socket_params_t sock_params; /**< Socket parameter */ #ifdef ODP_HAVE_NETMAP netmap_params_t nm_params; #endif