doc: add README for CONFIG_HWCONFIG option
--- doc/README.hwconfig | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 51 insertions(+), 0 deletions(-) create mode 100644 doc/README.hwconfig
doc/README.hwconfig new file +51 -0
@@ -0,0 +1,51 @@ +Enable this feature just define CONFIG_HWCONFIG in your board +config file. + +This implements simple hwconfig infrastructure: an +interface for software knobs to control a hardware. + +This is very simple implementation, i.e. it is implemented +via `hwconfig' environment variable. Later we could write +some "hwconfig <enable|disable|list>" commands, ncurses +interface for Award BIOS-like interface, and frame-buffer +interface for AMI GUI[1] BIOS-like interface with mouse +support[2]. + +Current implementation details/limitations: + +1. Doesn't support options dependencies and mutual exclusion. + We can implement this by integrating apt-get[3] into the + u-boot. But I didn't bother yet. + +2. Since we don't implement hwconfig command, i.e. we're working + with the environement directly, there is no way to tell that + toggling a particular option will need a reboot to take + an effect. So, for now it's advised to always reboot the + target after modifying hwconfig variable. + +3. We support hwconfig options with arguments. For example, + + set hwconfig "dr_usb:mode=peripheral,phy_type=ulpi" + + There are three hwconfig options selected: + 1. dr_usb - enable Dual-Role USB controller; + 2. dr_usb_mode:peripheral - USB in Function mode; + 3. dr_usb_phy_type:ulpi - USB should work with ULPI PHYs. + +The purpose of this simple implementation is to define some +internal API and then we can continue improving user experience +by adding more mature interface, like hwconfig command with +bells and whistles. Or not adding, if we feel that current +interface fits its needs. + +[1] http://en.wikipedia.org/wiki/American_Megatrends +[2] Regarding ncurses and GUI with mouse support -- I'm just + kidding. +[3] The comment regarding apt-get is also a joke, meaning that + dependency tracking could be non-trivial. For example, for + enabling HW feature X we may need to disable Y, and turn Z + into reduced mode (like RMII-only interface for ethernet, + no MII). + + It's quite trivial to implement simple cases though. +
Signature · 5 lines
1.6.2.5 -- DENX Software Engineering GmbH, MD: Wolfgang Denk & Detlev Zundel HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
doc/README.hwconfig line 2
Quoted 2 lines · On Tuesday 09 February 2010 09:50:30 Heiko Schocher wrote:
doc/README.hwconfig new file +2
-0+Enable this feature just define CONFIG_HWCONFIG in your board +config file.
To enable ...
doc/README.hwconfig line 5
Quoted 2 lines
doc/README.hwconfig new file +2
-0+This implements simple hwconfig infrastructure: an +interface for software knobs to control a hardware.
... a simple ...
... control hardware.
Quoted 1 line
+This is very simple implementation, i.e. it is implemented
... is a very ...
Quoted 1 line
+via `hwconfig' environment variable. Later we could write
... via the ...
doc/README.hwconfig line 18
Quoted 3 lines
+1. Doesn't support options dependencies and mutual exclusion.
doc/README.hwconfig new file +2
-0+ We can implement this by integrating apt-get[3] into the + u-boot. But I didn't bother yet.
... into Das U-Boot.
didn't -> haven't
Quoted 1 line
+2. Since we don't implement hwconfig command, i.e. we're working
... implement a hwconfig ...
doc/README.hwconfig line 23
Quoted 2 lines
doc/README.hwconfig new file +2
-0+ toggling a particular option will need a reboot to take + an effect. So, for now it's advised to always reboot the
... take effect.
Quoted 1 line
+ target after modifying hwconfig variable.
... modifying the hwconfig ...
doc/README.hwconfig line 30
Quoted 5 lines
+3. We support hwconfig options with arguments. For example,
doc/README.hwconfig new file +4
-0+ + set hwconfig "dr_usb:mode=peripheral,phy_type=ulpi" + + There are three hwconfig options selected:
This selects three hwconfig options:
Review
Quoted 2 lines
(quoted diff) +2
-0+The purpose of this simple implementation is to define some +internal API and
... to refine the internal ...
Quoted 1 line
+and then we can continue improving user experience
... improving the user ...
Quoted 1 line
+by adding more mature interface, like hwconfig command with
interfaces
... like a hwconfig ...
Quoted 1 line
+bells and whistles. Or not adding, if we feel that current
... that the current ...
Quoted 1 line
+interface fits its needs.
... fits people's needs.
-mike
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: This is a digitally signed message part.
Url : http://lists.denx.de/pipermail/u-boot/attachments/20100209/8df9f664/attachment.pgp
PATCH v2 1/1 doc: add README for CONFIG_HWCONFIG option
---
changes since v1:
- spelling check from Mike Frysinger, thanks!
doc/README.hwconfig | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 51 insertions(+), 0 deletions(-) create mode 100644 doc/README.hwconfig
doc/README.hwconfig new file +51 -0
@@ -0,0 +1,51 @@ +To enable this feature just define CONFIG_HWCONFIG in your board +config file. + +This implements a simple hwconfig infrastructure: an +interface for software knobs to control hardware. + +This a is very simple implementation, i.e. it is implemented +via the `hwconfig' environment variable. Later we could write +some "hwconfig <enable|disable|list>" commands, ncurses +interface for Award BIOS-like interface, and frame-buffer +interface for AMI GUI[1] BIOS-like interface with mouse +support[2]. + +Current implementation details/limitations: + +1. Doesn't support options dependencies and mutual exclusion. + We can implement this by integrating apt-get[3] into Das + U-Boot. But I haven't bother yet. + +2. Since we don't implement a hwconfig command, i.e. we're working + with the environement directly, there is no way to tell that + toggling a particular option will need a reboot to take + effect. So, for now it's advised to always reboot the + target after modifying the hwconfig variable. + +3. We support hwconfig options with arguments. For example, + + set hwconfig "dr_usb:mode=peripheral,phy_type=ulpi" + + This selects three hwconfig options: + 1. dr_usb - enable Dual-Role USB controller; + 2. dr_usb_mode:peripheral - USB in Function mode; + 3. dr_usb_phy_type:ulpi - USB should work with ULPI PHYs. + +The purpose of this simple implementation is to refine the +internal API and then we can continue improving the user +experience by adding more mature interfaces, like a hwconfig +command with bells and whistles. Or not adding, if we feel +that the current interface fits people's needs. + +[1] http://en.wikipedia.org/wiki/American_Megatrends +[2] Regarding ncurses and GUI with mouse support -- I'm just + kidding. +[3] The comment regarding apt-get is also a joke, meaning that + dependency tracking could be non-trivial. For example, for + enabling HW feature X we may need to disable Y, and turn Z + into reduced mode (like RMII-only interface for ethernet, + no MII). + + It's quite trivial to implement simple cases though. +
Signature · 5 lines
1.6.2.5 -- DENX Software Engineering GmbH, MD: Wolfgang Denk & Detlev Zundel HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Wolfgang Denk
AppliedPATCH v2 1/1 doc: add README for CONFIG_HWCONFIG option
Dear Heiko Schocher,
Quoted 8 lines · In message <[email protected]> you wrote:
Signed-off-by Heiko Schocher <[email protected]>---
changes since v1:
- spelling check from Mike Frysinger, thanks!doc/README.hwconfig | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 51 insertions(+), 0 deletions(-) create mode 100644 doc/README.hwconfig
Applied, thanks.
Best regards,
Wolfgang Denk
Signature · 4 lines
DENX Software Engineering GmbH, MD: Wolfgang Denk & Detlev Zundel HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de Often it is fatal to live too long. - Racine