serialq.h

关于zigbee厂家jennic的zigbee通信模块JN5139的一些示例程序。

/***************************************************************************/
/*!
 *\MODULE              Wireless UART with Flow Control
 *
 *\COMPONENT           $RCSfile: SerialQ.h,v $
 *
 *\VERSION             $Name:  $
 *
 *\REVISION            $Revision: 1.1 $
 *
 *\DATED               $Date: 2008/01/21 10:15:05 $
 *
 *\STATUS              $State: Exp $
 *
 *\AUTHOR              Ian Morris
 *	   \n			   Martin Looker
 *
 *\DESCRIPTION         Circular queue for serial port use.
 */
/*\CHANGE HISTORY
 *
 * $Log: SerialQ.h,v $
 * Revision 1.1  2008/01/21 10:15:05  mlook
 * Initial checkin
 *
 * Revision 1.1  2007/11/02 12:32:53  mlook
 * Adding new application notes
 *
 *
 *
 *\LAST MODIFIED BY    $Author: mlook $
 *                     $Modtime: $
 *
 ****************************************************************************
 *
 * This software is owned by Jennic and/or its supplier and is protected
 * under applicable copyright laws. All rights are reserved. We grant You,
 * and any third parties, a license to use this software solely and
 * exclusively on Jennic products. You, and any third parties must reproduce
 * the copyright and warranty notice and any other legend of ownership on each
 * copy or partial copy of the software.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS". JENNIC MAKES NO WARRANTIES, WHETHER
 * EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
 * ACCURACY OR LACK OF NEGLIGENCE. JENNIC SHALL NOT, IN ANY CIRCUMSTANCES,
 * BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, SPECIAL,
 * INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR ANY REASON WHATSOEVER.
 *
 * Copyright Jennic Ltd 2005, 2006, 2007. All rights reserved
 *
 ****************************************************************************/


#ifndef  SERIALQ_H_INCLUDED
#define  SERIALQ_H_INCLUDED

#if defined __cplusplus
extern "C" {
#endif

/****************************************************************************/
/***        Include Files                                                 ***/
/****************************************************************************/
#include <jendefs.h>

/****************************************************************************/
/***        Macro Definitions                                             ***/
/****************************************************************************/

/****************************************************************************/
/***        Type Definitions                                              ***/
/****************************************************************************/
/* Queue references */
typedef enum
{
	RX_QUEUE = 0,	/**< Receive queue reference */
	TX_QUEUE		/**< Transmit queue reference */
}   teQueueRef;

/****************************************************************************/
/***        Exported Functions                                            ***/
/****************************************************************************/
PUBLIC void     vSerialQ_Init(void);
PUBLIC void     vSerialQ_AddItem(teQueueRef, uint8);
PUBLIC uint8   u8SerialQ_RemoveItem(teQueueRef);
PUBLIC bool_t   bSerialQ_Full(teQueueRef);
PUBLIC bool_t   bSerialQ_Empty(teQueueRef);
PUBLIC void     vSerialQ_AddString(teQueueRef, char *);
PUBLIC void 	vSerialQ_AddHex(teQueueRef, uint16, uint8);
PUBLIC uint16 u16SerialQ_Count(teQueueRef eQueue);
PUBLIC uint16 u16SerialQ_Free(teQueueRef eQueue);
PUBLIC uint16 u16SerialQ_GetInCount(teQueueRef eQueue);
PUBLIC uint16 u16SerialQ_GetOutCount(teQueueRef eQueue);

/****************************************************************************/
/***        Exported Variables                                            ***/
/****************************************************************************/

#if defined __cplusplus
}
#endif

#endif  /* SERIALQ_H_INCLUDED */

/****************************************************************************/
/***        END OF FILE                                                   ***/
/****************************************************************************/