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

5-freebsd-12
Last change on this file since 8bd38d6 was 8bd38d6, checked in by Sebastian Huber <sebastian.huber@…>, on May 2, 2018 at 6:58:48 AM

dhcpcd: Add rtems_dhcpcd_start()

Use it throughout to start the DHCP client (dhcpcd).

  • Property mode set to 100644
File size: 2.6 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 <rtems.h>
44
45#ifdef __cplusplus
46extern "C" {
47#endif /* __cplusplus */
48
49/**
50 * @brief The DHCP client configuration (dhcpcd).
51 *
52 * Zero initialize the structure to allow future extensions.
53 */
54typedef struct rtems_dhcpcd_config {
55        rtems_task_priority priority;
56        int argc;
57        char **argv;
58        void (*prepare)(const struct rtems_dhcpcd_config *config,
59            int argc, char **argv);
60        void (*destroy)(const struct rtems_dhcpcd_config *config,
61            int exit_code);
62} rtems_dhcpcd_config;
63
64/**
65 * @brief Starts the DHCP client (dhcpcd).
66 *
67 * @param config The DHCP client configuration.  Use NULL for a default
68 * configuration.
69 *
70 * @retval RTEMS_SUCCESSFUL Successful operation.
71 * @retval RTEMS_INCORRECT_STATE The DHCP client runs already.
72 * @retval RTEMS_TOO_MANY No task control block available.
73 * @retval RTEMS_UNSATISFIED Not enough resources to create task.
74 * @retval RTEMS_INVALID_PRIORITY Invalid task priority.
75 */
76rtems_status_code rtems_dhcpcd_start(const rtems_dhcpcd_config *config);
77
78/** @} */
79
80#ifdef __cplusplus
81}
82#endif /* __cplusplus */
83
84#endif /* _RTEMS_DHCPCD_H_ */
Note: See TracBrowser for help on using the repository browser.