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 gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 64CA1C7EE39 for ; Sat, 28 Jun 2025 12:51:06 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id DB17810E0CE; Sat, 28 Jun 2025 12:50:59 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.b="O7XFrSC2"; dkim-atps=neutral Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.15]) by gabe.freedesktop.org (Postfix) with ESMTPS id 22C1610E0CE for ; Sat, 28 Jun 2025 12:50:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1751115057; x=1782651057; h=message-id:date:mime-version:subject:to:references:from: in-reply-to:content-transfer-encoding; bh=AtmO1tCgT6Z4STAIR6ODPiJ30eCmBuRwAGErWxvnxiM=; b=O7XFrSC2yLxARn2A4KOKWiKBF6fiKu5RnLCk9Igvyu3J+R5uKttpvcrU x4zvAAmCMBBvjzOcOyOGVkM/x1HrnJTwJeL10KektZR6Mw1p0a4Mcq/+d xE2DIOb5p1B8kNbnlGSZ3yZDz2VilghibnBGOQ/sRshsXzY8gCcBf6vHr leBpMOdA3hRzJ0uh5S0iZ/hNokVLvuwCmfgznXzO+wwagSywD0A4d1aM8 5sp6B/LkhuT+2t82TZGEIHkikxfmbo0CHF92HZ3XB71xSH8Am/cesVOKy X16Tm8WwPy1pcvf9+AfWYne4pOdYIDAdYe39K52aAgOqmb20eF7eTRDte A==; X-CSE-ConnectionGUID: Mqi7Ktt/SPiPwTz5qpkvRw== X-CSE-MsgGUID: FTCAErgMRti4kut40W7KQQ== X-IronPort-AV: E=McAfee;i="6800,10657,11478"; a="57088229" X-IronPort-AV: E=Sophos;i="6.16,273,1744095600"; d="scan'208";a="57088229" Received: from orviesa006.jf.intel.com ([10.64.159.146]) by orvoesa107.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 28 Jun 2025 05:50:56 -0700 X-CSE-ConnectionGUID: ggp4pdjaT563VwPhIlEppA== X-CSE-MsgGUID: 1Ts7CO/rQyC7/sHAMhoS2A== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.16,273,1744095600"; d="scan'208";a="152539197" Received: from irvmail002.ir.intel.com ([10.43.11.120]) by orviesa006.jf.intel.com with ESMTP; 28 Jun 2025 05:50:54 -0700 Received: from [10.245.96.176] (mwajdecz-MOBL.ger.corp.intel.com [10.245.96.176]) by irvmail002.ir.intel.com (Postfix) with ESMTP id 1A7DE12590; Sat, 28 Jun 2025 13:50:53 +0100 (IST) Message-ID: <31161bf0-1b78-44b8-a3d2-9ee83178846c@intel.com> Date: Sat, 28 Jun 2025 14:50:52 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v4 2/6] drm/xe/guc: Add LFD related abi definitions To: Zhanjun Dong , intel-xe@lists.freedesktop.org References: <20250423215821.3078428-1-zhanjun.dong@intel.com> <20250423215821.3078428-3-zhanjun.dong@intel.com> Content-Language: en-US From: Michal Wajdeczko In-Reply-To: <20250423215821.3078428-3-zhanjun.dong@intel.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: intel-xe@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel Xe graphics driver List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-xe-bounces@lists.freedesktop.org Sender: "Intel-xe" On 23.04.2025 23:58, Zhanjun Dong wrote: > Add GuC LFD (Log Format Descriptors) related ABI definitions. > > Signed-off-by: Zhanjun Dong > --- > drivers/gpu/drm/xe/abi/guc_log_lfd_abi.h | 279 +++++++++++++++++++++++ > 1 file changed, 279 insertions(+) > create mode 100644 drivers/gpu/drm/xe/abi/guc_log_lfd_abi.h > > diff --git a/drivers/gpu/drm/xe/abi/guc_log_lfd_abi.h b/drivers/gpu/drm/xe/abi/guc_log_lfd_abi.h > new file mode 100644 > index 000000000000..d7eb207f1560 > --- /dev/null > +++ b/drivers/gpu/drm/xe/abi/guc_log_lfd_abi.h > @@ -0,0 +1,279 @@ > +/* SPDX-License-Identifier: MIT */ > +/* > + * Copyright © 2025 Intel Corporation > + */ > + > +#ifndef _ABI_GUC_LOG_LFD_ABI_H_ > +#define _ABI_GUC_LOG_LFD_ABI_H_ > + > +#include > + > +#include "abi/guc_log_lic_abi.h" > + > +/* Magic keys define */ > +#define LFD_DRIVER_KEY_STREAMING 0x8086AAAA474C5346 > +#define LFD_LOG_BUFFER_MARKER_2 0xDEADFEED > +#define LFD_CRASH_DUMP_BUFFER_MARKER_2 0x8086DEAD > +#define LFD_STATE_CAPTURE_BUFFER_MARKER_2 0xBEEFFEED > +#define LFD_LOG_BUFFER_MARKER_1V2 0xCABBA9E6 > +#define LFD_STATE_CAPTURE_BUFFER_MARKER_1V2 0xCABBA9F7 no GUC prefix (or GUC_LOG prefix as in GUC_LOG_LIC) > +#define GUC_LOGFILE_LFD_HEADER_MAGIC 0x8086 inconsistent prefix > + > +/* The current major version of GuC-Log-File format. */ > +#define GUC_LOG_FILE_FORMAT_VERSION_MAJOR 0x0001 > +/* The current minor version of GuC-Log-File format. */ > +#define GUC_LOG_FILE_FORMAT_VERSION_MINOR 0x0000 shouldn't those names refer somehow to LFD ? better defined as 1u and 0u to avoid errors on 32bit arch > + > +/** enum guc_lfd_type - Log format descriptor type */ > +enum guc_lfd_type { decide whether GuC log definitions will include "log" tag or not: guc_loc_lic guc_log_lfd vs guc_lic guc_lfd > + /** > + * @GUC_LFD_TYPE_FW_REQUIRED_RANGE_START: Start of range for > + * required LFDs from GuC > + */ > + GUC_LFD_TYPE_FW_REQUIRED_RANGE_START = 0x1, > + /** > + * @GUC_LFD_TYPE_FW_VERSION: GuC Firmware Version structure. LFDs > + * payload is guc_lfd_data_fw_version > + */ > + GUC_LFD_TYPE_FW_VERSION = GUC_LOG_LIC_TYPE_GUC_SW_VERSION, > + /** > + * @GUC_LFD_TYPE_GUC_DEVICE_ID: GuC microcontroller device ID. > + * LFDs payload is guc_lfd_data_guc_devid > + */ > + GUC_LFD_TYPE_GUC_DEVICE_ID = GUC_LOG_LIC_TYPE_GUC_DEVICE_ID, > + /** > + * @GUC_LFD_TYPE_TSC_FREQUENCY: Frequency of GuC timestamps. LFDs > + * payload is guc_lfd_data_tsc_freq > + */ > + GUC_LFD_TYPE_TSC_FREQUENCY = GUC_LOG_LIC_TYPE_TSC_FREQUENCY, > + /** > + * @GUC_LFD_TYPE_GMD_ID: HW GMD ID. LFDs payload is > + * guc_lfd_data_gmdid > + */ > + GUC_LFD_TYPE_GMD_ID = GUC_LOG_LIC_TYPE_GMD_ID, > + /** > + * @GUC_LFD_TYPE_BUILD_PLATFORM_ID: GuC build platform ID. LFDs > + * payload is guc_lfd_data_build_platformid > + */ > + GUC_LFD_TYPE_BUILD_PLATFORM_ID = GUC_LOG_LIC_TYPE_BUILD_PLATFORM_ID, > + /** @GUC_LFD_TYPE_FW_REQUIRED_RANGE_END: End of this range */ > + GUC_LFD_TYPE_FW_REQUIRED_RANGE_END = 0x1FFF, > + /** > + * @GUC_LFD_TYPE_FW_OPTIONAL_RANGE_START: Start of range for > + * required LFDs from GuC > + */ > + GUC_LFD_TYPE_FW_OPTIONAL_RANGE_START = 0x2000, > + /** > + * @GUC_LFD_TYPE_LOG_EVENTS_BUFFER: Log-event-entries buffer. LFDs > + * payload is guc_lfd_data_log_events_buf > + */ > + GUC_LFD_TYPE_LOG_EVENTS_BUFFER = 0x2000, > + /** > + * @GUC_LFD_TYPE_FW_CRASH_DUMP: GuC generated crash-dump blob. > + * LFDs payload is guc_lfd_data_fw_crashdump > + */ > + GUC_LFD_TYPE_FW_CRASH_DUMP = 0x2001, > + /** @GUC_LFD_TYPE_FW_OPTIONAL_RANGE_END: End of this range */ > + GUC_LFD_TYPE_FW_OPTIONAL_RANGE_END = 0x3FFF, > + /** > + * @GUC_LFD_TYPE_KMD_REQUIRED_RANGE_START: Start of range for > + * required KMD LFDs > + */ > + GUC_LFD_TYPE_KMD_REQUIRED_RANGE_START = 0x4000, > + /** > + * @GUC_LFD_TYPE_OS_ID: An identifier for the OS. LFDs payload is > + * guc_lfd_data_os_id > + */ > + GUC_LFD_TYPE_OS_ID = 0x4000, > + /** @GUC_LFD_TYPE_KMD_REQUIRED_RANGE_END: End of this range */ > + GUC_LFD_TYPE_KMD_REQUIRED_RANGE_END = 0x5FFF, > + /** > + * @GUC_LFD_TYPE_KMD_OPTIONAL_RANGE_START: Start of range for > + * optional KMD LFDs > + */ > + GUC_LFD_TYPE_KMD_OPTIONAL_RANGE_START = 0x6000, > + /** > + * @GUC_LFD_TYPE_BINARY_SCHEMA_FORMAT: Binary representation of > + * GuC log-events schema. LFDs TLV payload is > + * guc_lfd_data_binary_schema > + */ > + GUC_LFD_TYPE_BINARY_SCHEMA_FORMAT = 0x6000, > + /** > + * @GUC_LFD_TYPE_HOST_COMMENT: ASCII string containing comments > + * from the host/KMD. LFDs TLV payload is > + * guc_lfd_data_host_comment > + */ > + GUC_LFD_TYPE_HOST_COMMENT = 0x6001, > + /** @GUC_LFD_TYPE_KMD_OPTIONAL_RANGE_END: End of this range */ > + GUC_LFD_TYPE_KMD_OPTIONAL_RANGE_END = 0x7FFF, > + /** @GUC_LFD_TYPE_RESERVED_RANGE_START: Start of reserved range */ > + GUC_LFD_TYPE_RESERVED_RANGE_START = 0x8000, > + /** @GUC_LFD_TYPE_RESERVED_RANGE_END: End of this range */ > + GUC_LFD_TYPE_RESERVED_RANGE_END = 0xFFFF, > +}; > + > +/** enum guc_lfd_os_type - OS Type LFD-ID */ > +enum guc_lfd_os_type { > + /** @GUC_LFD_OS_TYPE_OSID_WIN: Windows OS */ > + GUC_LFD_OS_TYPE_OSID_WIN = 0x1, > + /** @GUC_LFD_OS_TYPE_OSID_LIN: Linux OS */ > + GUC_LFD_OS_TYPE_OSID_LIN = 0x2, > + /** @GUC_LFD_OS_TYPE_OSID_VMW: VMWare OS */ > + GUC_LFD_OS_TYPE_OSID_VMW = 0x3, > + /** @GUC_LFD_OS_TYPE_OSID_OTHER: Other */ > + GUC_LFD_OS_TYPE_OSID_OTHER = 0x4, > +}; > + > +/** > + * struct guc_logfile_lfd_data - Log format descriptor (LFD). > + * A type of KLV with custom field-sizes + magic numbers. > + */ > +struct guc_logfile_lfd_data { guc_log_lfd_header ? > + /** @dw0: A 32 bits dword, contains multiple bit fields */ > + u32 dw0; > + /* Expected value: 0x8086. Helpful in detecting file errors. */ > +#define GUC_LOGFILE_LFD_MAGIC GENMASK(15, 0) > + /* > + * File descriptor type (the 'T' in TLV) is used to identify how > + * to interpret `data` below. For the range of types, see > + * guc_lfd_type > + */ > +#define GUC_LOGFILE_LFD_DESC_TYPE GENMASK(31, 16) > + /** @desc_dw_size: Number of dwords the `data` field contains. */ > + u32 desc_dw_size; just 'dw_size' like in LIC, or maybe just 'size' ? > + /** @data: Data defined by File descriptor type. */ > + u32 data[] __counted_by(desc_dw_size); > +} __packed; > + > +/** > + * struct guc_logfile_fmt_ver - GuC Log File Format Version. > + * Major-Minor is not a fractional number (i.e. Ver 1.3 would be older > + * than 1.12) > + */ > +struct guc_logfile_fmt_ver { guc_log_lfd_version > + /** @dw0: A 32 bits dword, contains multiple bit fields */ > + u32 dw0; > + /* > + * Guc-Log-File Format minor version. Must be > + * GUC_LOG_FILE_FORMAT_VERSION_MINOR > + */ > +#define GUC_LOGFILE_FMT_VER_MINOR_VERSION GENMASK(15, 0) > + /* > + * Guc-Log-File Format major version. Must be > + * GUC_LOG_FILE_FORMAT_VERSION_MAJOR > + */ > +#define GUC_LOGFILE_FMT_VER_MAJOR_VERSION GENMASK(31, 16) > +} __packed; > + > +/** > + * struct guc_lfd_data_guc_devid - GuC Device ID. > + * This is mandatory fw LFD data > + */ > +struct guc_lfd_data_guc_devid { > + /** > + * @guc_devid: GuC microcontroller device ID defined as described > + * in GUC_LOG_LIC_TYPE_GUC_DEVICE_ID > + */ > + u32 guc_devid; > +} __packed; > + > +/** > + * struct guc_lfd_data_tsc_freq - GuC TSC Fequency. > + * This is mandatory fw LFD data > + */ > +struct guc_lfd_data_tsc_freq { > + /** > + * @tsc_freq: GuC timestamp counter frequency as described in > + * GUC_LOG_LIC_TYPE_TSC_FREQUENCY > + */ > + u32 tsc_freq; > +} __packed; > + > +/** struct guc_lfd_data_gmdid - GMD ID. */ > +struct guc_lfd_data_gmdid { > + /** @gmd_id: GMD ID as described in GUC_LOG_LIC_TYPE_GMD_ID */ > + u32 gmd_id; > +} __packed; > + > +/** struct guc_lfd_data_build_platformid - GuC build platform ID. */ > +struct guc_lfd_data_build_platformid { > + /** > + * @platform_build_id: GuC build platform ID as described in > + * GUC_LOG_LIC_TYPE_BUILD_PLATFORM_ID > + */ > + u32 platform_build_id; > +} __packed; > + > +/** > + * struct guc_lfd_data_log_events_buf - GuC Log Events Buffer. > + * This is optional fw LFD data > + */ > +struct guc_lfd_data_log_events_buf { > + /** > + * @log_events_format_version: version of GuC log format of buffer > + */ > + u32 log_events_format_version; > + /** > + * @log_format_buf: If `log_format_version` == 1, array of > + * guc_log_format_version_1. If `log_format_version` == 2, array > + * of guc_log_format_version_2. Dword size determined by > + * guc_logfile_lfd.`desc_dw_size` - 1 > + */ > + u32 log_format_buf[]; > +} __packed; > + > +/** > + * struct guc_lfd_data_os_id - OS Version Information. > + * This is mandatory host LFD data > + */ > +struct guc_lfd_data_os_id { guc_lfd_data_os_info > + /** > + * @os_id: enum values to identify the OS brand (1=Windows, > + * 2=Linux, etc..). See guc_lfd_os_type for the range of types > + */ > + u32 os_id; > + /** > + * @build_version: ASCII string containing OS build version > + * information based on os_id. String is padded with null > + * characters to ensure its DWORD aligned. Dword size determined > + * by guc_logfile_lfd.`desc_dw_size` - 1 > + */ > + char build_version[]; > +} __packed; > + > +/** > + * struct guc_lfd_data_fw_version - GuC FW Version. > + * This is mandatory fw LFD data > + */ > +struct guc_lfd_data_fw_version { > + /** > + * @guc_sw_version: The full version of the GuC microkernel that > + * generated the logs as described in > + * GUC_LOG_LIC_TYPE_GUC_SW_VERSION. > + */ > + struct guc_sw_version guc_sw_version; > +} __packed; > + > +/** > + * struct guc_logfile_header - Header of GuC Log Streaming-LFD-File Format. > + * This structure encapsulates the layout of the guc-log-file format > + */ > +struct guc_logfile_header { guc_log_lfd_buffer (like in LIC) > + /** > + * @magic: A magic number set by producer of a GuC log file to > + * identify that file is a valid guc-log-file containing a stream > + * of LFDs: Expected value: 0x8086AAAA474C5346. > + */ > + u64 magic; > + /** > + * @version: Version of this file format layout as per > + * guc_logfile_fmt_ver > + */ > + struct guc_logfile_fmt_ver version; > + /** > + * @lfd_stream: A stream of one or more guc_logfile_lfd LFD data > + */ > + struct guc_logfile_lfd_data lfd_stream; just 'data' and [] to show it is open-ended? > +} __packed; > + > +#endif