blob: 71d696474f24d500ecd59af248a1e7f6e4dd0282 [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 -070056static __u16 vendor;
57static __u16 product;
58
59static struct usb_device_id id_table [] = {
60 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
61 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
62 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
63 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
64 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Hendrik Schweppe04d52462006-02-19 19:00:04 +010066 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
82 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -070084 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Maximilian Attemsc8ba84a2007-08-04 10:19:41 +0200102 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100104 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100106 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700108 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100110 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
113 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
114 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
116 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
117 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
118 { }, /* optional parameter entry */
119 { } /* Terminating entry */
120};
121
122static struct usb_device_id clie_id_5_table [] = {
123 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
124 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
125 { }, /* optional parameter entry */
126 { } /* Terminating entry */
127};
128
129static struct usb_device_id clie_id_3_5_table [] = {
130 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
131 { } /* Terminating entry */
132};
133
134static struct usb_device_id id_table_combined [] = {
135 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
136 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
137 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
Hendrik Schweppe04d52462006-02-19 19:00:04 +0100138 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
142 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
143 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
144 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
145 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
146 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -0700147 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
150 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
151 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
152 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
153 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
154 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
155 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
156 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
157 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
158 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
159 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700160 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
162 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
163 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
164 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
165 { }, /* optional parameter entry */
166 { } /* Terminating entry */
167};
168
Alan Coxd60d4392008-07-22 11:12:15 +0100169MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171static struct usb_driver visor_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 .name = "visor",
173 .probe = usb_serial_probe,
174 .disconnect = usb_serial_disconnect,
175 .id_table = id_table_combined,
176};
177
Alan Coxd60d4392008-07-22 11:12:15 +0100178/* All of the device info needed for the Handspring Visor,
179 and Palm 4.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700180static struct usb_serial_driver handspring_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700181 .driver = {
182 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700183 .name = "visor",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700184 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700185 .description = "Handspring Visor / Palm OS",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 .id_table = id_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200188 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 .open = visor_open,
190 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200191 .throttle = usb_serial_generic_throttle,
192 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 .attach = treo_attach,
194 .probe = visor_probe,
195 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 .read_int_callback = visor_read_int_callback,
197};
198
199/* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700200static struct usb_serial_driver clie_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700201 .driver = {
202 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700203 .name = "clie_5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700204 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700205 .description = "Sony Clie 5.0",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 .id_table = clie_id_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200208 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 .open = visor_open,
210 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200211 .throttle = usb_serial_generic_throttle,
212 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 .attach = clie_5_attach,
214 .probe = visor_probe,
215 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 .read_int_callback = visor_read_int_callback,
217};
218
219/* device info for the Sony Clie OS version 3.5 */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700220static struct usb_serial_driver clie_3_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700221 .driver = {
222 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700223 .name = "clie_3.5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700224 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700225 .description = "Sony Clie 3.5",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 .id_table = clie_id_3_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 .num_ports = 1,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200228 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 .open = visor_open,
230 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200231 .throttle = usb_serial_generic_throttle,
232 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 .attach = clie_3_5_startup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234};
235
Alan Stern29618e92012-02-23 14:57:32 -0500236static struct usb_serial_driver * const serial_drivers[] = {
237 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
238};
239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240/******************************************************************************
241 * Handspring Visor specific driver functions
242 ******************************************************************************/
Alan Coxa509a7e2009-09-19 13:13:26 -0700243static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 int result = 0;
246
Harvey Harrison441b62c2008-03-03 16:08:34 -0800247 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 if (!port->read_urb) {
250 /* this is needed for some brain dead Sony devices */
251 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
252 return -ENODEV;
253 }
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 /* Start reading from the device */
Johan Hovold214916f2010-05-15 17:53:49 +0200256 result = usb_serial_generic_open(tty, port);
257 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 goto exit;
Alan Coxd60d4392008-07-22 11:12:15 +0100259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 if (port->interrupt_in_urb) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800261 dbg("%s - adding interrupt input for treo", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
263 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100264 dev_err(&port->dev,
265 "%s - failed submitting interrupt urb, error %d\n",
266 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 }
Alan Coxd60d4392008-07-22 11:12:15 +0100268exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 return result;
270}
271
272
Alan Cox335f8512009-06-11 12:26:29 +0100273static void visor_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 unsigned char *transfer_buffer;
276
Harvey Harrison441b62c2008-03-03 16:08:34 -0800277 dbg("%s - port %d", __func__, port->number);
Alan Coxd60d4392008-07-22 11:12:15 +0100278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 /* shutdown our urbs */
Johan Hovold214916f2010-05-15 17:53:49 +0200280 usb_serial_generic_close(port);
Mariusz Kozlowskibcb54a52006-11-08 15:36:55 +0100281 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100283 mutex_lock(&port->serial->disc_mutex);
284 if (!port->serial->disconnected) {
285 /* Try to send shutdown message, unless the device is gone */
Alan Coxd60d4392008-07-22 11:12:15 +0100286 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100287 if (transfer_buffer) {
Alan Coxd60d4392008-07-22 11:12:15 +0100288 usb_control_msg(port->serial->dev,
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100289 usb_rcvctrlpipe(port->serial->dev, 0),
290 VISOR_CLOSE_NOTIFICATION, 0xc2,
291 0x0000, 0x0000,
292 transfer_buffer, 0x12, 300);
Alan Coxd60d4392008-07-22 11:12:15 +0100293 kfree(transfer_buffer);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100294 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 }
Oliver Neukum95bef012008-01-22 13:56:18 +0100296 mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297}
298
Alan Coxd60d4392008-07-22 11:12:15 +0100299static void visor_read_int_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Ming Leicdc97792008-02-24 18:41:47 +0800301 struct usb_serial_port *port = urb->context;
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700302 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 int result;
304
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700305 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 case 0:
307 /* success */
308 break;
309 case -ECONNRESET:
310 case -ENOENT:
311 case -ESHUTDOWN:
312 /* this urb is terminated, clean up */
313 dbg("%s - urb shutting down with status: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800314 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return;
316 default:
317 dbg("%s - nonzero urb status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800318 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 goto exit;
320 }
321
322 /*
323 * This information is still unknown what it can be used for.
324 * If anyone has an idea, please let the author know...
325 *
326 * Rumor has it this endpoint is used to notify when data
327 * is ready to be read from the bulk ones.
328 */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800329 usb_serial_debug_data(debug, &port->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 urb->actual_length, urb->transfer_buffer);
331
332exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100333 result = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100335 dev_err(&urb->dev->dev,
336 "%s - Error %d submitting interrupt urb\n",
337 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338}
339
Alan Coxd60d4392008-07-22 11:12:15 +0100340static int palm_os_3_probe(struct usb_serial *serial,
341 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
343 struct device *dev = &serial->dev->dev;
344 struct visor_connection_info *connection_info;
345 unsigned char *transfer_buffer;
346 char *string;
347 int retval = 0;
348 int i;
349 int num_ports = 0;
350
Harvey Harrison441b62c2008-03-03 16:08:34 -0800351 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Alan Coxd60d4392008-07-22 11:12:15 +0100353 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800355 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 sizeof(*connection_info));
357 return -ENOMEM;
358 }
359
360 /* send a get connection info request */
Alan Coxd60d4392008-07-22 11:12:15 +0100361 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 usb_rcvctrlpipe(serial->dev, 0),
363 VISOR_GET_CONNECTION_INFORMATION,
364 0xc2, 0x0000, 0x0000, transfer_buffer,
365 sizeof(*connection_info), 300);
366 if (retval < 0) {
367 dev_err(dev, "%s - error %d getting connection information\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800368 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 goto exit;
370 }
371
372 if (retval == sizeof(*connection_info)) {
Alan Coxd60d4392008-07-22 11:12:15 +0100373 connection_info = (struct visor_connection_info *)
374 transfer_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 num_ports = le16_to_cpu(connection_info->num_ports);
377 for (i = 0; i < num_ports; ++i) {
Alan Coxd60d4392008-07-22 11:12:15 +0100378 switch (
379 connection_info->connections[i].port_function_id) {
380 case VISOR_FUNCTION_GENERIC:
381 string = "Generic";
382 break;
383 case VISOR_FUNCTION_DEBUGGER:
384 string = "Debugger";
385 break;
386 case VISOR_FUNCTION_HOTSYNC:
387 string = "HotSync";
388 break;
389 case VISOR_FUNCTION_CONSOLE:
390 string = "Console";
391 break;
392 case VISOR_FUNCTION_REMOTE_FILE_SYS:
393 string = "Remote File System";
394 break;
395 default:
396 string = "unknown";
397 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 }
399 dev_info(dev, "%s: port %d, is for %s use\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700400 serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 connection_info->connections[i].port, string);
402 }
403 }
404 /*
405 * Handle devices that report invalid stuff here.
406 */
407 if (num_ports == 0 || num_ports > 2) {
Alan Coxd60d4392008-07-22 11:12:15 +0100408 dev_warn(dev, "%s: No valid connect info available\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700409 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 num_ports = 2;
411 }
Alan Coxd60d4392008-07-22 11:12:15 +0100412
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700413 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 num_ports);
415
416 /*
417 * save off our num_ports info so that we can use it in the
418 * calc_num_ports callback
419 */
420 usb_set_serial_data(serial, (void *)(long)num_ports);
421
Alan Coxd60d4392008-07-22 11:12:15 +0100422 /* ask for the number of bytes available, but ignore the
423 response as it is broken */
424 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 usb_rcvctrlpipe(serial->dev, 0),
426 VISOR_REQUEST_BYTES_AVAILABLE,
427 0xc2, 0x0000, 0x0005, transfer_buffer,
428 0x02, 300);
429 if (retval < 0)
430 dev_err(dev, "%s - error %d getting bytes available request\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800431 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 retval = 0;
433
434exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100435 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437 return retval;
438}
439
Alan Coxd60d4392008-07-22 11:12:15 +0100440static int palm_os_4_probe(struct usb_serial *serial,
441 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
443 struct device *dev = &serial->dev->dev;
444 struct palm_ext_connection_info *connection_info;
445 unsigned char *transfer_buffer;
446 int retval;
447
Harvey Harrison441b62c2008-03-03 16:08:34 -0800448 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Alan Coxd60d4392008-07-22 11:12:15 +0100450 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800452 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 sizeof(*connection_info));
454 return -ENOMEM;
455 }
456
Alan Coxd60d4392008-07-22 11:12:15 +0100457 retval = usb_control_msg(serial->dev,
458 usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 PALM_GET_EXT_CONNECTION_INFORMATION,
460 0xc2, 0x0000, 0x0000, transfer_buffer,
Alan Coxd60d4392008-07-22 11:12:15 +0100461 sizeof(*connection_info), 300);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 if (retval < 0)
463 dev_err(dev, "%s - error %d getting connection info\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800464 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 else
Harvey Harrison441b62c2008-03-03 16:08:34 -0800466 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 retval, transfer_buffer);
468
Alan Coxd60d4392008-07-22 11:12:15 +0100469 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 return 0;
471}
472
473
Alan Coxd60d4392008-07-22 11:12:15 +0100474static int visor_probe(struct usb_serial *serial,
475 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
477 int retval = 0;
Alan Coxd60d4392008-07-22 11:12:15 +0100478 int (*startup)(struct usb_serial *serial,
479 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Harvey Harrison441b62c2008-03-03 16:08:34 -0800481 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Maciej Szmigieroacb52cb2011-02-07 12:42:36 +0100483 /*
484 * some Samsung Android phones in modem mode have the same ID
485 * as SPH-I500, but they are ACM devices, so dont bind to them
486 */
487 if (id->idVendor == SAMSUNG_VENDOR_ID &&
488 id->idProduct == SAMSUNG_SPH_I500_ID &&
489 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
490 serial->dev->descriptor.bDeviceSubClass ==
491 USB_CDC_SUBCLASS_ACM)
492 return -ENODEV;
493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700495 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 serial->dev->actconfig->desc.bConfigurationValue);
497 return -ENODEV;
498 }
499
500 if (id->driver_info) {
501 startup = (void *)id->driver_info;
502 retval = startup(serial, id);
503 }
504
505 return retval;
506}
507
Alan Coxd60d4392008-07-22 11:12:15 +0100508static int visor_calc_num_ports(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
510 int num_ports = (int)(long)(usb_get_serial_data(serial));
511
512 if (num_ports)
513 usb_set_serial_data(serial, NULL);
514
515 return num_ports;
516}
517
Alan Coxd60d4392008-07-22 11:12:15 +0100518static int clie_3_5_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
520 struct device *dev = &serial->dev->dev;
521 int result;
Johan Hovold401711c2009-12-28 23:01:57 +0100522 u8 *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Harvey Harrison441b62c2008-03-03 16:08:34 -0800524 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Johan Hovold401711c2009-12-28 23:01:57 +0100526 data = kmalloc(1, GFP_KERNEL);
527 if (!data)
528 return -ENOMEM;
529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 /*
531 * Note that PEG-300 series devices expect the following two calls.
532 */
533
534 /* get the config number */
Alan Coxd60d4392008-07-22 11:12:15 +0100535 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
Johan Hovold401711c2009-12-28 23:01:57 +0100537 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100539 dev_err(dev, "%s: get config number failed: %d\n",
540 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100541 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 }
543 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100544 dev_err(dev, "%s: get config number bad return length: %d\n",
545 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100546 result = -EIO;
547 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 }
549
550 /* get the interface number */
Alan Coxd60d4392008-07-22 11:12:15 +0100551 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
552 USB_REQ_GET_INTERFACE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 USB_DIR_IN | USB_RECIP_INTERFACE,
Johan Hovold401711c2009-12-28 23:01:57 +0100554 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100556 dev_err(dev, "%s: get interface number failed: %d\n",
557 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100558 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 }
560 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100561 dev_err(dev,
562 "%s: get interface number bad return length: %d\n",
563 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100564 result = -EIO;
565 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
567
Johan Hovold214916f2010-05-15 17:53:49 +0200568 result = 0;
Johan Hovold401711c2009-12-28 23:01:57 +0100569out:
570 kfree(data);
571
572 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573}
Alan Coxd60d4392008-07-22 11:12:15 +0100574
575static int treo_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
577 struct usb_serial_port *swap_port;
578
579 /* Only do this endpoint hack for the Handspring devices with
580 * interrupt in endpoints, which for now are the Treo devices. */
Alan Coxd60d4392008-07-22 11:12:15 +0100581 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
582 == HANDSPRING_VENDOR_ID) ||
583 (le16_to_cpu(serial->dev->descriptor.idVendor)
584 == KYOCERA_VENDOR_ID)) ||
585 (serial->num_interrupt_in == 0))
Johan Hovold214916f2010-05-15 17:53:49 +0200586 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Harvey Harrison441b62c2008-03-03 16:08:34 -0800588 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590 /*
Alan Coxd60d4392008-07-22 11:12:15 +0100591 * It appears that Treos and Kyoceras want to use the
592 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
593 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
594 * Note that swapping the bulk out endpoints would break lots of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 * apps that want to communicate on the second port.
596 */
597#define COPY_PORT(dest, src) \
Alan Coxd60d4392008-07-22 11:12:15 +0100598 do { \
599 dest->read_urb = src->read_urb; \
600 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
601 dest->bulk_in_buffer = src->bulk_in_buffer; \
602 dest->interrupt_in_urb = src->interrupt_in_urb; \
603 dest->interrupt_in_endpointAddress = \
604 src->interrupt_in_endpointAddress;\
605 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
606 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
608 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
609 if (!swap_port)
610 return -ENOMEM;
611 COPY_PORT(swap_port, serial->port[0]);
612 COPY_PORT(serial->port[0], serial->port[1]);
613 COPY_PORT(serial->port[1], swap_port);
614 kfree(swap_port);
615
Johan Hovold214916f2010-05-15 17:53:49 +0200616 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617}
618
Alan Coxd60d4392008-07-22 11:12:15 +0100619static int clie_5_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200621 struct usb_serial_port *port;
622 unsigned int pipe;
623 int j;
624
Harvey Harrison441b62c2008-03-03 16:08:34 -0800625 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Alan Coxd60d4392008-07-22 11:12:15 +0100627 /* TH55 registers 2 ports.
628 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
629 from port 0. Communication out to the UX50/TH55 uses
630 bulk_out_endpointAddress from port 1
631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 Lets do a quick and dirty mapping
633 */
Alan Coxd60d4392008-07-22 11:12:15 +0100634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 /* some sanity check */
636 if (serial->num_ports < 2)
637 return -1;
Alan Coxd60d4392008-07-22 11:12:15 +0100638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 /* port 0 now uses the modified endpoint Address */
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200640 port = serial->port[0];
641 port->bulk_out_endpointAddress =
Alan Coxd60d4392008-07-22 11:12:15 +0100642 serial->port[1]->bulk_out_endpointAddress;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200644 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
645 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
646 port->write_urbs[j]->pipe = pipe;
647
Johan Hovold214916f2010-05-15 17:53:49 +0200648 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
Alan Coxd60d4392008-07-22 11:12:15 +0100651static int __init visor_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652{
653 int i, retval;
654 /* Only if parameters were passed to us */
Alan Coxd60d4392008-07-22 11:12:15 +0100655 if (vendor > 0 && product > 0) {
656 struct usb_device_id usb_dev_temp[] = {
657 {
658 USB_DEVICE(vendor, product),
659 .driver_info =
660 (kernel_ulong_t) &palm_os_4_probe
661 }
662 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
664 /* Find the last entry in id_table */
Alan Coxd60d4392008-07-22 11:12:15 +0100665 for (i = 0;; i++) {
666 if (id_table[i].idVendor == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 id_table[i] = usb_dev_temp[0];
668 break;
669 }
670 }
671 /* Find the last entry in id_table_combined */
Alan Coxd60d4392008-07-22 11:12:15 +0100672 for (i = 0;; i++) {
673 if (id_table_combined[i].idVendor == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 id_table_combined[i] = usb_dev_temp[0];
675 break;
676 }
677 }
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -0700678 printk(KERN_INFO KBUILD_MODNAME
679 ": Untested USB device specified at time of module insertion\n");
680 printk(KERN_INFO KBUILD_MODNAME
681 ": Warning: This is not guaranteed to work\n");
682 printk(KERN_INFO KBUILD_MODNAME
683 ": Using a newer kernel is preferred to this method\n");
684 printk(KERN_INFO KBUILD_MODNAME
685 ": Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 vendor, product);
687 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Alan Stern29618e92012-02-23 14:57:32 -0500689 retval = usb_serial_register_drivers(&visor_driver, serial_drivers);
690 if (retval == 0)
691 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 return retval;
693}
694
695
696static void __exit visor_exit (void)
697{
Alan Stern29618e92012-02-23 14:57:32 -0500698 usb_serial_deregister_drivers(&visor_driver, serial_drivers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699}
700
701
702module_init(visor_init);
703module_exit(visor_exit);
704
Alan Coxd60d4392008-07-22 11:12:15 +0100705MODULE_AUTHOR(DRIVER_AUTHOR);
706MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707MODULE_LICENSE("GPL");
708
709module_param(debug, bool, S_IRUGO | S_IWUSR);
710MODULE_PARM_DESC(debug, "Debug enabled or not");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
712module_param(vendor, ushort, 0);
713MODULE_PARM_DESC(vendor, "User specified vendor ID");
714module_param(product, ushort, 0);
715MODULE_PARM_DESC(product, "User specified product ID");
716