From 51626a48d45235a6811d09fcbd2b453f8714ba79 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Fri, 15 Mar 2019 11:33:53 +0100 Subject: [PATCH] netdev: document valid values for iolist in send() --- drivers/include/net/netdev.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/drivers/include/net/netdev.h b/drivers/include/net/netdev.h index 2d4135b973..c94c786e89 100644 --- a/drivers/include/net/netdev.h +++ b/drivers/include/net/netdev.h @@ -297,7 +297,11 @@ typedef struct netdev_driver { * @pre `(dev != NULL) && (iolist != NULL` * * @param[in] dev Network device descriptor. Must not be NULL. - * @param[in] iolist io vector list to send + * @param[in] iolist IO vector list to send. Elements of this list may + * have iolist_t::iol_data == NULL or + * iolist_t::iol_size == 0. However, unless otherwise + * specified by the device, the *first* element + * must contain data. * * @return negative errno on error * @return number of bytes sent