summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/MAC_PHY/include/macPurge.h
blob: dad169a3a1ea02944cf22bb5ef2fa15575558d28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/**************************************************************************//**
  \file macPurge.h
  
  \brief Types', constants' and functions' declarations for IEEE 802.15.4-2006 
     purge primitives.
     
  \author
    Atmel Corporation: http://www.atmel.com \n
    Support email: avr@atmel.com

  Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
  Licensed under Atmel's Limited License Agreement (BitCloudTM).
  
  \internal
    History:     
      18/06/07 ALuzhetsky - Created.
******************************************************************************/

#ifndef _MACPURGE_H
#define _MACPURGE_H

/******************************************************************************
                        Includes section
******************************************************************************/
#include <types.h>
#include <macCommon.h>

/******************************************************************************
                        Defines section
******************************************************************************/

/******************************************************************************
                        Types section
******************************************************************************/
/**
 * \brief MCPS-PURGE confirm primitive's parameters structure declaration.
 * IEEE 802.15.4-2006 7.1.1.5 MCPS-PURGE.confirm.
 */
typedef struct
{
  //! The handle of the MSDU requested to be purge from the transaction queue.
  uint8_t msduHandle;
  //! The status of the request to be purged an MSDU from the transaction queue.
  MAC_Status_t status;
}  MAC_PurgeConf_t;

/**
 * \brief MCPS-PURGE request primitive's parameters structure declaration.
 * IEEE 802.15.4-2006 7.1.1.4 MCPS-PURGE.request.
 */
typedef struct
{
  //! Service field - for internal needs.
  MAC_Service_t service;
  //! The handle of the MSDU to be purged from the transaction queue.
  uint8_t       msduHandle;
  //! MCPS-PURGE confirm callback function pointer.
  void (*MAC_PurgeConf)(MAC_PurgeConf_t *conf);
  //! MCPS-PURGE confirm parameters' structure.
  MAC_PurgeConf_t confirm;
}  MAC_PurgeReq_t;

/******************************************************************************
                        Prototypes section
******************************************************************************/
/**************************************************************************//**
  \brief MCPS-PURGE request primitive's prototype.
  \param reqParams - MCPS-PURGE request parameters' structure pointer.
  \return none.
******************************************************************************/
void MAC_PurgeReq(MAC_PurgeReq_t *reqParams);

#endif /* _MACPURGE_H */

// eof macPurge.h