ztcprimitivehandlercomplexprimwithoneptr.h

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

/******************************************************************************
* This file exposes the functionality of ZTC Complex Primitive with One Pointer
* 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 _ZTCPRIMITIVEHANDLERCOMPLEXPRIMWITHONEPTR_H_
#define _ZTCPRIMITIVEHANDLERCOMPLEXPRIMWITHONEPTR_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:
*       None
*
* Effects on global data.
*       None
*
* Source of algorithm used.
*       None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/ 
void ZTCPrimHandle_SendComplexPrimWithOnePtrToSAP
  (
  uint8_t* pMsgToSend,         /* IN/OUT: Memory loaction from where 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:
*       Returns the length of data it wrote into ZTC queue.
*
* Effects on global data.
*       None
*
* Source of algorithm used.
* None
*
* Revison history:
*
* date   Author   Comments
* ------ ------   --------
* 240306 LS,      Updated
*****************************************************************************/ 
uint8_t ZTCPrimHandle_StoreComplexPrimWithOnePtrInZTCQueue
  (
  const uint8_t* const 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 one pointer.These are used in injecting 
  these primitives to SAP and For forming conformation for these primitives  */
enum{
  gStartIdOfComplexPrimWithOnePtr_c = gStartOfMessageIdForComplexPrimitive_c,
  gMCPSDataReqId_c = gStartIdOfComplexPrimWithOnePtr_c,
  gMCPSDataIndId_c,
  gMCPSPromIndId_c,
  gASP_NVMReqId_c,
  gNLDEDataReqId_c,
  gNLDEDataIndId_c,
  gZTC_AF_MSGDataIndId_c,
  gNLMENwkDiscConfId_c,
  gAPSDEDataReqId_c,
  gAPSDEDataIndId_c,
  gZDPNwkDiscConfId_c,
  gEndIdOfComplexPrimWithOnePtr_c
};

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

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


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