Received: by 10.223.185.116 with SMTP id b49csp2373165wrg; Thu, 15 Feb 2018 10:35:25 -0800 (PST) X-Google-Smtp-Source: AH8x226CLdynIrBCBReJxPNfzV3W0yLfRm2GkXR1fcghn6jwlWetDaR78lrXSIxzLLCDHr79sI2N X-Received: by 2002:a17:902:b081:: with SMTP id p1-v6mr3313739plr.314.1518719725825; Thu, 15 Feb 2018 10:35:25 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1518719725; cv=none; d=google.com; s=arc-20160816; b=ohxyX8EFo+1j6xL9HGKktP9nT2Md7bExKro2tmpKxO76yOWN47y8AoLFK4HEUMSjpv VnXBWuqtvcdBd8xSgTQtnfEurIcyRoA4y8cZAknC6ZpffkseukuYkW2Xe4zqMwhuvNuJ 2PfBit6rh8IBzci6RPrD6YpkY3lfH3s+lQqLWA89ti7/AWt+sjfa0YH5QtNd8SeWvY+n i7sc0/uWN2JUSvfRx39wCDiLlgjmeH0WvLDyXGvze8ZMQwxy0I1/8TdueQ49pdc2Ihui 3Q8bU3zW4MI0J2l5zL2hOx21Id7ppztgkSA6JcM5fLZJ/irpvcVlAIgJ2wStIF6/r3dw QczQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:cc:to:subject :message-id:date:from:references:in-reply-to:mime-version :arc-authentication-results; bh=wnqkJSv/bGsZq/kZKvrQvvYii7Q+O2ftW56BCq/vDGE=; b=LapzrTEG+JV+YlIS/pz0tX6R+7/+Iti04tSx1kU4YxG2MG+Yf+vhAvQ8gaFdDjHFB4 fEmzw6akYdwUHTAM0tNZGborrTRLcP4Va1dhSaJ51g+++1JbGcVFF2pFBWSikfzUydH6 8J326iCfKeBa52pDCCleOFP1PyRkYHvUESWaRAKj+PJYW363Us8aWv7VzCaTplGDDTsy 5LIFwmq/ICTKr1WqmsFnyXrL/dJM+bYK6J3Gcr5KTe5NxtnCPWvYdlHDh98S5Y9NAWD1 s+VEnlPz/cgbvDp7MGS7S0HAshO42imGnFzsc8Mtr1KcAsZ8mgQUoSUbDREYfZi4wiRl 6yMA== 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 g9-v6si1915449pli.410.2018.02.15.10.35.11; Thu, 15 Feb 2018 10:35:25 -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 S1166613AbeBOSd6 convert rfc822-to-8bit (ORCPT + 99 others); Thu, 15 Feb 2018 13:33:58 -0500 Received: from mail-qk0-f195.google.com ([209.85.220.195]:34181 "EHLO mail-qk0-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1162960AbeBOSd5 (ORCPT ); Thu, 15 Feb 2018 13:33:57 -0500 Received: by mail-qk0-f195.google.com with SMTP id o7so792282qkc.1 for ; Thu, 15 Feb 2018 10:33:56 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=mFEA0QktkYeDqgfvBFhP3tJIyQBWx0nxH65NkiaaMcE=; b=aMrLv2D9Z7NVwMULjCvyLKmHAp2+WC5FQiDuNyCQNPNDmMIbpzWFUutiiHYWRcLQJ7 mBYRAvNBSAF2hP2V/GA8gDr34XnVd14p6zrPs3IPz8dlgpl2T1KPR2jOqVBHV5sa3ycw t17HrBvhBjk1MlNd9rP69Mep7knsWvjU58GY/YcGK4Xea9nrueSZSkyDfYkak61X1ayW g8DiJgZEJFe4kCJV9gxm3Bo9SvsTZZ9RZkGEh2zH8aovPg9NMr8j/ETYUc01hSlw4F+k 8JpYj2haeiSJszaXKD0BJeGhMtIg9MWweALqIaWhigEtYS2+vHhhY5btQZIxGokh5/U9 hKiw== X-Gm-Message-State: APf1xPDFMRi5siVM3A/SICkri0TO1R0uh8ZkbYeAyxmpIcZhLbopzhcf 0nN8M+uhh1yDeUVgFGC4hte1NMW13USbDwqQ7TWE45O9 X-Received: by 10.55.169.146 with SMTP id s140mr5640223qke.139.1518719636233; Thu, 15 Feb 2018 10:33:56 -0800 (PST) MIME-Version: 1.0 Received: by 10.12.146.213 with HTTP; Thu, 15 Feb 2018 10:33:55 -0800 (PST) In-Reply-To: <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> <20180215201547-mutt-send-email-mst@kernel.org> From: =?UTF-8?B?TWFyYy1BbmRyw6kgTHVyZWF1?= Date: Thu, 15 Feb 2018 19:33:55 +0100 Message-ID: Subject: Re: [PATCH v14 2/9] fw_cfg: add a public uapi header To: "Michael S. Tsirkin" Cc: Linux Kernel Mailing List , Baoquan He , Sergio Lopez Pascual , "Somlo, Gabriel" , xiaolong.ye@intel.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8BIT Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi On Thu, Feb 15, 2018 at 7:20 PM, Michael S. Tsirkin wrote: > 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. So would top comment be fine? /* SPDX-License-Identifier: BSD-3-Clause */ > >> 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. ok > >> > >> >> + >> >> +#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