Merge with git://www.denx.de/git/u-boot.git
[kernel/u-boot.git] / doc / README.generic_usb_ohci
1 Notes on the the generic USB-OHCI driver
2 ========================================
3
4 This driver (drivers/usb_ohci.[ch]) is the result of the merge of
5 various existing OHCI drivers that were basically identical beside
6 cpu/board dependant initalization. This initalization has been moved
7 into cpu/board directories and are called via the hooks below.
8
9 Configuration options
10 ----------------------
11
12 CONFIG_USB_OHCI_NEW: enable the new OHCI driver
13
14 CFG_USB_OHCI_BOARD_INIT: call the board dependant hooks:
15
16   - extern int usb_board_init(void);
17   - extern int usb_board_stop(void);
18   - extern int usb_cpu_init_fail(void);
19
20 CFG_USB_OHCI_CPU_INIT: call the cpu dependant hooks:
21
22   - extern int usb_cpu_init(void);
23   - extern int usb_cpu_stop(void);
24   - extern int usb_cpu_init_fail(void);
25
26 CFG_USB_OHCI_REGS_BASE: defines the base address of the OHCI registers
27
28 CFG_USB_OHCI_SLOT_NAME: slot name
29
30 CFG_USB_OHCI_MAX_ROOT_PORTS: maximal number of ports of the root hub.
31
32
33 Endianness issues
34 ------------------
35
36 The LITTLEENDIAN #define determines if the 'swap_16' and 'swap_32'
37 macros do byte swapping or not. But some cpus OHCI-controllers such as
38 ppc4xx and mpc5xxx operate in little endian mode, so some extra ifdefs
39 were necessary to make this work.
40
41
42
43