summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/MAC_PHY/include/macReset.h
blob: 6f1365ea6e6f319da2cdf2904cf6e176e1e0744e (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
/**************************************************************************//**
  \file macReset.h
  
  \brief Types', constants' and functions' declarations for IEEE 802.15.4-2006 
    reset 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 _MACRESET_H
#define _MACRESET_H

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

/******************************************************************************
                        Defines section
******************************************************************************/
/******************************************************************************
                        Types section
******************************************************************************/
/**
 * \brief MLME-RESET confirm primitive's parameters structure declaration.
 * IEEE 802.15.4-2006 7.1.9.2 MLME-RESET.confirm.
 */
typedef struct
{
  //! The result of the reset operation.
  MAC_Status_t status;
}  MAC_ResetConf_t;

/**
 * \brief MLME-RESET request primitive's parameters structure declaration.
 * IEEE 802.15.4-2006 7.1.9.1 MLME-RESET.request
 */
typedef struct
{
  //! Service field - for internal needs.
  MAC_Service_t service;
  //! If TRUE, the MAC sublayer is reset, and all MAC PIB attributes are set 
  //! to their default values. It resets radio chip also.
  bool setDefaultPib;
  // MLME-RESET confirm callback function's pointer.
  void (*MAC_ResetConf)(MAC_ResetConf_t *conf);
  // MLME-RESET confirm parameters structure.
  MAC_ResetConf_t confirm;
}  MAC_ResetReq_t;

/******************************************************************************
                        Prototypes section
******************************************************************************/
/**************************************************************************//**
  \brief MLME-RESET request primitive's prototype.
  \param reqParams - MLME-RESET request parameters' structure pointer.
  \return none.
******************************************************************************/
void MAC_ResetReq(MAC_ResetReq_t *reqParams);

#endif /* _MACRESET_H */

// eof macReset.h