summaryrefslogtreecommitdiff
path: root/cesar/cp/station/inc/station_event_handler.h
blob: 7d986d6183999c2305ba57e16c3093e1dbbe8d5d (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
/* Cesar project {{{
 *
 * Copyright (C) 2007 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    cp/station/inc/event_handler.h
 * \brief   event handler for the fsm events
 * \ingroup cp_station
 */

#ifndef EVENTHANDLER_H_
#define EVENTHANDLER_H_


#include "cp/msg/inc/msg_const.h"
#include "cp/interf/inc/interf_types.h"
#include "cp/vstate_fsm/src/SEMTypes.h"
#include "cp/station/station.h"
#include <cyg/kernel/kapi.h>

#define EVENT_QUEUE_SIZE (INTERF_NB_BUFFER * 3)

#if (INTERF_NB_BUFFER > EVENT_QUEUE_SIZE)
    #error "event queue size too small."
#endif


typedef struct event_t
{
    SEM_EVENT_TYPE event_type;
    VS_VOIDPTR mme_address;
} event_t;

typedef enum ev_err_code_t
{
    EV_OK = 0,
    EV_QUEUE_FULL,
    EV_QUEUE_EMPTY
} ev_err_code_t;


/**
 * \brief          initialize the event handler
 * \param 
 * \return         
 */
void 
cp_station_initialize_handler(void);

/**
 * \brief          add an event to the event stack
 * \param          event_type : the event type. They are defined in main_fsmData.h
 * \param          mme_address : if necessary, pointer to a mme,
 *                 or beacon address if the event is related to a beacon
 * \return         error code or 0 if success
 */
ev_err_code_t 
cp_station_add_event(const SEM_EVENT_TYPE event_type, const VS_VOIDPTR mme_address);    

/**
 * \brief          retrieve an event from the event stack
 * \param          event : the retieved event
 * \return         error code or 0 if success
 */
ev_err_code_t 
cp_station_get_event(event_t *event);



#endif /*EVENTHANDLER_H_*/