1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 /**
32  * @file netinet/ether.h
33  * @brief Ethernet (MAC) addresses.
34  */
35 
36 #include <sys/cdefs.h>
37 #include <netinet/if_ether.h>
38 
39 __BEGIN_DECLS
40 
41 /**
42  * [ether_ntoa(3)](http://man7.org/linux/man-pages/man3/ether_ntoa.3.html) returns a string
43  * representation of the given Ethernet address.
44  *
45  * Returns a pointer to a static buffer.
46  */
47 char* ether_ntoa(const struct ether_addr* __addr);
48 
49 /**
50  * [ether_ntoa_r(3)](http://man7.org/linux/man-pages/man3/ether_ntoa_r.3.html) returns a string
51  * representation of the given Ethernet address.
52  *
53  * Returns a pointer to the given buffer.
54  */
55 char* ether_ntoa_r(const struct ether_addr* __addr, char* __buf);
56 
57 /**
58  * [ether_aton(3)](http://man7.org/linux/man-pages/man3/ether_aton.3.html) returns an `ether_addr`
59  * corresponding to the given Ethernet address string.
60  *
61  * Returns a pointer to a static buffer, or NULL if the given string isn't a valid MAC address.
62  */
63 struct ether_addr* ether_aton(const char* __ascii);
64 
65 /**
66  * [ether_aton_r(3)](http://man7.org/linux/man-pages/man3/ether_aton_r.3.html) returns an
67  * `ether_addr` corresponding to the given Ethernet address string.
68  *
69  * Returns a pointer to the given buffer, or NULL if the given string isn't a valid MAC address.
70  */
71 struct ether_addr* ether_aton_r(const char* __ascii, struct ether_addr* __addr);
72 
73 __END_DECLS
74