Files
ipxe/src/config/config_usb.c
Michael Brown c69f9589cc [usb] Expose USB device descriptor and strings via settings
Allow scripts to read basic information from USB device descriptors
via the settings mechanism.  For example:

  echo USB vendor ID: ${usb/${busloc}.8.2}
  echo USB device ID: ${usb/${busloc}.10.2}
  echo USB manufacturer name: ${usb/${busloc}.14.0}

The general syntax is

  usb/<bus:dev>.<offset>.<length>

where bus:dev is the USB bus:device address (as obtained via the
"usbscan" command, or from e.g. ${net0/busloc} for a USB network
device), and <offset> and <length> select the required portion of the
USB device descriptor.

Following the usage of SMBIOS settings tags, a <length> of zero may be
used to indicate that the byte at <offset> contains a USB string
descriptor index, and an <offset> of zero may be used to indicate that
the <length> contains a literal USB string descriptor index.

Since the byte at offset zero can never contain a string index, and a
literal string index can never be zero, the combination of both
<length> and <offset> being zero may be used to indicate that the
entire device descriptor is to be read as a raw hex dump.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2024-10-18 13:13:51 +01:00

74 lines
1.7 KiB
C

/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*
* You can also choose to distribute this program under the terms of
* the Unmodified Binary Distribution Licence (as given in the file
* COPYING.UBDL), provided that you have satisfied its requirements.
*/
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#include <config/usb.h>
#include <config/settings.h>
/** @file
*
* USB configuration options
*
*/
PROVIDE_REQUIRING_SYMBOL();
/*
* Drag in USB controllers
*/
#ifdef USB_HCD_XHCI
REQUIRE_OBJECT ( xhci );
#endif
#ifdef USB_HCD_EHCI
REQUIRE_OBJECT ( ehci );
#endif
#ifdef USB_HCD_UHCI
REQUIRE_OBJECT ( uhci );
#endif
#ifdef USB_HCD_USBIO
REQUIRE_OBJECT ( usbio );
#endif
/*
* Drag in USB peripherals
*/
#ifdef USB_KEYBOARD
REQUIRE_OBJECT ( usbkbd );
#endif
#ifdef USB_BLOCK
REQUIRE_OBJECT ( usbblk );
#endif
/*
* Drag in USB external interfaces
*/
#ifdef USB_EFI
REQUIRE_OBJECT ( efi_usb );
#endif
/*
* Drag in USB settings mechanism
*/
#ifdef USB_SETTINGS
REQUIRE_OBJECT ( usb_settings );
#endif