From patchwork Mon Nov 2 17:25:30 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Wood X-Patchwork-Id: 7537661 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 3D08F9F830 for ; Mon, 2 Nov 2015 17:35:59 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 740B32041D for ; Mon, 2 Nov 2015 17:35:58 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 9E888203AB for ; Mon, 2 Nov 2015 17:35:57 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 36E556E589; Mon, 2 Nov 2015 09:35:56 -0800 (PST) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by gabe.freedesktop.org (Postfix) with ESMTP id 0CBC16E31B for ; Mon, 2 Nov 2015 09:35:53 -0800 (PST) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga103.jf.intel.com with ESMTP; 02 Nov 2015 09:35:53 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,234,1444719600"; d="scan'208";a="592647780" Received: from otc-vmt1.isw.intel.com ([10.237.224.80]) by FMSMGA003.fm.intel.com with ESMTP; 02 Nov 2015 09:35:53 -0800 From: Thomas Wood To: intel-gfx@lists.freedesktop.org Date: Mon, 2 Nov 2015 17:25:30 +0000 Message-Id: <1446485133-13529-2-git-send-email-thomas.wood@intel.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1446485133-13529-1-git-send-email-thomas.wood@intel.com> References: <1446485133-13529-1-git-send-email-thomas.wood@intel.com> Organization: Intel Corporation (UK) Ltd. - Co. Reg. #1134945 - Pipers Way, Swindon SN3 1RJ Subject: [Intel-gfx] [PATCH i-g-t 2/5] lib: add documentation for igt_display_init/fini 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=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, T_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 Signed-off-by: Thomas Wood --- lib/igt_kms.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/igt_kms.c b/lib/igt_kms.c index 51d735d..878e1fb 100644 --- a/lib/igt_kms.c +++ b/lib/igt_kms.c @@ -962,6 +962,15 @@ static int get_drm_plane_type(int drm_fd, uint32_t plane_id) return DRM_PLANE_TYPE_OVERLAY; } +/** + * igt_display_init: + * @display: a pointer to an #igt_display_t structure + * @drm_fd: a drm file descriptor + * + * Initialize @display and allocate the various resources required. Use + * #igt_display_fini to release the resources when they are no longer required. + * + */ void igt_display_init(igt_display_t *display, int drm_fd) { drmModeRes *resources; @@ -1160,6 +1169,13 @@ static void igt_output_fini(igt_output_t *output) free(output->name); } +/** + * igt_display_fini: + * @display: a pointer to an #igt_display_t structure + * + * Release any resources associated with @display. This does not free @display + * itself. + */ void igt_display_fini(igt_display_t *display) { int i;