[igt-dev] [PATCH i-g-t v8 09/17] lib/intel_batchbuffer: Update intel-bb docs

[Manszewski, Christoph]

Hi Zbigniew,

On 28.04.2023 08:22, Zbigniew Kempczyński wrote:
> After RANDOM pseudo-allocator was removed and RELOC allocator becomed
> stateful docs stays intact and documents old code. Fix this before
> adding xe code.

It just came to my mind that if you dedicate a patch for 
'__intel_bb_create' docs update, you may as well add missing description 
for 'start', 'end' and 'strategy' parameters. But it's optional, it can 
wait for another day.

Anyway:
Reviewed-by: Christoph Manszewski <christoph.manszewski at intel.com>

Christoph


> 
> Signed-off-by: Zbigniew Kempczyński <zbigniew.kempczynski at intel.com>
> ---
>   lib/intel_batchbuffer.c | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/lib/intel_batchbuffer.c b/lib/intel_batchbuffer.c
> index 99b0b61585..306b7650e9 100644
> --- a/lib/intel_batchbuffer.c
> +++ b/lib/intel_batchbuffer.c
> @@ -836,7 +836,7 @@ static inline uint64_t __intel_bb_get_offset(struct intel_bb *ibb,
>    * @allocator_type: allocator type, must be INTEL_ALLOCATOR_NONE for relocations
>    *
>    * intel-bb assumes it will work in one of two modes - with relocations or
> - * with using allocator (currently RANDOM and SIMPLE are implemented).
> + * with using allocator (currently RELOC and SIMPLE are implemented).
>    * Some description is required to describe how they maintain the addresses.
>    *
>    * Before entering into each scenarios generic rule is intel-bb keeps objects
> @@ -854,10 +854,10 @@ static inline uint64_t __intel_bb_get_offset(struct intel_bb *ibb,
>    *
>    * This mode is valid only for ppgtt. Addresses are acquired from allocator
>    * and softpinned. intel-bb cache must be then coherent with allocator
> - * (simple is coherent, random is not due to fact we don't keep its state).
> + * (simple is coherent, reloc partially [doesn't support address reservation]).
>    * When we do intel-bb reset with purging cache it has to reacquire addresses
>    * from allocator (allocator should return same address - what is true for
> - * simple allocator and false for random as mentioned before).
> + * simple and reloc allocators).
>    *
>    * If we do reset without purging caches we use addresses from intel-bb cache
>    * during execbuf objects construction.
> @@ -967,7 +967,7 @@ __intel_bb_create(int fd, uint32_t ctx, const intel_ctx_cfg_t *cfg,
>    * @size: size of the batchbuffer
>    * @start: allocator vm start address
>    * @end: allocator vm start address
> - * @allocator_type: allocator type, SIMPLE, RANDOM, ...
> + * @allocator_type: allocator type, SIMPLE, RELOC, ...
>    * @strategy: allocation strategy
>    *
>    * Creates bb with context passed in @ctx, size in @size and allocator type