ztcqueue.h

freescale的基于802.15.4的无线通讯例程

/******************************************************************************
* This file exposes the services of ZTC queue module.
*
*
* (c) Copyright 2006, Freescale, Inc. All rights reserved.
*
* Freescale Semiconductor Confidential Proprietary
*
* No part of this document must be reproduced in any form - including copied,
* transcribed, printed or by any electronic means - without specific written
* permission from Freescale Semiconductor Danmark A/S.
*
******************************************************************************/
#if ( gZtcIncluded_d == 1  ) 

#ifndef _ZTCQUEUE_H_
#define _ZTCQUEUE_H_

/******************************************************************************
*******************************************************************************
* Public macros
*******************************************************************************
******************************************************************************/

#define gZTCCannotBeQueued_c  255

/*****************************************************************************
* Checks whether enough space is available for msg in the Ztc buffer
*
* Interface assumptions:
*       None
*
* The routine limitations.
*       None
*
* Return value:
*       None
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/
#define ZTCQueue_SpaceAvailableToWriteIntoBuffer  \
         ((gZTCBufferLength_c) - (gtZTCBufferTail))
         
         
/******************************************************************************
*******************************************************************************
* Public type definitions
*******************************************************************************
******************************************************************************/
/* None */        

/******************************************************************************
*******************************************************************************
* Public prototypes
*******************************************************************************
******************************************************************************/

/*****************************************************************************
* This method gets the message sent by the test toll from the serial interface
* and calls the Primitive handler to processes it.
*
* Interface assumptions:
*       None
*
* The routine limitations.
*       None
*
* Return value:
*       None
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/
void ZTCQueue_QueueTheMsgFromTestClient( void );

/*****************************************************************************
* If ZTC task receives an event to send data from Ztc to Test client,this
* function is called.It handles sending of multiple number of messages stored
* in the ZTC Q to Test client. 
*
* Interface assumptions:
*       None
*
* The routine limitations.
*       None
*
* Return value:
*       None
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/
void ZTCQueue_SendMsgFromQToTestClient( void );

/*****************************************************************************
* This function sends  inject messages  to test client
*
* Interface assumptions:
*       None
*
* The routine limitations.
*       None
*
* Return value:
*       None
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/
void ZTCQueue_QueueToSendToTestClient
  (
  const uint8_t* pMsg,          /* IN : Pointer to the msg sent to the SAP */
  const uint8_t SAPId,          /* IN : SAP ID used in ZTC */
  const uint8_t msgIdUsedInZTC, /* IN : Message ID used in ZTC  */
  const uint8_t status					/* IN : Status returned from the SAP Handler */
  );

/******************************************************************************
*******************************************************************************
* Public memory declarations
*******************************************************************************
******************************************************************************/
/* Buffer to store the data for ZTC.It stores data from Test client to ZTC and 
Data to Test client from SAP */
extern uint8_t aZTCBuffer[ gZTCBufferLength_c ];

/* Head of the ZTC buffer queue */  
extern uint8_t ghZTCBufferHead;

/* Tail of the ZTC buffer queue */  
extern uint8_t gtZTCBufferTail;


/******************************************************************************
*******************************************************************************
* Public functions
*******************************************************************************
******************************************************************************/
/* None */

#endif /* _ZTCQUEUE_H_  */
#endif /* ( gZtcIncluded_d == 1  ) */