summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/MAC_PHY/MAC_HWD_PHY/include/machwdSet.h
blob: 7b1909e321dc264d3c190da42b2070695b1425e3 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/**************************************************************************//**
  \file machwdSet.h
  
  \brief MACHWD set types and function prototypes.

  \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:     
      26/09/07 A. Mandychev - Created.
******************************************************************************/

#ifndef _MACHWDSET_H
#define _MACHWDSET_H

/******************************************************************************
                    Includes section
******************************************************************************/
#include <inttypes.h>
#include <machwdService.h>
#include <macphyPib.h>

/******************************************************************************
                    Define(s) section
******************************************************************************/
//! Start point for Atmel own identifier counting.
#define MACHWD_ATMEL_RESERVED_ID 0xF0

/******************************************************************************
                    Types section
******************************************************************************/
//! MACHWD PIB identifiers.
typedef enum
{
  // PHY id.
  MACHWD_PIB_CURRENT_CHANNEL_ID     = PHY_PIB_CURRENT_CHANNEL_ID,
  MACHWD_PIB_TRANSMIT_POWER_ID      = PHY_PIB_TRANSMIT_POWER_ID,
  MACHWD_PIB_CCA_MODE_ID            = PHY_PIB_CCA_MODE_ID,
  MACHWD_PIB_CURRENT_PAGE_ID        = PHY_PIB_CURRENT_PAGE_ID,
  // MAC id.
  MACHWD_PIB_MAX_CSMA_BACKOFFS_ID   = MAC_PIB_MAX_CSMA_BACKOFFS_ID,
  MACHWD_PIB_PANID_ID               = MAC_PIB_PANID_ID,
  MACHWD_PIB_SHORT_ADDR_ID          = MAC_PIB_SHORT_ADDR_ID,
  MACHWD_PIB_MIN_BE_ID              = MAC_PIB_MIN_BE_ID,
  MACHWD_PIB_MAX_FRAME_RETRIES_ID   = MAC_PIB_MAX_FRAME_RETRIES_ID,
  MACHWD_PIB_EXT_ADDR_ID            = MAC_PIB_EXT_ADDR_ID,
  // Additional id for software needs.
  MACHWD_PIB_RF_IRQ_DISABLE_ID      = MACHWD_ATMEL_RESERVED_ID,
  MACHWD_PIB_BEACON_RX_MODE_ID      = MACHWD_ATMEL_RESERVED_ID + 1,
  // Additional id for hardware needs.
  MACHWD_PIB_PAN_COORDINATOR_ID     = MACHWD_ATMEL_RESERVED_ID + 2,
} MACHWD_PibId_t;

//! MACHWD PIB attribute type.
typedef union
{
  MAC_PibAttr_t macPib;
  PHY_PibAttr_t phyPib;
  bool panCoordinator;
  bool rfIrqDisable;
  bool beaconRxMode;
} MACHWD_PibAttr_t;

//! MACHWD set request structure.
typedef struct
{
  //! Service field - for internal needs.
  MACHWD_Service_t  service;
  //! MACHWD PIB identifier.
  MACHWD_PibId_t    id;
  //! MACHWD PIB attribute.
  MACHWD_PibAttr_t  attr;
  // MACHWD set confirm callback function's pointer.
  void (*MACHWD_SetConf)(void);
} MACHWD_SetReq_t;

/******************************************************************************
                    Prototypes section
******************************************************************************/
/**************************************************************************//**
  \brief Sets MACHWD attributes.
  \param reqParams - MACHWD set request structure pointer.
  \return none.
******************************************************************************/
void MACHWD_SetReq(MACHWD_SetReq_t *reqParams);

#endif /* _MACHWDSET_H */

// eof machwdSet.h