From nobody Wed Oct 8 22:33:19 2025 Received: from mail-wm1-f43.google.com (mail-wm1-f43.google.com [209.85.128.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 316462C374E for ; Tue, 24 Jun 2025 13:39:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.43 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1750772377; cv=none; b=UDauTECByhISqZXeHoKbgR342xsN+I5lSX93zdHFK8uzhlTvjgmRGGhslv3yiipEQfWSxO4dRwuDdgYq9Pc2fV9aBDYjIoS+aMpoOToUdO9Uzx8KGBdyHp8I0Jvq/JOOSpDX2TjtCfnw6xXgpQDFxpAERQ7gjxHKFNs3kHLyaM8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1750772377; c=relaxed/simple; bh=VXYHGpM05rGE//h/apw7eqoewOcMeRXmxyRdC/GTHL0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Jxrk4+vl1OQiN18vuKB4NGMH9f3hdMmJHRHIB24UehGZ+fkd4w9GEghYgmK4czezvabjhL41oEgZInXW6CkY/079/ooUcQgosSJXzah6IMkYX+uQZKO06OAvRCS5ZXVCrjjs4eukjsQIeGigZUs2PaBxGgRo2aQBuYYDzQRhiiM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=suse.com; spf=pass smtp.mailfrom=suse.com; dkim=pass (2048-bit key) header.d=suse.com header.i=@suse.com header.b=XS8120qE; arc=none smtp.client-ip=209.85.128.43 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=suse.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=suse.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=suse.com header.i=@suse.com header.b="XS8120qE" Received: by mail-wm1-f43.google.com with SMTP id 5b1f17b1804b1-4535fc0485dso6948075e9.0 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=vger.kernel.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=XS8120qE/rfT4p73GPsmp98ILIOvAvl7fs27jSl/BWMt+3E/RflmdI/eP2+TihBq+e GGPnwTZmlpYs3HQsXp0UkXLzCQpg/kx0p7U0HUaMhyUly8xDTXiVgBTl/HFey1Up5QCD eTpx71aBFZP44DeZC+WiQAnvbtbNyczm1uvZfn/wbFkJlNhrpnS+RXxvtuZddohCum6g UdyukphSlzCH4IOUxk4/SN+Hs7bUV5+AsTt9o+7i/mU+AtHjEjBktZkP6E437hUUP6yy SpiCLdCVnKZnfMn8M/T0Kt9XYwZtUdoQTfZQ5F7OvC6ZWwqYX+wDOahw+bd7+vcSRPpC Hkuw== 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=sx+862FCJFXy+TuRgWaIc+jiJCgocR/ECKEyQ3QnbyfMs3RzCOUVYDRFvUIj9cRi7g DiesrnUTH0f+YA5KWnWaCSlQlL70k7k3KkgDOduEdf0jDHOzS6ag9/tJx4rVrku2xxhg SA5eq8Y6GxESbc7aTqrMbtIJpdapd8wAMTPdoHUVwvrSD+4FGfE0yGFti00oByy39LiP J2cjz8osjYMOuo0yfP4abxwROaRU/f9AxkFZ5ShUjGHCyWEzFSQLxPTxda64AyCokgZS jqU/5EQ/n/XGY+nDhJbJE3Per57Ugqe4kyHr4IPwrXy6l/vCkA/O8LR0SmbnaJGj1YCl sQPQ== X-Forwarded-Encrypted: i=1; AJvYcCXr07xxd6TrkWBQdQ8HrH/TYRi4JThIYGNzx2bITo6waQGww8ERIvIFfVixYxTdh4SPv1iUk48UAZgVuTY=@vger.kernel.org X-Gm-Message-State: AOJu0YzZs4FPSo2eHI7RG34+y0G6VogHWJi7c8fOo0PnbXmhsurpeltU TkDdT/qu5zixpk93ki66dcuWCstt22x47RF7li8/rw2V6+ZEHPlOmZNbOLd5tISqgX4= X-Gm-Gg: ASbGncvbNNFFd7EGVE8stErf6EFeGBkiXL3v8XE82P40yRlsW0k2OgX0fYm+tH1gGPN N1xgaT8JV7yC03Ymv3IQdp4MOwnBTseLe/mlS9Za8gIe1x9ClFZ8VRrh+FTuwVNfKxJDaljNqdv ivESFmPeus8z/cEZHuy+4f7rJbz33xDtWhbz6knozS9/eIxlPl53N9uiz7QVyihxvG/E1NbokWu QuqxK8PGWkVC7kpa+B/O61JN7GLEDgT6R+twpPXnyXDVBXn89DV1BC86BkDBlmNiEu9JTJxnQeQ qntptixrgjwNYuILwR2Xj8MwwRNxkFZi+A52yaQKL1vAgpdK08g+SkWX7SrngQ2nJvFlz8rzyOI SdYfgWPoPIebP/DRaqotVnSGw/HVN/yXk3sh7jm14hvK3y1KWAqn/ 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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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: =20 +.. kernel-doc:: include/linux/dmapool.h + More Memory Management Functions =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D =20 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 cha= r *name, NUMA_NO_NODE); } =20 +/** + * 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) { --=20 2.49.0