From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 74B25C43461 for ; Wed, 21 Apr 2021 14:39:19 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 5095761457 for ; Wed, 21 Apr 2021 14:39:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S243624AbhDUOju (ORCPT ); Wed, 21 Apr 2021 10:39:50 -0400 Received: from mga12.intel.com ([192.55.52.136]:46406 "EHLO mga12.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S243476AbhDUOjs (ORCPT ); Wed, 21 Apr 2021 10:39:48 -0400 IronPort-SDR: LupxxomHL1KBvkM7KxMieqd/DuMb0fGwXheUgmYBmLyv0c/h66H9u+qzQAyolcdonoUVmSu1u/ 0oX1NukqTTBw== X-IronPort-AV: E=McAfee;i="6200,9189,9961"; a="175194776" X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="175194776" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:39:15 -0700 IronPort-SDR: 5FrLDqwjxLoKcB5liQmfvq9kHa0/Cm2aFt6uXtcwXh41gdtzV+M0BR0F0wOut9XQPBOY97/eLE rBG+3t5cmTMw== X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="421008986" Received: from lvaldivi-mobl3.ger.corp.intel.com (HELO [10.252.63.171]) ([10.252.63.171]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:39:13 -0700 Subject: Re: [PATCH] drm/i915: Fix docbook descriptions for i915_cmd_parser To: Daniel Vetter Cc: intel-gfx , Stephen Rothwell , DRI , Dave Airlie , Linux Kernel Mailing List References: <20210421120353.544518-1-maarten.lankhorst@linux.intel.com> From: Maarten Lankhorst Message-ID: <9ae96fa1-6c91-4ec1-422d-8e0a95251bb7@linux.intel.com> Date: Wed, 21 Apr 2021 16:39:10 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.9.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Content-Language: en-US Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Op 21-04-2021 om 16:32 schreef Daniel Vetter: > On Wed, Apr 21, 2021 at 2:03 PM Maarten Lankhorst > wrote: >> Fixes the following htmldocs warnings: >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Excess function parameter 'trampoline' description in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'jump_whitelist' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'shadow_map' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'batch_map' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Excess function parameter 'trampoline' description in 'intel_engine_cmd_parser' >> >> Reported-by: Stephen Rothwell >> Signed-off-by: Maarten Lankhorst >> --- >> drivers/gpu/drm/i915/i915_cmd_parser.c | 16 +++++++++++++++- >> 1 file changed, 15 insertions(+), 1 deletion(-) >> >> diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c >> index e6f1e93abbbb..afb9b7516999 100644 >> --- a/drivers/gpu/drm/i915/i915_cmd_parser.c >> +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c >> @@ -1369,6 +1369,18 @@ static int check_bbstart(u32 *cmd, u32 offset, u32 length, >> return 0; >> } >> >> +/** >> + * intel_engine_cmd_parser_alloc_jump_whitelist() - preallocate jump whitelist for intel_engine_cmd_parser() >> + * @batch_length: length of the commands in batch_obj >> + * @trampoline: Whether jump trampolines are used. >> + * >> + * Preallocates a jump whitelist for parsing the cmd buffer in intel_engine_cmd_parser(). >> + * This has to be preallocated, because the command parser runs in signaling context, >> + * and may not allocate any memory. >> + * >> + * Return: NULL or pointer to a jump whitelist, or ERR_PTR() on failure. Use >> + * IS_ERR() to check for errors. Must bre freed() with kfree(). > IS_ERR_OR_NULL or needs an actual bugfix in the code since we're not > consistent. Also s/bre/be/ We're sort of consistent, NULL is a valid return code. IS_ERR is only on faliure. :) > -Daniel > >> + */ >> unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length, >> bool trampoline) >> { >> @@ -1401,7 +1413,9 @@ unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length, >> * @batch_offset: byte offset in the batch at which execution starts >> * @batch_length: length of the commands in batch_obj >> * @shadow: validated copy of the batch buffer in question >> - * @trampoline: whether to emit a conditional trampoline at the end of the batch >> + * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist() >> + * @shadow_map: mapping to @shadow vma >> + * @batch_map: mapping to @batch vma >> * >> * Parses the specified batch buffer looking for privilege violations as >> * described in the overview. >> -- >> 2.31.0 >> > From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 746D5C433B4 for ; Wed, 21 Apr 2021 14:39:19 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 1AF4361421 for ; Wed, 21 Apr 2021 14:39:19 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 1AF4361421 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.intel.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 0DFCB6E9C4; Wed, 21 Apr 2021 14:39:17 +0000 (UTC) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by gabe.freedesktop.org (Postfix) with ESMTPS id 88F786E0C5; Wed, 21 Apr 2021 14:39:15 +0000 (UTC) IronPort-SDR: 6F5strjR5gJBcbJNCdYcAvqKqEnFfgUYHSAFaQqumeKrB5I8NvTAVg1lKlhafOM4fVMLw/A5v1 yHbJA6oytjcw== X-IronPort-AV: E=McAfee;i="6200,9189,9961"; a="193585691" X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="193585691" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:39:14 -0700 IronPort-SDR: 5FrLDqwjxLoKcB5liQmfvq9kHa0/Cm2aFt6uXtcwXh41gdtzV+M0BR0F0wOut9XQPBOY97/eLE rBG+3t5cmTMw== X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="421008986" Received: from lvaldivi-mobl3.ger.corp.intel.com (HELO [10.252.63.171]) ([10.252.63.171]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:39:13 -0700 Subject: Re: [PATCH] drm/i915: Fix docbook descriptions for i915_cmd_parser To: Daniel Vetter References: <20210421120353.544518-1-maarten.lankhorst@linux.intel.com> From: Maarten Lankhorst Message-ID: <9ae96fa1-6c91-4ec1-422d-8e0a95251bb7@linux.intel.com> Date: Wed, 21 Apr 2021 16:39:10 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.9.0 MIME-Version: 1.0 In-Reply-To: Content-Language: en-US X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Dave Airlie , Stephen Rothwell , intel-gfx , Linux Kernel Mailing List , DRI Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Op 21-04-2021 om 16:32 schreef Daniel Vetter: > On Wed, Apr 21, 2021 at 2:03 PM Maarten Lankhorst > wrote: >> Fixes the following htmldocs warnings: >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Excess function parameter 'trampoline' description in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'jump_whitelist' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'shadow_map' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'batch_map' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Excess function parameter 'trampoline' description in 'intel_engine_cmd_parser' >> >> Reported-by: Stephen Rothwell >> Signed-off-by: Maarten Lankhorst >> --- >> drivers/gpu/drm/i915/i915_cmd_parser.c | 16 +++++++++++++++- >> 1 file changed, 15 insertions(+), 1 deletion(-) >> >> diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c >> index e6f1e93abbbb..afb9b7516999 100644 >> --- a/drivers/gpu/drm/i915/i915_cmd_parser.c >> +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c >> @@ -1369,6 +1369,18 @@ static int check_bbstart(u32 *cmd, u32 offset, u32 length, >> return 0; >> } >> >> +/** >> + * intel_engine_cmd_parser_alloc_jump_whitelist() - preallocate jump whitelist for intel_engine_cmd_parser() >> + * @batch_length: length of the commands in batch_obj >> + * @trampoline: Whether jump trampolines are used. >> + * >> + * Preallocates a jump whitelist for parsing the cmd buffer in intel_engine_cmd_parser(). >> + * This has to be preallocated, because the command parser runs in signaling context, >> + * and may not allocate any memory. >> + * >> + * Return: NULL or pointer to a jump whitelist, or ERR_PTR() on failure. Use >> + * IS_ERR() to check for errors. Must bre freed() with kfree(). > IS_ERR_OR_NULL or needs an actual bugfix in the code since we're not > consistent. Also s/bre/be/ We're sort of consistent, NULL is a valid return code. IS_ERR is only on faliure. :) > -Daniel > >> + */ >> unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length, >> bool trampoline) >> { >> @@ -1401,7 +1413,9 @@ unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length, >> * @batch_offset: byte offset in the batch at which execution starts >> * @batch_length: length of the commands in batch_obj >> * @shadow: validated copy of the batch buffer in question >> - * @trampoline: whether to emit a conditional trampoline at the end of the batch >> + * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist() >> + * @shadow_map: mapping to @shadow vma >> + * @batch_map: mapping to @batch vma >> * >> * Parses the specified batch buffer looking for privilege violations as >> * described in the overview. >> -- >> 2.31.0 >> > _______________________________________________ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6DEE6C433ED for ; Wed, 21 Apr 2021 14:39:17 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 06D8661454 for ; Wed, 21 Apr 2021 14:39:16 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 06D8661454 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.intel.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=intel-gfx-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 9093A6E0C5; Wed, 21 Apr 2021 14:39:16 +0000 (UTC) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by gabe.freedesktop.org (Postfix) with ESMTPS id 88F786E0C5; Wed, 21 Apr 2021 14:39:15 +0000 (UTC) IronPort-SDR: 6F5strjR5gJBcbJNCdYcAvqKqEnFfgUYHSAFaQqumeKrB5I8NvTAVg1lKlhafOM4fVMLw/A5v1 yHbJA6oytjcw== X-IronPort-AV: E=McAfee;i="6200,9189,9961"; a="193585691" X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="193585691" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:39:14 -0700 IronPort-SDR: 5FrLDqwjxLoKcB5liQmfvq9kHa0/Cm2aFt6uXtcwXh41gdtzV+M0BR0F0wOut9XQPBOY97/eLE rBG+3t5cmTMw== X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="421008986" Received: from lvaldivi-mobl3.ger.corp.intel.com (HELO [10.252.63.171]) ([10.252.63.171]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:39:13 -0700 To: Daniel Vetter References: <20210421120353.544518-1-maarten.lankhorst@linux.intel.com> From: Maarten Lankhorst Message-ID: <9ae96fa1-6c91-4ec1-422d-8e0a95251bb7@linux.intel.com> Date: Wed, 21 Apr 2021 16:39:10 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.9.0 MIME-Version: 1.0 In-Reply-To: Content-Language: en-US Subject: Re: [Intel-gfx] [PATCH] drm/i915: Fix docbook descriptions for i915_cmd_parser X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Dave Airlie , Stephen Rothwell , intel-gfx , Linux Kernel Mailing List , DRI Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" Op 21-04-2021 om 16:32 schreef Daniel Vetter: > On Wed, Apr 21, 2021 at 2:03 PM Maarten Lankhorst > wrote: >> Fixes the following htmldocs warnings: >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Excess function parameter 'trampoline' description in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'jump_whitelist' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'shadow_map' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Function parameter or member 'batch_map' not described in 'intel_engine_cmd_parser' >> drivers/gpu/drm/i915/i915_cmd_parser.c:1420: warning: Excess function parameter 'trampoline' description in 'intel_engine_cmd_parser' >> >> Reported-by: Stephen Rothwell >> Signed-off-by: Maarten Lankhorst >> --- >> drivers/gpu/drm/i915/i915_cmd_parser.c | 16 +++++++++++++++- >> 1 file changed, 15 insertions(+), 1 deletion(-) >> >> diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c >> index e6f1e93abbbb..afb9b7516999 100644 >> --- a/drivers/gpu/drm/i915/i915_cmd_parser.c >> +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c >> @@ -1369,6 +1369,18 @@ static int check_bbstart(u32 *cmd, u32 offset, u32 length, >> return 0; >> } >> >> +/** >> + * intel_engine_cmd_parser_alloc_jump_whitelist() - preallocate jump whitelist for intel_engine_cmd_parser() >> + * @batch_length: length of the commands in batch_obj >> + * @trampoline: Whether jump trampolines are used. >> + * >> + * Preallocates a jump whitelist for parsing the cmd buffer in intel_engine_cmd_parser(). >> + * This has to be preallocated, because the command parser runs in signaling context, >> + * and may not allocate any memory. >> + * >> + * Return: NULL or pointer to a jump whitelist, or ERR_PTR() on failure. Use >> + * IS_ERR() to check for errors. Must bre freed() with kfree(). > IS_ERR_OR_NULL or needs an actual bugfix in the code since we're not > consistent. Also s/bre/be/ We're sort of consistent, NULL is a valid return code. IS_ERR is only on faliure. :) > -Daniel > >> + */ >> unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length, >> bool trampoline) >> { >> @@ -1401,7 +1413,9 @@ unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length, >> * @batch_offset: byte offset in the batch at which execution starts >> * @batch_length: length of the commands in batch_obj >> * @shadow: validated copy of the batch buffer in question >> - * @trampoline: whether to emit a conditional trampoline at the end of the batch >> + * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist() >> + * @shadow_map: mapping to @shadow vma >> + * @batch_map: mapping to @batch vma >> * >> * Parses the specified batch buffer looking for privilege violations as >> * described in the overview. >> -- >> 2.31.0 >> > _______________________________________________ Intel-gfx mailing list Intel-gfx@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/intel-gfx