Nut/OS  4.10.3
API Reference
dhcp.h
Go to the documentation of this file.
00001 #ifndef _PRO_DHCP_H_
00002 #define _PRO_DHCP_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2004 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * -
00036  * Portions Copyright (c) 1983, 1993 by
00037  *  The Regents of the University of California.  All rights reserved.
00038  *
00039  * Redistribution and use in source and binary forms, with or without
00040  * modification, are permitted provided that the following conditions
00041  * are met:
00042  * 1. Redistributions of source code must retain the above copyright
00043  *    notice, this list of conditions and the following disclaimer.
00044  * 2. Redistributions in binary form must reproduce the above copyright
00045  *    notice, this list of conditions and the following disclaimer in the
00046  *    documentation and/or other materials provided with the distribution.
00047  * 3. Neither the name of the University nor the names of its contributors
00048  *    may be used to endorse or promote products derived from this software
00049  *    without specific prior written permission.
00050  *
00051  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00052  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00053  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00054  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00055  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00056  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00057  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00058  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00059  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00060  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00061  * SUCH DAMAGE.
00062  */
00063 
00117 #include <cfg/dhcp.h>
00118 #include <sys/types.h>
00119 #include <stdint.h>
00120 
00121 #include <compiler.h> // For NUT_DEPRECATED
00122 
00127 
00128 
00136 
00147 #define DHCPST_IDLE         0
00148 
00157 #define DHCPST_INIT         1
00158 
00165 #define DHCPST_SELECTING    2
00166 
00174 #define DHCPST_REQUESTING   3
00175 
00181 #define DHCPST_REBOOTING    4
00182 
00195 #define DHCPST_BOUND        5
00196 
00206 #define DHCPST_RENEWING     6
00207 
00217 #define DHCPST_REBINDING    7
00218 
00224 #define DHCPST_INFORMING    8
00225 
00231 #define DHCPST_RELEASING    9
00232 
00243 
00251 #define DHCPERR_TIMEOUT     1
00252 
00259 #define DHCPERR_NOMAC       2
00260 
00268 #define DHCPERR_STATE       3
00269 
00276 #define DHCPERR_BADDEV      17
00277 
00284 #define DHCPERR_SYSTEM      18
00285 
00292 #define DHCPERR_TRANSMIT    19
00293 
00300 #define DHCPERR_RECEIVE     20
00301 
00305 
00306 __BEGIN_DECLS
00307 /* Function prototypes. */
00308 extern int NutDhcpIfConfig(CONST char *name, uint8_t * mac, uint32_t timeout);
00309 extern int NutDhcpRelease(CONST char *name, uint32_t timeout);
00310 extern int NutDhcpInform(CONST char *name, uint32_t timeout);
00311 extern int NutDhcpStatus(CONST char *name);
00312 extern int NutDhcpError(CONST char *name);
00313 
00314 extern int NutDhcpIsConfigured(void) NUT_DEPRECATED;
00315 
00316 __END_DECLS
00317 /* */
00318 #endif