Merge https://gitlab.denx.de/u-boot/custodians/u-boot-fsl-qoriq

[oweals/u-boot.git] / doc / README.usb

diff --git a/doc/README.usb b/doc/README.usb
index 65fb2886d9585b5ff69362650aa837bd3fa618a8..05c62c3413c5d827aabe867b715d7080e059bef7 100644 (file)
--- a/doc/README.usb
+++ b/doc/README.usb
@@ -1,12 +1,11 @@
+SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2001
  * Denis Peter, MPL AG Switzerland
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
-USB Support for PIP405 and MIP405 (UHCI)
-========================================
+USB Support
+===========
 
 The USB support is implemented on the base of the UHCI Host
 controller.
@@ -125,17 +124,27 @@ bootp
 
 To enable USB Host Ethernet in U-Boot, your platform must of course
 support USB with CONFIG_CMD_USB enabled and working. You will need to
-add some config settings to your board header file:
+add some config settings to your board config:
 
-#define CONFIG_USB_HOST_ETHER  /* Enable USB Ethernet adapters */
-#define CONFIG_USB_ETHER_ASIX  /* Asix, or whatever driver(s) you want */
+CONFIG_CMD_USB=y               /* the 'usb' interactive command */
+CONFIG_USB_HOST_ETHER=y                /* Enable USB Ethernet adapters */
+
+and one or more of the following for individual adapter hardware:
+
+CONFIG_USB_ETHER_ASIX=y
+CONFIG_USB_ETHER_ASIX88179=y
+CONFIG_USB_ETHER_LAN75XX=y
+CONFIG_USB_ETHER_LAN78XX=y
+CONFIG_USB_ETHER_MCS7830=y
+CONFIG_USB_ETHER_RTL8152=y
+CONFIG_USB_ETHER_SMSC95XX=y
 
 As with built-in networking, you will also want to enable some network
 commands, for example:
 
-#define CONFIG_CMD_NET
-#define CONFIG_CMD_PING
-#define CONFIG_CMD_DHCP
+CONFIG_CMD_NET=y
+CONFIG_CMD_PING=y
+CONFIG_CMD_DHCP=y
 
 and some bootp options, which tell your board to obtain its subnet,
 gateway IP, host name and boot path from the bootp/dhcp server. These
@@ -148,7 +157,10 @@ settings should start you off:
 
 You can also set the default IP address of your board and the server
 as well as the default file to load when a 'bootp' command is issued.
-All of these can be obtained from the bootp server if not set.
+However note that encoding these individual network settings into a
+common exectuable is discouraged, as it leads to potential conflicts,
+and all the parameters can either get stored in the board's external
+environment, or get obtained from the bootp server if not set.
 
 #define CONFIG_IPADDR          10.0.0.2  (replace with your value)
 #define CONFIG_SERVERIP                10.0.0.1  (replace with your value)