Received: by 10.223.185.116 with SMTP id b49csp2360316wrg; Thu, 15 Feb 2018 10:22:17 -0800 (PST) X-Google-Smtp-Source: AH8x224VRfo+FgYwoKp6HlsbD6oEhRoehcDqHxX393QQj/sjFG5Rw+XdDZRfk1awQbQIDkgyT3Je X-Received: by 10.98.34.15 with SMTP id i15mr3427590pfi.168.1518718937139; Thu, 15 Feb 2018 10:22:17 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1518718937; cv=none; d=google.com; s=arc-20160816; b=t8Uqd7LaCg38us58ZeNSUbMOj50vbA/EA6lq9IxyhYecHZ3+Jpt+2K7H8X6rX2bXjk 9ASqtjlEiGj8rT2PYAV3VpAnaZNbGDf8PBQTKFurEeTme9gzATTM8YSZJX0hMTy72IHa rkrJ+s/gl3ZnntR8sqWskDOfGFrvO/o1UbmEy56dOIBDCGimKTSzXpygzguT1SzcV5u1 MK+IP4tV8S9AGppVlyK9EVntpS6BNrZ0Yl34+WJWAbmAmkVkdSWB7iiULFKDdg81XipL hmEedIeOQ2QeIsj8lX3Phy6/zP6c/thv5GlaGcQAorJfSEDoERzGNI/fXzwvR2rI7+eb 8AzA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:in-reply-to:content-transfer-encoding :content-disposition:mime-version:references:message-id:subject:cc :to:from:date:arc-authentication-results; bh=78QZlfOxVM9YaWV6q4zEAwGk3r1UM/EwcGypygf2krE=; b=EPupu6EQJawrSNBfyN81eUAWD2me3k8kCqZsiZu46ZC8LTMcjgp44gb8zteCS+brYg aVaJk69712chjVC8QWP9Zb0PTk4rXz5gclLRyov+c2FBgJKrZG2vlr0t2w28oMPMiada ovP/rPptnMlzAobrcqsqrM3a4+rcABHNFXePSQs7XDpkDCAJNaIe8PRUGyAeN0vvZofv VAf2VNUpv0AfXx386MpvpD5tJNHhKMNhmAD9RIntqcLwhzlFvmtqiHb1oqy144DlljfT rU/b+HMRG+XzKwhbLv4nAQATL63C91gOPOx/w6pzdSvMo3b8d2h8vIWx2lY65cC/pFds bIJw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id b5si2753479pgv.317.2018.02.15.10.22.02; Thu, 15 Feb 2018 10:22:17 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1166274AbeBOSU2 (ORCPT + 99 others); Thu, 15 Feb 2018 13:20:28 -0500 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:53752 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1163438AbeBOSUZ (ORCPT ); Thu, 15 Feb 2018 13:20:25 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 9D8C2402291E; Thu, 15 Feb 2018 18:20:24 +0000 (UTC) Received: from redhat.com (ovpn-121-190.rdu2.redhat.com [10.10.121.190]) by smtp.corp.redhat.com (Postfix) with ESMTP id EB2182026E04; Thu, 15 Feb 2018 18:20:23 +0000 (UTC) Date: Thu, 15 Feb 2018 20:20:23 +0200 From: "Michael S. Tsirkin" To: Marc-Andre Lureau Cc: =?iso-8859-1?Q?Marc-Andr=E9?= Lureau , Linux Kernel Mailing List , Baoquan He , Sergio Lopez Pascual , "Somlo, Gabriel" , xiaolong.ye@intel.com Subject: Re: [PATCH v14 2/9] fw_cfg: add a public uapi header Message-ID: <20180215201547-mutt-send-email-mst@kernel.org> References: <20180214141850.4017-1-marcandre.lureau@redhat.com> <20180214141850.4017-3-marcandre.lureau@redhat.com> <20180214223631-mutt-send-email-mst@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.6]); Thu, 15 Feb 2018 18:20:24 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.6]); Thu, 15 Feb 2018 18:20:24 +0000 (UTC) for IP:'10.11.54.4' DOMAIN:'int-mx04.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'mst@redhat.com' RCPT:'' Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, Feb 15, 2018 at 10:25:27AM +0100, Marc-Andre Lureau wrote: > Hi > > On Wed, Feb 14, 2018 at 9:41 PM, Michael S. Tsirkin wrote: > > On Wed, Feb 14, 2018 at 03:18:43PM +0100, Marc-Andr? Lureau wrote: > >> Create a common header file for well-known values and structures to be > >> shared by the Linux kernel with qemu or other projects. > >> > >> Suggested-by: Michael S. Tsirkin > >> Signed-off-by: Marc-Andr? Lureau > >> > >> --- > >> > >> The related qemu patch making use of it, to be submitted: > >> https://github.com/elmarco/qemu/commit/4884fc9e9c4c4467a371e5a40f3181239e1b70f5 > >> --- > >> MAINTAINERS | 1 + > >> drivers/firmware/qemu_fw_cfg.c | 22 +-------- > >> include/uapi/linux/fw_cfg.h | 102 +++++++++++++++++++++++++++++++++++++++++ > >> 3 files changed, 105 insertions(+), 20 deletions(-) > >> create mode 100644 include/uapi/linux/fw_cfg.h > >> > >> diff --git a/MAINTAINERS b/MAINTAINERS > >> index 3bdc260e36b7..a66b65f62811 100644 > >> --- a/MAINTAINERS > >> +++ b/MAINTAINERS > >> @@ -11352,6 +11352,7 @@ M: "Michael S. Tsirkin" > >> L: qemu-devel@nongnu.org > >> S: Maintained > >> F: drivers/firmware/qemu_fw_cfg.c > >> +F: include/uapi/linux/fw_cfg.h > >> > >> QIB DRIVER > >> M: Dennis Dalessandro > >> diff --git a/drivers/firmware/qemu_fw_cfg.c b/drivers/firmware/qemu_fw_cfg.c > >> index a41b572eeeb1..90f467232777 100644 > >> --- a/drivers/firmware/qemu_fw_cfg.c > >> +++ b/drivers/firmware/qemu_fw_cfg.c > >> @@ -32,30 +32,12 @@ > >> #include > >> #include > >> #include > >> +#include > >> > >> MODULE_AUTHOR("Gabriel L. Somlo "); > >> MODULE_DESCRIPTION("QEMU fw_cfg sysfs support"); > >> MODULE_LICENSE("GPL"); > >> > >> -/* selector key values for "well-known" fw_cfg entries */ > >> -#define FW_CFG_SIGNATURE 0x00 > >> -#define FW_CFG_ID 0x01 > >> -#define FW_CFG_FILE_DIR 0x19 > >> - > >> -/* size in bytes of fw_cfg signature */ > >> -#define FW_CFG_SIG_SIZE 4 > >> - > >> -/* fw_cfg "file name" is up to 56 characters (including terminating nul) */ > >> -#define FW_CFG_MAX_FILE_PATH 56 > >> - > >> -/* fw_cfg file directory entry type */ > >> -struct fw_cfg_file { > >> - u32 size; > >> - u16 select; > >> - u16 reserved; > >> - char name[FW_CFG_MAX_FILE_PATH]; > >> -}; > >> - > >> /* fw_cfg device i/o register addresses */ > >> static bool fw_cfg_is_mmio; > >> static phys_addr_t fw_cfg_p_base; > >> @@ -597,7 +579,7 @@ MODULE_DEVICE_TABLE(of, fw_cfg_sysfs_mmio_match); > >> > >> #ifdef CONFIG_ACPI > >> static const struct acpi_device_id fw_cfg_sysfs_acpi_match[] = { > >> - { "QEMU0002", }, > >> + { FW_CFG_ACPI_DEVICE_ID, }, > >> {}, > >> }; > >> MODULE_DEVICE_TABLE(acpi, fw_cfg_sysfs_acpi_match); > >> diff --git a/include/uapi/linux/fw_cfg.h b/include/uapi/linux/fw_cfg.h > >> new file mode 100644 > >> index 000000000000..5b8136ce46ee > >> --- /dev/null > >> +++ b/include/uapi/linux/fw_cfg.h > >> @@ -0,0 +1,102 @@ > >> +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > >> +#ifndef _LINUX_FW_CFG_H > >> +#define _LINUX_FW_CFG_H > >> + > >> +#include > >> + > >> +#define FW_CFG_ACPI_DEVICE_ID "QEMU0002" > >> + > >> +/* selector key values for "well-known" fw_cfg entries */ > >> +#define FW_CFG_SIGNATURE 0x00 > >> +#define FW_CFG_ID 0x01 > >> +#define FW_CFG_UUID 0x02 > >> +#define FW_CFG_RAM_SIZE 0x03 > >> +#define FW_CFG_NOGRAPHIC 0x04 > >> +#define FW_CFG_NB_CPUS 0x05 > >> +#define FW_CFG_MACHINE_ID 0x06 > >> +#define FW_CFG_KERNEL_ADDR 0x07 > >> +#define FW_CFG_KERNEL_SIZE 0x08 > >> +#define FW_CFG_KERNEL_CMDLINE 0x09 > >> +#define FW_CFG_INITRD_ADDR 0x0a > >> +#define FW_CFG_INITRD_SIZE 0x0b > >> +#define FW_CFG_BOOT_DEVICE 0x0c > >> +#define FW_CFG_NUMA 0x0d > >> +#define FW_CFG_BOOT_MENU 0x0e > >> +#define FW_CFG_MAX_CPUS 0x0f > >> +#define FW_CFG_KERNEL_ENTRY 0x10 > >> +#define FW_CFG_KERNEL_DATA 0x11 > >> +#define FW_CFG_INITRD_DATA 0x12 > >> +#define FW_CFG_CMDLINE_ADDR 0x13 > >> +#define FW_CFG_CMDLINE_SIZE 0x14 > >> +#define FW_CFG_CMDLINE_DATA 0x15 > >> +#define FW_CFG_SETUP_ADDR 0x16 > >> +#define FW_CFG_SETUP_SIZE 0x17 > >> +#define FW_CFG_SETUP_DATA 0x18 > >> +#define FW_CFG_FILE_DIR 0x19 > >> + > >> +#define FW_CFG_FILE_FIRST 0x20 > >> +#define FW_CFG_FILE_SLOTS_MIN 0x10 > >> + > >> +#define FW_CFG_WRITE_CHANNEL 0x4000 > >> +#define FW_CFG_ARCH_LOCAL 0x8000 > >> +#define FW_CFG_ENTRY_MASK (~(FW_CFG_WRITE_CHANNEL | FW_CFG_ARCH_LOCAL)) > >> + > >> +#define FW_CFG_INVALID 0xffff > >> + > >> +/* width in bytes of fw_cfg control register */ > >> +#define FW_CFG_CTL_SIZE 0x02 > >> + > >> +/* fw_cfg "file name" is up to 56 characters (including terminating nul) */ > >> +#define FW_CFG_MAX_FILE_PATH 56 > >> + > >> +/* size in bytes of fw_cfg signature */ > >> +#define FW_CFG_SIG_SIZE 4 > >> + > >> +/* FW_CFG_ID bits */ > >> +#define FW_CFG_VERSION 0x01 > >> +#define FW_CFG_VERSION_DMA 0x02 > >> + > >> +/* fw_cfg file directory entry type */ > >> +struct fw_cfg_file { > >> + __be32 size; /* file size */ > >> + __be16 select; /* write this to 0x510 to read it */ > >> + __u16 reserved; > >> + char name[FW_CFG_MAX_FILE_PATH]; > >> +}; > >> + > >> +struct fw_cfg_files { > >> + __be32 count; /* number of entries */ > >> + struct fw_cfg_file f[]; > >> +}; > > > > This struct wasn't there in the original file. > > Is the source of these structures QEMU or Linux? > > If Linux, then pls split this > > 1. move code out to a header > > 2. add more structs > > It is based from Linux source + qemu docs/specs/fw_cfg.txt which > references include/hw/nvram/fw_cfg_keys.h "for the most up-to-date and > authoritative list" & vmcoreinfo.txt. > > QEMU ./include/hw/nvram/fw_cfg_keys.h doesn't have specific licence > text, and QEMU as a whole is released under the GNU General Public > License, version 2. Yes but it was split off from ./include/hw/nvram/fw_cfg.h so it's a mistake that license was not copied. But I think that for headers BSD is preferrable, and this is exactly the license in QEMU. > Let me know if I still need to change the license and what you > recommend instead. vmcoreinfo as I said should be a separate patch. > > > >> + > >> +/* FW_CFG_DMA_CONTROL bits */ > >> +#define FW_CFG_DMA_CTL_ERROR 0x01 > >> +#define FW_CFG_DMA_CTL_READ 0x02 > >> +#define FW_CFG_DMA_CTL_SKIP 0x04 > >> +#define FW_CFG_DMA_CTL_SELECT 0x08 > >> +#define FW_CFG_DMA_CTL_WRITE 0x10 > >> + > >> +#define FW_CFG_DMA_SIGNATURE 0x51454d5520434647ULL /* "QEMU CFG" */ > >> + > >> +/* Control as first field allows for different structures selected by this > >> + * field, which might be useful in the future > >> + */ > >> +struct fw_cfg_dma_access { > >> + __be32 control; > >> + __be32 length; > >> + __be64 address; > >> +}; > > > > Maybe this should be part of the dma patch. > > I prefer to introduce all the spec defines in one patch, but I can > split it if it helps. Probably - this way it's a harmless refactor. > > > >> + > >> +#define FW_CFG_VMCOREINFO_FILENAME "etc/vmcoreinfo" > >> + > >> +#define FW_CFG_VMCOREINFO_FORMAT_NONE 0x0 > >> +#define FW_CFG_VMCOREINFO_FORMAT_ELF 0x1 > >> + > >> +struct fw_cfg_vmcoreinfo { > >> + __le16 host_format; > >> + __le16 guest_format; > >> + __le32 size; > >> + __le64 paddr; > >> +}; > > > > Maybe this should be part of the vmcore patch. > > same > > > Thanks