[PATCH 3/5] drm/ttm: enable TTM resource object kerneldoc

[Christian König]

Am 03.09.21 um 15:48 schrieb Matthew Auld:
> On Fri, 3 Sept 2021 at 13:31, Christian König
> <ckoenig.leichtzumerken at gmail.com> wrote:
>> Fix the last two remaining warnings and finally enable this.
>>
>> Signed-off-by: Christian König <christian.koenig at amd.com>
>> ---
>>   Documentation/gpu/drm-mm.rst   | 9 +++++++++
>>   include/drm/ttm/ttm_resource.h | 6 ++----
>>   2 files changed, 11 insertions(+), 4 deletions(-)
>>
>> diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
>> index 56b7b581567d..094e367130db 100644
>> --- a/Documentation/gpu/drm-mm.rst
>> +++ b/Documentation/gpu/drm-mm.rst
>> @@ -39,6 +39,15 @@ TTM device object reference
>>   .. kernel-doc:: drivers/gpu/drm/ttm/ttm_device.c
>>      :export:
>>
>> +TTM resource object reference
>> +-----------------------------
>> +
>> +.. kernel-doc:: include/drm/ttm/ttm_resource.h
>> +   :internal:
>> +
>> +.. kernel-doc:: drivers/gpu/drm/ttm/ttm_resource.c
>> +   :export:
>> +
>>   The Graphics Execution Manager (GEM)
>>   ====================================
>>
>> diff --git a/include/drm/ttm/ttm_resource.h b/include/drm/ttm/ttm_resource.h
>> index 32c5edd9e8b5..255fc8169d9a 100644
>> --- a/include/drm/ttm/ttm_resource.h
>> +++ b/include/drm/ttm/ttm_resource.h
>> @@ -103,10 +103,7 @@ struct ttm_resource_manager_func {
>>    * struct ttm_resource_manager
>>    *
>>    * @use_type: The memory type is enabled.
>> - * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
>> - * managed by this memory type.
>> - * @gpu_offset: If used, the GPU offset of the first managed page of
>> - * fixed memory or the first managed location in an aperture.
>> + * @use_tt: If a TT object should be used for the backing store.
>>    * @size: Size of the managed region.
>>    * @func: structure pointer implementing the range manager. See above
>>    * @move_lock: lock for move fence
>> @@ -144,6 +141,7 @@ struct ttm_resource_manager {
>>    * @addr:              mapped virtual address
>>    * @offset:            physical addr
>>    * @is_iomem:          is this io memory ?
>> + * @caching:           What CPU caching should be used
> Maybe add "See enum ttm_caching" or something, so it generates a link,
> once we also add kernel-doc for that?

Good point, going to do that as well.

Thanks,
Christian.

>
>>    *
>>    * Structure indicating the bus placement of an object.
>>    */
>> --
>> 2.25.1
>>