From patchwork Fri Feb 3 11:24:00 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Petri Savolainen X-Patchwork-Id: 93170 Delivered-To: patch@linaro.org Received: by 10.140.20.99 with SMTP id 90csp544329qgi; Fri, 3 Feb 2017 03:24:39 -0800 (PST) X-Received: by 10.200.55.37 with SMTP id o34mr12700649qtb.48.1486121079012; Fri, 03 Feb 2017 03:24:39 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q38si19066945qtf.149.2017.02.03.03.24.38; Fri, 03 Feb 2017 03:24:38 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 35945609E1; Fri, 3 Feb 2017 11:24:38 +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=-1.9 required=5.0 tests=BAD_ENC_HEADER,BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, SPF_HELO_PASS 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 57ACB609C5; Fri, 3 Feb 2017 11:24:32 +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 8F5DA609C5; Fri, 3 Feb 2017 11:24:29 +0000 (UTC) Received: from EUR01-HE1-obe.outbound.protection.outlook.com (mail-he1eur01on0098.outbound.protection.outlook.com [104.47.0.98]) by lists.linaro.org (Postfix) with ESMTPS id 0FEBA609B6 for ; Fri, 3 Feb 2017 11:24:28 +0000 (UTC) Received: from DB6PR0701CA0003.eurprd07.prod.outlook.com (10.168.7.141) by VI1PR07MB0815.eurprd07.prod.outlook.com (10.161.107.150) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.888.5; Fri, 3 Feb 2017 11:24:26 +0000 Received: from DB3FFO11FD047.protection.gbl (2a01:111:f400:7e04::198) by DB6PR0701CA0003.outlook.office365.com (2603:10a6:4:3::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.888.5 via Frontend Transport; Fri, 3 Feb 2017 11:24:25 +0000 Received-SPF: SoftFail (protection.outlook.com: domain of transitioning linaro.org discourages use of 131.228.2.37 as permitted sender) Received: from hybrid2.ext.net.nokia.com (131.228.2.37) by DB3FFO11FD047.mail.protection.outlook.com (10.47.217.78) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.874.2 via Frontend Transport; Fri, 3 Feb 2017 11:24:25 +0000 Received: from fihe3nok1346.nsn-intra.net (10.158.36.134) by fihe3nok1348.nsn-intra.net (10.158.36.136) with Microsoft SMTP Server (TLS) id 15.1.466.34; Fri, 3 Feb 2017 13:24:24 +0200 Received: from mailrelay.int.nokia.com (10.130.128.21) by fihe3nok1346.nsn-intra.net (10.158.36.134) with Microsoft SMTP Server (TLS) id 15.1.466.34 via Frontend Transport; Fri, 3 Feb 2017 13:24:25 +0200 Received: from fihe3nok0734.emea.nsn-net.net (localhost [127.0.0.1]) by fihe3nok0734.emea.nsn-net.net (8.14.9/8.14.5) with ESMTP id v13BO0W0009238 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 3 Feb 2017 13:24:00 +0200 Received: from 10.144.19.15 ([10.144.104.219]) by fihe3nok0734.emea.nsn-net.net (8.14.9/8.14.5) with ESMTP id v13BO0Hq009210 (version=TLSv1/SSLv3 cipher=AES128-SHA256 bits=128 verify=NOT) for ; Fri, 3 Feb 2017 13:24:00 +0200 X-HPESVCS-Source-Ip: 10.144.104.219 From: Petri Savolainen To: Date: Fri, 3 Feb 2017 13:24:00 +0200 Message-ID: <1486121040-12393-2-git-send-email-petri.savolainen@linaro.org> X-Mailer: git-send-email 2.8.1 In-Reply-To: <1486121040-12393-1-git-send-email-petri.savolainen@linaro.org> References: <1486121040-12393-1-git-send-email-petri.savolainen@linaro.org> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-HT: Tenant X-Forefront-Antispam-Report: CIP:131.228.2.37; IPV:NLI; CTRY:FI; EFV:NLI; SFV:NSPM; SFS:(10019020)(6009001)(7916002)(39410400002)(39450400003)(39860400002)(39840400002)(39850400002)(2980300002)(189002)(199003)(50226002)(47776003)(86362001)(626004)(450100001)(97736004)(356003)(8936002)(81156014)(575784001)(105596002)(76176999)(50986999)(92566002)(53936002)(2351001)(305945005)(8676002)(81166006)(106466001)(36756003)(107886002)(22756006)(6916009)(110136003)(68736007)(5660300001)(77096006)(48376002)(38730400001)(50466002)(5003940100001)(33646002)(2906002)(189998001)(2950100002); DIR:OUT; SFP:1102; SCL:1; SRVR:VI1PR07MB0815; H:hybrid2.ext.net.nokia.com; FPR:; SPF:SoftFail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; DB3FFO11FD047; 1:oLSbfzbn0xub6D5pIIX67rmBKnbA/nsbqDswMqDOkD+f9b/KFOXpHoZMXtItNU82lLwzlWcKNd2YFoo+XuEotxBkZVVB7N3DPyHVkLtYtz6TxBI9cWMXiiE/PK0GUGV5RpFYbxvZTJQ5cSv9Vp5FUfkWZSydB2DdbTivPXztMQCdktIsqNHjujLM1miX57/fueaJBmS83gtyFdtE1J4t+PlkMKQaY74guDyZondKivpYFuOhRec5F2samwXH1rJVl8MYWCaq5wcyQ7ypCD3NReXojyQ8o+TRlvWmEOIR2QUYFYbblMttNM5oAHAfliAFM9LVPk7FFBVjQkeRI/Exex0I13wRq3B+T8SCF0O0nFcn81s5qFCB4lKOF7in7EJ0sPQe8G5JvoUHy2AIa0eyzDyGK8GhyCAufT6MPw64arYQ4q5zZIOwmO7bleLF1tLa7sNuycPXFZbHhd2Ij00Jlw== X-MS-Office365-Filtering-Correlation-Id: ae3f4898-e7c6-41c2-d689-08d44c273601 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:VI1PR07MB0815; X-Microsoft-Exchange-Diagnostics: 1; VI1PR07MB0815; 3:xLdbYmYJqewyN+MfusrOxh4zlTS8nq9dlWKNIAYtwlHs/MPbevof7Dc39jmYJbFf/Evrezc/FVSnGTuQwmPl0fL3NCn+10t/rhFDvz77BudoZfPmVPuIBK7s1slniHQ/26QiKeqfEslcHYEIbii0zsKbC8Y8BIR8CkPq3VoNVkrhxOhlvVvNRKrjn8zEGN/uW2MM/ehZoJlVSd72aT4SIxZXMO0wi2EJhYFUliD4xHU2NUtBJBX7dl4zJnlbOLW84TDVoaWRnPJgNGuGpMSpVGV0TyDwZbNM5kUhX6D44+vQX8jy8pXOVmXzBb4Fj3NGFjipVj1chV9mIZ7Tkcvl8r8wykjGZoz0JCpQ8BBGrqQ=; 25:qKl+OSAm8iiA84bkEofo+xMuNidYobDlCMn7guaKxVjB6PvpKKqVvX34diHwcvPjislmTP/AP3F4CjVAWOgP+Vc0MR0tGzxKvl9oUN/hfLBknL8pHjyQlsI/YJBrE4nD9/qZtTE+ZNB4fv8ozVVFwy/bpYcOPU3LGVLevC8R2AX3BUQGYoAZE1RSCsIdlGI2EQVGs74ZO7sZQ4+oHptHw2DI+/R2rTnpyHT9GU5aXJj6SN4Xzs2tD0g0X6NdlE5pZ/4Q4hSRL0p8rdsDlpyS6cw6L7cbqsgSzZ7+F7BR/55yEchKuQpK+p6KPOqVUQy8dZ9jqb7miXE2CFlcr5P5N6QQ7RkyiIIOe1CQe8Xenc05gbACxbvvWup8oNYic5782KLBtesYAmNTSIDJwth/1VyXRZBt8ddZDPDB0Z+CQqOsZsr1keJpaLjnQY4KKUw+Uv5pWoCxHMkkVsuyOaDqtA== X-Microsoft-Exchange-Diagnostics: 1; VI1PR07MB0815; 31:srf+iQnHQAXURrG9ECpLuB8ycqLWVsK5RCxTCUon8pFVvdskzBd893vFG43L7GsAx/ngCrWh+oR3htLQU/gsPSfK9Gnn1KBpjxqrKzNYQfeH/uDEm6rsoNO1gy1jruMqcT6X9PV34TgbPHa83HeGhUv9oiEleRe3kQ6QCEBhBTuyRcy26cWQw+nNBYYe5uv5rP8+0s1Fj6DCqjC285Mf4g0L8uSRJ/G0QeLY4WCAGVnZr8wqEcfnkPP3YBBDEdUuL6K4vG90HfA/pbDK0pz1/SPpAzgZkRByGxsZ3cOAMqw=; 20:Lflcq9mU0h0dsYiHGvu/Fb7uGYBPwn/S734APw+taGP/2jJXl2Nf/BXDVkZPRqqZlvCgG6HCICiNnbQHy8/ema6sn2CfpChY8i3SuqaiNU+ZlAUWbfr0An6qftHjp/vnGpbloH8H3TKM+Bl2q3FW1QnRkN3gNhgoPBg1LdbyKqJHhnmblo1ccb5BUZ02OezxbdUW6uuLTdLFiHPtvVN25Z1uqele7rRsQX0CkNzntiaYDKJ1e88ZcPnEyEQiKAkipG2FbcJ7Uct4gufP94Jd5wRPEt9O8wx4j9cR4Go5mdi3EZkv4Vc9tuxGXC1HQXUhkhGdhv/lJ8IpfrHzyoGvgl9QLiC1KI70TY6adeDa1aS2sLDYI80+1TH8Tfc5r9ZMsOZH5Kz91Uoh9SgaMYyLhsPl7mfWqRpA82gfSumz+g6ey1EniPMzcgxnD11KgOWvZYRquyCaJiETBA8kbOCh8isSMehjHskhYX6QSvwrH99tdjLbJFWbr+5k1+sdFh/S0OO863md7eY1QKxLJ/HjUcF1xIKC0IjsDAVKM5whsqHN1YN8n/7jWqRu/N7FdSy+0iDzEG0YlpUCS96NvDIKuWNuOGQRSSGLPAn2bSiBpSo= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040375)(601004)(2401047)(13018025)(5005006)(8121501046)(13016025)(3002001)(10201501046)(6055026)(6041248)(20161123555025)(20161123558025)(20161123562025)(20161123564025)(20161123560025)(6072148); SRVR:VI1PR07MB0815; BCL:0; PCL:0; RULEID:; SRVR:VI1PR07MB0815; X-Microsoft-Exchange-Diagnostics: 1; VI1PR07MB0815; 4:zt5xl/6fxy4zGYG9WQKymUnL7JOpQgUxx2RPNeCgox3KkTI9PevjYqMyZ/aOs1QMuT4rl7EIa+XLnx0e4ZsJp5G4F0k+hWbnHu30N4PBuriZlEn+EfJ/0wAt6QFTt4CHEUqKnsLoLDCLDHmwDJ4HnyBS4fln9b3i/3AfxUSfcGeA5pcQUXprFrr/OhklHu66HgPRryZxdixGBfwEB/Zy+7BOoQNqBRzrmhemE7pk9IM2lkiV+ukn2oP3dU7TADGqffbx2mDY4rcXe0YoF0iQNxscBEJWZUoUBMbpo1/lj0QE5VQEofLnCkSQaOrVW/9DeuuirS4/JjAROnOMwdIRL5kqE5QtXmQEDkuCDf77scIamE3dpbZODVN4x/o48yNev86rC/1KpW9bZ2NMIU+g97YDE2/scJQ1c4YTbB7gIxHBV4IfrAz0BwRIJmJ1tQctQfSUVZgGpRSLVwxhILPVeSbroQtFepUAkZVBr8ZJtG+AO4uJzA5RDzkvvqfzPduZa+tkHCdBebpr+4iyxdep+cCowZxNYl+i70aazq/kLHvjQEEI3M02c1NCtJxQ7//FhgSe1n/fAFc8SlLf1wJpN9MlcpU2Yz15y1pH+2HsDQOOauMXwg4sK/ATrZqipOSw/7rcM/huDGUFCEIIOQyTcMO0NNJMLT+XoNeVvwUIfk8= X-Forefront-PRVS: 02070414A1 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; VI1PR07MB0815; 23:FZWTPdzGUA+8eq4j5DmGOC2SO8UEFy3uq8YKOP8ze?= yyiifFmBelQ4we2T6Sg+qqjxyQewUQlzzJNgPOL6L1PtvzbPhIokFdKuUcX6S6BS8JDanpPvitgnU9LhqaRF3gNuMgNbJOkEHoPU2YhyZbaXa+VWKTruEsjQ05kECmkqYyenHupLj73fKNeqShOZk2mn8Z/+nR2h6dahBdUBw5+dSJQV5OHP9qzqXOFKrO1TeuyUB3vG61TfBsU/gJFOVW1NPCCwlVdX2JMv2BtXHQk2470uc6WHJQQqYblS6hB3+2s3gFXWlPendyCU5xXTHBhxWQK6njjipLVyRUouSt/vHbAhjT/62gt8DwdjX7EDcNMeawgwtoC23kw+8lga1zNROxcg+yaqsNV2wb0VgPyDVSou/33vXTeechIchYJ+jMAKPOVX8T3tipBso+JmbF+WnryzavYuqIJsp2N9cHytpBPEeGS61v3KUBvSMesUarRf3p111nkScOccKEkrSocfImruh50NW2BPIwXjzORnjGvzVWGjxFehud86W29WGQAeLRAAuLNkJGBuHmtHH1xRrxet2dxtx+neW5uXIRhs6IOoj8bKWqh/vVzSHyDJ7UUtrJnzsV6sGz5/5HXkLKVvezdWl6uYFzrMJI3zy4uYO0nxh9S/36dNHXnH7bmcA0Mkr0BXB3g4FlIkrK0AhgFE/ZX6GJGMA+w3OSiTAbWyXQn9Yfek2OP+o/IGbDnWRqxXbL5WWjj+aD8QoC6PIsg0LvLmnU1vO1WQa+bFgc89PHk2HubMVO/rwFhh4/XcLCb4FF+eOPusH6BIAEbJMiTRN7KZ2K8qYeXwiRhKzAf8GkoBGhQM/0HaH8ug8DicVHHkSumDJV5jJecXxaIVkM901AwA4LmkdXSCxBWX9CKIeE+1gQXjOu7iMO1Bmsac6aDy1LjH+JrHbcL8i2QiGC9iiWCyElKMHvTZqwlyOPLkVfm3ZyOTuMxuP6cutzcHm3kbCqFvS5RwNzsOWCcYa84pcir8RxeNtnqndX2gKuscp55pd0E1KvU8Kku4UlxhufdHe+NgTv/NzfhvUh43lxWwD+ULKyfEEhsnAAHVTBHcF7+0zUrX3Mi5c4KqkS/MP/DnM9c2aJy3GjgK1wB9PnU X-Microsoft-Exchange-Diagnostics: 1; VI1PR07MB0815; 6:pD4Emzb4R+LuGJtM19r/LRIlp2Xr3Ns7nk2PSHpKHjyUCfRRbLAJqCL4geDO5wfk8PjPBmVFpRdBHZnhWk3FpVYaDfdJ29j4zG6ePrqgCQ6Oyeh3OC3PC8vsIsLDCSB9T47iTq5b2Np7hsGkdhKYn4qc0+RdjiuOJsAfHdqMVyw641UIYAEjnQp3zIY+sdeZ7CEEMEem56XpVgCwFBPeS8b/YITnGpCh17jaZDHq0S1AAs9dLmKlLGCPwwR3C1QWpiaHJcmB2QRQ4SK36Nxr83718+Ih2xKuUEgospvDu2DcDUgSd/cj+KLT6UG2zi4W00sgXGQuvb9bl2JUw3U8orTgGD+3XrmO0xApybX621DPkguel6/z1ITQIZtcPVIDtLD0czB0nq7cLtfesKkqUL+HAUXZupEvr+JqwmDGqkA=; 5:Qx7sh/7eV1Z58PTg4Oqe6hQITb1g2sXMIS0q5+vUrc9fYyz1bIxK2rWvcBuvVHCelyIIffFPW1kbN9677os3JRKBVkwld8UXCiarPFSMgK4hXpQYS6vMWuJ1o91UFTy92Uubq28jnmXkDncyHkBOwg==; 24:rQv3bnRynt84gTmzL8/cSD+0AP1G7+7XYy7k/rckAadvfrMGCboYNu6Jh3mriPUi4WALGY1YVqT5ZPjuKHoQiQRpemgmfGvuGBcufBHNg20= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; VI1PR07MB0815; 7:mfnP+BFteatfJt+YJxD6MVVtUwckBPQXQUcC41XBM653HQxyWaCuhTVPcBUs1QOKCmlX86eglaWVqDz5/2/kU6TMReEKzbFVpVdPjpjGmGLbhYMD6oUHFXfxkyye9OLeyzAEyQScUVpA0098kKluyAqvDbfbSDnMUJG8MGmWpFNxxpS37AfkUgbG1zBGSyM1MEiez4w28xLlrnF8dV3lRy0CxLFs/uyJFT50A86lwHdh7U7GQPeyn2eGxYqoSSGPgWtf0wgjaLca9xm9MT74DsokBwrWyBpTU4WLTcz6H78knj6vtsRDbLLAvoYfcFGzz3n03hjO8akvbRPmBM/pP2iBxBP69H37TLnmReF3g3Knufe/m5VOkAt0qYDu8jpgp83Smq1UQVY5euHtE3pzbfdlWmUIvyM6v6a5DOleCPuUQUWlmaqFJiGNqxa21VB7n1ZQU0+0v+nzcjgMnLnBbDb141VW6GwOFcbOw47jfjQbKD9dNWXdTNERcSz9mA4G5VxGti8tkpjlFEiBSccE/g== X-OriginatorOrg: nokia.onmicrosoft.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Feb 2017 11:24:25.8516 (UTC) X-MS-Exchange-CrossTenant-Id: 5d471751-9675-428d-917b-70f44f9630b0 X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5d471751-9675-428d-917b-70f44f9630b0; Ip=[131.228.2.37]; Helo=[hybrid2.ext.net.nokia.com] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR07MB0815 Subject: [lng-odp] [PATCH 2/2] helper: add stubs for missing 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" This suppress excessive amount of doxygen warnings caused by missing helper documentation. Other more improtant warnings may go unnoticed if these warning fill the screen. Signed-off-by: Petri Savolainen --- helper/include/odp/helper/odph_cuckootable.h | 52 +++++++++++++++++++++++ helper/include/odp/helper/odph_hashtable.h | 57 ++++++++++++++++++++++++++ helper/include/odp/helper/odph_iplookuptable.h | 57 +++++++++++++++++++++++++- helper/include/odp/helper/odph_lineartable.h | 48 ++++++++++++++++++++++ 4 files changed, 212 insertions(+), 2 deletions(-) -- 2.8.1 diff --git a/helper/include/odp/helper/odph_cuckootable.h b/helper/include/odp/helper/odph_cuckootable.h index d569980..65cd555 100644 --- a/helper/include/odp/helper/odph_cuckootable.h +++ b/helper/include/odp/helper/odph_cuckootable.h @@ -52,27 +52,79 @@ extern "C" { #endif +/** + * documentation missing + * + * @param name + * @param capacity + * @param key_size + * @param value_size + * + * @return + */ odph_table_t odph_cuckoo_table_create( const char *name, uint32_t capacity, uint32_t key_size, uint32_t value_size); +/** + * documentation missing + * + * @param name + * + * @return + */ odph_table_t odph_cuckoo_table_lookup(const char *name); +/** + * documentation missing + * + * @param table + * + * @return + */ int odph_cuckoo_table_destroy(odph_table_t table); +/** + * documentation missing + * + * @param table + * @param key + * @param value + * + * @return + */ int odph_cuckoo_table_put_value( odph_table_t table, void *key, void *value); +/** + * documentation missing + * + * @param table + * @param key + * @param buffer + * @param buffer_size + * + * @return + */ int odph_cuckoo_table_get_value( odph_table_t table, void *key, void *buffer, uint32_t buffer_size); +/** + * documentation missing + * + * @param table + * @param key + * + * @return + */ int odph_cuckoo_table_remove_value(odph_table_t table, void *key); +/** documentation missing */ extern odph_table_ops_t odph_cuckoo_table_ops; #ifdef __cplusplus diff --git a/helper/include/odp/helper/odph_hashtable.h b/helper/include/odp/helper/odph_hashtable.h index bb75cb9..d3dce99 100644 --- a/helper/include/odp/helper/odph_hashtable.h +++ b/helper/include/odp/helper/odph_hashtable.h @@ -19,17 +19,74 @@ extern "C" { #endif +/** + * documentation missing + * + * @param name + * @param capacity + * @param key_size + * @param value_size + * + * @return + */ odph_table_t odph_hash_table_create(const char *name, uint32_t capacity, uint32_t key_size, uint32_t value_size); + +/** + * documentation missing + * + * @param name + * + * @return + */ odph_table_t odph_hash_table_lookup(const char *name); + +/** + * documentation missing + * + * @param table + * + * @return + */ int odph_hash_table_destroy(odph_table_t table); + +/** + * documentation missing + * + * @param table + * @param key + * @param value + * + * @return + */ int odph_hash_put_value(odph_table_t table, void *key, void *value); + +/** + * documentation missing + * + * @param table + * @param key + * @param buffer + * @param buffer_size + * + * @return + */ int odph_hash_get_value(odph_table_t table, void *key, void *buffer, uint32_t buffer_size); + +/** + * documentation missing + * + * @param table + * @param key + * + * @return + */ int odph_hash_remove_value(odph_table_t table, void *key); +/** documentation missing */ extern odph_table_ops_t odph_hash_table_ops; #ifdef __cplusplus diff --git a/helper/include/odp/helper/odph_iplookuptable.h b/helper/include/odp/helper/odph_iplookuptable.h index 0ae6b37..f5da493 100644 --- a/helper/include/odp/helper/odph_iplookuptable.h +++ b/helper/include/odp/helper/odph_iplookuptable.h @@ -24,31 +24,84 @@ extern "C" { #endif +/** documentation missing */ typedef struct { - uint32_t ip; - uint8_t cidr; + uint32_t ip; /**< IP */ + uint8_t cidr; /**< CIDR */ } odph_iplookup_prefix_t; +/** + * documentation missing + * + * @param name + * @param ODP_IGNORED_1 + * @param ODP_IGNORED_2 + * @param value_size + * + * @return + */ odph_table_t odph_iplookup_table_create( const char *name, uint32_t ODP_IGNORED_1, uint32_t ODP_IGNORED_2, uint32_t value_size); +/** + * documentation missing + * + * @param name + * + * @return + */ odph_table_t odph_iplookup_table_lookup(const char *name); +/** + * documentation missing + * + * @param table + * + * @return + */ int odph_iplookup_table_destroy(odph_table_t table); +/** + * documentation missing + * + * @param table + * @param key + * @param value + * + * @return + */ int odph_iplookup_table_put_value( odph_table_t table, void *key, void *value); +/** + * documentation missing + * + * @param table + * @param key + * @param buffer + * @param buffer_size + * + * @return + */ int odph_iplookup_table_get_value( odph_table_t table, void *key, void *buffer, uint32_t buffer_size); +/** + * documentation missing + * + * @param table + * @param key + * + * @return + */ int odph_iplookup_table_remove_value( odph_table_t table, void *key); +/** documentation missing */ extern odph_table_ops_t odph_iplookup_table_ops; #ifdef __cplusplus diff --git a/helper/include/odp/helper/odph_lineartable.h b/helper/include/odp/helper/odph_lineartable.h index 0b56b7f..c01f0b9 100644 --- a/helper/include/odp/helper/odph_lineartable.h +++ b/helper/include/odp/helper/odph_lineartable.h @@ -20,16 +20,64 @@ extern "C" { #endif +/** + * documentation missing + * + * @param name + * @param capacity + * @param ODP_IGNORED + * @param value_size + * + * @return + */ odph_table_t odph_linear_table_create(const char *name, uint32_t capacity, uint32_t ODP_IGNORED, uint32_t value_size); + +/** + * documentation missing + * + * @param name + * + * @return + */ odph_table_t odph_linear_table_lookup(const char *name); + +/** + * documentation missing + * + * @param table + * + * @return + */ int odph_linear_table_destroy(odph_table_t table); + +/** + * documentation missing + * + * @param table + * @param key + * @param value + * + * @return + */ int odph_linear_put_value(odph_table_t table, void *key, void *value); + +/** + * documentation missing + * + * @param table + * @param key + * @param buffer + * @param buffer_size + * + * @return + */ int odph_linear_get_value(odph_table_t table, void *key, void *buffer, uint32_t buffer_size); +/** documentation missing */ extern odph_table_ops_t odph_linear_table_ops; #ifdef __cplusplus