From nobody Wed Dec 17 10:17:47 2025 Received: from mail-pl1-f175.google.com (mail-pl1-f175.google.com [209.85.214.175]) (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 1C63326289; Fri, 28 Mar 2025 11:47:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743162437; cv=none; b=WAzXxFO/3T+UTn35nugh9ibdzg1rMlS1A2CbaHJ61k+rWMZEDTPQygdTKg3HRLe0bwCxfsvK62NDNt2bicHW0OSkANyYhCdW/N8SPisNFhzP3cyL7eVU+vpdWNveTKwW/p23t3BD3SnST1NNHDdr0G0ZqXeOXgN4bPRocp9/vFY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743162437; c=relaxed/simple; bh=fSDDLJIg1AIFezqeviZx0z10om+VyB30CEwom2stASw=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=ri9CZGvcxuYx2V91X8Lq7iW3dfkRfuvzngryncC9ZG7t9LjqS0slLxrisDzXdJGUF5EqGoIlyG19oecHyHHP89GTdy/n188jU/3DzNrMrGS00iJFGW6k4TYejt1eynnpKisYl+0IAzPLaehHDFYH+IMjW6oim+t/jIyPuuGSa00= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=XzilTukn; arc=none smtp.client-ip=209.85.214.175 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="XzilTukn" Received: by mail-pl1-f175.google.com with SMTP id d9443c01a7336-227cf12df27so30936005ad.0; Fri, 28 Mar 2025 04:47:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1743162434; x=1743767234; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=Hc/xauRBy7/DMinG+JVri98lUK7sMGQwLWf3P4KYn9g=; b=XzilTukn7q68jnXs2aU9aa+3hKXBh2mYTK2BrwJXTaIZ4aCf7ZRr8lqP8y0vaDuC2M jXUxZ9LxDljJtijqP2LDqoVaEOU37h2GyVNyQ4NA7m+L8fwefPDugEJKUMZsqQ1UsFtI a/42flYwH9n5fzvC92DZ7Vt6GwjNY4PUMMuO91apq37bMhuxrPw4MXu55SfCyALArMe8 nrEHNPtWjPM58VGJVkjoqa8p2bCfMtY+Yzwc1IZQUgqBiiRolm6pVd0gcEwMp91WYvp8 q5mtT/xPty6Uxg21JCj3DnIM21qFYit6/X0CfSqG907Flo3xCiIg3G/LBpKpLAHWwoGX ej/g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1743162434; x=1743767234; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=Hc/xauRBy7/DMinG+JVri98lUK7sMGQwLWf3P4KYn9g=; b=fKOUoCnZJ0a9ZeAjwCzoIq25Pvy4z61LOfv4098hGkPcxPGFfmTuOoZpHm3rP9xNtz EShKCdNE/hx7AqBsDJzGBsKdse8Lt0Ae75ZOOlfA+x0Rn/XG0ZGcw14D3OKmMbFYeDG9 7ZPDsMILt8/0JQCObwqhPpWDYFGSnjTPo9zHpLiGx2fULOcId/ejDF7prDeHzc7JjGEE B8B/beJ3ZvVOCsrNTyEqQMSvEsfCsST1V+s6OKk7fKEerzBEZvdVr3k9vXpXOTWgvYIZ s9lc1MoNoIHY47uSlQArrgGcBd57CtdP/si74K1/ArNZCiYUHEIfDduciOTyWWWtIXWZ ynFA== X-Forwarded-Encrypted: i=1; AJvYcCWsJVZoDCvrqDJfjMwCTNPEyO3nG0JccVKsiwG6zJwhqahwcXFFCJc9752rB+f3aGXUmTpUurJ/yJQ=@vger.kernel.org X-Gm-Message-State: AOJu0YwnHfQMsRtBGdonD9cOk/15HwS9y9CXRMz+bayiqe61JxUsMtWw xbKWTSEazWCLSDWvW1hkEy2sbSqX5+pVt8jrLVbsrMh/dOcPANuc X-Gm-Gg: ASbGncuh04aBWDX9nPpH5Dw10by5k4wNH8jyjkEzxN6KUVb5PB4tOnKfch1HH76P2qq DOq64A5lXZyJLH2xraita7txm7um4SEdJ2jQfnZsXXDSPmoI+L+VFB+czaq6+MIACunJ2YF9LiI GFtPw0V53acdsGxZx2yO3HS8+X1iFXPgDlWwvE6EwaWLNxtpWcCGBRmY200UoaqlByUnIlQF4wv 9gVh6wVCBu5QQ1sglyGeokNJlIY7FYSg+6BKvta30bHgmHisBRMU4xiFeT7GQthNjtyelS0IHb8 wErCBc26NZxXhj7V2g2mDFmDLKGyNvVKH127KD3OsFcG X-Google-Smtp-Source: AGHT+IGL+2VkvZUTLK5bh/+zKUx91iBAgtBVleFDA2Cq1ZEhcmX1cqdZcGj78v2l4OVP0YvtefEQjg== X-Received: by 2002:a17:902:f68f:b0:224:3610:bef4 with SMTP id d9443c01a7336-22921d5fe82mr37434305ad.25.1743162434071; Fri, 28 Mar 2025 04:47:14 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-73971091ce4sm1548199b3a.132.2025.03.28.04.47.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Mar 2025 04:47:13 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 0409C420A74C; Fri, 28 Mar 2025 18:47:09 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux IOMMU Cc: Jason Gunthorpe , Kevin Tian , Nicolin Chen , Lu Baolu , Bagas Sanjaya , Stephen Rothwell Subject: [PATCH] iommufd: Fix iommu_vevent_header tables markup Date: Fri, 28 Mar 2025 18:46:54 +0700 Message-ID: <20250328114654.55840-1-bagasdotme@gmail.com> X-Mailer: git-send-email 2.49.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=4215; i=bagasdotme@gmail.com; h=from:subject; bh=fSDDLJIg1AIFezqeviZx0z10om+VyB30CEwom2stASw=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDOnPuvfMqq4J+PvAebYEx5WAXL26NXcVNoidV9F3auqz6 Hm/t/pNRykLgxgXg6yYIsukRL6m07uMRC60r3WEmcPKBDKEgYtTACaysJfhn9mW60I9qx4tEbi1 Q1Kg8WKS4MyQN2+Ouf+73JabIWrJ7MTwh/PvpC0zNA/denZUgLmW766oQoGwyHujKcULUw6kxH7 L5wUA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Stephen Rothwell reports htmldocs warnings on iommu_vevent_header tables: Documentation/userspace-api/iommufd:323: ./include/uapi/linux/iommufd.h:104= 8: CRITICAL: Unexpected section title or transition. Reported-by: Stephen Rothwell ------------------------------------------------------------------------- [= docutils] WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-versi= on 8.1.3 ./include/uapi/linux/iommufd.h' processing failed with: Documentat= ion/userspace-api/iommufd:323: ./include/uapi/linux/iommufd.h:1048: (SEVERE= /4) Unexpected section title or transition. ------------------------------------------------------------------------- These are because Sphinx confuses the tables for section headings. Fix the table markup to squash away above warnings. Fixes: e36ba5ab808e ("iommufd: Add IOMMUFD_OBJ_VEVENTQ and IOMMUFD_CMD_VEVE= NTQ_ALLOC") Reported-by: Stephen Rothwell Closes: https://lore.kernel.org/linux-next/20250318213359.5dc56fd1@canb.auu= g.org.au/ Signed-off-by: Bagas Sanjaya --- include/uapi/linux/iommufd.h | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/include/uapi/linux/iommufd.h b/include/uapi/linux/iommufd.h index 81c31a36e14a97..fa479700918409 100644 --- a/include/uapi/linux/iommufd.h +++ b/include/uapi/linux/iommufd.h @@ -1045,21 +1045,26 @@ enum iommu_veventq_flag { * [0, INT_MAX] where the following index of INT_MAX is 0 * * Each iommufd_vevent_header reports a sequence index of the following vE= VENT: - * ----------------------------------------------------------------------= --- + * + * +----------------------+-------+----------------------+-------+---+----= ---+ * | header0 {sequence=3D0} | data0 | header1 {sequence=3D1} | data1 |...|= dataN | - * ----------------------------------------------------------------------= --- + * +----------------------+-------+----------------------+-------+---+----= ---+ + * * And this sequence index is expected to be monotonic to the sequence ind= ex of * the previous vEVENT. If two adjacent sequence indexes has a delta large= r than * 1, it means that delta - 1 number of vEVENTs has lost, e.g. two lost vE= VENTs: - * ----------------------------------------------------------------------= --- + * + * +-----+----------------------+-------+----------------------+-------+--= ---+ * | ... | header3 {sequence=3D3} | data3 | header6 {sequence=3D6} | data6= | ... | - * ----------------------------------------------------------------------= --- + * +-----+----------------------+-------+----------------------+-------+--= ---+ + * * If a vEVENT lost at the tail of the vEVENTQ and there is no following v= EVENT * providing the next sequence index, an IOMMU_VEVENTQ_FLAG_LOST_EVENTS he= ader * would be added to the tail, and no data would follow this header: - * ----------------------------------------------------------------------= ----- + * + * +--+----------------------+-------+------------------------------------= -----+ * |..| header3 {sequence=3D3} | data3 | header4 {flags=3DLOST_EVENTS, seq= uence=3D4} | - * ----------------------------------------------------------------------= ----- + * +--+----------------------+-------+------------------------------------= -----+ */ struct iommufd_vevent_header { __u32 flags; @@ -1117,9 +1122,11 @@ struct iommu_vevent_arm_smmuv3 { * * Each vEVENT in a vEVENTQ encloses a struct iommufd_vevent_header follow= ed by * a type-specific data structure, in a normal case: - * ------------------------------------------------------------- - * || header0 | data0 | header1 | data1 | ... | headerN | dataN || - * ------------------------------------------------------------- + * + * +-+---------+-------+---------+-------+-----+---------+-------+-+ + * | | header0 | data0 | header1 | data1 | ... | headerN | dataN | | + * +-+---------+-------+---------+-------+-----+---------+-------+-+ + * * unless a tailing IOMMU_VEVENTQ_FLAG_LOST_EVENTS header is logged (refer= to * struct iommufd_vevent_header). */ base-commit: 899ddafec3b4adeb324ebda146914980137c1553 --=20 An old man doll... just what I always wanted! - Clara