blob: 17fd8822d07f6a9735aa1329bdd33822f9ba73be [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "visor.h"
31
32/*
33 * Version Information
34 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
36#define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
37
38/* function prototypes for a handspring visor */
Alan Coxa509a7e2009-09-19 13:13:26 -070039static int visor_open(struct tty_struct *tty, struct usb_serial_port *port);
Alan Cox335f8512009-06-11 12:26:29 +010040static void visor_close(struct usb_serial_port *port);
Alan Coxd60d4392008-07-22 11:12:15 +010041static int visor_probe(struct usb_serial *serial,
42 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043static int visor_calc_num_ports(struct usb_serial *serial);
Alan Coxd60d4392008-07-22 11:12:15 +010044static void visor_read_int_callback(struct urb *urb);
45static int clie_3_5_startup(struct usb_serial *serial);
46static int treo_attach(struct usb_serial *serial);
47static int clie_5_attach(struct usb_serial *serial);
48static int palm_os_3_probe(struct usb_serial *serial,
49 const struct usb_device_id *id);
50static int palm_os_4_probe(struct usb_serial *serial,
51 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53/* Parameters that may be passed into the module. */
54static int debug;
55static __u16 vendor;
56static __u16 product;
57
58static struct usb_device_id id_table [] = {
59 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
60 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
61 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
62 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
63 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
64 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Hendrik Schweppe04d52462006-02-19 19:00:04 +010065 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
66 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
68 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
69 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
70 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
71 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
72 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
73 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
74 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
75 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
76 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
77 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
78 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
79 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
80 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
81 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
82 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -070083 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
84 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
86 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
88 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
89 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
90 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
91 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
92 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
93 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
94 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
95 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
96 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
97 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
98 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
99 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
100 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Maximilian Attemsc8ba84a2007-08-04 10:19:41 +0200101 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
102 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100103 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100105 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700107 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
108 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100109 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
111 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
112 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
113 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
114 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
115 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
116 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
117 { }, /* optional parameter entry */
118 { } /* Terminating entry */
119};
120
121static struct usb_device_id clie_id_5_table [] = {
122 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
123 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
124 { }, /* optional parameter entry */
125 { } /* Terminating entry */
126};
127
128static struct usb_device_id clie_id_3_5_table [] = {
129 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
130 { } /* Terminating entry */
131};
132
133static struct usb_device_id id_table_combined [] = {
134 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
135 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
136 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
Hendrik Schweppe04d52462006-02-19 19:00:04 +0100137 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
142 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
143 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
144 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
145 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -0700146 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
149 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
150 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
151 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
152 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
153 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
154 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
155 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
156 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
157 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
158 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700159 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
161 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
162 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
163 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
164 { }, /* optional parameter entry */
165 { } /* Terminating entry */
166};
167
Alan Coxd60d4392008-07-22 11:12:15 +0100168MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170static struct usb_driver visor_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 .name = "visor",
172 .probe = usb_serial_probe,
173 .disconnect = usb_serial_disconnect,
174 .id_table = id_table_combined,
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800175 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176};
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",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100186 .usb_driver = &visor_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 .id_table = id_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 .num_ports = 2,
189 .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",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100206 .usb_driver = &visor_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 .id_table = clie_id_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 .num_ports = 2,
209 .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",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100226 .usb_driver = &visor_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 .id_table = clie_id_3_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 .num_ports = 1,
229 .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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236/******************************************************************************
237 * Handspring Visor specific driver functions
238 ******************************************************************************/
Alan Coxa509a7e2009-09-19 13:13:26 -0700239static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 int result = 0;
242
Harvey Harrison441b62c2008-03-03 16:08:34 -0800243 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245 if (!port->read_urb) {
246 /* this is needed for some brain dead Sony devices */
247 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
248 return -ENODEV;
249 }
250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 /* Start reading from the device */
Johan Hovold214916f2010-05-15 17:53:49 +0200252 result = usb_serial_generic_open(tty, port);
253 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 goto exit;
Alan Coxd60d4392008-07-22 11:12:15 +0100255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 if (port->interrupt_in_urb) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800257 dbg("%s - adding interrupt input for treo", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
259 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100260 dev_err(&port->dev,
261 "%s - failed submitting interrupt urb, error %d\n",
262 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
Alan Coxd60d4392008-07-22 11:12:15 +0100264exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 return result;
266}
267
268
Alan Cox335f8512009-06-11 12:26:29 +0100269static void visor_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 unsigned char *transfer_buffer;
272
Harvey Harrison441b62c2008-03-03 16:08:34 -0800273 dbg("%s - port %d", __func__, port->number);
Alan Coxd60d4392008-07-22 11:12:15 +0100274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 /* shutdown our urbs */
Johan Hovold214916f2010-05-15 17:53:49 +0200276 usb_serial_generic_close(port);
Mariusz Kozlowskibcb54a52006-11-08 15:36:55 +0100277 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100279 mutex_lock(&port->serial->disc_mutex);
280 if (!port->serial->disconnected) {
281 /* Try to send shutdown message, unless the device is gone */
Alan Coxd60d4392008-07-22 11:12:15 +0100282 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100283 if (transfer_buffer) {
Alan Coxd60d4392008-07-22 11:12:15 +0100284 usb_control_msg(port->serial->dev,
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100285 usb_rcvctrlpipe(port->serial->dev, 0),
286 VISOR_CLOSE_NOTIFICATION, 0xc2,
287 0x0000, 0x0000,
288 transfer_buffer, 0x12, 300);
Alan Coxd60d4392008-07-22 11:12:15 +0100289 kfree(transfer_buffer);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100290 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 }
Oliver Neukum95bef012008-01-22 13:56:18 +0100292 mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294
Alan Coxd60d4392008-07-22 11:12:15 +0100295static void visor_read_int_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296{
Ming Leicdc97792008-02-24 18:41:47 +0800297 struct usb_serial_port *port = urb->context;
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700298 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 int result;
300
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700301 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 case 0:
303 /* success */
304 break;
305 case -ECONNRESET:
306 case -ENOENT:
307 case -ESHUTDOWN:
308 /* this urb is terminated, clean up */
309 dbg("%s - urb shutting down with status: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800310 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 return;
312 default:
313 dbg("%s - nonzero urb status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800314 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 goto exit;
316 }
317
318 /*
319 * This information is still unknown what it can be used for.
320 * If anyone has an idea, please let the author know...
321 *
322 * Rumor has it this endpoint is used to notify when data
323 * is ready to be read from the bulk ones.
324 */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800325 usb_serial_debug_data(debug, &port->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 urb->actual_length, urb->transfer_buffer);
327
328exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100329 result = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100331 dev_err(&urb->dev->dev,
332 "%s - Error %d submitting interrupt urb\n",
333 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334}
335
Alan Coxd60d4392008-07-22 11:12:15 +0100336static int palm_os_3_probe(struct usb_serial *serial,
337 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338{
339 struct device *dev = &serial->dev->dev;
340 struct visor_connection_info *connection_info;
341 unsigned char *transfer_buffer;
342 char *string;
343 int retval = 0;
344 int i;
345 int num_ports = 0;
346
Harvey Harrison441b62c2008-03-03 16:08:34 -0800347 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Alan Coxd60d4392008-07-22 11:12:15 +0100349 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800351 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 sizeof(*connection_info));
353 return -ENOMEM;
354 }
355
356 /* send a get connection info request */
Alan Coxd60d4392008-07-22 11:12:15 +0100357 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 usb_rcvctrlpipe(serial->dev, 0),
359 VISOR_GET_CONNECTION_INFORMATION,
360 0xc2, 0x0000, 0x0000, transfer_buffer,
361 sizeof(*connection_info), 300);
362 if (retval < 0) {
363 dev_err(dev, "%s - error %d getting connection information\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800364 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 goto exit;
366 }
367
368 if (retval == sizeof(*connection_info)) {
Alan Coxd60d4392008-07-22 11:12:15 +0100369 connection_info = (struct visor_connection_info *)
370 transfer_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
372 num_ports = le16_to_cpu(connection_info->num_ports);
373 for (i = 0; i < num_ports; ++i) {
Alan Coxd60d4392008-07-22 11:12:15 +0100374 switch (
375 connection_info->connections[i].port_function_id) {
376 case VISOR_FUNCTION_GENERIC:
377 string = "Generic";
378 break;
379 case VISOR_FUNCTION_DEBUGGER:
380 string = "Debugger";
381 break;
382 case VISOR_FUNCTION_HOTSYNC:
383 string = "HotSync";
384 break;
385 case VISOR_FUNCTION_CONSOLE:
386 string = "Console";
387 break;
388 case VISOR_FUNCTION_REMOTE_FILE_SYS:
389 string = "Remote File System";
390 break;
391 default:
392 string = "unknown";
393 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 }
395 dev_info(dev, "%s: port %d, is for %s use\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700396 serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 connection_info->connections[i].port, string);
398 }
399 }
400 /*
401 * Handle devices that report invalid stuff here.
402 */
403 if (num_ports == 0 || num_ports > 2) {
Alan Coxd60d4392008-07-22 11:12:15 +0100404 dev_warn(dev, "%s: No valid connect info available\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700405 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 num_ports = 2;
407 }
Alan Coxd60d4392008-07-22 11:12:15 +0100408
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700409 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 num_ports);
411
412 /*
413 * save off our num_ports info so that we can use it in the
414 * calc_num_ports callback
415 */
416 usb_set_serial_data(serial, (void *)(long)num_ports);
417
Alan Coxd60d4392008-07-22 11:12:15 +0100418 /* ask for the number of bytes available, but ignore the
419 response as it is broken */
420 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 usb_rcvctrlpipe(serial->dev, 0),
422 VISOR_REQUEST_BYTES_AVAILABLE,
423 0xc2, 0x0000, 0x0005, transfer_buffer,
424 0x02, 300);
425 if (retval < 0)
426 dev_err(dev, "%s - error %d getting bytes available request\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800427 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 retval = 0;
429
430exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100431 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
433 return retval;
434}
435
Alan Coxd60d4392008-07-22 11:12:15 +0100436static int palm_os_4_probe(struct usb_serial *serial,
437 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
439 struct device *dev = &serial->dev->dev;
440 struct palm_ext_connection_info *connection_info;
441 unsigned char *transfer_buffer;
442 int retval;
443
Harvey Harrison441b62c2008-03-03 16:08:34 -0800444 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Alan Coxd60d4392008-07-22 11:12:15 +0100446 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800448 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 sizeof(*connection_info));
450 return -ENOMEM;
451 }
452
Alan Coxd60d4392008-07-22 11:12:15 +0100453 retval = usb_control_msg(serial->dev,
454 usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 PALM_GET_EXT_CONNECTION_INFORMATION,
456 0xc2, 0x0000, 0x0000, transfer_buffer,
Alan Coxd60d4392008-07-22 11:12:15 +0100457 sizeof(*connection_info), 300);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 if (retval < 0)
459 dev_err(dev, "%s - error %d getting connection info\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800460 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 else
Harvey Harrison441b62c2008-03-03 16:08:34 -0800462 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 retval, transfer_buffer);
464
Alan Coxd60d4392008-07-22 11:12:15 +0100465 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 return 0;
467}
468
469
Alan Coxd60d4392008-07-22 11:12:15 +0100470static int visor_probe(struct usb_serial *serial,
471 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472{
473 int retval = 0;
Alan Coxd60d4392008-07-22 11:12:15 +0100474 int (*startup)(struct usb_serial *serial,
475 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Harvey Harrison441b62c2008-03-03 16:08:34 -0800477 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700480 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 serial->dev->actconfig->desc.bConfigurationValue);
482 return -ENODEV;
483 }
484
485 if (id->driver_info) {
486 startup = (void *)id->driver_info;
487 retval = startup(serial, id);
488 }
489
490 return retval;
491}
492
Alan Coxd60d4392008-07-22 11:12:15 +0100493static int visor_calc_num_ports(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
495 int num_ports = (int)(long)(usb_get_serial_data(serial));
496
497 if (num_ports)
498 usb_set_serial_data(serial, NULL);
499
500 return num_ports;
501}
502
Alan Coxd60d4392008-07-22 11:12:15 +0100503static int clie_3_5_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 struct device *dev = &serial->dev->dev;
506 int result;
Johan Hovold401711c2009-12-28 23:01:57 +0100507 u8 *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Harvey Harrison441b62c2008-03-03 16:08:34 -0800509 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Johan Hovold401711c2009-12-28 23:01:57 +0100511 data = kmalloc(1, GFP_KERNEL);
512 if (!data)
513 return -ENOMEM;
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 /*
516 * Note that PEG-300 series devices expect the following two calls.
517 */
518
519 /* get the config number */
Alan Coxd60d4392008-07-22 11:12:15 +0100520 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
Johan Hovold401711c2009-12-28 23:01:57 +0100522 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100524 dev_err(dev, "%s: get config number failed: %d\n",
525 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100526 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 }
528 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100529 dev_err(dev, "%s: get config number bad return length: %d\n",
530 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100531 result = -EIO;
532 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 }
534
535 /* get the interface number */
Alan Coxd60d4392008-07-22 11:12:15 +0100536 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
537 USB_REQ_GET_INTERFACE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 USB_DIR_IN | USB_RECIP_INTERFACE,
Johan Hovold401711c2009-12-28 23:01:57 +0100539 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100541 dev_err(dev, "%s: get interface number failed: %d\n",
542 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100543 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 }
545 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100546 dev_err(dev,
547 "%s: get interface number bad return length: %d\n",
548 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100549 result = -EIO;
550 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552
Johan Hovold214916f2010-05-15 17:53:49 +0200553 result = 0;
Johan Hovold401711c2009-12-28 23:01:57 +0100554out:
555 kfree(data);
556
557 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
Alan Coxd60d4392008-07-22 11:12:15 +0100559
560static int treo_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
562 struct usb_serial_port *swap_port;
563
564 /* Only do this endpoint hack for the Handspring devices with
565 * interrupt in endpoints, which for now are the Treo devices. */
Alan Coxd60d4392008-07-22 11:12:15 +0100566 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
567 == HANDSPRING_VENDOR_ID) ||
568 (le16_to_cpu(serial->dev->descriptor.idVendor)
569 == KYOCERA_VENDOR_ID)) ||
570 (serial->num_interrupt_in == 0))
Johan Hovold214916f2010-05-15 17:53:49 +0200571 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Harvey Harrison441b62c2008-03-03 16:08:34 -0800573 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575 /*
Alan Coxd60d4392008-07-22 11:12:15 +0100576 * It appears that Treos and Kyoceras want to use the
577 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
578 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
579 * Note that swapping the bulk out endpoints would break lots of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 * apps that want to communicate on the second port.
581 */
582#define COPY_PORT(dest, src) \
Alan Coxd60d4392008-07-22 11:12:15 +0100583 do { \
584 dest->read_urb = src->read_urb; \
585 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
586 dest->bulk_in_buffer = src->bulk_in_buffer; \
587 dest->interrupt_in_urb = src->interrupt_in_urb; \
588 dest->interrupt_in_endpointAddress = \
589 src->interrupt_in_endpointAddress;\
590 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
591 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
593 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
594 if (!swap_port)
595 return -ENOMEM;
596 COPY_PORT(swap_port, serial->port[0]);
597 COPY_PORT(serial->port[0], serial->port[1]);
598 COPY_PORT(serial->port[1], swap_port);
599 kfree(swap_port);
600
Johan Hovold214916f2010-05-15 17:53:49 +0200601 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
Alan Coxd60d4392008-07-22 11:12:15 +0100604static int clie_5_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
Harvey Harrison441b62c2008-03-03 16:08:34 -0800606 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Alan Coxd60d4392008-07-22 11:12:15 +0100608 /* TH55 registers 2 ports.
609 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
610 from port 0. Communication out to the UX50/TH55 uses
611 bulk_out_endpointAddress from port 1
612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 Lets do a quick and dirty mapping
614 */
Alan Coxd60d4392008-07-22 11:12:15 +0100615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 /* some sanity check */
617 if (serial->num_ports < 2)
618 return -1;
Alan Coxd60d4392008-07-22 11:12:15 +0100619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 /* port 0 now uses the modified endpoint Address */
Alan Coxd60d4392008-07-22 11:12:15 +0100621 serial->port[0]->bulk_out_endpointAddress =
622 serial->port[1]->bulk_out_endpointAddress;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Johan Hovold214916f2010-05-15 17:53:49 +0200624 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625}
626
Alan Coxd60d4392008-07-22 11:12:15 +0100627static int __init visor_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
629 int i, retval;
630 /* Only if parameters were passed to us */
Alan Coxd60d4392008-07-22 11:12:15 +0100631 if (vendor > 0 && product > 0) {
632 struct usb_device_id usb_dev_temp[] = {
633 {
634 USB_DEVICE(vendor, product),
635 .driver_info =
636 (kernel_ulong_t) &palm_os_4_probe
637 }
638 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640 /* Find the last entry in id_table */
Alan Coxd60d4392008-07-22 11:12:15 +0100641 for (i = 0;; i++) {
642 if (id_table[i].idVendor == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 id_table[i] = usb_dev_temp[0];
644 break;
645 }
646 }
647 /* Find the last entry in id_table_combined */
Alan Coxd60d4392008-07-22 11:12:15 +0100648 for (i = 0;; i++) {
649 if (id_table_combined[i].idVendor == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 id_table_combined[i] = usb_dev_temp[0];
651 break;
652 }
653 }
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -0700654 printk(KERN_INFO KBUILD_MODNAME
655 ": Untested USB device specified at time of module insertion\n");
656 printk(KERN_INFO KBUILD_MODNAME
657 ": Warning: This is not guaranteed to work\n");
658 printk(KERN_INFO KBUILD_MODNAME
659 ": Using a newer kernel is preferred to this method\n");
660 printk(KERN_INFO KBUILD_MODNAME
661 ": Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 vendor, product);
663 }
664 retval = usb_serial_register(&handspring_device);
665 if (retval)
666 goto failed_handspring_register;
667 retval = usb_serial_register(&clie_3_5_device);
668 if (retval)
669 goto failed_clie_3_5_register;
670 retval = usb_serial_register(&clie_5_device);
671 if (retval)
672 goto failed_clie_5_register;
673 retval = usb_register(&visor_driver);
Alan Coxd60d4392008-07-22 11:12:15 +0100674 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 goto failed_usb_register;
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -0700676 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
678 return 0;
679failed_usb_register:
680 usb_serial_deregister(&clie_5_device);
681failed_clie_5_register:
682 usb_serial_deregister(&clie_3_5_device);
683failed_clie_3_5_register:
684 usb_serial_deregister(&handspring_device);
685failed_handspring_register:
686 return retval;
687}
688
689
690static void __exit visor_exit (void)
691{
Alan Coxd60d4392008-07-22 11:12:15 +0100692 usb_deregister(&visor_driver);
693 usb_serial_deregister(&handspring_device);
694 usb_serial_deregister(&clie_3_5_device);
695 usb_serial_deregister(&clie_5_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696}
697
698
699module_init(visor_init);
700module_exit(visor_exit);
701
Alan Coxd60d4392008-07-22 11:12:15 +0100702MODULE_AUTHOR(DRIVER_AUTHOR);
703MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704MODULE_LICENSE("GPL");
705
706module_param(debug, bool, S_IRUGO | S_IWUSR);
707MODULE_PARM_DESC(debug, "Debug enabled or not");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
709module_param(vendor, ushort, 0);
710MODULE_PARM_DESC(vendor, "User specified vendor ID");
711module_param(product, ushort, 0);
712MODULE_PARM_DESC(product, "User specified product ID");
713