blob: aa8911dc4154fe820946cbfe5c6931283583c279 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB HandSpring Visor, Palm m50x, and Sony Clie driver
3 * (supports all of the Palm OS USB devices)
4 *
5 * Copyright (C) 1999 - 2004
6 * Greg Kroah-Hartman (greg@kroah.com)
7 *
Greg Kroah-Hartman4d0dce32007-06-12 11:43:37 -07008 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
Alan Coxd60d4392008-07-22 11:12:15 +010012 * See Documentation/usb/usb-serial.txt for more information on using this
13 * driver
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/kernel.h>
18#include <linux/errno.h>
19#include <linux/init.h>
20#include <linux/slab.h>
21#include <linux/tty.h>
22#include <linux/tty_driver.h>
23#include <linux/tty_flip.h>
24#include <linux/module.h>
25#include <linux/moduleparam.h>
26#include <linux/spinlock.h>
Alan Coxd60d4392008-07-22 11:12:15 +010027#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/usb.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070029#include <linux/usb/serial.h>
Maciej Szmigieroacb52cb2011-02-07 12:42:36 +010030#include <linux/usb/cdc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "visor.h"
32
33/*
34 * Version Information
35 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
37#define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
38
39/* function prototypes for a handspring visor */
Alan Coxa509a7e2009-09-19 13:13:26 -070040static int visor_open(struct tty_struct *tty, struct usb_serial_port *port);
Alan Cox335f8512009-06-11 12:26:29 +010041static void visor_close(struct usb_serial_port *port);
Alan Coxd60d4392008-07-22 11:12:15 +010042static int visor_probe(struct usb_serial *serial,
43 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static int visor_calc_num_ports(struct usb_serial *serial);
Alan Coxd60d4392008-07-22 11:12:15 +010045static void visor_read_int_callback(struct urb *urb);
46static int clie_3_5_startup(struct usb_serial *serial);
47static int treo_attach(struct usb_serial *serial);
48static int clie_5_attach(struct usb_serial *serial);
49static int palm_os_3_probe(struct usb_serial *serial,
50 const struct usb_device_id *id);
51static int palm_os_4_probe(struct usb_serial *serial,
52 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/* Parameters that may be passed into the module. */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103055static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57static struct usb_device_id id_table [] = {
58 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
59 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
60 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
61 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
62 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
63 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Hendrik Schweppe04d52462006-02-19 19:00:04 +010064 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
68 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -070082 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Maximilian Attemsc8ba84a2007-08-04 10:19:41 +0200100 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100102 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100104 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700106 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100108 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
113 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
114 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 { } /* Terminating entry */
117};
118
119static struct usb_device_id clie_id_5_table [] = {
120 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
121 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 { } /* Terminating entry */
123};
124
125static struct usb_device_id clie_id_3_5_table [] = {
126 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
127 { } /* Terminating entry */
128};
129
130static struct usb_device_id id_table_combined [] = {
131 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
132 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
133 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
Hendrik Schweppe04d52462006-02-19 19:00:04 +0100134 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
136 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
137 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
138 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
142 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -0700143 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
146 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
147 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
148 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
149 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
150 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
151 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
152 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
153 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
154 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
155 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700156 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
158 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
159 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
160 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 { } /* Terminating entry */
162};
163
Alan Coxd60d4392008-07-22 11:12:15 +0100164MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166static struct usb_driver visor_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 .name = "visor",
168 .probe = usb_serial_probe,
169 .disconnect = usb_serial_disconnect,
170 .id_table = id_table_combined,
171};
172
Alan Coxd60d4392008-07-22 11:12:15 +0100173/* All of the device info needed for the Handspring Visor,
174 and Palm 4.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700175static struct usb_serial_driver handspring_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700176 .driver = {
177 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700178 .name = "visor",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700179 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700180 .description = "Handspring Visor / Palm OS",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 .id_table = id_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200183 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 .open = visor_open,
185 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200186 .throttle = usb_serial_generic_throttle,
187 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 .attach = treo_attach,
189 .probe = visor_probe,
190 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 .read_int_callback = visor_read_int_callback,
192};
193
194/* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700195static struct usb_serial_driver clie_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700196 .driver = {
197 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700198 .name = "clie_5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700199 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700200 .description = "Sony Clie 5.0",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 .id_table = clie_id_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200203 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 .open = visor_open,
205 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200206 .throttle = usb_serial_generic_throttle,
207 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 .attach = clie_5_attach,
209 .probe = visor_probe,
210 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 .read_int_callback = visor_read_int_callback,
212};
213
214/* device info for the Sony Clie OS version 3.5 */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700215static struct usb_serial_driver clie_3_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700216 .driver = {
217 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700218 .name = "clie_3.5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700219 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700220 .description = "Sony Clie 3.5",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 .id_table = clie_id_3_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 .num_ports = 1,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200223 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 .open = visor_open,
225 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200226 .throttle = usb_serial_generic_throttle,
227 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 .attach = clie_3_5_startup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229};
230
Alan Stern29618e92012-02-23 14:57:32 -0500231static struct usb_serial_driver * const serial_drivers[] = {
232 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
233};
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235/******************************************************************************
236 * Handspring Visor specific driver functions
237 ******************************************************************************/
Alan Coxa509a7e2009-09-19 13:13:26 -0700238static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 int result = 0;
241
Harvey Harrison441b62c2008-03-03 16:08:34 -0800242 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244 if (!port->read_urb) {
245 /* this is needed for some brain dead Sony devices */
246 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
247 return -ENODEV;
248 }
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 /* Start reading from the device */
Johan Hovold214916f2010-05-15 17:53:49 +0200251 result = usb_serial_generic_open(tty, port);
252 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 goto exit;
Alan Coxd60d4392008-07-22 11:12:15 +0100254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 if (port->interrupt_in_urb) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800256 dbg("%s - adding interrupt input for treo", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
258 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100259 dev_err(&port->dev,
260 "%s - failed submitting interrupt urb, error %d\n",
261 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 }
Alan Coxd60d4392008-07-22 11:12:15 +0100263exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 return result;
265}
266
267
Alan Cox335f8512009-06-11 12:26:29 +0100268static void visor_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 unsigned char *transfer_buffer;
271
Harvey Harrison441b62c2008-03-03 16:08:34 -0800272 dbg("%s - port %d", __func__, port->number);
Alan Coxd60d4392008-07-22 11:12:15 +0100273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 /* shutdown our urbs */
Johan Hovold214916f2010-05-15 17:53:49 +0200275 usb_serial_generic_close(port);
Mariusz Kozlowskibcb54a52006-11-08 15:36:55 +0100276 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100278 mutex_lock(&port->serial->disc_mutex);
279 if (!port->serial->disconnected) {
280 /* Try to send shutdown message, unless the device is gone */
Alan Coxd60d4392008-07-22 11:12:15 +0100281 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100282 if (transfer_buffer) {
Alan Coxd60d4392008-07-22 11:12:15 +0100283 usb_control_msg(port->serial->dev,
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100284 usb_rcvctrlpipe(port->serial->dev, 0),
285 VISOR_CLOSE_NOTIFICATION, 0xc2,
286 0x0000, 0x0000,
287 transfer_buffer, 0x12, 300);
Alan Coxd60d4392008-07-22 11:12:15 +0100288 kfree(transfer_buffer);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100289 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 }
Oliver Neukum95bef012008-01-22 13:56:18 +0100291 mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292}
293
Alan Coxd60d4392008-07-22 11:12:15 +0100294static void visor_read_int_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295{
Ming Leicdc97792008-02-24 18:41:47 +0800296 struct usb_serial_port *port = urb->context;
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700297 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 int result;
299
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700300 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 case 0:
302 /* success */
303 break;
304 case -ECONNRESET:
305 case -ENOENT:
306 case -ESHUTDOWN:
307 /* this urb is terminated, clean up */
308 dbg("%s - urb shutting down with status: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800309 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 return;
311 default:
312 dbg("%s - nonzero urb status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800313 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 goto exit;
315 }
316
317 /*
318 * This information is still unknown what it can be used for.
319 * If anyone has an idea, please let the author know...
320 *
321 * Rumor has it this endpoint is used to notify when data
322 * is ready to be read from the bulk ones.
323 */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800324 usb_serial_debug_data(debug, &port->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 urb->actual_length, urb->transfer_buffer);
326
327exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100328 result = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100330 dev_err(&urb->dev->dev,
331 "%s - Error %d submitting interrupt urb\n",
332 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333}
334
Alan Coxd60d4392008-07-22 11:12:15 +0100335static int palm_os_3_probe(struct usb_serial *serial,
336 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
338 struct device *dev = &serial->dev->dev;
339 struct visor_connection_info *connection_info;
340 unsigned char *transfer_buffer;
341 char *string;
342 int retval = 0;
343 int i;
344 int num_ports = 0;
345
Harvey Harrison441b62c2008-03-03 16:08:34 -0800346 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Alan Coxd60d4392008-07-22 11:12:15 +0100348 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800350 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 sizeof(*connection_info));
352 return -ENOMEM;
353 }
354
355 /* send a get connection info request */
Alan Coxd60d4392008-07-22 11:12:15 +0100356 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 usb_rcvctrlpipe(serial->dev, 0),
358 VISOR_GET_CONNECTION_INFORMATION,
359 0xc2, 0x0000, 0x0000, transfer_buffer,
360 sizeof(*connection_info), 300);
361 if (retval < 0) {
362 dev_err(dev, "%s - error %d getting connection information\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800363 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 goto exit;
365 }
366
367 if (retval == sizeof(*connection_info)) {
Alan Coxd60d4392008-07-22 11:12:15 +0100368 connection_info = (struct visor_connection_info *)
369 transfer_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371 num_ports = le16_to_cpu(connection_info->num_ports);
372 for (i = 0; i < num_ports; ++i) {
Alan Coxd60d4392008-07-22 11:12:15 +0100373 switch (
374 connection_info->connections[i].port_function_id) {
375 case VISOR_FUNCTION_GENERIC:
376 string = "Generic";
377 break;
378 case VISOR_FUNCTION_DEBUGGER:
379 string = "Debugger";
380 break;
381 case VISOR_FUNCTION_HOTSYNC:
382 string = "HotSync";
383 break;
384 case VISOR_FUNCTION_CONSOLE:
385 string = "Console";
386 break;
387 case VISOR_FUNCTION_REMOTE_FILE_SYS:
388 string = "Remote File System";
389 break;
390 default:
391 string = "unknown";
392 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 }
394 dev_info(dev, "%s: port %d, is for %s use\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700395 serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 connection_info->connections[i].port, string);
397 }
398 }
399 /*
400 * Handle devices that report invalid stuff here.
401 */
402 if (num_ports == 0 || num_ports > 2) {
Alan Coxd60d4392008-07-22 11:12:15 +0100403 dev_warn(dev, "%s: No valid connect info available\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700404 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 num_ports = 2;
406 }
Alan Coxd60d4392008-07-22 11:12:15 +0100407
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700408 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 num_ports);
410
411 /*
412 * save off our num_ports info so that we can use it in the
413 * calc_num_ports callback
414 */
415 usb_set_serial_data(serial, (void *)(long)num_ports);
416
Alan Coxd60d4392008-07-22 11:12:15 +0100417 /* ask for the number of bytes available, but ignore the
418 response as it is broken */
419 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 usb_rcvctrlpipe(serial->dev, 0),
421 VISOR_REQUEST_BYTES_AVAILABLE,
422 0xc2, 0x0000, 0x0005, transfer_buffer,
423 0x02, 300);
424 if (retval < 0)
425 dev_err(dev, "%s - error %d getting bytes available request\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800426 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 retval = 0;
428
429exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100430 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 return retval;
433}
434
Alan Coxd60d4392008-07-22 11:12:15 +0100435static int palm_os_4_probe(struct usb_serial *serial,
436 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
438 struct device *dev = &serial->dev->dev;
439 struct palm_ext_connection_info *connection_info;
440 unsigned char *transfer_buffer;
441 int retval;
442
Harvey Harrison441b62c2008-03-03 16:08:34 -0800443 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Alan Coxd60d4392008-07-22 11:12:15 +0100445 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800447 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 sizeof(*connection_info));
449 return -ENOMEM;
450 }
451
Alan Coxd60d4392008-07-22 11:12:15 +0100452 retval = usb_control_msg(serial->dev,
453 usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 PALM_GET_EXT_CONNECTION_INFORMATION,
455 0xc2, 0x0000, 0x0000, transfer_buffer,
Alan Coxd60d4392008-07-22 11:12:15 +0100456 sizeof(*connection_info), 300);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 if (retval < 0)
458 dev_err(dev, "%s - error %d getting connection info\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800459 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 else
Harvey Harrison441b62c2008-03-03 16:08:34 -0800461 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 retval, transfer_buffer);
463
Alan Coxd60d4392008-07-22 11:12:15 +0100464 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return 0;
466}
467
468
Alan Coxd60d4392008-07-22 11:12:15 +0100469static int visor_probe(struct usb_serial *serial,
470 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471{
472 int retval = 0;
Alan Coxd60d4392008-07-22 11:12:15 +0100473 int (*startup)(struct usb_serial *serial,
474 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Harvey Harrison441b62c2008-03-03 16:08:34 -0800476 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Maciej Szmigieroacb52cb2011-02-07 12:42:36 +0100478 /*
479 * some Samsung Android phones in modem mode have the same ID
480 * as SPH-I500, but they are ACM devices, so dont bind to them
481 */
482 if (id->idVendor == SAMSUNG_VENDOR_ID &&
483 id->idProduct == SAMSUNG_SPH_I500_ID &&
484 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
485 serial->dev->descriptor.bDeviceSubClass ==
486 USB_CDC_SUBCLASS_ACM)
487 return -ENODEV;
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700490 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 serial->dev->actconfig->desc.bConfigurationValue);
492 return -ENODEV;
493 }
494
495 if (id->driver_info) {
496 startup = (void *)id->driver_info;
497 retval = startup(serial, id);
498 }
499
500 return retval;
501}
502
Alan Coxd60d4392008-07-22 11:12:15 +0100503static int visor_calc_num_ports(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 int num_ports = (int)(long)(usb_get_serial_data(serial));
506
507 if (num_ports)
508 usb_set_serial_data(serial, NULL);
509
510 return num_ports;
511}
512
Alan Coxd60d4392008-07-22 11:12:15 +0100513static int clie_3_5_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514{
515 struct device *dev = &serial->dev->dev;
516 int result;
Johan Hovold401711c2009-12-28 23:01:57 +0100517 u8 *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Harvey Harrison441b62c2008-03-03 16:08:34 -0800519 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Johan Hovold401711c2009-12-28 23:01:57 +0100521 data = kmalloc(1, GFP_KERNEL);
522 if (!data)
523 return -ENOMEM;
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 /*
526 * Note that PEG-300 series devices expect the following two calls.
527 */
528
529 /* get the config number */
Alan Coxd60d4392008-07-22 11:12:15 +0100530 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
Johan Hovold401711c2009-12-28 23:01:57 +0100532 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100534 dev_err(dev, "%s: get config number failed: %d\n",
535 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100536 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
538 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100539 dev_err(dev, "%s: get config number bad return length: %d\n",
540 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100541 result = -EIO;
542 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 }
544
545 /* get the interface number */
Alan Coxd60d4392008-07-22 11:12:15 +0100546 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
547 USB_REQ_GET_INTERFACE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 USB_DIR_IN | USB_RECIP_INTERFACE,
Johan Hovold401711c2009-12-28 23:01:57 +0100549 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100551 dev_err(dev, "%s: get interface number failed: %d\n",
552 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100553 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100556 dev_err(dev,
557 "%s: get interface number bad return length: %d\n",
558 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100559 result = -EIO;
560 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 }
562
Johan Hovold214916f2010-05-15 17:53:49 +0200563 result = 0;
Johan Hovold401711c2009-12-28 23:01:57 +0100564out:
565 kfree(data);
566
567 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
Alan Coxd60d4392008-07-22 11:12:15 +0100569
570static int treo_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571{
572 struct usb_serial_port *swap_port;
573
574 /* Only do this endpoint hack for the Handspring devices with
575 * interrupt in endpoints, which for now are the Treo devices. */
Alan Coxd60d4392008-07-22 11:12:15 +0100576 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
577 == HANDSPRING_VENDOR_ID) ||
578 (le16_to_cpu(serial->dev->descriptor.idVendor)
579 == KYOCERA_VENDOR_ID)) ||
580 (serial->num_interrupt_in == 0))
Johan Hovold214916f2010-05-15 17:53:49 +0200581 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Harvey Harrison441b62c2008-03-03 16:08:34 -0800583 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
585 /*
Alan Coxd60d4392008-07-22 11:12:15 +0100586 * It appears that Treos and Kyoceras want to use the
587 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
588 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
589 * Note that swapping the bulk out endpoints would break lots of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 * apps that want to communicate on the second port.
591 */
592#define COPY_PORT(dest, src) \
Alan Coxd60d4392008-07-22 11:12:15 +0100593 do { \
594 dest->read_urb = src->read_urb; \
595 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
596 dest->bulk_in_buffer = src->bulk_in_buffer; \
597 dest->interrupt_in_urb = src->interrupt_in_urb; \
598 dest->interrupt_in_endpointAddress = \
599 src->interrupt_in_endpointAddress;\
600 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
601 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
604 if (!swap_port)
605 return -ENOMEM;
606 COPY_PORT(swap_port, serial->port[0]);
607 COPY_PORT(serial->port[0], serial->port[1]);
608 COPY_PORT(serial->port[1], swap_port);
609 kfree(swap_port);
610
Johan Hovold214916f2010-05-15 17:53:49 +0200611 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
613
Alan Coxd60d4392008-07-22 11:12:15 +0100614static int clie_5_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615{
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200616 struct usb_serial_port *port;
617 unsigned int pipe;
618 int j;
619
Harvey Harrison441b62c2008-03-03 16:08:34 -0800620 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Alan Coxd60d4392008-07-22 11:12:15 +0100622 /* TH55 registers 2 ports.
623 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
624 from port 0. Communication out to the UX50/TH55 uses
625 bulk_out_endpointAddress from port 1
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 Lets do a quick and dirty mapping
628 */
Alan Coxd60d4392008-07-22 11:12:15 +0100629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 /* some sanity check */
631 if (serial->num_ports < 2)
632 return -1;
Alan Coxd60d4392008-07-22 11:12:15 +0100633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 /* port 0 now uses the modified endpoint Address */
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200635 port = serial->port[0];
636 port->bulk_out_endpointAddress =
Alan Coxd60d4392008-07-22 11:12:15 +0100637 serial->port[1]->bulk_out_endpointAddress;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200639 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
640 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
641 port->write_urbs[j]->pipe = pipe;
642
Johan Hovold214916f2010-05-15 17:53:49 +0200643 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644}
645
Greg Kroah-Hartman0bf4da32012-04-19 15:15:43 -0700646module_usb_serial_driver(visor_driver, serial_drivers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Alan Coxd60d4392008-07-22 11:12:15 +0100648MODULE_AUTHOR(DRIVER_AUTHOR);
649MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650MODULE_LICENSE("GPL");
651
652module_param(debug, bool, S_IRUGO | S_IWUSR);
653MODULE_PARM_DESC(debug, "Debug enabled or not");