freebsd-dev/sys/dev/bhnd
Landon J. Fuller 77cb4d3e50 bhnd(4): Unify NVRAM/SPROM parsing, implement compact SPROM layout encoding.
- Defined an abstract NVRAM I/O API (bhnd_nvram_io), decoupling NVRAM/SPROM
  parsing from the actual underlying NVRAM data provider (e.g. CFE firmware
  devices).
- Defined an abstract NVRAM data API (bhnd_nvram_data), decoupling
  higher-level NVRAM operations (indexed lookup, data conversion, etc) from
  the underlying NVRAM file format parsing/serialization.
- Implemented a new high-level bhnd_nvram_store API, providing indexed
  variable lookup, pending write tracking, etc on top of an arbitrary
  bhnd_nvram_data instance.
- Migrated all bhnd(4) NVRAM device drivers to the common bhnd_nvram_store
  API.
- Implemented a common bhnd_nvram_val API for parsing/encoding NVRAM
  variable values, including applying format-specific behavior when
  converting to/from the NVRAM string representations.
- Dropped the now unnecessary bhnd_nvram driver, and moved the
  broadcom/mips-specific CFE NVRAM driver out into sys/mips/broadcom.
- Implemented a new nvram_map file format:
        - Variable definitions are now defined separately from the SPROM
          layout. This will also allow us to define CIS tuple NVRAM
          mappings referencing the common NVRAM variable definitions.
        - Variables can now be defined within arbitrary named groups.
        - Textual descriptions and help information can be defined inline
          for both variables and variable groups.
        - Implemented a new, compact encoding of SPROM image layout
          offsets.
- Source-level (but not build system) support for building the NVRAM file
  format APIs (bhnd_nvram_io, bhnd_nvram_data, bhnd_nvram_store) as a
  userspace library.

The new compact SPROM image layout encoding is loosely modeled on Apple
dyld compressed LINKEDIT symbol binding opcodes; it provides a compact
state-machine encoding of the mapping between NVRAM variables and the SPROM
image offset, mask, and shift instructions necessary to decode or encode
the SPROM variable data.

The compact encoding reduces the size of the generated SPROM layout data
from roughly 60KB to 3KB. The sequential nature SPROM layout opcode tables
also simplify iteration of the SPROM variables, as it's no longer
neccessary to iterate the full NVRAM variable definition table, but
instead simply scan the SPROM revision's layout opcode table.

Approved by:    adrian (mentor)
Differential Revision:  https://reviews.freebsd.org/D8645
2016-11-26 23:22:32 +00:00
..
bcma [BHND] correct spelling error in macro name 2016-11-15 20:05:22 +00:00
bhndb bhnd: remove redundant ;s at the end of functions or switch statements 2016-09-06 13:34:10 +00:00
cores Fix device delete child function. 2016-10-17 10:20:38 +00:00
nvram bhnd(4): Unify NVRAM/SPROM parsing, implement compact SPROM layout encoding. 2016-11-26 23:22:32 +00:00
siba bhnd(4): Implement common API for IOST/IOCTL register access and core reset 2016-09-24 04:08:16 +00:00
tools bhnd(4): Unify NVRAM/SPROM parsing, implement compact SPROM layout encoding. 2016-11-26 23:22:32 +00:00
bhnd_bus_if.m bhnd(4): Implement common API for IOST/IOCTL register access and core reset 2016-09-24 04:08:16 +00:00
bhnd_debug.h - Fix make in sys/modules/bhnd 2016-11-01 03:49:31 +00:00
bhnd_erom_if.m Migrate bhndb(4) to the new bhnd_erom API. 2016-09-04 00:58:19 +00:00
bhnd_erom_types.h Implement a generic bhnd(4) device enumeration table API. 2016-09-03 23:57:17 +00:00
bhnd_erom.c Migrate bhndb(4) to the new bhnd_erom API. 2016-09-04 00:58:19 +00:00
bhnd_erom.h Migrate bhndb(4) to the new bhnd_erom API. 2016-09-04 00:58:19 +00:00
bhnd_ids.h bhnd(4): Initial PMU/PWRCTL power and clock management support. 2016-08-27 00:03:02 +00:00
bhnd_match.h Migrate bhndb(4) to the new bhnd_erom API. 2016-09-04 00:58:19 +00:00
bhnd_nexus.c bhnd(4): Implement backplane interrupt handling. 2016-09-05 22:11:46 +00:00
bhnd_nexusvar.h Switch mips/sentry5 to bhnd(4), and unify with mips/broadcom 2016-06-04 19:53:47 +00:00
bhnd_subr.c bhnd(4): Unify NVRAM/SPROM parsing, implement compact SPROM layout encoding. 2016-11-26 23:22:32 +00:00
bhnd_types.h bhnd(4): Add device classes for USB host/dev/dual-mode controller cores. 2016-09-05 21:48:16 +00:00
bhnd.c bhnd(4): Implement common API for IOST/IOCTL register access and core reset 2016-09-24 04:08:16 +00:00
bhnd.h bhnd(4): Implement common API for IOST/IOCTL register access and core reset 2016-09-24 04:08:16 +00:00
bhndreg.h
bhndvar.h bhnd(4): Implement common API for IOST/IOCTL register access and core reset 2016-09-24 04:08:16 +00:00