From patchwork Wed Oct 8 17:31:18 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 38488 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ee0-f71.google.com (mail-ee0-f71.google.com [74.125.83.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id B112120447 for ; Wed, 8 Oct 2014 17:31:53 +0000 (UTC) Received: by mail-ee0-f71.google.com with SMTP id d17sf5630348eek.10 for ; Wed, 08 Oct 2014 10:31:52 -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: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=issvmaRsGfOVMedAel8CK8I9eafncFlBLsd4zHBXj3o=; b=UPv0qLsca1LbbiqOyWhcjVGu+JyRvU+LaYHeiLm+5yBBEX5z177kcajuLjqQveAIlD pvNY5oCm/4joJfrDwhkwxWRiYnReUV7lCiO13/ZmtrajCdBTBsRSRoKTgC7RzRwQRYNU jZ/NnqYejy6f+jsulCAg7O2r8yVCh62tAwY3IGk0tMJYn+/gRmx3DqGc5NyenOXt1M6s UHChhYtBy4SjUO4rDqcyQ1AZDie7t0Za2yDDKaVv5tJ96i0o8p7Nfgs8gNQ+tLDcMlwA kZQvj5TBli2TMXIVj1pK7QCCrWFsfk0KDMQXbTGzcQn09tLP4I5r2QMU9MmSp64edsHD rntQ== X-Gm-Message-State: ALoCoQmm2UUiNgAQyWGFV/bXuOYvN9hZ+P/v8GPVgMgc4ivg3Yp/OvT15OLUZu7tUUE5B0vbZids X-Received: by 10.181.9.73 with SMTP id dq9mr1779102wid.2.1412789512828; Wed, 08 Oct 2014 10:31:52 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.28.133 with SMTP id b5ls79448lah.26.gmail; Wed, 08 Oct 2014 10:31:52 -0700 (PDT) X-Received: by 10.152.6.137 with SMTP id b9mr8941724laa.84.1412789512669; Wed, 08 Oct 2014 10:31:52 -0700 (PDT) Received: from mail-la0-f43.google.com (mail-la0-f43.google.com [209.85.215.43]) by mx.google.com with ESMTPS id b6si904522lae.131.2014.10.08.10.31.52 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 08 Oct 2014 10:31:52 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.43 as permitted sender) client-ip=209.85.215.43; Received: by mail-la0-f43.google.com with SMTP id mc6so8946400lab.2 for ; Wed, 08 Oct 2014 10:31:52 -0700 (PDT) X-Received: by 10.152.28.167 with SMTP id c7mr12884264lah.27.1412789512228; Wed, 08 Oct 2014 10:31:52 -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.112.84.229 with SMTP id c5csp103919lbz; Wed, 8 Oct 2014 10:31:51 -0700 (PDT) X-Received: by 10.53.3.162 with SMTP id bx2mr10391220vdd.56.1412789511056; Wed, 08 Oct 2014 10:31:51 -0700 (PDT) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id s17si584738vcu.91.2014.10.08.10.31.47 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 08 Oct 2014 10:31:51 -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-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Xbv5W-0003Yp-Bz; Wed, 08 Oct 2014 17:31:46 +0000 Received: from mail-qc0-f180.google.com ([209.85.216.180]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Xbv5Q-0003Ya-4m for lng-odp@lists.linaro.org; Wed, 08 Oct 2014 17:31:40 +0000 Received: by mail-qc0-f180.google.com with SMTP id x3so8006887qcv.11 for ; Wed, 08 Oct 2014 10:31:35 -0700 (PDT) X-Received: by 10.224.4.72 with SMTP id 8mr15209577qaq.79.1412789494927; Wed, 08 Oct 2014 10:31:34 -0700 (PDT) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id 63sm455714qgl.16.2014.10.08.10.31.32 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 08 Oct 2014 10:31:33 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 8 Oct 2014 13:31:18 -0400 Message-Id: <1412789478-38353-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: Architecture patch Subject: [lng-odp] [PATCH ARCH] Factor out requirement terminology 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: mike.holmes@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.215.43 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 We only need one copy of the requirements terminology Signed-off-by: Mike Holmes --- boilerplate.dox | 15 +++++++++++++++ classification_design.dox | 3 +-- crypto_design.dox | 3 +-- 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 boilerplate.dox diff --git a/boilerplate.dox b/boilerplate.dox new file mode 100644 index 0000000..5ac1616 --- /dev/null +++ b/boilerplate.dox @@ -0,0 +1,15 @@ +/* Copyright (c) 2014, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@page odp_definitions Definitions + +@tableofcontents + +@section use_of_terms Requirement terminology +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). + +*/ diff --git a/classification_design.dox b/classification_design.dox index db0b273..8733144 100644 --- a/classification_design.dox +++ b/classification_design.dox @@ -15,8 +15,7 @@ This document defines the Classification APIs supported by ODP. Classification is logically composed of two stages: Parsing and Rule Matching. Parsing takes a raw packet and validates its structure and identifies fields of interest in the various headers that comprise the layers of the packet. Rule Matching, in turn, takes the result of parsing and sorts packets into Classes of Service (CoS) based on application-defined rule sets. -@subsection use_of_terms Use of Terms -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc21199). +@ref use_of_terms @subsection purpose Purpose ODP is a framework for software-based packet forwarding/filtering applications, and the purpose of the Packet Classifier API is to enable applications to program the platform hardware or software implementation to assist in prioritization, classification and scheduling of each packet, so that the software application can run faster, scale better and adhere to QoS requirements. The following API abstraction are not modelled after any existing product implementation, but is instead defined in terms of what a typical data-plane application may require from such a platform, without sacrificing simplicity and avoiding ambiguity. diff --git a/crypto_design.dox b/crypto_design.dox index d0f016b..ed9166d 100644 --- a/crypto_design.dox +++ b/crypto_design.dox @@ -15,8 +15,7 @@ This document describes the ODP Crypto API. Cryptography is an important part of data plane processing as many communication protocols make use of cryptographic functions. Moreover, many SoCs incorporate cryptographic hardware that can significantly accelerate these operations compared to their software equivalents as well as provide validated hardware functional correctness and security boundaries necessary for system-level security certifications such as FIPS-140 Level 2 and above. @section requirements Requirements -@subsection use_of_terms Use of Terms -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). +@ref use_of_terms @subsection uses_of_cryptography Uses of Cryptography Crypto functions cover a range of uses and capabilities designed to support data security, integrity, authentication, and non-repudiation. @subsubsection data_security Data Security