138 lines
4.8 KiB
C
138 lines
4.8 KiB
C
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \file wsf_msg.h
|
||
|
|
*
|
||
|
|
* \brief Message passing service.
|
||
|
|
*
|
||
|
|
* $Date: 2017-03-10 14:08:37 -0600 (Fri, 10 Mar 2017) $
|
||
|
|
* $Revision: 11501 $
|
||
|
|
*
|
||
|
|
* Copyright (c) 2009-2017 ARM Ltd., all rights reserved.
|
||
|
|
* ARM Ltd. confidential and proprietary.
|
||
|
|
*
|
||
|
|
* IMPORTANT. Your use of this file is governed by a Software License Agreement
|
||
|
|
* ("Agreement") that must be accepted in order to download or otherwise receive a
|
||
|
|
* copy of this file. You may not use or copy this file for any purpose other than
|
||
|
|
* as described in the Agreement. If you do not agree to all of the terms of the
|
||
|
|
* Agreement do not use this file and delete all copies in your possession or control;
|
||
|
|
* if you do not have a copy of the Agreement, you must contact ARM Ltd. prior
|
||
|
|
* to any use, copying or further distribution of this software.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
#ifndef WSF_MSG_H
|
||
|
|
#define WSF_MSG_H
|
||
|
|
|
||
|
|
#include "wsf_queue.h"
|
||
|
|
#include "wsf_os.h"
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**************************************************************************************************
|
||
|
|
Function Declarations
|
||
|
|
**************************************************************************************************/
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgDataAlloc
|
||
|
|
*
|
||
|
|
* \brief Allocate a data message buffer to be sent with WsfMsgSend().
|
||
|
|
*
|
||
|
|
* \param len Message length in bytes.
|
||
|
|
* \param tailroom Tailroom length in bytes.
|
||
|
|
*
|
||
|
|
* \return Pointer to data message buffer or NULL if allocation failed.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void *WsfMsgDataAlloc(uint16_t len, uint8_t tailroom);
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgAlloc
|
||
|
|
*
|
||
|
|
* \brief Allocate a message buffer to be sent with WsfMsgSend().
|
||
|
|
*
|
||
|
|
* \param len Message length in bytes.
|
||
|
|
*
|
||
|
|
* \return Pointer to message buffer or NULL if allocation failed.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void *WsfMsgAlloc(uint16_t len);
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgFree
|
||
|
|
*
|
||
|
|
* \brief Free a message buffer allocated with WsfMsgAlloc().
|
||
|
|
*
|
||
|
|
* \param pMsg Pointer to message buffer.
|
||
|
|
*
|
||
|
|
* \return None.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void WsfMsgFree(void *pMsg);
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgSend
|
||
|
|
*
|
||
|
|
* \brief Send a message to an event handler.
|
||
|
|
*
|
||
|
|
* \param handlerId Event handler ID.
|
||
|
|
* \param pMsg Pointer to message buffer.
|
||
|
|
*
|
||
|
|
* \return None.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void WsfMsgSend(wsfHandlerId_t handlerId, void *pMsg);
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgEnq
|
||
|
|
*
|
||
|
|
* \brief Enqueue a message.
|
||
|
|
*
|
||
|
|
* \param pQueue Pointer to queue.
|
||
|
|
* \param handerId Set message handler ID to this value.
|
||
|
|
* \param pElem Pointer to message buffer.
|
||
|
|
*
|
||
|
|
* \return None.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void WsfMsgEnq(wsfQueue_t *pQueue, wsfHandlerId_t handlerId, void *pMsg);
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgDeq
|
||
|
|
*
|
||
|
|
* \brief Dequeue a message.
|
||
|
|
*
|
||
|
|
* \param pQueue Pointer to queue.
|
||
|
|
* \param pHandlerId Handler ID of returned message; this is a return parameter.
|
||
|
|
*
|
||
|
|
* \return Pointer to message that has been dequeued or NULL if queue is empty.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void *WsfMsgDeq(wsfQueue_t *pQueue, wsfHandlerId_t *pHandlerId);
|
||
|
|
|
||
|
|
/*************************************************************************************************/
|
||
|
|
/*!
|
||
|
|
* \fn WsfMsgPeek
|
||
|
|
*
|
||
|
|
* \brief Get the next message without removing it from the queue.
|
||
|
|
*
|
||
|
|
* \param pQueue Pointer to queue.
|
||
|
|
* \param pHandlerId Handler ID of returned message; this is a return parameter.
|
||
|
|
*
|
||
|
|
* \return Pointer to the next message on the queue or NULL if queue is empty.
|
||
|
|
*/
|
||
|
|
/*************************************************************************************************/
|
||
|
|
void *WsfMsgPeek(wsfQueue_t *pQueue, wsfHandlerId_t *pHandlerId);
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
};
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* WSF_MSG_H */
|