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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 30572C77B7C for ; Tue, 24 Jun 2025 13:39:45 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8CD438D000A; Tue, 24 Jun 2025 09:39:37 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 855B78D0001; Tue, 24 Jun 2025 09:39:37 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6CF258D000A; Tue, 24 Jun 2025 09:39:37 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 5362F8D0001 for ; Tue, 24 Jun 2025 09:39:37 -0400 (EDT) Received: from smtpin29.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id EB2665B9D5 for ; Tue, 24 Jun 2025 13:39:36 +0000 (UTC) X-FDA: 83590401552.29.75B9281 Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) by imf09.hostedemail.com (Postfix) with ESMTP id EB2A5140008 for ; Tue, 24 Jun 2025 13:39:34 +0000 (UTC) Authentication-Results: imf09.hostedemail.com; dkim=pass header.d=suse.com header.s=google header.b=Ft71VRtx; dmarc=pass (policy=quarantine) header.from=suse.com; spf=pass (imf09.hostedemail.com: domain of ptesarik@suse.com designates 209.85.221.41 as permitted sender) smtp.mailfrom=ptesarik@suse.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1750772375; a=rsa-sha256; cv=none; b=xiiU6W9HLg3ePqIYc75K4arZG/BHdKNJbGWcj6S1lriWkWr7vJG/Ae2THtg06WangcaFQs ZXHEfcwhFGmItemAkJL1jzOtyA4hNugemuFFMbSB7cJnCJSGJeyjf+SsnwnqHm4XvtyyOI U1T5VGYbqnKceIityitJ9kh1t01l50s= ARC-Authentication-Results: i=1; imf09.hostedemail.com; dkim=pass header.d=suse.com header.s=google header.b=Ft71VRtx; dmarc=pass (policy=quarantine) header.from=suse.com; spf=pass (imf09.hostedemail.com: domain of ptesarik@suse.com designates 209.85.221.41 as permitted sender) smtp.mailfrom=ptesarik@suse.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1750772375; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=oeJkbEKgM0HHbkRMH9B3w8A15xaUkHynZ4iVjI/7IZk=; b=g9+GNMo9k+TKbzYanXqdf8RAaXFpUswuur8NDoYEiJFPLi+7recbMP8RbFxvyJ72dcwdO+ Nbn+HLeByY6mMDr5U4HBRJUie9Lq+O8glPTFxLCR1PhjdpiuB96pM+e3zX9q9sZTqj/X6j +4c05x8LIxvV/JWqBAkGAHYyOddYKwc= Received: by mail-wr1-f41.google.com with SMTP id ffacd0b85a97d-3a4ebbfb18fso262963f8f.3 for ; Tue, 24 Jun 2025 06:39:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=google; t=1750772373; x=1751377173; darn=kvack.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=oeJkbEKgM0HHbkRMH9B3w8A15xaUkHynZ4iVjI/7IZk=; b=Ft71VRtx4B+hNtP3lTXyxKMzgXVY6nAYGOBhG/Ze3W4ETju8yQGT2ZkStvLJOxBVex pNzQjmZVsIFwAiUJRYdL64zKnI3Z63jbYW2+3VXKgzzmpNtPqd1tCVGE1uYIj/ACHrAp EZnpvc7FHy9IWubp/hx/j06Va/e4eJ9N018wDAoaVbc8E5ClWk3O9NEPU7E9C4kJDXBI ebioS1NHJEUxv23A3NH0jUytZQ9n4VFI0rBHGh9bs2Rr6PTyd5/vcC0jneiV199dyBnB 4SED/xH+x7wU7Qs71TgRKctGMHXKzO5IgXcZ2Zlp1ss3h9D+Wr1p45Jd7zm2/Krij3/X geiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1750772373; x=1751377173; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=oeJkbEKgM0HHbkRMH9B3w8A15xaUkHynZ4iVjI/7IZk=; b=Y4a86czePNtjzYf+aVAhqP3roew25j+2rvUEEgb6MQSkTb31MCM+oNYktAwoRzgcjI 7afKZlTZd9kf68Uh22MynPjIYpGYgJgK+bRBXEFaTFyW6ibnbau6VO8elVvCDcqbpCss Ma86/l2W3lAiNBCxi5sEAiGmrKO1fPPISZjow8KkQYCHuUi27TfVmWmwS1jcxjQvgRjx MsLXQy0uBYJc73aFeKlurtGwvVSZLOBdyQ62B5jWP3Rpni2ZbapshIVORc9G6G14RcvM dN44iB8sLroFARVkroo1j07Yy1bFaEb0vHpCSEyUJnuv1HK/T91sWgncirZIinuUyGbZ 92jA== X-Forwarded-Encrypted: i=1; AJvYcCUKwyBy8C7gwc3aJ53bukf55bBAPijduBVLdDe12Q541Dckg9OoKK0dz8JQbypPbBASVwID/21weg==@kvack.org X-Gm-Message-State: AOJu0YxrCY9uSXNCTleXovyQ/Ams5CasWnzfdLDOzjUJHw9fpyPg+E+I 47o0Ns0qfKIkMzruo46xZ9xh9awG3o0J+CsqaQ9oSqb97ubXoPjRaK211YE17YWwcAw= X-Gm-Gg: ASbGnctWXdgUNfVwGte/aXOau0QHjrWv/t41qPnLYDL6TqHPRVMmF60k80t/ZTf10ky g4nV9MILLd0BVtCoYPl2VyVRXXDbIH7ts81CejTf+yLR8l0DUMacDa68FbmBKRHjVnupKLxzatx zxjGSbeLBcSUccITcdhpXaN7unI1/v9jtJZjzPgCRM+uaNOVFSFsanfpL3mq/PwS1piAAiO0Mvx NV+mxJlOFut+KyOFA94NknF90xmwm07waNbwlD3MwBplum8P6V9QZ9Iwb3g4+e88KYbMbE6OCk+ HtDcfy7w5QoC8Jd+Ys0hHxnVvi2qIXdBYjVRam2mkoKQ3Wytw4PPKfYwYru1vtTLo0rCvG8RFC1 YRC9ONmOdseD/g/iM6bXSVX99uju2E6HH/ZC0dymLzXKtgo+iXye1 X-Google-Smtp-Source: AGHT+IGHQNhqIB3JgmwwepWbvWA2111RF5PUV4yxQGXON8tqDIklGy8e/Cjdf3HtwXlEs0xEqbFKrw== X-Received: by 2002:a05:6000:430e:b0:3a6:d403:6429 with SMTP id ffacd0b85a97d-3a6d4036867mr5219824f8f.4.1750772373456; Tue, 24 Jun 2025 06:39:33 -0700 (PDT) Received: from localhost (dynamic-2a00-1028-83b8-1e7a-3010-3bd6-8521-caf1.ipv6.o2.cz. [2a00:1028:83b8:1e7a:3010:3bd6:8521:caf1]) by smtp.gmail.com with UTF8SMTPSA id 5b1f17b1804b1-453646d1391sm143209275e9.9.2025.06.24.06.39.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 24 Jun 2025 06:39:32 -0700 (PDT) From: Petr Tesarik To: Jonathan Corbet , Morton Cc: Marek Szyprowski , Leon Romanovsky , Keith Busch , Caleb Sander Mateos , Sagi Grimberg , Jens Axboe , John Garry , linux-doc@vger.kernel.org (open list:DOCUMENTATION), linux-kernel@vger.kernel.org (open list), linux-mm@kvack.org (open list:MEMORY MANAGEMENT), Petr Tesarik Subject: [PATCH 4/8] docs: dma-api: add a kernel-doc comment for dma_pool_zalloc() Date: Tue, 24 Jun 2025 15:39:19 +0200 Message-ID: <20250624133923.1140421-5-ptesarik@suse.com> X-Mailer: git-send-email 2.49.0 In-Reply-To: <20250624133923.1140421-1-ptesarik@suse.com> References: <20250624133923.1140421-1-ptesarik@suse.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Rspamd-Server: rspam08 X-Rspamd-Queue-Id: EB2A5140008 X-Stat-Signature: togk1duitdh65ib49x5rwunhpcho8t9b X-Rspam-User: X-HE-Tag: 1750772374-761171 X-HE-Meta: U2FsdGVkX197dATcAAf0lEo+yrXn3i1zzbqEtg492WaV7JHRmhL1LE24seQdtrJeKmgicDlu6PX294jYIZIantZzqkK0X2x8Wn3c8BGMcD3pCJir8+qYEK3kll46Y6ho07SfDDhxeUFSPErj3Kj4tiyWSBUZAJfx0dGKzCK0WP21LMoLUvawcOfu9zGBwarH6EVhXAJT9NMxEeedL7+h7Hf6v54Lf6CnaO7YrxU7YqbnKQuLj02UBF9cHwh8TXtDzkOsLqBG0JBCSNmsDK77+A6E0T3ox0OropSTiGO3OArHaDcFARun8fccICB0wNYDSbn2H0esTU6VqQgN5JrNAiCsxfCoW3rKKvu74Om62lmSTnmswX8gun42dlHn9QFJB3VP87NuOh75dx5QdXi1cNizk7sX0AshDFTkEmAvqawr+lfAAetyBiGFXsWIs8/oi+Eq8wM1Li2/i7Iy/PC3O7h7xZ/OpoHZfYOXTkqBk1lEQXjboFs0dnjuWZbtSFO43TatEHW0vRv5z9TVIt/UWZMPDxD2IrXvWex++dWWMsyUjg7X0yURTyw/Sla+Ur9cDmcP974vrGie7dhnf1UNBMmPtvJzqo0yjslqfEvspuwqp+xVs1cMXY9nSZW6wO7n5d/WDfDtmiPkf57Wu7LTHhNTz0JA3qfu5Xo5oKrkj3WMWkXBuZvl6tHCSZQXn2VZe+9SGAwOIi/wKMXWmNjC9/xEa9rigqQ10Ra48sauMJ46mPGxszKXDTJg+6QKT2amxfbskKJbf/UylKrAn7NnLqv/h3MAAuvpnJX5sASLVHpKLjYalqU8N0aLtmY1ingUkUWc8F6XgzvhiV1WlIJ4+rDf7D5l/OjrTmiwUXqo6F5hmt15jiiv0ofey4zSlFlao5sNPMcAPeasDgccNrd3lgTWXNgSn3R6VabVAQN2FPIwI2qsTJevitPcRqE0GlUf7th6ZrMoJx26KQ4aaix s2HvjSWx C5+h4U2UTesYJkFv75MtC0N5AnqE3zUbVWfCmOZ5ItJQdo003oQIgkf6kPzo7cW1KjQryEy7ukkORalXVaFUc89g9niDikn5uJ4vv6/8vaPQb5XiP6F6rnuQd4MPYQvF1A8ACU5tZt69lAv1CUCS1XNZig25zRfOH3uU7NMKkt2PJDsQr3JDY1LsK6pw+pWJe39s4OF5bTCqLoRF5gu7R/FKcR/ClR6hiTy0iQIqxZFsIlxfaQoiCgeWP9nzjeTjoPtFcbtKbsOOUCdBFAwMBJM4pnpXwxwKYwt3VnutEkyXpXlxXzFu+JDr+dzkpOtz23X0lGD4l2xHWKudgMJxlDER8L267z/illikR8LjmN0T9JTE= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Document the dma_pool_zalloc() wrapper. Signed-off-by: Petr Tesarik --- Documentation/core-api/mm-api.rst | 2 ++ include/linux/dmapool.h | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst index af8151db88b2..a61766328ac0 100644 --- a/Documentation/core-api/mm-api.rst +++ b/Documentation/core-api/mm-api.rst @@ -97,6 +97,8 @@ DMA pools .. kernel-doc:: mm/dmapool.c :export: +.. kernel-doc:: include/linux/dmapool.h + More Memory Management Functions ================================ diff --git a/include/linux/dmapool.h b/include/linux/dmapool.h index 06c4de602b2f..c0c7717d3ae7 100644 --- a/include/linux/dmapool.h +++ b/include/linux/dmapool.h @@ -60,6 +60,14 @@ static inline struct dma_pool *dma_pool_create(const char *name, NUMA_NO_NODE); } +/** + * dma_pool_zalloc - Get a zero-initialized block of DMA coherent memory. + * @pool: dma pool that will produce the block + * @mem_flags: GFP_* bitmask + * @handle: pointer to dma address of block + * + * Same as @dma_pool_alloc, but the returned memory is zeroed. + */ static inline void *dma_pool_zalloc(struct dma_pool *pool, gfp_t mem_flags, dma_addr_t *handle) { -- 2.49.0