dm: Add a demonstration/example driver

As an example of how to write a uclass and a driver, provide a demo version
of each, accessible through the 'demo' command.

To use these with driver model, define CONFIG_CMD_DEMO and CONFIG_DM_DEMO.

The two demo drivers are enabled with CONFIG_DM_DEMO_SIMPLE and
CONFIG_DM_DEMO_SHAPE.

Signed-off-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Marek Vasut <marex@denx.de>
Signed-off-by: Pavel Herrmann <morpheus.ibis@gmail.com>
Signed-off-by: Viktor Křivák <viktor.krivak@gmail.com>
Signed-off-by: Tomas Hlavacek <tmshlvck@gmail.com>

diff --git a/Makefile b/Makefile
index c6d1afa1c99f9dbf8a1a98d29ca1abb8b0a3d93f..f405b257f0880e8200b77673d67d370b01ff65b5 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -627,6 +627,7 @@ libs-$(CONFIG_API) += api/
 libs-$(CONFIG_HAS_POST) += post/
 libs-y += test/
 libs-y += test/dm/
 libs-$(CONFIG_HAS_POST) += post/
 libs-y += test/
 libs-y += test/dm/

+libs-$(CONFIG_DM_DEMO) += drivers/demo/

 
 ifneq (,$(filter $(SOC), mx25 mx27 mx5 mx6 mx31 mx35 mxs vf610))
 libs-y += arch/$(ARCH)/imx-common/
 
 ifneq (,$(filter $(SOC), mx25 mx27 mx5 mx6 mx31 mx35 mxs vf610))
 libs-y += arch/$(ARCH)/imx-common/

diff --git a/common/Makefile b/common/Makefile
index ca9af13ce7a1bdefb4681cc7a052f092131a1cab..04e9cdd5ffa1a599676e9130947412b0aeb6759e 100644 (file)
--- a/common/Makefile
+++ b/common/Makefile
@@ -64,6 +64,7 @@ obj-$(CONFIG_CMD_CONSOLE) += cmd_console.o
 obj-$(CONFIG_CMD_CPLBINFO) += cmd_cplbinfo.o
 obj-$(CONFIG_DATAFLASH_MMC_SELECT) += cmd_dataflash_mmc_mux.o
 obj-$(CONFIG_CMD_DATE) += cmd_date.o
 obj-$(CONFIG_CMD_CPLBINFO) += cmd_cplbinfo.o
 obj-$(CONFIG_DATAFLASH_MMC_SELECT) += cmd_dataflash_mmc_mux.o
 obj-$(CONFIG_CMD_DATE) += cmd_date.o

+obj-$(CONFIG_CMD_DEMO) += cmd_demo.o

 obj-$(CONFIG_CMD_SOUND) += cmd_sound.o
 ifdef CONFIG_4xx
 obj-$(CONFIG_CMD_SETGETDCR) += cmd_dcr.o
 obj-$(CONFIG_CMD_SOUND) += cmd_sound.o
 ifdef CONFIG_4xx
 obj-$(CONFIG_CMD_SETGETDCR) += cmd_dcr.o

diff --git a/common/cmd_demo.c b/common/cmd_demo.c
new file mode 100644 (file)
index 0000000..a3bba7f
--- /dev/null
+++ b/common/cmd_demo.c
@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2013 Google, Inc
+ *
+ * (C) Copyright 2012
+ * Pavel Herrmann <morpheus.ibis@gmail.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <common.h>
+#include <dm-demo.h>
+#include <asm/io.h>
+
+struct device *demo_dev;
+
+static int do_demo_hello(cmd_tbl_t *cmdtp, int flag, int argc,
+                        char * const argv[])
+{
+       int ch = 0;
+
+       if (argc)
+               ch = *argv[0];
+
+       return demo_hello(demo_dev, ch);
+}
+
+static int do_demo_status(cmd_tbl_t *cmdtp, int flag, int argc,
+                         char * const argv[])
+{
+       int status;
+       int ret;
+
+       ret = demo_status(demo_dev, &status);
+       if (ret)
+               return ret;
+
+       printf("Status: %d\n", status);
+
+       return 0;
+}
+
+int do_demo_list(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+{
+       struct device *dev;
+       int i, ret;
+
+       puts("Demo uclass entries:\n");
+
+       for (i = 0, ret = uclass_first_device(UCLASS_DEMO, &dev);
+            dev;
+            ret = uclass_next_device(&dev)) {
+               printf("entry %d - instance %08x, ops %08x, platdata %08x\n",
+                      i++, map_to_sysmem(dev),
+                      map_to_sysmem(dev->driver->ops),
+                      map_to_sysmem(dev_get_platdata(dev)));
+       }
+
+       return cmd_process_error(cmdtp, ret);
+}
+
+static cmd_tbl_t demo_commands[] = {
+       U_BOOT_CMD_MKENT(list, 0, 1, do_demo_list, "", ""),
+       U_BOOT_CMD_MKENT(hello, 2, 1, do_demo_hello, "", ""),
+       U_BOOT_CMD_MKENT(status, 1, 1, do_demo_status, "", ""),
+};
+
+static int do_demo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+{
+       cmd_tbl_t *demo_cmd;
+       int devnum = 0;
+       int ret;
+
+       if (argc < 2)
+               return CMD_RET_USAGE;
+       demo_cmd = find_cmd_tbl(argv[1], demo_commands,
+                               ARRAY_SIZE(demo_commands));
+       argc -= 2;
+       argv += 2;
+       if (!demo_cmd || argc > demo_cmd->maxargs)
+               return CMD_RET_USAGE;
+
+       if (argc) {
+               devnum = simple_strtoul(argv[0], NULL, 10);
+               ret = uclass_get_device(UCLASS_DEMO, devnum, &demo_dev);
+               if (ret)
+                       return cmd_process_error(cmdtp, ret);
+               argc--;
+               argv++;
+       }
+
+       ret = demo_cmd->cmd(demo_cmd, flag, argc, argv);
+
+       return cmd_process_error(demo_cmd, ret);
+}
+
+U_BOOT_CMD(
+       demo,   4,      1,      do_demo,
+       "Driver model (dm) demo operations",
+       "list                     List available demo devices\n"
+       "demo hello <num> [<char>]     Say hello\n"
+       "demo status <num>             Get demo device status"
+);

diff --git a/drivers/demo/Makefile b/drivers/demo/Makefile
new file mode 100644 (file)
index 0000000..baaa2ba
--- /dev/null
+++ b/drivers/demo/Makefile
@@ -0,0 +1,9 @@
+#
+# Copyright (c) 2013 Google, Inc
+#
+# SPDX-License-Identifier:     GPL-2.0+
+#
+
+obj-$(CONFIG_DM_DEMO) += demo-uclass.o demo-pdata.o
+obj-$(CONFIG_DM_DEMO_SIMPLE) += demo-simple.o
+obj-$(CONFIG_DM_DEMO_SHAPE) += demo-shape.o

diff --git a/drivers/demo/demo-pdata.c b/drivers/demo/demo-pdata.c
new file mode 100644 (file)
index 0000000..e92841d
--- /dev/null
+++ b/drivers/demo/demo-pdata.c
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2013 Google, Inc
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <common.h>
+#include <dm.h>
+#include <dm-demo.h>
+
+static const struct dm_demo_pdata red_square = {
+       .colour = "red",
+       .sides = 4.
+};
+static const struct dm_demo_pdata green_triangle = {
+       .colour = "green",
+       .sides = 3.
+};
+static const struct dm_demo_pdata yellow_hexagon = {
+       .colour = "yellow",
+       .sides = 6.
+};
+
+U_BOOT_DEVICE(demo0) = {
+       .name = "demo_shape_drv",
+       .platdata = &red_square,
+};
+
+U_BOOT_DEVICE(demo1) = {
+       .name = "demo_simple_drv",
+       .platdata = &red_square,
+};
+
+U_BOOT_DEVICE(demo2) = {
+       .name = "demo_shape_drv",
+       .platdata = &green_triangle,
+};
+
+U_BOOT_DEVICE(demo3) = {
+       .name = "demo_simple_drv",
+       .platdata = &yellow_hexagon,
+};
+
+U_BOOT_DEVICE(demo4) = {
+       .name = "demo_shape_drv",
+       .platdata = &yellow_hexagon,
+};

diff --git a/drivers/demo/demo-shape.c b/drivers/demo/demo-shape.c
new file mode 100644 (file)
index 0000000..2f0eb96
--- /dev/null
+++ b/drivers/demo/demo-shape.c
@@ -0,0 +1,127 @@
+/*
+ * Copyright (c) 2013 Google, Inc
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <common.h>
+#include <dm.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <malloc.h>
+#include <dm-demo.h>
+#include <asm/io.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+/* Shape size */
+#define WIDTH  8
+#define HEIGHT 6
+
+struct shape_data {
+       int num_chars;  /* Number of non-space characters output so far */
+};
+
+/* Crazy little function to draw shapes on the console */
+static int shape_hello(struct device *dev, int ch)
+{
+       const struct dm_demo_pdata *pdata = dev_get_platdata(dev);
+       struct shape_data *data = dev_get_priv(dev);
+       static const struct shape {
+               int start;
+               int end;
+               int dstart;
+               int dend;
+       } shapes[3] = {
+               { 0, 1, 0, 1 },
+               { 0, WIDTH, 0, 0 },
+               { HEIGHT / 2 - 1, WIDTH - HEIGHT / 2 + 1, -1, 1},
+       };
+       struct shape shape;
+       unsigned int index;
+       int line, pos, inside;
+       const char *colour = pdata->colour;
+       int first = 0;
+
+       if (!ch)
+               ch = pdata->default_char;
+       if (!ch)
+               ch = '@';
+
+       index = (pdata->sides / 2) - 1;
+       if (index >= ARRAY_SIZE(shapes))
+               return -EIO;
+       shape = shapes[index];
+
+       for (line = 0; line < HEIGHT; line++) {
+               first = 1;
+               for (pos = 0; pos < WIDTH; pos++) {
+                       inside = pos >= shape.start && pos < shape.end;
+                       if (inside) {
+                               putc(first ? *colour++ : ch);
+                               data->num_chars++;
+                               first = 0;
+                               if (!*colour)
+                                       colour = pdata->colour;
+                       } else {
+                               putc(' ');
+                       }
+               }
+               putc('\n');
+               shape.start += shape.dstart;
+               shape.end += shape.dend;
+               if (shape.start < 0) {
+                       shape.dstart = -shape.dstart;
+                       shape.dend = -shape.dend;
+                       shape.start += shape.dstart;
+                       shape.end += shape.dend;
+               }
+       }
+
+       return 0;
+}
+
+static int shape_status(struct device *dev, int *status)
+{
+       struct shape_data *data = dev_get_priv(dev);
+
+       *status = data->num_chars;
+       return 0;
+}
+
+static const struct demo_ops shape_ops = {
+       .hello = shape_hello,
+       .status = shape_status,
+};
+
+static int shape_ofdata_to_platdata(struct device *dev)
+{
+       struct dm_demo_pdata *pdata = dev_get_platdata(dev);
+       int ret;
+
+       /* Parse the data that is common with all demo devices */
+       ret = demo_parse_dt(dev);
+       if (ret)
+               return ret;
+
+       /* Parse the data that only we need */
+       pdata->default_char = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
+                                            "character", '@');
+
+       return 0;
+}
+
+static const struct device_id demo_shape_id[] = {
+       { "demo-shape", 0 },
+       { },
+};
+
+U_BOOT_DRIVER(demo_shape_drv) = {
+       .name   = "demo_shape_drv",
+       .of_match = demo_shape_id,
+       .id     = UCLASS_DEMO,
+       .ofdata_to_platdata = shape_ofdata_to_platdata,
+       .ops    = &shape_ops,
+       .priv_auto_alloc_size = sizeof(struct shape_data),
+       .platdata_auto_alloc_size = sizeof(struct dm_demo_pdata),
+};

diff --git a/drivers/demo/demo-simple.c b/drivers/demo/demo-simple.c
new file mode 100644 (file)
index 0000000..6ba8131
--- /dev/null
+++ b/drivers/demo/demo-simple.c
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2013 Google, Inc
+ *
+ * (C) Copyright 2012
+ * Pavel Herrmann <morpheus.ibis@gmail.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <common.h>
+#include <dm.h>
+#include <dm-demo.h>
+#include <asm/io.h>
+
+static int simple_hello(struct device *dev, int ch)
+{
+       const struct dm_demo_pdata *pdata = dev_get_platdata(dev);
+
+       printf("Hello from %08x: %s %d\n", map_to_sysmem(dev), pdata->colour,
+              pdata->sides);
+
+       return 0;
+}
+
+static const struct demo_ops simple_ops = {
+       .hello = simple_hello,
+};
+
+static int demo_shape_ofdata_to_platdata(struct device *dev)
+{
+       /* Parse the data that is common with all demo devices */
+       return demo_parse_dt(dev);
+}
+
+static const struct device_id demo_shape_id[] = {
+       { "demo-simple", 0 },
+       { },
+};
+
+U_BOOT_DRIVER(demo_simple_drv) = {
+       .name   = "demo_simple_drv",
+       .of_match = demo_shape_id,
+       .id     = UCLASS_DEMO,
+       .ofdata_to_platdata = demo_shape_ofdata_to_platdata,
+       .ops    = &simple_ops,
+       .platdata_auto_alloc_size = sizeof(struct dm_demo_pdata),
+};

diff --git a/drivers/demo/demo-uclass.c b/drivers/demo/demo-uclass.c
new file mode 100644 (file)
index 0000000..48588be
--- /dev/null
+++ b/drivers/demo/demo-uclass.c
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2013 Google, Inc
+ *
+ * (C) Copyright 2012
+ * Pavel Herrmann <morpheus.ibis@gmail.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <common.h>
+#include <dm.h>
+#include <dm-demo.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <malloc.h>
+#include <asm/io.h>
+#include <linux/list.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+UCLASS_DRIVER(demo) = {
+       .id             = UCLASS_DEMO,
+};
+
+int demo_hello(struct device *dev, int ch)
+{
+       const struct demo_ops *ops = device_get_ops(dev);
+
+       if (!ops->hello)
+               return -ENOSYS;
+
+       return ops->hello(dev, ch);
+}
+
+int demo_status(struct device *dev, int *status)
+{
+       const struct demo_ops *ops = device_get_ops(dev);
+
+       if (!ops->status)
+               return -ENOSYS;
+
+       return ops->status(dev, status);
+}
+
+int demo_parse_dt(struct device *dev)
+{
+       struct dm_demo_pdata *pdata = dev_get_platdata(dev);
+       int dn = dev->of_offset;
+
+       pdata->sides = fdtdec_get_int(gd->fdt_blob, dn, "sides", 0);
+       pdata->colour = fdt_getprop(gd->fdt_blob, dn, "colour", NULL);
+       if (!pdata->sides || !pdata->colour) {
+               debug("%s: Invalid device tree data\n", __func__);
+               return -EINVAL;
+       }
+
+       return 0;
+}

diff --git a/include/configs/sandbox.h b/include/configs/sandbox.h
index 8e034a73521673177e7220fa4dcdc7ef5deadfb1..1d11c40b104b336535f5d2d5665c91930c4c6af1 100644 (file)
--- a/include/configs/sandbox.h
+++ b/include/configs/sandbox.h
@@ -21,7 +21,11 @@
 #define CONFIG_BOOTSTAGE
 #define CONFIG_BOOTSTAGE_REPORT
 #define CONFIG_DM
 #define CONFIG_BOOTSTAGE
 #define CONFIG_BOOTSTAGE_REPORT
 #define CONFIG_DM

+#define CONFIG_CMD_DEMO

 #define CONFIG_CMD_DM
 #define CONFIG_CMD_DM

+#define CONFIG_DM_DEMO
+#define CONFIG_DM_DEMO_SIMPLE
+#define CONFIG_DM_DEMO_SHAPE

 #define CONFIG_DM_TEST
 
 /* Number of bits in a C 'long' on this architecture */
 #define CONFIG_DM_TEST
 
 /* Number of bits in a C 'long' on this architecture */

diff --git a/include/dm-demo.h b/include/dm-demo.h
new file mode 100644 (file)
index 0000000..6e38d3c
--- /dev/null
+++ b/include/dm-demo.h
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2013 Google, Inc
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#ifndef __DM_DEMO_H
+#define __DM_DEMO_H
+
+#include <dm.h>
+
+/**
+ * struct dm_demo_pdata - configuration data for demo instance
+ *
+ * @colour: Color of the demo
+ * @sides: Numbers of sides
+ * @default_char: Default ASCII character to output (65 = 'A')
+ */
+struct dm_demo_pdata {
+       const char *colour;
+       int sides;
+       int default_char;
+};
+
+struct demo_ops {
+       int (*hello)(struct device *dev, int ch);
+       int (*status)(struct device *dev, int *status);
+};
+
+int demo_hello(struct device *dev, int ch);
+int demo_status(struct device *dev, int *status);
+int demo_list(void);
+
+int demo_parse_dt(struct device *dev);
+
+#endif