[PATCH] pciconfig_read.2: SYNOPSIS: Fix prototype parameter types

[PATCH] pciconfig_read.2: SYNOPSIS: Fix prototype parameter types

[Alejandro Colomar]

Use the glibc prototypes instead of the kernel ones.
Exception: use 'int' instead of 'enum'.

......

.../glibc$ grep_glibc_prototype pciconfig_read
sysdeps/unix/sysv/linux/alpha/sys/io.h:72:
extern int pciconfig_read (unsigned long int __bus,
			   unsigned long int __dfn,
			   unsigned long int __off,
			   unsigned long int __len,
			   unsigned char *__buf) __THROW;
sysdeps/unix/sysv/linux/ia64/sys/io.h:57:
extern int pciconfig_read (unsigned long int __bus, unsigned long int __dfn,
			   unsigned long int __off, unsigned long int __len,
			   unsigned char *__buf);
.../glibc$ grep_glibc_prototype pciconfig_write
sysdeps/unix/sysv/linux/alpha/sys/io.h:78:
extern int pciconfig_write (unsigned long int __bus,
			    unsigned long int __dfn,
			    unsigned long int __off,
			    unsigned long int __len,
			    unsigned char *__buf) __THROW;
sysdeps/unix/sysv/linux/ia64/sys/io.h:61:
extern int pciconfig_write (unsigned long int __bus, unsigned long int __dfn,
			    unsigned long int __off, unsigned long int __len,
			    unsigned char *__buf);
.../glibc$ grep_glibc_prototype pciconfig_iobase
sysdeps/unix/sysv/linux/alpha/sys/io.h:66:
extern long pciconfig_iobase(enum __pciconfig_iobase_which __which,
			     unsigned long int __bus,
			     unsigned long int __dfn)
     __THROW __attribute__ ((const));
.../glibc$

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man2/pciconfig_read.2 | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/man2/pciconfig_read.2 b/man2/pciconfig_read.2
index cec6f58e9..c379e2d3b 100644
--- a/man2/pciconfig_read.2
+++ b/man2/pciconfig_read.2
@@ -13,11 +13,13 @@ pciconfig_read, pciconfig_write, pciconfig_iobase \- pci device information hand
 .B #include <pci.h>
 .PP
 .BI "int pciconfig_read(unsigned long " bus ", unsigned long " dfn ,
-.BI "          unsigned long " off ", unsigned long " len ", void *" buf );
+.BI "                   unsigned long " off ", unsigned long " len ,
+.BI "                   unsigned char *" buf );
 .BI "int pciconfig_write(unsigned long " bus ", unsigned long " dfn ,
-.BI "          unsigned long " off ", unsigned long " len ", void *" buf );
-.BI "int pciconfig_iobase(long " which ", unsigned long " bus ,
-.BI "          unsigned long " devfn );
+.BI "                   unsigned long " off ", unsigned long " len ,
+.BI "                   unsgined char *" buf );
+.BI "int pciconfig_iobase(int " which ", unsigned long " bus ,
+.BI "                   unsigned long " devfn );
 .fi
 .SH DESCRIPTION
 Most of the interaction with PCI devices is already handled by the
-- 
2.30.0

Re: [PATCH] pciconfig_read.2: SYNOPSIS: Fix prototype parameter types

[Michael Kerrisk (man-pages)]

Hi Alex,

On 2/15/21 2:15 PM, Alejandro Colomar wrote:
> Use the glibc prototypes instead of the kernel ones.
> Exception: use 'int' instead of 'enum'.
> 
> ......
> 
> .../glibc$ grep_glibc_prototype pciconfig_read
> sysdeps/unix/sysv/linux/alpha/sys/io.h:72:
> extern int pciconfig_read (unsigned long int __bus,
> 			   unsigned long int __dfn,
> 			   unsigned long int __off,
> 			   unsigned long int __len,
> 			   unsigned char *__buf) __THROW;
> sysdeps/unix/sysv/linux/ia64/sys/io.h:57:
> extern int pciconfig_read (unsigned long int __bus, unsigned long int __dfn,
> 			   unsigned long int __off, unsigned long int __len,
> 			   unsigned char *__buf);
> .../glibc$ grep_glibc_prototype pciconfig_write
> sysdeps/unix/sysv/linux/alpha/sys/io.h:78:
> extern int pciconfig_write (unsigned long int __bus,
> 			    unsigned long int __dfn,
> 			    unsigned long int __off,
> 			    unsigned long int __len,
> 			    unsigned char *__buf) __THROW;
> sysdeps/unix/sysv/linux/ia64/sys/io.h:61:
> extern int pciconfig_write (unsigned long int __bus, unsigned long int __dfn,
> 			    unsigned long int __off, unsigned long int __len,
> 			    unsigned char *__buf);
> .../glibc$ grep_glibc_prototype pciconfig_iobase
> sysdeps/unix/sysv/linux/alpha/sys/io.h:66:
> extern long pciconfig_iobase(enum __pciconfig_iobase_which __which,
> 			     unsigned long int __bus,
> 			     unsigned long int __dfn)
>      __THROW __attribute__ ((const));
> .../glibc$
> 
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

Thanks! Patch applied.

Cheers,

Michael


> ---
>  man2/pciconfig_read.2 | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/man2/pciconfig_read.2 b/man2/pciconfig_read.2
> index cec6f58e9..c379e2d3b 100644
> --- a/man2/pciconfig_read.2
> +++ b/man2/pciconfig_read.2
> @@ -13,11 +13,13 @@ pciconfig_read, pciconfig_write, pciconfig_iobase \- pci device information hand
>  .B #include <pci.h>
>  .PP
>  .BI "int pciconfig_read(unsigned long " bus ", unsigned long " dfn ,
> -.BI "          unsigned long " off ", unsigned long " len ", void *" buf );
> +.BI "                   unsigned long " off ", unsigned long " len ,
> +.BI "                   unsigned char *" buf );
>  .BI "int pciconfig_write(unsigned long " bus ", unsigned long " dfn ,
> -.BI "          unsigned long " off ", unsigned long " len ", void *" buf );
> -.BI "int pciconfig_iobase(long " which ", unsigned long " bus ,
> -.BI "          unsigned long " devfn );
> +.BI "                   unsigned long " off ", unsigned long " len ,
> +.BI "                   unsgined char *" buf );
> +.BI "int pciconfig_iobase(int " which ", unsigned long " bus ,
> +.BI "                   unsigned long " devfn );
>  .fi
>  .SH DESCRIPTION
>  Most of the interaction with PCI devices is already handled by the
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/