From patchwork Tue Jul 5 12:47:45 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 71391 Delivered-To: patch@linaro.org Received: by 10.140.28.4 with SMTP id 4csp292581qgy; Tue, 5 Jul 2016 05:47:58 -0700 (PDT) X-Received: by 10.237.51.227 with SMTP id v90mr26762085qtd.23.1467722878693; Tue, 05 Jul 2016 05:47:58 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id u6si2180156qtu.141.2016.07.05.05.47.57; Tue, 05 Jul 2016 05:47:58 -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=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id CB60268199; Tue, 5 Jul 2016 12:47:57 +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=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, 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 E55C668030; Tue, 5 Jul 2016 12:47:52 +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 6CE6E680C1; Tue, 5 Jul 2016 12:47:50 +0000 (UTC) Received: from mail-qk0-f173.google.com (mail-qk0-f173.google.com [209.85.220.173]) by lists.linaro.org (Postfix) with ESMTPS id 3138364D77 for ; Tue, 5 Jul 2016 12:47:48 +0000 (UTC) Received: by mail-qk0-f173.google.com with SMTP id e3so85074239qkd.0 for ; Tue, 05 Jul 2016 05:47:48 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=R+SmopZueOmB2IF41PDzeygwCG6eREYqRT9LDtyA6k8=; b=H/XXpUQaWObgQ+S7/7Z95paXqCH68LhkvyN6iYvQFUUH1zpmg2UMGWJHH/QjPowe4x UbNthTrU/o+TcAkwr00+A2gO3pR3TnbYTAiRopCGpBtzPZHwQuu19+dmtGpY7rb2BrGd yjGwSBeo8704M+qksJD3D/KcfebKft0jwV1r/zIHSrgAvWPoVgisQtUwls21KU7ACeOh Fi4gKSzvpwJFGpKWI4z/bi6/k/ujrhBehJKlQTV+P+l/xU/l2esg7qI+IqvloV8hJhtR INKv8toyrpuVO4NBLMQ6U295kbISlFSym7T2LLw+npHleUhhu2qGDBryxpejHPTko3D0 pTZQ== X-Gm-Message-State: ALyK8tK4V8GZw4PJx/xG/lUsjU0NE63AHYDn25kiV+OT+F3j6w/ntVDJUGcVJLaUowrfnCOp7Ss= X-Received: by 10.55.64.65 with SMTP id n62mr21205841qka.98.1467722867904; Tue, 05 Jul 2016 05:47:47 -0700 (PDT) Received: from localhost (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id d185sm3003740qkf.46.2016.07.05.05.47.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Jul 2016 05:47:47 -0700 (PDT) From: Mike Holmes To: christophe.milard@linaro.org Date: Tue, 5 Jul 2016 08:47:45 -0400 Message-Id: <1467722865-12522-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Cc: lng-odp@lists.linaro.org Subject: [lng-odp] [PATCH] doc: driver-api-guide: initial revision 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: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Add an initial driver API document structure for the existing driver framework. Signed-off-by: Mike Holmes --- configure.ac | 4 +++- doc/Makefile.am | 6 +++++- doc/driver-api-guide/.gitignore | 1 + doc/driver-api-guide/Doxyfile | 14 ++++++++++++++ doc/driver-api-guide/Makefile.am | 5 +++++ doc/driver-api-guide/odp.dox | 20 ++++++++++++++++++++ doc/m4/configure.m4 | 3 ++- 7 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 doc/driver-api-guide/.gitignore create mode 100644 doc/driver-api-guide/Doxyfile create mode 100644 doc/driver-api-guide/Makefile.am create mode 100644 doc/driver-api-guide/odp.dox diff --git a/configure.ac b/configure.ac index c0eb207..d1e410a 100644 --- a/configure.ac +++ b/configure.ac @@ -188,7 +188,9 @@ DX_INIT_DOXYGEN($PACKAGE_NAME, ${srcdir}/doc/helper-guide/Doxyfile, ${builddir}/doc/helper-guide/output, ${srcdir}/doc/platform-api-guide/Doxyfile, - ${builddir}/doc/platform-api-guide/output) + ${builddir}/doc/platform-api-guide/output, + ${srcdir}/doc/driver-api-guide/Doxyfile, + ${builddir}/doc/driver-api-guide/output) ########################################################################## # Enable/disable ODP_DEBUG_PRINT diff --git a/doc/Makefile.am b/doc/Makefile.am index d49d84b..59d6a6c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,8 @@ -SUBDIRS = application-api-guide helper-guide platform-api-guide +SUBDIRS = \ + application-api-guide \ + helper-guide \ + platform-api-guide \ + driver-api-guide if user_guide SUBDIRS += implementers-guide users-guide process-guide diff --git a/doc/driver-api-guide/.gitignore b/doc/driver-api-guide/.gitignore new file mode 100644 index 0000000..53752db --- /dev/null +++ b/doc/driver-api-guide/.gitignore @@ -0,0 +1 @@ +output diff --git a/doc/driver-api-guide/Doxyfile b/doc/driver-api-guide/Doxyfile new file mode 100644 index 0000000..eff3285 --- /dev/null +++ b/doc/driver-api-guide/Doxyfile @@ -0,0 +1,14 @@ +@INCLUDE = $(SRCDIR)/doc/Doxyfile_common + +PROJECT_NAME = "Driver Reference Manual" +PROJECT_NUMBER = $(VERSION) +PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg +INPUT = $(SRCDIR)/doc/driver-api-guide \ + $(SRCDIR)/include/odp/drv \ + $(SRCDIR)/include/odp_drv.h +EXCLUDE_PATTERNS = drv* odp_drv.h +EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR) +PREDEFINED = __GNUC__ \ + "ODP_HANDLE_T(type)=odp_handle_t type" \ + odpdrv_bool_t=int +WARNINGS = NO diff --git a/doc/driver-api-guide/Makefile.am b/doc/driver-api-guide/Makefile.am new file mode 100644 index 0000000..4fc4755 --- /dev/null +++ b/doc/driver-api-guide/Makefile.am @@ -0,0 +1,5 @@ +EXTRA_DIST = \ + odp.dox + +clean-local: + rm -rf output diff --git a/doc/driver-api-guide/odp.dox b/doc/driver-api-guide/odp.dox new file mode 100644 index 0000000..687a79e --- /dev/null +++ b/doc/driver-api-guide/odp.dox @@ -0,0 +1,20 @@ +/* Copyright (c) 2016, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** + * @mainpage + * + * @section sec_1 Introduction + * + * OpenDataPlane (ODP) provides a driver interface + + * + * @section contact Contact Details + * - The main web site is http://www.opendataplane.org/ + * - The git repo is https://git.linaro.org/lng/odp.git + * - Bug tracking is https://bugs.linaro.org/buglist.cgi?product=OpenDataPlane + * + */ diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4 index ed9451d..6e02f76 100644 --- a/doc/m4/configure.m4 +++ b/doc/m4/configure.m4 @@ -42,4 +42,5 @@ AC_CONFIG_FILES([doc/application-api-guide/Makefile doc/Makefile doc/platform-api-guide/Makefile doc/process-guide/Makefile - doc/users-guide/Makefile]) + doc/users-guide/Makefile + doc/driver-api-guide/Makefile])