blob: f253c91383dacf1dfa4b89da4700dc946301d059 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB HandSpring Visor, Palm m50x, and Sony Clie driver
3 * (supports all of the Palm OS USB devices)
4 *
5 * Copyright (C) 1999 - 2004
6 * Greg Kroah-Hartman (greg@kroah.com)
7 *
Greg Kroah-Hartman4d0dce32007-06-12 11:43:37 -07008 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
Alan Coxd60d4392008-07-22 11:12:15 +010012 * See Documentation/usb/usb-serial.txt for more information on using this
13 * driver
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/kernel.h>
18#include <linux/errno.h>
19#include <linux/init.h>
20#include <linux/slab.h>
21#include <linux/tty.h>
22#include <linux/tty_driver.h>
23#include <linux/tty_flip.h>
24#include <linux/module.h>
25#include <linux/moduleparam.h>
26#include <linux/spinlock.h>
Alan Coxd60d4392008-07-22 11:12:15 +010027#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/usb.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070029#include <linux/usb/serial.h>
Maciej Szmigieroacb52cb2011-02-07 12:42:36 +010030#include <linux/usb/cdc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "visor.h"
32
33/*
34 * Version Information
35 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
37#define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
38
39/* function prototypes for a handspring visor */
Alan Coxa509a7e2009-09-19 13:13:26 -070040static int visor_open(struct tty_struct *tty, struct usb_serial_port *port);
Alan Cox335f8512009-06-11 12:26:29 +010041static void visor_close(struct usb_serial_port *port);
Alan Coxd60d4392008-07-22 11:12:15 +010042static int visor_probe(struct usb_serial *serial,
43 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static int visor_calc_num_ports(struct usb_serial *serial);
Alan Coxd60d4392008-07-22 11:12:15 +010045static void visor_read_int_callback(struct urb *urb);
46static int clie_3_5_startup(struct usb_serial *serial);
47static int treo_attach(struct usb_serial *serial);
48static int clie_5_attach(struct usb_serial *serial);
49static int palm_os_3_probe(struct usb_serial *serial,
50 const struct usb_device_id *id);
51static int palm_os_4_probe(struct usb_serial *serial,
52 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/* Parameters that may be passed into the module. */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103055static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57static struct usb_device_id id_table [] = {
58 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
59 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
60 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
61 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
62 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
63 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Hendrik Schweppe04d52462006-02-19 19:00:04 +010064 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
68 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -070082 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Maximilian Attemsc8ba84a2007-08-04 10:19:41 +0200100 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100102 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100104 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700106 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Alan Coxd60d4392008-07-22 11:12:15 +0100108 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
113 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
114 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 { } /* Terminating entry */
117};
118
119static struct usb_device_id clie_id_5_table [] = {
120 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
121 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 { } /* Terminating entry */
123};
124
125static struct usb_device_id clie_id_3_5_table [] = {
126 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
127 { } /* Terminating entry */
128};
129
130static struct usb_device_id id_table_combined [] = {
131 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
132 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
133 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
Hendrik Schweppe04d52462006-02-19 19:00:04 +0100134 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
136 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
137 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
138 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
142 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
gregkh@suse.deac21e9f2005-04-18 17:39:20 -0700143 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
146 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
147 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
148 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
149 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
150 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
151 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
152 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
153 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
154 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
155 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
Larry Battraw115c1ce2005-04-18 17:39:20 -0700156 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
158 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
159 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
160 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 { } /* Terminating entry */
162};
163
Alan Coxd60d4392008-07-22 11:12:15 +0100164MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Alan Coxd60d4392008-07-22 11:12:15 +0100166/* All of the device info needed for the Handspring Visor,
167 and Palm 4.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700168static struct usb_serial_driver handspring_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700169 .driver = {
170 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700171 .name = "visor",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700172 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700173 .description = "Handspring Visor / Palm OS",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 .id_table = id_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200176 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 .open = visor_open,
178 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200179 .throttle = usb_serial_generic_throttle,
180 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 .attach = treo_attach,
182 .probe = visor_probe,
183 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 .read_int_callback = visor_read_int_callback,
185};
186
187/* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700188static struct usb_serial_driver clie_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700189 .driver = {
190 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700191 .name = "clie_5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700192 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700193 .description = "Sony Clie 5.0",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 .id_table = clie_id_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 .num_ports = 2,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200196 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 .open = visor_open,
198 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200199 .throttle = usb_serial_generic_throttle,
200 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 .attach = clie_5_attach,
202 .probe = visor_probe,
203 .calc_num_ports = visor_calc_num_ports,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 .read_int_callback = visor_read_int_callback,
205};
206
207/* device info for the Sony Clie OS version 3.5 */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700208static struct usb_serial_driver clie_3_5_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700209 .driver = {
210 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700211 .name = "clie_3.5",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700212 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700213 .description = "Sony Clie 3.5",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 .id_table = clie_id_3_5_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 .num_ports = 1,
Johan Hovold9a1f2982010-05-16 15:06:55 +0200216 .bulk_out_size = 256,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 .open = visor_open,
218 .close = visor_close,
Johan Hovold214916f2010-05-15 17:53:49 +0200219 .throttle = usb_serial_generic_throttle,
220 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 .attach = clie_3_5_startup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222};
223
Alan Stern29618e92012-02-23 14:57:32 -0500224static struct usb_serial_driver * const serial_drivers[] = {
225 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
226};
227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228/******************************************************************************
229 * Handspring Visor specific driver functions
230 ******************************************************************************/
Alan Coxa509a7e2009-09-19 13:13:26 -0700231static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 int result = 0;
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 if (!port->read_urb) {
236 /* this is needed for some brain dead Sony devices */
237 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
238 return -ENODEV;
239 }
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 /* Start reading from the device */
Johan Hovold214916f2010-05-15 17:53:49 +0200242 result = usb_serial_generic_open(tty, port);
243 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 goto exit;
Alan Coxd60d4392008-07-22 11:12:15 +0100245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 if (port->interrupt_in_urb) {
Greg Kroah-Hartman4d9b4002012-05-03 16:40:45 -0700247 dev_dbg(&port->dev, "adding interrupt input for treo\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
249 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100250 dev_err(&port->dev,
251 "%s - failed submitting interrupt urb, error %d\n",
252 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 }
Alan Coxd60d4392008-07-22 11:12:15 +0100254exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 return result;
256}
257
258
Alan Cox335f8512009-06-11 12:26:29 +0100259static void visor_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 unsigned char *transfer_buffer;
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 /* shutdown our urbs */
Johan Hovold214916f2010-05-15 17:53:49 +0200264 usb_serial_generic_close(port);
Mariusz Kozlowskibcb54a52006-11-08 15:36:55 +0100265 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100267 mutex_lock(&port->serial->disc_mutex);
268 if (!port->serial->disconnected) {
269 /* Try to send shutdown message, unless the device is gone */
Alan Coxd60d4392008-07-22 11:12:15 +0100270 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100271 if (transfer_buffer) {
Alan Coxd60d4392008-07-22 11:12:15 +0100272 usb_control_msg(port->serial->dev,
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100273 usb_rcvctrlpipe(port->serial->dev, 0),
274 VISOR_CLOSE_NOTIFICATION, 0xc2,
275 0x0000, 0x0000,
276 transfer_buffer, 0x12, 300);
Alan Coxd60d4392008-07-22 11:12:15 +0100277 kfree(transfer_buffer);
Oliver Neukume33fe4d2008-01-21 17:44:10 +0100278 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 }
Oliver Neukum95bef012008-01-22 13:56:18 +0100280 mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282
Alan Coxd60d4392008-07-22 11:12:15 +0100283static void visor_read_int_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
Ming Leicdc97792008-02-24 18:41:47 +0800285 struct usb_serial_port *port = urb->context;
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700286 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 int result;
288
Greg Kroah-Hartman38e8c912007-06-15 15:44:13 -0700289 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 case 0:
291 /* success */
292 break;
293 case -ECONNRESET:
294 case -ENOENT:
295 case -ESHUTDOWN:
296 /* this urb is terminated, clean up */
Greg Kroah-Hartman4d9b4002012-05-03 16:40:45 -0700297 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
298 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 return;
300 default:
Greg Kroah-Hartman4d9b4002012-05-03 16:40:45 -0700301 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
302 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 goto exit;
304 }
305
306 /*
307 * This information is still unknown what it can be used for.
308 * If anyone has an idea, please let the author know...
309 *
310 * Rumor has it this endpoint is used to notify when data
311 * is ready to be read from the bulk ones.
312 */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800313 usb_serial_debug_data(debug, &port->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 urb->actual_length, urb->transfer_buffer);
315
316exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100317 result = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 if (result)
Alan Coxd60d4392008-07-22 11:12:15 +0100319 dev_err(&urb->dev->dev,
320 "%s - Error %d submitting interrupt urb\n",
321 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322}
323
Alan Coxd60d4392008-07-22 11:12:15 +0100324static int palm_os_3_probe(struct usb_serial *serial,
325 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326{
327 struct device *dev = &serial->dev->dev;
328 struct visor_connection_info *connection_info;
329 unsigned char *transfer_buffer;
330 char *string;
331 int retval = 0;
332 int i;
333 int num_ports = 0;
334
Alan Coxd60d4392008-07-22 11:12:15 +0100335 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800337 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 sizeof(*connection_info));
339 return -ENOMEM;
340 }
341
342 /* send a get connection info request */
Alan Coxd60d4392008-07-22 11:12:15 +0100343 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 usb_rcvctrlpipe(serial->dev, 0),
345 VISOR_GET_CONNECTION_INFORMATION,
346 0xc2, 0x0000, 0x0000, transfer_buffer,
347 sizeof(*connection_info), 300);
348 if (retval < 0) {
349 dev_err(dev, "%s - error %d getting connection information\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800350 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 goto exit;
352 }
353
354 if (retval == sizeof(*connection_info)) {
Alan Coxd60d4392008-07-22 11:12:15 +0100355 connection_info = (struct visor_connection_info *)
356 transfer_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
358 num_ports = le16_to_cpu(connection_info->num_ports);
359 for (i = 0; i < num_ports; ++i) {
Alan Coxd60d4392008-07-22 11:12:15 +0100360 switch (
361 connection_info->connections[i].port_function_id) {
362 case VISOR_FUNCTION_GENERIC:
363 string = "Generic";
364 break;
365 case VISOR_FUNCTION_DEBUGGER:
366 string = "Debugger";
367 break;
368 case VISOR_FUNCTION_HOTSYNC:
369 string = "HotSync";
370 break;
371 case VISOR_FUNCTION_CONSOLE:
372 string = "Console";
373 break;
374 case VISOR_FUNCTION_REMOTE_FILE_SYS:
375 string = "Remote File System";
376 break;
377 default:
378 string = "unknown";
379 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 }
381 dev_info(dev, "%s: port %d, is for %s use\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700382 serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 connection_info->connections[i].port, string);
384 }
385 }
386 /*
387 * Handle devices that report invalid stuff here.
388 */
389 if (num_ports == 0 || num_ports > 2) {
Alan Coxd60d4392008-07-22 11:12:15 +0100390 dev_warn(dev, "%s: No valid connect info available\n",
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700391 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 num_ports = 2;
393 }
Alan Coxd60d4392008-07-22 11:12:15 +0100394
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700395 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 num_ports);
397
398 /*
399 * save off our num_ports info so that we can use it in the
400 * calc_num_ports callback
401 */
402 usb_set_serial_data(serial, (void *)(long)num_ports);
403
Alan Coxd60d4392008-07-22 11:12:15 +0100404 /* ask for the number of bytes available, but ignore the
405 response as it is broken */
406 retval = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 usb_rcvctrlpipe(serial->dev, 0),
408 VISOR_REQUEST_BYTES_AVAILABLE,
409 0xc2, 0x0000, 0x0005, transfer_buffer,
410 0x02, 300);
411 if (retval < 0)
412 dev_err(dev, "%s - error %d getting bytes available request\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800413 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 retval = 0;
415
416exit:
Alan Coxd60d4392008-07-22 11:12:15 +0100417 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419 return retval;
420}
421
Alan Coxd60d4392008-07-22 11:12:15 +0100422static int palm_os_4_probe(struct usb_serial *serial,
423 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
425 struct device *dev = &serial->dev->dev;
426 struct palm_ext_connection_info *connection_info;
427 unsigned char *transfer_buffer;
428 int retval;
429
Alan Coxd60d4392008-07-22 11:12:15 +0100430 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 if (!transfer_buffer) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800432 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 sizeof(*connection_info));
434 return -ENOMEM;
435 }
436
Alan Coxd60d4392008-07-22 11:12:15 +0100437 retval = usb_control_msg(serial->dev,
438 usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 PALM_GET_EXT_CONNECTION_INFORMATION,
440 0xc2, 0x0000, 0x0000, transfer_buffer,
Alan Coxd60d4392008-07-22 11:12:15 +0100441 sizeof(*connection_info), 300);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 if (retval < 0)
443 dev_err(dev, "%s - error %d getting connection info\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800444 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 else
Harvey Harrison441b62c2008-03-03 16:08:34 -0800446 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 retval, transfer_buffer);
448
Alan Coxd60d4392008-07-22 11:12:15 +0100449 kfree(transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 return 0;
451}
452
453
Alan Coxd60d4392008-07-22 11:12:15 +0100454static int visor_probe(struct usb_serial *serial,
455 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 int retval = 0;
Alan Coxd60d4392008-07-22 11:12:15 +0100458 int (*startup)(struct usb_serial *serial,
459 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Maciej Szmigieroacb52cb2011-02-07 12:42:36 +0100461 /*
462 * some Samsung Android phones in modem mode have the same ID
463 * as SPH-I500, but they are ACM devices, so dont bind to them
464 */
465 if (id->idVendor == SAMSUNG_VENDOR_ID &&
466 id->idProduct == SAMSUNG_SPH_I500_ID &&
467 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
468 serial->dev->descriptor.bDeviceSubClass ==
469 USB_CDC_SUBCLASS_ACM)
470 return -ENODEV;
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700473 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 serial->dev->actconfig->desc.bConfigurationValue);
475 return -ENODEV;
476 }
477
478 if (id->driver_info) {
479 startup = (void *)id->driver_info;
480 retval = startup(serial, id);
481 }
482
483 return retval;
484}
485
Alan Coxd60d4392008-07-22 11:12:15 +0100486static int visor_calc_num_ports(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487{
488 int num_ports = (int)(long)(usb_get_serial_data(serial));
489
490 if (num_ports)
491 usb_set_serial_data(serial, NULL);
492
493 return num_ports;
494}
495
Alan Coxd60d4392008-07-22 11:12:15 +0100496static int clie_3_5_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 struct device *dev = &serial->dev->dev;
499 int result;
Johan Hovold401711c2009-12-28 23:01:57 +0100500 u8 *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Johan Hovold401711c2009-12-28 23:01:57 +0100502 data = kmalloc(1, GFP_KERNEL);
503 if (!data)
504 return -ENOMEM;
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 /*
507 * Note that PEG-300 series devices expect the following two calls.
508 */
509
510 /* get the config number */
Alan Coxd60d4392008-07-22 11:12:15 +0100511 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
Johan Hovold401711c2009-12-28 23:01:57 +0100513 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100515 dev_err(dev, "%s: get config number failed: %d\n",
516 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100517 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 }
519 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100520 dev_err(dev, "%s: get config number bad return length: %d\n",
521 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100522 result = -EIO;
523 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 }
525
526 /* get the interface number */
Alan Coxd60d4392008-07-22 11:12:15 +0100527 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
528 USB_REQ_GET_INTERFACE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 USB_DIR_IN | USB_RECIP_INTERFACE,
Johan Hovold401711c2009-12-28 23:01:57 +0100530 0, 0, data, 1, 3000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 if (result < 0) {
Alan Coxd60d4392008-07-22 11:12:15 +0100532 dev_err(dev, "%s: get interface number failed: %d\n",
533 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100534 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 }
536 if (result != 1) {
Alan Coxd60d4392008-07-22 11:12:15 +0100537 dev_err(dev,
538 "%s: get interface number bad return length: %d\n",
539 __func__, result);
Johan Hovold401711c2009-12-28 23:01:57 +0100540 result = -EIO;
541 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 }
543
Johan Hovold214916f2010-05-15 17:53:49 +0200544 result = 0;
Johan Hovold401711c2009-12-28 23:01:57 +0100545out:
546 kfree(data);
547
548 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
Alan Coxd60d4392008-07-22 11:12:15 +0100550
551static int treo_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
553 struct usb_serial_port *swap_port;
554
555 /* Only do this endpoint hack for the Handspring devices with
556 * interrupt in endpoints, which for now are the Treo devices. */
Alan Coxd60d4392008-07-22 11:12:15 +0100557 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
558 == HANDSPRING_VENDOR_ID) ||
559 (le16_to_cpu(serial->dev->descriptor.idVendor)
560 == KYOCERA_VENDOR_ID)) ||
561 (serial->num_interrupt_in == 0))
Johan Hovold214916f2010-05-15 17:53:49 +0200562 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 /*
Alan Coxd60d4392008-07-22 11:12:15 +0100565 * It appears that Treos and Kyoceras want to use the
566 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
567 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
568 * Note that swapping the bulk out endpoints would break lots of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 * apps that want to communicate on the second port.
570 */
571#define COPY_PORT(dest, src) \
Alan Coxd60d4392008-07-22 11:12:15 +0100572 do { \
573 dest->read_urb = src->read_urb; \
574 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
575 dest->bulk_in_buffer = src->bulk_in_buffer; \
576 dest->interrupt_in_urb = src->interrupt_in_urb; \
577 dest->interrupt_in_endpointAddress = \
578 src->interrupt_in_endpointAddress;\
579 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
580 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
582 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
583 if (!swap_port)
584 return -ENOMEM;
585 COPY_PORT(swap_port, serial->port[0]);
586 COPY_PORT(serial->port[0], serial->port[1]);
587 COPY_PORT(serial->port[1], swap_port);
588 kfree(swap_port);
589
Johan Hovold214916f2010-05-15 17:53:49 +0200590 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
Alan Coxd60d4392008-07-22 11:12:15 +0100593static int clie_5_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200595 struct usb_serial_port *port;
596 unsigned int pipe;
597 int j;
598
Alan Coxd60d4392008-07-22 11:12:15 +0100599 /* TH55 registers 2 ports.
600 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
601 from port 0. Communication out to the UX50/TH55 uses
602 bulk_out_endpointAddress from port 1
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 Lets do a quick and dirty mapping
605 */
Alan Coxd60d4392008-07-22 11:12:15 +0100606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 /* some sanity check */
608 if (serial->num_ports < 2)
609 return -1;
Alan Coxd60d4392008-07-22 11:12:15 +0100610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 /* port 0 now uses the modified endpoint Address */
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200612 port = serial->port[0];
613 port->bulk_out_endpointAddress =
Alan Coxd60d4392008-07-22 11:12:15 +0100614 serial->port[1]->bulk_out_endpointAddress;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Johan Hovoldcfb8da82010-10-12 01:07:05 +0200616 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
617 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
618 port->write_urbs[j]->pipe = pipe;
619
Johan Hovold214916f2010-05-15 17:53:49 +0200620 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621}
622
Greg Kroah-Hartman68e24112012-05-08 15:46:14 -0700623module_usb_serial_driver(serial_drivers, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Alan Coxd60d4392008-07-22 11:12:15 +0100625MODULE_AUTHOR(DRIVER_AUTHOR);
626MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627MODULE_LICENSE("GPL");
628
629module_param(debug, bool, S_IRUGO | S_IWUSR);
630MODULE_PARM_DESC(debug, "Debug enabled or not");