lwmac_internal.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.
 */
 
#pragma once
 
#include <stdint.h>
 
#include "periph/rtt.h"
#include "net/gnrc/netif.h"
#include "net/gnrc/mac/types.h"
#include "net/gnrc/lwmac/types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define GNRC_LWMAC_TX_CONTINUE          (0x0008U)
 
#define GNRC_LWMAC_QUIT_TX              (0x0010U)
 
#define GNRC_LWMAC_PHASE_BACKOFF        (0x0020U)
 
#define GNRC_LWMAC_QUIT_RX              (0x0040U)
 
typedef struct {
    gnrc_lwmac_hdr_t *header;       
    gnrc_lwmac_l2_addr_t src_addr;  
    gnrc_lwmac_l2_addr_t dst_addr;  
} gnrc_lwmac_packet_info_t;
 
#define GNRC_LWMAC_RTT_EVENT_MARGIN_TICKS    (RTT_MS_TO_TICKS(2))
 
static inline void gnrc_lwmac_set_tx_continue(gnrc_netif_t *netif, bool tx_continue)
{
    if (tx_continue) {
        netif->mac.mac_info |= GNRC_LWMAC_TX_CONTINUE;
    }
    else {
        netif->mac.mac_info &= ~GNRC_LWMAC_TX_CONTINUE;
    }
}
 
static inline bool gnrc_lwmac_get_tx_continue(gnrc_netif_t *netif)
{
    return (netif->mac.mac_info & GNRC_LWMAC_TX_CONTINUE);
}
 
static inline void gnrc_lwmac_set_quit_tx(gnrc_netif_t *netif, bool quit_tx)
{
    if (quit_tx) {
        netif->mac.mac_info |= GNRC_LWMAC_QUIT_TX;
    }
    else {
        netif->mac.mac_info &= ~GNRC_LWMAC_QUIT_TX;
    }
}
 
static inline bool gnrc_lwmac_get_quit_tx(gnrc_netif_t *netif)
{
    return (netif->mac.mac_info & GNRC_LWMAC_QUIT_TX);
}
 
static inline void gnrc_lwmac_set_phase_backoff(gnrc_netif_t *netif, bool backoff)
{
    if (backoff) {
        netif->mac.mac_info |= GNRC_LWMAC_PHASE_BACKOFF;
    }
    else {
        netif->mac.mac_info &= ~GNRC_LWMAC_PHASE_BACKOFF;
    }
}
 
static inline bool gnrc_lwmac_get_phase_backoff(gnrc_netif_t *netif)
{
    return (netif->mac.mac_info & GNRC_LWMAC_PHASE_BACKOFF);
}
 
static inline void gnrc_lwmac_set_quit_rx(gnrc_netif_t *netif, bool quit_rx)
{
    if (quit_rx) {
        netif->mac.mac_info |= GNRC_LWMAC_QUIT_RX;
    }
    else {
        netif->mac.mac_info &= ~GNRC_LWMAC_QUIT_RX;
    }
}
 
static inline bool gnrc_lwmac_get_quit_rx(gnrc_netif_t *netif)
{
    return (netif->mac.mac_info & GNRC_LWMAC_QUIT_RX);
}
 
static inline void gnrc_lwmac_set_dutycycle_active(gnrc_netif_t *netif, bool active)
{
    if (active) {
        netif->mac.prot.lwmac.lwmac_info |= GNRC_LWMAC_DUTYCYCLE_ACTIVE;
    }
    else {
        netif->mac.prot.lwmac.lwmac_info &= ~GNRC_LWMAC_DUTYCYCLE_ACTIVE;
    }
}
 
static inline bool gnrc_lwmac_get_dutycycle_active(gnrc_netif_t *netif)
{
    return (netif->mac.prot.lwmac.lwmac_info & GNRC_LWMAC_DUTYCYCLE_ACTIVE);
}
 
static inline void gnrc_lwmac_set_reschedule(gnrc_netif_t *netif, bool reschedule)
{
    if (reschedule) {
        netif->mac.prot.lwmac.lwmac_info |= GNRC_LWMAC_NEEDS_RESCHEDULE;
    }
    else {
        netif->mac.prot.lwmac.lwmac_info &= ~GNRC_LWMAC_NEEDS_RESCHEDULE;
    }
}
 
static inline bool gnrc_lwmac_get_reschedule(gnrc_netif_t *netif)
{
    return (netif->mac.prot.lwmac.lwmac_info & GNRC_LWMAC_NEEDS_RESCHEDULE);
}
 
int _gnrc_lwmac_transmit(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt);
 
int _gnrc_lwmac_parse_packet(gnrc_pktsnip_t *pkt, gnrc_lwmac_packet_info_t *info);
 
netopt_state_t _gnrc_lwmac_get_netdev_state(gnrc_netif_t *netif);
 
void _gnrc_lwmac_set_netdev_state(gnrc_netif_t *netif, netopt_state_t devstate);
 
static inline uint32_t _gnrc_lwmac_ticks_to_phase(uint32_t ticks)
{
    assert(CONFIG_GNRC_LWMAC_WAKEUP_INTERVAL_US != 0);
 
    return (ticks % RTT_US_TO_TICKS(CONFIG_GNRC_LWMAC_WAKEUP_INTERVAL_US));
}
 
static inline uint32_t _gnrc_lwmac_phase_now(void)
{
    return _gnrc_lwmac_ticks_to_phase(rtt_get_counter());
}
 
static inline uint32_t _gnrc_lwmac_ticks_until_phase(uint32_t phase)
{
    long int tmp = phase - _gnrc_lwmac_phase_now();
 
    if (tmp < 0) {
        /* Phase in next interval */
        tmp += RTT_US_TO_TICKS(CONFIG_GNRC_LWMAC_WAKEUP_INTERVAL_US);
    }
 
    return (uint32_t)tmp;
}
 
int _gnrc_lwmac_dispatch_defer(gnrc_pktsnip_t * buffer[], gnrc_pktsnip_t * pkt);
 
#ifdef __cplusplus
}
#endif