ztcprimitivehandlercomplexprimitive.h

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

/******************************************************************************
* This file exposes the functionality of ZTC Complex Primitive handler 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 _ZTCPRIMITIVEHANDLERCOMPLEXPRIMITIVE_H_
#define _ZTCPRIMITIVEHANDLERCOMPLEXPRIMITIVE_H_

/******************************************************************************
*******************************************************************************
* Public macros
*******************************************************************************
******************************************************************************/
#define gStartOfMessageIdForComplexPrimitive_c   100

/******************************************************************************
*******************************************************************************
* 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 msgLength + payloadLength if success or FF if Failed 
*
* Effects on global data.
*   None
*
* Source of algorithm used.
*   None
*
* Revison history:
*   date    Author   Comments
*   ------  ------   --------
*   240306  LS,      Updated
*****************************************************************************/ 
uint8_t  ZTCPrimHandle_StoreComplexPrimInZTCQueue
  (
  const uint8_t  complexMsgId, /* IN: MSG ID used for complex primitive */
  const uint8_t  status,       /* IN: Status returned from the SAP Handler */
  const uint8_t* const pMsg    /* IN: Pointer to the memory sent to the SAP */
  );

/*****************************************************************************
* This function allocates the buffer for the complex 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
*   ------  ------   --------
*   240306  LS,      Updated
*****************************************************************************/ 
void ZTCPrimHandle_SendComplexPrimToSAP
  (
  const ZTCMessage_t* const pMsg,/* IN: Msg received from the test client */
  const uint8_t SAPId,           /* IN: Sap ID to which the prim has to be sent*/
  uint8_t complexMsgId           /* IN: MSG ID used for complex primitive */
  );


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