[U-Boot] [PATCH 65/72] serial: ns16550: Rename serial.c to serial_ns16550.c

[Michal Simek <monstr@monstr.eu>]

On 09/29/2012 11:52 PM, Marek Vasut wrote:
> This serial driver had wrong name of the source file for some time
> now. The name of the driver was serial.c instead of any more logical
> and fitting name. Thus, rename the driver source file to serial_ns16550.c
> and be done with it.
>
> Signed-off-by: Marek Vasut <marex@denx.de>
> Cc: Marek Vasut <marek.vasut@gmail.com>
> Cc: Tom Rini <trini@ti.com>
> Cc: Anatolij Gustschin <agust@denx.de>
> Cc: Stefan Roese <sr@denx.de>
> Cc: Mike Frysinger <vapier@gentoo.org>
> Cc: Michal Simek <monstr@monstr.eu>
> ---
>   drivers/serial/Makefile         |    2 +-
>   drivers/serial/serial.c         |  359 ---------------------------------------
>   drivers/serial/serial_ns16550.c |  359 +++++++++++++++++++++++++++++++++++++++
>   3 files changed, 360 insertions(+), 360 deletions(-)
>   delete mode 100644 drivers/serial/serial.c
>   create mode 100644 drivers/serial/serial_ns16550.c
>
> diff --git a/drivers/serial/Makefile b/drivers/serial/Makefile
> index 65d0f23..d93e81b 100644
> --- a/drivers/serial/Makefile
> +++ b/drivers/serial/Makefile
> @@ -37,7 +37,7 @@ COBJS-$(CONFIG_SYS_NS16550) += ns16550.o
>   COBJS-$(CONFIG_DRIVER_S3C4510_UART) += s3c4510b_uart.o
>   COBJS-$(CONFIG_S3C64XX) += s3c64xx.o
>   COBJS-$(CONFIG_S5P) += serial_s5p.o
> -COBJS-$(CONFIG_SYS_NS16550_SERIAL) += serial.o
> +COBJS-$(CONFIG_SYS_NS16550_SERIAL) += serial_ns16550.o
>   COBJS-$(CONFIG_CLPS7111_SERIAL) += serial_clps7111.o
>   COBJS-$(CONFIG_IMX_SERIAL) += serial_imx.o
>   COBJS-$(CONFIG_IXP_SERIAL) += serial_ixp.o
> diff --git a/drivers/serial/serial.c b/drivers/serial/serial.c
> deleted file mode 100644
> index 00ad97c..0000000
> --- a/drivers/serial/serial.c
> +++ /dev/null
> @@ -1,359 +0,0 @@
> -/*
> - * (C) Copyright 2000
> - * Rob Taylor, Flying Pig Systems. robt at flyingpig.com.
> - *
> - * See file CREDITS for list of people who contributed to this
> - * project.
> - *
> - * 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.
> - *
> - * This program is distributed in the hope that it will be useful,
> - * but WITHOUT ANY WARRANTY; without even the implied warranty of
> - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> - * GNU General Public License for more details.
> - *
> - * You should have received a copy of the GNU General Public License
> - * along with this program; if not, write to the Free Software
> - * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> - * MA 02111-1307 USA
> - */
> -
> -#include <common.h>
> -#include <linux/compiler.h>
> -
> -#include <ns16550.h>
> -#ifdef CONFIG_NS87308
> -#include <ns87308.h>
> -#endif
> -
> -#if defined (CONFIG_SERIAL_MULTI)
> -#include <serial.h>
> -#endif
> -
> -DECLARE_GLOBAL_DATA_PTR;
> -
> -#if !defined(CONFIG_CONS_INDEX)
> -#if defined (CONFIG_SERIAL_MULTI)
> -/*   with CONFIG_SERIAL_MULTI we might have no console
> - *  on these devices
> - */
> -#else
> -#error	"No console index specified."
> -#endif /* CONFIG_SERIAL_MULTI */
> -#elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 4)
> -#error	"Invalid console index value."
> -#endif
> -
> -#if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
> -#error	"Console port 1 defined but not configured."
> -#elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
> -#error	"Console port 2 defined but not configured."
> -#elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
> -#error	"Console port 3 defined but not configured."
> -#elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
> -#error	"Console port 4 defined but not configured."
> -#endif
> -
> -/* Note: The port number specified in the functions is 1 based.
> - *	 the array is 0 based.
> - */
> -static NS16550_t serial_ports[4] = {
> -#ifdef CONFIG_SYS_NS16550_COM1
> -	(NS16550_t)CONFIG_SYS_NS16550_COM1,
> -#else
> -	NULL,
> -#endif
> -#ifdef CONFIG_SYS_NS16550_COM2
> -	(NS16550_t)CONFIG_SYS_NS16550_COM2,
> -#else
> -	NULL,
> -#endif
> -#ifdef CONFIG_SYS_NS16550_COM3
> -	(NS16550_t)CONFIG_SYS_NS16550_COM3,
> -#else
> -	NULL,
> -#endif
> -#ifdef CONFIG_SYS_NS16550_COM4
> -	(NS16550_t)CONFIG_SYS_NS16550_COM4
> -#else
> -	NULL
> -#endif
> -};
> -
> -#define PORT	serial_ports[port-1]
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -
> -/* Multi serial device functions */
> -#define DECLARE_ESERIAL_FUNCTIONS(port) \
> -    int  eserial##port##_init (void) {\
> -	int clock_divisor; \
> -	clock_divisor = calc_divisor(serial_ports[port-1]); \
> -	NS16550_init(serial_ports[port-1], clock_divisor); \
> -	return(0);}\
> -    void eserial##port##_setbrg (void) {\
> -	serial_setbrg_dev(port);}\
> -    int  eserial##port##_getc (void) {\
> -	return serial_getc_dev(port);}\
> -    int  eserial##port##_tstc (void) {\
> -	return serial_tstc_dev(port);}\
> -    void eserial##port##_putc (const char c) {\
> -	serial_putc_dev(port, c);}\
> -    void eserial##port##_puts (const char *s) {\
> -	serial_puts_dev(port, s);}
> -
> -/* Serial device descriptor */
> -#define INIT_ESERIAL_STRUCTURE(port, __name) {	\
> -	.name	= __name,			\
> -	.start	= eserial##port##_init,		\
> -	.stop	= NULL,				\
> -	.setbrg	= eserial##port##_setbrg,	\
> -	.getc	= eserial##port##_getc,		\
> -	.tstc	= eserial##port##_tstc,		\
> -	.putc	= eserial##port##_putc,		\
> -	.puts	= eserial##port##_puts,		\
> -}
> -
> -#endif /* CONFIG_SERIAL_MULTI */
> -
> -static int calc_divisor (NS16550_t port)
> -{
> -#ifdef CONFIG_OMAP1510
> -	/* If can't cleanly clock 115200 set div to 1 */
> -	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
> -		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
> -		return (1);				/* return 1 for base divisor */
> -	}
> -	port->osc_12m_sel = 0;			/* clear if previsouly set */
> -#endif
> -#ifdef CONFIG_OMAP1610
> -	/* If can't cleanly clock 115200 set div to 1 */
> -	if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
> -		return (26);		/* return 26 for base divisor */
> -	}
> -#endif
> -
> -#ifdef CONFIG_APTIX
> -#define MODE_X_DIV 13
> -#else
> -#define MODE_X_DIV 16
> -#endif
> -
> -	/* Compute divisor value. Normally, we should simply return:
> -	 *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
> -	 * but we need to round that value by adding 0.5.
> -	 * Rounding is especially important at high baud rates.
> -	 */
> -	return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
> -		(MODE_X_DIV * gd->baudrate);
> -}
> -
> -#if !defined(CONFIG_SERIAL_MULTI)
> -int serial_init (void)
> -{
> -	int clock_divisor;
> -
> -#ifdef CONFIG_NS87308
> -	initialise_ns87308();
> -#endif
> -
> -#ifdef CONFIG_SYS_NS16550_COM1
> -	clock_divisor = calc_divisor(serial_ports[0]);
> -	NS16550_init(serial_ports[0], clock_divisor);
> -#endif
> -#ifdef CONFIG_SYS_NS16550_COM2
> -	clock_divisor = calc_divisor(serial_ports[1]);
> -	NS16550_init(serial_ports[1], clock_divisor);
> -#endif
> -#ifdef CONFIG_SYS_NS16550_COM3
> -	clock_divisor = calc_divisor(serial_ports[2]);
> -	NS16550_init(serial_ports[2], clock_divisor);
> -#endif
> -#ifdef CONFIG_SYS_NS16550_COM4
> -	clock_divisor = calc_divisor(serial_ports[3]);
> -	NS16550_init(serial_ports[3], clock_divisor);
> -#endif
> -
> -	return (0);
> -}
> -#endif
> -
> -void
> -_serial_putc(const char c,const int port)
> -{
> -	if (c == '\n')
> -		NS16550_putc(PORT, '\r');
> -
> -	NS16550_putc(PORT, c);
> -}
> -
> -void
> -_serial_putc_raw(const char c,const int port)
> -{
> -	NS16550_putc(PORT, c);
> -}
> -
> -void
> -_serial_puts (const char *s,const int port)
> -{
> -	while (*s) {
> -		_serial_putc (*s++,port);
> -	}
> -}
> -
> -
> -int
> -_serial_getc(const int port)
> -{
> -	return NS16550_getc(PORT);
> -}
> -
> -int
> -_serial_tstc(const int port)
> -{
> -	return NS16550_tstc(PORT);
> -}
> -
> -void
> -_serial_setbrg (const int port)
> -{
> -	int clock_divisor;
> -
> -	clock_divisor = calc_divisor(PORT);
> -	NS16550_reinit(PORT, clock_divisor);
> -}
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -static inline void
> -serial_putc_dev(unsigned int dev_index,const char c)
> -{
> -	_serial_putc(c,dev_index);
> -}
> -#else
> -void
> -serial_putc(const char c)
> -{
> -	_serial_putc(c,CONFIG_CONS_INDEX);
> -}
> -#endif
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -static inline void
> -serial_putc_raw_dev(unsigned int dev_index,const char c)
> -{
> -	_serial_putc_raw(c,dev_index);
> -}
> -#else
> -void
> -serial_putc_raw(const char c)
> -{
> -	_serial_putc_raw(c,CONFIG_CONS_INDEX);
> -}
> -#endif
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -static inline void
> -serial_puts_dev(unsigned int dev_index,const char *s)
> -{
> -	_serial_puts(s,dev_index);
> -}
> -#else
> -void
> -serial_puts(const char *s)
> -{
> -	_serial_puts(s,CONFIG_CONS_INDEX);
> -}
> -#endif
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -static inline int
> -serial_getc_dev(unsigned int dev_index)
> -{
> -	return _serial_getc(dev_index);
> -}
> -#else
> -int
> -serial_getc(void)
> -{
> -	return _serial_getc(CONFIG_CONS_INDEX);
> -}
> -#endif
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -static inline int
> -serial_tstc_dev(unsigned int dev_index)
> -{
> -	return _serial_tstc(dev_index);
> -}
> -#else
> -int
> -serial_tstc(void)
> -{
> -	return _serial_tstc(CONFIG_CONS_INDEX);
> -}
> -#endif
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -static inline void
> -serial_setbrg_dev(unsigned int dev_index)
> -{
> -	_serial_setbrg(dev_index);
> -}
> -#else
> -void
> -serial_setbrg(void)
> -{
> -	_serial_setbrg(CONFIG_CONS_INDEX);
> -}
> -#endif
> -
> -#if defined(CONFIG_SERIAL_MULTI)
> -
> -DECLARE_ESERIAL_FUNCTIONS(1);
> -struct serial_device eserial1_device =
> -	INIT_ESERIAL_STRUCTURE(1, "eserial0");
> -DECLARE_ESERIAL_FUNCTIONS(2);
> -struct serial_device eserial2_device =
> -	INIT_ESERIAL_STRUCTURE(2, "eserial1");
> -DECLARE_ESERIAL_FUNCTIONS(3);
> -struct serial_device eserial3_device =
> -	INIT_ESERIAL_STRUCTURE(3, "eserial2");
> -DECLARE_ESERIAL_FUNCTIONS(4);
> -struct serial_device eserial4_device =
> -	INIT_ESERIAL_STRUCTURE(4, "eserial3");
> -
> -__weak struct serial_device *default_serial_console(void)
> -{
> -#if CONFIG_CONS_INDEX == 1
> -	return &eserial1_device;
> -#elif CONFIG_CONS_INDEX == 2
> -	return &eserial2_device;
> -#elif CONFIG_CONS_INDEX == 3
> -	return &eserial3_device;
> -#elif CONFIG_CONS_INDEX == 4
> -	return &eserial4_device;
> -#else
> -#error "Bad CONFIG_CONS_INDEX."
> -#endif
> -}
> -
> -void ns16550_serial_initialize(void)
> -{
> -#if defined(CONFIG_SYS_NS16550_COM1)
> -	serial_register(&eserial1_device);
> -#endif
> -#if defined(CONFIG_SYS_NS16550_COM2)
> -	serial_register(&eserial2_device);
> -#endif
> -#if defined(CONFIG_SYS_NS16550_COM3)
> -	serial_register(&eserial3_device);
> -#endif
> -#if defined(CONFIG_SYS_NS16550_COM4)
> -	serial_register(&eserial4_device);
> -#endif
> -}
> -
> -#endif /* CONFIG_SERIAL_MULTI */
> diff --git a/drivers/serial/serial_ns16550.c b/drivers/serial/serial_ns16550.c
> new file mode 100644
> index 0000000..00ad97c
> --- /dev/null
> +++ b/drivers/serial/serial_ns16550.c
> @@ -0,0 +1,359 @@
> +/*
> + * (C) Copyright 2000
> + * Rob Taylor, Flying Pig Systems. robt at flyingpig.com.
> + *
> + * See file CREDITS for list of people who contributed to this
> + * project.
> + *
> + * 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.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> + * MA 02111-1307 USA
> + */
> +
> +#include <common.h>
> +#include <linux/compiler.h>
> +
> +#include <ns16550.h>
> +#ifdef CONFIG_NS87308
> +#include <ns87308.h>
> +#endif
> +
> +#if defined (CONFIG_SERIAL_MULTI)
> +#include <serial.h>
> +#endif
> +
> +DECLARE_GLOBAL_DATA_PTR;
> +
> +#if !defined(CONFIG_CONS_INDEX)
> +#if defined (CONFIG_SERIAL_MULTI)
> +/*   with CONFIG_SERIAL_MULTI we might have no console
> + *  on these devices
> + */
> +#else
> +#error	"No console index specified."
> +#endif /* CONFIG_SERIAL_MULTI */
> +#elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 4)
> +#error	"Invalid console index value."
> +#endif
> +
> +#if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
> +#error	"Console port 1 defined but not configured."
> +#elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
> +#error	"Console port 2 defined but not configured."
> +#elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
> +#error	"Console port 3 defined but not configured."
> +#elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
> +#error	"Console port 4 defined but not configured."
> +#endif
> +
> +/* Note: The port number specified in the functions is 1 based.
> + *	 the array is 0 based.
> + */
> +static NS16550_t serial_ports[4] = {
> +#ifdef CONFIG_SYS_NS16550_COM1
> +	(NS16550_t)CONFIG_SYS_NS16550_COM1,
> +#else
> +	NULL,
> +#endif
> +#ifdef CONFIG_SYS_NS16550_COM2
> +	(NS16550_t)CONFIG_SYS_NS16550_COM2,
> +#else
> +	NULL,
> +#endif
> +#ifdef CONFIG_SYS_NS16550_COM3
> +	(NS16550_t)CONFIG_SYS_NS16550_COM3,
> +#else
> +	NULL,
> +#endif
> +#ifdef CONFIG_SYS_NS16550_COM4
> +	(NS16550_t)CONFIG_SYS_NS16550_COM4
> +#else
> +	NULL
> +#endif
> +};

Would it be better just use this structure?

#ifdef CONFIG_SYS_NS16550_COM1
        [0] = (NS16550_t)CONFIG_SYS_NS16550_COM1,
#endif



> +
> +#define PORT	serial_ports[port-1]
> +
> +#if defined(CONFIG_SERIAL_MULTI)
> +
> +/* Multi serial device functions */
> +#define DECLARE_ESERIAL_FUNCTIONS(port) \
> +    int  eserial##port##_init (void) {\
> +	int clock_divisor; \
> +	clock_divisor = calc_divisor(serial_ports[port-1]); \
> +	NS16550_init(serial_ports[port-1], clock_divisor); \
> +	return(0);}\
> +    void eserial##port##_setbrg (void) {\
> +	serial_setbrg_dev(port);}\
> +    int  eserial##port##_getc (void) {\
> +	return serial_getc_dev(port);}\
> +    int  eserial##port##_tstc (void) {\
> +	return serial_tstc_dev(port);}\
> +    void eserial##port##_putc (const char c) {\
> +	serial_putc_dev(port, c);}\
> +    void eserial##port##_puts (const char *s) {\
> +	serial_puts_dev(port, s);}
> +
> +/* Serial device descriptor */
> +#define INIT_ESERIAL_STRUCTURE(port, __name) {	\
> +	.name	= __name,			\
> +	.start	= eserial##port##_init,		\
> +	.stop	= NULL,				\
> +	.setbrg	= eserial##port##_setbrg,	\
> +	.getc	= eserial##port##_getc,		\
> +	.tstc	= eserial##port##_tstc,		\
> +	.putc	= eserial##port##_putc,		\
> +	.puts	= eserial##port##_puts,		\
> +}
> +
> +#endif /* CONFIG_SERIAL_MULTI */
> +
> +static int calc_divisor (NS16550_t port)
> +{
> +#ifdef CONFIG_OMAP1510
> +	/* If can't cleanly clock 115200 set div to 1 */
> +	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
> +		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
> +		return (1);				/* return 1 for base divisor */
> +	}
> +	port->osc_12m_sel = 0;			/* clear if previsouly set */
> +#endif
> +#ifdef CONFIG_OMAP1610
> +	/* If can't cleanly clock 115200 set div to 1 */
> +	if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
> +		return (26);		/* return 26 for base divisor */
> +	}
> +#endif
> +
> +#ifdef CONFIG_APTIX
> +#define MODE_X_DIV 13
> +#else
> +#define MODE_X_DIV 16
> +#endif
> +
> +	/* Compute divisor value. Normally, we should simply return:
> +	 *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
> +	 * but we need to round that value by adding 0.5.
> +	 * Rounding is especially important at high baud rates.
> +	 */
> +	return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
> +		(MODE_X_DIV * gd->baudrate);
> +}
> +
> +#if !defined(CONFIG_SERIAL_MULTI)
> +int serial_init (void)
> +{
> +	int clock_divisor;
> +
> +#ifdef CONFIG_NS87308
> +	initialise_ns87308();
> +#endif
> +
> +#ifdef CONFIG_SYS_NS16550_COM1
> +	clock_divisor = calc_divisor(serial_ports[0]);
> +	NS16550_init(serial_ports[0], clock_divisor);
> +#endif
> +#ifdef CONFIG_SYS_NS16550_COM2
> +	clock_divisor = calc_divisor(serial_ports[1]);
> +	NS16550_init(serial_ports[1], clock_divisor);
> +#endif
> +#ifdef CONFIG_SYS_NS16550_COM3
> +	clock_divisor = calc_divisor(serial_ports[2]);
> +	NS16550_init(serial_ports[2], clock_divisor);
> +#endif
> +#ifdef CONFIG_SYS_NS16550_COM4
> +	clock_divisor = calc_divisor(serial_ports[3]);
> +	NS16550_init(serial_ports[3], clock_divisor);
> +#endif
> +
> +	return (0);
> +}
> +#endif
> +
> +void
> +_serial_putc(const char c,const int port)

You are using two coding styles in this file.
One has function return value on one line and then function name
and the second function return value on one line with function name.
Will be good to unify it to look the same in the whole file.


Thanks,
Michal


-- 
Michal Simek, Ing. (M.Eng)
w: www.monstr.eu p: +42-0-721842854
Maintainer of Linux kernel 2.6 Microblaze Linux - http://www.monstr.eu/fdt/
Microblaze U-BOOT custodian