Commit c8f638b7 authored by Lee Jones's avatar Lee Jones Committed by Jakub Kicinski
Browse files

net: ieee802154: ca8210: Fix a bunch of kernel-doc issues 



Fixes the following W=1 kernel build warning(s):

 drivers/net/ieee802154/ca8210.c:326: warning: Function parameter or member 'readq' not described in 'ca8210_test'
 drivers/net/ieee802154/ca8210.c:375: warning: Function parameter or member 'spi_transfer_complete' not described in 'ca8210_priv'
 drivers/net/ieee802154/ca8210.c:375: warning: Function parameter or member 'sync_exchange_complete' not described in 'ca8210_priv'
 drivers/net/ieee802154/ca8210.c:375: warning: Function parameter or member 'promiscuous' not described in 'ca8210_priv'
 drivers/net/ieee802154/ca8210.c:430: warning: Function parameter or member 'short_address' not described in 'macaddr'
 drivers/net/ieee802154/ca8210.c:723: warning: Function parameter or member 'cas_ctl' not described in 'ca8210_rx_done'
 drivers/net/ieee802154/ca8210.c:723: warning: Excess function parameter 'arg' description in 'ca8210_rx_done'
 drivers/net/ieee802154/ca8210.c:1289: warning: Excess function parameter 'device_ref' description in 'tdme_checkpibattribute'
 drivers/net/ieee802154/ca8210.c:3054: warning: Function parameter or member 'spi_device' not described in 'ca8210_remove'
 drivers/net/ieee802154/ca8210.c:3054: warning: Excess function parameter 'priv' description in 'ca8210_remove'
 drivers/net/ieee802154/ca8210.c:3104: warning: Function parameter or member 'spi_device' not described in 'ca8210_probe'
 drivers/net/ieee802154/ca8210.c:3104: warning: Excess function parameter 'priv' description in 'ca8210_probe'

Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Acked-by: default avatarStefan Schmidt <stefan@datenfreihafen.org>
Link: https://lore.kernel.org/r/20201102114512.1062724-21-lee.jones@linaro.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent f40b160d

drivers/net/ieee802154/ca8210.c

+11 −11
Original line number Diff line number Diff line
@@ -316,6 +316,7 @@ struct cas_control { 
 * struct ca8210_test - ca8210 test interface structure

 * @ca8210_dfs_spi_int: pointer to the entry in the debug fs for this device

 * @up_fifo:            fifo for upstream messages

 * @readq:              read wait queue

 *

 * This structure stores all the data pertaining to the debug interface

 */
@@ -346,10 +347,10 @@ struct ca8210_test { 
 * @ca8210_is_awake:        nonzero if ca8210 is initialised, ready for comms

 * @sync_down:              counts number of downstream synchronous commands

 * @sync_up:                counts number of upstream synchronous commands

 * @spi_transfer_complete   completion object for a single spi_transfer

 * @sync_exchange_complete  completion object for a complete synchronous API

 * @spi_transfer_complete:  completion object for a single spi_transfer

 * @sync_exchange_complete: completion object for a complete synchronous API

 *                          exchange

 * @promiscuous             whether the ca8210 is in promiscuous mode or not

 * @promiscuous:            whether the ca8210 is in promiscuous mode or not

 * @retries:                records how many times the current pending spi

 *                          transfer has been retried

 */
@@ -420,7 +421,7 @@ struct fulladdr { 


/**

 * union macaddr: generic MAC address container

 * @short_addr:   16-bit short address

 * @short_address: 16-bit short address

 * @ieee_address:  64-bit extended address as LE byte array

 *

 */
@@ -714,7 +715,7 @@ static void ca8210_mlme_reset_worker(struct work_struct *work) 
/**

 * ca8210_rx_done() - Calls various message dispatches responding to a received

 *                    command

 * @arg:  Pointer to the cas_control object for the relevant spi transfer

 * @cas_ctrl: Pointer to the cas_control object for the relevant spi transfer

 *

 * Presents a received SAP command from the ca8210 to the Cascoda EVBME, test

 * interface and network driver.
@@ -1277,7 +1278,6 @@ static u8 tdme_channelinit(u8 channel, void *device_ref) 
 * @pib_attribute:        Attribute Number

 * @pib_attribute_length: Attribute length

 * @pib_attribute_value:  Pointer to Attribute Value

 * @device_ref:           Nondescript pointer to target device

 *

 * Return: 802.15.4 status code of checks

 */
@@ -3046,7 +3046,7 @@ static void ca8210_test_interface_clear(struct ca8210_priv *priv) 


/**

 * ca8210_remove() - Shut down a ca8210 upon being disconnected

 * @priv:  Pointer to private data structure

 * @spi_device:  Pointer to spi device data structure

 *

 * Return: 0 or linux error code

 */
@@ -3096,7 +3096,7 @@ static int ca8210_remove(struct spi_device *spi_device) 


/**

 * ca8210_probe() - Set up a connected ca8210 upon being detected by the system

 * @priv:  Pointer to private data structure

 * @spi_device:  Pointer to spi device data structure

 *

 * Return: 0 or linux error code

 */