From nobody Mon May 6 05:39:26 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575646075; cv=none; d=zohomail.com; s=zohoarc; b=gW6VUpVSK0Hwc24VMte2/UZ04CyyiDZSsmttFw2i9DjfjFwH1ag5k5RdPfYTN1XhyRvR2keAbzFBk/DFneKY7PZodfpLbrFAdx/+e5tGB9bDfV8dyt5c3l/2UvX4lj2LoTOIsafnpdkl0YAX04Sp+LS4dOXLt728tdZbrHv1G9A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575646075; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=bIJvzQpnEMApOElCaCk2lLQMQ09zgb2vjn7tNHApnQk=; b=Cs+HoPKzAAjqT36P4VkN9Dp5CvU6pq7bFuemVOkkY2t5/wauxZ61kvmGiwCoK0mMZg9WSon286eInLsh6RIzqoZW2EmXeFWJ7+uXpH/+M1geJ82TxL0VeYuQjaZa2kSIAGzIhRswWmQYdf1D5HR5IVXpBtc8r0ihWD9UiVR6PYg= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1575646075195131.34098743931543; Fri, 6 Dec 2019 07:27:55 -0800 (PST) Received: from localhost ([::1]:39724 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1idFWL-0004hk-7S for importer@patchew.org; Fri, 06 Dec 2019 10:27:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:44820) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1idEkR-0008B0-Vt for qemu-devel@nongnu.org; Fri, 06 Dec 2019 09:38:26 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1idEkQ-0000Qi-U0 for qemu-devel@nongnu.org; Fri, 06 Dec 2019 09:38:23 -0500 Received: from us-smtp-delivery-1.mimecast.com ([205.139.110.120]:59027 helo=us-smtp-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1idEkQ-0000P4-4z for qemu-devel@nongnu.org; Fri, 06 Dec 2019 09:38:22 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-146-w70AkRktMg-X9ARXWebacw-1; Fri, 06 Dec 2019 09:38:18 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 6466B8051BE; Fri, 6 Dec 2019 14:38:17 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 240DC6016D; Fri, 6 Dec 2019 14:38:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643101; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=bIJvzQpnEMApOElCaCk2lLQMQ09zgb2vjn7tNHApnQk=; b=GJOUBr/b/NWsPqsxQm6sfWiv2uef8xgf0kJf/A/AJdYPHpBjIQJrmrO5kBph0sxwB0rdIy GdPW74u/tcf96E2E3NFzo6a1EHXaEV1VE+lwbPd2Bzns+GSkCz0Nt8vdhibfYEemSuEG91 d5EQQig4UlxMjibqXx5j/VfuCo3tV/o= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Subject: [PATCH] qapi: better document NVMe blockdev @device parameter Date: Fri, 6 Dec 2019 14:38:11 +0000 Message-Id: <20191206143811.3777524-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: w70AkRktMg-X9ARXWebacw-1 X-Mimecast-Spam-Score: 0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 205.139.110.120 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Stefan Hajnoczi , Markus Armbruster , qemu-block@nongnu.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Mention that this is a PCI device address & give the format it is expected it. Also mention that it must be first unbound from any host kernel driver. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Eric Blake Reviewed-by: Stefan Hajnoczi --- qapi/block-core.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index 0cf68fea14..fcb52ec24f 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -2963,9 +2963,13 @@ # # Driver specific block device options for the NVMe backend. # -# @device: controller address of the NVMe device. +# @device: PCI controller address of the NVMe device in +# format hhhh:bb:ss.f (host:bus:slot.function) # @namespace: namespace number of the device, starting from 1. # +# Note that the PCI @device must have been unbound from any host +# kernel driver before instructing QEMU to add the blockdev. +# # Since: 2.12 ## { 'struct': 'BlockdevOptionsNVMe', --=20 2.23.0