mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-10-05 16:37:50 +00:00
Code Issues Releases Wiki Activity

s390/netiucv: remove incorrect kernel doc indicators

Browse source 
Many comments above functions start with a kernel doc indicator, but
the comments are not using kernel doc style. Get rid of the warnings
by simply removing the indicator.

E.g.:

drivers/s390/net/netiucv.c:1852: warning:
 This comment starts with '/**', but isn't a kernel-doc comment.

Reviewed-by: Alexandra Winter <wintera@linux.ibm.com>
Signed-off-by: Heiko Carstens <hca@linux.ibm.com>
Signed-off-by: Karsten Graul <kgraul@linux.ibm.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Heiko Carstens 2021-09-14 10:33:19 +02:00 committed by David S. Miller
parent 239686c11f
commit 478a31403b
2 changed files with 53 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
drivers/s390/net/fsm.c
View file

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* A generic FSM based on fsm used in isdn4linux * A generic FSM based on fsm used in isdn4linux
* *
*/ */

104
drivers/s390/net/netiucv.c
View file

@ -58,7 +58,7 @@ MODULE_AUTHOR
("(C) 2001 IBM Corporation by Fritz Elfert (felfert@millenux.com)"); ("(C) 2001 IBM Corporation by Fritz Elfert (felfert@millenux.com)");
MODULE_DESCRIPTION ("Linux for S/390 IUCV network driver"); MODULE_DESCRIPTION ("Linux for S/390 IUCV network driver");
/** /*
* Debug Facility stuff * Debug Facility stuff
*/ */
#define IUCV_DBF_SETUP_NAME "iucv_setup" #define IUCV_DBF_SETUP_NAME "iucv_setup"
@ -107,7 +107,7 @@ DECLARE_PER_CPU(char[256], iucv_dbf_txt_buf);
debug_sprintf_event(iucv_dbf_trace, level, text ); \ debug_sprintf_event(iucv_dbf_trace, level, text ); \
} while (0) } while (0)
/** /*
* some more debug stuff * some more debug stuff
*/ */
#define PRINTK_HEADER " iucv: " /* for debugging */ #define PRINTK_HEADER " iucv: " /* for debugging */
@ -118,7 +118,7 @@ static struct device_driver netiucv_driver = {
.bus = &iucv_bus, .bus = &iucv_bus,
}; };
/** /*
* Per connection profiling data * Per connection profiling data
*/ */
struct connection_profile { struct connection_profile {
@ -133,7 +133,7 @@ struct connection_profile {
unsigned long tx_max_pending; unsigned long tx_max_pending;
}; };
/** /*
* Representation of one iucv connection * Representation of one iucv connection
*/ */
struct iucv_connection { struct iucv_connection {
@ -154,13 +154,13 @@ struct iucv_connection {
char userdata[17]; char userdata[17];
}; };
/** /*
* Linked list of all connection structs. * Linked list of all connection structs.
*/ */
static LIST_HEAD(iucv_connection_list); static LIST_HEAD(iucv_connection_list);
static DEFINE_RWLOCK(iucv_connection_rwlock); static DEFINE_RWLOCK(iucv_connection_rwlock);
/** /*
* Representation of event-data for the * Representation of event-data for the
* connection state machine. * connection state machine.
*/ */
@ -169,7 +169,7 @@ struct iucv_event {
void *data; void *data;
}; };
/** /*
* Private part of the network device structure * Private part of the network device structure
*/ */
struct netiucv_priv { struct netiucv_priv {
@ -180,7 +180,7 @@ struct netiucv_priv {
struct device *dev; struct device *dev;
}; };
/** /*
* Link level header for a packet. * Link level header for a packet.
*/ */
struct ll_header { struct ll_header {
@ -195,7 +195,7 @@ struct ll_header {
#define NETIUCV_QUEUELEN_DEFAULT 50 #define NETIUCV_QUEUELEN_DEFAULT 50
#define NETIUCV_TIMEOUT_5SEC 5000 #define NETIUCV_TIMEOUT_5SEC 5000
/** /*
* Compatibility macros for busy handling * Compatibility macros for busy handling
* of network devices. * of network devices.
*/ */
@ -223,7 +223,7 @@ static u8 iucvMagic_ebcdic[16] = {
0xF0, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40 0xF0, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40
}; };
/** /*
* Convert an iucv userId to its printable * Convert an iucv userId to its printable
* form (strip whitespace at end). * form (strip whitespace at end).
* *
@ -262,7 +262,7 @@ static char *netiucv_printuser(struct iucv_connection *conn)
return netiucv_printname(conn->userid, 8); return netiucv_printname(conn->userid, 8);
} }
/** /*
* States of the interface statemachine. * States of the interface statemachine.
*/ */
enum dev_states { enum dev_states {
@ -270,7 +270,7 @@ enum dev_states {
DEV_STATE_STARTWAIT, DEV_STATE_STARTWAIT,
DEV_STATE_STOPWAIT, DEV_STATE_STOPWAIT,
DEV_STATE_RUNNING, DEV_STATE_RUNNING,
/** /*
* MUST be always the last element!! * MUST be always the last element!!
*/ */
NR_DEV_STATES NR_DEV_STATES
@ -283,7 +283,7 @@ static const char *dev_state_names[] = {
"Running", "Running",
}; };
/** /*
* Events of the interface statemachine. * Events of the interface statemachine.
*/ */
enum dev_events { enum dev_events {
@ -291,7 +291,7 @@ enum dev_events {
DEV_EVENT_STOP, DEV_EVENT_STOP,
DEV_EVENT_CONUP, DEV_EVENT_CONUP,
DEV_EVENT_CONDOWN, DEV_EVENT_CONDOWN,
/** /*
* MUST be always the last element!! * MUST be always the last element!!
*/ */
NR_DEV_EVENTS NR_DEV_EVENTS
@ -304,11 +304,11 @@ static const char *dev_event_names[] = {
"Connection down", "Connection down",
}; };
/** /*
* Events of the connection statemachine * Events of the connection statemachine
*/ */
enum conn_events { enum conn_events {
/** /*
* Events, representing callbacks from * Events, representing callbacks from
* lowlevel iucv layer) * lowlevel iucv layer)
*/ */
@ -320,23 +320,23 @@ enum conn_events {
CONN_EVENT_RX, CONN_EVENT_RX,
CONN_EVENT_TXDONE, CONN_EVENT_TXDONE,
/** /*
* Events, representing errors return codes from * Events, representing errors return codes from
* calls to lowlevel iucv layer * calls to lowlevel iucv layer
*/ */
/** /*
* Event, representing timer expiry. * Event, representing timer expiry.
*/ */
CONN_EVENT_TIMER, CONN_EVENT_TIMER,
/** /*
* Events, representing commands from upper levels. * Events, representing commands from upper levels.
*/ */
CONN_EVENT_START, CONN_EVENT_START,
CONN_EVENT_STOP, CONN_EVENT_STOP,
/** /*
* MUST be always the last element!! * MUST be always the last element!!
*/ */
NR_CONN_EVENTS, NR_CONN_EVENTS,
@ -357,55 +357,55 @@ static const char *conn_event_names[] = {
"Stop", "Stop",
}; };
/** /*
* States of the connection statemachine. * States of the connection statemachine.
*/ */
enum conn_states { enum conn_states {
/** /*
* Connection not assigned to any device, * Connection not assigned to any device,
* initial state, invalid * initial state, invalid
*/ */
CONN_STATE_INVALID, CONN_STATE_INVALID,
/** /*
* Userid assigned but not operating * Userid assigned but not operating
*/ */
CONN_STATE_STOPPED, CONN_STATE_STOPPED,
/** /*
* Connection registered, * Connection registered,
* no connection request sent yet, * no connection request sent yet,
* no connection request received * no connection request received
*/ */
CONN_STATE_STARTWAIT, CONN_STATE_STARTWAIT,
/** /*
* Connection registered and connection request sent, * Connection registered and connection request sent,
* no acknowledge and no connection request received yet. * no acknowledge and no connection request received yet.
*/ */
CONN_STATE_SETUPWAIT, CONN_STATE_SETUPWAIT,
/** /*
* Connection up and running idle * Connection up and running idle
*/ */
CONN_STATE_IDLE, CONN_STATE_IDLE,
/** /*
* Data sent, awaiting CONN_EVENT_TXDONE * Data sent, awaiting CONN_EVENT_TXDONE
*/ */
CONN_STATE_TX, CONN_STATE_TX,
/** /*
* Error during registration. * Error during registration.
*/ */
CONN_STATE_REGERR, CONN_STATE_REGERR,
/** /*
* Error during registration. * Error during registration.
*/ */
CONN_STATE_CONNERR, CONN_STATE_CONNERR,
/** /*
* MUST be always the last element!! * MUST be always the last element!!
*/ */
NR_CONN_STATES, NR_CONN_STATES,
@ -424,7 +424,7 @@ static const char *conn_state_names[] = {
}; };
/** /*
* Debug Facility Stuff * Debug Facility Stuff
*/ */
static debug_info_t *iucv_dbf_setup = NULL; static debug_info_t *iucv_dbf_setup = NULL;
@ -556,7 +556,7 @@ static void netiucv_callback_connres(struct iucv_path *path, u8 *ipuser)
fsm_event(conn->fsm, CONN_EVENT_CONN_RES, conn); fsm_event(conn->fsm, CONN_EVENT_CONN_RES, conn);
} }
/** /*
* NOP action for statemachines * NOP action for statemachines
*/ */
static void netiucv_action_nop(fsm_instance *fi, int event, void *arg) static void netiucv_action_nop(fsm_instance *fi, int event, void *arg)
@ -567,7 +567,7 @@ static void netiucv_action_nop(fsm_instance *fi, int event, void *arg)
* Actions of the connection statemachine * Actions of the connection statemachine
*/ */
/** /*
* netiucv_unpack_skb * netiucv_unpack_skb
* @conn: The connection where this skb has been received. * @conn: The connection where this skb has been received.
* @pskb: The received skb. * @pskb: The received skb.
@ -993,7 +993,7 @@ static const int CONN_FSM_LEN = sizeof(conn_fsm) / sizeof(fsm_node);
* Actions for interface - statemachine. * Actions for interface - statemachine.
*/ */
/** /*
* dev_action_start * dev_action_start
* @fi: An instance of an interface statemachine. * @fi: An instance of an interface statemachine.
* @event: The event, just happened. * @event: The event, just happened.
@ -1012,7 +1012,7 @@ static void dev_action_start(fsm_instance *fi, int event, void *arg)
fsm_event(privptr->conn->fsm, CONN_EVENT_START, privptr->conn); fsm_event(privptr->conn->fsm, CONN_EVENT_START, privptr->conn);
} }
/** /*
* Shutdown connection by sending CONN_EVENT_STOP to it. * Shutdown connection by sending CONN_EVENT_STOP to it.
* *
* @param fi An instance of an interface statemachine. * @param fi An instance of an interface statemachine.
@ -1034,7 +1034,7 @@ dev_action_stop(fsm_instance *fi, int event, void *arg)
fsm_event(privptr->conn->fsm, CONN_EVENT_STOP, &ev); fsm_event(privptr->conn->fsm, CONN_EVENT_STOP, &ev);
} }
/** /*
* Called from connection statemachine * Called from connection statemachine
* when a connection is up and running. * when a connection is up and running.
* *
@ -1067,7 +1067,7 @@ dev_action_connup(fsm_instance *fi, int event, void *arg)
} }
} }
/** /*
* Called from connection statemachine * Called from connection statemachine
* when a connection has been shutdown. * when a connection has been shutdown.
* *
@ -1107,7 +1107,7 @@ static const fsm_node dev_fsm[] = {
static const int DEV_FSM_LEN = sizeof(dev_fsm) / sizeof(fsm_node); static const int DEV_FSM_LEN = sizeof(dev_fsm) / sizeof(fsm_node);
/** /*
* Transmit a packet. * Transmit a packet.
* This is a helper function for netiucv_tx(). * This is a helper function for netiucv_tx().
* *
@ -1144,7 +1144,7 @@ static int netiucv_transmit_skb(struct iucv_connection *conn,
spin_unlock_irqrestore(&conn->collect_lock, saveflags); spin_unlock_irqrestore(&conn->collect_lock, saveflags);
} else { } else {
struct sk_buff *nskb = skb; struct sk_buff *nskb = skb;
/** /*
* Copy the skb to a new allocated skb in lowmem only if the * Copy the skb to a new allocated skb in lowmem only if the
* data is located above 2G in memory or tailroom is < 2. * data is located above 2G in memory or tailroom is < 2.
*/ */
@ -1164,7 +1164,7 @@ static int netiucv_transmit_skb(struct iucv_connection *conn,
} }
copied = 1; copied = 1;
} }
/** /*
* skb now is below 2G and has enough room. Add headers. * skb now is below 2G and has enough room. Add headers.
*/ */
header.next = nskb->len + NETIUCV_HDRLEN; header.next = nskb->len + NETIUCV_HDRLEN;
@ -1194,7 +1194,7 @@ static int netiucv_transmit_skb(struct iucv_connection *conn,
if (copied) if (copied)
dev_kfree_skb(nskb); dev_kfree_skb(nskb);
else { else {
/** /*
* Remove our headers. They get added * Remove our headers. They get added
* again on retransmit. * again on retransmit.
*/ */
@ -1217,7 +1217,7 @@ static int netiucv_transmit_skb(struct iucv_connection *conn,
* Interface API for upper network layers * Interface API for upper network layers
*/ */
/** /*
* Open an interface. * Open an interface.
* Called from generic network layer when ifconfig up is run. * Called from generic network layer when ifconfig up is run.
* *
@ -1233,7 +1233,7 @@ static int netiucv_open(struct net_device *dev)
return 0; return 0;
} }
/** /*
* Close an interface. * Close an interface.
* Called from generic network layer when ifconfig down is run. * Called from generic network layer when ifconfig down is run.
* *
@ -1249,7 +1249,7 @@ static int netiucv_close(struct net_device *dev)
return 0; return 0;
} }
/** /*
* Start transmission of a packet. * Start transmission of a packet.
* Called from generic network device layer. * Called from generic network device layer.
* *
@ -1266,7 +1266,7 @@ static int netiucv_tx(struct sk_buff *skb, struct net_device *dev)
int rc; int rc;
IUCV_DBF_TEXT(trace, 4, __func__); IUCV_DBF_TEXT(trace, 4, __func__);
/** /*
* Some sanity checks ... * Some sanity checks ...
*/ */
if (skb == NULL) { if (skb == NULL) {
@ -1282,7 +1282,7 @@ static int netiucv_tx(struct sk_buff *skb, struct net_device *dev)
return NETDEV_TX_OK; return NETDEV_TX_OK;
} }
/** /*
* If connection is not running, try to restart it * If connection is not running, try to restart it
* and throw away packet. * and throw away packet.
*/ */
@ -1304,7 +1304,7 @@ static int netiucv_tx(struct sk_buff *skb, struct net_device *dev)
return rc ? NETDEV_TX_BUSY : NETDEV_TX_OK; return rc ? NETDEV_TX_BUSY : NETDEV_TX_OK;
} }
/** /*
* netiucv_stats * netiucv_stats
* @dev: Pointer to interface struct. * @dev: Pointer to interface struct.
* *
@ -1745,7 +1745,7 @@ static void netiucv_unregister_device(struct device *dev)
device_unregister(dev); device_unregister(dev);
} }
/** /*
* Allocate and initialize a new connection structure. * Allocate and initialize a new connection structure.
* Add it to the list of netiucv connections; * Add it to the list of netiucv connections;
*/ */
@ -1802,7 +1802,7 @@ static struct iucv_connection *netiucv_new_connection(struct net_device *dev,
return NULL; return NULL;
} }
/** /*
* Release a connection structure and remove it from the * Release a connection structure and remove it from the
* list of netiucv connections. * list of netiucv connections.
*/ */
@ -1826,7 +1826,7 @@ static void netiucv_remove_connection(struct iucv_connection *conn)
kfree_skb(conn->tx_buff); kfree_skb(conn->tx_buff);
} }
/** /*
* Release everything of a net device. * Release everything of a net device.
*/ */
static void netiucv_free_netdevice(struct net_device *dev) static void netiucv_free_netdevice(struct net_device *dev)
@ -1848,7 +1848,7 @@ static void netiucv_free_netdevice(struct net_device *dev)
} }
} }
/** /*
* Initialize a net device. (Called from kernel in alloc_netdev()) * Initialize a net device. (Called from kernel in alloc_netdev())
*/ */
static const struct net_device_ops netiucv_netdev_ops = { static const struct net_device_ops netiucv_netdev_ops = {
@ -1873,7 +1873,7 @@ static void netiucv_setup_netdevice(struct net_device *dev)
dev->netdev_ops = &netiucv_netdev_ops; dev->netdev_ops = &netiucv_netdev_ops;
} }
/** /*
* Allocate and initialize everything of a net device. * Allocate and initialize everything of a net device.
*/ */
static struct net_device *netiucv_init_netdevice(char *username, char *userdata) static struct net_device *netiucv_init_netdevice(char *username, char *userdata)