summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/MAC_PHY/MAC_HWI/include/machwiTransactionHandler.h
blob: cd5d31a8702fa98100b5f60df3db9c095bb2799e (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
/******************************************************************************
  \file machwiTransactionHandler.h
  
  \brief machwiTransactionHandler header file.
  
  \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:     
      28/06/07 ALuzhetsky - Created.
******************************************************************************/

#ifndef _MACHWITRANSACTIONHANDLER_H
#define _MACHWITRANSACTIONHANDLER_H
#ifdef _FFD_

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

/******************************************************************************
                    Types section
******************************************************************************/
typedef enum
{
  MACHWI_IDLE_TRANSACTION_HANDLER_STATE,
  MACHWI_BUSY_ASSOCIATE_TRANSACTION_HANDLER_STATE,
#ifdef _MAC_DISASSOCIATE_

  MACHWI_BUSY_DISASSOCIATE_TRANSACTION_HANDLER_STATE,
#endif //_MAC_DISASSOCIATE_

  MACHWI_BUSY_DATA_TRANSACTION_HANDLER_STATE,
#ifdef _PENDING_EMPTY_DATA_FRAME_
  MACHWI_BUSY_EMPTY_DATA_HANDLER_STATE,
#endif // _PENDING_EMPTY_DATA_FRAME_
} MachwiTransactionHandlerState_t;

/******************************************************************************
                        Prototypes section.
******************************************************************************/

/******************************************************************************
  Indicates, that transaction event happened (it was requested or just expired).
  Parameters:
    transaction - transaction descriptor.
    event - type of the event (MAC_TRANSACTION_EXPIRED_EVENT or 
            MAC_TRANSACTION_READY_EVENT).
  Returns:
    true - activate the kicked transaction, false - otherwise.
******************************************************************************/
bool machwiSendTransactionEvent(MachwiTransaction_t *transaction, MachwiTransactionEvent_t event);


/******************************************************************************
  Resets transaction handler.
  Parameters:
    none.
  Returns:
    none.
******************************************************************************/
void machwiResetTransactionHandler(void);

#ifdef _PENDING_EMPTY_DATA_FRAME_
/******************************************************************************
  Sends an empty data frame in reply to the data request.
  Parameters:
    frameDescr - data request frame description.
  Returns:
    none.
******************************************************************************/
void replyWithEmptyDataFrame(MAC_FrameDescr_t *frameDescr);
#endif // _PENDING_EMPTY_DATA_FRAME_

#endif //_FFD_
#endif //_MACHWITRANSACTIONHANDLER_H

// eof machwiTransactionHandler.h