xref: /linux/drivers/usb/host/sl811_cs.c (revision de2fe5e07d58424bc286fff3fd3c1b0bf933cd58)
1 /*
2  * PCMCIA driver for SL811HS (as found in REX-CFU1U)
3  * Filename: sl811_cs.c
4  * Author:   Yukio Yamamoto
5  *
6  *  Port to sl811-hcd and 2.6.x by
7  *    Botond Botyanszki <boti@rocketmail.com>
8  *    Simon Pickering
9  *
10  *  Last update: 2005-05-12
11  */
12 
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/sched.h>
17 #include <linux/ptrace.h>
18 #include <linux/slab.h>
19 #include <linux/string.h>
20 #include <linux/timer.h>
21 #include <linux/ioport.h>
22 #include <linux/platform_device.h>
23 
24 #include <pcmcia/cs_types.h>
25 #include <pcmcia/cs.h>
26 #include <pcmcia/cistpl.h>
27 #include <pcmcia/cisreg.h>
28 #include <pcmcia/ds.h>
29 
30 #include <linux/usb_sl811.h>
31 
32 MODULE_AUTHOR("Botond Botyanszki");
33 MODULE_DESCRIPTION("REX-CFU1U PCMCIA driver for 2.6");
34 MODULE_LICENSE("GPL");
35 
36 
37 /*====================================================================*/
38 /* MACROS                                                             */
39 /*====================================================================*/
40 
41 #if defined(DEBUG) || defined(PCMCIA_DEBUG)
42 
43 static int pc_debug = 0;
44 module_param(pc_debug, int, 0644);
45 
46 #define DBG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG "sl811_cs: " args)
47 
48 #else
49 #define DBG(n, args...) do{}while(0)
50 #endif	/* no debugging */
51 
52 #define INFO(args...) printk(KERN_INFO "sl811_cs: " args)
53 
54 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
55 
56 #define CS_CHECK(fn, ret) \
57 	do { \
58 		last_fn = (fn); \
59 		if ((last_ret = (ret)) != 0) \
60 			goto cs_failed; \
61 	} while (0)
62 
63 /*====================================================================*/
64 /* VARIABLES                                                          */
65 /*====================================================================*/
66 
67 static const char driver_name[DEV_NAME_LEN]  = "sl811_cs";
68 
69 typedef struct local_info_t {
70 	dev_link_t		link;
71 	dev_node_t		node;
72 } local_info_t;
73 
74 static void sl811_cs_release(dev_link_t * link);
75 
76 /*====================================================================*/
77 
78 static void release_platform_dev(struct device * dev)
79 {
80 	DBG(0, "sl811_cs platform_dev release\n");
81 	dev->parent = NULL;
82 }
83 
84 static struct sl811_platform_data platform_data = {
85 	.potpg		= 100,
86 	.power		= 50,		/* == 100mA */
87 	// .reset	= ... FIXME:  invoke CF reset on the card
88 };
89 
90 static struct resource resources[] = {
91 	[0] = {
92 		.flags	= IORESOURCE_IRQ,
93 	},
94 	[1] = {
95 		// .name   = "address",
96 		.flags	= IORESOURCE_IO,
97 	},
98 	[2] = {
99 		// .name   = "data",
100 		.flags	= IORESOURCE_IO,
101 	},
102 };
103 
104 extern struct platform_driver sl811h_driver;
105 
106 static struct platform_device platform_dev = {
107 	.id			= -1,
108 	.dev = {
109 		.platform_data = &platform_data,
110 		.release       = release_platform_dev,
111 	},
112 	.resource		= resources,
113 	.num_resources		= ARRAY_SIZE(resources),
114 };
115 
116 static int sl811_hc_init(struct device *parent, ioaddr_t base_addr, int irq)
117 {
118 	if (platform_dev.dev.parent)
119 		return -EBUSY;
120 	platform_dev.dev.parent = parent;
121 
122 	/* finish seting up the platform device */
123 	resources[0].start = irq;
124 
125 	resources[1].start = base_addr;
126 	resources[1].end = base_addr;
127 
128 	resources[2].start = base_addr + 1;
129 	resources[2].end   = base_addr + 1;
130 
131 	/* The driver core will probe for us.  We know sl811-hcd has been
132 	 * initialized already because of the link order dependency created
133 	 * by referencing "sl811h_driver".
134 	 */
135 	platform_dev.name = sl811h_driver.driver.name;
136 	return platform_device_register(&platform_dev);
137 }
138 
139 /*====================================================================*/
140 
141 static void sl811_cs_detach(struct pcmcia_device *p_dev)
142 {
143 	dev_link_t *link = dev_to_instance(p_dev);
144 
145 	DBG(0, "sl811_cs_detach(0x%p)\n", link);
146 
147 	link->state &= ~DEV_PRESENT;
148 	if (link->state & DEV_CONFIG)
149 		sl811_cs_release(link);
150 
151 	/* This points to the parent local_info_t struct */
152 	kfree(link->priv);
153 }
154 
155 static void sl811_cs_release(dev_link_t * link)
156 {
157 
158 	DBG(0, "sl811_cs_release(0x%p)\n", link);
159 
160 	/* Unlink the device chain */
161 	link->dev = NULL;
162 
163 	platform_device_unregister(&platform_dev);
164 	pcmcia_release_configuration(link->handle);
165 	if (link->io.NumPorts1)
166 		pcmcia_release_io(link->handle, &link->io);
167 	if (link->irq.AssignedIRQ)
168 		pcmcia_release_irq(link->handle, &link->irq);
169 	link->state &= ~DEV_CONFIG;
170 }
171 
172 static void sl811_cs_config(dev_link_t *link)
173 {
174 	client_handle_t		handle = link->handle;
175 	struct device		*parent = &handle_to_dev(handle);
176 	local_info_t		*dev = link->priv;
177 	tuple_t			tuple;
178 	cisparse_t		parse;
179 	int			last_fn, last_ret;
180 	u_char			buf[64];
181 	config_info_t		conf;
182 	cistpl_cftable_entry_t	dflt = { 0 };
183 
184 	DBG(0, "sl811_cs_config(0x%p)\n", link);
185 
186 	tuple.DesiredTuple = CISTPL_CONFIG;
187 	tuple.Attributes = 0;
188 	tuple.TupleData = buf;
189 	tuple.TupleDataMax = sizeof(buf);
190 	tuple.TupleOffset = 0;
191 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
192 	CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
193 	CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
194 	link->conf.ConfigBase = parse.config.base;
195 	link->conf.Present = parse.config.rmask[0];
196 
197 	/* Configure card */
198 	link->state |= DEV_CONFIG;
199 
200 	/* Look up the current Vcc */
201 	CS_CHECK(GetConfigurationInfo,
202 			pcmcia_get_configuration_info(handle, &conf));
203 	link->conf.Vcc = conf.Vcc;
204 
205 	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
206 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
207 	while (1) {
208 		cistpl_cftable_entry_t	*cfg = &(parse.cftable_entry);
209 
210 		if (pcmcia_get_tuple_data(handle, &tuple) != 0
211 				|| pcmcia_parse_tuple(handle, &tuple, &parse)
212 						!= 0)
213 			goto next_entry;
214 
215 		if (cfg->flags & CISTPL_CFTABLE_DEFAULT) {
216 			dflt = *cfg;
217 		}
218 
219 		if (cfg->index == 0)
220 			goto next_entry;
221 
222 		link->conf.ConfigIndex = cfg->index;
223 
224 		/* Use power settings for Vcc and Vpp if present */
225 		/*  Note that the CIS values need to be rescaled */
226 		if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
227 			if (cfg->vcc.param[CISTPL_POWER_VNOM]/10000
228 					!= conf.Vcc)
229 				goto next_entry;
230 		} else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
231 			if (dflt.vcc.param[CISTPL_POWER_VNOM]/10000
232 					!= conf.Vcc)
233 				goto next_entry;
234 		}
235 
236 		if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
237 			link->conf.Vpp1 = link->conf.Vpp2 =
238 				cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
239 		else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
240 			link->conf.Vpp1 = link->conf.Vpp2 =
241 				dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
242 
243 		/* we need an interrupt */
244 		if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
245 			link->conf.Attributes |= CONF_ENABLE_IRQ;
246 
247 		/* IO window settings */
248 		link->io.NumPorts1 = link->io.NumPorts2 = 0;
249 		if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
250 			cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
251 
252 			link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
253 			link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
254 			link->io.BasePort1 = io->win[0].base;
255 			link->io.NumPorts1 = io->win[0].len;
256 
257 			if (pcmcia_request_io(link->handle, &link->io) != 0)
258 				goto next_entry;
259 		}
260 		break;
261 
262 next_entry:
263 		if (link->io.NumPorts1)
264 			pcmcia_release_io(link->handle, &link->io);
265 		last_ret = pcmcia_get_next_tuple(handle, &tuple);
266 	}
267 
268 	/* require an IRQ and two registers */
269 	if (!link->io.NumPorts1 || link->io.NumPorts1 < 2)
270 		goto cs_failed;
271 	if (link->conf.Attributes & CONF_ENABLE_IRQ)
272 		CS_CHECK(RequestIRQ,
273 			pcmcia_request_irq(link->handle, &link->irq));
274 	else
275 		goto cs_failed;
276 
277 	CS_CHECK(RequestConfiguration,
278 		pcmcia_request_configuration(link->handle, &link->conf));
279 
280 	sprintf(dev->node.dev_name, driver_name);
281 	dev->node.major = dev->node.minor = 0;
282 	link->dev = &dev->node;
283 
284 	printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
285 	       dev->node.dev_name, link->conf.ConfigIndex,
286 	       link->conf.Vcc/10, link->conf.Vcc%10);
287 	if (link->conf.Vpp1)
288 		printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
289 	printk(", irq %d", link->irq.AssignedIRQ);
290 	printk(", io 0x%04x-0x%04x", link->io.BasePort1,
291 	       link->io.BasePort1+link->io.NumPorts1-1);
292 	printk("\n");
293 
294 	link->state &= ~DEV_CONFIG_PENDING;
295 
296 	if (sl811_hc_init(parent, link->io.BasePort1, link->irq.AssignedIRQ)
297 			< 0) {
298 cs_failed:
299 		printk("sl811_cs_config failed\n");
300 		cs_error(link->handle, last_fn, last_ret);
301 		sl811_cs_release(link);
302 		link->state &= ~DEV_CONFIG_PENDING;
303 	}
304 }
305 
306 static int sl811_suspend(struct pcmcia_device *dev)
307 {
308 	dev_link_t *link = dev_to_instance(dev);
309 
310 	link->state |= DEV_SUSPEND;
311 	if (link->state & DEV_CONFIG)
312 		pcmcia_release_configuration(link->handle);
313 
314 	return 0;
315 }
316 
317 static int sl811_resume(struct pcmcia_device *dev)
318 {
319 	dev_link_t *link = dev_to_instance(dev);
320 
321 	link->state &= ~DEV_SUSPEND;
322 	if (link->state & DEV_CONFIG)
323 		pcmcia_request_configuration(link->handle, &link->conf);
324 
325 	return 0;
326 }
327 
328 static int sl811_cs_attach(struct pcmcia_device *p_dev)
329 {
330 	local_info_t *local;
331 	dev_link_t *link;
332 
333 	local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
334 	if (!local)
335 		return -ENOMEM;
336 	memset(local, 0, sizeof(local_info_t));
337 	link = &local->link;
338 	link->priv = local;
339 
340 	/* Initialize */
341 	link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
342 	link->irq.IRQInfo1 = IRQ_INFO2_VALID|IRQ_LEVEL_ID;
343 	link->irq.Handler = NULL;
344 
345 	link->conf.Attributes = 0;
346 	link->conf.Vcc = 33;
347 	link->conf.IntType = INT_MEMORY_AND_IO;
348 
349 	link->handle = p_dev;
350 	p_dev->instance = link;
351 
352 	link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
353 	sl811_cs_config(link);
354 
355 	return 0;
356 }
357 
358 static struct pcmcia_device_id sl811_ids[] = {
359 	PCMCIA_DEVICE_MANF_CARD(0xc015, 0x0001), /* RATOC USB HOST CF+ Card */
360 	PCMCIA_DEVICE_NULL,
361 };
362 MODULE_DEVICE_TABLE(pcmcia, sl811_ids);
363 
364 static struct pcmcia_driver sl811_cs_driver = {
365 	.owner		= THIS_MODULE,
366 	.drv		= {
367 		.name	= (char *)driver_name,
368 	},
369 	.probe		= sl811_cs_attach,
370 	.remove		= sl811_cs_detach,
371 	.id_table	= sl811_ids,
372 	.suspend	= sl811_suspend,
373 	.resume		= sl811_resume,
374 };
375 
376 /*====================================================================*/
377 
378 static int __init init_sl811_cs(void)
379 {
380 	return pcmcia_register_driver(&sl811_cs_driver);
381 }
382 module_init(init_sl811_cs);
383 
384 static void __exit exit_sl811_cs(void)
385 {
386 	pcmcia_unregister_driver(&sl811_cs_driver);
387 }
388 module_exit(exit_sl811_cs);
389