mirror of https://github.com/hak5/openwrt-owl.git
160 lines
4.4 KiB
C
160 lines
4.4 KiB
C
/*
|
|
* NVRAM variable manipulation
|
|
*
|
|
* Copyright 2006, Broadcom Corporation
|
|
* All Rights Reserved.
|
|
*
|
|
* THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
|
|
* KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
|
|
* SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
|
|
*
|
|
* $Id: bcmnvram.h,v 1.17 2006/03/02 12:33:44 honor Exp $
|
|
*/
|
|
|
|
#ifndef _bcmnvram_h_
|
|
#define _bcmnvram_h_
|
|
|
|
#ifndef _LANGUAGE_ASSEMBLY
|
|
|
|
#include <typedefs.h>
|
|
#include <bcmdefs.h>
|
|
|
|
struct nvram_header {
|
|
uint32 magic;
|
|
uint32 len;
|
|
uint32 crc_ver_init; /* 0:7 crc, 8:15 ver, 16:31 sdram_init */
|
|
uint32 config_refresh; /* 0:15 sdram_config, 16:31 sdram_refresh */
|
|
uint32 config_ncdl; /* ncdl values for memc */
|
|
};
|
|
|
|
struct nvram_tuple {
|
|
char *name;
|
|
char *value;
|
|
struct nvram_tuple *next;
|
|
};
|
|
|
|
/*
|
|
* Initialize NVRAM access. May be unnecessary or undefined on certain
|
|
* platforms.
|
|
*/
|
|
extern int nvram_init(void *sbh);
|
|
|
|
/*
|
|
* Disable NVRAM access. May be unnecessary or undefined on certain
|
|
* platforms.
|
|
*/
|
|
extern void nvram_exit(void *sbh);
|
|
|
|
/*
|
|
* Get the value of an NVRAM variable. The pointer returned may be
|
|
* invalid after a set.
|
|
* @param name name of variable to get
|
|
* @return value of variable or NULL if undefined
|
|
*/
|
|
extern char * nvram_get(const char *name);
|
|
|
|
/*
|
|
* Read the reset GPIO value from the nvram and set the GPIO
|
|
* as input
|
|
*/
|
|
extern int BCMINITFN(nvram_resetgpio_init)(void *sbh);
|
|
extern int BCMINITFN(nvram_gpio_init)(const char *name, void *sbh);
|
|
extern int BCMINITFN(nvram_gpio_set)(const char *name, void *sbh, int type);
|
|
|
|
/*
|
|
* Get the value of an NVRAM variable.
|
|
* @param name name of variable to get
|
|
* @return value of variable or NUL if undefined
|
|
*/
|
|
#define nvram_safe_get(name) (nvram_get(name) ? : "")
|
|
|
|
#define nvram_safe_unset(name) ({ \
|
|
if(nvram_get(name)) \
|
|
nvram_unset(name); \
|
|
})
|
|
|
|
#define nvram_safe_set(name, value) ({ \
|
|
if(!nvram_get(name) || strcmp(nvram_get(name), value)) \
|
|
nvram_set(name, value); \
|
|
})
|
|
|
|
/*
|
|
* Match an NVRAM variable.
|
|
* @param name name of variable to match
|
|
* @param match value to compare against value of variable
|
|
* @return TRUE if variable is defined and its value is string equal
|
|
* to match or FALSE otherwise
|
|
*/
|
|
static INLINE int
|
|
nvram_match(char *name, char *match) {
|
|
const char *value = nvram_get(name);
|
|
return (value && !strcmp(value, match));
|
|
}
|
|
|
|
/*
|
|
* Inversely match an NVRAM variable.
|
|
* @param name name of variable to match
|
|
* @param match value to compare against value of variable
|
|
* @return TRUE if variable is defined and its value is not string
|
|
* equal to invmatch or FALSE otherwise
|
|
*/
|
|
static INLINE int
|
|
nvram_invmatch(char *name, char *invmatch) {
|
|
const char *value = nvram_get(name);
|
|
return (value && strcmp(value, invmatch));
|
|
}
|
|
|
|
/*
|
|
* Set the value of an NVRAM variable. The name and value strings are
|
|
* copied into private storage. Pointers to previously set values
|
|
* may become invalid. The new value may be immediately
|
|
* retrieved but will not be permanently stored until a commit.
|
|
* @param name name of variable to set
|
|
* @param value value of variable
|
|
* @return 0 on success and errno on failure
|
|
*/
|
|
extern int nvram_set(const char *name, const char *value);
|
|
|
|
/*
|
|
* Unset an NVRAM variable. Pointers to previously set values
|
|
* remain valid until a set.
|
|
* @param name name of variable to unset
|
|
* @return 0 on success and errno on failure
|
|
* NOTE: use nvram_commit to commit this change to flash.
|
|
*/
|
|
extern int nvram_unset(const char *name);
|
|
|
|
/*
|
|
* Commit NVRAM variables to permanent storage. All pointers to values
|
|
* may be invalid after a commit.
|
|
* NVRAM values are undefined after a commit.
|
|
* @return 0 on success and errno on failure
|
|
*/
|
|
extern int nvram_commit(void);
|
|
|
|
/*
|
|
* Get all NVRAM variables (format name=value\0 ... \0\0).
|
|
* @param buf buffer to store variables
|
|
* @param count size of buffer in bytes
|
|
* @return 0 on success and errno on failure
|
|
*/
|
|
extern int nvram_getall(char *buf, int count);
|
|
|
|
extern int file2nvram(char *filename, char *varname);
|
|
extern int nvram2file(char *varname, char *filename);
|
|
|
|
#endif /* _LANGUAGE_ASSEMBLY */
|
|
|
|
#define NVRAM_MAGIC 0x48534C46 /* 'FLSH' */
|
|
#define NVRAM_CLEAR_MAGIC 0x0
|
|
#define NVRAM_INVALID_MAGIC 0xFFFFFFFF
|
|
#define NVRAM_VERSION 1
|
|
#define NVRAM_HEADER_SIZE 20
|
|
#define NVRAM_SPACE 0x8000
|
|
|
|
#define NVRAM_MAX_VALUE_LEN 255
|
|
#define NVRAM_MAX_PARAM_LEN 64
|
|
|
|
#endif /* _bcmnvram_h_ */
|