freebsd-dev/sys/dev/bhnd/nvram/bhnd_nvram_parserreg.h
Landon J. Fuller 1728aef23d bhnd(4): Implement NVRAM support required for PMU bring-up.
- Added a generic bhnd_nvram_parser API, with support for the TLV format
  used on WGT634U devices, the standard BCM NVRAM format used on most
  modern devices, and the "board text file" format used on some hardware
  to supply external NVRAM data at runtime (e.g. via an EFI variable).

- Extended the bhnd_bus_if and bhnd_nvram_if interfaces to support both
  string-based and primitive data type variable access, required for
  common behavior across both SPROM and NVRAM data sources.
- Extended the existing SPROM implementation to support the new
  string-based NVRAM APIs.

- Added an abstract bhnd_nvram driver, implementing the bhnd_nvram_if
  atop the bhnd_nvram_parser API.
- Added a CFE-based bhnd_nvram driver to provide read-only access to
  NVRAM data on MIPS SoCs, pending implementation of a flash-aware
  bhnd_nvram driver.

Approved by:	adrian (mentor)
Differential Revision:	https://reviews.freebsd.org/D7489
2016-08-16 21:32:05 +00:00

76 lines
2.9 KiB
C

/*-
* Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org>
* 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,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
* redistribution must be conditioned upon including a substantially
* similar Disclaimer requirement for further binary redistribution.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
*
* $FreeBSD$
*/
#ifndef _BHND_NVRAM_BHND_NVRAM_PARSERREG_H_
#define _BHND_NVRAM_BHND_NVRAM_PARSERREG_H_
#define NVRAM_GET_BITS(_value, _field) \
((_value & _field ## _MASK) >> _field ## _SHIFT)
/* NVRAM header fields */
#define NVRAM_MAGIC 0x48534C46 /* 'FLSH' */
#define NVRAM_VERSION 1
#define NVRAM_CRC_SKIP 9 /* skip magic, size, and crc8 */
#define NVRAM_CFG0_CRC_MASK 0x000000FF
#define NVRAM_CFG0_CRC_SHIFT 0
#define NVRAM_CFG0_VER_MASK 0x0000FF00
#define NVRAM_CFG0_VER_SHIFT 8
#define NVRAM_CFG0_SDRAM_INIT_MASK 0xFFFF0000
#define NVRAM_CFG0_SDRAM_INIT_SHIFT 16
#define NVRAM_CFG0_SDRAM_INIT_VAR "sdram_init"
#define NVRAM_CFG0_SDRAM_INIT_FMT "0x%04x"
#define NVRAM_CFG1_SDRAM_CFG_MASK 0x0000FFFF
#define NVRAM_CFG1_SDRAM_CFG_SHIFT 0
#define NVRAM_CFG1_SDRAM_CFG_VAR "sdram_config"
#define NVRAM_CFG1_SDRAM_CFG_FMT "0x%04x"
#define NVRAM_CFG1_SDRAM_REFRESH_MASK 0xFFFF0000
#define NVRAM_CFG1_SDRAM_REFRESH_SHIFT 16
#define NVRAM_CFG1_SDRAM_REFRESH_VAR "sdram_refresh"
#define NVRAM_CFG1_SDRAM_REFRESH_FMT "0x%04x"
#define NVRAM_SDRAM_NCDL_MASK UINT32_MAX
#define NVRAM_SDRAM_NCDL_SHIFT 0
#define NVRAM_SDRAM_NCDL_VAR "sdram_ncdl"
#define NVRAM_SDRAM_NCDL_FMT "0x%08x"
/* WGT634U-specific TLV encoding */
#define NVRAM_TLV_TF_U8_LEN 0x01 /**< type has 8-bit length */
#define NVRAM_TLV_TYPE_END 0x00 /**< end of table */
#define NVRAM_TLV_TYPE_ENV 0x01 /**< variable record */
#endif /* _BHND_NVRAM_BHND_NVRAM_PARSERVAR_H_ */