source: rtems-libbsd/rtemsbsd/include/rtems/bsd/util.h

Last change on this file was ffbee8a, checked in by Sebastian Huber <sebastian.huber@…>, on Nov 3, 2014 at 8:18:14 AM

Add rtems_bsd_force_select_timeout()

  • Property mode set to 100644
File size: 3.4 KB
Line 
1/*
2 * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
3 *
4 *  embedded brains GmbH
5 *  Dornierstr. 4
6 *  82178 Puchheim
7 *  Germany
8 *  <rtems@embedded-brains.de>
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _RTEMS_BSD_UTIL_H_
33#define _RTEMS_BSD_UTIL_H_
34
35#include <sys/types.h>
36
37#include <net/if.h>
38#include <net/if_arp.h>
39#include <net/ethernet.h>
40
41#include <stdint.h>
42
43#include <rtems.h>
44
45#ifdef __cplusplus
46extern "C" {
47#endif /* __cplusplus */
48
49/**
50 * @brief Gets the Ethernet address of an interface identified by its name.
51 *
52 * This function uses getifaddrs().  The interface type is not checked, so it
53 * is only safe to use this function for Ethernet type interfaces.
54 *
55 * @param[in] ifname The name of the interface.
56 * @parma[out] eaddr The Ethernet address of this interface.
57 *
58 * @retval 0 Successful operation.
59 * @retval -1 An error occurred.  The errno is set to indicate the error.
60 */
61int
62rtems_bsd_get_ethernet_addr(const char *ifname, uint8_t eaddr[ETHER_ADDR_LEN]);
63
64typedef void (*rtems_bsd_arp_processor)(void *arg, int fd,
65    const uint8_t eaddr[ETHER_ADDR_LEN], const struct arphdr *ar,
66    uint32_t spa, uint32_t tpa, const uint8_t *sha, const uint8_t *tha);
67
68typedef struct rtems_bsd_arp_processor_context rtems_bsd_arp_processor_context;
69
70rtems_bsd_arp_processor_context *
71rtems_bsd_arp_processor_create(const char *ifname);
72
73int
74rtems_bsd_arp_processor_get_file_descriptor(
75    const rtems_bsd_arp_processor_context *ctx);
76
77int
78rtems_bsd_arp_processor_process(
79    rtems_bsd_arp_processor_context *ctx,
80    rtems_bsd_arp_processor processor, void *arg);
81
82/**
83 * @brief Forces a select() timeout for the specified task.
84 *
85 * In case the specified task waits in a select(), then it is woken up with a
86 * timeout status, otherwise this call has no effect.
87 *
88 * @param[in] task_id The task identifier.
89 *
90 * @retval RTEMS_SUCCESSFUL Successful operation.
91 * @retval RTEMS_INVALID_ID No such task.
92 *
93 * @warning This function may go away once the signal support for condition
94 * variables is implemented.
95 */
96rtems_status_code
97rtems_bsd_force_select_timeout(rtems_id task_id);
98
99#ifdef __cplusplus
100}
101#endif /* __cplusplus */
102
103#endif /* _RTEMS_BSD_UTIL_H_ */
Note: See TracBrowser for help on using the repository browser.