[linux-2.6-block.git] / drivers / tty / serial / of_serial.c

/*
 *  Serial Port driver for Open Firmware platform devices
 *
 *    Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>, IBM Corp.
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 */
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/serial_core.h>
#include <linux/serial_8250.h>
#include <linux/of_address.h>
#include <linux/of_irq.h>
#include <linux/of_platform.h>
#include <linux/nwpserial.h>

struct of_serial_info {
	int type;
	int line;
};

/*
 * Fill a struct uart_port for a given device node
 */
static int __devinit of_platform_serial_setup(struct platform_device *ofdev,
					int type, struct uart_port *port)
{
	struct resource resource;
	struct device_node *np = ofdev->dev.of_node;
	const __be32 *clk, *spd;
	const __be32 *prop;
	int ret, prop_size;

	memset(port, 0, sizeof *port);
	spd = of_get_property(np, "current-speed", NULL);
	clk = of_get_property(np, "clock-frequency", NULL);
	if (!clk) {
		dev_warn(&ofdev->dev, "no clock-frequency property set\n");
		return -ENODEV;
	}

	ret = of_address_to_resource(np, 0, &resource);
	if (ret) {
		dev_warn(&ofdev->dev, "invalid address\n");
		return ret;
	}

	spin_lock_init(&port->lock);
	port->mapbase = resource.start;

	/* Check for shifted address mapping */
	prop = of_get_property(np, "reg-offset", &prop_size);
	if (prop && (prop_size == sizeof(u32)))
		port->mapbase += be32_to_cpup(prop);

	/* Check for registers offset within the devices address range */
	prop = of_get_property(np, "reg-shift", &prop_size);
	if (prop && (prop_size == sizeof(u32)))
		port->regshift = be32_to_cpup(prop);

	port->irq = irq_of_parse_and_map(np, 0);
	port->iotype = UPIO_MEM;
	port->type = type;
	port->uartclk = be32_to_cpup(clk);
	port->flags = UPF_SHARE_IRQ | UPF_BOOT_AUTOCONF | UPF_IOREMAP
		| UPF_FIXED_PORT | UPF_FIXED_TYPE;
	port->dev = &ofdev->dev;
	/* If current-speed was set, then try not to change it. */
	if (spd)
		port->custom_divisor = be32_to_cpup(clk) / (16 * (be32_to_cpup(spd)));

	return 0;
}

/*
 * Try to register a serial port
 */
static int __devinit of_platform_serial_probe(struct platform_device *ofdev)
{
	struct of_serial_info *info;
	struct uart_port port;
	int port_type;
	int ret;

	if (!ofdev->dev.of_match)
		return -EINVAL;

	if (of_find_property(ofdev->dev.of_node, "used-by-rtas", NULL))
		return -EBUSY;

	info = kmalloc(sizeof(*info), GFP_KERNEL);
	if (info == NULL)
		return -ENOMEM;

	port_type = (unsigned long)ofdev->dev.of_match->data;
	ret = of_platform_serial_setup(ofdev, port_type, &port);
	if (ret)
		goto out;

	switch (port_type) {
#ifdef CONFIG_SERIAL_8250
	case PORT_8250 ... PORT_MAX_8250:
		ret = serial8250_register_port(&port);
		break;
#endif
#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	case PORT_NWPSERIAL:
		ret = nwpserial_register_port(&port);
		break;
#endif
	default:
		/* need to add code for these */
	case PORT_UNKNOWN:
		dev_info(&ofdev->dev, "Unknown serial port found, ignored\n");
		ret = -ENODEV;
		break;
	}
	if (ret < 0)
		goto out;

	info->type = port_type;
	info->line = ret;
	dev_set_drvdata(&ofdev->dev, info);
	return 0;
out:
	kfree(info);
	irq_dispose_mapping(port.irq);
	return ret;
}

/*
 * Release a line
 */
static int of_platform_serial_remove(struct platform_device *ofdev)
{
	struct of_serial_info *info = dev_get_drvdata(&ofdev->dev);
	switch (info->type) {
#ifdef CONFIG_SERIAL_8250
	case PORT_8250 ... PORT_MAX_8250:
		serial8250_unregister_port(info->line);
		break;
#endif
#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	case PORT_NWPSERIAL:
		nwpserial_unregister_port(info->line);
		break;
#endif
	default:
		/* need to add code for these */
		break;
	}
	kfree(info);
	return 0;
}

/*
 * A few common types, add more as needed.
 */
static struct of_device_id __devinitdata of_platform_serial_table[] = {
	{ .compatible = "ns8250",   .data = (void *)PORT_8250, },
	{ .compatible = "ns16450",  .data = (void *)PORT_16450, },
	{ .compatible = "ns16550a", .data = (void *)PORT_16550A, },
	{ .compatible = "ns16550",  .data = (void *)PORT_16550, },
	{ .compatible = "ns16750",  .data = (void *)PORT_16750, },
	{ .compatible = "ns16850",  .data = (void *)PORT_16850, },
#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	{ .compatible = "ibm,qpace-nwp-serial",
		.data = (void *)PORT_NWPSERIAL, },
#endif
	{ .type = "serial",         .data = (void *)PORT_UNKNOWN, },
	{ /* end of list */ },
};

static struct platform_driver of_platform_serial_driver = {
	.driver = {
		.name = "of_serial",
		.owner = THIS_MODULE,
		.of_match_table = of_platform_serial_table,
	},
	.probe = of_platform_serial_probe,
	.remove = of_platform_serial_remove,
};

static int __init of_platform_serial_init(void)
{
	return platform_driver_register(&of_platform_serial_driver);
}
module_init(of_platform_serial_init);

static void __exit of_platform_serial_exit(void)
{
	return platform_driver_unregister(&of_platform_serial_driver);
};
module_exit(of_platform_serial_exit);

MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("Serial Port driver for Open Firmware platform devices");
Commit	Line	Data
8d38a5b2 AB	1	/*
	2	* Serial Port driver for Open Firmware platform devices
	3	*
	4	* Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>, IBM Corp.
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License
	8	* as published by the Free Software Foundation; either version
	9	* 2 of the License, or (at your option) any later version.
	10	*
	11	*/
	12	#include <linux/init.h>
	13	#include <linux/module.h>
5a0e3ad6	14	#include <linux/slab.h>
8d38a5b2 AB	15	#include <linux/serial_core.h>
8d38a5b2 AB	16	#include <linux/serial_8250.h>
f1ca09b2	17	#include <linux/of_address.h>
73930a85	18	#include <linux/of_irq.h>
c401b044	19	#include <linux/of_platform.h>
5886188d	20	#include <linux/nwpserial.h>
8d38a5b2	21
e34b9c94 IK	22	struct of_serial_info {
	23	int type;
	24	int line;
	25	};
	26
8d38a5b2 AB	27	/*
	28	* Fill a struct uart_port for a given device node
	29	*/
2dc11581	30	static int __devinit of_platform_serial_setup(struct platform_device *ofdev,
8d38a5b2 AB	31	int type, struct uart_port *port)
	32	{
	33	struct resource resource;
61c7a080	34	struct device_node *np = ofdev->dev.of_node;
f14362d1 IM	35	const __be32 clk, spd;
f14362d1 IM	36	const __be32 *prop;
b912b5e2	37	int ret, prop_size;
8d38a5b2 AB	38
8d38a5b2 AB	39	memset(port, 0, sizeof *port);
40cd3a45 SR	40	spd = of_get_property(np, "current-speed", NULL);
40cd3a45 SR	41	clk = of_get_property(np, "clock-frequency", NULL);
8d38a5b2 AB	42	if (!clk) {
	43	dev_warn(&ofdev->dev, "no clock-frequency property set\n");
	44	return -ENODEV;
	45	}
	46
	47	ret = of_address_to_resource(np, 0, &resource);
	48	if (ret) {
	49	dev_warn(&ofdev->dev, "invalid address\n");
	50	return ret;
	51	}
	52
	53	spin_lock_init(&port->lock);
	54	port->mapbase = resource.start;
b912b5e2 JL	55
	56	/* Check for shifted address mapping */
	57	prop = of_get_property(np, "reg-offset", &prop_size);
	58	if (prop && (prop_size == sizeof(u32)))
f14362d1	59	port->mapbase += be32_to_cpup(prop);
b912b5e2 JL	60
	61	/* Check for registers offset within the devices address range */
	62	prop = of_get_property(np, "reg-shift", &prop_size);
	63	if (prop && (prop_size == sizeof(u32)))
f14362d1	64	port->regshift = be32_to_cpup(prop);
b912b5e2	65
8d38a5b2 AB	66	port->irq = irq_of_parse_and_map(np, 0);
	67	port->iotype = UPIO_MEM;
	68	port->type = type;
f14362d1	69	port->uartclk = be32_to_cpup(clk);
abb4a239	70	port->flags = UPF_SHARE_IRQ \| UPF_BOOT_AUTOCONF \| UPF_IOREMAP
eedacbf0	71	\| UPF_FIXED_PORT \| UPF_FIXED_TYPE;
8d38a5b2	72	port->dev = &ofdev->dev;
19a74263 SN	73	/* If current-speed was set, then try not to change it. */
19a74263 SN	74	if (spd)
f14362d1	75	port->custom_divisor = be32_to_cpup(clk) / (16 * (be32_to_cpup(spd)));
8d38a5b2 AB	76
	77	return 0;
	78	}
	79
	80	/*
	81	* Try to register a serial port
	82	*/
793218df	83	static int __devinit of_platform_serial_probe(struct platform_device *ofdev)
8d38a5b2	84	{
e34b9c94	85	struct of_serial_info *info;
8d38a5b2 AB	86	struct uart_port port;
	87	int port_type;
	88	int ret;
	89
793218df GL	90	if (!ofdev->dev.of_match)
	91	return -EINVAL;
	92
61c7a080	93	if (of_find_property(ofdev->dev.of_node, "used-by-rtas", NULL))
8d38a5b2 AB	94	return -EBUSY;
8d38a5b2 AB	95
e34b9c94 IK	96	info = kmalloc(sizeof(*info), GFP_KERNEL);
	97	if (info == NULL)
	98	return -ENOMEM;
	99
793218df	100	port_type = (unsigned long)ofdev->dev.of_match->data;
8d38a5b2 AB	101	ret = of_platform_serial_setup(ofdev, port_type, &port);
	102	if (ret)
	103	goto out;
	104
	105	switch (port_type) {
5886188d	106	#ifdef CONFIG_SERIAL_8250
8d38a5b2 AB	107	case PORT_8250 ... PORT_MAX_8250:
	108	ret = serial8250_register_port(&port);
	109	break;
5886188d BK	110	#endif
	111	#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	112	case PORT_NWPSERIAL:
	113	ret = nwpserial_register_port(&port);
	114	break;
	115	#endif
8d38a5b2 AB	116	default:
8d38a5b2 AB	117	/* need to add code for these */
1558f9b4 IK	118	case PORT_UNKNOWN:
1558f9b4 IK	119	dev_info(&ofdev->dev, "Unknown serial port found, ignored\n");
8d38a5b2 AB	120	ret = -ENODEV;
	121	break;
	122	}
	123	if (ret < 0)
	124	goto out;
	125
e34b9c94 IK	126	info->type = port_type;
e34b9c94 IK	127	info->line = ret;
3cf62a5a	128	dev_set_drvdata(&ofdev->dev, info);
8d38a5b2 AB	129	return 0;
8d38a5b2 AB	130	out:
e34b9c94	131	kfree(info);
8d38a5b2 AB	132	irq_dispose_mapping(port.irq);
	133	return ret;
	134	}
	135
	136	/*
	137	* Release a line
	138	*/
2dc11581	139	static int of_platform_serial_remove(struct platform_device *ofdev)
8d38a5b2	140	{
3cf62a5a	141	struct of_serial_info *info = dev_get_drvdata(&ofdev->dev);
e34b9c94	142	switch (info->type) {
5886188d	143	#ifdef CONFIG_SERIAL_8250
e34b9c94 IK	144	case PORT_8250 ... PORT_MAX_8250:
	145	serial8250_unregister_port(info->line);
	146	break;
5886188d BK	147	#endif
	148	#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	149	case PORT_NWPSERIAL:
	150	nwpserial_unregister_port(info->line);
	151	break;
	152	#endif
e34b9c94 IK	153	default:
	154	/* need to add code for these */
	155	break;
	156	}
	157	kfree(info);
8d38a5b2 AB	158	return 0;
	159	}
	160
	161	/*
	162	* A few common types, add more as needed.
	163	*/
	164	static struct of_device_id __devinitdata of_platform_serial_table[] = {
8c6e9112 GL	165	{ .compatible = "ns8250", .data = (void *)PORT_8250, },
	166	{ .compatible = "ns16450", .data = (void *)PORT_16450, },
	167	{ .compatible = "ns16550a", .data = (void *)PORT_16550A, },
	168	{ .compatible = "ns16550", .data = (void *)PORT_16550, },
	169	{ .compatible = "ns16750", .data = (void *)PORT_16750, },
	170	{ .compatible = "ns16850", .data = (void *)PORT_16850, },
5886188d	171	#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
8c6e9112 GL	172	{ .compatible = "ibm,qpace-nwp-serial",
8c6e9112 GL	173	.data = (void *)PORT_NWPSERIAL, },
5886188d	174	#endif
8c6e9112	175	{ .type = "serial", .data = (void *)PORT_UNKNOWN, },
8d38a5b2 AB	176	{ /* end of list */ },
	177	};
	178
793218df	179	static struct platform_driver of_platform_serial_driver = {
4018294b GL	180	.driver = {
	181	.name = "of_serial",
	182	.owner = THIS_MODULE,
	183	.of_match_table = of_platform_serial_table,
	184	},
8d38a5b2 AB	185	.probe = of_platform_serial_probe,
8d38a5b2 AB	186	.remove = of_platform_serial_remove,
8d38a5b2 AB	187	};
	188
	189	static int __init of_platform_serial_init(void)
	190	{
793218df	191	return platform_driver_register(&of_platform_serial_driver);
8d38a5b2 AB	192	}
	193	module_init(of_platform_serial_init);
	194
	195	static void __exit of_platform_serial_exit(void)
	196	{
793218df	197	return platform_driver_unregister(&of_platform_serial_driver);
8d38a5b2 AB	198	};
	199	module_exit(of_platform_serial_exit);
	200
	201	MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
	202	MODULE_LICENSE("GPL");
	203	MODULE_DESCRIPTION("Serial Port driver for Open Firmware platform devices");