types.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Shuguo Zhuo
 *
 * 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_GOMACH_TYPES_H
#define NET_GNRC_GOMACH_TYPES_H

#include <stdint.h>
#include <stdbool.h>

#include "xtimer.h"
#include "net/gnrc/gomach/hdr.h"

#ifdef __cplusplus
extern "C" {
#endif

#define GNRC_GOMACH_EVENT_RTT_TYPE          (0x4300)

#define GNRC_GOMACH_EVENT_RTT_NEW_CYCLE     (0x4301)

#define GNRC_GOMACH_EVENT_TIMEOUT_TYPE      (0x4400)

#define GNRC_GOMACH_PHASE_UNINITIALIZED     (0)

#define GNRC_GOMACH_PHASE_MAX               (-1)

#define GNRC_GOMACH_DUPCHK_BUFFER_SIZE             (8U)

#define GNRC_GOMACH_TIMEOUT_COUNT             (6U)

#define GNRC_GOMACH_SLOSCH_UNIT_COUNT           (11U)

#define GNRC_GOMACH_TYPE_UNKNOWN           (0U)

#define GNRC_GOMACH_TYPE_KNOWN             (1U)

typedef enum {
    GNRC_GOMACH_BCAST_INIT,             
    GNRC_GOMACH_BCAST_SEND,             
    GNRC_GOMACH_BCAST_WAIT_TX_FINISH,   
    GNRC_GOMACH_BCAST_WAIT_NEXT_TX,     
    GNRC_GOMACH_BCAST_END               
} gnrc_gomach_bcast_state_t;

typedef enum {
    GNRC_GOMACH_T2K_INIT,                   
    GNRC_GOMACH_T2K_WAIT_CP,                
    GNRC_GOMACH_T2K_TRANS_IN_CP,            
    GNRC_GOMACH_T2K_WAIT_CPTX_FEEDBACK,     
    GNRC_GOMACH_T2K_WAIT_BEACON,            
    GNRC_GOMACH_T2K_WAIT_SLOTS,             
    GNRC_GOMACH_T2K_VTDMA_TRANS,            
    GNRC_GOMACH_T2K_WAIT_VTDMA_FEEDBACK,    
    GNRC_GOMACH_T2K_END                     
} gnrc_gomach_t2k_state_t;

typedef enum {
    GNRC_GOMACH_T2U_INIT,                   
    GNRC_GOMACH_T2U_PREAMBLE_PREPARE,       
    GNRC_GOMACH_T2U_SEND_PREAMBLE,          
    GNRC_GOMACH_T2U_WAIT_PREAMBLE_TX,       
    GNRC_GOMACH_T2U_WAIT_PREAMBLE_ACK,      
    GNRC_GOMACH_T2U_SEND_DATA,              
    GNRC_GOMACH_T2U_WAIT_DATA_TX,           
    GNRC_GOMACH_T2U_END                     
} gnrc_gomach_t2u_state_t;

typedef enum {
    GNRC_GOMACH_INIT,           
    GNRC_GOMACH_LISTEN,         
    GNRC_GOMACH_TRANSMIT        
} gnrc_gomach_basic_state_t;

typedef enum {
    GNRC_GOMACH_INIT_PREPARE,           
    GNRC_GOMACH_INIT_ANNC_SUBCHAN,      
    GNRC_GOMACH_INIT_WAIT_FEEDBACK,     
    GNRC_GOMACH_INIT_END                
} gnrc_gomach_init_state_t;

typedef enum {
    GNRC_GOMACH_LISTEN_CP_INIT,             
    GNRC_GOMACH_LISTEN_CP_LISTEN,           
    GNRC_GOMACH_LISTEN_CP_END,              
    GNRC_GOMACH_LISTEN_SEND_BEACON,         
    GNRC_GOMACH_LISTEN_WAIT_BEACON_TX,      
    GNRC_GOMACH_LISTEN_VTDMA_INIT,          
    GNRC_GOMACH_LISTEN_VTDMA,               
    GNRC_GOMACH_LISTEN_VTDMA_END,           
    GNRC_GOMACH_LISTEN_SLEEP_INIT,          
    GNRC_GOMACH_LISTEN_SLEEP,               
    GNRC_GOMACH_LISTEN_SLEEP_END            
} gnrc_gomach_listen_state_t;

typedef enum {
    GNRC_GOMACH_TRANS_TO_UNKNOWN,       
    GNRC_GOMACH_TRANS_TO_KNOWN,         
    GNRC_GOMACH_BROADCAST               
} gnrc_gomach_transmit_state_t;

typedef enum {
    GNRC_GOMACH_TIMEOUT_DISABLED,               
    GNRC_GOMACH_TIMEOUT_BCAST_FINISH,           
    GNRC_GOMACH_TIMEOUT_BCAST_INTERVAL,         
    GNRC_GOMACH_TIMEOUT_PREAMBLE,               
    GNRC_GOMACH_TIMEOUT_MAX_PREAM_INTERVAL,     
    GNRC_GOMACH_TIMEOUT_PREAM_DURATION,         
    GNRC_GOMACH_TIMEOUT_WAIT_CP,                
    GNRC_GOMACH_TIMEOUT_WAIT_BEACON,            
    GNRC_GOMACH_TIMEOUT_WAIT_SLOTS,             
    GNRC_GOMACH_TIMEOUT_CP_END,                 
    GNRC_GOMACH_TIMEOUT_CP_MAX,                 
    GNRC_GOMACH_TIMEOUT_WAIT_RX_END,            
    GNRC_GOMACH_TIMEOUT_VTDMA,                  
    GNRC_GOMACH_TIMEOUT_NO_TX_ISR,              
} gnrc_gomach_timeout_type_t;

typedef struct {
    uint8_t addr[IEEE802154_LONG_ADDRESS_LEN];  
} gnrc_gomach_l2_id_t;

typedef struct {
    gnrc_gomach_l2_addr_t node_addr;    
    uint8_t queue_indicator;            
} gnrc_gomach_slosch_unit_t;

typedef struct {
    uint8_t total_slots_num;        
    uint8_t sub_channel_seq;        
} gnrc_gomach_vtdma_manag_t;

typedef struct {
    gnrc_gomach_l2_addr_t node_addr;    
    uint8_t seq;                        
    uint8_t life_cycle;                 
} gnrc_gomach_dupchk_unit_t;

typedef struct {
    gnrc_gomach_dupchk_unit_t last_nodes[GNRC_GOMACH_DUPCHK_BUFFER_SIZE]; 
    uint8_t queue_head;                                                   
} gnrc_gomach_dupchk_t;

typedef struct {
    gnrc_gomach_hdr_t *header;          
    gnrc_gomach_l2_addr_t src_addr;     
    gnrc_gomach_l2_addr_t dst_addr;     
    uint8_t seq;                        
} gnrc_gomach_packet_info_t;

typedef struct {
    uint16_t sub_channel_seq;       
    uint8_t slots_position;         
    uint8_t slots_num;              
} gnrc_gomach_vtdma_t;

typedef struct {
    xtimer_t timer;                     
    msg_t msg;                          
    bool expired;                       
    gnrc_gomach_timeout_type_t type;    
} gnrc_gomach_timeout_t;

#define GNRC_GOMACH_TIMEOUT_INIT  { {}, {}, false, GNRC_GOMACH_TIMEOUT_DISABLED }

typedef struct gomach {
    gnrc_gomach_basic_state_t basic_state;                      
    gnrc_gomach_init_state_t init_state;                        
    gnrc_gomach_timeout_t timeouts[GNRC_GOMACH_TIMEOUT_COUNT];  
    uint16_t subchannel_occu_flags;                             
    uint16_t sub_channel_seq;                                   
    uint16_t pub_channel_1;                                     
    uint16_t pub_channel_2;                                     
    uint16_t cur_pub_channel;                                   
    uint8_t cp_extend_count;                                    
    uint32_t last_wakeup;                                       
    uint32_t backoff_phase_us;                                  
    uint16_t gomach_info;                                       
    uint64_t last_wakeup_phase_us;                              
    int16_t rx_pkt_rssi;                                        
    uint8_t rx_pkt_lqi;                                         
#if (GNRC_MAC_ENABLE_DUTYCYCLE_RECORD == 1)
    /* Parameters for recording duty-cycle */
    uint64_t last_radio_on_time_ticks;                          
    uint64_t radio_off_time_ticks;                              
    uint64_t system_start_time_ticks;                           
    uint64_t awake_duration_sum_ticks;                          
#endif
} gnrc_gomach_t;

#ifdef __cplusplus
}
#endif

#endif /* NET_GNRC_GOMACH_TYPES_H */