Merge tag 'u-boot-stm32-20200528' of https://gitlab.denx.de/u-boot/custodians/u-boot-stm

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

diff --git a/doc/README.usb b/doc/README.usb
index a8a4058de122d6c068d9cb91b218bdc89919c0b8..05c62c3413c5d827aabe867b715d7080e059bef7 100644 (file)
--- a/doc/README.usb
+++ b/doc/README.usb
@@ -1,29 +1,11 @@
+SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2001
  * Denis Peter, MPL AG Switzerland
- *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * 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., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
- *
  */
 
-USB Support for PIP405 and MIP405 (UHCI)
-========================================
+USB Support
+===========
 
 The USB support is implemented on the base of the UHCI Host
 controller.
@@ -63,7 +45,7 @@ Common USB Commands:
 Storage USB Commands:
 - usb scan:        scans the USB for storage devices.The USB must be
                    running for this command (usb start)
-- usb device [dev]: show or set current USB staorage device
+- usb device [dev]: show or set current USB storage device
 - usb part [dev]:   print partition table of one or all USB storage
                    devices
 - usb read addr blk# cnt:
@@ -116,7 +98,7 @@ Bus 002 Device 010: ID 0b95:7720 ASIX Electronics Corp. AX88772
 If you look at drivers/usb/eth/asix.c you will see this line within the
 supported device list, so we know this adapter is supported.
 
-        { 0x0b95, 0x7720 },     /* Trendnet TU2-ET100 V3.0R */
+       { 0x0b95, 0x7720 },     /* Trendnet TU2-ET100 V3.0R */
 
 If your adapter is not listed there is a still a chance that it will
 work. Try looking up the manufacturer of the chip inside your adapter.
@@ -142,18 +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_NET_MULTI
-#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
@@ -166,11 +157,14 @@ 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)
-#define CONFIG_BOOTFILE         uImage
+#define CONFIG_IPADDR          10.0.0.2  (replace with your value)
+#define CONFIG_SERVERIP                10.0.0.1  (replace with your value)
+#define CONFIG_BOOTFILE                "uImage"
 
 
 The 'usb start' command should identify the adapter something like this:
@@ -200,9 +194,9 @@ TFTP from server 172.22.72.144; our IP address is 172.22.73.81
 Filename '/tftpboot/uImage-sjg-seaboard-261347'.
 Load address: 0x40c000
 Loading: #################################################################
-         #################################################################
-         #################################################################
-         ################################################
+        #################################################################
+        #################################################################
+        ################################################
 done
 Bytes transferred = 3557464 (364858 hex)
 CrOS>