From patchwork Fri Oct 27 12:50:14 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Eremin-Solenikov X-Patchwork-Id: 117361 Delivered-To: patch@linaro.org Received: by 10.140.22.164 with SMTP id 33csp788514qgn; Fri, 27 Oct 2017 06:43:32 -0700 (PDT) X-Google-Smtp-Source: ABhQp+RYrkA+R7kJoeWPqv90Qh5XSXvN1Ef2/v1cOBMleU+yqoozVvPSb0DfkXYiAYm/i3v/vS9m X-Received: by 10.200.34.45 with SMTP id o42mr917690qto.18.1509111812254; Fri, 27 Oct 2017 06:43:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1509111812; cv=none; d=google.com; s=arc-20160816; b=ozrNkMUMGZ6ISHHbD5G7MWI7m/SAy4jWrjoOmeRa34d8mt6AkkV2sqWwpyTE3LsAhn toy9zWVd8fkwuKcYaGYm/JelDVKAbuYqrLELK1P9HhqFqhX32+V7YFBOf2EfPJ0jKB57 0ftoio6IKyOOXzm6zVs+6F7VDg9L5drbbSzKa2oHEvH3YYVOQcbEbPt0etZizRoMj2C8 9m1+ABLKeutkv1Ngyr9r1PU3S1HsWCaNxMYS806mjuZMf5YqAI4J37GCE+joJhiJg0El ftpant4IfMi+oF/OdcIH1na87V6YM519m+VKGYzhulkJ8vyxYxlIavpVtH6mfUZDIfJR VvSg== 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:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=w5fNX155zkJ1ZFEU0MVPkt6lT/hONeYDuppDmuAKoc8=; b=qaigJBzxOjBB429ESEZ6cT8m1JF5SajKezI//UjtTtn9Fb5tK4FxMBiJ7DoTsGn5jn YEEM5NP7IBS2cKBfEkMnHxU7zWKb7i2VJGh8Jvg1T4uiSUJNQZjy1+Kb3vAFmmxN9LKz gYIX4W8NfvXT2XTXs6naj6lWqpSTKpDBXnANdNW9sbAizoSaVPVXmDR9xMT1FxeB5scy PCiE301VUmXbwk4feKXWNrh2TC8JpR68SB6SEoM9RtfScH1KxZKBAIwGfM48appDHCSy CIB+xQN9Yy/zpUAwNwh8azu0ogWtmJDsBUrhe7LdyX8V8mbYCqKuahnkK3DbrxFqxB1F 9GxQ== 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=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org 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 r22si5002040qta.124.2017.10.27.06.43.32; Fri, 27 Oct 2017 06:43:32 -0700 (PDT) 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=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id E5BA6629C7; Fri, 27 Oct 2017 13:43:31 +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.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, URIBL_BLOCKED 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 AA273629EE; Fri, 27 Oct 2017 12:57:40 +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 01B636296C; Fri, 27 Oct 2017 12:57:36 +0000 (UTC) Received: from mail-lf0-f66.google.com (mail-lf0-f66.google.com [209.85.215.66]) by lists.linaro.org (Postfix) with ESMTPS id 467356296C for ; Fri, 27 Oct 2017 12:50:57 +0000 (UTC) Received: by mail-lf0-f66.google.com with SMTP id k40so7305078lfi.4 for ; Fri, 27 Oct 2017 05:50:57 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=w5fNX155zkJ1ZFEU0MVPkt6lT/hONeYDuppDmuAKoc8=; b=uVjSlESkuxxtT6h92PFhBYi3hiK3BXU4V2+tDQc5IaXKOzoPD8Iz7y+isBAr1+Or2v YzF//UN1VNnQDF1FiztKdM3LXrWOOALdBvnppiJHqHKV67R4kXObkM8Xfvjd4xovWujh /DpFVUs8q/BnCZRYWAif2joRYMrAXz3zBw5MvegMNNmECOnfwTnCFklGqTVt74yijEmt mi+IhamTbiQBCMdlzYJqgMwRkVE9uj4sikIsK/Qy2wEdV978liabpmxU83w5YcUHa9XC tisHWA8GiKak5+mcJBqJ0x1+EGwJ7/q252y4yoj2aeL5Td+1byAWCjPmFnRzAZP0onhn S95A== X-Gm-Message-State: AMCzsaWfcpV9yjLrPz64obxrB5TRfy3BYLI/iT8ORzDx4ViRaCAK661d GIf5+ub5w/4rHeAZqOg6oaPVTJtpEWAAqA== X-Received: by 10.25.115.14 with SMTP id o14mr116587lfc.79.1509108655903; Fri, 27 Oct 2017 05:50:55 -0700 (PDT) Received: from rhovanion.lumag.spb.ru ([94.25.228.222]) by smtp.gmail.com with ESMTPSA id l194sm1584690lfl.11.2017.10.27.05.50.54 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 27 Oct 2017 05:50:55 -0700 (PDT) From: Dmitry Eremin-Solenikov To: lng-odp@lists.linaro.org Date: Fri, 27 Oct 2017 15:50:14 +0300 Message-Id: <20171027125014.27313-31-dmitry.ereminsolenikov@linaro.org> X-Mailer: git-send-email 2.14.2 In-Reply-To: <20171027125014.27313-1-dmitry.ereminsolenikov@linaro.org> References: <20171027125014.27313-1-dmitry.ereminsolenikov@linaro.org> Subject: [lng-odp] [PATCH v10 30/30] include: provide formal description of ODP specification 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" Provide formal description of files being part of ODP specification, platform-specific headers, substituting parts of ODP specification and additional headers supplementing ODP specification. Signed-off-by: Dmitry Eremin-Solenikov --- include/README | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 include/README -- 2.14.2 diff --git a/include/README b/include/README new file mode 100644 index 000000000000..8f13dbad68e5 --- /dev/null +++ b/include/README @@ -0,0 +1,77 @@ +ODP specification +================= + +ODP specification consists of several types of files, which together provide +full list of types, values and functions that ODP implemention MUST provide. + +ODP API specification +--------------------- + +These are the files from `include/odp/api/spec` directory. They specify a set +of function prototypes, types, type names, enumerations etc that MUST be +provided by ODP implementation. Doxygen comments inside these files document +requirements for ABI interface provided by an implementation. An implementation +MUST use these headers AS IS, without any modifications to be compatible with +ODP specification. + +ODP ABI compatibility specification +----------------------------------- + +These are the files from `include/odp/arch/@ARCH_ABI@/odp/api/abi/` directory. +They specify a set of types and values that MUST be used AS IS without any +modifications by an implementation if it supports and is compiled for +ABI-compatibility mode. + +ODP default ABI headers +----------------------- + +These are the files from `include/odp/api/abi-default` directory. They provide +default specification for ODP types and values for ABI compatibility. CPU +architecture specific ABI compatibility files heavily depend on these headers. +These files MUST NOT be changed by an implementation. + +odp_api.h header +---------------- + +This header found at `include/odp_api.h` is an entry point for an application. +Application MUST include only odp_api.h, nothing else. This file includes all +files from ODP specification. + +Additional ODP headers +====================== + +These are the headers provided by an ODP to supplement ODP specification. + +ODP API headers +--------------- + +These are the files from `include/odp/api` directory. They glue together API +and ABI specification headers. Although they are not part of ODP specification +itself, they provide an easy way for an implementation to use ODP API/ABI +header files. An implementation SHOULD use these headers AS IS unless it has +strong reason not to do so. + +Platform-specific headers +========================= + +Platform ABI headers +-------------------- + +These are the headers found at +`platform/@with_platform@/include-abi/odp/api/abi` directory. They are used by +the reset of ODP code if implementation is compiled with ABI compatibility +disabled. They should implement at least a set of types and values documented +in ODP API specification headers. They are permitted to provide any platform +specific optimizations (i.e. they might provide types and/or values that map +directly onto the hardware details, they might provide inline functions to +speed up execution of the application, etc). These headers MAY use ODP default +ABI headers if they do fit. + +Rest of platform-specific headers +--------------------------------- + +Platform MAY provide additional headers at `platform/@with_platform/include`. +However these headers SHOULD NOT be used directly by an application, because +this will tie it to the exact implementation details. Application MUST include +only header. Platform ABI headers MAY use these headers to +implement platform-specific optimizations.