ztcprimitivehandlersimpleprimitive.h

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

/******************************************************************************
* This file exposes the functionality of ZTC Simple Primitive handler module.
*
*
* (c) Copyright 2006, Freescale, Inc. All rigZtchts 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 _ZTCPRIMITIVEHANDLERSIMPLEPRIMITIVE_H_
#define _ZTCPRIMITIVEHANDLERSIMPLEPRIMITIVE_H_

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

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

/******************************************************************************
*******************************************************************************
* Public type definitions
*******************************************************************************
******************************************************************************/
/* None */

/******************************************************************************
*******************************************************************************
* Public memory declarations
*******************************************************************************
******************************************************************************/
/* None */

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

/*****************************************************************************
* This will stores the data in the primitive in the ZTC queue 
*
* Interface assumptions:
*       None
*
* The routine limitations.
*       None
*
* Return value:
*       Returns the length of the message if successs else sends failure status
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240506 LS,      Updated
*****************************************************************************/
uint8_t ZTCPrimHandle_StoreSimplePrimInZTCQueue
  (
  const uint8_t msgLength, /* IN : Length to be copied to the ZTC queue */
  const uint8_t* pMsg		   /* IN : Pointer to the memory loaction where the data 
                                   has to be copied to the ZTC queue */
  );

/*****************************************************************************
* This function allocates the buffer for the simple primitive,  copies the msg
* and calls corresponding SapHandler
*
* 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
* ------ ------   --------
* 240506 LS,      Updated
*****************************************************************************/ 
void ZTCPrimHandle_SendSimplePrimToSAP
(
  const ZTCMessage_t* pMsg, /* IN : Pointer to the message received */
  const uint8_t SAPId,		  /* IN:SapId used by the ZTC,which is derived from
                               the opcodeGrp   */
  const uint8_t msgLength	  /* IN:Length of the primitive */
);


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