From patchwork Tue Aug 25 09:26:42 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Graham Whaley X-Patchwork-Id: 7070331 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 76D129F344 for ; Tue, 25 Aug 2015 09:27:59 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 6472120519 for ; Tue, 25 Aug 2015 09:27:58 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 4F72E202EB for ; Tue, 25 Aug 2015 09:27:57 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id B1C356EB58; Tue, 25 Aug 2015 02:27:56 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by gabe.freedesktop.org (Postfix) with ESMTP id E39EA6EB58; Tue, 25 Aug 2015 02:27:55 -0700 (PDT) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP; 25 Aug 2015 02:27:42 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,744,1432623600"; d="scan'208";a="790462723" Received: from gwhaley-mobl1.ger.corp.intel.com ([10.252.24.136]) by orsmga002.jf.intel.com with ESMTP; 25 Aug 2015 02:27:39 -0700 From: Graham Whaley To: daniel.vetter@intel.com, jani.nikula@linux.intel.com, intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org Date: Tue, 25 Aug 2015 10:26:42 +0100 Message-Id: <1440494805-13325-3-git-send-email-graham.whaley@linux.intel.com> X-Mailer: git-send-email 2.4.3 In-Reply-To: <1440494805-13325-1-git-send-email-graham.whaley@linux.intel.com> References: <1440494805-13325-1-git-send-email-graham.whaley@linux.intel.com> Cc: Graham Whaley , danilo.cesar@collabora.co.uk, corbet@lwn.net Subject: [Intel-gfx] [PATCH 2/5] Documentation: drm: Fix pdfdocs listitem and abstract s X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-5.5 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Fix pdfdocs errors such as: jade:/Documentation/DocBook/drm.xml:1348:20:E: character data is not allowed here by adding tags to listitems and abstracts Signed-off-by: Graham Whaley --- Documentation/DocBook/drm.tmpl | 87 +++++++++++++++++++++++------------------- 1 file changed, 48 insertions(+), 39 deletions(-) diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 586f1b8..952eb78 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl @@ -579,9 +579,9 @@ char *date; On a fundamental level, GEM involves several operations: - Memory allocation and freeing - Command execution - Aperture management at command execution time + Memory allocation and freeing + Command execution + Aperture management at command execution time Buffer object allocation is relatively straightforward and largely provided by Linux's shmem layer, which provides memory to back each @@ -1386,20 +1386,20 @@ int max_width, max_height; The DRM core recognizes three types of planes: - + DRM_PLANE_TYPE_PRIMARY represents a "main" plane for a CRTC. Primary planes are the planes operated upon by CRTC modesetting and flipping operations described in . - - + + DRM_PLANE_TYPE_CURSOR represents a "cursor" plane for a CRTC. Cursor planes are the planes operated upon by the DRM_IOCTL_MODE_CURSOR and DRM_IOCTL_MODE_CURSOR2 ioctls. - - + + DRM_PLANE_TYPE_OVERLAY represents all non-primary, non-cursor planes. Some drivers refer to these types of planes as "sprites" internally. - + For compatibility with legacy userspace, only overlay planes are made available to userspace by default. Userspace clients may set the @@ -1503,22 +1503,22 @@ int max_width, max_height; drm_encoder_init. The function takes a pointer to the encoder functions and an encoder type. Supported types are - + DRM_MODE_ENCODER_DAC for VGA and analog on DVI-I/DVI-A - - + + DRM_MODE_ENCODER_TMDS for DVI, HDMI and (embedded) DisplayPort - - + + DRM_MODE_ENCODER_LVDS for display panels - - + + DRM_MODE_ENCODER_TVDAC for TV output (Composite, S-Video, Component, SCART) - - + + DRM_MODE_ENCODER_VIRTUAL for virtual machine displays - + @@ -1635,21 +1635,21 @@ int max_width, max_height; Supported connector types are - DRM_MODE_CONNECTOR_VGA - DRM_MODE_CONNECTOR_DVII - DRM_MODE_CONNECTOR_DVID - DRM_MODE_CONNECTOR_DVIA - DRM_MODE_CONNECTOR_Composite - DRM_MODE_CONNECTOR_SVIDEO - DRM_MODE_CONNECTOR_LVDS - DRM_MODE_CONNECTOR_Component - DRM_MODE_CONNECTOR_9PinDIN - DRM_MODE_CONNECTOR_DisplayPort - DRM_MODE_CONNECTOR_HDMIA - DRM_MODE_CONNECTOR_HDMIB - DRM_MODE_CONNECTOR_TV - DRM_MODE_CONNECTOR_eDP - DRM_MODE_CONNECTOR_VIRTUAL + DRM_MODE_CONNECTOR_VGA + DRM_MODE_CONNECTOR_DVII + DRM_MODE_CONNECTOR_DVID + DRM_MODE_CONNECTOR_DVIA + DRM_MODE_CONNECTOR_Composite + DRM_MODE_CONNECTOR_SVIDEO + DRM_MODE_CONNECTOR_LVDS + DRM_MODE_CONNECTOR_Component + DRM_MODE_CONNECTOR_9PinDIN + DRM_MODE_CONNECTOR_DisplayPort + DRM_MODE_CONNECTOR_HDMIA + DRM_MODE_CONNECTOR_HDMIB + DRM_MODE_CONNECTOR_TV + DRM_MODE_CONNECTOR_eDP + DRM_MODE_CONNECTOR_VIRTUAL @@ -3612,7 +3612,10 @@ void (*lastclose) (struct drm_device *); int (*open) (struct drm_device *, struct drm_file *); void (*preclose) (struct drm_device *, struct drm_file *); void (*postclose) (struct drm_device *, struct drm_file *); - Open and close handlers. None of those methods are mandatory. + + + Open and close handlers. None of those methods are mandatory. + The firstopen method is called by the DRM core @@ -3667,7 +3670,11 @@ void (*postclose) (struct drm_device *, struct drm_file *); File Operations const struct file_operations *fops - File operations for the DRM device node. + + + File operations for the DRM device node. + + Drivers must define the file operations structure that forms the DRM userspace API entry point, even though most of those operations are @@ -3717,14 +3724,17 @@ void (*postclose) (struct drm_device *, struct drm_file *); IOCTLs struct drm_ioctl_desc *ioctls; int num_ioctls; - Driver-specific ioctls descriptors table. + + + Driver-specific ioctls descriptors table. + + Driver-specific ioctls numbers start at DRM_COMMAND_BASE. The ioctls descriptors table is indexed by the ioctl number offset from the base value. Drivers can use the DRM_IOCTL_DEF_DRV() macro to initialize the table entries. - DRM_IOCTL_DEF_DRV(ioctl, func, flags) ioctl is the ioctl name. Drivers must define @@ -3763,7 +3773,6 @@ int num_ioctls; -