From dd0808ab40ca4c00e1c3cae85614f1a42b3df882 Mon Sep 17 00:00:00 2001 From: Kevin Paul Reddy Janagari Date: Sat, 5 Apr 2025 22:21:16 +0530 Subject: Added usb_string function to a namespace with reference to WARNING: Duplicate C declaration, also defined at driver-api/usb/gadget:804 There is a function usb_string in the file message.c, there is also a struct usb_string in the kernel api headers. The docs is unable to index the function as the index is occupied by struct This fix adds messgae.c to the usb_core namespace (in docs) hence providing usb_sting a unique index usb_core.usb_string() Signed-off-by: Kevin Paul Reddy Janagari Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20250405165116.147958-1-kevinpaul468@gmail.com --- Documentation/driver-api/usb/usb.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/driver-api') diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst index 89f9c37bb979..976fb4221062 100644 --- a/Documentation/driver-api/usb/usb.rst +++ b/Documentation/driver-api/usb/usb.rst @@ -161,6 +161,7 @@ rely on 64bit DMA to eliminate another kind of bounce buffer. .. kernel-doc:: drivers/usb/core/urb.c :export: +.. c:namespace:: usb_core .. kernel-doc:: drivers/usb/core/message.c :export: -- cgit v1.2.3 From fea017a99ba5e28b23f8249c04b2f475e4ed1fb3 Mon Sep 17 00:00:00 2001 From: Kendra Moore Date: Sun, 20 Apr 2025 21:02:05 -0400 Subject: docs: dmaengine: add explanation for DMA_ASYNC_TX capability This patch replaces the TODO for DMA_ASYNC_TX in the DMA engine provider documentation. The flag is automatically set by the DMA framework when a device supports key asynchronous memory-to-memory operations such as memcpy, memset, xor, pq, xor_val, and pq_val. It must not be set by drivers directly. Signed-off-by: Kendra Moore Signed-off-by: Jonathan Corbet Message-ID: <20250421010205.84719-1-kendra.j.moore3443@gmail.com> --- Documentation/driver-api/dmaengine/provider.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'Documentation/driver-api') diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst index 3085f8b460fa..8f0910668ca3 100644 --- a/Documentation/driver-api/dmaengine/provider.rst +++ b/Documentation/driver-api/dmaengine/provider.rst @@ -217,10 +217,12 @@ Currently, the types available are: - DMA_ASYNC_TX - - Must not be set by the device, and will be set by the framework - if needed + - The device supports asynchronous memory-to-memory operations, + including memcpy, memset, xor, pq, xor_val, and pq_val. - - TODO: What is it about? + - This capability is automatically set by the DMA engine + framework and must not be configured manually by device + drivers. - DMA_SLAVE -- cgit v1.2.3 From 1884847909afb5b980c8b48f80a7d2ce0a4061ca Mon Sep 17 00:00:00 2001 From: Randy Dunlap Date: Thu, 8 May 2025 17:55:38 -0700 Subject: Docs: driver-api/basics: add kobject_event interfaces Add the kernel-doc comments from lib/kobject_uevent.c to the "Kernel objects manipulation" section of driver API Basics. Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman Cc: Rafael J. Wysocki Cc: Danilo Krummrich Signed-off-by: Jonathan Corbet Message-ID: <20250509005538.685678-1-rdunlap@infradead.org> --- Documentation/driver-api/basics.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'Documentation/driver-api') diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst index d78b7c328ff7..5e9f7aee71a7 100644 --- a/Documentation/driver-api/basics.rst +++ b/Documentation/driver-api/basics.rst @@ -108,6 +108,9 @@ Kernel objects manipulation .. kernel-doc:: lib/kobject.c :export: +.. kernel-doc:: lib/kobject_uevent.c + :export: + Kernel utility functions ------------------------ -- cgit v1.2.3 From 54538c24eeac901ddefe2238142fabf2839ee1a0 Mon Sep 17 00:00:00 2001 From: Utkarsh Tiwari Date: Mon, 19 May 2025 13:32:47 +0530 Subject: Documentation: NTB: Fix typo Fix 'peace' to 'piece' in the ntb documentation Signed-off-by: Utkarsh Tiwari Signed-off-by: Jonathan Corbet Message-ID: <20250519080248.648971-1-utkarsh02t@gmail.com> --- Documentation/driver-api/ntb.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/driver-api') diff --git a/Documentation/driver-api/ntb.rst b/Documentation/driver-api/ntb.rst index e991d92b8b1d..a49c41383779 100644 --- a/Documentation/driver-api/ntb.rst +++ b/Documentation/driver-api/ntb.rst @@ -35,7 +35,7 @@ anyone who has written a pci driver. NTB Typical client driver implementation ---------------------------------------- -Primary purpose of NTB is to share some peace of memory between at least two +Primary purpose of NTB is to share some piece of memory between at least two systems. So the NTB device features like Scratchpad/Message registers are mainly used to perform the proper memory window initialization. Typically there are two types of memory window interfaces supported by the NTB API: -- cgit v1.2.3