drm/xe: Document nested struct members according to guidelines
Subsystems (2)
Thomas Hellström
maintainerPATCH 1/1 drm/xe: Document nested struct members according to guidelines
Document nested struct members with full names as described in Documentation/doc-guide/kernel-doc.rst.
For this documentation we allow a column with of to make it more readable.
This fixes warnings similar to:drivers/gpu/drm/xe/xe_lrc_types.h:45: warning: Excess struct member 'size' description in 'xe_lrc'
--- drivers/gpu/drm/xe/xe_device_types.h | 161 ++++++++++++----------- drivers/gpu/drm/xe/xe_exec_queue_types.h | 36 ++--- drivers/gpu/drm/xe/xe_gsc_types.h | 16 +-- drivers/gpu/drm/xe/xe_gt_types.h | 99 +++++++------- drivers/gpu/drm/xe/xe_guc_ct_types.h | 4 +- drivers/gpu/drm/xe/xe_guc_submit_types.h | 18 +-- drivers/gpu/drm/xe/xe_guc_types.h | 28 ++-- drivers/gpu/drm/xe/xe_hw_engine_types.h | 70 +++++----- drivers/gpu/drm/xe/xe_lrc_types.h | 6 +- drivers/gpu/drm/xe/xe_sched_job_types.h | 6 +- drivers/gpu/drm/xe/xe_uc_fw_types.h | 9 +- drivers/gpu/drm/xe/xe_wopcm_types.h | 4 +- 12 files changed, 233 insertions(+), 224 deletions(-)
drivers/gpu/drm/xe/xe_device_types.h +83 -78
@@ -143,10 +143,10 @@ struct xe_tile {* * 8MB-16MB: global GTT */ struct { -/** @size: size of tile's MMIO space */ +/** @mmio.size: size of tile's MMIO space */ size_t size; -/** @regs: pointer to tile's MMIO space (starting with registers) */ +/** @mmio.regs: pointer to tile's MMIO space (starting with registers) */ void __iomem *regs; } mmio;
@@ -156,31 +156,31 @@ struct xe_tile {* Each tile has its own additional 256MB (28-bit) MMIO-extension space. */ struct { -/** @size: size of tile's additional MMIO-extension space */ +/** @mmio_ext.size: size of tile's additional MMIO-extension space */ size_t size; -/** @regs: pointer to tile's additional MMIO-extension space */ +/** @mmio_ext.regs: pointer to tile's additional MMIO-extension space */ void __iomem *regs; } mmio_ext;/** @mem: memory management info for tile */ struct {/** -* @vram: VRAM info for tile. +* @mem.vram: VRAM info for tile. * * Although VRAM is associated with a specific tile, it can * still be accessed by all tiles' GTs. */ struct xe_mem_region vram; -/** @vram_mgr: VRAM TTM manager */ +/** @mem.vram_mgr: VRAM TTM manager */ struct xe_ttm_vram_mgr *vram_mgr; -/** @ggtt: Global graphics translation table */ +/** @mem.ggtt: Global graphics translation table */ struct xe_ggtt *ggtt;/** -* @kernel_bb_pool: Pool from which batchbuffers are allocated. +* @mem.kernel_bb_pool: Pool from which batchbuffers are allocated. * * Media GT shares a pool with its primary GT. */
@@ -218,68 +218,68 @@ struct xe_device {/** @info: device info */ struct intel_device_info { -/** @graphics_name: graphics IP name */ +/** @info.graphics_name: graphics IP name */ const char *graphics_name; -/** @media_name: media IP name */ +/** @info.media_name: media IP name */ const char *media_name; -/** @tile_mmio_ext_size: size of MMIO extension space, per-tile */ +/** @info.tile_mmio_ext_size: size of MMIO extension space, per-tile */ u32 tile_mmio_ext_size; -/** @graphics_verx100: graphics IP version */ +/** @info.graphics_verx100: graphics IP version */ u32 graphics_verx100; -/** @media_verx100: media IP version */ +/** @info.media_verx100: media IP version */ u32 media_verx100; -/** @mem_region_mask: mask of valid memory regions */ +/** @info.mem_region_mask: mask of valid memory regions */ u32 mem_region_mask; -/** @platform: XE platform enum */ +/** @info.platform: XE platform enum */ enum xe_platform platform; -/** @subplatform: XE subplatform enum */ +/** @info.subplatform: XE subplatform enum */ enum xe_subplatform subplatform; -/** @devid: device ID */ +/** @info.devid: device ID */ u16 devid; -/** @revid: device revision */ +/** @info.revid: device revision */ u8 revid; -/** @step: stepping information for each IP */ +/** @info.step: stepping information for each IP */ struct xe_step_info step; -/** @dma_mask_size: DMA address bits */ +/** @info.dma_mask_size: DMA address bits */ u8 dma_mask_size; -/** @vram_flags: Vram flags */ +/** @info.vram_flags: Vram flags */ u8 vram_flags; -/** @tile_count: Number of tiles */ +/** @info.tile_count: Number of tiles */ u8 tile_count; -/** @gt_count: Total number of GTs for entire device */ +/** @info.gt_count: Total number of GTs for entire device */ u8 gt_count; -/** @vm_max_level: Max VM level */ +/** @info.vm_max_level: Max VM level */ u8 vm_max_level; -/** @va_bits: Maximum bits of a virtual address */ +/** @info.va_bits: Maximum bits of a virtual address */ u8 va_bits; -/** @is_dgfx: is discrete device */ +/** @info.is_dgfx: is discrete device */ u8 is_dgfx:1 ; -/** @has_asid: Has address space ID */ +/** @info.has_asid: Has address space ID */ u8 has_asid:1 ; -/** @force_execlist: Forced execlist submission */ +/** @info.force_execlist: Forced execlist submission */ u8 force_execlist:1 ; -/** @has_flat_ccs: Whether flat CCS metadata is used */ +/** @info.has_flat_ccs: Whether flat CCS metadata is used */ u8 has_flat_ccs:1 ; -/** @has_llc: Device has a shared CPU+GPU last level cache */ +/** @info.has_llc: Device has a shared CPU+GPU last level cache */ u8 has_llc:1 ; -/** @has_mmio_ext: Device has extra MMIO address range */ +/** @info.has_mmio_ext: Device has extra MMIO address range */ u8 has_mmio_ext:1 ; -/** @has_range_tlb_invalidation: Has range based TLB invalidations */ +/** @info.has_range_tlb_invalidation: Has range based TLB invalidations */ u8 has_range_tlb_invalidation:1 ; -/** @has_sriov: Supports SR-IOV */ +/** @info.has_sriov: Supports SR-IOV */ u8 has_sriov:1 ; -/** @has_usm: Device has unified shared memory support */ +/** @info.has_usm: Device has unified shared memory support */ u8 has_usm:1 ; -/** @enable_display: display enabled */ +/** @info.enable_display: display enabled */ u8 enable_display:1 ; -/** @skip_mtcfg: skip Multi-Tile configuration from MTCFG register */ +/** @info.skip_mtcfg: skip Multi-Tile configuration from MTCFG register */ u8 skip_mtcfg:1 ; -/** @skip_pcode: skip access to PCODE uC */ +/** @info.skip_pcode: skip access to PCODE uC */ u8 skip_pcode:1 ; -/** @has_heci_gscfi: device has heci gscfi */ +/** @info.has_heci_gscfi: device has heci gscfi */ u8 has_heci_gscfi:1 ; -/** @skip_guc_pc: Skip GuC based PM feature init */ +/** @info.skip_guc_pc: Skip GuC based PM feature init */ u8 skip_guc_pc:1 ;#if IS_ENABLED (CONFIG_DRM_XE_DISPLAY )
@@ -291,10 +291,10 @@ struct xe_device {/** @irq: device interrupt state */ struct { -/** @lock: lock for processing irq's on this device */ +/** @irq.lock: lock for processing irq's on this device */ spinlock_t lock; -/** @enabled: interrupts enabled on this device */ +/** @irq.enabled: interrupts enabled on this device */ bool enabled; } irq;
@@ -303,17 +303,17 @@ struct xe_device {/** @mmio: mmio info for device */ struct { -/** @size: size of MMIO space for device */ +/** @mmio.size: size of MMIO space for device */ size_t size; -/** @regs: pointer to MMIO space for device */ +/** @mmio.regs: pointer to MMIO space for device */ void __iomem *regs; } mmio;/** @mem: memory info for device */ struct { -/** @vram: VRAM info for device */ +/** @mem.vram: VRAM info for device */ struct xe_mem_region vram; -/** @sys_mgr: system TTM manager */ +/** @mem.sys_mgr: system TTM manager */ struct ttm_resource_manager sys_mgr; } mem;
@@ -327,44 +327,44 @@ struct xe_device {/** @clients: drm clients info */ struct { -/** @lock: Protects drm clients info */ +/** @clients.lock: Protects drm clients info */ spinlock_t lock; -/** @count: number of drm clients */ +/** @clients.count: number of drm clients */ u64 count; } clients;/** @usm: unified memory state */ struct { -/** @asid: convert a ASID to VM */ +/** @usm.asid: convert a ASID to VM */ struct xarray asid_to_vm; -/** @next_asid: next ASID, used to cyclical alloc asids */ +/** @usm.next_asid: next ASID, used to cyclical alloc asids */ u32 next_asid; -/** @num_vm_in_fault_mode: number of VM in fault mode */ +/** @usm.num_vm_in_fault_mode: number of VM in fault mode */ u32 num_vm_in_fault_mode; -/** @num_vm_in_non_fault_mode: number of VM in non-fault mode */ +/** @usm.num_vm_in_non_fault_mode: number of VM in non-fault mode */ u32 num_vm_in_non_fault_mode; -/** @lock: protects UM state */ +/** @usm.lock: protects UM state */ struct mutex lock; } usm;/** @persistent_engines: engines that are closed but still running */ struct { -/** @lock: protects persistent engines */ +/** @persistent_engines.lock: protects persistent engines */ struct mutex lock; -/** @list: list of persistent engines */ +/** @persistent_engines.list: list of persistent engines */ struct list_head list; } persistent_engines;/** @pinned: pinned BO state */ struct { -/** @lock: protected pinned BO list state */ +/** @pinned.lock: protected pinned BO list state */ spinlock_t lock; -/** @evicted: pinned kernel BO that are present */ +/** @pinned.kernel_bo_present: pinned kernel BO that are present */ struct list_head kernel_bo_present; -/** @evicted: pinned BO that have been evicted */ +/** @pinned.evicted: pinned BO that have been evicted */ struct list_head evicted; -/** @external_vram: pinned external BO in vram*/ +/** @pinned.external_vram: pinned external BO in vram*/ struct list_head external_vram; } pinned;
@@ -385,21 +385,26 @@ struct xe_device {* triggering additional actions when they occur. */ struct { -/** @ref: ref count of memory accesses */ -atomic_t ref; +/** @mem_access.ref: ref count of memory accesses */ + atomic_t mem_access.ref; -/** @vram_userfault: Encapsulate vram_userfault related stuff */ +/** +* @mem_access.vram_userfault: Encapsulate vram_userfault +* related stuff +*/ struct {/** -* @lock: Protects access to @vram_usefault.list -* Using mutex instead of spinlock as lock is applied to entire -* list operation which may sleep +* @mem_access.vram_userfault.lock: Protects access to +* @vram_usefault.list Using mutex instead of spinlock +* as lock is applied to entire list operation which +* may sleep */ struct mutex lock;/** -* @list: Keep list of userfaulted vram bo, which require to release their -* mmap mappings at runtime suspend path +* @mem_access.vram_userfault.list: Keep list of userfaulted +* vram bo, which require to release their mmap mappings +* at runtime suspend path */ struct list_head list; } vram_userfault;
@@ -409,28 +414,28 @@ struct xe_device {* @pat: Encapsulate PAT related stuff */ struct { -/** Internal operations to abstract platforms */ +/** @pat.ops: Internal operations to abstract platforms */ const struct xe_pat_ops *ops; -/** PAT table to program in the HW */ +/** @pat.table: PAT table to program in the HW */ const struct xe_pat_table_entry *table; -/** Number of PAT entries */ +/** @pat.n_entries: Number of PAT entries */ int n_entries;u32 idx[__XE_CACHE_LEVEL_COUNT]; } pat;/** @d3cold: Encapsulate d3cold related stuff */ struct { -/** capable: Indicates if root port is d3cold capable */ +/** @d3cold.capable: Indicates if root port is d3cold capable */ bool capable; -/** @allowed: Indicates if d3cold is a valid device state */ +/** @d3cold.allowed: Indicates if d3cold is a valid device state */ bool allowed; -/** @power_lost: Indicates if card has really lost power. */ +/** @d3cold.power_lost: Indicates if card has really lost power. */ bool power_lost;/** -* @vram_threshold: +* @d3cold.vram_threshold: * * This represents the permissible threshold(in megabytes) * for vram save/restore. d3cold will be disallowed,
@@ -439,7 +444,7 @@ struct xe_device {* Default threshold value is 300mb. */ u32 vram_threshold; -/** @lock: protect vram_threshold */ +/** @d3cold.lock: protect vram_threshold */ struct mutex lock; } d3cold;
@@ -547,17 +552,17 @@ struct xe_file {/** @vm: VM state for file */ struct { -/** @xe: xarray to store VMs */ +/** @vm.xe: xarray to store VMs */ struct xarray xa; -/** @lock: protects file VM state */ +/** @vm.lock: protects file VM state */ struct mutex lock; } vm;/** @exec_queue: Submission exec queue state for file */ struct { -/** @xe: xarray to store engines */ +/** @exec_queue.xe: xarray to store engines */ struct xarray xa; -/** @lock: protects file engine state */ +/** @exec_queue.lock: protects file engine state */ struct mutex lock; } exec_queue;
drivers/gpu/drm/xe/xe_exec_queue_types.h +18 -18
@@ -109,9 +109,9 @@ struct xe_exec_queue {* @persistent: persistent exec queue state */ struct { -/** @xef: file which this exec queue belongs to */ +/** @persistent.xef: file which this exec queue belongs to */ struct xe_file *xef; -/** @link: link in list of persistent exec queues */ +/** @persisiten.link: link in list of persistent exec queues */ struct list_head link; } persistent;
@@ -120,55 +120,55 @@ struct xe_exec_queue {* @parallel: parallel submission state */ struct { -/** @composite_fence_ctx: context composite fence */ +/** @parallel.composite_fence_ctx: context composite fence */ u64 composite_fence_ctx; -/** @composite_fence_seqno: seqno for composite fence */ +/** @parallel.composite_fence_seqno: seqno for composite fence */ u32 composite_fence_seqno; } parallel;/** * @bind: bind submission state */ struct { -/** @fence_ctx: context bind fence */ +/** @bind.fence_ctx: context bind fence */ u64 fence_ctx; -/** @fence_seqno: seqno for bind fence */ +/** @bind.fence_seqno: seqno for bind fence */ u32 fence_seqno; } bind; };/** @sched_props: scheduling properties */ struct { -/** @timeslice_us: timeslice period in micro-seconds */ +/** @sched_props.timeslice_us: timeslice period in micro-seconds */ u32 timeslice_us; -/** @preempt_timeout_us: preemption timeout in micro-seconds */ +/** @sched_props.preempt_timeout_us: preemption timeout in micro-seconds */ u32 preempt_timeout_us; -/** @job_timeout_ms: job timeout in milliseconds */ +/** @sched_props.job_timeout_ms: job timeout in milliseconds */ u32 job_timeout_ms; -/** @priority: priority of this exec queue */ +/** @sched_props.priority: priority of this exec queue */ enum xe_exec_queue_priority priority; } sched_props;/** @compute: compute exec queue state */ struct { -/** @pfence: preemption fence */ +/** @compute.pfence: preemption fence */ struct dma_fence *pfence; -/** @context: preemption fence context */ +/** @compute.context: preemption fence context */ u64 context; -/** @seqno: preemption fence seqno */ +/** @compute.seqno: preemption fence seqno */ u32 seqno; -/** @link: link into VM's list of exec queues */ +/** @compute.link: link into VM's list of exec queues */ struct list_head link; -/** @lock: preemption fences lock */ +/** @compute.lock: preemption fences lock */ spinlock_t lock; } compute;/** @usm: unified shared memory state */ struct { -/** @acc_trigger: access counter trigger */ +/** @usm.acc_trigger: access counter trigger */ u32 acc_trigger; -/** @acc_notify: access counter notify */ +/** @usm.acc_notify: access counter notify */ u32 acc_notify; -/** @acc_granularity: access counter granularity */ +/** @usm.acc_granularity: access counter granularity */ u32 acc_granularity; } usm;
drivers/gpu/drm/xe/xe_gsc_types.h +8 -8
@@ -50,21 +50,21 @@ struct xe_gsc {/** @proxy: sub-structure containing the SW proxy-related variables */ struct { -/** @component: struct for communication with mei component */ +/** @proxy.component: struct for communication with mei component */ struct i915_gsc_proxy_component *component; -/** @mutex: protects the component binding and usage */ +/** @proxy.mutex: protects the component binding and usage */ struct mutex mutex; -/** @component_added: whether the component has been added */ +/** @proxy.component_added: whether the component has been added */ bool component_added; -/** @bo: object to store message to and from the GSC */ +/** @proxy.bo: object to store message to and from the GSC */ struct xe_bo *bo; -/** @to_gsc: map of the memory used to send messages to the GSC */ +/** @proxy.to_gsc: map of the memory used to send messages to the GSC */ struct iosys_map to_gsc; -/** @from_gsc: map of the memory used to recv messages from the GSC */ +/** @proxy.from_gsc: map of the memory used to recv messages from the GSC */ struct iosys_map from_gsc; -/** @to_csme: pointer to the memory used to send messages to CSME */ +/** @proxy.to_csme: pointer to the memory used to send messages to CSME */ void *to_csme; -/** @from_csme: pointer to the memory used to recv messages from CSME */ +/** @proxy.from_csme: pointer to the memory used to recv messages from CSME */ void *from_csme; } proxy; };
drivers/gpu/drm/xe/xe_gt_types.h +50 -49
249 lines not on this page · raw message
drivers/gpu/drm/xe/xe_guc_ct_types.h +2 -2
@@ -87,9 +87,9 @@ struct xe_guc_ct {spinlock_t fast_lock;/** @ctbs: buffers for sending and receiving commands */ struct { -/** @send: Host to GuC (H2G, send) channel */ +/** @ctbs.send: Host to GuC (H2G, send) channel */ struct guc_ctb h2g; -/** @recv: GuC to Host (G2H, receive) channel */ +/** @ctbs.recv: GuC to Host (G2H, receive) channel */ struct guc_ctb g2h; } ctbs;/** @g2h_outstanding: number of outstanding G2H */
drivers/gpu/drm/xe/xe_guc_submit_types.h +9 -9
@@ -102,9 +102,9 @@ struct xe_guc_submit_exec_queue_snapshot {/** @sched_props: scheduling properties */ struct { -/** @timeslice_us: timeslice period in micro-seconds */ +/** @sched_props.timeslice_us: timeslice period in micro-seconds */ u32 timeslice_us; -/** @preempt_timeout_us: preemption timeout in micro-seconds */ +/** @sched_props.preempt_timeout_us: preemption timeout in micro-seconds */ u32 preempt_timeout_us; } sched_props;
@@ -118,11 +118,11 @@ struct xe_guc_submit_exec_queue_snapshot {/** @guc: GuC Engine Snapshot */ struct { -/** @wqi_head: work queue item head */ +/** @guc.wqi_head: work queue item head */ u32 wqi_head; -/** @wqi_tail: work queue item tail */ +/** @guc.wqi_tail: work queue item tail */ u32 wqi_tail; -/** @id: GuC id for this exec_queue */ +/** @guc.id: GuC id for this exec_queue */ u16 id; } guc;
@@ -133,13 +133,13 @@ struct xe_guc_submit_exec_queue_snapshot {bool parallel_execution;/** @parallel: snapshot of the useful parallel scratch */ struct { -/** @wq_desc: Workqueue description */ +/** @parallel.wq_desc: Workqueue description */ struct { -/** @head: Workqueue Head */ +/** @parallel.wq_desc.head: Workqueue Head */ u32 head; -/** @tail: Workqueue Tail */ +/** @parallel.wq_desc.tail: Workqueue Tail */ u32 tail; -/** @status: Workqueue Status */ +/** @parallel.wq_desc.status: Workqueue Status */ u32 status; } wq_desc;/** @wq: Workqueue Items */
drivers/gpu/drm/xe/xe_guc_types.h +14 -14
@@ -49,40 +49,40 @@ struct xe_guc {struct xe_guc_db_mgr dbm;/** @submission_state: GuC submission state */ struct { -/** @exec_queue_lookup: Lookup an xe_engine from guc_id */ +/** @submission_state.exec_queue_lookup: Lookup an xe_engine from guc_id */ struct xarray exec_queue_lookup; -/** @guc_ids: used to allocate new guc_ids, single-lrc */ +/** @submission_state.guc_ids: used to allocate new guc_ids, single-lrc */ struct ida guc_ids; -/** @guc_ids_bitmap: used to allocate new guc_ids, multi-lrc */ +/** @submission_state.guc_ids_bitmap: used to allocate new guc_ids, multi-lrc */ unsigned long *guc_ids_bitmap; -/** @stopped: submissions are stopped */ +/** @submission_state.stopped: submissions are stopped */ atomic_t stopped; -/** @lock: protects submission state */ +/** @submission_state.lock: protects submission state */ struct mutex lock; -/** @suspend: suspend fence state */ +/** @submission_state.suspend: suspend fence state */ struct { -/** @lock: suspend fences lock */ +/** @submission_state.suspend.lock: suspend fences lock */ spinlock_t lock; -/** @context: suspend fences context */ +/** @submission_state.suspend.context: suspend fences context */ u64 context; -/** @seqno: suspend fences seqno */ +/** @submission_state.suspend.seqno: suspend fences seqno */ u32 seqno; } suspend;#ifdef CONFIG_PROVE_LOCKING #define NUM_SUBMIT_WQ 256 -/** @submit_wq_pool: submission ordered workqueues pool */ +/** @submission_state.submit_wq_pool: submission ordered workqueues pool */ struct workqueue_struct *submit_wq_pool[NUM_SUBMIT_WQ ]; -/** @submit_wq_idx: submission ordered workqueue index */ +/** @submission_state.submit_wq_idx: submission ordered workqueue index */ int submit_wq_idx;#endif -/** @enabled: submission is enabled */ +/** @submission_state.enabled: submission is enabled */ bool enabled; } submission_state;/** @hwconfig: Hardware config state */ struct { -/** @bo: buffer object of the hardware config */ +/** @hwconfig.bo: buffer object of the hardware config */ struct xe_bo *bo; -/** @size: size of the hardware config */ +/** @hwconfig.size: size of the hardware config */ u32 size; } hwconfig;
drivers/gpu/drm/xe/xe_hw_engine_types.h +35 -35
120 lines not on this page · raw message
drivers/gpu/drm/xe/xe_lrc_types.h +3 -3
@@ -28,11 +28,11 @@ struct xe_lrc {/** @ring: submission ring state */ struct { -/** @size: size of submission ring */ +/** @ring.size: size of submission ring */ u32 size; -/** @tail: tail of submission ring */ +/** @ring.tail: tail of submission ring */ u32 tail; -/** @old_tail: shadow of tail */ +/** @ring.old_tail: shadow of tail */ u32 old_tail; } ring;
drivers/gpu/drm/xe/xe_sched_job_types.h +3 -3
@@ -30,11 +30,11 @@ struct xe_sched_job {struct dma_fence *fence;/** @user_fence: write back value when BB is complete */ struct { -/** @used: user fence is used */ +/** @user_fence.used: user fence is used */ bool used; -/** @addr: address to write to */ +/** @user_fence.addr: address to write to */ u64 addr; -/** @value: write back value */ +/** @user_fence.value: write back value */ u64 value; } user_fence;/** @migrate_flush_flags: Additional flush flags for migration jobs */
drivers/gpu/drm/xe/xe_uc_fw_types.h +6 -3
@@ -124,11 +124,14 @@ struct xe_uc_fw {/** @versions: FW versions wanted and found */ struct { -/** @wanted: firmware version wanted by platform */ +/** @versions.wanted: firmware version wanted by platform */ struct xe_uc_fw_version wanted; -/** @wanted_type: type of firmware version wanted (release vs compatibility) */ +/** +* @versions.wanted_type: type of firmware version wanted +* (release vs compatibility) +*/ enum xe_uc_fw_version_types wanted_type; -/** @found: fw versions found in firmware blob */ +/** @versions.found: fw versions found in firmware blob */ struct xe_uc_fw_version found[XE_UC_FW_VER_TYPE_COUNT ]; } versions;
drivers/gpu/drm/xe/xe_wopcm_types.h +2 -2
@@ -16,9 +16,9 @@ struct xe_wopcm {u32 size;/** @guc: GuC WOPCM Region info */ struct { -/** @base: GuC WOPCM base which is offset from WOPCM base */ +/** @guc.base: GuC WOPCM base which is offset from WOPCM base */ u32 base; -/** @size: Size of the GuC WOPCM region */ +/** @guc.size: Size of the GuC WOPCM region */ u32 size; } guc; };
Signature · 1 line
2.43.0
Patchwork
CI✓ CI.Patch_applied: success for drm/xe: Document nested struct members according to guidelines
== Series Details ==
== Series Details ==
Series: drm/xe: Document nested struct members according to guidelines
URL : https://patchwork.freedesktop.org/series/129086/
State : success
== Summary ==
=== Applying kernel patches on branch 'drm-tip' with base: ===
Base commit: 741c43950 drm-tip: 2024y-01m-23d-11h-59m-12s UTC integration manifest === git am output follows ===
Applying: drm/xe: Document nested struct members according to guidelines
Patchwork
CI✓ CI.checkpatch: success for drm/xe: Document nested struct members according to guidelines
In reply to Thomas Hellström== Series Details ==
== Series Details ==
Series: drm/xe: Document nested struct members according to guidelines
URL : https://patchwork.freedesktop.org/series/129086/
State : success
== Summary ==
+ KERNEL=/kernel
+ git clone https://gitlab.freedesktop.org/drm/maintainer-tools mt Cloning into 'mt'...
warning: redirecting to https://gitlab.freedesktop.org/drm/maintainer-tools.git/
+ git -C mt rev-list -n1 origin/master e7f730565356938dd6c63cd498218fdc5d6a22b0
+ cd /kernel
+ git config --global --add safe.directory /kernel
+ git log -n1
commit cdeb78d40187ee67c5b3dafd10c53e7243869452
Author: Thomas Hellström <[email protected]> Date: Tue Jan 23 13:08:40 2024 +0100
drm/xe: Document nested struct members according to guidelines
Document nested struct members with full names as described in Documentation/doc-guide/kernel-doc.rst.
For this documentation we allow a column with of to make it more readable.
This fixes warnings similar to:
drivers/gpu/drm/xe/xe_lrc_types.h:45: warning: Excess struct member 'size' description in 'xe_lrc'
+ /mt/dim checkpatch 741c439503ee0986a7b7c5b590cbd9813b8841f6 drm-intel cdeb78d40 drm/xe: Document nested struct members according to guidelines
Patchwork
CI✗ CI.KUnit: failure for drm/xe: Document nested struct members according to guidelines
In reply to Thomas Hellström== Series Details ==
== Series Details ==
Series: drm/xe: Document nested struct members according to guidelines
URL : https://patchwork.freedesktop.org/series/129086/
State : failure
== Summary ==
+ trap cleanup EXIT
+ /kernel/tools/testing/kunit/kunit.py run --kunitconfig /kernel/drivers/gpu/drm/xe/.kunitconfig ERROR:root:../arch/x86/um/user-offsets.c:17:6: warning: no previous prototype for ‘foo’ [-Wmissing-prototypes] 17 | void foo(void)
| ^~~
In file included from ../arch/um/kernel/asm-offsets.c:1:../arch/x86/um/shared/sysdep/kernel-offsets.h:9:6: warning: no previous prototype for ‘foo’ [-Wmissing-prototypes]
9 | void foo(void)
| ^~~../arch/x86/um/bugs_64.c:9:6: warning: no previous prototype for ‘arch_check_bugs’ [-Wmissing-prototypes]
9 | void arch_check_bugs(void)
| ^~~~~~~~~~~~~~~../arch/x86/um/bugs_64.c:13:6: warning: no previous prototype for ‘arch_examine_signal’ [-Wmissing-prototypes]
13 | void arch_examine_signal(int sig, struct uml_pt_regs *regs)
| ^~~~~~~~~~~~~~~~~~~
../arch/x86/um/fault.c:18:5: warning: no previous prototype for ‘arch_fixup’ [-Wmissing-prototypes]
18 | int arch_fixup(unsigned long address, struct uml_pt_regs *regs)
| ^~~~~~~~~~
../arch/x86/um/os-Linux/registers.c:146:15: warning: no previous prototype for ‘get_thread_reg’ [-Wmissing-prototypes]
146 | unsigned long get_thread_reg(int reg, jmp_buf *buf)
| ^~~~~~~~~~~~~~
../arch/x86/um/vdso/um_vdso.c:16:5: warning: no previous prototype for ‘__vdso_clock_gettime’ [-Wmissing-prototypes]
16 | int __vdso_clock_gettime(clockid_t clock, struct __kernel_old_timespec *ts)
| ^~~~~~~~~~~~~~~~~~~~
../arch/x86/um/vdso/um_vdso.c:30:5: warning: no previous prototype for ‘__vdso_gettimeofday’ [-Wmissing-prototypes]
30 | int __vdso_gettimeofday(struct __kernel_old_timeval *tv, struct timezone *tz)
| ^~~~~~~~~~~~~~~~~~~
../arch/x86/um/vdso/um_vdso.c:44:21: warning: no previous prototype for ‘__vdso_time’ [-Wmissing-prototypes]
44 | __kernel_old_time_t __vdso_time(__kernel_old_time_t *t)
| ^~~~~~~~~~~
../arch/x86/um/vdso/um_vdso.c:57:1: warning: no previous prototype for ‘__vdso_getcpu’ [-Wmissing-prototypes]
57 | __vdso_getcpu(unsigned *cpu, unsigned *node, struct getcpu_cache *unused)
| ^~~~~~~~~~~~~../arch/x86/um/os-Linux/mcontext.c:7:6: warning: no previous prototype for ‘get_regs_from_mc’ [-Wmissing-prototypes]
7 | void get_regs_from_mc(struct uml_pt_regs *regs, mcontext_t *mc)
| ^~~~~~~~~~~~~~~~../arch/um/os-Linux/skas/process.c:107:6: warning: no previous prototype for ‘wait_stub_done’ [-Wmissing-prototypes]
107 | void wait_stub_done(int pid)
| ^~~~~~~~~~~~~~
../arch/um/os-Linux/skas/process.c:683:6: warning: no previous prototype for ‘__switch_mm’ [-Wmissing-prototypes]
683 | void __switch_mm(struct mm_id *mm_idp)
| ^~~~~~~~~~~
../arch/um/kernel/skas/mmu.c:17:5: warning: no previous prototype for ‘init_new_context’ [-Wmissing-prototypes]
17 | int init_new_context(struct task_struct *task, struct mm_struct *mm)
| ^~~~~~~~~~~~~~~~
../arch/um/kernel/skas/mmu.c:60:6: warning: no previous prototype for ‘destroy_context’ [-Wmissing-prototypes]
60 | void destroy_context(struct mm_struct *mm)
| ^~~~~~~~~~~~~~~
../arch/um/kernel/skas/process.c:36:12: warning: no previous prototype for ‘start_uml’ [-Wmissing-prototypes]
36 | int __init start_uml(void)
| ^~~~~~~~~
../arch/x86/um/ptrace_64.c:111:5: warning: no previous prototype for ‘poke_user’ [-Wmissing-prototypes]
111 | int poke_user(struct task_struct *child, long addr, long data)
| ^~~~~~~~~
../arch/x86/um/ptrace_64.c:171:5: warning: no previous prototype for ‘peek_user’ [-Wmissing-prototypes]
171 | int peek_user(struct task_struct *child, long addr, long data)
| ^~~~~~~~~
../arch/um/os-Linux/main.c:187:7: warning: no previous prototype for ‘__wrap_malloc’ [-Wmissing-prototypes]
187 | void *__wrap_malloc(int size)
| ^~~~~~~~~~~~~
../arch/um/os-Linux/main.c:208:7: warning: no previous prototype for ‘__wrap_calloc’ [-Wmissing-prototypes]
208 | void *__wrap_calloc(int n, int size)
| ^~~~~~~~~~~~~
../arch/um/os-Linux/main.c:222:6: warning: no previous prototype for ‘__wrap_free’ [-Wmissing-prototypes]
222 | void __wrap_free(void *ptr)
| ^~~~~~~~~~~
../arch/um/os-Linux/mem.c:28:6: warning: no previous prototype for ‘kasan_map_memory’ [-Wmissing-prototypes]
28 | void kasan_map_memory(void *start, size_t len)
| ^~~~~~~~~~~~~~~~
../arch/um/os-Linux/mem.c:212:13: warning: no previous prototype for ‘check_tmpexec’ [-Wmissing-prototypes]
212 | void __init check_tmpexec(void)
| ^~~~~~~~~~~~~
../arch/um/os-Linux/signal.c:75:6: warning: no previous prototype for ‘sig_handler’ [-Wmissing-prototypes]
75 | void sig_handler(int sig, struct siginfo *si, mcontext_t *mc)
| ^~~~~~~~~~~
../arch/um/os-Linux/signal.c:111:6: warning: no previous prototype for ‘timer_alarm_handler’ [-Wmissing-prototypes]
111 | void timer_alarm_handler(int sig, struct siginfo *unused_si, mcontext_t *mc)
| ^~~~~~~~~~~~~~~~~~~
../arch/um/os-Linux/start_up.c:301:12: warning: no previous prototype for ‘parse_iomem’ [-Wmissing-prototypes]
301 | int __init parse_iomem(char *str, int *add)
| ^~~~~~~~~~~
../arch/x86/um/signal.c:560:6: warning: no previous prototype for ‘sys_rt_sigreturn’ [-Wmissing-prototypes]
560 | long sys_rt_sigreturn(void)
| ^~~~~~~~~~~~~~~~
../arch/um/kernel/mem.c:202:8: warning: no previous prototype for ‘pgd_alloc’ [-Wmissing-prototypes]
202 | pgd_t *pgd_alloc(struct mm_struct *mm)
| ^~~~~~~~~
../arch/um/kernel/mem.c:215:7: warning: no previous prototype for ‘uml_kmalloc’ [-Wmissing-prototypes]
215 | void *uml_kmalloc(int size, int flags)
| ^~~~~~~~~~~
../arch/um/kernel/reboot.c:45:6: warning: no previous prototype for ‘machine_restart’ [-Wmissing-prototypes]
45 | void machine_restart(char * __unused)
| ^~~~~~~~~~~~~~~
../arch/um/kernel/reboot.c:51:6: warning: no previous prototype for ‘machine_power_off’ [-Wmissing-prototypes]
51 | void machine_power_off(void)
| ^~~~~~~~~~~~~~~~~
../arch/um/kernel/reboot.c:57:6: warning: no previous prototype for ‘machine_halt’ [-Wmissing-prototypes]
57 | void machine_halt(void)
| ^~~~~~~~~~~~
../arch/um/kernel/process.c:51:5: warning: no previous prototype for ‘pid_to_processor_id’ [-Wmissing-prototypes]
51 | int pid_to_processor_id(int pid)
| ^~~~~~~~~~~~~~~~~~~
../arch/um/kernel/process.c:87:7: warning: no previous prototype for ‘__switch_to’ [-Wmissing-prototypes]
87 | void *__switch_to(struct task_struct *from, struct task_struct *to)
| ^~~~~~~~~~~
../arch/um/kernel/process.c:140:6: warning: no previous prototype for ‘fork_handler’ [-Wmissing-prototypes]
140 | void fork_handler(void)
| ^~~~~~~~~~~~
../arch/um/kernel/process.c:217:6: warning: no previous prototype for ‘arch_cpu_idle’ [-Wmissing-prototypes]
217 | void arch_cpu_idle(void)
| ^~~~~~~~~~~~~
../arch/um/kernel/process.c:253:5: warning: no previous prototype for ‘copy_to_user_proc’ [-Wmissing-prototypes]
253 | int copy_to_user_proc(void __user *to, void *from, int size)
| ^~~~~~~~~~~~~~~~~
../arch/um/kernel/process.c:263:5: warning: no previous prototype for ‘clear_user_proc’ [-Wmissing-prototypes]
263 | int clear_user_proc(void __user *buf, int size)
| ^~~~~~~~~~~~~~~
../arch/um/kernel/process.c:271:6: warning: no previous prototype for ‘set_using_sysemu’ [-Wmissing-prototypes]
271 | void set_using_sysemu(int value)
| ^~~~~~~~~~~~~~~~
../arch/um/kernel/process.c:278:5: warning: no previous prototype for ‘get_using_sysemu’ [-Wmissing-prototypes]
278 | int get_using_sysemu(void)
| ^~~~~~~~~~~~~~~~
../arch/um/kernel/process.c:316:12: warning: no previous prototype for ‘make_proc_sysemu’ [-Wmissing-prototypes]
316 | int __init make_proc_sysemu(void)
| ^~~~~~~~~~~~~~~~
../arch/um/kernel/process.c:348:15: warning: no previous prototype for ‘arch_align_stack’ [-Wmissing-prototypes]
348 | unsigned long arch_align_stack(unsigned long sp)
| ^~~~~~~~~~~~~~~~
../arch/x86/um/syscalls_64.c:48:6: warning: no previous prototype for ‘arch_switch_to’ [-Wmissing-prototypes]
48 | void arch_switch_to(struct task_struct *to)
| ^~~~~~~~~~~~~~
../arch/um/kernel/tlb.c:579:6: warning: no previous prototype for ‘flush_tlb_mm_range’ [-Wmissing-prototypes]
579 | void flush_tlb_mm_range(struct mm_struct *mm, unsigned long start,
| ^~~~~~~~~~~~~~~~~~
../arch/um/kernel/tlb.c:594:6: warning: no previous prototype for ‘force_flush_all’ [-Wmissing-prototypes]
594 | void force_flush_all(void)
| ^~~~~~~~~~~~~~~
../arch/um/kernel/um_arch.c:408:19: warning: no previous prototype for ‘read_initrd’ [-Wmissing-prototypes]
408 | int __init __weak read_initrd(void)
| ^~~~~~~~~~~
../arch/um/kernel/um_arch.c:461:7: warning: no previous prototype for ‘text_poke’ [-Wmissing-prototypes]
461 | void *text_poke(void *addr, const void *opcode, size_t len)
| ^~~~~~~~~
../arch/um/kernel/um_arch.c:473:6: warning: no previous prototype for ‘text_poke_sync’ [-Wmissing-prototypes]
473 | void text_poke_sync(void)
| ^~~~~~~~~~~~~~
../arch/um/kernel/kmsg_dump.c:60:12: warning: no previous prototype for ‘kmsg_dumper_stdout_init’ [-Wmissing-prototypes]
60 | int __init kmsg_dumper_stdout_init(void)
| ^~~~~~~~~~~~~~~~~~~~~~~
In file included from ../drivers/gpu/drm/xe/xe_device.h:15,
from ../drivers/gpu/drm/xe/xe_bb.c:10:../drivers/gpu/drm/xe/xe_device_types.h:389:22: error: expected ‘:’, ‘,’, ‘;’, ‘}’ or ‘__attribute__’ before ‘.’ token
389 | atomic_t mem_access.ref;
| ^
make[7]: *** [../scripts/Makefile.build:243: drivers/gpu/drm/xe/xe_bb.o] Error 1
make[7]: *** Waiting for unfinished jobs....
In file included from ../drivers/gpu/drm/xe/xe_device.h:15,
from ../drivers/gpu/drm/xe/tests/xe_pci_test.c:13:
../drivers/gpu/drm/xe/xe_device_types.h:389:22: error: expected ‘:’, ‘,’, ‘;’, ‘}’ or ‘__attribute__’ before ‘.’ token
389 | atomic_t mem_access.ref;
| ^
make[8]: *** [../scripts/Makefile.build:243: drivers/gpu/drm/xe/tests/xe_pci_test.o] Error 1 make[8]: *** Waiting for unfinished jobs....
In file included from ../drivers/gpu/drm/xe/xe_device.h:15,
from ../drivers/gpu/drm/xe/tests/xe_wa_test.c:11:
../drivers/gpu/drm/xe/xe_device_types.h:389:22: error: expected ‘:’, ‘,’, ‘;’, ‘}’ or ‘__attribute__’ before ‘.’ token
389 | atomic_t mem_access.ref;
| ^
make[8]: *** [../scripts/Makefile.build:243: drivers/gpu/drm/xe/tests/xe_wa_test.o] Error 1
In file included from ../drivers/gpu/drm/xe/xe_device.h:15,
from ../drivers/gpu/drm/xe/tests/xe_rtp_test.c:16:
../drivers/gpu/drm/xe/xe_device_types.h:389:22: error: expected ‘:’, ‘,’, ‘;’, ‘}’ or ‘__attribute__’ before ‘.’ token
389 | atomic_t mem_access.ref;
| ^
make[8]: *** [../scripts/Makefile.build:243: drivers/gpu/drm/xe/tests/xe_rtp_test.o] Error 1 make[7]: *** [../scripts/Makefile.build:481: drivers/gpu/drm/xe/tests] Error 2
make[6]: *** [../scripts/Makefile.build:481: drivers/gpu/drm/xe] Error 2
make[6]: *** Waiting for unfinished jobs....
make[5]: *** [../scripts/Makefile.build:481: drivers/gpu/drm] Error 2
make[4]: *** [../scripts/Makefile.build:481: drivers/gpu] Error 2
make[4]: *** Waiting for unfinished jobs....
make[3]: *** [../scripts/Makefile.build:481: drivers] Error 2
make[3]: *** Waiting for unfinished jobs....../lib/iomap.c:156:5: warning: no previous prototype for ‘ioread64_lo_hi’ [-Wmissing-prototypes]
156 | u64 ioread64_lo_hi(const void __iomem *addr)
| ^~~~~~~~~~~~~~
../lib/iomap.c:163:5: warning: no previous prototype for ‘ioread64_hi_lo’ [-Wmissing-prototypes]
163 | u64 ioread64_hi_lo(const void __iomem *addr)
| ^~~~~~~~~~~~~~
../lib/iomap.c:170:5: warning: no previous prototype for ‘ioread64be_lo_hi’ [-Wmissing-prototypes]
170 | u64 ioread64be_lo_hi(const void __iomem *addr)
| ^~~~~~~~~~~~~~~~
../lib/iomap.c:178:5: warning: no previous prototype for ‘ioread64be_hi_lo’ [-Wmissing-prototypes]
178 | u64 ioread64be_hi_lo(const void __iomem *addr)
| ^~~~~~~~~~~~~~~~
../lib/iomap.c:264:6: warning: no previous prototype for ‘iowrite64_lo_hi’ [-Wmissing-prototypes]
264 | void iowrite64_lo_hi(u64 val, void __iomem *addr)
| ^~~~~~~~~~~~~~~
../lib/iomap.c:272:6: warning: no previous prototype for ‘iowrite64_hi_lo’ [-Wmissing-prototypes]
272 | void iowrite64_hi_lo(u64 val, void __iomem *addr)
| ^~~~~~~~~~~~~~~
../lib/iomap.c:280:6: warning: no previous prototype for ‘iowrite64be_lo_hi’ [-Wmissing-prototypes]
280 | void iowrite64be_lo_hi(u64 val, void __iomem *addr)
| ^~~~~~~~~~~~~~~~~
../lib/iomap.c:288:6: warning: no previous prototype for ‘iowrite64be_hi_lo’ [-Wmissing-prototypes]
288 | void iowrite64be_hi_lo(u64 val, void __iomem *addr)
| ^~~~~~~~~~~~~~~~~make[2]: *** [/kernel/Makefile:1917: .] Error 2 make[1]: *** [/kernel/Makefile:240: __sub-make] Error 2
make: *** [Makefile:240: __sub-make] Error 2
[12:34:12] Configuring KUnit Kernel ...
Generating .config ...
Populating config with:
$ make ARCH=um O=.kunit olddefconfig [12:34:16] Building KUnit Kernel ... Populating config with: $ make ARCH=um O=.kunit olddefconfig Building with: $ make ARCH=um O=.kunit --jobs=48 + cleanup ++ stat -c %u:%g /kernel + chown -R 1003:1003 /kernel
Quoted 6 lines · Thomas Hellström
Document nested struct members with full names as described in
Documentation/doc-guide/kernel-doc.rst.For this documentation we allow a column with of to make it more readable.
Quoted 6 lines
This fixes warnings similar to:
drivers/gpu/drm/xe/xe_lrc_types.h:45: warning: Excess struct member 'size' description in 'xe_lrc'Cc Lucas De Marchi <[email protected]>Cc Matthew Brost <[email protected]>Signed-off-by Thomas Hellström <[email protected]>
git show --color-words seems sane. CI result tells it took care of all the warnings too.
thaks
Lucas De Marchi