packages/redboot/v2_0/include/flash_config.h

   1 //==========================================================================
   2 //
   3 //      flash_config.h
   4 //
   5 //      Flash configuration data tables for RedBoot
   6 //
   7 //==========================================================================
   8 //####ECOSGPLCOPYRIGHTBEGIN####
   9 // -------------------------------------------
  10 // This file is part of eCos, the Embedded Configurable Operating System.
  11 // Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 Red Hat, Inc.
  12 //
  13 // eCos is free software; you can redistribute it and/or modify it under
  14 // the terms of the GNU General Public License as published by the Free
  15 // Software Foundation; either version 2 or (at your option) any later version.
  16 //
  17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 // for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License along
  23 // with eCos; if not, write to the Free Software Foundation, Inc.,
  24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 //
  26 // As a special exception, if other files instantiate templates or use macros
  27 // or inline functions from this file, or you compile this file and link it
  28 // with other works to produce a work based on this file, this file does not
  29 // by itself cause the resulting work to be covered by the GNU General Public
  30 // License. However the source code for this file must still be made available
  31 // in accordance with section (3) of the GNU General Public License.
  32 //
  33 // This exception does not invalidate any other reasons why a work based on
  34 // this file might be covered by the GNU General Public License.
  35 //
  36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 // at http://sources.redhat.com/ecos/ecos-license/
  38 // -------------------------------------------
  39 //####ECOSGPLCOPYRIGHTEND####
  40 //==========================================================================
  41 //#####DESCRIPTIONBEGIN####
  42 //
  43 // Author(s):    gthomas
  44 // Contributors: gthomas
  45 // Date:         2000-08-21
  46 // Purpose:
  47 // Description:
  48 //
  49 // This code is part of RedBoot (tm).
  50 //
  51 //####DESCRIPTIONEND####
  52 //
  53 //==========================================================================
  54
  55 #ifndef _FLASH_CONFIG_H_
  56 #define _FLASH_CONFIG_H_
  57
  58 #define MAX_SCRIPT_LENGTH CYGNUM_REDBOOT_FLASH_SCRIPT_SIZE
  59 #define MAX_STRING_LENGTH CYGNUM_REDBOOT_FLASH_STRING_SIZE
  60 #define MAX_CONFIG_DATA   CYGNUM_REDBOOT_FLASH_CONFIG_SIZE
  61
  62 #define CONFIG_EMPTY   0
  63 #define CONFIG_BOOL    1
  64 #define CONFIG_INT     2
  65 #define CONFIG_STRING  3
  66 #define CONFIG_SCRIPT  4
  67 #ifdef CYGPKG_REDBOOT_NETWORKING
  68 #define CONFIG_IP      5
  69 #define CONFIG_ESA     6
  70 #define CONFIG_NETPORT 7
  71 #endif
  72
  73 struct config_option {
  74     char *key;
  75     char *title;
  76     char *enable;
  77     bool  enable_sense;
  78     int   type;
  79     unsigned long dflt;
  80 } CYG_HAL_TABLE_TYPE;
  81
  82 #define ALWAYS_ENABLED (char *)0
  83
  84 #define RedBoot_config_option(_t_,_n_,_e_,_ie_,_type_,_dflt_)        \
  85 struct config_option _config_option_##_n_                               \
  86 CYG_HAL_TABLE_QUALIFIED_ENTRY(RedBoot_config_options,_n_) =             \
  87    {#_n_,_t_,_e_,_ie_,_type_,(unsigned long)_dflt_};
  88
  89 // Cause the in-memory configuration data to be written to flash
  90 void flash_write_config(bool prompt);
  91 // Fetch a data item from flash storage, returns 'false' if not found
  92 bool flash_get_config(char *key, void *val, int type);
  93 // Update a data item from flash storage, returns 'false' if not found
  94 bool flash_set_config(char *key, void *val, int type);
  95 // Enumerate keys from configuration
  96 bool flash_next_key(char *key, int keylen, int *type, int *offset);
  97 // Add a new data item to configuration data base.  Returns 'false'
  98 // if no space is available.
  99 bool flash_add_config(struct config_option *opt, bool update);
 100
 101 // Internal structure used to hold config data
 102 struct _config {
 103     unsigned long len;
 104     unsigned long key1;
 105     unsigned char config_data[MAX_CONFIG_DATA-(4*4)];
 106     unsigned long key2;
 107     unsigned long cksum;
 108 };
 109
 110 #endif // _FLASH_CONFIG_H_