From patchwork Thu Oct 9 14:08:43 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anders Roxell X-Patchwork-Id: 38505 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f200.google.com (mail-lb0-f200.google.com [209.85.217.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 0BEAC202E7 for ; Thu, 9 Oct 2014 14:09:20 +0000 (UTC) Received: by mail-lb0-f200.google.com with SMTP id b6sf921544lbj.7 for ; Thu, 09 Oct 2014 07:09:19 -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=+iFQ/V+lkdqI6F9wBSdFQu6uBf/bZwvNaAqUrVNIxkE=; b=CWnDaakXpj/g8ymV29anO74IsoGUuLLhJTdelcUVYUuJyS9l0p2NkjEl8iS76terHZ ClmLb7ziEkKgdaoPHwZbPaoisQy56r+ffYaXhBGoP1npU837GSXixyOoq79zJRaqbkzG JhDvXyHvC0uYser7lvUZktRII0czRDiPF5x+QgjfK300F25Tr5FuPBdsoecwIzOLhpW+ 6+C8XGF3VN5CU6SlQdEmizKJ8DnhEw9/xv3Lp+ohiURAqmIW3IortDP+mrO7xcFoGcWl ohdxM0cG6/MZxVOFzwaV/uh5UCGtbYiL2vMpb6mwcBceHixRUVsUPiw7gcVzjlUdbcIu KYAQ== X-Gm-Message-State: ALoCoQkeCDQkM6eZPZ1uL4krjuGbyRB2LC0oIlmgeDgtM8moXgJP/dv5PaRr8uRz3Zjh3j2pTIom X-Received: by 10.112.190.40 with SMTP id gn8mr781264lbc.10.1412863758704; Thu, 09 Oct 2014 07:09:18 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.19.5 with SMTP id a5ls181808lae.19.gmail; Thu, 09 Oct 2014 07:09:18 -0700 (PDT) X-Received: by 10.112.35.199 with SMTP id k7mr17989439lbj.76.1412863758555; Thu, 09 Oct 2014 07:09:18 -0700 (PDT) Received: from mail-lb0-f181.google.com (mail-lb0-f181.google.com [209.85.217.181]) by mx.google.com with ESMTPS id vu3si972164lbb.82.2014.10.09.07.09.18 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 09 Oct 2014 07:09:18 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.181 as permitted sender) client-ip=209.85.217.181; Received: by mail-lb0-f181.google.com with SMTP id l4so1198244lbv.40 for ; Thu, 09 Oct 2014 07:09:18 -0700 (PDT) X-Received: by 10.152.19.195 with SMTP id h3mr19001201lae.71.1412863758170; Thu, 09 Oct 2014 07:09:18 -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 c5csp254709lbz; Thu, 9 Oct 2014 07:09:17 -0700 (PDT) X-Received: by 10.229.11.135 with SMTP id t7mr24082712qct.7.1412863756655; Thu, 09 Oct 2014 07:09:16 -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 l7si5791916qac.52.2014.10.09.07.09.15 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 09 Oct 2014 07:09:16 -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 1XcEP4-0006wR-KK; Thu, 09 Oct 2014 14:09:14 +0000 Received: from mail-lb0-f179.google.com ([209.85.217.179]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XcEOs-0006ts-8c for lng-odp@lists.linaro.org; Thu, 09 Oct 2014 14:09:02 +0000 Received: by mail-lb0-f179.google.com with SMTP id l4so1198009lbv.38 for ; Thu, 09 Oct 2014 07:08:56 -0700 (PDT) X-Received: by 10.152.205.38 with SMTP id ld6mr3359643lac.97.1412863736374; Thu, 09 Oct 2014 07:08:56 -0700 (PDT) Received: from localhost (c-853670d5.07-21-73746f28.cust.bredbandsbolaget.se. [213.112.54.133]) by mx.google.com with ESMTPSA id xs6sm1002230lbb.13.2014.10.09.07.08.55 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Thu, 09 Oct 2014 07:08:55 -0700 (PDT) From: Anders Roxell To: lng-odp@lists.linaro.org Date: Thu, 9 Oct 2014 16:08:43 +0200 Message-Id: <1412863729-28176-2-git-send-email-anders.roxell@linaro.org> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1412863729-28176-1-git-send-email-anders.roxell@linaro.org> References: <1412863729-28176-1-git-send-email-anders.roxell@linaro.org> Subject: [lng-odp] [DO NOT REVIEW 1/7] packet_io: add introduction 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.217.181 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 --- packet_io.dox | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 packet_io.dox diff --git a/packet_io.dox b/packet_io.dox new file mode 100644 index 0000000..d9d96b4 --- /dev/null +++ b/packet_io.dox @@ -0,0 +1,44 @@ +/* Copyright (c) 2014, Linaro + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@page pktio ODP Design - Packet I/O + +For the implementation of the ODP Packet I/O API please see odp_packet_io.h + +@tableofcontents + +@section intro Introduction + +This document describes the Packet I/O (pktio) APIs supported by ODP. These +APIs provide a high level abstraction of a single packet I/O interface, +allowing an ODP application to configure, send and receive packets over an +interface without having to concern itself with how the implementation performs +those operations. The packet I/O implementation for a given interface may be +performed entirely in hardware, entirely in software or a combination of the +two. + +A pktio interface may represent a single physical, virtual or logical interface +(for example, a loopback interface). An ODP implementation on a single platform +may support multiple different interface types and export some or all of them +all via the pktio API. + +An application would not typically receive packets directly from the pktio +interface, but would instead configure the system such that packets received +on the interface are classified and delivered to a predefined input queue, or +input queue group, depending on application requirements. The application then +receives packets from one of the input queues by invoking the scheduler. +Packets received from a pktio interface, either directly or indirectly, have +already been through input parsing and classification based on the rules +established when the interface was configured. + +Similarly for transmission, a pktio interface has an output queue associated +with it. Packets are transmitted by enqueueing them to the output queue +associated with the pktio device over which the packet is to be sent, the +implementation is then responsible for taking the packet from the output queue +and effecting its transmission. + +*/