blob: 15a5d89b7f397596e45475afc83b83a8ea1d2ffa [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,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200189 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 .open = visor_open,
191 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200192 .throttle = usb_serial_generic_throttle,
193 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 .attach = treo_attach,
195 .probe = visor_probe,
196 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 .read_int_callback = visor_read_int_callback,
198};
199
200/* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700201static struct usb_serial_driver clie_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700202 .driver = {
203 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700204 .name = "clie_5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700205 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700206 .description = "Sony Clie 5.0",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100207 .usb_driver = &visor_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 .id_table = clie_id_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200210 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 .open = visor_open,
212 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200213 .throttle = usb_serial_generic_throttle,
214 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 .attach = clie_5_attach,
216 .probe = visor_probe,
217 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 .read_int_callback = visor_read_int_callback,
219};
220
221/* device info for the Sony Clie OS version 3.5 */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700222static struct usb_serial_driver clie_3_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700223 .driver = {
224 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700225 .name = "clie_3.5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700226 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700227 .description = "Sony Clie 3.5",
Johannes Hölzld9b1b782006-12-17 21:50:24 +0100228 .usb_driver = &visor_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 .id_table = clie_id_3_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 .num_ports = 1,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200231 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 .open = visor_open,
233 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200234 .throttle = usb_serial_generic_throttle,
235 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 .attach = clie_3_5_startup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237};
238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239/******************************************************************************
240 * Handspring Visor specific driver functions
241 ******************************************************************************/
Alan Coxa509a7e2009-09-19 13:13:26 -0700242static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 int result = 0;
245
Harvey Harrison441b62c2008-03-03 16:08:34 -0800246 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 if (!port->read_urb) {
249 /* this is needed for some brain dead Sony devices */
250 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
251 return -ENODEV;
252 }
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 /* Start reading from the device */
Johan Hovold214916f2010-05-15 17:53:49 +0200255 result = usb_serial_generic_open(tty, port);
256 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 goto exit;
Alan Coxd60d4392008-07-22 11:12:15 +0100258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 if (port->interrupt_in_urb) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800260 dbg("%s - adding interrupt input for treo", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
262 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100263 dev_err(&port->dev,
264 "%s - failed submitting interrupt urb, error %d\n",
265 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 }
Alan Coxd60d4392008-07-22 11:12:15 +0100267exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return result;
269}
270
271
Alan Cox335f8512009-06-11 12:26:29 +0100272static void visor_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 unsigned char *transfer_buffer;
275
Harvey Harrison441b62c2008-03-03 16:08:34 -0800276 dbg("%s - port %d", __func__, port->number);
Alan Coxd60d4392008-07-22 11:12:15 +0100277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 /* shutdown our urbs */
Johan Hovold214916f2010-05-15 17:53:49 +0200279 usb_serial_generic_close(port);
Mariusz Kozlowskibcb54a52006-11-08 15:36:55 +0100280 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100282 mutex_lock(&port->serial->disc_mutex);
283 if (!port->serial->disconnected) {
284 /* Try to send shutdown message, unless the device is gone */
Alan Coxd60d4392008-07-22 11:12:15 +0100285 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100286 if (transfer_buffer) {
Alan Coxd60d4392008-07-22 11:12:15 +0100287 usb_control_msg(port->serial->dev,
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100288 usb_rcvctrlpipe(port->serial->dev, 0),
289 VISOR_CLOSE_NOTIFICATION, 0xc2,
290 0x0000, 0x0000,
291 transfer_buffer, 0x12, 300);
Alan Coxd60d4392008-07-22 11:12:15 +0100292 kfree(transfer_buffer);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100293 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 }
Oliver Neukum95bef012008-01-22 13:56:18 +0100295 mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
Alan Coxd60d4392008-07-22 11:12:15 +0100298static void visor_read_int_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299{
Ming Leicdc97792008-02-24 18:41:47 +0800300 struct usb_serial_port *port = urb->context;
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700301 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 int result;
303
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700304 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 case 0:
306 /* success */
307 break;
308 case -ECONNRESET:
309 case -ENOENT:
310 case -ESHUTDOWN:
311 /* this urb is terminated, clean up */
312 dbg("%s - urb shutting down with status: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800313 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 return;
315 default:
316 dbg("%s - nonzero urb status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800317 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 goto exit;
319 }
320
321 /*
322 * This information is still unknown what it can be used for.
323 * If anyone has an idea, please let the author know...
324 *
325 * Rumor has it this endpoint is used to notify when data
326 * is ready to be read from the bulk ones.
327 */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800328 usb_serial_debug_data(debug, &port->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 urb->actual_length, urb->transfer_buffer);
330
331exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100332 result = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100334 dev_err(&urb->dev->dev,
335 "%s - Error %d submitting interrupt urb\n",
336 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337}
338
Alan Coxd60d4392008-07-22 11:12:15 +0100339static int palm_os_3_probe(struct usb_serial *serial,
340 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341{
342 struct device *dev = &serial->dev->dev;
343 struct visor_connection_info *connection_info;
344 unsigned char *transfer_buffer;
345 char *string;
346 int retval = 0;
347 int i;
348 int num_ports = 0;
349
Harvey Harrison441b62c2008-03-03 16:08:34 -0800350 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Alan Coxd60d4392008-07-22 11:12:15 +0100352 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800354 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 sizeof(*connection_info));
356 return -ENOMEM;
357 }
358
359 /* send a get connection info request */
Alan Coxd60d4392008-07-22 11:12:15 +0100360 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 usb_rcvctrlpipe(serial->dev, 0),
362 VISOR_GET_CONNECTION_INFORMATION,
363 0xc2, 0x0000, 0x0000, transfer_buffer,
364 sizeof(*connection_info), 300);
365 if (retval < 0) {
366 dev_err(dev, "%s - error %d getting connection information\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800367 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 goto exit;
369 }
370
371 if (retval == sizeof(*connection_info)) {
Alan Coxd60d4392008-07-22 11:12:15 +0100372 connection_info = (struct visor_connection_info *)
373 transfer_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375 num_ports = le16_to_cpu(connection_info->num_ports);
376 for (i = 0; i < num_ports; ++i) {
Alan Coxd60d4392008-07-22 11:12:15 +0100377 switch (
378 connection_info->connections[i].port_function_id) {
379 case VISOR_FUNCTION_GENERIC:
380 string = "Generic";
381 break;
382 case VISOR_FUNCTION_DEBUGGER:
383 string = "Debugger";
384 break;
385 case VISOR_FUNCTION_HOTSYNC:
386 string = "HotSync";
387 break;
388 case VISOR_FUNCTION_CONSOLE:
389 string = "Console";
390 break;
391 case VISOR_FUNCTION_REMOTE_FILE_SYS:
392 string = "Remote File System";
393 break;
394 default:
395 string = "unknown";
396 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 }
398 dev_info(dev, "%s: port %d, is for %s use\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700399 serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 connection_info->connections[i].port, string);
401 }
402 }
403 /*
404 * Handle devices that report invalid stuff here.
405 */
406 if (num_ports == 0 || num_ports > 2) {
Alan Coxd60d4392008-07-22 11:12:15 +0100407 dev_warn(dev, "%s: No valid connect info available\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700408 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 num_ports = 2;
410 }
Alan Coxd60d4392008-07-22 11:12:15 +0100411
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700412 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 num_ports);
414
415 /*
416 * save off our num_ports info so that we can use it in the
417 * calc_num_ports callback
418 */
419 usb_set_serial_data(serial, (void *)(long)num_ports);
420
Alan Coxd60d4392008-07-22 11:12:15 +0100421 /* ask for the number of bytes available, but ignore the
422 response as it is broken */
423 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 usb_rcvctrlpipe(serial->dev, 0),
425 VISOR_REQUEST_BYTES_AVAILABLE,
426 0xc2, 0x0000, 0x0005, transfer_buffer,
427 0x02, 300);
428 if (retval < 0)
429 dev_err(dev, "%s - error %d getting bytes available request\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800430 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 retval = 0;
432
433exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100434 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436 return retval;
437}
438
Alan Coxd60d4392008-07-22 11:12:15 +0100439static int palm_os_4_probe(struct usb_serial *serial,
440 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 struct device *dev = &serial->dev->dev;
443 struct palm_ext_connection_info *connection_info;
444 unsigned char *transfer_buffer;
445 int retval;
446
Harvey Harrison441b62c2008-03-03 16:08:34 -0800447 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Alan Coxd60d4392008-07-22 11:12:15 +0100449 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800451 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 sizeof(*connection_info));
453 return -ENOMEM;
454 }
455
Alan Coxd60d4392008-07-22 11:12:15 +0100456 retval = usb_control_msg(serial->dev,
457 usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 PALM_GET_EXT_CONNECTION_INFORMATION,
459 0xc2, 0x0000, 0x0000, transfer_buffer,
Alan Coxd60d4392008-07-22 11:12:15 +0100460 sizeof(*connection_info), 300);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 if (retval < 0)
462 dev_err(dev, "%s - error %d getting connection info\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800463 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 else
Harvey Harrison441b62c2008-03-03 16:08:34 -0800465 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 retval, transfer_buffer);
467
Alan Coxd60d4392008-07-22 11:12:15 +0100468 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 return 0;
470}
471
472
Alan Coxd60d4392008-07-22 11:12:15 +0100473static int visor_probe(struct usb_serial *serial,
474 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
476 int retval = 0;
Alan Coxd60d4392008-07-22 11:12:15 +0100477 int (*startup)(struct usb_serial *serial,
478 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Harvey Harrison441b62c2008-03-03 16:08:34 -0800480 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700483 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 serial->dev->actconfig->desc.bConfigurationValue);
485 return -ENODEV;
486 }
487
488 if (id->driver_info) {
489 startup = (void *)id->driver_info;
490 retval = startup(serial, id);
491 }
492
493 return retval;
494}
495
Alan Coxd60d4392008-07-22 11:12:15 +0100496static int visor_calc_num_ports(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 int num_ports = (int)(long)(usb_get_serial_data(serial));
499
500 if (num_ports)
501 usb_set_serial_data(serial, NULL);
502
503 return num_ports;
504}
505
Alan Coxd60d4392008-07-22 11:12:15 +0100506static int clie_3_5_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
508 struct device *dev = &serial->dev->dev;
509 int result;
Johan Hovold401711c2009-12-28 23:01:57 +0100510 u8 *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Harvey Harrison441b62c2008-03-03 16:08:34 -0800512 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Johan Hovold401711c2009-12-28 23:01:57 +0100514 data = kmalloc(1, GFP_KERNEL);
515 if (!data)
516 return -ENOMEM;
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 /*
519 * Note that PEG-300 series devices expect the following two calls.
520 */
521
522 /* get the config number */
Alan Coxd60d4392008-07-22 11:12:15 +0100523 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
Johan Hovold401711c2009-12-28 23:01:57 +0100525 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100527 dev_err(dev, "%s: get config number failed: %d\n",
528 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100529 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 }
531 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100532 dev_err(dev, "%s: get config number bad return length: %d\n",
533 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100534 result = -EIO;
535 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 }
537
538 /* get the interface number */
Alan Coxd60d4392008-07-22 11:12:15 +0100539 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
540 USB_REQ_GET_INTERFACE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 USB_DIR_IN | USB_RECIP_INTERFACE,
Johan Hovold401711c2009-12-28 23:01:57 +0100542 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100544 dev_err(dev, "%s: get interface number failed: %d\n",
545 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100546 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 }
548 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100549 dev_err(dev,
550 "%s: get interface number bad return length: %d\n",
551 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100552 result = -EIO;
553 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555
Johan Hovold214916f2010-05-15 17:53:49 +0200556 result = 0;
Johan Hovold401711c2009-12-28 23:01:57 +0100557out:
558 kfree(data);
559
560 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
Alan Coxd60d4392008-07-22 11:12:15 +0100562
563static int treo_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
565 struct usb_serial_port *swap_port;
566
567 /* Only do this endpoint hack for the Handspring devices with
568 * interrupt in endpoints, which for now are the Treo devices. */
Alan Coxd60d4392008-07-22 11:12:15 +0100569 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
570 == HANDSPRING_VENDOR_ID) ||
571 (le16_to_cpu(serial->dev->descriptor.idVendor)
572 == KYOCERA_VENDOR_ID)) ||
573 (serial->num_interrupt_in == 0))
Johan Hovold214916f2010-05-15 17:53:49 +0200574 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Harvey Harrison441b62c2008-03-03 16:08:34 -0800576 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
578 /*
Alan Coxd60d4392008-07-22 11:12:15 +0100579 * It appears that Treos and Kyoceras want to use the
580 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
581 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
582 * Note that swapping the bulk out endpoints would break lots of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 * apps that want to communicate on the second port.
584 */
585#define COPY_PORT(dest, src) \
Alan Coxd60d4392008-07-22 11:12:15 +0100586 do { \
587 dest->read_urb = src->read_urb; \
588 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
589 dest->bulk_in_buffer = src->bulk_in_buffer; \
590 dest->interrupt_in_urb = src->interrupt_in_urb; \
591 dest->interrupt_in_endpointAddress = \
592 src->interrupt_in_endpointAddress;\
593 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
594 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
596 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
597 if (!swap_port)
598 return -ENOMEM;
599 COPY_PORT(swap_port, serial->port[0]);
600 COPY_PORT(serial->port[0], serial->port[1]);
601 COPY_PORT(serial->port[1], swap_port);
602 kfree(swap_port);
603
Johan Hovold214916f2010-05-15 17:53:49 +0200604 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605}
606
Alan Coxd60d4392008-07-22 11:12:15 +0100607static int clie_5_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200609 struct usb_serial_port *port;
610 unsigned int pipe;
611 int j;
612
Harvey Harrison441b62c2008-03-03 16:08:34 -0800613 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Alan Coxd60d4392008-07-22 11:12:15 +0100615 /* TH55 registers 2 ports.
616 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
617 from port 0. Communication out to the UX50/TH55 uses
618 bulk_out_endpointAddress from port 1
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 Lets do a quick and dirty mapping
621 */
Alan Coxd60d4392008-07-22 11:12:15 +0100622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 /* some sanity check */
624 if (serial->num_ports < 2)
625 return -1;
Alan Coxd60d4392008-07-22 11:12:15 +0100626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 /* port 0 now uses the modified endpoint Address */
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200628 port = serial->port[0];
629 port->bulk_out_endpointAddress =
Alan Coxd60d4392008-07-22 11:12:15 +0100630 serial->port[1]->bulk_out_endpointAddress;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200632 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
633 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
634 port->write_urbs[j]->pipe = pipe;
635
Johan Hovold214916f2010-05-15 17:53:49 +0200636 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
638
Alan Coxd60d4392008-07-22 11:12:15 +0100639static int __init visor_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
641 int i, retval;
642 /* Only if parameters were passed to us */
Alan Coxd60d4392008-07-22 11:12:15 +0100643 if (vendor > 0 && product > 0) {
644 struct usb_device_id usb_dev_temp[] = {
645 {
646 USB_DEVICE(vendor, product),
647 .driver_info =
648 (kernel_ulong_t) &palm_os_4_probe
649 }
650 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 /* Find the last entry in id_table */
Alan Coxd60d4392008-07-22 11:12:15 +0100653 for (i = 0;; i++) {
654 if (id_table[i].idVendor == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 id_table[i] = usb_dev_temp[0];
656 break;
657 }
658 }
659 /* Find the last entry in id_table_combined */
Alan Coxd60d4392008-07-22 11:12:15 +0100660 for (i = 0;; i++) {
661 if (id_table_combined[i].idVendor == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 id_table_combined[i] = usb_dev_temp[0];
663 break;
664 }
665 }
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -0700666 printk(KERN_INFO KBUILD_MODNAME
667 ": Untested USB device specified at time of module insertion\n");
668 printk(KERN_INFO KBUILD_MODNAME
669 ": Warning: This is not guaranteed to work\n");
670 printk(KERN_INFO KBUILD_MODNAME
671 ": Using a newer kernel is preferred to this method\n");
672 printk(KERN_INFO KBUILD_MODNAME
673 ": Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 vendor, product);
675 }
676 retval = usb_serial_register(&handspring_device);
677 if (retval)
678 goto failed_handspring_register;
679 retval = usb_serial_register(&clie_3_5_device);
680 if (retval)
681 goto failed_clie_3_5_register;
682 retval = usb_serial_register(&clie_5_device);
683 if (retval)
684 goto failed_clie_5_register;
685 retval = usb_register(&visor_driver);
Alan Coxd60d4392008-07-22 11:12:15 +0100686 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 goto failed_usb_register;
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -0700688 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
690 return 0;
691failed_usb_register:
692 usb_serial_deregister(&clie_5_device);
693failed_clie_5_register:
694 usb_serial_deregister(&clie_3_5_device);
695failed_clie_3_5_register:
696 usb_serial_deregister(&handspring_device);
697failed_handspring_register:
698 return retval;
699}
700
701
702static void __exit visor_exit (void)
703{
Alan Coxd60d4392008-07-22 11:12:15 +0100704 usb_deregister(&visor_driver);
705 usb_serial_deregister(&handspring_device);
706 usb_serial_deregister(&clie_3_5_device);
707 usb_serial_deregister(&clie_5_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
709
710
711module_init(visor_init);
712module_exit(visor_exit);
713
Alan Coxd60d4392008-07-22 11:12:15 +0100714MODULE_AUTHOR(DRIVER_AUTHOR);
715MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716MODULE_LICENSE("GPL");
717
718module_param(debug, bool, S_IRUGO | S_IWUSR);
719MODULE_PARM_DESC(debug, "Debug enabled or not");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721module_param(vendor, ushort, 0);
722MODULE_PARM_DESC(vendor, "User specified vendor ID");
723module_param(product, ushort, 0);
724MODULE_PARM_DESC(product, "User specified product ID");
725