From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id AF6A7CCA48B for ; Fri, 22 Jul 2022 08:50:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235012AbiGVIud (ORCPT ); Fri, 22 Jul 2022 04:50:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48854 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234554AbiGVIub (ORCPT ); Fri, 22 Jul 2022 04:50:31 -0400 Received: from mail-pj1-x1031.google.com (mail-pj1-x1031.google.com [IPv6:2607:f8b0:4864:20::1031]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A6C4927CCF; Fri, 22 Jul 2022 01:50:30 -0700 (PDT) Received: by mail-pj1-x1031.google.com with SMTP id t2-20020a17090a4e4200b001f21572f3a4so3659631pjl.0; Fri, 22 Jul 2022 01:50:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=XGvxZvhnTAZBI+rA5TQMHLllkhlUn2KKMKKwFEJoTrQ=; b=jmxWGNPrWZotRVEC446wT5rD74ZsGChwiZJLDeQcbQMpgAfjCjqDcEKhf0E4L9rmUL eRQM9QL5om8cfKJnR8u+5T3zVqEgDBjybCw9BpnxKPPMgzsWnEdOeK8/uQxiXl4zQmpt B76qQHf47ukLTQfQzN8guLuc7Tfoy6GWYRvouvq5f6Yen9Tbr+7ki7Es7w4TFj+scs4G WjKaAxIT3sRvipY2U9/Yne+Zi9m96xmqsNPvxIRghhxqGxaAghH3kFp3Sxz+HgXJtZUO dR0/YcKs9ToFzF3LKXdDELoKrn63fzPY8wzKVddc1bcYC3N2uQ+4IkHEZL8E/nqymexS 24+A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=XGvxZvhnTAZBI+rA5TQMHLllkhlUn2KKMKKwFEJoTrQ=; b=tgnFJlBFurXCvujJIL1XAHKXkIzmsFKsq85KH9XsbVm/wlkjwh3lirxU0FImY4WZtK 4IG2Lht9uq3B7+ig5ZkQ3LBGFOXXTqRXcISfa8BVU1KQdoa06UtRDHC9nhGiZGeczDTf 3P7sWZUkn2S4vS648DZ7yep9vYijtaIKogtf424E7RNrRWTwzW0kHcwSNr2cXK6f4HMz iYcRYuOJ8nzAqwPzqmCpUwmXkh/6D+FPB/kxdBsnngyhtUccIgVBVwPdrrqCJ85CqC3N d6mSXjgqyPqvlZ0HcldqG6zMTF80uFR7sr/+JpWeaRGJZi/Dw5IJyBVCiLHbpBjQ6mxq aJMQ== X-Gm-Message-State: AJIora+Ur+r5/UvcIfUYpk4ngl2bE38N6hFLYc6sGUp3ZlQgKytqmZ4h jc5jIx1Ny2Vu9X4UyRbdHOcCD/QRe+o= X-Google-Smtp-Source: AGRyM1spRFdtcN9eEyBuRdKIh7Nq4MsnGesl3K9gNf1D2r3l+Pmy8pyBFD+LrMeHnLINbPresm3wHA== X-Received: by 2002:a17:90a:9a97:b0:1f2:3b4b:cb85 with SMTP id e23-20020a17090a9a9700b001f23b4bcb85mr5889791pjp.15.1658479830053; Fri, 22 Jul 2022 01:50:30 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id l8-20020a17090a3f0800b001ef9479373fsm5031082pjc.4.2022.07.22.01.50.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:29 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 56935104982; Fri, 22 Jul 2022 15:50:22 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 1/8] Documentation: s390: Use note directive for changing mask note Date: Fri, 22 Jul 2022 15:49:40 +0700 Message-Id: <20220722084946.22965-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The changing mask note uses custom syntax (open asterisks), which triggers emphasis warnings as Sphinx confuses it as boldface: Documentation/s390/vfio-ap.rst:684: WARNING: Inline strong start-string wit= hout end-string. Documentation/s390/vfio-ap.rst:684: WARNING: Inline emphasis start-string w= ithout end-string. Use note directive instead. Link: https://lore.kernel.org/linux-next/20220721205937.10043b5f@canb.auug.= org.au/ Fixes: cb269e0aba7c3f ("s390/vfio-ap: update docs to include dynamic config= support") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/Documentation/s390/vfio-ap.rst b/Documentation/s390/vfio-ap.rst index f4b8748ab9a8cd..7aea0afe2ef390 100644 --- a/Documentation/s390/vfio-ap.rst +++ b/Documentation/s390/vfio-ap.rst @@ -681,15 +681,17 @@ These are the steps: default drivers pool: adapter 0-15, domain 1 alternate drivers pool: adapter 16-255, domains 0, 2-255 =20 - Note ***: - Changing a mask such that one or more APQNs will be taken from a vfio_ap - mediated device (see below) will fail with an error (EBUSY). A message - is logged to the kernel ring buffer which can be viewed with the 'dmesg' - command. The output identifies each APQN flagged as 'in use' and identi= fies - the vfio_ap mediated device to which it is assigned; for example: + .. note:: + =20 + Changing a mask such that one or more APQNs will be taken from a vfi= o_ap + mediated device (see below) will fail with an error (EBUSY). A messa= ge + is logged to the kernel ring buffer which can be viewed with the 'dm= esg' + command. The output identifies each APQN flagged as 'in use' and + identifies the vfio_ap mediated device to which it is assigned; for + example:: =20 - Userspace may not re-assign queue 05.0054 already assigned to 62177883-= f1bb-47f0-914d-32a22e3a8804 - Userspace may not re-assign queue 04.0054 already assigned to cef03c3c-= 903d-4ecc-9a83-40694cb8aee4 + Userspace may not re-assign queue 05.0054 already assigned to 621= 77883-f1bb-47f0-914d-32a22e3a8804 + Userspace may not re-assign queue 04.0054 already assigned to cef= 03c3c-903d-4ecc-9a83-40694cb8aee4 =20 Securing the APQNs for our example ---------------------------------- --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 25851C433EF for ; Fri, 22 Jul 2022 08:51:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235172AbiGVIvS (ORCPT ); Fri, 22 Jul 2022 04:51:18 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49112 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235055AbiGVIug (ORCPT ); Fri, 22 Jul 2022 04:50:36 -0400 Received: from mail-pl1-x634.google.com (mail-pl1-x634.google.com [IPv6:2607:f8b0:4864:20::634]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AB9FB3120F; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: by mail-pl1-x634.google.com with SMTP id w7so4045846plp.5; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ceEYPzRSeSpxrJgH4dqtQc5ZKG3XNVZNdz1910Rs8+E=; b=HSLDQch/EhbwJQ6FNPDijFTX2F0ymRVo8ZZxJYr+dzvQb/35Mc2JgW/y/ik9o8ak3D /O+C85BjaJT92jdVmz8y65nNMMSIUaYKvOckIwdoxEb5kcaD0GTBCWohNpGw9LexUlaO GRUNr3h/BhzN5H4Ui1bDcBavy6lGUnBT01OhKxypZkXeQWH6lZEWjmkc6YC/ux2+QuD8 ud3dnLy1lWG1Gkd18/IRKEjL04ItnhUB6/2xiI53VhrB6zIc/wUP4wqoLUIBz4T5Kogc RTqWh28WkNiB5xHFw33KOn9EjVHacQ+RwA7gGtrjaxwanaGDYcjXp6qcJIEZh3NeXAZ9 BpDw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ceEYPzRSeSpxrJgH4dqtQc5ZKG3XNVZNdz1910Rs8+E=; b=CnyBhXjJFA6tSeABAqoOobWN9SawYhuWNqy5fLkIV+naSGuxA7bIz6KewAroRxQZR1 R1SABI/U+AzBc/74B32XHyH+BPcm/TqNu/DXOTMMM9OmQQg4/qXJjY5f2/WLpJE5s5oS a0dTDSXwyfHYbNfQxw0rFYSoglzOW1TgqeVlDmmi1CkLTaQ7B8UyEBNPwUgZnSetc5MK tgRGNrU4SjIHYQkw6IVqJL7LSnGQp3WWLmxpI6QL3eGXBi8Mh82/xver4Cwo1CS0JC8h ZAx4sRShugoVuqy+ajyyh1ittVifgssqYfnJnshNPo9Lt2AGb47yOwE/ogiE4Cu9jIzV DMOg== X-Gm-Message-State: AJIora+unEQ9Ofaio1WpgJQ2zlwzGhI/GJgBWQbFi+P9V0T/TbZ9A86x P8h5BoGsPwzyDeI/Lj4nis8= X-Google-Smtp-Source: AGRyM1ul9sEqgoURfnWwdMVnDPgz0X76SFB0LjCpcfiAzhoTS0E3qWEj50ZWAxplHTLfuGDnazv6kQ== X-Received: by 2002:a17:90b:3e89:b0:1f0:4233:b20e with SMTP id rj9-20020a17090b3e8900b001f04233b20emr3062372pjb.0.1658479833053; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id d10-20020a170902654a00b0016d1e514ec5sm3081418pln.139.2022.07.22.01.50.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:32 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 954F6104983; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya Subject: [PATCH 2/8] Documentation: s390: use note directive for remaining notes Date: Fri, 22 Jul 2022 15:49:41 +0700 Message-Id: <20220722084946.22965-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" Convert remaining vfio-ap.rst notes to use note directive, while also fix maximum sysfs notes being rendered as definition lists instead. Fixes: cb269e0aba7c3f ("s390/vfio-ap: update docs to include dynamic config= support") Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap.rst | 51 +++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/Documentation/s390/vfio-ap.rst b/Documentation/s390/vfio-ap.rst index 7aea0afe2ef390..5bf15d117c4ba0 100644 --- a/Documentation/s390/vfio-ap.rst +++ b/Documentation/s390/vfio-ap.rst @@ -475,24 +475,29 @@ following CPU model features: guest. This facility can be made available to the guest only if it is available on the host (i.e., facility bit 65 is set). =20 -Note: If the user chooses to specify a CPU model different than the 'host' -model to QEMU, the CPU model features and facilities need to be turned on -explicitly; for example:: + .. note:: =20 - /usr/bin/qemu-system-s390x ... -cpu z13,ap=3Don,apqci=3Don,apft=3Don,= apqi=3Don + If the user chooses to specify a CPU model different than the 'host' + model to QEMU, the CPU model features and facilities need to be turn= ed + on explicitly; for example:: =20 -A guest can be precluded from using AP features/facilities by turning them= off -explicitly; for example:: + /usr/bin/qemu-system-s390x ... -cpu z13,ap=3Don,apqci=3Don,apft= =3Don,apqi=3Don =20 - /usr/bin/qemu-system-s390x ... -cpu host,ap=3Doff,apqci=3Doff,apft=3D= off,apqi=3Doff + A guest can be precluded from using AP features/facilities by turning + them off explicitly; for example:: =20 -Note: If the APFT facility is turned off (apft=3Doff) for the guest, the g= uest -will not see any AP devices. The zcrypt device drivers on the guest that -register for type 10 and newer AP devices - i.e., the cex4card and cex4que= ue -device drivers - need the APFT facility to ascertain the facilities instal= led on -a given AP device. If the APFT facility is not installed on the guest, the= n no -adapter or domain devices will get created by the AP bus running on the -guest because only type 10 and newer devices can be configured for guest u= se. + /usr/bin/qemu-system-s390x ... -cpu host,ap=3Doff,apqci=3Doff,apf= t=3Doff,apqi=3Doff + + .. note:: + + If the APFT facility is turned off (apft=3Doff) for the guest, the g= uest + will not see any AP devices. The zcrypt device drivers on the guest = that + register for type 10 and newer AP devices - i.e., the cex4card and + cex4queue device drivers - need the APFT facility to ascertain the + facilities installed on a given AP device. If the APFT facility is n= ot + installed on the guest, then no adapter or domain devices will get + created by the AP bus running on the guest because only type 10 and + newer devices can be configured for guest use. =20 Example =3D=3D=3D=3D=3D=3D=3D @@ -802,8 +807,10 @@ Securing the APQNs for our example ----------------unassign_control_domain ----------------unassign_domain =20 - Note *****: The vfio_ap mdevs do not persist across reboots unless the - mdevctl tool is used to create and persist them. + .. note:: + + The vfio_ap mdevs do not persist across reboots unless the + mdevctl tool is used to create and persist them. =20 4. The administrator now needs to configure the matrixes for the mediated devices $uuid1 (for Guest1), $uuid2 (for Guest2) and $uuid3 (for Guest3= ). @@ -849,8 +856,10 @@ Securing the APQNs for our example higher than the maximum is specified, the operation will terminate wi= th an error (ENODEV). =20 - Note: The maximum adapter number can be obtained via the sysfs - /sys/bus/ap/ap_max_adapter_id attribute file. + .. note:: + + The maximum adapter number can be obtained via the sysfs + /sys/bus/ap/ap_max_adapter_id =20 * Each APQN derived from the Cartesian product of the APID of the adapt= er being assigned and the APQIs of the domains previously assigned: @@ -875,8 +884,10 @@ Securing the APQNs for our example higher than the maximum is specified, the operation will terminate wi= th an error (ENODEV). =20 - Note: The maximum domain number can be obtained via the sysfs - /sys/bus/ap/ap_max_domain_id attribute file. + .. note:: + + The maximum domain number can be obtained via the sysfs + /sys/bus/ap/ap_max_domain_id =20 * Each APQN derived from the Cartesian product of the APQI of the doma= in being assigned and the APIDs of the adapters previously assigned: --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 73FB3C433EF for ; Fri, 22 Jul 2022 08:50:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232987AbiGVIuv (ORCPT ); Fri, 22 Jul 2022 04:50:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48886 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234794AbiGVIub (ORCPT ); Fri, 22 Jul 2022 04:50:31 -0400 Received: from mail-pg1-x52d.google.com (mail-pg1-x52d.google.com [IPv6:2607:f8b0:4864:20::52d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1AC7A28E0B; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) Received: by mail-pg1-x52d.google.com with SMTP id 12so3677843pga.1; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Pgt3B8Mk6hzHexkwWSUpURVE6bVjaRrgC1Jzib8Uvgo=; b=fuAfY/jrnEl/zT0Bkg422Q0EGBqVY533MZMJ25gpLsnPu/y46yqy0mgm9jo5fQjUGO JGhkasnCK3MjhEFLNW2AWfQX96zMsmF5Se0vVP7cmSAKbFBmXyYPF0NBSpQ8sIY/rcPX 5NhDFZrlqxa1wXWMibumin+li4rRtBsyWteLsowMBxifs+lijwcqu3nVGQajxG739eO/ UNcNoUgpG5JjsBPKf56VBGovilrg+xy7tunGAo6YFSdQwB6FCpMnGgxaokTuAJtOJQCZ r25xNLEhcpcrpuya2aq3dPvjxNxcZPefVlshKl08NZC8HtnjNm58ate7aN526NJEofBa mq5A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Pgt3B8Mk6hzHexkwWSUpURVE6bVjaRrgC1Jzib8Uvgo=; b=8MnKOYrU6cWZTuC83ycfv2zXDi/WUGxGCjB5kFldQCcTZBY6+c8qcb/0pbDN0qojar qtN4yRq2Dx+lxtCFQVspFlFO/1pBSm28Hzqlapc/EFlXkhHd/i7b/qFNwI65JlsE68fk bD4UuQwv8j0f7pfhFXl7ehbINXB+EBJToZBZ7kVYrvW/4AVV8Bls3t1Tc4CogG0TRazf k1PbCCu6ih5064ay95Cl33+3tX3AjRmPJLinXXr065c6aZzqGSHws5mF1tA+yoBGYJmx KvXhO2XhrBpnjHoR6NcuxFKEj5r/FZp4uoALlqJnshqaVIsRiGnFLvLR4V1lNE7UiiuZ M5ig== X-Gm-Message-State: AJIora/Xv/0qSbql/oe0vJ/0A5fhEbPSlsLvQ22o9/p9djG5bnBsPUog NPOZCeBO37ass40NM0bD0Gs= X-Google-Smtp-Source: AGRyM1sZaNj+EkBrXdBDlKIqFWzl1zSDddu0Blwgj8QuUbuhYX8EsqNQEEkmPyRipLOpnTiv2xpbYw== X-Received: by 2002:a63:594f:0:b0:412:96c7:26f7 with SMTP id j15-20020a63594f000000b0041296c726f7mr2414112pgm.110.1658479830555; Fri, 22 Jul 2022 01:50:30 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id o3-20020a17090a744300b001f24dfedb94sm733678pjk.53.2022.07.22.01.50.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:29 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 35E9A104985; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 3/8] Documentation: s390: sync heading underlines Date: Fri, 22 Jul 2022 15:49:42 +0700 Message-Id: <20220722084946.22965-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" Two section headings ("Hot plug/unplug support" and "Overprovisioning ...") have too short underlines compared to the heading length, hence trigger repeated warnings: Documentation/s390/vfio-ap.rst:943: WARNING: Title underline too short. Hot plug/unplug support: =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Documentation/s390/vfio-ap.rst:943: WARNING: Title underline too short. Hot plug/unplug support: =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Documentation/s390/vfio-ap.rst:965: WARNING: Title underline too short. Over-provisioning of AP queues for a KVM guest: =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=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Documentation/s390/vfio-ap.rst:965: WARNING: Title underline too short. Over-provisioning of AP queues for a KVM guest: =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=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Adjust the underlines length to match the text. While at it, strip trailing colon on headings since these are redundant. Link:https://lore.kernel.org/linux-next/20220721205937.10043b5f@canb.auug.o= rg.au/ Fixes: cb269e0aba7c3f ("s390/vfio-ap: update docs to include dynamic config= support") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/s390/vfio-ap.rst b/Documentation/s390/vfio-ap.rst index 5bf15d117c4ba0..c0d76a959ed583 100644 --- a/Documentation/s390/vfio-ap.rst +++ b/Documentation/s390/vfio-ap.rst @@ -952,8 +952,9 @@ remove it if no guest will use it during the remaining = lifetime of the linux host. If the vfio_ap mdev is removed, one may want to also reconfigure the pool of adapters and queues reserved for use by the default drivers. =20 -Hot plug/unplug support: -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Hot plug/unplug support +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + An adapter, domain or control domain may be hot plugged into a running KVM guest by assigning it to the vfio_ap mediated device being used by the gue= st if the following conditions are met: @@ -974,7 +975,7 @@ An adapter, domain or control domain may be hot unplugg= ed from a running KVM guest by unassigning it from the vfio_ap mediated device being used by the guest. =20 -Over-provisioning of AP queues for a KVM guest: +Over-provisioning of AP queues for a KVM guest =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=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Over-provisioning is defined herein as the assignment of adapters or domai= ns to a vfio_ap mediated device that do not reference AP devices in the host's AP --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9A3DCC43334 for ; Fri, 22 Jul 2022 08:51:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235164AbiGVIvO (ORCPT ); Fri, 22 Jul 2022 04:51:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49066 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235017AbiGVIue (ORCPT ); Fri, 22 Jul 2022 04:50:34 -0400 Received: from mail-pj1-x102d.google.com (mail-pj1-x102d.google.com [IPv6:2607:f8b0:4864:20::102d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AB9AF30F77; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: by mail-pj1-x102d.google.com with SMTP id t3-20020a17090a3b4300b001f21eb7e8b0so6994745pjf.1; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=6ZQ5kPkHtyDecpdBs3hMRWo2GqFD03eIO0NfZtVc+O4=; b=DVKLZm5X2YxI/hHtBVSmt5Myni1GZ/sy0ItyEQawn8DWmwBpC/+/diVmqnaUnVF8Zn Q86viinljGXvI+oe/fcBVa+5NGI3wdU8YiauOkshPf88zhnjTFpVCaLXpPaRks1W5Qx4 CWrZf8zEnBvNtOo58LLdphc6Hml46aZ9BppOHKfosXSc5yMwtj6zMnQwQHYkTEO8p2hg 4NfnZXAyg8BNln6Z5NE1RVxZ51EoIaONKwzkvwhfLksCRov3ZA2GZEIIFAlgUfIsoM78 9yH5u4AKP3KRMytt5bX/QwvnOhRXzC9tWapeLjyX/YnLzsZMZTwa9WoKoZ4SNlYlLYyP Hdhw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=6ZQ5kPkHtyDecpdBs3hMRWo2GqFD03eIO0NfZtVc+O4=; b=xUccBKB9LinFrRyh0qmiXVy9sOfd3ViTWtvGbNu2bUyTUmC+UAngeWMJzF2IrtbUjL 2kQ4YFhyR0r6P21iVrEslyETTFPcd0CpHhyuUfB0/FjPaomJSuYeHz5/kMT/5AFLx+5D yzGOEG/+a0XTsp2Jxwe6IoIALsWBJRP3OKWv8fEcK1xeBl5ZLOx8JYDiFVqQ9nBXSh+w YqVSQE9EIEUwxI86fn/oixG5vhItqfbCzy+az+Z3JPs1tn6k8eM53RDsc9X46Q45zPN6 VQShs0bd+2MvoS99YE078jWLWiryFHE5987jUZp1J0htHcR5m/9gFzZek+Btnyo98OXm BVbQ== X-Gm-Message-State: AJIora8vSHrmsqgzdrSjs0Zyg35XWdicdXGiG5Qm2pK3S5zIz8nyMqGk /pQuVA3peML8vrFIhwEdYqVT6enh/mk= X-Google-Smtp-Source: AGRyM1v/n3N6pUtAoflXr4rbN4DXL8mbPl10cRpA9jhBTUyB0AUCiqNy6e4YumTRaBnfVvGJXmPHWQ== X-Received: by 2002:a17:902:6a8c:b0:16d:1f3f:e184 with SMTP id n12-20020a1709026a8c00b0016d1f3fe184mr2384380plk.73.1658479833205; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id j7-20020a170903024700b0016c20d40ee7sm3213447plh.174.2022.07.22.01.50.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:32 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 7A339104980; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 4/8] Documentation: s390: use code blocks for virsh and qemu output Date: Fri, 22 Jul 2022 15:49:43 +0700 Message-Id: <20220722084946.22965-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" virsh and qemu output blocks are formatted with definition lists, however Sphinx isn't happy with the formatting: Documentation/s390/vfio-ap.rst:998: WARNING: Definition list ends without a= blank line; unexpected unindent. Documentation/s390/vfio-ap.rst:999: WARNING: Definition list ends without a= blank line; unexpected unindent. Documentation/s390/vfio-ap.rst:1038: WARNING: Definition list ends without = a blank line; unexpected unindent. Documentation/s390/vfio-ap.rst:1039: WARNING: Definition list ends without = a blank line; unexpected unindent. Use code blocks instead, which are more appropriate. While at it, also describe virsh commands where --hmp flag is given. Link:https://lore.kernel.org/linux-next/20220721205937.10043b5f@canb.auug.o= rg.au/ Fixes: cb269e0aba7c3f ("s390/vfio-ap: update docs to include dynamic config= support") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap.rst | 88 ++++++++++++++++++---------------- 1 file changed, 48 insertions(+), 40 deletions(-) diff --git a/Documentation/s390/vfio-ap.rst b/Documentation/s390/vfio-ap.rst index c0d76a959ed583..920d67ab7b06ff 100644 --- a/Documentation/s390/vfio-ap.rst +++ b/Documentation/s390/vfio-ap.rst @@ -995,70 +995,78 @@ the mdev is in use by a KVM guest. If the guest is be= ing emulated by QEMU, its mdev can be hot unplugged from the guest in one of two ways: =20 1. If the KVM guest was started with libvirt, you can hot unplug the mdev = via - the following commands: + the following commands:: =20 virsh detach-device =20 - For example, to hot unplug mdev 62177883-f1bb-47f0-914d-32a22e3a8804= from - the guest named 'my-guest': + For example, to hot unplug mdev 62177883-f1bb-47f0-914d-32a22e3a8804 fr= om + the guest named 'my-guest':: =20 - virsh detach-device my-guest ~/config/my-guest-hostdev.xml + virsh detach-device my-guest ~/config/my-guest-hostdev.xml =20 - The contents of my-guest-hostdev.xml: + The contents of my-guest-hostdev.xml: =20 - - -
- - + .. code-block:: xml =20 + + +
+ + + + + To hot unplug the vfio_ap mediated device identified on the qemu command + line, use:: =20 virsh qemu-monitor-command --hmp "device-del " =20 - For example, to hot unplug the vfio_ap mediated device identified on= the - qemu command line with 'id=3Dhostdev0' from the guest named 'my-gues= t': + For example, to hot unplug the vfio_ap mediated device identified on the + qemu command line with 'id=3Dhostdev0' from the guest named 'my-guest':: =20 - virsh qemu-monitor-command my-guest --hmp "device_del hostdev0" + virsh qemu-monitor-command my-guest --hmp "device_del hostdev0" =20 2. A vfio_ap mediated device can be hot unplugged by attaching the qemu mo= nitor - to the guest and using the following qemu monitor command: + to the guest and using the following qemu monitor command:: =20 (QEMU) device-del id=3D =20 - For example, to hot unplug the vfio_ap mediated device that was spec= ified - on the qemu command line with 'id=3Dhostdev0' when the guest was sta= rted: + For example, to hot unplug the vfio_ap mediated device that was specifi= ed + on the qemu command line with 'id=3Dhostdev0' when the guest was starte= d:: =20 - (QEMU) device-del id=3Dhostdev0 + (QEMU) device-del id=3Dhostdev0 =20 After live migration of the KVM guest completes, an AP configuration can be restored to the KVM guest by hot plugging a vfio_ap mediated device on the= target system into the guest in one of two ways: =20 1. If the KVM guest was started with libvirt, you can hot plug a matrix me= diated - device into the guest via the following virsh commands: + device into the guest via the following virsh commands:: =20 - virsh attach-device + virsh attach-device =20 - For example, to hot plug mdev 62177883-f1bb-47f0-914d-32a22e3a8804 i= nto - the guest named 'my-guest': + For example, to hot plug mdev 62177883-f1bb-47f0-914d-32a22e3a8804 into + the guest named 'my-guest':: =20 - virsh attach-device my-guest ~/config/my-guest-hostdev.xml + virsh attach-device my-guest ~/config/my-guest-hostdev.xml =20 - The contents of my-guest-hostdev.xml: + The contents of my-guest-hostdev.xml: =20 - - -
- - + .. code-block:: xml =20 + + +
+ + =20 - virsh qemu-monitor-command --hmp \ - "device_add vfio-ap,sysfsdev=3D,id=3D" + To hot plug vfio_ap mediated device, use:: =20 - For example, to hot plug the vfio_ap mediated device - 62177883-f1bb-47f0-914d-32a22e3a8804 into the guest named 'my-guest'= with - device-id hostdev0: + virsh qemu-monitor-command --hmp \ + "device_add vfio-ap,sysfsdev=3D,id=3D" + + For example, to hot plug the vfio_ap mediated device + ``62177883-f1bb-47f0-914d-32a22e3a8804`` into the guest named 'my-guest' + with device-id hostdev0:: =20 virsh qemu-monitor-command my-guest --hmp \ "device_add vfio-ap,\ @@ -1066,14 +1074,14 @@ system into the guest in one of two ways: id=3Dhostdev0" =20 2. A vfio_ap mediated device can be hot plugged by attaching the qemu moni= tor - to the guest and using the following qemu monitor command: + to the guest and using the following qemu monitor command:: =20 (qemu) device_add "vfio-ap,sysfsdev=3D,id=3D" =20 - For example, to plug the vfio_ap mediated device - 62177883-f1bb-47f0-914d-32a22e3a8804 into the guest with the device-= id - hostdev0: + For example, to plug the vfio_ap mediated device + ``62177883-f1bb-47f0-914d-32a22e3a8804`` into the guest with the device= -id + hostdev0:: =20 - (QEMU) device-add "vfio-ap,\ - sysfsdev=3D/sys/devices/vfio_ap/matrix/62177883-f1bb-47f0-914d-32= a22e3a8804,\ - id=3Dhostdev0" + (QEMU) device-add "vfio-ap,\ + sysfsdev=3D/sys/devices/vfio_ap/matrix/62177883-f1bb-47f0-914d-32a22= e3a8804,\ + id=3Dhostdev0" --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BD6B5C43334 for ; Fri, 22 Jul 2022 08:51:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235136AbiGVIvG (ORCPT ); Fri, 22 Jul 2022 04:51:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48940 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234969AbiGVIuc (ORCPT ); Fri, 22 Jul 2022 04:50:32 -0400 Received: from mail-pj1-x102e.google.com (mail-pj1-x102e.google.com [IPv6:2607:f8b0:4864:20::102e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BBA3B27CCF; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) Received: by mail-pj1-x102e.google.com with SMTP id gn24so3814687pjb.3; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=E/k5RCOqp4l8e/X8YSW8RAC7hl6FhMb1nEHkDDI4VqI=; b=NK8kP9v/27/rHyHa0CAOwc3ULlDg8vvHqkVCR6DCXkAV5cSCpvotRrSWd2P3GJSwdw hmwr2fabn/yDmMeaQZIFDY0G/wOcx/6SrsYsia77wH3Tp7llbhRnYiY5C3F22e45KZdf 0xyXysOiuP/vI1sEbdygAb0hUM7j6rBx5r0TxyY2tFbYvuuyX59+zUalaGF47RxcIVF9 mnfewKYci49PQPND/M9QeLC8w02ZZsXd+dl/XUvfl3BF5itnZSH08fYdMmFxa8RSA0hp sSQFTCLkpfKvW1biU461B+GAKr8B1K98BZdoPOrGYygnwqttKDk5K7pxoLvAvz7alY31 ygRg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=E/k5RCOqp4l8e/X8YSW8RAC7hl6FhMb1nEHkDDI4VqI=; b=MP+VZf3Myu0A0QEiHA1ZbebwOm9ViCFIuwC084kNhnhj9shEyjnL8Ifk53lIp7CdGk GbpRwPxMy7LUWN15cWHarOEa+ZogWtnn8Q1/R3AA4ux1S2pM79ocr56P8EPt9xAXWavF AkGj+sqdxja2pu3Xhc/ZmCWidiGfE028j+D+2GMdLzYS/q9/wUzEce+Q+nk098K+jkbt 8NWn+2ghxKWtAGu36yOJmpMPevFc0dUOVolVBevPOcgdrQ4LPuRfUG6GDzOKBw/Lmdz4 NHM+LhJIbuRC1u+dz/5VPR7Ow/3DcaZkYDXSOgbVUXxYcoDl1sYp0W6wJLjXuGt183jA oL+g== X-Gm-Message-State: AJIora8US209aEP8QWj+ogO/qLttXo8YUzrTqL0L8ylBwhD0qPfMdY4H m2SEhG0XSSjZGOtSFzYYyNM= X-Google-Smtp-Source: AGRyM1vQhaO3jrrh+otrq6YcHEp2H/n0sVGK5hWk4mbXlwUC7VPwTqbEuErjW6ANBO88mC728LJMRA== X-Received: by 2002:a17:902:da8f:b0:16d:1c82:624b with SMTP id j15-20020a170902da8f00b0016d1c82624bmr2497497plx.163.1658479831175; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id 22-20020a631556000000b003fd9b8b865dsm2999988pgv.0.2022.07.22.01.50.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:29 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id EEA7A104987; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 5/8] Documentation: s390: use code block for structs Date: Fri, 22 Jul 2022 15:49:44 +0700 Message-Id: <20220722084946.22965-6-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" In vfio-ap-locking documentation, struct code samples aren't inside code blocks, hence trigger many inline emphasis and definition list warnings. Use code blocks for them. Link: https://lore.kernel.org/linux-next/20220721201058.2a276286@canb.auug.= org.au/ Fixes: e32d3827f3d5b2 ("s390/Docs: new doc describing lock usage by the vfi= o_ap device driver") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap-locking.rst | 64 +++++++++++++++----------- 1 file changed, 36 insertions(+), 28 deletions(-) diff --git a/Documentation/s390/vfio-ap-locking.rst b/Documentation/s390/vf= io-ap-locking.rst index c4e1eeec79a0f5..4194b78ace0e94 100644 --- a/Documentation/s390/vfio-ap-locking.rst +++ b/Documentation/s390/vfio-ap-locking.rst @@ -5,21 +5,23 @@ VFIO AP Locks Overview =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D This document describes the locks that are pertinent to the secure operati= on of the vfio_ap device driver. Throughout this document, the following vari= ables -will be used to denote instances of the structures herein described: +will be used to denote instances of the structures herein described:: =20 -struct ap_matrix_dev *matrix_dev; -struct ap_matrix_mdev *matrix_mdev; -struct kvm *kvm; + struct ap_matrix_dev *matrix_dev; + struct ap_matrix_mdev *matrix_mdev; + struct kvm *kvm; =20 The Matrix Devices Lock (drivers/s390/crypto/vfio_ap_private.h) -------------------------------------------------------------- =20 -struct ap_matrix_dev { - ... - struct list_head mdev_list; - struct mutex mdevs_lock; - ... -} +:: + + struct ap_matrix_dev { + ... + struct list_head mdev_list; + struct mutex mdevs_lock; + ... + } =20 The Matrix Devices Lock (matrix_dev->mdevs_lock) is implemented as a global mutex contained within the single object of struct ap_matrix_dev. This lock @@ -31,11 +33,13 @@ representing one of the vfio_ap device driver's mediate= d devices. The KVM Lock (include/linux/kvm_host.h) --------------------------------------- =20 -struct kvm { - ... - struct mutex lock; - ... -} +:: + + struct kvm { + ... + struct mutex lock; + ... + } =20 The KVM Lock (kvm->lock) controls access to the state data for a KVM guest= . This lock must be held by the vfio_ap device driver while one or more AP adapte= rs, @@ -48,12 +52,14 @@ been attached to the KVM guest. The Guests Lock (drivers/s390/crypto/vfio_ap_private.h) ----------------------------------------------------------- =20 -struct ap_matrix_dev { - ... - struct list_head mdev_list; - struct mutex guests_lock; - ... -} +:: + + struct ap_matrix_dev { + ... + struct list_head mdev_list; + struct mutex guests_lock; + ... + } =20 The Guests Lock (matrix_dev->guests_lock) controls access to the matrix_mdev instances (matrix_dev->mdev_list) that represent mediated devi= ces @@ -89,14 +95,16 @@ resources, so only the matrix_dev->mdevs_lock needs to = be held. The PQAP Hook Lock (arch/s390/include/asm/kvm_host.h) ----------------------------------------------------- =20 -typedef int (*crypto_hook)(struct kvm_vcpu *vcpu); +:: =20 -struct kvm_s390_crypto { - ... - struct rw_semaphore pqap_hook_rwsem; - crypto_hook *pqap_hook; - ... -}; + typedef int (*crypto_hook)(struct kvm_vcpu *vcpu); + + struct kvm_s390_crypto { + ... + struct rw_semaphore pqap_hook_rwsem; + crypto_hook *pqap_hook; + ... + }; =20 The PQAP Hook Lock is a r/w semaphore that controls access to the function pointer of the handler (*kvm->arch.crypto.pqap_hook) to invoke when the --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BAF37C43334 for ; Fri, 22 Jul 2022 08:51:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235147AbiGVIvL (ORCPT ); Fri, 22 Jul 2022 04:51:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49070 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235020AbiGVIue (ORCPT ); Fri, 22 Jul 2022 04:50:34 -0400 Received: from mail-pj1-x102e.google.com (mail-pj1-x102e.google.com [IPv6:2607:f8b0:4864:20::102e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 129943B976; Fri, 22 Jul 2022 01:50:34 -0700 (PDT) Received: by mail-pj1-x102e.google.com with SMTP id x24-20020a17090ab01800b001f21556cf48so7570170pjq.4; Fri, 22 Jul 2022 01:50:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=O/NbGM5kJjRqIAfAkXYggB/ERlvKPV9lzrEH17cTzVU=; b=eYGbdaRu+qY7Z4aDMxmm1rR81L5jtkCkJQaZdx7QGhTGL93r2kDufbITPBYwd5Crfe NxSRuMBOVT490FewDGGPEqIwgENUAjM/X97YMWS07PH+LPtmfQ26ffG9dyzfYqJwVM9K akO/5K2ALIaPUo7kWg1m32v/drNAijzlzX0dVXTKa2XYuy9fEp+WdBKqUKBzJipQO7t6 9P6jWbFguO+jBG2jXZvCexqVNAcOgtTb4pjUo8qZ2ZW1uZpHCOkpynYdZLZF7CgcRSmp pddi896FJbH5H4a1iSBuD86rmG/deo2rVZ9QSTYn+2glKWmrqo6WD/YQ+N43AAW4/ddn gDvg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=O/NbGM5kJjRqIAfAkXYggB/ERlvKPV9lzrEH17cTzVU=; b=Ti4pbw0HQqEp6xwbVyCM5K7xY0MkUSjefNzdhZM3MwAm/SkkXHKenvGBewrHL02gww VEVvdzBuGedQvlhcanYViT7WNHZrdQkALn2m8/2SFKs8iC+td63F/49Jee4MB16xkUJB ljfcSqNj3TAGzZMoN3tHWBM+JH0uzzLXm9AHuBpwcXMZJCZRIMygMpqD5fobAUVJlgen 743Up6ZogQDjM8y0To4NB1BzAeHu6I72kll9kv59hYOfBrH88YLrvlkFagh1ROeyCFFV i685oPEke/LRP4quZ4dXlGlH0ajwUudjz/v17gxN8De3hFd/8rG2+g8scas98vVGj8fl rkeA== X-Gm-Message-State: AJIora8Z8zq+GrU2s8dBiqJltiz3E8bKZ2zH3WXLA4OUcH/1p9GFCmdj kwYONgrLHTsFEV3qIwJd+3c= X-Google-Smtp-Source: AGRyM1us+umJEjBCkMBqnMpr40e1Me6PRIvRqhajmFBdp63TFBVGRUSKkpQ4eMjvrgszDgGHqGo7Xg== X-Received: by 2002:a17:902:7612:b0:16d:2dbe:26f2 with SMTP id k18-20020a170902761200b0016d2dbe26f2mr2609786pll.94.1658479833470; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id e6-20020a17090301c600b0016cdefd5e95sm3040341plh.8.2022.07.22.01.50.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:32 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id B3539104981; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 6/8] Documentation: s390: escape *kvm->arch.crypto.pqap_hook pointer inside inline code Date: Fri, 22 Jul 2022 15:49:45 +0700 Message-Id: <20220722084946.22965-7-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The *kvm->arch.crypto.pqap_hook pointer triggers inline emphasis warning, due to unescaped asterisk. Escape it into inline code. Link: https://lore.kernel.org/linux-next/20220721201058.2a276286@canb.auug.= org.au/ Fixes: e32d3827f3d5b2 ("s390/Docs: new doc describing lock usage by the vfi= o_ap device driver") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap-locking.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/s390/vfio-ap-locking.rst b/Documentation/s390/vf= io-ap-locking.rst index 4194b78ace0e94..cfbb661ea72e63 100644 --- a/Documentation/s390/vfio-ap-locking.rst +++ b/Documentation/s390/vfio-ap-locking.rst @@ -107,7 +107,7 @@ The PQAP Hook Lock (arch/s390/include/asm/kvm_host.h) }; =20 The PQAP Hook Lock is a r/w semaphore that controls access to the function -pointer of the handler (*kvm->arch.crypto.pqap_hook) to invoke when the +pointer of the handler (``*kvm->arch.crypto.pqap_hook``) to invoke when the PQAP(AQIC) instruction sub-function is intercepted by the host. The lock m= ust be held in write mode when pqap_hook value is set, and in read mode when the pqap_hook function is called. --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BB26FC43334 for ; Fri, 22 Jul 2022 08:51:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234805AbiGVIvB (ORCPT ); Fri, 22 Jul 2022 04:51:01 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48898 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234942AbiGVIuc (ORCPT ); Fri, 22 Jul 2022 04:50:32 -0400 Received: from mail-pj1-x102d.google.com (mail-pj1-x102d.google.com [IPv6:2607:f8b0:4864:20::102d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3F52E28E33; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) Received: by mail-pj1-x102d.google.com with SMTP id gn24so3814673pjb.3; Fri, 22 Jul 2022 01:50:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=NHPADm0+jI7FAaPRhILrrh5k8cQJVDYd8IToScSIdm4=; b=izz6djKSQTtceEafrVo7QxdMb2Wd4uy11VI+7JvM9USfvwZt+bHKyMow6PP6klgalD VLAi36H+fo2EvuUB/fcIxTCcGYQwMZCZ4+YL03pDCyG+acz+/rL3OxFKL65qkWSNOYFD hW0XaxvvgllBme5khczEKLkGMCrSq6imrM1TSYiq0Q2TPONLYwC2/BTzBfOVhg3gTG3Z f2KjIJjEgr2owaqClB2O84adnJ4ka6uxCbUMlF+/RIy++0LR229iBGgg46rQN1rlmuDJ wWNjawg7wWHUhMyFcTxo10HHqewAKB7kS9bMyhuDs5qC1UQEkytiRPBuESgUMqTc8um4 vL4g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=NHPADm0+jI7FAaPRhILrrh5k8cQJVDYd8IToScSIdm4=; b=Zm8KaEFAE75EdwqTdnCjKrh7y8ifeuuOj6tORAppI7VUJyBb5Ax7V+vbHTkUJWDcxt 39oSO700G06dn/A/esf3oq8yqwLxuxJvCdUQZJUfaaNhdUln6nHWqCofhlayAFzvWQxe Fgp/QgInQh6WIoVWdjDBg0K6QYAfDGyaEM9Ir+ex16cA678f7jBY7H/pQE5wRlfA7CD4 rU+pBw6JzaLGbcT9l+xbldRCFilyDC1BSAlgq/9sx58YJEVa95PHTPHo32keBpFOHS+5 8CZF2Loqp4U7xUeNNaVlN3mamcyge3uoNOBe6goepKBp2SxH/AG9Pq40RZ7RC/JpaAgL wA7w== X-Gm-Message-State: AJIora9afFjdQLxOr5DFzCKRp2QdabASAg0PzuwCJd+iWgmlq3Up+GAr XW84LHpVUHb8A3DfOMitxaY= X-Google-Smtp-Source: AGRyM1vuI+wWNr7WhC5ccsl4JgLjSx5Fk9RToyt2DQtUj2jgzGYrI2asEV3Gfto7fiwX0ux2dwT7Lw== X-Received: by 2002:a17:903:1c4:b0:16c:4e45:38a3 with SMTP id e4-20020a17090301c400b0016c4e4538a3mr2340164plh.41.1658479830700; Fri, 22 Jul 2022 01:50:30 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id k4-20020a170902ce0400b0016d42244886sm717506plg.94.2022.07.22.01.50.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:29 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id B4B291039A0; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 7/8] Documentation: s390: extend underline for matrix devices lock Date: Fri, 22 Jul 2022 15:49:46 +0700 Message-Id: <20220722084946.22965-8-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The underline heading for "The Matrix Devices Lock" section is off-short by a dash, hence: Documentation/s390/vfio-ap-locking.rst:15: WARNING: Title underline too sho= rt. The Matrix Devices Lock (drivers/s390/crypto/vfio_ap_private.h) Reported-by: Stephen Rothwell -------------------------------------------------------------- Extend the underline to match heading text length. Link:https://lore.kernel.org/linux-next/20220721201058.2a276286@canb.auug.o= rg.au/ Fixes: e32d3827f3d5b2 ("s390/Docs: new doc describing lock usage by the vfi= o_ap device driver") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/vfio-ap-locking.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/s390/vfio-ap-locking.rst b/Documentation/s390/vf= io-ap-locking.rst index cfbb661ea72e63..ab41b0e5dca40e 100644 --- a/Documentation/s390/vfio-ap-locking.rst +++ b/Documentation/s390/vfio-ap-locking.rst @@ -12,7 +12,7 @@ will be used to denote instances of the structures herein= described:: struct kvm *kvm; =20 The Matrix Devices Lock (drivers/s390/crypto/vfio_ap_private.h) --------------------------------------------------------------- +--------------------------------------------------------------- =20 :: =20 --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 17 09:21:49 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CA963C433EF for ; Fri, 22 Jul 2022 08:51:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235179AbiGVIvU (ORCPT ); Fri, 22 Jul 2022 04:51:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49160 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235061AbiGVIug (ORCPT ); Fri, 22 Jul 2022 04:50:36 -0400 Received: from mail-pl1-x62b.google.com (mail-pl1-x62b.google.com [IPv6:2607:f8b0:4864:20::62b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DA4F931DCA; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: by mail-pl1-x62b.google.com with SMTP id d7so4029039plr.9; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=WMLMbhzpQ8BYCKUc89U899ul04BiM4aI/9He03oT5uc=; b=duF24r2Mh/zRTYtQOAshatj9u415FRbTrhKlEf3cjpV57Heczae2zKForLZUgVcTIj ibUj2DTGe4mcVs5yOgqhngG7UJ4mKzxnEzebg6MChYG8DHwJtj2SE+pMyC9f+d2AKaxl yAXXf1jgaFSXRAVzm6KnetZlKLwPn0fvUcVbYgKsalOoKvVYi2/dpaOT8GWMLBvbuoAa IL7qRg7ghT5+z3OFTSXzs3i+Oq+3s8SMCR6c70kxPvNLlfC26d+jmpUuBREDvsHQMNRw p/0doIb4Z2iLKRfBiWQCnfITS6Hc4/kimbOb4IaWD84fCdzFFDwV7RH9XjrpI3LD+HAp 1cJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=WMLMbhzpQ8BYCKUc89U899ul04BiM4aI/9He03oT5uc=; b=zyUslw7Lc8Hm56nJ4q5r6mvhjMXTqcQyjZUeBc/BmI+/k3mJvosqFKfl7iewifOSBG eCysyUjfXhuQlHxta8bQJWWPFiHlhBmRygfn0lGZp5jBjo2TxBx/BmwnLTl/1Vl1xFxJ Zju1N5MC3sa7o1GCdbIp7M2EZ7mRIouPhQvwmA+kKo9yGdkVELN4P3qdR153ZklONPYc 7QKkj2cnoMwvRxf5stEIosuwSQUzEBdtedUiBEN7Wo7hLponPQzugGzC9DwEWqATwZFe i3CZ4mp2DyrUpTvB5BWGP2k7CKQLgWD9Jgfmxq/hhFHDHhDsPhST0gj7ztFuVW0mG80N 9RQA== X-Gm-Message-State: AJIora+sDJ+PBwQ0vgE5YoMdg+bGHEehnIdV2uqweLuRHEMqpMH59jrG 0oZyh0vLDR/PoWI33QIYrR8= X-Google-Smtp-Source: AGRyM1ulLh5mC4aId6RvlA5MUpQyoZ+n5mnzh95GyZAc0cRin4lIZGT5yP5tox1MRsNbRAOatdEjyA== X-Received: by 2002:a17:90a:9409:b0:1f0:e171:f2bd with SMTP id r9-20020a17090a940900b001f0e171f2bdmr2867699pjo.245.1658479833324; Fri, 22 Jul 2022 01:50:33 -0700 (PDT) Received: from debian.me (subs03-180-214-233-91.three.co.id. [180.214.233.91]) by smtp.gmail.com with ESMTPSA id i7-20020a056a00224700b0051b8e7765edsm3227658pfu.67.2022.07.22.01.50.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 01:50:32 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id CEAFC104986; Fri, 22 Jul 2022 15:50:23 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Heiko Carstens , Vasily Gorbik , Alexander Gordeev , Christian Borntraeger , Sven Schnelle , Jonathan Corbet , Halil Pasic , Tony Krowiak , Jason Herne , linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya , Stephen Rothwell Subject: [PATCH 8/8] Documentation: s390: add vfio-ap-locking documentation to table of contents index Date: Fri, 22 Jul 2022 15:49:47 +0700 Message-Id: <20220722084946.22965-9-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com> References: <20220722084946.22965-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" vfio-ap-locking.rst documentation is missing from s390 index, so: Documentation/s390/vfio-ap-locking.rst: WARNING: document isn't included in= any toctree Add missing documentation to the index. Link: https://lore.kernel.org/linux-next/20220721201058.2a276286@canb.auug.= org.au/ Fixes: e32d3827f3d5b2 ("s390/Docs: new doc describing lock usage by the vfi= o_ap device driver") Reported-by: Stephen Rothwell Signed-off-by: Bagas Sanjaya --- Documentation/s390/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/s390/index.rst b/Documentation/s390/index.rst index b10ca919255738..73c79bf586fd60 100644 --- a/Documentation/s390/index.rst +++ b/Documentation/s390/index.rst @@ -12,6 +12,7 @@ s390 Architecture qeth s390dbf vfio-ap + vfio-ap-locking vfio-ccw zfcpdump common_io --=20 An old man doll... just what I always wanted! - Clara