[deliverable/linux.git] / drivers / 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/serial_core.h>
#include <linux/serial_8250.h>
#include <linux/of_platform.h>
#include <linux/nwpserial.h>

#include <asm/prom.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 of_device *ofdev,
					int type, struct uart_port *port)
{
	struct resource resource;
	struct device_node *np = ofdev->node;
	const unsigned int *clk, *spd;
	const u32 *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 += *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 = *prop;

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

	return 0;
}

/*
 * Try to register a serial port
 */
static int __devinit of_platform_serial_probe(struct of_device *ofdev,
						const struct of_device_id *id)
{
	struct of_serial_info *info;
	struct uart_port port;
	int port_type;
	int ret;

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

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

	port_type = (unsigned long)id->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;
	ofdev->dev.driver_data = info;
	return 0;
out:
	kfree(info);
	irq_dispose_mapping(port.irq);
	return ret;
}

/*
 * Release a line
 */
static int of_platform_serial_remove(struct of_device *ofdev)
{
	struct of_serial_info *info = ofdev->dev.driver_data;
	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[] = {
	{ .type = "serial", .compatible = "ns8250",   .data = (void *)PORT_8250, },
	{ .type = "serial", .compatible = "ns16450",  .data = (void *)PORT_16450, },
	{ .type = "serial", .compatible = "ns16550",  .data = (void *)PORT_16550, },
	{ .type = "serial", .compatible = "ns16750",  .data = (void *)PORT_16750, },
#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	{ .type = "serial", .compatible = "ibm,qpace-nwp-serial",
					.data = (void *)PORT_NWPSERIAL, },
#endif
	{ .type = "serial",			      .data = (void *)PORT_UNKNOWN, },
	{ /* end of list */ },
};

static struct of_platform_driver of_platform_serial_driver = {
	.owner = THIS_MODULE,
	.name = "of_serial",
	.probe = of_platform_serial_probe,
	.remove = of_platform_serial_remove,
	.match_table = of_platform_serial_table,
};

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

static void __exit of_platform_serial_exit(void)
{
	return of_unregister_platform_driver(&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>
	14	#include <linux/serial_core.h>
	15	#include <linux/serial_8250.h>
c401b044	16	#include <linux/of_platform.h>
5886188d	17	#include <linux/nwpserial.h>
8d38a5b2	18
8d38a5b2 AB	19	#include <asm/prom.h>
8d38a5b2 AB	20
e34b9c94 IK	21	struct of_serial_info {
	22	int type;
	23	int line;
	24	};
	25
8d38a5b2 AB	26	/*
	27	* Fill a struct uart_port for a given device node
	28	*/
	29	static int __devinit of_platform_serial_setup(struct of_device *ofdev,
	30	int type, struct uart_port *port)
	31	{
	32	struct resource resource;
	33	struct device_node *np = ofdev->node;
	34	const unsigned int clk, spd;
b912b5e2 JL	35	const u32 *prop;
b912b5e2 JL	36	int ret, prop_size;
8d38a5b2 AB	37
8d38a5b2 AB	38	memset(port, 0, sizeof *port);
40cd3a45 SR	39	spd = of_get_property(np, "current-speed", NULL);
40cd3a45 SR	40	clk = of_get_property(np, "clock-frequency", NULL);
8d38a5b2 AB	41	if (!clk) {
	42	dev_warn(&ofdev->dev, "no clock-frequency property set\n");
	43	return -ENODEV;
	44	}
	45
	46	ret = of_address_to_resource(np, 0, &resource);
	47	if (ret) {
	48	dev_warn(&ofdev->dev, "invalid address\n");
	49	return ret;
	50	}
	51
	52	spin_lock_init(&port->lock);
	53	port->mapbase = resource.start;
b912b5e2 JL	54
	55	/* Check for shifted address mapping */
	56	prop = of_get_property(np, "reg-offset", &prop_size);
	57	if (prop && (prop_size == sizeof(u32)))
	58	port->mapbase += *prop;
	59
	60	/* Check for registers offset within the devices address range */
	61	prop = of_get_property(np, "reg-shift", &prop_size);
	62	if (prop && (prop_size == sizeof(u32)))
	63	port->regshift = *prop;
	64
8d38a5b2 AB	65	port->irq = irq_of_parse_and_map(np, 0);
	66	port->iotype = UPIO_MEM;
	67	port->type = type;
	68	port->uartclk = *clk;
abb4a239 DG	69	port->flags = UPF_SHARE_IRQ \| UPF_BOOT_AUTOCONF \| UPF_IOREMAP
abb4a239 DG	70	\| UPF_FIXED_PORT;
8d38a5b2	71	port->dev = &ofdev->dev;
19a74263 SN	72	/* If current-speed was set, then try not to change it. */
	73	if (spd)
	74	port->custom_divisor = clk / (16 (*spd));
8d38a5b2 AB	75
	76	return 0;
	77	}
	78
	79	/*
	80	* Try to register a serial port
	81	*/
	82	static int __devinit of_platform_serial_probe(struct of_device *ofdev,
	83	const struct of_device_id *id)
	84	{
e34b9c94	85	struct of_serial_info *info;
8d38a5b2 AB	86	struct uart_port port;
	87	int port_type;
	88	int ret;
	89
	90	if (of_find_property(ofdev->node, "used-by-rtas", NULL))
	91	return -EBUSY;
	92
e34b9c94 IK	93	info = kmalloc(sizeof(*info), GFP_KERNEL);
	94	if (info == NULL)
	95	return -ENOMEM;
	96
8d38a5b2 AB	97	port_type = (unsigned long)id->data;
	98	ret = of_platform_serial_setup(ofdev, port_type, &port);
	99	if (ret)
	100	goto out;
	101
	102	switch (port_type) {
5886188d	103	#ifdef CONFIG_SERIAL_8250
8d38a5b2 AB	104	case PORT_8250 ... PORT_MAX_8250:
	105	ret = serial8250_register_port(&port);
	106	break;
5886188d BK	107	#endif
	108	#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	109	case PORT_NWPSERIAL:
	110	ret = nwpserial_register_port(&port);
	111	break;
	112	#endif
8d38a5b2 AB	113	default:
8d38a5b2 AB	114	/* need to add code for these */
1558f9b4 IK	115	case PORT_UNKNOWN:
1558f9b4 IK	116	dev_info(&ofdev->dev, "Unknown serial port found, ignored\n");
8d38a5b2 AB	117	ret = -ENODEV;
	118	break;
	119	}
	120	if (ret < 0)
	121	goto out;
	122
e34b9c94 IK	123	info->type = port_type;
	124	info->line = ret;
	125	ofdev->dev.driver_data = info;
8d38a5b2 AB	126	return 0;
8d38a5b2 AB	127	out:
e34b9c94	128	kfree(info);
8d38a5b2 AB	129	irq_dispose_mapping(port.irq);
	130	return ret;
	131	}
	132
	133	/*
	134	* Release a line
	135	*/
	136	static int of_platform_serial_remove(struct of_device *ofdev)
	137	{
e34b9c94 IK	138	struct of_serial_info *info = ofdev->dev.driver_data;
e34b9c94 IK	139	switch (info->type) {
5886188d	140	#ifdef CONFIG_SERIAL_8250
e34b9c94 IK	141	case PORT_8250 ... PORT_MAX_8250:
	142	serial8250_unregister_port(info->line);
	143	break;
5886188d BK	144	#endif
	145	#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	146	case PORT_NWPSERIAL:
	147	nwpserial_unregister_port(info->line);
	148	break;
	149	#endif
e34b9c94 IK	150	default:
	151	/* need to add code for these */
	152	break;
	153	}
	154	kfree(info);
8d38a5b2 AB	155	return 0;
	156	}
	157
	158	/*
	159	* A few common types, add more as needed.
	160	*/
	161	static struct of_device_id __devinitdata of_platform_serial_table[] = {
	162	{ .type = "serial", .compatible = "ns8250", .data = (void *)PORT_8250, },
	163	{ .type = "serial", .compatible = "ns16450", .data = (void *)PORT_16450, },
	164	{ .type = "serial", .compatible = "ns16550", .data = (void *)PORT_16550, },
	165	{ .type = "serial", .compatible = "ns16750", .data = (void *)PORT_16750, },
5886188d BK	166	#ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL
	167	{ .type = "serial", .compatible = "ibm,qpace-nwp-serial",
	168	.data = (void *)PORT_NWPSERIAL, },
	169	#endif
8d38a5b2 AB	170	{ .type = "serial", .data = (void *)PORT_UNKNOWN, },
	171	{ /* end of list */ },
	172	};
	173
e84290dc	174	static struct of_platform_driver of_platform_serial_driver = {
8d38a5b2 AB	175	.owner = THIS_MODULE,
	176	.name = "of_serial",
	177	.probe = of_platform_serial_probe,
	178	.remove = of_platform_serial_remove,
	179	.match_table = of_platform_serial_table,
	180	};
	181
	182	static int __init of_platform_serial_init(void)
	183	{
	184	return of_register_platform_driver(&of_platform_serial_driver);
	185	}
	186	module_init(of_platform_serial_init);
	187
	188	static void __exit of_platform_serial_exit(void)
	189	{
	190	return of_unregister_platform_driver(&of_platform_serial_driver);
	191	};
	192	module_exit(of_platform_serial_exit);
	193
	194	MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
	195	MODULE_LICENSE("GPL");
	196	MODULE_DESCRIPTION("Serial Port driver for Open Firmware platform devices");