diff options
| author |  Andy Shevchenko <andriy.shevchenko@linux.intel.com>
| 2024-05-03 20:15:54 +0300 |
|---|---|---|
| committer |  Greg Kroah-Hartman <gregkh@linuxfoundation.org>
| 2024-05-04 18:09:29 +0200 |
| commit | 19234a5f61c5431bd2468ff5b7d65fa99ebb9f02 (patch) | |
| tree | 633301c552bb0df5d4c1c83c61c4cbade989e01c /drivers/tty | |
| parent | serial: 8250_exar: Don't return positive values as error codes (diff) | |
| download | linux-19234a5f61c5431bd2468ff5b7d65fa99ebb9f02.tar.gz linux-19234a5f61c5431bd2468ff5b7d65fa99ebb9f02.tar.bz2 linux-19234a5f61c5431bd2468ff5b7d65fa99ebb9f02.zip | |
serial: 8250_exar: Describe all parameters in kernel doc
Kernel doc validator is not happy:
warning: Function parameter or struct member 'pcidev' not described in 'cti_get_port_type_xr17c15x_xr17v25x'
warning: Function parameter or struct member 'pcidev' not described in 'cti_get_port_type_fpga'
warning: Function parameter or struct member 'pcidev' not described in 'cti_get_port_type_xr17v35x'
Add missed descriptions.
Fixes: f7ce07062988 ("serial: exar: add CTI specific setup code")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Tested-by: Parker Newman <pnewman@connecttech.com>
Link: https://lore.kernel.org/r/20240503171917.2921250-3-andriy.shevchenko@linux.intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/tty')
| -rw-r--r-- | drivers/tty/serial/8250/8250_exar.c | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/drivers/tty/serial/8250/8250_exar.c b/drivers/tty/serial/8250/8250_exar.c index 9930668610ca..150c4abd92fc 100644 --- a/drivers/tty/serial/8250/8250_exar.c +++ b/drivers/tty/serial/8250/8250_exar.c @@ -715,6 +715,7 @@ static int cti_read_osc_freq(struct exar8250 *priv, u8 eeprom_offset) /** * cti_get_port_type_xr17c15x_xr17v25x() - Get port type of xr17c15x/xr17v25x * @priv: Device's private structure + * @pcidev: Pointer to the PCI device for this port * @port_num: Port to get type of * * CTI xr17c15x and xr17v25x based cards port types are based on PCI IDs. @@ -807,6 +808,7 @@ static enum cti_port_type cti_get_port_type_xr17c15x_xr17v25x(struct exar8250 *p /** * cti_get_port_type_fpga() - Get the port type of a CTI FPGA card * @priv: Device's private structure + * @pcidev: Pointer to the PCI device for this port * @port_num: Port to get type of * * FPGA based cards port types are based on PCI IDs. @@ -836,6 +838,7 @@ static enum cti_port_type cti_get_port_type_fpga(struct exar8250 *priv, /** * cti_get_port_type_xr17v35x() - Read port type from the EEPROM * @priv: Device's private structure + * @pcidev: Pointer to the PCI device for this port * @port_num: port offset * * CTI XR17V35X based cards have the port types stored in the EEPROM. |