2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-28 23:23:55 +08:00
linux-next/drivers/ipack/devices/ipoctal.h
Aditya Srivastava b716f42e87 ipac: ipoctal: fix kernel-doc syntax and remove filename from file headers
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/ipack/devices/ipoctal follows this syntax, but the
content inside does not comply with kernel-doc.

This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warning from kernel-doc.

For e.g., running scripts/kernel-doc -none on
drivers/ipack/devices/ipoctal.h emits:
warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * ipoctal.h

Provide a simple fix by replacing this occurrence with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.

Also remove the redundant file name from the comment headers.

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Link: https://lore.kernel.org/r/20210522121944.11182-1-yashsri421@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-05-27 14:39:42 +02:00

37 lines
871 B
C

/* SPDX-License-Identifier: GPL-2.0-only */
/*
* driver for the IPOCTAL boards
*
* Copyright (C) 2009-2012 CERN (www.cern.ch)
* Author: Nicolas Serafini, EIC2 SA
* Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
*/
#ifndef _IPOCTAL_H_
#define _IPOCTAL_H_
#define NR_CHANNELS 8
#define IPOCTAL_MAX_BOARDS 16
#define MAX_DEVICES (NR_CHANNELS * IPOCTAL_MAX_BOARDS)
/**
* struct ipoctal_stats -- Stats since last reset
*
* @tx: Number of transmitted bytes
* @rx: Number of received bytes
* @overrun: Number of overrun errors
* @parity_err: Number of parity errors
* @framing_err: Number of framing errors
* @rcv_break: Number of break received
*/
struct ipoctal_stats {
unsigned long tx;
unsigned long rx;
unsigned long overrun_err;
unsigned long parity_err;
unsigned long framing_err;
unsigned long rcv_break;
};
#endif /* _IPOCTAL_H_ */