Commit 734fadce authored by Chaehyun Lim's avatar Chaehyun Lim Committed by Greg Kroah-Hartman
Browse files

staging: wilc1000: remove over-commenting 



There are over-commenting in wilc_msgqueue.h file. This comment is not
explain exactly what codes do and make checkpatch warning about "line
over 80 charcters". If necessary, comment will be added later with
preferred coding style.

Signed-off-by: default avatarChaehyun Lim <chaehyun.lim@gmail.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 2c8e2dcb

drivers/staging/wilc1000/wilc_msgqueue.h

+0 −66
Original line number Diff line number Diff line 
#ifndef __WILC_MSG_QUEUE_H__

#define __WILC_MSG_QUEUE_H__



/*!

 *  @file	wilc_msgqueue.h

 *  @brief	Message Queue OS wrapper functionality

 *  @author	syounan

 *  @sa		wilc_oswrapper.h top level OS wrapper file

 *  @date	30 Aug 2010

 *  @version	1.0

 */



#include <linux/semaphore.h>



/* Message Queue type is a structure */

struct message {

	void *buf;

	u32 len;
@@ -27,67 +17,11 @@ struct message_queue { 
	struct message *msg_list;

};



/*!

 *  @brief		Creates a new Message queue

 *  @details		Creates a new Message queue, if the feature

 *                              CONFIG_WILC_MSG_QUEUE_IPC_NAME is enabled and pstrAttrs->pcName

 *                              is not Null, then this message queue can be used for IPC with

 *                              any other message queue having the same name in the system

 *  @param[in,out]	pHandle handle to the message queue object

 *  @param[in]	pstrAttrs Optional attributes, NULL for default

 *  @return		Error code indicating success/failure

 *  @author		syounan

 *  @date		30 Aug 2010

 *  @version		1.0

 */

int wilc_mq_create(struct message_queue *mq);



/*!

 *  @brief		Sends a message

 *  @details		Sends a message, this API will block until the message is

 *                              actually sent or until it is timedout (as long as the feature

 *                              CONFIG_WILC_MSG_QUEUE_TIMEOUT is enabled and pstrAttrs->u32Timeout

 *                              is not set to WILC_OS_INFINITY), zero timeout is a valid value

 *  @param[in]	pHandle handle to the message queue object

 *  @param[in]	pvSendBuffer pointer to the data to send

 *  @param[in]	u32SendBufferSize the size of the data to send

 *  @param[in]	pstrAttrs Optional attributes, NULL for default

 *  @return		Error code indicating success/failure

 *  @author		syounan

 *  @date		30 Aug 2010

 *  @version		1.0

 */

int wilc_mq_send(struct message_queue *mq,

		 const void *send_buf, u32 send_buf_size);



/*!

 *  @brief		Receives a message

 *  @details		Receives a message, this API will block until a message is

 *                              received or until it is timedout (as long as the feature

 *                              CONFIG_WILC_MSG_QUEUE_TIMEOUT is enabled and pstrAttrs->u32Timeout

 *                              is not set to WILC_OS_INFINITY), zero timeout is a valid value

 *  @param[in]	pHandle handle to the message queue object

 *  @param[out]	pvRecvBuffer pointer to a buffer to fill with the received message

 *  @param[in]	u32RecvBufferSize the size of the receive buffer

 *  @param[out]	pu32ReceivedLength the length of received data

 *  @param[in]	pstrAttrs Optional attributes, NULL for default

 *  @return		Error code indicating success/failure

 *  @author		syounan

 *  @date		30 Aug 2010

 *  @version		1.0

 */

int wilc_mq_recv(struct message_queue *mq,

		 void *recv_buf, u32 recv_buf_size, u32 *recv_len);



/*!

 *  @brief		Destroys an existing  Message queue

 *  @param[in]	pHandle handle to the message queue object

 *  @param[in]	pstrAttrs Optional attributes, NULL for default

 *  @return		Error code indicating success/failure

 *  @author		syounan

 *  @date		30 Aug 2010

 *  @version		1.0

 */

int wilc_mq_destroy(struct message_queue *mq);



#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE