temp revert rk change
[firefly-linux-kernel-4.4.55.git] / drivers / net / usb / qcusbnet / README
1 Gobi2000 network driver for HP 1.0.110
2 06/18/2010
3
4 This readme covers important information concerning
5 the QCUSBNet2kHP driver, provided in correlation with
6 the Gobi2000-Linux-Package.
7
8 Table of Contents
9
10 1. Prerequisites
11 2. Installation instructions
12 3. What's new in this release
13 4. Notes
14 5. Known issues
15
16 -------------------------------------------------------------------------------
17
18 1. PREREQUISITES
19
20 a. Kernel headers or full kernel source installed for the currently
21    running kernel.  There must be a link "/lib/modules/<uname -r>/build"
22    that points to these kernel headers or sources.
23 b. The kernel must support the usbcore and usbnet drivers, either as
24    modules or built into the kernel.
25 c. Tools required for building the kernel.  These tools usually come in a
26    package called "kernel-devel".
27 d. "gcc" compiler
28 e. "make" tool
29
30 -------------------------------------------------------------------------------
31
32 2. INSTALLATION INSTRUCTIONS
33
34 a. Navigate to the folder "QCUSBNet2k" that contains:
35       Makefile
36       QCUSBNetHP.c
37       QMIDevice.c
38       qmidevice.h
39       structs.h
40       QMI.c
41       qmi.h
42 b. (only required for kernels prior to 2.6.25) Create a symbolic link
43    to the usbnet.h file in your kernel sources:
44       ln -s <linux sources>/drivers/net/usb/usbnet.h ./
45 c. Run the command:
46       make
47 d. Copy the newly created QCUSBNet2kHP.ko into the directory
48    /lib/modules/`uname -r`/kernel/drivers/net/usb/
49 e. Run the command:
50       depmod
51 f. (Optional) Load the driver manually with the command:
52       modprobe QCUSBNet2kHP
53    - This is only required the first time after you install the
54      drivers.  If you restart or plug the Gobi device in the drivers
55      will be automatically loaded.
56
57 -------------------------------------------------------------------------------
58
59 3. WHAT'S NEW
60
61 This Release (Gobi2000 network driver for HP 1.0.110) 06/18/2010
62 a. Correctly initialize semaphore during probe function.
63
64 Prior Release (Gobi2000 network driver for HP 1.0.100) 06/02/2010
65 a. Merge QCQMI driver into QCUSBNet2k driver, removing dependency.
66
67 Prior Release (Gobi2000 network driver for HP 1.0.90) 05/13/2010
68 a. Fix devqmi_close() from a thread
69 b. Add 2.6.33 kernel support
70
71 Prior Release (Gobi2000 network driver for HP 1.0.80) 04/19/2010
72 a. Add support to check for duplicate or out of sequence QMI messages.
73
74 Prior Release (Gobi2000 network driver for HP 1.0.70) 03/15/2010
75 a. Added support for CDC CONNECTION_SPEED_CHANGE indication.
76 b. Modified device cleanup function to better handle the device
77    losing power during suspend or hibernate.
78 c. Replaced autosuspend feature with more aggressive "Selective suspend"
79    style power management.  Even if QCWWAN2k or Network connections are
80    active the device will still enter autosuspend after the delay time,
81    and wake on remote wakeup or new data being sent.
82
83 Prior Release (Gobi2000 Serial driver for HP 1.0.60) 02/16/2010
84 a. Fix to allow proper fork() functionality
85 b. Add supports_autosuspend flag
86 c. Ignore EOVERFLOW errors on interrupt endpoint and resubmit URB
87 d. Change driver versions to match installer package
88 e. Minor update for 2.6.23 kernel compatibility
89
90 Prior Release (in correlation with Gobi2000-Linux-Package 1.0.30) 12/04/2009
91 a. Modify ioctl numbering to avoid conflict in 2.6.31 kernel
92    This release is only compatible with GOBI2000_LINUX_SDK 1.0.30 and newer.
93 b. Made minor compatibility changes for 2.6.31 kernel
94
95 Prior Release (in correlation with Gobi2000-Linux-Package 1.0.20) 11/20/2009
96 a. Initial release
97
98 -------------------------------------------------------------------------------
99
100 4. NOTES
101
102 a. In Composite mode, the Gobi device will enumerate a network interface
103    usb<#> where <#> signifies the next available USB network interface.
104 b. In Composite mode, the Gobi device will enumerate a device node
105    /dev/qcqmi<#>.  This device node is for use by the QCWWANCMAPI2k.
106 c. Ownership, group, and permissions are managed by your system
107    configuration.
108
109 -------------------------------------------------------------------------------
110
111 5. KNOWN ISSUES
112
113 No known issues.
114
115 -------------------------------------------------------------------------------