d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nvram2env: Retire unused MIPS-specific driver

Browse Source 
This code was used only on MIPS platforms, and has not built in some
time.

Reviewed by: ray
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D38986
This commit is contained in:
Ed Maste 2023-03-08 12:22:29 -05:00
parent 3140e27ee5
commit 4a869d380e
5 changed files with 0 additions and 515 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
share/man/man4/Makefile
View File

@ -415,7 +415,6 @@ MAN= aac.4 \
${_nvdimm.4} \
${_nvme.4} \
${_nvram.4} \
${_nvram2env.4} \
oce.4 \
ocs_fc.4\
ohci.4 \
@ -887,10 +886,6 @@ _vmm.4= vmm.4
.endif
.endif
.if ${MACHINE_CPUARCH} == "mips"
_nvram2env.4= nvram2env.4
.endif
.if ${MACHINE_CPUARCH} == "powerpc"
_nvd.4= nvd.4
_nvme.4= nvme.4

117
share/man/man4/nvram2env.4
View File

@ -1,117 +0,0 @@
.\" Copyright (c) 2011 Aleksandr Rybalko
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd April 3, 2011
.Dt NVRAM2ENV 4
.Os
.Sh NAME
.Nm nvram2env
.Nd "copy nvram-like data into kernel environment"
.Sh SYNOPSIS
.Cd "device nvram2env"
.Sh DESCRIPTION
.Nm
implements a simple method of reading the NVRAM-like data and information
stored in flash and storing it in the kernel environment.
It can then be used by various device drivers at boot-time.
.Pp
The NVRAM-like data is an array of zero terminated strings.
Each string contains the string name, "=" delimiter and the string value.
.Pp
.Nm
copies the environment values into kernel environment using the kernel setenv call.
.Pp
Configuration of
.Nm
is done in
.Xr device.hints 5
defining the NVRAM base address, fallback base address, maxsize and flags.
.Pp
.Nm
is currently MIPS-specific.
.Ss base
base - physical address where data block is stored.
.Ss fallbackbase
fallbackbase - physical address where data block is stored, but only
if not found at base.
.Ss maxsize
maxsize - maximum size of data block.
.Ss flags
flags - control flags, used to select nvram type and enable/disable CRC check.
.Bl -tag -width indent
.It Fa 0x0001
Avoid CRC checking.
Currently CRC checking is not implemented, so to be future
compatible, please set it to "1".
.It Fa 0x0002
Use format "Generic", skip uint32_t field, then zero terminating array of
strings.
.It Fa 0x0004
Use Broadcom CFE format, uint32_t signature "FLSH", uint32_t size,
three unused fields uint32_t, then data.
.It Fa 0x0008
Use U-Boot format, uint32_t crc, then zero terminating array of strings.
.El
.Sh EXAMPLES
Usage in U-Boot case:
.Bd -literal -offset indent
hint.nvram.0.base=0x1f030000
hint.nvram.0.maxsize=0x2000
hint.nvram.0.flags=3 # 1 = No check, 2 = Format Generic
hint.nvram.1.base=0x1f032000
hint.nvram.1.maxsize=0x4000
hint.nvram.1.flags=3 # 1 = No check, 2 = Format Generic
.Ed
.Pp
CFE nvram with fallback:
.Bd -literal -offset indent
hint.nvram.0.base=0x1fff8000
hint.nvram.0.fallbackbase=0x1fc00400
hint.nvram.0.flags=4 # 4 = Format Broadcom
.Ed
.Pp
but seems for CFE nvram preferred to read both blocks:
.Pp
NVRAM partition: Static, CFE internal
.Bd -literal -offset indent
hint.nvram.0.flags=0x05 # Broadcom + nocheck
hint.nvram.0.base=0x1fc00400
.Ed
.Pp
Dynamic, editable form CFE, override values from first
.Bd -literal -offset indent
hint.nvram.1.flags=0x05 # Broadcom + nocheck
hint.nvram.1.base=0x1cff8000
.Ed
.Sh SEE ALSO
.Xr kenv 1 ,
.Xr kenv 2
.Sh HISTORY
.Nm
first appeared in
.Fx 9.0 .
.Sh AUTHORS
.An Aleksandr Rybalko Aq Mt ray@ddteam.net

286
sys/dev/nvram2env/nvram2env.c
View File

@ -1,286 +0,0 @@
/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2010 Aleksandr Rybalko.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Pseudo driver to copy the NVRAM settings from various sources
* into the kernel environment.
*
* Drivers (such as ethernet devices) can then use environment
* variables to set default parameters.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/bus.h>
#include <sys/endian.h>
#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/rman.h>
#include <sys/malloc.h>
#include <machine/bus.h>
#include "nvram2env.h"
static void
nvram2env_identify(driver_t * drv, device_t parent)
{
int i, ivar;
for (i = 0; !resource_int_value("nvram", i, "base", &ivar); i++)
BUS_ADD_CHILD(parent, 0, "nvram2env", i);
}
int
nvram2env_probe(device_t dev)
{
uint32_t i, ivar, sig;
struct nvram2env_softc * sc = device_get_softc(dev);
/*
* Please ensure that your implementation of NVRAM->ENV specifies
* bus tag
*/
if (sc->bst == NULL)
return (ENXIO);
if (sc->sig == 0)
if (resource_int_value("nvram", device_get_unit(dev), "sig",
&sc->sig) != 0 || sc->sig == 0)
sc->sig = CFE_NVRAM_SIGNATURE;
if (sc->maxsize == 0)
if (resource_int_value("nvram", device_get_unit(dev), "maxsize",
&sc->maxsize) != 0 || sc->maxsize == 0)
sc->maxsize = NVRAM_MAX_SIZE;
if (sc->flags == 0)
if (resource_int_value("nvram", device_get_unit(dev), "flags",
&sc->flags) != 0 || sc->flags == 0)
sc->flags = NVRAM_FLAGS_GENERIC;
for (i = 0; i < 2; i ++)
{
switch (i) {
case 0:
break;
case 1:
case 2:
if (resource_int_value("nvram", device_get_unit(dev),
(i == 1) ? "base" : "fallbackbase", &ivar) != 0 ||
ivar == 0)
continue;
sc->addr = ivar;
break;
default:
break;
}
if (sc->addr == 0)
continue;
if (bootverbose)
device_printf(dev, "base=0x%08x sig=0x%08x "
"maxsize=0x%08x flags=0x%08x\n",
sc->addr, sc->sig, sc->maxsize, sc->flags);
if (bus_space_map(sc->bst, sc->addr, sc->maxsize, 0,
&sc->bsh) != 0)
continue;
sig = bus_space_read_4(sc->bst, sc->bsh, 0);
if ( sig == sc->sig /*FLSH*/)
{
device_printf(dev, "Found NVRAM at %#x\n",
(uint32_t)ivar);
sc->need_swap = 0;
goto unmap_done;
}
else if ( htole32(sig) == sc->sig /*HSLF*/)
{
device_printf(dev, "Found NVRAM at %#x\n",
(uint32_t)ivar);
sc->need_swap = 1;
goto unmap_done;
} else if (sc->flags & NVRAM_FLAGS_UBOOT) {
device_printf(dev, "Use NVRAM at %#x\n",
(uint32_t)ivar);
sc->crc = sig;
goto unmap_done;
}
bus_space_unmap(sc->bst, sc->bsh, NVRAM_MAX_SIZE);
}
sc->bst = 0;
sc->bsh = 0;
sc->addr = 0;
return (ENXIO);
unmap_done:
bus_space_unmap(sc->bst, sc->bsh, NVRAM_MAX_SIZE);
device_set_desc(dev, "NVRAM to ENV pseudo-device");
return (BUS_PROBE_SPECIFIC);
}
static uint32_t read_4(struct nvram2env_softc * sc, int offset)
{
if (sc->need_swap)
return (bswap32(bus_space_read_4(sc->bst, sc->bsh, offset)));
else
return (bus_space_read_4(sc->bst, sc->bsh, offset));
}
int
nvram2env_attach(device_t dev)
{
struct nvram2env_softc *sc;
struct nvram *nv;
char *pair, *value, *assign;
uint32_t sig, size, i, *tmp;
sc = device_get_softc(dev);
if (sc->bst == 0 || sc->addr == 0)
return (ENXIO);
if (bus_space_map(sc->bst, sc->addr, NVRAM_MAX_SIZE, 0,
&sc->bsh) != 0)
return (ENXIO);
sig = read_4(sc, 0);
size = read_4(sc, 4);
if (bootverbose)
device_printf(dev, " size=0x%05x maxsize=0x%05x\n", size,
sc->maxsize);
size = (size > sc->maxsize)?sc->maxsize:size;
if (sig == sc->sig || (sc->flags & NVRAM_FLAGS_UBOOT))
{
/* align size to 32bit size*/
size += 3;
size &= ~3;
nv = malloc(size, M_DEVBUF, M_WAITOK | M_ZERO);
if (!nv)
return (ENOMEM);
/* set tmp pointer to begin of NVRAM */
tmp = (uint32_t *) nv;
/* use read_4 to swap bytes if it's required */
for (i = 0; i < size; i += 4) {
*tmp = read_4(sc, i);
tmp++;
}
/* now tmp pointer is end of NVRAM */
if (sc->flags & NVRAM_FLAGS_BROADCOM) {
device_printf(dev, "sig = %#x\n", nv->sig);
device_printf(dev, "size = %#x\n", nv->size);
}
if (!(sc->flags & NVRAM_FLAGS_NOCHECK)) {
/* TODO: need checksum verification */
}
if (sc->flags & NVRAM_FLAGS_GENERIC)
pair = (char*)nv+4;
if (sc->flags & NVRAM_FLAGS_UBOOT)
pair = (char*)nv+4;
else if (sc->flags & NVRAM_FLAGS_BROADCOM)
pair = (char*)nv+20;
else
pair = (char*)nv+4;
/* iterate over buffer till end. tmp points to end of NVRAM */
for ( ; pair < (char*)tmp;
pair += strlen(pair) + strlen(value) + 2 ) {
if (!pair || (strlen(pair) == 0))
break;
/* hint.nvram.0. */
assign = strchr(pair,'=');
assign[0] = '\0';
value = assign+1;
if (bootverbose)
printf("ENV[%p]: %s=%s\n",
(void*)((char*)pair - (char*)nv),
pair, value);
kern_setenv(pair, value);
if (strcasecmp(pair, "WAN_MAC_ADDR") == 0) {
/* Alias for MAC address of eth0 */
if (bootverbose)
printf("ENV: aliasing "
"WAN_MAC_ADDR to ethaddr"
" = %s\n", value);
kern_setenv("ethaddr", value);
}
else if (strcasecmp(pair, "LAN_MAC_ADDR") == 0){
/* Alias for MAC address of eth1 */
if (bootverbose)
printf("ENV: aliasing "
"LAN_MAC_ADDR to eth1addr"
" = %s\n", value);
kern_setenv("eth1addr", value);
}
if (strcmp(pair, "bootverbose") == 0)
bootverbose = strtoul(value, 0, 0);
if (strcmp(pair, "boothowto" ) == 0)
boothowto = strtoul(value, 0, 0);
}
free(nv, M_DEVBUF);
}
bus_space_unmap(sc->bst, sc->bsh, NVRAM_MAX_SIZE);
return (0);
}
static device_method_t nvram2env_methods[] = {
/* Device interface */
DEVMETHOD(device_identify, nvram2env_identify),
DEVMETHOD(device_probe, nvram2env_probe),
DEVMETHOD(device_attach, nvram2env_attach),
DEVMETHOD_END
};
driver_t nvram2env_driver = {
"nvram2env",
nvram2env_methods,
sizeof(struct nvram2env_softc),
};

86
sys/dev/nvram2env/nvram2env.h
View File

@ -1,86 +0,0 @@
/*-
* Copyright (c) 2010 Aleksandr Rybalko.
* Copyright (c) 2016 Michael Zhilin.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef NVRAM2ENV_NVRAM2ENV_H_
#define NVRAM2ENV_NVRAM2ENV_H_
#define nvram2env_read_1(sc, reg) \
bus_space_read_1((sc)->sc_bt, (sc)->sc_bh,(reg))
#define nvram2env_read_2(sc, reg) \
bus_space_read_2((sc)->sc_bt, (sc)->sc_bh,(reg))
#define nvram2env_read_4(sc, reg) \
bus_space_read_4((sc)->sc_bt, (sc)->sc_bh,(reg))
#define nvram2env_write_1(sc, reg, val) \
bus_space_write_1((sc)->sc_bt, (sc)->sc_bh, \
(reg), (val))
#define nvram2env_write_2(sc, reg, val) \
bus_space_write_2((sc)->sc_bt, (sc)->sc_bh, \
(reg), (val))
#define nvram2env_write_4(sc, reg, val) \
bus_space_write_4((sc)->sc_bt, (sc)->sc_bh, \
(reg), (val))
struct nvram2env_softc {
bus_space_tag_t bst;
bus_space_handle_t bsh;
bus_addr_t addr;
int need_swap;
uint32_t sig;
uint32_t flags;
#define NVRAM_FLAGS_NOCHECK 0x0001 /* Do not check(CRC or somthing else)*/
#define NVRAM_FLAGS_GENERIC 0x0002 /* Format Generic, skip 4b and read */
#define NVRAM_FLAGS_BROADCOM 0x0004 /* Format Broadcom, use struct nvram */
#define NVRAM_FLAGS_UBOOT 0x0008 /* Format Generic, skip 4b of CRC and read */
uint32_t maxsize;
uint32_t crc;
};
#define NVRAM_MAX_SIZE 0x10000
#define CFE_NVRAM_SIGNATURE 0x48534c46
struct nvram {
u_int32_t sig;
u_int32_t size;
u_int32_t unknown1;
u_int32_t unknown2;
u_int32_t unknown3;
char data[];
};
int nvram2env_attach(device_t);
int nvram2env_probe(device_t);
extern driver_t nvram2env_driver;
#endif /* SYS_DEV_NVRAM2ENV_NVRAM2ENV_H_ */

21
tools/kerneldoc/subsys/Doxyfile-dev_nvram2env
View File

@ -1,21 +0,0 @@
# Doxyfile 1.5.2
# $FreeBSD$
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "FreeBSD kernel NVRAM2ENV device code"
OUTPUT_DIRECTORY = $(DOXYGEN_DEST_PATH)/dev_nvram2env/
EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/nvram2env/ \
$(NOTREVIEWED)
GENERATE_TAGFILE = dev_nvram2env/dev_nvram2env.tag
@INCLUDE_PATH = $(DOXYGEN_INCLUDE_PATH)
@INCLUDE = common-Doxyfile