Re: [PATCH bluetooth-next] mac802154: add description to mac802154 APIs

[Alexander Aring <alex.aring@gmail.com>]

On Thu, Apr 09, 2015 at 05:41:01PM +0530, Varka Bhadram wrote:
> This patch adds the proper description to the mac802154 core APIs.
> 
> Signed-off-by: Varka Bhadram <varkab@cdac.in>

Acked-by: Alexander Aring <alex.aring@gmail.com>

> ---
>  include/net/mac802154.h |   94 ++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 92 insertions(+), 2 deletions(-)
> 
> diff --git a/include/net/mac802154.h b/include/net/mac802154.h
> index e18e7fd..0553ec0 100644
> --- a/include/net/mac802154.h
> +++ b/include/net/mac802154.h
> @@ -247,19 +247,109 @@ static inline void ieee802154_le64_to_be64(void *be64_dst, const void *le64_src)
>  	__put_unaligned_memmove64(swab64p(le64_src), be64_dst);
>  }
>  

...

just nitpicking here.

> +/**
> + * ieee802154_rx_irqsafe - receive frame
> + *

here you use the correct terminlogy "frame".

> + * Like ieee802154_rx() but can be called in IRQ context
> + * (internally defers to a tasklet.)
> + *
> + * @hw: the hardware this frame came in on
> + * @skb: the buffer to receive, owned by mac802154 after this call
> + * @lqi: link quality indicator
> + */
>  void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
>  			   u8 lqi);
> -
> +/**
> + * ieee802154_wake_queue - wake ieee802154 queue
> + * @hw: pointer as obtained from ieee802154_alloc_hw().
> + *
> + * Drivers should use this function instead of netif_wake_queue.
> + */
>  void ieee802154_wake_queue(struct ieee802154_hw *hw);
> +
> +/**
> + * ieee802154_stop_queue - stop ieee802154 queue
> + * @hw: pointer as obtained from ieee802154_alloc_hw().
> + *
> + * Drivers should use this function instead of netif_stop_queue.
> + */
>  void ieee802154_stop_queue(struct ieee802154_hw *hw);
> +
> +/**
> + * ieee802154_xmit_complete - packet transmission complete
> + *

here you use packet which is wrong. L2 is frame, see [0].

Nevertheless I like that somebody improve the commentation stuff. Thanks
:-)

> + * @hw: pointer as obtained from ieee802154_alloc_hw().
> + * @skb: buffer for transmission
> + * @ifs_handling: indicate interframe space handling
> + */
>  void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb,
>  			      bool ifs_handling);
>  

- Alex

[0] http://en.wikipedia.org/wiki/Network_packet#Terminology