Bug 6555

Summary: Provide User-Centric BIOS configuration menus
Product: [Hardware Platforms] MinnowBoard MAX Firmware Reporter: Darren Hart <dvhart>
Component: minnowmax-edk2Assignee: Michael Krau <michael.p.krau>
Status: RESOLVED MOVED QA Contact:
Severity: enhancement    
Priority: Low CC: sjolley.yp.pm, warthog9
Version: unspecified   
Target Milestone: Production Release   
Hardware: MinnowBoard Max   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Don't know

Description Darren Hart 2014-07-18 18:34:28 UTC
Max Eliaser raised the issue that finding things like the MMC/SD configuration was difficult for someone not intimately familiar Intel terminology and the SoC architecture.

For example, to configure the low-speed expansion header (GPIO/Native mode) one needs to navigate through:

Device Manager -> System Setup -> South Cluster Configuration -> LPSS & SCC Configuration

That's an impressively deep hierarchy of rather arcane terminology.

We should consider providing a menu system that is logical from a user perspective, using MinnowBoard-Max specific terminology. For example:

Board Configuration
    Configure Low Speed Expansion
    Configure High Speed Expansion

Items that do not apply to the board or cannot be changed should be removed and not left and not left as inactive options. The PCI Root ports, USB OTG Support,  NGFF, for example.
Comment 1 Darren Hart 2014-11-06 23:04:44 UTC
Can we get an update on this? Steps completed? Next steps planned? ETA?
Comment 2 John 'Warthog9' Hawley 2014-11-07 00:21:35 UTC
http://www.elinux.org/Minnowboard:MaxBios

Mostly current firmware menu mapping.
Comment 3 Michael Krau 2014-11-08 00:24:31 UTC
Actually there are a couple of master options in the 'setup' of the MAX:
Language selection - straight forward enough
Boot Manager - boot setup
Device manager - device setup
Boot Maintenance Manager - Boot, driver, Timeout, and console options of the system (including serial console)

Focusing upon the Device manager, which is the hardware 'setup' of the system which is currently arranged to reflect the hardware block diagram of the MinnowBoard MAX.

The question becomes a several fold series to refine the expectation of the user and of Setup.

Question 1: Should the setup reflect the hardware design of the current MinnowBoard MAX or should it reflect the hardware capabilities of the components, so future derivative designs may use the firmware with minimum modification to effect setup changes? 

i.e. the MAX does not populate PCIe lanes 0 or 1.  So should those be removed from setup?  If so, what is the plan for firmware support of those lanes on designs derivative but based upon the production MAX design (those lanes get used).

Question 2: Should the mechanism and order remain, and the titles and descriptions be changed to some less architecture specific lexicon:

i.e. the "Uncore configuration" menu is really only related to video device configuration.  If that title were changed (uncore ==> video) would that be sufficient clarification?

uncore ==> video
South Cluster ==> peripherals

Question 3: to what degree should the architecture specific lexicon be converted?  Intel Architecture? UEFI architecture? other BIOS standards Architectures (USB, PCI, LPE, SATA)?  

the setup can be changed a myriad of ways, but each change will create new opportunities, and will close others.  These questions are to establish a strategy around the direction these changes should go.
Comment 4 Darren Hart 2014-11-13 21:22:37 UTC
(In reply to comment #3)

> Question 1: Should the setup reflect the hardware design of the current
> MinnowBoard MAX or should it reflect the hardware capabilities of the
> components, so future derivative designs may use the firmware with minimum
> modification to effect setup changes? 

The firmware should match the device it ships with. For people creating derivative devices, the firmware source is available for them to customize the firmware to their specific needs. The customization for MinnowMAX should be one of configuration and not of code removal such that it should be a relatively easy reconfiguration for people to add in new features not present on the MinnowMAX, or to remove features not on their derivative board.


> Question 2: Should the mechanism and order remain, and the titles and
> descriptions be changed to some less architecture specific lexicon:

That is the general idea, yes.

> i.e. the "Uncore configuration" menu is really only related to video device
> configuration.  If that title were changed (uncore ==> video) would that be
> sufficient clarification?
> 
> uncore ==> video

This seems to make sense - but there is also "ISP PCI Device Configuration" under "uncore".


> South Cluster ==> peripherals

The South Cluster is generally very deep and complex to get to anything a user really cares about. In general, we are looking to approach this from MinnowBoard MAX task based perspective, instead of an SoC block diagram.

A user is likely to want to "Reconfigure the pins on the low speed expansion header" which doesn't translate to "Device manager->South Cluster Configuration->LPSS & SCC Configuration->LPSS 1 Configuration-> ..."

Reconfiguring these pins is likely to be the single most common task anyone performs on the board (with the possible exception of selecting the boot device). The menu interface should be optimized for these common cases, not just in lexicon, but also in hierarchy and organization.

> Question 3: to what degree should the architecture specific lexicon be
> converted?  Intel Architecture? UEFI architecture? other BIOS standards
> Architectures (USB, PCI, LPE, SATA)?

The most practical approach to documentation in my experience is to document for the least knowledgeable user. They are the most common, and they are the most resource intensive to support via lists and such (due to the repetitive nature of the questions and the inability to generalize due to lack of context). Design and document for them and most everyone else will be able to get what they need to out of it as well.

So terms that appear on devices they might purchase (USB, PCI, SATA, etc) are going to be familiar, SoC specific terminology like uncore, south cluster, LPSS, etc. are not.
Comment 5 Stephen K Jolley 2014-12-01 18:38:01 UTC
It appears the needed information has been supplied.
Comment 6 Stephen K Jolley 2017-06-13 18:03:37 UTC
We are no longer tracking in Yocto Project Bugzilla MinnowBoard and MinnowBoard-MAX HW and firmware bugs.