Commit 7cdda1c1 authored by Andrew Lunn's avatar Andrew Lunn Committed by Jakub Kicinski
Browse files

net: nfc: Fix kerneldoc warnings 



net//nfc/core.c:1046: warning: Function parameter or member 'tx_headroom' not described in 'nfc_allocate_device'
net//nfc/core.c:1046: warning: Function parameter or member 'tx_tailroom' not described in 'nfc_allocate_device'
net//nfc/core.c:198: warning: Excess function parameter 'protocols' description in 'nfc_start_poll'
net//nfc/core.c:198: warning: Function parameter or member 'im_protocols' not described in 'nfc_start_poll'
net//nfc/core.c:198: warning: Function parameter or member 'tm_protocols' not described in 'nfc_start_poll'
net//nfc/core.c:441: warning: Function parameter or member 'mode' not described in 'nfc_deactivate_target'
net//nfc/core.c:711: warning: Function parameter or member 'dev' not described in 'nfc_alloc_send_skb'
net//nfc/core.c:711: warning: Function parameter or member 'err' not described in 'nfc_alloc_send_skb'
net//nfc/core.c:711: warning: Function parameter or member 'flags' not described in 'nfc_alloc_send_skb'
net//nfc/core.c:711: warning: Function parameter or member 'sk' not described in 'nfc_alloc_send_skb'
net//nfc/digital_core.c:470: warning: Function parameter or member 'im_protocols' not described in 'digital_start_poll'
net//nfc/digital_core.c:470: warning: Function parameter or member 'nfc_dev' not described in 'digital_start_poll'
net//nfc/digital_core.c:470: warning: Function parameter or member 'tm_protocols' not described in 'digital_start_poll'
net//nfc/nci/core.c:1119: warning: Function parameter or member 'tx_headroom' not described in 'nci_allocate_device'
net//nfc/nci/core.c:1119: warning: Function parameter or member 'tx_tailroom' not described in 'nci_allocate_device'

Signed-off-by: default avatarAndrew Lunn <andrew@lunn.ch>
Link: https://lore.kernel.org/r/20201028005653.930467-1-andrew@lunn.ch


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

net/nfc/core.c

+9 −1
Original line number Diff line number Diff line
@@ -189,7 +189,8 @@ static const struct rfkill_ops nfc_rfkill_ops = { 
 * nfc_start_poll - start polling for nfc targets

 *

 * @dev: The nfc device that must start polling

 * @protocols: bitset of nfc protocols that must be used for polling

 * @im_protocols: bitset of nfc initiator protocols to be used for polling

 * @tm_protocols: bitset of nfc transport protocols to be used for polling

 *

 * The device remains polling for targets until a target is found or

 * the nfc_stop_poll function is called.
@@ -436,6 +437,7 @@ error: 
 *

 * @dev: The nfc device that found the target

 * @target_idx: index of the target that must be deactivated

 * @mode: idle or sleep?

 */

int nfc_deactivate_target(struct nfc_dev *dev, u32 target_idx, u8 mode)

{
@@ -703,7 +705,11 @@ EXPORT_SYMBOL(nfc_tm_deactivated); 
/**

 * nfc_alloc_send_skb - allocate a skb for data exchange responses

 *

 * @dev: device sending the response

 * @sk: socket sending the response

 * @flags: MSG_DONTWAIT flag

 * @size: size to allocate

 * @err: pointer to memory to store the error code

 */

struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,

				   unsigned int flags, unsigned int size,
@@ -1039,6 +1045,8 @@ struct nfc_dev *nfc_get_device(unsigned int idx) 
 *

 * @ops: device operations

 * @supported_protocols: NFC protocols supported by the device

 * @tx_headroom: reserved space at beginning of skb

 * @tx_tailroom: reserved space at end of skb

 */

struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,

				    u32 supported_protocols,

net/nfc/digital_core.c

+3 −0
Original line number Diff line number Diff line
@@ -458,6 +458,9 @@ static void digital_add_poll_tech(struct nfc_digital_dev *ddev, u8 rf_tech, 


/**

 * start_poll operation

 * @nfc_dev: device to be polled

 * @im_protocols: bitset of nfc initiator protocols to be used for polling

 * @tm_protocols: bitset of nfc transport protocols to be used for polling

 *

 * For every supported protocol, the corresponding polling function is added

 * to the table of polling technologies (ddev->poll_techs[]) using

net/nfc/nci/core.c

+2 −0
Original line number Diff line number Diff line
@@ -1112,6 +1112,8 @@ static struct nfc_ops nci_nfc_ops = { 
 *

 * @ops: device operations

 * @supported_protocols: NFC protocols supported by the device

 * @tx_headroom: Reserved space at beginning of skb

 * @tx_tailroom: Reserved space at end of skb

 */

struct nci_dev *nci_allocate_device(struct nci_ops *ops,

				    __u32 supported_protocols,

CRA Git | Maintained and supported by SUSTech CRA and CCSE