From patchwork Fri Oct 14 08:49:08 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Elo, Matias \(Nokia - FI/Espoo\)" X-Patchwork-Id: 77650 Delivered-To: patch@linaro.org Received: by 10.140.97.247 with SMTP id m110csp197404qge; Fri, 14 Oct 2016 01:53:13 -0700 (PDT) X-Received: by 10.200.56.52 with SMTP id q49mr11241804qtb.23.1476435193006; Fri, 14 Oct 2016 01:53:13 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id f140si9049323qke.270.2016.10.14.01.53.12; Fri, 14 Oct 2016 01:53:12 -0700 (PDT) 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=fail (p=NONE dis=NONE) header.from=nokia.com Received: by lists.linaro.org (Postfix, from userid 109) id 7CD4D609ED; Fri, 14 Oct 2016 08:53:07 +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_H2, 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 1616661B8F; Fri, 14 Oct 2016 08:50:41 +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 4441161B97; Fri, 14 Oct 2016 08:50:35 +0000 (UTC) Received: from EUR01-VE1-obe.outbound.protection.outlook.com (mail-ve1eur01on0095.outbound.protection.outlook.com [104.47.1.95]) by lists.linaro.org (Postfix) with ESMTPS id 0C60D609FB for ; Fri, 14 Oct 2016 08:49:36 +0000 (UTC) Received: from HE1PR0701CA0047.eurprd07.prod.outlook.com (10.168.191.15) by AM5PR0701MB2626.eurprd07.prod.outlook.com (10.173.92.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.669.5; Fri, 14 Oct 2016 08:49:34 +0000 Received: from AM1FFO11OLC005.protection.gbl (2a01:111:f400:7e00::160) by HE1PR0701CA0047.outlook.office365.com (2603:10a6:3:9e::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.679.4 via Frontend Transport; Fri, 14 Oct 2016 08:49:33 +0000 Received-SPF: Pass (protection.outlook.com: domain of nokia.com designates 131.228.2.241 as permitted sender) receiver=protection.outlook.com; client-ip=131.228.2.241; helo=fihe3nok0735.emea.nsn-net.net; Received: from fihe3nok0735.emea.nsn-net.net (131.228.2.241) by AM1FFO11OLC005.mail.protection.outlook.com (10.174.64.132) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.669.7 via Frontend Transport; Fri, 14 Oct 2016 08:49:32 +0000 Received: from fihe3nok0735.emea.nsn-net.net (localhost [127.0.0.1]) by fihe3nok0735.emea.nsn-net.net (8.14.9/8.14.5) with ESMTP id u9E8nCvf005815 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 14 Oct 2016 11:49:12 +0300 Received: from 10.144.19.15 ([10.144.104.92]) by fihe3nok0735.emea.nsn-net.net (8.14.9/8.14.5) with ESMTP id u9E8nCVl005806 (version=TLSv1/SSLv3 cipher=AES128-SHA256 bits=128 verify=NOT) for ; Fri, 14 Oct 2016 11:49:12 +0300 X-HPESVCS-Source-Ip: 10.144.104.92 From: Matias Elo To: Date: Fri, 14 Oct 2016 11:49:08 +0300 Message-ID: <1476434952-8282-2-git-send-email-matias.elo@nokia.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1476434952-8282-1-git-send-email-matias.elo@nokia.com> References: <1476434952-8282-1-git-send-email-matias.elo@nokia.com> X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-HT: Tenant X-Forefront-Antispam-Report: CIP:131.228.2.241; IPV:NLI; CTRY:FI; EFV:NLI; SFV:NSPM; SFS:(10019020)(6009001)(7916002)(2980300002)(438002)(189002)(199003)(106466001)(36756003)(5660300001)(42882006)(6916009)(50466002)(48376002)(2950100002)(586003)(47776003)(575784001)(107886002)(8936002)(68736007)(110136003)(6666003)(189998001)(50226002)(87936001)(97736004)(50986999)(19580405001)(76176999)(19580395003)(77096005)(92566002)(229853001)(626004)(11100500001)(33646002)(2351001)(5003940100001)(356003)(81156014)(305945005)(450100001)(2906002)(7846002)(8676002)(81166006)(217873001); DIR:OUT; SFP:1102; SCL:1; SRVR:AM5PR0701MB2626; H:fihe3nok0735.emea.nsn-net.net; FPR:; SPF:Pass; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; AM1FFO11OLC005; 1:G+Vs4xmdh8nTlfdX/t+WNZF6gM+JLpW6GpH2ZGGtDDFDSl2awmRu8MbLpSnK8zN6YK0TmdOuP4FypPIsqePdfUWtaKsE9WkGriJoqOKL7CXOYZcAAu1mjKXYvgweqM1rnKRQtHRjIs3oJRfWHXGY3m4xP287qesfSi3GCzRSabWAG3RWudXgwtzFiOwunX3WIF2MLB2wfRK5EWEkAhbbyfcW7bq3wSDOLHlcI4I+iqmx5CVGJDyWP9AiQvBjyKJOIEO7N1UucjhcUhY2Mbk3UHEoh3uxQXhRB9sahWHQyjpWc6UuzOgHSV8FOXdMOi9KZHPwrVJ0ybrwwlKWkMSdxY9LSrsYqOS8WD8IYy6ILjqsFM5Guef1DvncUJpjM49RSQdaX/ck3Ql/icTUhoqUgHA/U3JH/7pVOvTGdNnQ88CxYKzbP8Y3IbRjAfampF3kfNn54qbRZOz0ip4rbLveyBrQmbcGTkgR37XNkFiwc5jsCSzFUtwP+lDJkOrAdEfa MIME-Version: 1.0 X-MS-Office365-Filtering-Correlation-Id: 97d7c01e-b86d-4882-00e5-08d3f40f04e6 X-Microsoft-Exchange-Diagnostics: 1; AM5PR0701MB2626; 2:Tmg8L97twKV1E14hL51R+k6ysL1A8BFSpFikZgfyuAdpiA2BQcqAdZdMOfWCmKHmfHCulnj1unIl3v1TACMkZt1pvlBv3xTRBgQEUHTapQNPkcni/S0k3nsDsS4UruQwUVD+Ov+ckaFcWIPfQgfct7K7gENtf4nTtCfg2bRiSIDUPzpA/VvhsVWRT0r5va1/oWfNgvYWl8g+3iaRtlaISg==; 3:+lY34naXAnpUDxdsgchMN14op0A5oAoeB7wqSraOxgUqIrh0QdepC6r0b34VqoY8kn0yR0c1Cm9HLkW6hpH8e1EAcHqQaX495oo+Pkn1Nj5UmlU9y5SKbdcSGISOfauGP5wfAcFClkrDK5zvO2HXkuboxCHpENpLwJaAlHZuJV7PN+8Zeg1Qk3pHBdUDcooSrJE4b3V6XXteAldda9NDlxuEkXk69U+RzjR01KBcheVrYfYASp2BVpaM0u3lz2PdpXUYpRAc0mckaBMkAt+YRWo4gkvyg7gsJwv/e/smJXY=; 25:OAM1T5XbsEUmSqKV31URcNpmAzPGkmnzxsFRXkJXR/ro7VKDloL7R54UpratEUYO8xmi1Itdm+t+fkLmpF0cUN4gnL7zqDJFLfypJFOQN5uUk7ooEd1sweEEaYbbld/MTusvahHRfI8gtR4q6rgFVNoIeX2je2vHOqFVagyPpP+ibavyBbeKKfAme7trg05Xzxvapyr/rL2OeeAOHWK3tcKhQOKUFa4hzyqU6+OY1dVPV8W58V0y4mptX66l/H9tOljIY3xEx/FJ2nASsOJg5BoyKETerYZdfh2jaGISAlb7Qko9OOle0WFEs0tMCKXIwAkHTX5qI8nb9En9wQq+ifcHlpDMtTxZYcoTTmwm30p6HXxlRhXQm2L8FntWq4a7MA/AmM33yaU39xH9iLuq6Ped1UGb6veWVu+53LIQ0Lz9tEeETqRsz1CzaGG71sLH X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(8251501002); SRVR:AM5PR0701MB2626; X-Microsoft-Exchange-Diagnostics: 1; AM5PR0701MB2626; 31:jxaKZsXPcXhyLw9tW+bUmjtWVVo808JJMjHGuD3bhYW4Za0/bGXWaTsxxwhn1Xy8f0PrDd0T9lShgbTp7F5F1O+z2RGfG1ppDrq51PEh/1Ag7l90//rn4tYWjdusOw9AyCxLhZCslM0B1kT1lJzlp9Wf05C0v288IyBehInU44ar9lgS5yKiPiZh7izzNWKWuACksGV5/OI29TaqmRJV0JNej0z2/jWFPSF7CdYtGuu86kfUGZxT3ton7xw9i6Ns; 20:IE+CfSLF21bM8TxUn3hvBNZZnDrMVwt/7y7pNJ8mHhUX+roovxkWKXQEkMOH+zGr8aZt8Srrw4/uQil8j05S2SU4x300GXFh9evtQSV8rrsaYpEy/xEznfF1nr0GuKTraifKYCNeeHz7OndpAjVTxybpPpHD5OhbfNlKrJQYk2DnkjgqKgvD3KJWDdbpnSrfLW7W8QLzkLJV3PLkJgc7BoYdwMsRJOEoPF7sf0No0qTBdbAzfEKTMwr4T2n5dMcnnfFMvb6K8V/Trs7DyyMpMn7xpsAv1fB+SpM2TQ1i2YuBoq/RPgesIBu0ioKDk1ONvPMdWkC6xOyQblRKQnffHh1FFi7muzS4sbhXxcnf7BXAXB9S9O1IfmkrNo2HlzubHbPSlgc7prcNlWDXehpJB1vXYuFFDcait+mMOQbY4+VE8c+7NVsn+9sR4/NWUIDtrB48/hxTfRmrUute7k27ZmJuznehqmZ4g8MFIAV/1C3frTrERhoWUTdJ5/N75X9Nkrd2b0bsuYkWfefjSXQ2eDzyzrk3IJtLR0RcsJej+/Ts5J7jn1y4YJT9pMK5fjupmSRowsNsu+8W/nUp5EtP6czOQ74A7kH0i/d/wc2OQFU= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(82608151540597); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040176)(601004)(2401047)(13016025)(5005006)(8121501046)(13018025)(3002001)(10201501046)(6055026); SRVR:AM5PR0701MB2626; BCL:0; PCL:0; RULEID:; SRVR:AM5PR0701MB2626; X-Microsoft-Exchange-Diagnostics: 1; AM5PR0701MB2626; 4:xmfPQVWoCMYNIBpT8t+1aBzZtHTmUBlcFlbg5mueY1Z9O84MLRlvz94XEEwRIFhNw8aWXdzhPbJaJ+rAxXEuRFvoYqJfhpwdgEnPqPmE24hGQycuYfezG4A0lDNQGX1LfVBUwHhbqJEgavOLnFlWZw7AGHPDJBsk+OnDN5aeenDMvrG75sUfBzdEFn6D/oGJgOg5pPWe9NWbW89xWeOecMErfiYZXDc2uTnCEjB3Dx3mpL6BXbq9/3mQrCS6O0B3vao6ZK2UDcDrbdOKE/TzDEH4GsOcJzG65seCGw1NOJPIRbRMCrKF5jCcLMfOI6krKdMXzkQ8b4wEwPwhmDTvYJJqDWAgJzuoKMuGKr4owTT0jMyjK7ZARcDCjfAly4sXqb65Sg/sM6m8zmgxjNySwB2KpYrH1RYvwoQGj4G2ZqFwlDyGKQvfc6z521hh40f6R9MvGrYQ7FxXDa9nPJzDhrT9/Mu9VnKjku379/UNmaYmB11BF7KX83QcvtkhPP/Z X-Forefront-PRVS: 0095BCF226 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; AM5PR0701MB2626; 23:uWSRrt55OfLabDJcDSGC88iglJBEMjZAKlqhlFk?= =?us-ascii?Q?tdUJ5UFAQuJvGwjaf8FB/HPw7GxF9JNhPw61zt5Nem1MPmz4+rNK8Ymhczu8?= =?us-ascii?Q?Rs1BsiyGXqeLCtMs7yhrp8RfrfIe5l+ESHqN+lQr4CvD8SEfBnRW76eYxG8H?= =?us-ascii?Q?yYkSpp1JyNg07PA7JJynkUoK9XF5TVKC4dZCSsfJniDwg9Ors761PVMEkWUa?= =?us-ascii?Q?nncAGtkpc9ObodSpPnVmpPBTbUeMYqEA4fK099TUYIJxEV3qfrdUF4XmP7mR?= =?us-ascii?Q?2At1badGcIecd9/3QtAe1Q7EMsv+NXgFhAlhuy3KlEcmeyKJEg0MEeMYL8Lc?= =?us-ascii?Q?BYvUCxxpagYQYCfwX+MnbLVbd+8fSMW7knx0iAD49YWqthLe2Nqb0mse8SIc?= =?us-ascii?Q?KtiSjctXw4HCWVcuzsq6n8AMcUXNtTDlSV68XjJ46+bh9sB76NtPnqe+7Tf9?= =?us-ascii?Q?cJdqzxD7gfG8jsOlF7A28ecvUy3eG9diSBN0kSkEr0WJYfXWzJ7SnJWS99zq?= =?us-ascii?Q?Rm+gcDGutAXnS7PDR+Sq0zMZmSLSje6/1mg2KM3GxXKqT11dtG5+oZUQfBjP?= =?us-ascii?Q?4glI3O4Gu6vzo6apricjh16RPt+Sxcotlph1aRKBI3nqFnQW92wZStstaouy?= =?us-ascii?Q?r2qYSl6+Mo8FMSDU7tKGLs0UmPACCOKJ6WW6jK1Qh4GX7lPDxaz1JlXcEF47?= =?us-ascii?Q?CYDNhY/i9YWjtpGOqk76yQtbCAQLWFR4kjez8LLKsYDYKizxfiByWFay2SW8?= =?us-ascii?Q?IP1CR1qJelwsVtGVRfi+xEZ5BLvmZTJCjopIjjqNaI/1BIaCVsgKHb0u1xqL?= =?us-ascii?Q?XDcSnLm6oHF+jDkADHpgjoOLe+mhOJsE3kjup6mZS+rC20Yfy6iGlF60qFWZ?= =?us-ascii?Q?/2GD9HBGj5wt5r5Y15qHS5IlBg9rIaBeMCKQCJYWLyxPY0M//u4wk8hJfBRB?= =?us-ascii?Q?sCmZLb+R3ctRMWLdrBBUO0y/5iQBZLolgU+sl01SN1bhyZX9gBOcbxAlgueI?= =?us-ascii?Q?uAUId/HXm5r2K2su8z/G8z4eslRf5j+OqgCaA+z4aFvoAEcpv1qKow/e5vYH?= =?us-ascii?Q?Lf1mMehUJxugydusllmYOk1+/Eup+zTtwgRywaB0ErbBp7imGSjSo0oTOzEh?= =?us-ascii?Q?Nxdx3XeKk0qp9x9wQCop1ZiK2GptDX6knOXlMYaSq+R8tOQx2x2fWu/g4+Rx?= =?us-ascii?Q?BI6hYf6O/pn4bUSA=3D?= X-Microsoft-Exchange-Diagnostics: 1; AM5PR0701MB2626; 6:OsmNPVrGDkSh/Ymj5YRWeFITMSWoUXc05RYNNaX+FqVltFRm8rS+sxysy9mI9Oq8wJJNzMZwMI3IU08YwR0rfn+OL2n6JAQK6D2k+MwgOq0ZkVO/w4FDMAtPajP2RToQGgWCin+ZkyiuDctK8KCnEdr8mr1ENeMePwzehVWTFBot5m5pZcXgYulZyqVWkcoCSGMg01augRjxznoz7DDPSqQamJoUBp46I3o697jp/Y1FYApj2lDS7/lvW/T8IODMEgBlhLCoa0aQBA2FU76G3/W0R34eYyZjOKJbyOiQyPLcgrxWbCFenxwSgdKLpDTYisCEY8A6SKCm2znPr04gUfcpH9i+4N2sTz/Fr9FlS+E=; 5:fYb1uil4EwvlcWed966eKSYqg3Pu3amcwVfan59HDs9fUchGiUv3kx6p4IfErgp+MkufX7elOtSmpWP40di6sLFk+7IoQ5AGfLQytKE0D7NYxAVwuiJ/f4vkiz6rKvtx+tEptYhgtpwVadQcT7WWWA==; 24:zAquWiTq8RRZziWk0vip3T3kgkFfeDKPCYNZH/vrk/Qx2zTNWvtyBYfJsxKj77xiiOZRQgl4TkD4QoZJFwuNn+zF/9rUnA3icsaFmMfS5Bk= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; AM5PR0701MB2626; 7:fvfiePgpHoHkZr/dmhPcegPmqjDvvFZ1wxJOxJKlxyoUMLavVuKDZm9552Qpf/2tKH/tkdTPUWF6kZ3IyS8YdUVfApxqZY6A/7HsqcOHhml9SSEEX5sOjsDCwRi3YYerb9Kvilm4TTHVQJ6adL2W8SLvrw6/QE3crmELGInMuRA33IQR8GFKWkH3v8ZpK+q5i5Kq3LZNj93ZsqFUjypVVFR+QFWzsZWnq57Ax6r/mDjl179MIC9zsVS/7klTBdyv9zeC5VWhpO3lvMHHUr0x1ZkJ7qXSFMEmnepUHxQmp4x61Uux4bizrmdA/9HZRXc72VhPt14Bt4gqQOHQpQTy04q4LcfYfznYYvweS8KcEro= X-OriginatorOrg: nokia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Oct 2016 08:49:32.8249 (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.241]; Helo=[fihe3nok0735.emea.nsn-net.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM5PR0701MB2626 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCH 1/5] api: improve name argument definitions in *_create() functions 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" The current APIs don't always define valid name argument values. Fix this by stating when NULL is a valid value and when the name string doesn't have to be unique. Signed-off-by: Matias Elo --- include/odp/api/spec/classification.h | 10 ++++++---- include/odp/api/spec/pool.h | 17 ++++++----------- include/odp/api/spec/queue.h | 9 ++++++--- include/odp/api/spec/schedule.h | 12 ++++++------ include/odp/api/spec/timer.h | 5 ++++- 5 files changed, 28 insertions(+), 25 deletions(-) -- 2.7.4 diff --git a/include/odp/api/spec/classification.h b/include/odp/api/spec/classification.h index 189c91f..0e442c7 100644 --- a/include/odp/api/spec/classification.h +++ b/include/odp/api/spec/classification.h @@ -193,12 +193,14 @@ int odp_cls_capability(odp_cls_capability_t *capability); /** * Create a class-of-service * - * @param name String intended for debugging purposes. + * The use of class-of-service name is optional. Unique names are not required. * - * @param param class of service parameters + * @param name Name of the class-of-service or NULL. Maximum string + * length is ODP_COS_NAME_LEN. + * @param param Class-of-service parameters * - * @retval class of service handle - * @retval ODP_COS_INVALID on failure. + * @retval Class-of-service handle + * @retval ODP_COS_INVALID on failure. * * @note ODP_QUEUE_INVALID and ODP_POOL_INVALID are valid values for queue * and pool associated with a class of service and when any one of these values diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h index c80c98a..a1331e3 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -220,14 +220,12 @@ typedef struct odp_pool_param_t { /** * Create a pool * - * This routine is used to create a pool. It take two arguments: the optional - * name of the pool to be created and a parameter struct that describes the - * pool to be created. If a name is not specified the result is an anonymous - * pool that cannot be referenced by odp_pool_lookup(). - * - * @param name Name of the pool, max ODP_POOL_NAME_LEN-1 chars. - * May be specified as NULL for anonymous pools. + * This routine is used to create a pool. The use of pool name is optional. + * Unique names are not required. However, odp_pool_lookup() returns only a + * single matching pool. * + * @param name Name of the pool or NULL. Maximum string length is + * ODP_POOL_NAME_LEN. * @param params Pool parameters. * * @return Handle of the created pool @@ -256,11 +254,8 @@ int odp_pool_destroy(odp_pool_t pool); * * @param name Name of the pool * - * @return Handle of found pool + * @return Handle of the first matching pool * @retval ODP_POOL_INVALID Pool could not be found - * - * @note This routine cannot be used to look up an anonymous pool (one created - * with no name). */ odp_pool_t odp_pool_lookup(const char *name); diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h index 31dc9f5..b0c5e31 100644 --- a/include/odp/api/spec/queue.h +++ b/include/odp/api/spec/queue.h @@ -173,9 +173,12 @@ typedef struct odp_queue_param_t { * Create a queue according to the queue parameters. Queue type is specified by * queue parameter 'type'. Use odp_queue_param_init() to initialize parameters * into their default values. Default values are also used when 'param' pointer - * is NULL. The default queue type is ODP_QUEUE_TYPE_PLAIN. + * is NULL. The default queue type is ODP_QUEUE_TYPE_PLAIN. The use of queue + * name is optional. Unique names are not required. However, odp_queue_lookup() + * returns only a single matching queue. * - * @param name Queue name + * @param name Name of the queue or NULL. Maximum string length is + * ODP_QUEUE_NAME_LEN. * @param param Queue parameters. Uses defaults if NULL. * * @return Queue handle @@ -203,7 +206,7 @@ int odp_queue_destroy(odp_queue_t queue); * * @param name Queue name * - * @return Queue handle + * @return Handle of the first matching queue * @retval ODP_QUEUE_INVALID on failure */ odp_queue_t odp_queue_lookup(const char *name); diff --git a/include/odp/api/spec/schedule.h b/include/odp/api/spec/schedule.h index d924da2..f976a4c 100644 --- a/include/odp/api/spec/schedule.h +++ b/include/odp/api/spec/schedule.h @@ -214,10 +214,12 @@ int odp_schedule_num_prio(void); * mask will receive events from a queue that belongs to the schedule group. * Thread masks of various schedule groups may overlap. There are predefined * groups such as ODP_SCHED_GROUP_ALL and ODP_SCHED_GROUP_WORKER, which are - * always present and automatically updated. Group name is optional - * (may be NULL) and can have ODP_SCHED_GROUP_NAME_LEN characters in maximum. + * always present and automatically updated. The use of group name is optional. + * Unique names are not required. However, odp_schedule_group_lookup() returns + * only a single matching group. * - * @param name Schedule group name + * @param name Name of the schedule group or NULL. Maximum string length is + * ODP_SCHED_GROUP_NAME_LEN. * @param mask Thread mask * * @return Schedule group handle @@ -245,11 +247,9 @@ int odp_schedule_group_destroy(odp_schedule_group_t group); /** * Look up a schedule group by name * - * Return the handle of a schedule group from its name - * * @param name Name of schedule group * - * @return Handle of schedule group for specified name + * @return Handle of the first matching schedule group * @retval ODP_SCHEDULE_GROUP_INVALID No matching schedule group found */ odp_schedule_group_t odp_schedule_group_lookup(const char *name); diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index df37189..49221c4 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -108,7 +108,10 @@ typedef struct { /** * Create a timer pool * - * @param name Name of the timer pool. The string will be copied. + * The use of pool name is optional. Unique names are not required. + * + * @param name Name of the timer pool or NULL. Maximum string length is + * ODP_TIMER_POOL_NAME_LEN. * @param params Timer pool parameters. The content will be copied. * * @return Timer pool handle on success