]> git.sur5r.net Git - u-boot/commitdiff
dm: Add a uclass for serial devices
authorSimon Glass <sjg@chromium.org>
Thu, 4 Sep 2014 22:27:26 +0000 (16:27 -0600)
committerSimon Glass <sjg@chromium.org>
Wed, 10 Sep 2014 19:00:00 +0000 (13:00 -0600)
Serial devices support simple byte input/output and a few operations to find
out whether data is available. Add a basic uclass for serial devices to be
used by drivers that are converted to driver model.

Signed-off-by: Simon Glass <sjg@chromium.org>
drivers/serial/Makefile
drivers/serial/serial-uclass.c [new file with mode: 0644]
include/dm/uclass-id.h
include/serial.h

index 571c18fa9323562db21bebf25051700b6cb26a39..4720e1d14488e3bcbcef810607eaf72f767d63e8 100644 (file)
@@ -5,7 +5,11 @@
 # SPDX-License-Identifier:     GPL-2.0+
 #
 
+ifdef CONFIG_DM_SERIAL
+obj-y += serial-uclass.o
+else
 obj-y += serial.o
+endif
 
 obj-$(CONFIG_ALTERA_UART) += altera_uart.o
 obj-$(CONFIG_ALTERA_JTAG_UART) += altera_jtag_uart.o
diff --git a/drivers/serial/serial-uclass.c b/drivers/serial/serial-uclass.c
new file mode 100644 (file)
index 0000000..d04104e
--- /dev/null
@@ -0,0 +1,213 @@
+/*
+ * Copyright (c) 2014 The Chromium OS Authors.
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <common.h>
+#include <dm.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <os.h>
+#include <serial.h>
+#include <stdio_dev.h>
+#include <dm/lists.h>
+#include <dm/device-internal.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+/* The currently-selected console serial device */
+struct udevice *cur_dev __attribute__ ((section(".data")));
+
+#ifndef CONFIG_SYS_MALLOC_F_LEN
+#error "Serial is required before relocation - define CONFIG_SYS_MALLOC_F_LEN to make this work"
+#endif
+
+static void serial_find_console_or_panic(void)
+{
+       int node;
+
+       /* Check for a chosen console */
+       node = fdtdec_get_chosen_node(gd->fdt_blob, "stdout-path");
+       if (node < 0)
+               node = fdtdec_get_alias_node(gd->fdt_blob, "console");
+       if (!uclass_get_device_by_of_offset(UCLASS_SERIAL, node, &cur_dev))
+               return;
+
+       /*
+        * If the console is not marked to be bound before relocation, bind
+        * it anyway.
+        */
+       if (node > 0 &&
+           !lists_bind_fdt(gd->dm_root, gd->fdt_blob, node, &cur_dev)) {
+               if (!device_probe(cur_dev))
+                       return;
+               cur_dev = NULL;
+       }
+
+       /*
+        * Failing that, get the device with sequence number 0, or in extremis
+        * just the first serial device we can find. But we insist on having
+        * a console (even if it is silent).
+        */
+       if (uclass_get_device_by_seq(UCLASS_SERIAL, 0, &cur_dev) &&
+           (uclass_first_device(UCLASS_SERIAL, &cur_dev) || !cur_dev))
+               panic("No serial driver found");
+}
+
+/* Called prior to relocation */
+int serial_init(void)
+{
+       serial_find_console_or_panic();
+       gd->flags |= GD_FLG_SERIAL_READY;
+
+       return 0;
+}
+
+/* Called after relocation */
+void serial_initialize(void)
+{
+       serial_find_console_or_panic();
+}
+
+void serial_putc(char ch)
+{
+       struct dm_serial_ops *ops = serial_get_ops(cur_dev);
+       int err;
+
+       do {
+               err = ops->putc(cur_dev, ch);
+       } while (err == -EAGAIN);
+       if (ch == '\n')
+               serial_putc('\r');
+}
+
+void serial_setbrg(void)
+{
+       struct dm_serial_ops *ops = serial_get_ops(cur_dev);
+
+       if (ops->setbrg)
+               ops->setbrg(cur_dev, gd->baudrate);
+}
+
+void serial_puts(const char *str)
+{
+       while (*str)
+               serial_putc(*str++);
+}
+
+int serial_tstc(void)
+{
+       struct dm_serial_ops *ops = serial_get_ops(cur_dev);
+
+       if (ops->pending)
+               return ops->pending(cur_dev, true);
+
+       return 1;
+}
+
+int serial_getc(void)
+{
+       struct dm_serial_ops *ops = serial_get_ops(cur_dev);
+       int err;
+
+       do {
+               err = ops->getc(cur_dev);
+       } while (err == -EAGAIN);
+
+       return err >= 0 ? err : 0;
+}
+
+void serial_stdio_init(void)
+{
+}
+
+void serial_stub_putc(struct stdio_dev *sdev, const char ch)
+{
+       struct udevice *dev = sdev->priv;
+       struct dm_serial_ops *ops = serial_get_ops(dev);
+
+       ops->putc(dev, ch);
+}
+
+void serial_stub_puts(struct stdio_dev *sdev, const char *str)
+{
+       while (*str)
+               serial_stub_putc(sdev, *str++);
+}
+
+int serial_stub_getc(struct stdio_dev *sdev)
+{
+       struct udevice *dev = sdev->priv;
+       struct dm_serial_ops *ops = serial_get_ops(dev);
+
+       int err;
+
+       do {
+               err = ops->getc(dev);
+       } while (err == -EAGAIN);
+
+       return err >= 0 ? err : 0;
+}
+
+int serial_stub_tstc(struct stdio_dev *sdev)
+{
+       struct udevice *dev = sdev->priv;
+       struct dm_serial_ops *ops = serial_get_ops(dev);
+
+       if (ops->pending)
+               return ops->pending(dev, true);
+
+       return 1;
+}
+
+static int serial_post_probe(struct udevice *dev)
+{
+       struct stdio_dev sdev;
+       struct dm_serial_ops *ops = serial_get_ops(dev);
+       struct serial_dev_priv *upriv = dev->uclass_priv;
+       int ret;
+
+       /* Set the baud rate */
+       if (ops->setbrg) {
+               ret = ops->setbrg(dev, gd->baudrate);
+               if (ret)
+                       return ret;
+       }
+
+       if (!(gd->flags & GD_FLG_RELOC))
+               return 0;
+
+       memset(&sdev, '\0', sizeof(sdev));
+
+       strncpy(sdev.name, dev->name, sizeof(sdev.name));
+       sdev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
+       sdev.priv = dev;
+       sdev.putc = serial_stub_putc;
+       sdev.puts = serial_stub_puts;
+       sdev.getc = serial_stub_getc;
+       sdev.tstc = serial_stub_tstc;
+       stdio_register_dev(&sdev, &upriv->sdev);
+
+       return 0;
+}
+
+static int serial_pre_remove(struct udevice *dev)
+{
+#ifdef CONFIG_SYS_STDIO_DEREGISTER
+       struct serial_dev_priv *upriv = dev->uclass_priv;
+
+       if (stdio_deregister_dev(upriv->sdev))
+               return -EPERM;
+#endif
+
+       return 0;
+}
+
+UCLASS_DRIVER(serial) = {
+       .id             = UCLASS_SERIAL,
+       .name           = "serial",
+       .post_probe     = serial_post_probe,
+       .pre_remove     = serial_pre_remove,
+       .per_device_auto_alloc_size = sizeof(struct serial_dev_priv),
+};
index dd95fca428dc54d54c1d706431f7ef6e512c78e1..7f0e37b7b789cd64b48a124a0726dc4efbbe2fe4 100644 (file)
@@ -21,6 +21,7 @@ enum uclass_id {
 
        /* U-Boot uclasses start here */
        UCLASS_GPIO,            /* Bank of general-purpose I/O pins */
+       UCLASS_SERIAL,          /* Serial UART */
 
        UCLASS_COUNT,
        UCLASS_INVALID = -1,
index d232d470a337e842ed9f88173b9a810f3fc818ba..8f574e4ef896617caa997f0f99823287f476e40a 100644 (file)
@@ -72,4 +72,96 @@ extern int write_port(struct stdio_dev *port, char *buf);
 extern int read_port(struct stdio_dev *port, char *buf, int size);
 #endif
 
+struct udevice;
+
+/**
+ * struct struct dm_serial_ops - Driver model serial operations
+ *
+ * The uclass interface is implemented by all serial devices which use
+ * driver model.
+ */
+struct dm_serial_ops {
+       /**
+        * setbrg() - Set up the baud rate generator
+        *
+        * Adjust baud rate divisors to set up a new baud rate for this
+        * device. Not all devices will support all rates. If the rate
+        * cannot be supported, the driver is free to select the nearest
+        * available rate. or return -EINVAL if this is not possible.
+        *
+        * @dev: Device pointer
+        * @baudrate: New baud rate to use
+        * @return 0 if OK, -ve on error
+        */
+       int (*setbrg)(struct udevice *dev, int baudrate);
+       /**
+        * getc() - Read a character and return it
+        *
+        * If no character is available, this should return -EAGAIN without
+        * waiting.
+        *
+        * @dev: Device pointer
+        * @return character (0..255), -ve on error
+        */
+       int (*getc)(struct udevice *dev);
+       /**
+        * putc() - Write a character
+        *
+        * @dev: Device pointer
+        * @ch: character to write
+        * @return 0 if OK, -ve on error
+        */
+       int (*putc)(struct udevice *dev, const char ch);
+       /**
+        * pending() - Check if input/output characters are waiting
+        *
+        * This can be used to return an indication of the number of waiting
+        * characters if the driver knows this (e.g. by looking at the FIFO
+        * level). It is acceptable to return 1 if an indeterminant number
+        * of characters is waiting.
+        *
+        * This method is optional.
+        *
+        * @dev: Device pointer
+        * @input: true to check input characters, false for output
+        * @return number of waiting characters, 0 for none, -ve on error
+        */
+       int (*pending)(struct udevice *dev, bool input);
+       /**
+        * clear() - Clear the serial FIFOs/holding registers
+        *
+        * This method is optional.
+        *
+        * This quickly clears any input/output characters from the UART.
+        * If this is not possible, but characters still exist, then it
+        * is acceptable to return -EAGAIN (try again) or -EINVAL (not
+        * supported).
+        *
+        * @dev: Device pointer
+        * @return 0 if OK, -ve on error
+        */
+       int (*clear)(struct udevice *dev);
+#if CONFIG_POST & CONFIG_SYS_POST_UART
+       /**
+        * loop() - Control serial device loopback mode
+        *
+        * @dev: Device pointer
+        * @on: 1 to turn loopback on, 0 to turn if off
+        */
+       int (*loop)(struct udevice *dev, int on);
+#endif
+};
+
+/**
+ * struct serial_dev_priv - information about a device used by the uclass
+ *
+ * @sdev: stdio device attached to this uart
+ */
+struct serial_dev_priv {
+       struct stdio_dev *sdev;
+};
+
+/* Access the serial operations for a device */
+#define serial_get_ops(dev)    ((struct dm_serial_ops *)(dev)->driver->ops)
+
 #endif