ztcprimitivehandlercomplexprimwithtablelist.h

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

/******************************************************************************
* This file exposes the functionality of ZTC Complex Primitive handler module
* with Table list.
*
*
* (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 _ZTCPRIMITIVEHANDLERCOMPLEXPRIMWITHTABLELIST_H_
#define _ZTCPRIMITIVEHANDLERCOMPLEXPRIMWITHTABLELIST_H_

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

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

/*****************************************************************************
* Inject the primitive with pointer to the corresponding SAP for that primitve
*
* Interface assumptions:
*       None
*		   
* The routine limitations.
*       None
*
* Return value: length of data copied from ZTC queue to send the message to SAP
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/ 
uint8_t ZTCPrimHandle_SendComplexPrimWithTableListToSAP
(
  uint8_t* pMsgToSend,         /*IN: Memory loaction to the data part of the 
                                  primitive has to be written to send to the SAP */
  const uint8_t* pMsgReceived, /*IN: Memory location to the data part received 
                                       from the test client */
  const uint8_t   msgId					/*IN: Msg ID of primitive with one pointer Here 
                       ID 0 is gMcpsDataReqID_c and 1 is gMCPSDataIndId_c and so on */
);

/*****************************************************************************
* Stores the one pointer primitive sent from one SAP handler to the other 
* into the ZTC queue.
*
* Interface assumptions:
*       None
*
* The routine limitations.
*       None
*
* Return value: Length of data copied ot the ZTC queue if the coping is sucess
*     else returns gZTCCannotBeQueued_c i.e. 255.
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/ 
uint8_t ZTCPrimHandle_StoreComplexPrimWithTableListInZTCQueue
(
  const uint8_t* pMsg, /*  IN: Memory location to the data part received 
                                from the SAP */
  const uint8_t msgId   /*  IN: Msg ID of primitive with one pointer Here ID 
                            0 is gMcpsDataReqID_c and 1 is gMCPSDataIndId_c and so on */  
);


/******************************************************************************
*******************************************************************************
* Public type definitions
*******************************************************************************
******************************************************************************/
/*  Enums for complex primitives with Table List. */
enum{
  gStartIdOfComplexPrimWithTableList_c = gEndIdOfComplexPrimWithOnePtr_c,
  gNwkAddrRespId_c = gStartIdOfComplexPrimWithTableList_c,
  gIEEEAddrRespId_c,  
  gActiveEpRespId_c,
  gMatchDescRespId_c,
  gUserDescRespId_c,
  gMgmtNwkDiscRespId_c,
  gMgmtLQIRespId_c,
  gMgmtRtgRespId_c,
  gMgmtBindRespId_c,  
  gZTC_MSGDataReqId_c,
  gZTCActiveEpRespId_c ,
  gEndIdOfComplexPrimWithTableList_c  
};

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

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



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