aboutsummaryrefslogtreecommitdiffstats
path: root/os/io/mac.h
blob: 9bbfa5cef988b7a5cbae064e970dde8fdbd445e8 (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
74
75
76
77
78
79
80
81
82
83
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file mac.h
 * @brief MAC Driver macros and structures.
 * @addtogroup MAC
 * @{
 */

#ifndef _MAC_H_
#define _MAC_H_

#include "mac_lld.h"

/**
 * @brief Returns the buffer associated to a @p MACTransmitDescriptor.
 *
 * @param[in] tdp the pointer to the @p MACTransmitDescriptor structure
 * @return The pointer to the transmit buffer.
 */
#define macGetTransmitBuffer(tdp) mac_lld_get_transmit_buffer(tdp)

/**
 * @brief Returns the buffer associated to a @p MACReceiveDescriptor.
 *
 * @param[in] rdp the pointer to the @p MACReceiveDescriptor structure
 * @return The pointer to the receive buffer.
 */
#define macGetReceiveBuffer(rdp) mac_lld_get_receive_buffer(rdp)

/**
 * @bief Returns the received frames event source.
 *
 * @param[in] macp pointer to the @p MACDriver object
 * @return The pointer to the @p EventSource structure.
 */
#if CH_USE_EVENTS || defined(__DOXYGEN__)
#define macGetReceiveEventSource(macp)  (&(macp)->md_rdevent)
#endif

#ifdef __cplusplus
extern "C" {
#endif
  void macInit(void);
  void macObjectInit(MACDriver *macp);
  void macSetAddress(MACDriver *macp, const uint8_t *p);
  void macStart(MACDriver *macp);
  void macStop(MACDriver *macp);
  MACTransmitDescriptor *macWaitTransmitDescriptor(MACDriver *macp,
                                                   size_t size,
                                                   systime_t time);
  void macReleaseTransmitDescriptor(MACDriver *macp,
                                    MACTransmitDescriptor *tdp);
  MACReceiveDescriptor *macWaitReceiveDescriptor(MACDriver *macp,
                                                 size_t *szp,
                                                 systime_t time);
  void macReleaseReceiveDescriptor(MACDriver *macp,
                                   MACReceiveDescriptor *rdp);
  bool_t macPollLinkStatus(MACDriver *macp);
#ifdef __cplusplus
}
#endif

#endif /* _MAC_H_ */

/** @} */