diff options
author | Thomas Hellström <thomas.hellstrom@linux.intel.com> | 2024-01-23 18:31:47 +0300 |
---|---|---|
committer | Thomas Hellström <thomas.hellstrom@linux.intel.com> | 2024-01-23 18:54:41 +0300 |
commit | 6240c2c43fd062515dda68e60866b4851f32d631 (patch) | |
tree | 97d7f42ec4eb45ea4f1b546ef9bb2763b53f3305 /drivers/gpu/drm/xe/xe_gsc_types.h | |
parent | 02c4e64a860a05ca3ffe4d416c1ae9003d3453ea (diff) | |
download | linux-6240c2c43fd062515dda68e60866b4851f32d631.tar.xz |
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 width of 100 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'
v2:
- Only change the documentation, not the member.
v3:
- Fix the commit message wording.
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Cc: Matthew Brost <matthew.brost@intel.com>
Signed-off-by: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240123153147.27305-1-thomas.hellstrom@linux.intel.com
Diffstat (limited to 'drivers/gpu/drm/xe/xe_gsc_types.h')
-rw-r--r-- | drivers/gpu/drm/xe/xe_gsc_types.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/drivers/gpu/drm/xe/xe_gsc_types.h b/drivers/gpu/drm/xe/xe_gsc_types.h index 060d0fe848ad..138d8cc0f19c 100644 --- a/drivers/gpu/drm/xe/xe_gsc_types.h +++ b/drivers/gpu/drm/xe/xe_gsc_types.h @@ -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; }; |