Nut/OS  4.10.3
API Reference
confos.h
Go to the documentation of this file.
00001 #ifndef _SYS_CONFOS_H_
00002 #define _SYS_CONFOS_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2006 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 
00086 #include <sys/types.h>
00087 #include <cfg/eeprom.h>
00088 
00089 #include <stdint.h>
00090 
00095 
00102 #ifndef CONFOS_EE_OFFSET
00103 #define CONFOS_EE_OFFSET    0
00104 #endif
00105 
00106 #ifndef CONFOS_EE_MAGIC
00107 #define CONFOS_EE_MAGIC     "OS"
00108 #endif
00109 
00116 #ifndef MAX_HOSTNAME_LEN
00117 #define MAX_HOSTNAME_LEN    15
00118 #endif
00119 
00125 #ifndef CONFOS_VIRGIN_HOSTNAME
00126 #define CONFOS_VIRGIN_HOSTNAME  "ethernut"
00127 #endif
00128 
00132 typedef struct _CONFOS CONFOS;
00133 
00141 struct __attribute__ ((packed)) _CONFOS {
00147     uint8_t size;
00148 
00153     uint8_t magic[sizeof(CONFOS_EE_MAGIC) - 1];
00154 
00157     char hostname[MAX_HOSTNAME_LEN + 1];
00158 };
00159 
00160 extern CONFOS confos;
00161 
00162 __BEGIN_DECLS
00163 /* Function prototypes */
00164 
00165 extern int NutLoadConfig(void);
00166 extern int NutSaveConfig(void);
00167 
00168 __END_DECLS
00169 /* End of prototypes */
00170 
00173 #endif