Blame view

RIOT/sys/include/net/gnrc/mac/internal.h 2.77 KB
a752c7ab   elopes   add first test an...
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
  /*
   * 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.
   */
  
  /**
   * @ingroup     net_gnrc_mac
   * @{
   *
   * @file
   * @brief       Definitions of internal functions of GNRC_MAC module
   * @internal
   * @author      Daniel Krebs <github@daniel-krebs.net>
   * @author      Shuguo Zhuo  <shuguo.zhuo@inria.fr>
   */
  
  #ifndef NET_GNRC_MAC_INTERNAL_H
  #define NET_GNRC_MAC_INTERNAL_H
  
  #include <stdint.h>
  
  #include "net/ieee802154.h"
  #include "net/gnrc/mac/types.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  #if (GNRC_MAC_TX_QUEUE_SIZE != 0) || defined(DOXYGEN)
  /**
   * @brief Queues the packet into the related transmission packet queue in netdev_t::tx.
   *        Note that, in case the `gnrc_mac_tx_neighbor_t` structure is in used (indicated
   *        by `GNRC_MAC_NEIGHBOR_COUNT != 0`), this function queues the packet to
   *        the queue associated to the pkt's destination neighbor, including a
   *        `broadcast-neighbor` (neighbor id is `0` in netdev_t::tx::neighbors) which
   *        specifically stores broadcasting packets.
   *        On the other hand, if `gnrc_mac_tx_neighbor_t` structure is not in used (indicated
   *        by `GNRC_MAC_NEIGHBOR_COUNT == 0`), this function queues the packet into the single
   *        priority TX queue defined in in netdev_t::tx.
   *
   * @param[in,out] tx        gnrc_mac transmission management object
   * @param[in]     priority  the priority of @p pkt
   * @param[in]     pkt       gnrc packet that will be queued
   *
   * @return                  true if queued successfully, otherwise false.
   */
  bool gnrc_mac_queue_tx_packet(gnrc_mac_tx_t *tx, uint32_t priority, gnrc_pktsnip_t *pkt);
  #endif /* (GNRC_MAC_TX_QUEUE_SIZE != 0) || defined(DOXYGEN) */
  
  #if (GNRC_MAC_RX_QUEUE_SIZE != 0) || defined(DOXYGEN)
  /**
   * @brief Queues the packet into the reception packet queue in netdev_t::rx.
   *
   * @param[in,out] rx        gnrc_mac reception management object
   * @param[in]     priority  the priority of @p pkt
   * @param[in]     pkt       gnrc packet that will be queued
   *
   * @return                  true if queued successfully, otherwise false.
   */
  bool gnrc_mac_queue_rx_packet(gnrc_mac_rx_t *rx, uint32_t priority, gnrc_pktsnip_t *pkt);
  #endif /* (GNRC_MAC_RX_QUEUE_SIZE != 0) || defined(DOXYGEN) */
  
  #if (GNRC_MAC_DISPATCH_BUFFER_SIZE != 0) || defined(DOXYGEN)
  /**
   * @brief Dispatch all the packets stored in netdev_t::rx:dispatch_buffer to upper layer.
   *
   * @param[in,out]  rx       gnrc_mac reception management object
   */
  void gnrc_mac_dispatch(gnrc_mac_rx_t *rx);
  #endif /* (GNRC_MAC_DISPATCH_BUFFER_SIZE != 0) || defined(DOXYGEN) */
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* NET_GNRC_MAC_INTERNAL_H */
  /** @} */