types.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Daniel Krebs
 *               2016 INRIA
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef NET_GNRC_LWMAC_TYPES_H
#define NET_GNRC_LWMAC_TYPES_H
 
#include "msg.h"
#include "xtimer.h"
#include "net/gnrc/lwmac/hdr.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define GNRC_LWMAC_EVENT_RTT_TYPE            (0x4300)
 
#define GNRC_LWMAC_EVENT_RTT_START           (0x4301)
 
#define GNRC_LWMAC_EVENT_RTT_STOP            (0x4302)
 
#define GNRC_LWMAC_EVENT_RTT_PAUSE           (0x4303)
 
#define GNRC_LWMAC_EVENT_RTT_RESUME          (0x4304)
 
#define GNRC_LWMAC_EVENT_RTT_WAKEUP_PENDING  (0x4305)
 
#define GNRC_LWMAC_EVENT_RTT_SLEEP_PENDING   (0x4306)
 
#define GNRC_LWMAC_EVENT_TIMEOUT_TYPE        (0x4400)
 
#define GNRC_LWMAC_DUTYCYCLE_ACTIVE          (0x01)
 
#define GNRC_LWMAC_NEEDS_RESCHEDULE          (0x02)
 
#define GNRC_LWMAC_RADIO_IS_ON               (0x04)
 
#ifndef CONFIG_GNRC_LWMAC_TIMEOUT_COUNT
#define CONFIG_GNRC_LWMAC_TIMEOUT_COUNT             (3U)
#endif
typedef enum {
    GNRC_LWMAC_UNDEF = -1,      
    GNRC_LWMAC_STOPPED,         
    GNRC_LWMAC_START,           
    GNRC_LWMAC_STOP,            
    GNRC_LWMAC_RESET,           
    GNRC_LWMAC_LISTENING,       
    GNRC_LWMAC_RECEIVING,       
    GNRC_LWMAC_TRANSMITTING,    
    GNRC_LWMAC_SLEEPING,        
    GNRC_LWMAC_STATE_COUNT      
} gnrc_lwmac_state_t;
 
typedef enum {
    GNRC_LWMAC_TX_STATE_STOPPED,            
    GNRC_LWMAC_TX_STATE_INIT,               
    GNRC_LWMAC_TX_STATE_SEND_BROADCAST,     
    GNRC_LWMAC_TX_STATE_SEND_WR,            
    GNRC_LWMAC_TX_STATE_WAIT_WR_SENT,       
    GNRC_LWMAC_TX_STATE_WAIT_FOR_WA,        
    GNRC_LWMAC_TX_STATE_SEND_DATA,          
    GNRC_LWMAC_TX_STATE_WAIT_FEEDBACK,      
    GNRC_LWMAC_TX_STATE_SUCCESSFUL,         
    GNRC_LWMAC_TX_STATE_FAILED              
} gnrc_lwmac_tx_state_t;
 
#define GNRC_LWMAC_TX_STATE_INITIAL GNRC_LWMAC_TX_STATE_STOPPED
 
typedef enum {
    GNRC_LWMAC_RX_STATE_STOPPED,        
    GNRC_LWMAC_RX_STATE_INIT,           
    GNRC_LWMAC_RX_STATE_WAIT_FOR_WR,    
    GNRC_LWMAC_RX_STATE_SEND_WA,        
    GNRC_LWMAC_RX_STATE_WAIT_WA_SENT,   
    GNRC_LWMAC_RX_STATE_WAIT_FOR_DATA,  
    GNRC_LWMAC_RX_STATE_SUCCESSFUL,     
    GNRC_LWMAC_RX_STATE_FAILED          
} gnrc_lwmac_rx_state_t;
 
#define GNRC_LWMAC_RX_STATE_INITIAL GNRC_LWMAC_RX_STATE_STOPPED
 
#define GNRC_LWMAC_PHASE_UNINITIALIZED   (0)
 
#define GNRC_LWMAC_PHASE_MAX             (-1)
 
typedef enum {
    GNRC_LWMAC_TIMEOUT_DISABLED,                
    GNRC_LWMAC_TIMEOUT_WR,                      
    GNRC_LWMAC_TIMEOUT_NO_RESPONSE,             
    GNRC_LWMAC_TIMEOUT_DATA,                    
    GNRC_LWMAC_TIMEOUT_WAIT_DEST_WAKEUP,        
    GNRC_LWMAC_TIMEOUT_WAKEUP_PERIOD,           
    GNRC_LWMAC_TIMEOUT_NEXT_BROADCAST,          
    GNRC_LWMAC_TIMEOUT_BROADCAST_END,           
} gnrc_lwmac_timeout_type_t;
 
typedef struct {
    xtimer_t timer;                 
    msg_t msg;                      
    bool expired;                   
    gnrc_lwmac_timeout_type_t type; 
} gnrc_lwmac_timeout_t;
 
typedef struct lwmac {
    gnrc_lwmac_state_t state;                                   
    uint32_t last_wakeup;                                       
    uint8_t lwmac_info;                                         
    gnrc_lwmac_timeout_t timeouts[CONFIG_GNRC_LWMAC_TIMEOUT_COUNT];    
#if (GNRC_MAC_ENABLE_DUTYCYCLE_RECORD == 1)
    /* Parameters for recording duty-cycle */
    uint32_t last_radio_on_time_ticks;                          
    uint32_t radio_off_time_ticks;                              
    uint32_t system_start_time_ticks;                           
    uint32_t awake_duration_sum_ticks;                          
    uint32_t pkt_start_sending_time_ticks;                      
#endif
} gnrc_lwmac_t;
 
#ifdef __cplusplus
}
#endif
 
#endif /* NET_GNRC_LWMAC_TYPES_H */