Gitiles
Code Review Sign In
gerrit.omnirom.org / android_bionic / 6aa6277fa461dc92cbbbe4f0259f0de4a8f26663 / . / libc / include / netinet / ether.h
blob: 4af7edae1eb37a2087fdb941a093055fbad1d128 [file] [log] [blame]
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800[diff] [blame]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 */
Elliott Hughesf6324d52016-05-12 13:11:28 -0700[diff] [blame]28
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]29#pragma once
30
31/**
32 * @file netinet/ether.h
33 * @brief Ethernet (MAC) addresses.
34 */
Elliott Hughesf6324d52016-05-12 13:11:28 -0700[diff] [blame]35
36#include <sys/cdefs.h>
37#include <netinet/if_ether.h>
38
39__BEGIN_DECLS
40
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]41/**
42 * [ether_ntoa(3)](http://man7.org/linux/man-pages/man3/ether_ntoa.3.html) returns a string
Elliott Hughes3ed6e722024-02-16 01:18:01 +0000[diff] [blame]43 * representation of the given Ethernet (MAC) address.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]44 *
45 * Returns a pointer to a static buffer.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]46 */
zijunzhao577177a2023-04-23 05:28:48 +0000[diff] [blame]47char* _Nonnull ether_ntoa(const struct ether_addr* _Nonnull __addr);
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]48
49/**
50 * [ether_ntoa_r(3)](http://man7.org/linux/man-pages/man3/ether_ntoa_r.3.html) returns a string
Elliott Hughes3ed6e722024-02-16 01:18:01 +0000[diff] [blame]51 * representation of the given Ethernet (MAC) address.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]52 *
53 * Returns a pointer to the given buffer.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]54 */
zijunzhao577177a2023-04-23 05:28:48 +0000[diff] [blame]55char* _Nonnull ether_ntoa_r(const struct ether_addr* _Nonnull __addr, char* _Nonnull __buf);
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]56
57/**
58 * [ether_aton(3)](http://man7.org/linux/man-pages/man3/ether_aton.3.html) returns an `ether_addr`
Elliott Hughes3ed6e722024-02-16 01:18:01 +0000[diff] [blame]59 * corresponding to the given Ethernet (MAC) address string.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]60 *
61 * Returns a pointer to a static buffer, or NULL if the given string isn't a valid MAC address.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]62 */
zijunzhao577177a2023-04-23 05:28:48 +0000[diff] [blame]63struct ether_addr* _Nullable ether_aton(const char* _Nonnull __ascii);
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]64
65/**
66 * [ether_aton_r(3)](http://man7.org/linux/man-pages/man3/ether_aton_r.3.html) returns an
Elliott Hughes3ed6e722024-02-16 01:18:01 +0000[diff] [blame]67 * `ether_addr` corresponding to the given Ethernet (MAC) address string.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]68 *
69 * Returns a pointer to the given buffer, or NULL if the given string isn't a valid MAC address.
Elliott Hughesdd6763a2018-10-04 16:35:13 -0700[diff] [blame]70 */
zijunzhao577177a2023-04-23 05:28:48 +0000[diff] [blame]71struct ether_addr* _Nullable ether_aton_r(const char* _Nonnull __ascii, struct ether_addr* _Nonnull __addr);
Elliott Hughesf6324d52016-05-12 13:11:28 -0700[diff] [blame]72
73__END_DECLS