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 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 smtp.lore.kernel.org (Postfix) with ESMTPS id 54B00C00140 for ; Fri, 5 Aug 2022 09:39:47 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 498BAB2922; Fri, 5 Aug 2022 09:27:26 +0000 (UTC) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by gabe.freedesktop.org (Postfix) with ESMTPS id DD37DB20C9; Fri, 5 Aug 2022 09:26:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1659691593; x=1691227593; h=message-id:date:mime-version:subject:to:cc:references: from:in-reply-to:content-transfer-encoding; bh=tG8kUD3ji7GDYQSEFarrC17CSyndXtVIb31RNBiVtX4=; b=dvErYwbBiTy8WVtIUdE2Kbq300OF8nISVJcLFR89EKQvMlIkT4OigO9P /NbX+RDTGa3DJTqTjC8cDQALR27P+AnYylpYBVNk7SLg1W8Orb2+XZ4ak PvdrXf29t4I3bsBCOt2fqKExbth68dyenPHzw7At8JbLHtc7kJ+yFUz4C wQdgDDAI8n2hyWsgypUavn7Xj0mT52OqCvRRC5KbaN7q2mGOMARnQX2uR 1kZHJ21Ayem00oHxvq6AribwMeFJL/QCiCY4kXGPiMLmKI7KviWvQul51 +kpykvmK4efZyNtr2DZ6ARM4I6qFXL1kDyZrUZH5Ip8VkZ8qKPdWzLyOP Q==; X-IronPort-AV: E=McAfee;i="6400,9594,10429"; a="291384807" X-IronPort-AV: E=Sophos;i="5.93,216,1654585200"; d="scan'208";a="291384807" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 05 Aug 2022 02:24:31 -0700 X-IronPort-AV: E=Sophos;i="5.93,216,1654585200"; d="scan'208";a="554052121" Received: from bfglenno-mobl.ger.corp.intel.com (HELO [10.213.238.183]) ([10.213.238.183]) by orsmga003-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 05 Aug 2022 02:24:27 -0700 Message-ID: <7156b3bd-69d7-de53-dd2b-96e82a8cf0f7@linux.intel.com> Date: Fri, 5 Aug 2022 10:24:25 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0 Content-Language: en-US To: Andi Shyti , Randy Dunlap References: <0698c5a5-3bf2-daa4-e10e-2715f9b0d080@infradead.org> From: Tvrtko Ursulin Organization: Intel Corporation UK Plc In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit Subject: Re: [Intel-gfx] [PATCH v3 3/3] drm/i915/gt: document TLB cache invalidation functions 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: Maxime Ripard , Thomas Zimmermann , Jonathan Corbet , David Airlie , dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org, Chris Wilson , linux-doc@vger.kernel.org, Rodrigo Vivi , Mauro Carvalho Chehab , intel-gfx@lists.freedesktop.org Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" On 05/08/2022 10:08, Andi Shyti wrote: > Hi Randy, > >>> +/** >>> + * intel_gt_invalidate_tlb_full - do full TLB cache invalidation >>> + * @gt: GT structure >> >> In multiple places (here and below) it would be nice to know what a >> GT structure is. I looked thru multiple C and header files yesterday >> and didn't find any comments about it. >> >> Just saying that @gt is a GT structure isn't very helpful, other >> than making kernel-doc shut up. > > the 'gt' belongs to the drivers/gpu/drm/i915/gt/ subsystem and > it's widely used a throughout i915. > > I think it's inappropriate to describe it just here. On the other > hand I agree that a better documentation is required for the GT > itself where other parts can point to. Yeah agreed there is no point of copy pasting some explanation all over the place. Could we just do s/GT structure/struct intel_gt/, or "pointer to struct intel_gt to operate on", would that be good enough? Regards, Tvrtko