README.usb 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. /*
  2. * (C) Copyright 2001
  3. * Denis Peter, MPL AG Switzerland
  4. *
  5. * See file CREDITS for list of people who contributed to this
  6. * project.
  7. *
  8. * This program is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU General Public License as
  10. * published by the Free Software Foundation; either version 2 of
  11. * the License, or (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21. * MA 02111-1307 USA
  22. *
  23. */
  24. USB Support for PIP405 and MIP405 (UHCI)
  25. ========================================
  26. The USB support is implemented on the base of the UHCI Host
  27. controller.
  28. Currently supported are USB Hubs, USB Keyboards, USB Floppys, USB
  29. flash sticks and USB network adaptors.
  30. Tested with a TEAC Floppy TEAC FD-05PUB and Chicony KU-8933 Keyboard.
  31. How it works:
  32. -------------
  33. The USB (at least the USB UHCI) needs a frame list (4k), transfer
  34. descripor and queue headers which are all located in the main memory.
  35. The UHCI allocates every milisecond the PCI bus and reads the current
  36. frame pointer. This may cause to crash the OS during boot. So the USB
  37. _MUST_ be stopped during OS boot. This is the reason, why the USB is
  38. NOT automatically started during start-up. If someone needs the USB
  39. he has to start it and should therefore be aware that he had to stop
  40. it before booting the OS.
  41. For USB keyboards this can be done by a script which is automatically
  42. started after the U-Boot is up and running. To boot an OS with a an
  43. USB keyboard another script is necessary, which first disables the
  44. USB and then executes the boot command. If the boot command fails,
  45. the script can reenable the USB kbd.
  46. Common USB Commands:
  47. - usb start:
  48. - usb reset: (re)starts the USB. All USB devices will be
  49. initialized and a device tree is build for them.
  50. - usb tree: shows all USB devices in a tree like display
  51. - usb info [dev]: shows all USB infos of the device dev, or of all
  52. the devices
  53. - usb stop [f]: stops the USB. If f==1 the USB will also stop if
  54. an USB keyboard is assigned as stdin. The stdin
  55. is then switched to serial input.
  56. Storage USB Commands:
  57. - usb scan: scans the USB for storage devices.The USB must be
  58. running for this command (usb start)
  59. - usb device [dev]: show or set current USB staorage device
  60. - usb part [dev]: print partition table of one or all USB storage
  61. devices
  62. - usb read addr blk# cnt:
  63. read `cnt' blocks starting at block `blk#'to
  64. memory address `addr'
  65. - usbboot addr dev:part:
  66. boot from USB device
  67. Config Switches:
  68. ----------------
  69. CONFIG_CMD_USB enables basic USB support and the usb command
  70. CONFIG_USB_UHCI defines the lowlevel part.A lowlevel part must be defined
  71. if using CONFIG_CMD_USB
  72. CONFIG_USB_KEYBOARD enables the USB Keyboard
  73. CONFIG_USB_STORAGE enables the USB storage devices
  74. CONFIG_USB_HOST_ETHER enables USB ethernet adapter support
  75. USB Host Networking
  76. ===================
  77. If you have a supported USB Ethernet adapter you can use it in U-Boot
  78. to obtain an IP address and load a kernel from a network server.
  79. Note: USB Host Networking is not the same as making your board act as a USB
  80. client. In that case your board is pretending to be an Ethernet adapter
  81. and will appear as a network interface to an attached computer. In that
  82. case the connection is via a USB cable with the computer acting as the host.
  83. With USB Host Networking, your board is the USB host. It controls the
  84. Ethernet adapter to which it is directly connected and the connection to
  85. the outside world is your adapter's Ethernet cable. Your board becomes an
  86. independent network device, able to connect and perform network operations
  87. independently of your computer.
  88. Device support
  89. --------------
  90. Currently supported devices are listed in the drivers according to
  91. their vendor and product IDs. You can check your device by connecting it
  92. to a Linux machine and typing 'lsusb'. The drivers are in
  93. drivers/usb/eth.
  94. For example this lsusb output line shows a device with Vendor ID 0x0x95
  95. and product ID 0x7720:
  96. Bus 002 Device 010: ID 0b95:7720 ASIX Electronics Corp. AX88772
  97. If you look at drivers/usb/eth/asix.c you will see this line within the
  98. supported device list, so we know this adapter is supported.
  99. { 0x0b95, 0x7720 }, /* Trendnet TU2-ET100 V3.0R */
  100. If your adapter is not listed there is a still a chance that it will
  101. work. Try looking up the manufacturer of the chip inside your adapter.
  102. or take the adapter apart and look for chip markings. Then add a line
  103. for your vendor/product ID into the table of the appropriate driver,
  104. build U-Boot and see if it works. If not then there might be differences
  105. between the chip in your adapter and the driver. You could try to get a
  106. datasheet for your device and add support for it to U-Boot. This is not
  107. particularly difficult - you only need to provide support for four basic
  108. functions: init, halt, send and recv.
  109. Enabling USB Host Networking
  110. ----------------------------
  111. The normal U-Boot commands are used with USB networking, but you must
  112. start USB first. For example:
  113. usb start
  114. setenv bootfile /tftpboot/uImage
  115. bootp
  116. To enable USB Host Ethernet in U-Boot, your platform must of course
  117. support USB with CONFIG_CMD_USB enabled and working. You will need to
  118. add some config settings to your board header file:
  119. #define CONFIG_USB_HOST_ETHER /* Enable USB Ethernet adapters */
  120. #define CONFIG_USB_ETHER_ASIX /* Asix, or whatever driver(s) you want */
  121. As with built-in networking, you will also want to enable some network
  122. commands, for example:
  123. #define CONFIG_CMD_NET
  124. #define CONFIG_NET_MULTI
  125. #define CONFIG_CMD_PING
  126. #define CONFIG_CMD_DHCP
  127. and some bootp options, which tell your board to obtain its subnet,
  128. gateway IP, host name and boot path from the bootp/dhcp server. These
  129. settings should start you off:
  130. #define CONFIG_BOOTP_SUBNETMASK
  131. #define CONFIG_BOOTP_GATEWAY
  132. #define CONFIG_BOOTP_HOSTNAME
  133. #define CONFIG_BOOTP_BOOTPATH
  134. You can also set the default IP address of your board and the server
  135. as well as the default file to load when a 'bootp' command is issued.
  136. All of these can be obtained from the bootp server if not set.
  137. #define CONFIG_IPADDR 10.0.0.2 (replace with your value)
  138. #define CONFIG_SERVERIP 10.0.0.1 (replace with your value)
  139. #define CONFIG_BOOTFILE uImage
  140. The 'usb start' command should identify the adapter something like this:
  141. CrOS> usb start
  142. (Re)start USB...
  143. USB EHCI 1.00
  144. scanning bus for devices... 3 USB Device(s) found
  145. scanning bus for storage devices... 0 Storage Device(s) found
  146. scanning bus for ethernet devices... 1 Ethernet Device(s) found
  147. CrOS> print ethact
  148. ethact=asx0
  149. You can see that it found an ethernet device and we can print out the
  150. device name (asx0 in this case).
  151. Then 'bootp' or 'dhcp' should use it to obtain an IP address from DHCP,
  152. perhaps something like this:
  153. CrOS> bootp
  154. Waiting for Ethernet connection... done.
  155. BOOTP broadcast 1
  156. BOOTP broadcast 2
  157. DHCP client bound to address 172.22.73.81
  158. Using asx0 device
  159. TFTP from server 172.22.72.144; our IP address is 172.22.73.81
  160. Filename '/tftpboot/uImage-sjg-seaboard-261347'.
  161. Load address: 0x40c000
  162. Loading: #################################################################
  163. #################################################################
  164. #################################################################
  165. ################################################
  166. done
  167. Bytes transferred = 3557464 (364858 hex)
  168. CrOS>
  169. Another way of doing this is to issue a tftp command, which will cause the
  170. bootp to happen automatically.
  171. MAC Addresses
  172. -------------
  173. Most Ethernet dongles have a built-in MAC address which is unique in the
  174. world. This is important so that devices on the network can be
  175. distinguised from each other. MAC address conflicts are evil and
  176. generally result in strange and eratic behaviour.
  177. Some boards have USB Ethernet chips on-board, and these sometimes do not
  178. have an assigned MAC address. In this case it is up to you to assign
  179. one which is unique. You should obtain a valid MAC address from a range
  180. assigned to you before you ship the product.
  181. Built-in Ethernet adapters support setting the MAC address by means of
  182. an ethaddr environment variable for each interface (ethaddr, eth1addr,
  183. eth2addr). There is similar support on the USB network side, using the
  184. names usbethaddr, usbeth1addr, etc. They are kept separate since we
  185. don't want a USB device taking the MAC address of a built-in device or
  186. vice versa.
  187. So if your USB Ethernet chip doesn't have a MAC address available then
  188. you must set usbethaddr to a suitable MAC address. At the time of
  189. writing this functionality is only supported by the SMSC driver.