From bc8d964cb9052f0ae761ff98f2ac32762e5a4e43 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Tue, 19 Nov 2019 20:46:43 -0600 Subject: [PATCH] net/netlink: Add some comments about 'Input Parameters' --- include/nuttx/net/netlink.h | 8 ++++++++ net/netlink/netlink_conn.c | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/include/nuttx/net/netlink.h b/include/nuttx/net/netlink.h index f126375673..cbf99105b2 100644 --- a/include/nuttx/net/netlink.h +++ b/include/nuttx/net/netlink.h @@ -100,6 +100,14 @@ extern "C" * Note: The network will be momentarily locked to support exclusive * access to the pending response list. * + * Input Parameters: + * handle - The handle previously provided to the sendto() implementation + * for the protocol. This is an opaque reference to the Netlink + * socket state structure. + * resp - The response to the request. The memory referenced by 'resp' + * must have been allocated via kmm_malloc(). It will be freed + * using kmm_free() after it has been consumed. + * ****************************************************************************/ void netlink_add_response(NETLINK_HANDLE handle, diff --git a/net/netlink/netlink_conn.c b/net/netlink/netlink_conn.c index 4439bb387b..0acc0a584d 100644 --- a/net/netlink/netlink_conn.c +++ b/net/netlink/netlink_conn.c @@ -345,6 +345,14 @@ FAR struct netlink_conn_s *netlink_active(FAR struct sockaddr_nl *addr) * Note: The network will be momentarily locked to support exclusive * access to the pending response list. * + * Input Parameters: + * handle - The handle previously provided to the sendto() implementation + * for the protocol. This is an opaque reference to the Netlink + * socket state structure. + * resp - The response to the request. The memory referenced by 'resp' + * must have been allocated via kmm_malloc(). It will be freed + * using kmm_free() after it has been consumed. + * ****************************************************************************/ void netlink_add_response(NETLINK_HANDLE handle,