coreboot-kgpe-d16/payloads/libpayload
Gabe Black dc9e77f451 libpayload: Add usb_generic_(create|remove) functions for unrecognized devices
It might be useful to provide a USB driver in the payload itself instead of in
libpayload. For example there are multiple payloads being built and linked
against the same libpayload, and they might not need or even want to have the
same set of drivers installed.

This change adds two new functions, usb_generic_create and usb_generic_remove,
which behave like the usbdisk_create and usbdisk_remove functions which are
defined for USB mass storage devices. If a USB device isn't recognized and
claimed by one of the built in USB class drivers (currently hub, hid, and msc)
and the create function is defined, then it will be called to give the payload
a chance to use the device. Once it's removed, if usb_generic_remove is
defined it will be called, effectively giving the payload notice.

Built and booted depthcharge on Link. Built depthcharge for Daisy. Built
a netbooting payload, called usb_poll() with those functions implemented, and
verified that they were called and that the devices they were told about were
reasonable and the same as what was reported by lsusb in the booted system.

Change-Id: Ief7c0a513b60849fbf2986ef4ae5c9e7825fef16
Signed-off-by: Gabe Black <gabeblack@google.com>
Reviewed-on: http://review.coreboot.org/2666
Tested-by: build bot (Jenkins)
Reviewed-by: Kimarie Hoot <kimarie.hoot@se-eng.com>
Reviewed-by: Ronald G. Minnich <rminnich@gmail.com>
2013-03-13 23:08:58 +01:00
..
arch libpayload: Make whether or not there's an IO address space configurable 2013-03-13 23:02:05 +01:00
bin libpayload: fix compiler flags 2013-02-15 06:51:52 +01:00
configs libpayload: Update configs/defconfig file 2012-12-18 15:05:36 +01:00
crypto Change TARGET_I386 to ARCH_X86 2012-11-30 23:20:54 +01:00
curses PDcurses: Delete automatically created (and unused) files 2012-12-20 14:46:29 +01:00
drivers libpayload: Add usb_generic_(create|remove) functions for unrecognized devices 2013-03-13 23:08:58 +01:00
include libpayload: Add usb_generic_(create|remove) functions for unrecognized devices 2013-03-13 23:08:58 +01:00
libc libpayload: Stub out time keeping functions for ARM as well 2013-03-13 23:06:27 +01:00
libcbfs libpayload: Fix reading x86 CBFS images from RAM 2013-03-12 10:23:12 +01:00
liblzma libpayload: Make the source for lzma decompression const 2013-03-13 18:16:35 +01:00
libpci libpayload: minor cleanups 2012-04-04 00:40:31 +02:00
sample fix compilation of hello.elf example payload. 2010-08-28 23:23:47 +00:00
util libpayload: Start using only internal and compiler headers. 2013-03-13 22:04:44 +01:00
Config.in libpayload: Make whether or not there's an IO address space configurable 2013-03-13 23:02:05 +01:00
Doxyfile Run doxygen -u on doxygen configuration files 2010-06-28 10:40:38 +00:00
LICENSES Since some people disapprove of white space cleanups mixed in regular commits 2010-04-27 06:56:47 +00:00
Makefile libpayload: Initial ARMv7 port 2012-12-14 22:29:48 +01:00
Makefile.inc libpayload: Start using only internal and compiler headers. 2013-03-13 22:04:44 +01:00
README libpayload: Update README with Git repository URL and directory location 2013-01-30 17:36:22 +01:00

README

-------------------------------------------------------------------------------
libpayload README
-------------------------------------------------------------------------------

libpayload is a minimal library to support standalone payloads
that can be booted with firmware like coreboot. It handles the setup
code, and provides common C library symbols such as malloc() and printf().

Note: This is _not_ a standard library for use with an operating system,
rather it's only useful for coreboot payload development!
See http://coreboot.org for details on coreboot.


Installation
------------

 $ git clone http://review.coreboot.org/p/coreboot.git

 $ cd payloads/libpayload

 $ make menuconfig

 $ make

 $ sudo make install (optional, will install into /opt per default)

As libpayload is for 32bit x86 systems only, you might have to install the
32bit libgcc version, otherwise your payloads will fail to compile.
On Debian systems you'd do 'apt-get install gcc-multilib' for example.


Usage
-----

Here's an example of a very simple payload (hello.c) and how to build it:

 #include <libpayload.h>

 int main(void)
 {
     printf("Hello, world!\n");
     return 0;
 }

Building the payload using the 'lpgcc' compiler wrapper:

 $ lpgcc -o hello.elf hello.c

Please see the sample/ directory for details.


Website and Mailing List
------------------------

The main website is http://www.coreboot.org/Libpayload.

For additional information, patches, and discussions, please join the
coreboot mailing list at http://coreboot.org/Mailinglist, where most
libpayload developers are subscribed.


Copyright and License
---------------------

See LICENSES.