From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B813138BF60 for ; Wed, 25 Mar 2026 23:52:42 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1774482764; cv=none; b=J/ld1fXQHNnrtex+imDHJWgT9iCSWjfUAgr+YJ9MXTK4ruYzRtboEr7F9IxRuAgc38NMkGhAsqrK95qXkM7yxJO2M9KEJ6Dyx6qWUr17/NpZJpm9MzXlV2PinzYlQioRODyMGwwkGI983Rg5ne0G/TiszwNqQvfmTJziJGMPZJ8= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1774482764; c=relaxed/simple; bh=pDlL9CglIFwRMO2//WwSLnjr7T4jqi7GVAwBYo3zUck=; h=From:Subject:Date:Message-Id:MIME-Version:Content-Type:To:Cc; b=RCKF7ZgsswHf/nQgeRX55ZE5lS/pKSffhURjyH+ZLzguOMBsgPBuojCHmLl0yb3iIn3TaBVqxY7riuEmHoSWy8Wu1z94d75hfz3CNyXjsRPFNfbKj7lor/bhga776dk/s64FryCVUFFVKxA/27BDhS9AapDsQMe/wjdNLKJi2Dc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=Zz6Gtbv3; dkim=pass (2048-bit key) header.d=redhat.com header.i=@redhat.com header.b=cQ6K1kzS; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Zz6Gtbv3"; dkim=pass (2048-bit key) header.d=redhat.com header.i=@redhat.com header.b="cQ6K1kzS" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1774482761; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=yuJFXc+oSvSHiNWcGKsTw0+QoEJBqEFxVNPR1gcgJbM=; b=Zz6Gtbv3sBozsI2/X8mvsRyQxlaPg8fa4u0Yh7gGZv4hPc2bi3edaGvgPsBReWytq7ECp7 IDpXR3tHI3Ezrjb8XkYKiNgM53CfiHwiZ2LfSar8rYiT4pgn7bsExKzWrmhMf/Mj0MEzc7 ChJ3ACduOR3XMVqokNyJUCW7+Zv6n9c= Received: from mail-qk1-f198.google.com (mail-qk1-f198.google.com [209.85.222.198]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-394-kXtQIMHxP-utxtlKt_fMeQ-1; Wed, 25 Mar 2026 19:52:40 -0400 X-MC-Unique: kXtQIMHxP-utxtlKt_fMeQ-1 X-Mimecast-MFC-AGG-ID: kXtQIMHxP-utxtlKt_fMeQ_1774482760 Received: by mail-qk1-f198.google.com with SMTP id af79cd13be357-8cfda078676so182082985a.2 for ; Wed, 25 Mar 2026 16:52:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=google; t=1774482760; x=1775087560; darn=vger.kernel.org; h=cc:to:content-transfer-encoding:mime-version:message-id:date :subject:from:from:to:cc:subject:date:message-id:reply-to; bh=yuJFXc+oSvSHiNWcGKsTw0+QoEJBqEFxVNPR1gcgJbM=; b=cQ6K1kzSgy6+Pde3JMLbR+DEDzVoMPT1prAP5K2+Q67HfT18WBd15NH0chfkRsGst3 /vzpzMRKtPY1V56zPv8NRBKdUPZpdviOUeaq5Z7inGVHXLBbOug1hysQ4f+dh2uTmTzY ZEt2wqyIS+5oMqr/nY+oPbPDVsF7GhmuE9ZOXs6h586ktjmutuNs+nApUs6ZCcwGYghe iX8pq1db4tRK93BVJqnY9j6cMRA/3aJbDU68WbPkxDzY9FQ19GaMcrj19slNCy9pHXew /+995YU19vpzmQxpFpeG0Fz0l0BozIEEzZMGI+eHOcnwoYiT2y1DMLekKezVQSQ21wVF WfDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1774482760; x=1775087560; h=cc:to:content-transfer-encoding:mime-version:message-id:date :subject:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=yuJFXc+oSvSHiNWcGKsTw0+QoEJBqEFxVNPR1gcgJbM=; b=bDW3bcWKXI6HICOhn3i4THzDM/HS9y3YsQMBMfr11xkVuAswGgUwhv9GeVXHMVqKOV NhsrU0nkNiUgavuXM0Auah3Co/DpF1WPLD5q6db8IU/0F830Ogyg4E/lbe7mlJu/VpUN KXFb2yFeEjRWEZdD6xyrIRT8ZWS07Cqw1v8XTjjFqImpNg8dKcOjbxerHGptJ5Kib0dh M1F68y2XNcZjVXDqlbWIekX4M0ZPx+eqtw9C/Wm7YqPkFIzOx6uJJGIuviknNYsMRXoH +YaJ2DjeytJfMF7qrxyTz70BOMTg46y6RujwRtJRJtqy5yGxIsmgCmrRRRvc5+Wcpqzx CZFQ== X-Forwarded-Encrypted: i=1; AJvYcCXdT0qpyhGKwisLyg+z4/wbICpUeFeCQkJyjHhjhPpRrgyYcXKAvezcZMCZcNylyqDAtIR9wqh40XhDuLA=@vger.kernel.org X-Gm-Message-State: AOJu0YwYuYh2FsPKlCvgVmVylIM5Wqa9zDAzxzasJATk9R69ntYnlBvz BpE8+Xi/jkagSsasPKjRyxzMhZnNctTrehRrp1OA3UKY3mHt0wbKeJ/ObcaMT7hI5y6uIzreag8 41zpyPLf5p9otywrxvCaGUIrMb+m0E3381wPh5TJohPr3h7pp5+VlmQzsYhwZqEf2pA== X-Gm-Gg: ATEYQzz5/ISwuiC2vhJgFTLUMHJUiNPzE26tVK43xX/3yxjBlm/efDh817c6OujysAh XspDBrZT1VGtk1ReF2juDgDWmjXxecIHmaJcUDFDYYIYmTV0Pi5KZ8GEa4i6zP/C5OQeVUnzfXR ZKHGNEixhKAbjzAFMAM97Ek15zYQYFqRvWno1iVcEc/fm1qRzjUj7KOpKZRbkvANYOGxJnhB6eB x3KSoqRIn7Bjy1gsBqzm0A/YD6SUUxARNY5GSx8J3NYGCse0wmPNmgTqsx9fOQ2djCvNCU+/K8o s6wAC9N/uF7bl6X2s6mwrTWZCKzyoq5faYXgrFfv9edEjwyMYwH9a8w5pq51g/uilUbKzyAFpAT DwEzQDXH8yprsHxzHdRM9dkZaN54er636W65JdOMjmdE3GjezNutN9sOv8ThB X-Received: by 2002:a05:620a:1708:b0:8cf:be85:ba84 with SMTP id af79cd13be357-8d00107923fmr778027485a.54.1774482759962; Wed, 25 Mar 2026 16:52:39 -0700 (PDT) X-Received: by 2002:a05:620a:1708:b0:8cf:be85:ba84 with SMTP id af79cd13be357-8d00107923fmr778024085a.54.1774482759430; Wed, 25 Mar 2026 16:52:39 -0700 (PDT) Received: from [192.168.1.3] (c-73-183-52-120.hsd1.pa.comcast.net. [73.183.52.120]) by smtp.gmail.com with ESMTPSA id af79cd13be357-8d00e501eedsm106346785a.40.2026.03.25.16.52.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 25 Mar 2026 16:52:38 -0700 (PDT) From: Brian Masney Subject: [PATCH v2 0/4] clk: update kernel docs Date: Wed, 25 Mar 2026 19:52:09 -0400 Message-Id: <20260325-clk-docs-v2-0-bcf660e1ceb5@redhat.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit X-B4-Tracking: v=1; b=H4sIAAAAAAAC/23MQQ7CIBCF4as0s3bMgIitK+9humhhEKIWA02ja bi72LXL/+XlWyFzCpzh3KyQeAk5xKmG3DVg/DDdGIOtDZKkpgMpNI872mgy0ng8tU5JoYmg3l+ JXXhv1LWv7UOeY/ps8iJ+6x9kEUjomJVu7dh1TlwSWz/MexOf0JdSvh4f6YuhAAAA X-Change-ID: 20260304-clk-docs-0b578f421600 To: Michael Turquette , Stephen Boyd , Maxime Ripard , Jonathan Corbet , Shuah Khan Cc: linux-clk@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Brian Masney X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1789; i=bmasney@redhat.com; s=20250903; h=from:subject:message-id; bh=pDlL9CglIFwRMO2//WwSLnjr7T4jqi7GVAwBYo3zUck=; b=owGbwMvMwCW2/dJd9di6A+2Mp9WSGDKPlFo5/vZZuG+mk1PKvYgrl3X/XDn3f2vjybkxZ+tnn FZQf6Fq01HKwiDGxSArpsiyJNeoICJ1le29O5osMHNYmUCGMHBxCsBENvEyMnSd2xG4cIsok6FS pEK0S/KyA7ITX1b7r++ecmNv/6FlKzcwMkwXEzkyV31+S2zVzYBbjDqb3jxwuXrIh2GTYi2r3eb E2dwA X-Developer-Key: i=bmasney@redhat.com; a=openpgp; fpr=A46D32705865AA3DDEDC2904B7D2DD275D7EC087 Here's a small series that updates the kernel documentation for struct clk_core, moves the clk flags into a new enum so that they can be shown in the documentation, and updates the clk kunit test to use HZ_PER_MHZ. Since I've been doing a lot of work in the clk subsystem lately, I would like to add some more documentation about this subsystem in the future as I have time. There's a lot of other things that I know can be done now, and I'd like to just start with these small changes merged. Changes in v2: - Add clk_core_flags enum, and kernel doc for this. - Update descriptions in clk_core based on feedback from Stephen. - Update clk kernel docs to show some of the new API documentation. - Link to v1: https://lore.kernel.org/r/20260304-clk-docs-v1-0-fee468db99f1@redhat.com Merge Strategy -------------- Since there is a new enum that's added, and it's referenced in the docoumentation, all of these patches will need to go through Stephen's tree. Signed-off-by: Brian Masney --- Brian Masney (4): clk: move core flags into a new enum for kernel docs clk: add kernel docs for struct clk_core docs: clk: include some identifiers to keep documentation up to date clk: test: convert constants to use HZ_PER_MHZ Documentation/driver-api/clk.rst | 58 +++++++--------------------------------- drivers/clk/clk.c | 51 +++++++++++++++++++++++++++++++++++ drivers/clk/clk_test.c | 7 ++--- include/linux/clk-provider.h | 55 ++++++++++++++++++++++--------------- 4 files changed, 98 insertions(+), 73 deletions(-) --- base-commit: 85964cdcad0fac9a0eb7b87a0f9d88cc074b854c change-id: 20260304-clk-docs-0b578f421600 Best regards, -- Brian Masney