From patchwork Wed Jun 28 10:40:37 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Arkadiusz Hiler X-Patchwork-Id: 9813925 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 3E813603D7 for ; Wed, 28 Jun 2017 10:40:52 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 326491FF52 for ; Wed, 28 Jun 2017 10:40:52 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2521F284FC; Wed, 28 Jun 2017 10:40:52 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 862851FF52 for ; Wed, 28 Jun 2017 10:40:51 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 2C73B6E438; Wed, 28 Jun 2017 10:40:49 +0000 (UTC) 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 ESMTPS id 21AF36E438 for ; Wed, 28 Jun 2017 10:40:48 +0000 (UTC) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Jun 2017 03:40:47 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos; i="5.40,275,1496127600"; d="scan'208"; a="1165585186" Received: from ahiler-desk1.fi.intel.com ([10.237.68.139]) by fmsmga001.fm.intel.com with ESMTP; 28 Jun 2017 03:40:46 -0700 From: Arkadiusz Hiler To: intel-gfx@lists.freedesktop.org Date: Wed, 28 Jun 2017 13:40:37 +0300 Message-Id: <20170628104037.2979-1-arkadiusz.hiler@intel.com> X-Mailer: git-send-email 2.9.4 In-Reply-To: <20170623132122.24698-1-radoslaw.szwichtenberg@intel.com> References: <20170623132122.24698-1-radoslaw.szwichtenberg@intel.com> Organization: Intel Technology Poland sp. z o.o. - KRS 101882 - ul. Slowackiego 173, 80-298 Gdansk Cc: Daniel Vetter Subject: [Intel-gfx] [PATCH i-g-t] lib/ioctl_wrappers: Fix some comments 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-Virus-Scanned: ClamAV using ClamSMTP "This is a wraps" -> "This wraps" "hw/hardware context" -> "context" gem_context_create does not use igt_require() but igt_skip_on() so make the similarity note more vague and in result true. Cc: Daniel Vetter Cc: Radoslaw Szwichtenberg Signed-off-by: Arkadiusz Hiler Reviewed-by: Radoslaw Szwichtenberg --- lib/ioctl_wrappers.c | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/lib/ioctl_wrappers.c b/lib/ioctl_wrappers.c index 8e5ec88..2bbaed5 100644 --- a/lib/ioctl_wrappers.c +++ b/lib/ioctl_wrappers.c @@ -881,7 +881,7 @@ void *gem_mmap__cpu(int fd, uint32_t handle, uint64_t offset, uint64_t size, uns * @handle: gem buffer object handle * @state: desired madvise state * - * This is a wraps the MADVISE ioctl, which is used in libdrm to implement + * This wraps the MADVISE ioctl, which is used in libdrm to implement * opportunistic buffer object caching. Objects in the cache are set to DONTNEED * (internally in the kernel tracked as purgeable objects). When such a cached * object is in need again it must be set back to WILLNEED before first use. @@ -906,12 +906,11 @@ int gem_madvise(int fd, uint32_t handle, int state) * gem_context_create: * @fd: open i915 drm file descriptor * - * This is a wraps the CONTEXT_CREATE ioctl, which is used to allocate a new - * hardware context. Not that similarly to gem_set_caching() this wrapper calls - * igt_require() internally to correctly skip on kernels and platforms where hw - * context support is not available. + * This wraps the CONTEXT_CREATE ioctl, which is used to allocate a new + * context. Note that similarly to gem_set_caching() this wrapper skips on + * kernels and platforms where context support is not available. * - * Returns: The id of the allocated hw context. + * Returns: The id of the allocated context. */ uint32_t gem_context_create(int fd) { @@ -946,10 +945,9 @@ int __gem_context_destroy(int fd, uint32_t ctx_id) /** * gem_context_destroy: * @fd: open i915 drm file descriptor - * @ctx_id: i915 hw context id + * @ctx_id: i915 context id * - * This is a wraps the CONTEXT_DESTROY ioctl, which is used to free a hardware - * context. + * This wraps the CONTEXT_DESTROY ioctl, which is used to free a context. */ void gem_context_destroy(int fd, uint32_t ctx_id) { @@ -975,9 +973,9 @@ int __gem_context_get_param(int fd, struct local_i915_gem_context_param *p) /** * gem_context_get_param: * @fd: open i915 drm file descriptor - * @p: i915 hw context parameter + * @p: i915 context parameter * - * This is a wraps the CONTEXT_GET_PARAM ioctl, which is used to get a context + * This wraps the CONTEXT_GET_PARAM ioctl, which is used to get a context * parameter. */ void gem_context_get_param(int fd, struct local_i915_gem_context_param *p) @@ -999,9 +997,9 @@ int __gem_context_set_param(int fd, struct local_i915_gem_context_param *p) /** * gem_context_set_param: * @fd: open i915 drm file descriptor - * @p: i915 hw context parameter + * @p: i915 context parameter * - * This is a wraps the CONTEXT_SET_PARAM ioctl, which is used to set a context + * This wraps the CONTEXT_SET_PARAM ioctl, which is used to set a context * parameter. */ void gem_context_set_param(int fd, struct local_i915_gem_context_param *p) @@ -1012,9 +1010,9 @@ void gem_context_set_param(int fd, struct local_i915_gem_context_param *p) /** * gem_context_require_param: * @fd: open i915 drm file descriptor - * @param: i915 hw context parameter + * @param: i915 context parameter * - * Feature test macro to query whether hw context parameter support for @param + * Feature test macro to query whether context parameter support for @param * is available. Automatically skips through igt_require() if not. */ void gem_context_require_param(int fd, uint64_t param) @@ -1098,7 +1096,7 @@ void gem_userptr(int fd, void *ptr, int size, int read_only, uint32_t flags, uin * @fd: open i915 drm file descriptor * @handle: gem buffer object handle * - * This is a wraps the SW_FINISH ioctl, which is used to flush out frontbuffer + * This wraps the SW_FINISH ioctl, which is used to flush out frontbuffer * rendering done through the direct cpu memory mappings. Shipping userspace * does _not_ call this after frontbuffer rendering through gtt memory mappings. */ @@ -1117,7 +1115,7 @@ void gem_sw_finish(int fd, uint32_t handle) * @fd: open i915 drm file descriptor * @handle: gem buffer object handle * - * This is a wraps the BUSY ioctl, which tells whether a buffer object is still + * This wraps the BUSY ioctl, which tells whether a buffer object is still * actively used by the gpu in a execbuffer. * * Returns: The busy state of the buffer object.