diff mbox series

[v2,1/4] docs: Fix next function numbers in SR/IOV documentation

Message ID 20230702094631.39111-2-akihiko.odaki@daynix.com
State New
Headers show
Series pcie: Fix ARI next function numbers | expand

Commit Message

Akihiko Odaki July 2, 2023, 9:46 a.m. UTC
The ARI next function number field is undefined for VF so the PF should
end the linked list formed with the field by specifying 0.

This also changes the value of the field for VF; it seems to imply the
value has some meaning if it differs from one of the PF, but it doesn't.

Fixes: 2503461691 ("pcie: Add some SR/IOV API documentation in docs/pcie_sriov.txt")
Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
---
 docs/pcie_sriov.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Michael S. Tsirkin July 2, 2023, 10:40 a.m. UTC | #1
On Sun, Jul 02, 2023 at 06:46:25PM +0900, Akihiko Odaki wrote:
> The ARI next function number field is undefined for VF so the PF should
> end the linked list formed with the field by specifying 0.
> 
> This also changes the value of the field for VF; it seems to imply the
> value has some meaning if it differs from one of the PF, but it doesn't.
> 
> Fixes: 2503461691 ("pcie: Add some SR/IOV API documentation in docs/pcie_sriov.txt")
> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> ---
>  docs/pcie_sriov.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/pcie_sriov.txt b/docs/pcie_sriov.txt
> index 7eff7f2703..2b7094dc47 100644
> --- a/docs/pcie_sriov.txt
> +++ b/docs/pcie_sriov.txt
> @@ -48,7 +48,7 @@ setting up a BAR for a VF.
>        ...
>        int ret = pcie_endpoint_cap_init(d, 0x70);
>        ...
> -      pcie_ari_init(d, 0x100, 1);
> +      pcie_ari_init(d, 0x100, 0);
>        ...
>  
>        /* Add and initialize the SR/IOV capability */
> @@ -78,7 +78,7 @@ setting up a BAR for a VF.
>        ...
>        int ret = pcie_endpoint_cap_init(d, 0x60);
>        ...
> -      pcie_ari_init(d, 0x100, 1);
> +      pcie_ari_init(d, 0x100, 0);
>        ...
>        memory_region_init(mr, ... )
>        pcie_sriov_vf_register_bar(d, bar_nr, mr);


So now code does not match docs.


> -- 
> 2.41.0
Akihiko Odaki July 2, 2023, 11:19 a.m. UTC | #2
On 2023/07/02 19:40, Michael S. Tsirkin wrote:
> On Sun, Jul 02, 2023 at 06:46:25PM +0900, Akihiko Odaki wrote:
>> The ARI next function number field is undefined for VF so the PF should
>> end the linked list formed with the field by specifying 0.
>>
>> This also changes the value of the field for VF; it seems to imply the
>> value has some meaning if it differs from one of the PF, but it doesn't.
>>
>> Fixes: 2503461691 ("pcie: Add some SR/IOV API documentation in docs/pcie_sriov.txt")
>> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
>> ---
>>   docs/pcie_sriov.txt | 4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/pcie_sriov.txt b/docs/pcie_sriov.txt
>> index 7eff7f2703..2b7094dc47 100644
>> --- a/docs/pcie_sriov.txt
>> +++ b/docs/pcie_sriov.txt
>> @@ -48,7 +48,7 @@ setting up a BAR for a VF.
>>         ...
>>         int ret = pcie_endpoint_cap_init(d, 0x70);
>>         ...
>> -      pcie_ari_init(d, 0x100, 1);
>> +      pcie_ari_init(d, 0x100, 0);
>>         ...
>>   
>>         /* Add and initialize the SR/IOV capability */
>> @@ -78,7 +78,7 @@ setting up a BAR for a VF.
>>         ...
>>         int ret = pcie_endpoint_cap_init(d, 0x60);
>>         ...
>> -      pcie_ari_init(d, 0x100, 1);
>> +      pcie_ari_init(d, 0x100, 0);
>>         ...
>>         memory_region_init(mr, ... )
>>         pcie_sriov_vf_register_bar(d, bar_nr, mr);
> 
> 
> So now code does not match docs.

Can you elaborate more?
Michael S. Tsirkin July 2, 2023, 1:24 p.m. UTC | #3
On Sun, Jul 02, 2023 at 08:19:43PM +0900, Akihiko Odaki wrote:
> On 2023/07/02 19:40, Michael S. Tsirkin wrote:
> > On Sun, Jul 02, 2023 at 06:46:25PM +0900, Akihiko Odaki wrote:
> > > The ARI next function number field is undefined for VF so the PF should
> > > end the linked list formed with the field by specifying 0.
> > > 
> > > This also changes the value of the field for VF; it seems to imply the
> > > value has some meaning if it differs from one of the PF, but it doesn't.
> > > 
> > > Fixes: 2503461691 ("pcie: Add some SR/IOV API documentation in docs/pcie_sriov.txt")
> > > Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> > > ---
> > >   docs/pcie_sriov.txt | 4 ++--
> > >   1 file changed, 2 insertions(+), 2 deletions(-)
> > > 
> > > diff --git a/docs/pcie_sriov.txt b/docs/pcie_sriov.txt
> > > index 7eff7f2703..2b7094dc47 100644
> > > --- a/docs/pcie_sriov.txt
> > > +++ b/docs/pcie_sriov.txt
> > > @@ -48,7 +48,7 @@ setting up a BAR for a VF.
> > >         ...
> > >         int ret = pcie_endpoint_cap_init(d, 0x70);
> > >         ...
> > > -      pcie_ari_init(d, 0x100, 1);
> > > +      pcie_ari_init(d, 0x100, 0);
> > >         ...
> > >         /* Add and initialize the SR/IOV capability */
> > > @@ -78,7 +78,7 @@ setting up a BAR for a VF.
> > >         ...
> > >         int ret = pcie_endpoint_cap_init(d, 0x60);
> > >         ...
> > > -      pcie_ari_init(d, 0x100, 1);
> > > +      pcie_ari_init(d, 0x100, 0);
> > >         ...
> > >         memory_region_init(mr, ... )
> > >         pcie_sriov_vf_register_bar(d, bar_nr, mr);
> > 
> > 
> > So now code does not match docs.
> 
> Can you elaborate more?

your new revision addresses this.
diff mbox series

Patch

diff --git a/docs/pcie_sriov.txt b/docs/pcie_sriov.txt
index 7eff7f2703..2b7094dc47 100644
--- a/docs/pcie_sriov.txt
+++ b/docs/pcie_sriov.txt
@@ -48,7 +48,7 @@  setting up a BAR for a VF.
       ...
       int ret = pcie_endpoint_cap_init(d, 0x70);
       ...
-      pcie_ari_init(d, 0x100, 1);
+      pcie_ari_init(d, 0x100, 0);
       ...
 
       /* Add and initialize the SR/IOV capability */
@@ -78,7 +78,7 @@  setting up a BAR for a VF.
       ...
       int ret = pcie_endpoint_cap_init(d, 0x60);
       ...
-      pcie_ari_init(d, 0x100, 1);
+      pcie_ari_init(d, 0x100, 0);
       ...
       memory_region_init(mr, ... )
       pcie_sriov_vf_register_bar(d, bar_nr, mr);