source: rtems-libbsd/rtemsbsd/include/rtems/dhcpcd.h @ b2eb48c

5-freebsd-12
Last change on this file since b2eb48c was b2eb48c, checked in by Sebastian Huber <sebastian.huber@…>, on May 2, 2018 at 7:01:32 AM

dhcpcd: Add hooks

  • Property mode set to 100644
File size: 3.4 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup rtems_bsd
5 *
6 * @brief TODO.
7 */
8
9/*
10 * Copyright (c) 2018 embedded brains GmbH.  All rights reserved.
11 *
12 *  embedded brains GmbH
13 *  Dornierstr. 4
14 *  82178 Puchheim
15 *  Germany
16 *  <rtems@embedded-brains.de>
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 *    notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 *    notice, this list of conditions and the following disclaimer in the
25 *    documentation and/or other materials provided with the distribution.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 */
39
40#ifndef _RTEMS_DHCPCD_H_
41#define _RTEMS_DHCPCD_H_
42
43#include <sys/cdefs.h>
44#include <sys/queue.h>
45
46#include <rtems.h>
47
48#ifdef __cplusplus
49extern "C" {
50#endif /* __cplusplus */
51
52/**
53 * @brief The DHCP client configuration (dhcpcd).
54 *
55 * Zero initialize the structure to allow future extensions.
56 */
57typedef struct rtems_dhcpcd_config {
58        rtems_task_priority priority;
59        int argc;
60        char **argv;
61        void (*prepare)(const struct rtems_dhcpcd_config *config,
62            int argc, char **argv);
63        void (*destroy)(const struct rtems_dhcpcd_config *config,
64            int exit_code);
65} rtems_dhcpcd_config;
66
67/**
68 * @brief Starts the DHCP client (dhcpcd).
69 *
70 * @param config The DHCP client configuration.  Use NULL for a default
71 * configuration.
72 *
73 * @retval RTEMS_SUCCESSFUL Successful operation.
74 * @retval RTEMS_INCORRECT_STATE The DHCP client runs already.
75 * @retval RTEMS_TOO_MANY No task control block available.
76 * @retval RTEMS_UNSATISFIED Not enough resources to create task.
77 * @retval RTEMS_INVALID_PRIORITY Invalid task priority.
78 */
79rtems_status_code rtems_dhcpcd_start(const rtems_dhcpcd_config *config);
80
81typedef struct rtems_dhcpcd_hook {
82        SLIST_ENTRY(rtems_dhcpcd_hook) node;
83        const char *name;
84        void (*handler)(struct rtems_dhcpcd_hook *hook, char *const *env);
85} rtems_dhcpcd_hook;
86
87/**
88 * @brief Adds a DHCP client hook.
89 *
90 * The hook handler is invoked with an environment list (NULL terminated) of
91 * strings ('\0' terminated).  Each string of the environment list has usually
92 * the format "key=value", e.g. "interface=eth0", "reason=BOUND".
93 *
94 * The hook handler are called by the DHCP client task.  It is safe to
95 * add/remove hooks in the hook handler.
96 */
97void rtems_dhcpcd_add_hook(rtems_dhcpcd_hook *hook);
98
99/**
100 * @brief Removes a DHCP client hook.
101 */
102void rtems_dhcpcd_remove_hook(rtems_dhcpcd_hook *hook);
103
104/** @} */
105
106#ifdef __cplusplus
107}
108#endif /* __cplusplus */
109
110#endif /* _RTEMS_DHCPCD_H_ */
Note: See TracBrowser for help on using the repository browser.