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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (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 2471CC77B7C for ; Fri, 5 May 2023 15:30:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=Ms52/Dkvuu0TXCzyUbgcB5VtIfggR0svLm/VbNc5Nzc=; b=HdsuRrSJtlBsOv AsQLCjRd23njUDaO8A/q4Fyogt++eUDoVq8gp0OJUqVnMJyfvWFy3jjZpolElqCjWufaE9+KcKlkC cRTbqt41cJPQ8wqu/8rFVC3lzc08Gv7ZPvAostqe+qDicKOW1FyFDhuextXi0bzhamw7xGjRuPDqP /AfwWZ4aeIz9lie6oDzcpBRJ4zzn9XtBicj/uDSEsqxOHl1q4fnDijRr5+XZGGaRFQQDhrgp609t9 oR/WaYas0VYaGCzrtsMiCvwVGPszoa5wOx3tgA3cc+6rr1Mm+AcHl9qGtSCJt2CqE6KnEfLrWoXYc 0r5nhHJW/8W+xVnT7G5w==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1puxNN-00BBrH-0z; Fri, 05 May 2023 15:29:41 +0000 Received: from dfw.source.kernel.org ([139.178.84.217]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1puxNJ-00BBq9-2O for linux-arm-kernel@lists.infradead.org; Fri, 05 May 2023 15:29:39 +0000 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 5A09E63ED2; Fri, 5 May 2023 15:29:37 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 35910C433D2; Fri, 5 May 2023 15:29:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1683300576; bh=2TPWOPhFJzdwwpBDvHtt4BWhGjepWrVrYx1gskl609o=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=uc7K/I/VdaX8SNqB1hYfppXeHReiEZmx2kkprPXG2aCStH0FkYn1q0vurH4PwTn+D XsIWamEMOdWk9ImVuAZLoa5jVco57mz22p0u+f0+enaF2QHKOZ/+Cy/ye5LfeJTRQ4 65K4n7tfX2kU3YH0g2M6g7zXZTOVuc/pa8I3OiJzyZZmh4QwDpxwvYpdRgmTFVexaG DL6V1cRT56eDGidyGVv70rWDoe8T4irCWAJRe8l5nxSubJP0I9pefMYK/hMGg2WmK0 ycWf/nmSB5mJ/WOxow0F5b8bN3+h8raqWdPoBKtTarnKcTWZRyLqrm25tzMCIIGwgj ghy6a54FyoJyw== Date: Fri, 5 May 2023 08:29:35 -0700 From: Jakub Kicinski To: Vadim Fedorenko Cc: Vadim Fedorenko , Jiri Pirko , Arkadiusz Kubalewski , Jonathan Lemon , Paolo Abeni , Milena Olech , Michal Michalik , linux-arm-kernel@lists.infradead.org, poros@redhat.com, mschmidt@redhat.com, netdev@vger.kernel.org, linux-clk@vger.kernel.org Subject: Re: [RFC PATCH v7 3/8] dpll: documentation on DPLL subsystem interface Message-ID: <20230505082935.24deca78@kernel.org> In-Reply-To: <7be22f4a-3fd5-f579-6824-56b4feafdb03@linux.dev> References: <20230428002009.2948020-1-vadfed@meta.com> <20230428002009.2948020-4-vadfed@meta.com> <20230504120431.036cb8ba@kernel.org> <7be22f4a-3fd5-f579-6824-56b4feafdb03@linux.dev> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230505_082937_817467_1A2A57A0 X-CRM114-Status: GOOD ( 18.68 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Fri, 5 May 2023 14:16:53 +0100 Vadim Fedorenko wrote: > >> +Then there are two groups of configuration knobs: > >> +1) Set on a pin - the configuration affects all dpll devices pin is > >> + registered to. (i.e. ``PIN_FREQUENCY``, ``PIN_DIRECTION``), > > > > Why is direction set on a pin? We can't chain DPLLs? > > We can chain DPLLs using pins only. We don't have any interface to > configure 2 pins to connect 2 different DPLLs to each other at the same > time. The configuration should take care of one pin being input and > other one being output. That's why we have direction property attached > to the pin, not the DPLL itself. Makes sense. > >> +Device driver implementation > >> +============================ > >> + > >> +Device is allocated by ``dpll_device_get`` call. Second call with the > >> +same arguments doesn't create new object but provides pointer to > >> +previously created device for given arguments, it also increase refcount > >> +of that object. > >> +Device is deallocated by ``dpll_device_put`` call, which first decreases > >> +the refcount, once refcount is cleared the object is destroyed. > > > > You can add () after the function name and render the kdoc at the end > > of this doc. The `` marking will then be unnecessary. > > > Mmm... any examples of such a way of creating documentation? I was > following tls*.rst style, but without copying code-blocks. net_dim.rst, maybe? driver.rst ? Feel free to ping me 1:1 if you're struggling, it should be fairly straightforward. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel