From patchwork Wed May 21 22:37:40 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pierrick Bouvier X-Patchwork-Id: 891566 Delivered-To: patch@linaro.org Received: by 2002:adf:e88a:0:b0:3a3:61c9:c5d4 with SMTP id d10csp2355943wrm; Wed, 21 May 2025 15:39:51 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCXqwvSXWHrspbdihE8c1QnBYgSFzfEvxMASUK+jg47QSpDSKp1OJf9S1lNt+NQ++X69vcHA+w==@linaro.org X-Google-Smtp-Source: AGHT+IE5wuCV8tlxbQGfg6iXzjeN9ykY8WeQXe/6gp5z48MQKzKsM0Cy2JyLjsxFjC8tDHPI3V+X X-Received: by 2002:a05:620a:9520:b0:7ce:bda1:b7b1 with SMTP id af79cd13be357-7cebda1b7d0mr1746609685a.4.1747867190772; Wed, 21 May 2025 15:39:50 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1747867190; cv=none; d=google.com; s=arc-20240605; b=kjzyordA3JLlTvr9fc7+lIP75Uyu2E1P3fvOLglpRwNPRaO+vqVOYymMrfPI58cMn7 MPHfZiqbVSWjxYkyHoUUOdHrbFgEpwWNYOKZDvruJA1M5yzblhv54nogmLrHCWdDJxL5 mnUBxV2JTDq5YN+qkNRTR2vYSfbDGf7KhzqA86aQV91w2U6FAyNdXM8sja4dKzqb2GAS 1wXwbqUatFCICpp7OmkhPJZ6u+m6tpbH4dLDzhmnl98MN0F+7BEkxK3pW35PZbbw2Zq8 CthCj8/ww/vvgRjS2vmTOhHfL8dKt3+idtdY3ayPmW45fXCjpou61FtfzhdWIm4NwnLX u3pA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=2aCXupjQf+KpZBVxWkFiZBckC01w8HvIqJ4QFv6HBfc=; fh=LhSqqQWZO3+G6N3MwmuBki2bwvRqsTDzvJqbgdDCcqY=; b=VXwkBleBjHv2jRE71J5DnqoSWA0UdktVUZeiWnD/eCgnnETJl0KSZWn3mckJnjhp4l hvcgKYY46x5zJKRqTfpJ24BehXhE4T7jUIN1Su259rZdgtOlc9VhyLHXEIbT5tz0TW26 9qsY8lHPBZ/MprwP9TEAmgqjZG/GwIyY3n+9bPkce6/kGBR1ZufKrXxqcKjGfW/IIBLE 2cLhnkWE39Ix9ZEAEmFf2xo/fArl6OhABDPbPZey+xB83KTXpnz+O2FG5epRymwUWIIU ADgUHg0CIIrquVDsfJBcGGj0kQN2a82kHHzETpstev0EPxwKDbO2OM1gU9fZArXvxBVV ThHg==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Okwq030Z; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=neutral header.i=@linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id af79cd13be357-7cd467cf6f0si1401560985a.25.2025.05.21.15.39.50 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 21 May 2025 15:39:50 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Okwq030Z; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=neutral header.i=@linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uHs4f-0006DG-0E; Wed, 21 May 2025 18:38:09 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uHs4a-0006BM-12 for qemu-devel@nongnu.org; Wed, 21 May 2025 18:38:04 -0400 Received: from mail-pl1-x635.google.com ([2607:f8b0:4864:20::635]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1uHs4Y-0005bp-1t for qemu-devel@nongnu.org; Wed, 21 May 2025 18:38:03 -0400 Received: by mail-pl1-x635.google.com with SMTP id d9443c01a7336-231e98e46c0so46383575ad.3 for ; Wed, 21 May 2025 15:37:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1747867078; x=1748471878; darn=nongnu.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=2aCXupjQf+KpZBVxWkFiZBckC01w8HvIqJ4QFv6HBfc=; b=Okwq030Z6AGdtvUPTkYwW9HB/jrhEheqT5jvqp+acl+PaqYCkhwwd2zjVNMeTvKkQl oeU8cjpQ5voUahFFCZCyt/ZrJ2Gn7ho1nK4Z0uk4xoqlXzTDZwJZXaIWHAsXXU2aYC8g QC7Z0YwPvKgLzjQ7xrQESH9A3FhHW4TsolRsTlw6FmhPDsQVZFgOH1biOCw8bKddGCdN ilUX1yB6mmBoSCSZCLFTSIvuu4EzDj2T6CePJdK9aXz/BfGUc996DhMgbkBog/AzDmMB xRX0qjeggaVd5q0NMV64j+3wzh2DnWSYbu9k2avp/Pu90f9sMxEk6OQHdPt1EGzoyfwU 3QMQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1747867078; x=1748471878; 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=2aCXupjQf+KpZBVxWkFiZBckC01w8HvIqJ4QFv6HBfc=; b=ilIICcb/hJrsPX+nmY+XDiiWzJUmL3BNzDAhNEY3tgGR7lAesMxYnCbZapu47Q3xIN Fk6jLmCCLpi9Ruq/bMREmaVGxVUCsNQhbeXHAX9zdh4SJ2E0B2dXHT0iUlgj3os/LoTQ IP0ckK7qIiDIRNkLo+ecJIofF7KDRyjHxx6C9P4i5stqEHbUn4IPNxOWlxhuipD6eZLB mI0VAM8ICqHFJkHv9bplg3yJgXmS4Ap1MiyemcAVq4EFhQgcN5r67i4ddaFFLyJwdGQA dW/Cjl6gtVSbzANluhYDZtFinJqXyvnryEMTdffqlTe+uDIvox8Oec4oma0vZUuUY3gI SUeA== X-Gm-Message-State: AOJu0Yz+UqZg0t1ElBMLhPRaNQntdxLrBBgNupDcxLGiFO0gwVC8lS+F glySAUIc3GSoLdValYoyroK2dChc2TneAjYqPdygEpvV9KlDcG6NR1eD9AMudBqWjn0AVy0+dsP YokFH X-Gm-Gg: ASbGncudEaO+yb41iL3rs5RPkbxdoqUHcvln/ClFnLVQS3pcSsVKhK+zk58rhaU2EEo +stu8IZdWU4EERBVMqiTmRNKiOVZXeoFgm+8voPW8Da9Mpa0US7sRdp+5shEyfchoj4PZ1dm44P SlOrFvK6ADmIU3LMnVRzyi0Aghwcm+d3//tkaIlcbz/sS6+CCIRGjNVd+R5cYr1nWWkCmpABCms qp0Rnh711U18jYsovTI4GD1W50c/u2MpKbYAhUpEx56uTMU3V1Mji2weFKruVbkwidr8u00YKFd E8Ho3mDtogCh6QlqdVS0rrrV/BxPQ+XX/cMU+IMJo4Wll66Lyfk= X-Received: by 2002:a17:903:324c:b0:231:e331:b7c9 with SMTP id d9443c01a7336-231e331bc2emr275792475ad.10.1747867077894; Wed, 21 May 2025 15:37:57 -0700 (PDT) Received: from pc.. ([38.41.223.211]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-231d4e97dcesm97711105ad.121.2025.05.21.15.37.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 21 May 2025 15:37:57 -0700 (PDT) From: Pierrick Bouvier To: qemu-devel@nongnu.org Cc: pierrick.bouvier@linaro.org, pbonzini@redhat.com, peter.maydell@linaro.org, armbru@redhat.com, michael.roth@amd.com, philmd@linaro.org, richard.henderson@linaro.org, berrange@redhat.com, thuth@redhat.com Subject: [PATCH v3 14/14] qapi/misc-i386: move errors to their own documentation section Date: Wed, 21 May 2025 15:37:40 -0700 Message-ID: <20250521223740.249720-15-pierrick.bouvier@linaro.org> X-Mailer: git-send-email 2.47.2 In-Reply-To: <20250521223740.249720-1-pierrick.bouvier@linaro.org> References: <20250521223740.249720-1-pierrick.bouvier@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::635; envelope-from=pierrick.bouvier@linaro.org; helo=mail-pl1-x635.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org Signed-off-by: Pierrick Bouvier --- qapi/misc-i386.json | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json index 6f79817e382..796eaa5f406 100644 --- a/qapi/misc-i386.json +++ b/qapi/misc-i386.json @@ -166,12 +166,13 @@ # measurement for SEV-SNP guests is only available within # the guest. # -# This will return an error if the launch measurement is -# unavailable, either due to an invalid guest configuration -# or if the guest has not reached the required SEV state. -# # Returns: The @SevLaunchMeasureInfo for the guest # +# Errors: +# - If the launch measurement is unavailable, either due to an +# invalid guest configuration or if the guest has not reached +# the required SEV state, GenericError +# # Since: 2.12 # # .. qmp-example:: @@ -210,12 +211,15 @@ ## # @query-sev-capabilities: # -# This command is used to get the SEV capabilities, and is only -# supported on AMD X86 platforms with KVM enabled. If SEV is not -# available on the platform an error will be returned. +# Get SEV capabilities. +# +# This is only supported on AMD X86 platforms with KVM enabled. # # Returns: SevCapability objects. # +# Errors: +# - If # SEV is not available on the platform, GenericError +# # Since: 2.12 # # .. qmp-example:: @@ -234,11 +238,7 @@ # # This is only valid on x86 machines configured with KVM and the # 'sev-guest' confidential virtualization object. SEV-SNP guests -# do not support launch secret injection -# -# This will return an error if launch secret injection is not possible, -# either due to an invalid guest configuration, or if the guest has not -# reached the required SEV state. +# do not support launch secret injection. # # @packet-header: the launch secret packet header encoded in base64 # @@ -246,6 +246,11 @@ # # @gpa: the guest physical address where secret will be injected. # +# Errors: +# - If launch secret injection is not possible, either due to +# an invalid guest configuration, or if the guest has not +# reached the required SEV state, GenericError +# # Since: 6.0 ## { 'command': 'sev-inject-launch-secret', @@ -273,15 +278,17 @@ # 'sev-guest' confidential virtualization object. The attestation # report for SEV-SNP guests is only available within the guest. # -# This will return an error if the attestation report is -# unavailable, either due to an invalid guest configuration -# or if the guest has not reached the required SEV state. -# # @mnonce: a random 16 bytes value encoded in base64 (it will be # included in report) # # Returns: SevAttestationReport objects. # +# Errors: +# - This will return an error if the attestation report is +# unavailable, either due to an invalid guest configuration +# or if the guest has not reached the required SEV state, +# GenericError +# # Since: 6.1 # # .. qmp-example::